LogoLogo
Visit Contextual.ioSign Up
  • Getting Started
    • Welcome
    • Tour: Hello, AI World!
  • TRAINING
    • Basic Developer Training Course
      • Lesson 1: HTTP Agent Introduction
      • Lesson 2: Logging and Error Handling Basics
      • Lesson 3: Event Processing Agent Introduction
  • Services Catalog
    • What's in the Catalog?
      • Intro Patterns
      • Object Type Bundles
    • Browse by Platform
    • All Intro Patterns
      • Anthropic Claude Image Analysis
      • Mistral AI Prompt and Response
      • xAI Grok Prompt and Response
      • DeepSeek Chat Prompt and Response
      • Qwen Chat Prompt and Response
      • Perplexity AI Search and Response
      • Firecrawl Website Scraper
      • Groq Prompt and Response
      • Nyckel Dog Breed Classification
      • RapidAPI ClassifyAI Text Classification
      • RapidAPI YouTube AI Video Summary
      • UnifyAI Model Comparison
      • WebPilot URL Analysis and Summarization
      • OpenAI Assistants Prompt and Response
      • OpenAI Sync
    • All Prebuilt Solutions
      • Invoice AI
      • Lead Generation Form
    • All Object Type Bundles
      • Work Order Management System ITIL Object Type Bundle
        • Work Order
        • User
        • Role
        • Permission
        • Asset
        • Task
        • Action
        • Attachment
        • Comment
        • Notification
        • Audit Log
        • Service Level Agreement
        • Custom Fields
        • Work Order Template
        • Work Order Transition
        • Escalation Policy
        • Tag
  • Components & Data
    • Object Types
      • Data in Contextual
        • Secrets
        • Validation
        • Versioning
      • Examples
      • Creating an Object Type
      • Object Type Details
        • Definition
        • Data Schema
          • Automatic Record Metadata
          • Generated Values
            • Dates and Times
            • UUIDs
          • Frequently Used Validation
          • Disallowing Null Property Values
          • Disallowing Undefined Properties
          • Secrets
          • AI Assistant
          • ID and PrimaryKey Permanence
        • UI Schemas
        • Features
        • Triggers
        • Actions
        • Audit Trail
        • Versions
        • Templates
        • Records
      • Using Object Types in Flows
      • Records
        • Records and Your Tenant API
        • Record Import
    • Flows
      • Nodes
      • Wires
      • Message Object
      • Flow Editor
        • Basics
        • Saving Changes
        • In-Flow Testing with Debugger
        • Restart Agents to Make Changes Active
        • Config
      • Node Reference
        • Common
          • Log Tap
          • Inject
          • Debug
          • Complete
          • Catch
          • Status
          • Link In
          • Link Call
          • Link Out
          • Comment
        • Event
          • Prepare Event
          • Event Start
          • Event End
          • Event Error
        • Object
          • Search Object
          • Get Object
          • Create Object
          • Patch Object
          • Put Object
          • Delete Object
          • Run Action
        • Request
          • Send to Agent
          • HTTP GET
          • HTTP PATCH
          • HTTP PUT
          • HTTP DELETE
          • HTTP POST
          • GQL
          • Produce Message
        • Function
          • Function
          • Switch
          • Change
          • Range
          • Template
          • Delay
          • Trigger
          • Exec
          • Filter
          • Loop
        • Models
          • ML Predict
        • Network
          • MQTT In
          • MQTT Out
          • HTTP In
          • HTTP Response
          • HTTP Request
          • WebSocket In
          • WebSocket Out
          • TCP In
          • TCP Out
          • TCP Request
          • UDP In
          • UDP Out
        • Sequence
          • Split
          • Join
          • Sort
          • Batch
        • Parser
          • csv
          • html
          • json
          • xml
          • yaml
    • Agents
      • Creating an Agent
      • Types of Agents
        • Event to Flow
        • HTTP to Flow
          • Custom Domains
      • How Agents Work
        • Flow Execution
        • HTTP Load Balancing
        • Event Routing
      • Scale and Performance
        • Flow execution
        • Parallel Instances
        • Event Lag Scaling
        • Compute Threshold Scaling
        • Instance Compute Sizing
      • Agent Details
        • Definition
        • Operations
        • Logs
          • Session Log
          • Message Log
        • Audit Trail
        • Versions
      • Using Agents in Flows
    • Connections
      • Creating a Connection
      • Types of Connections
        • Basic
        • Bearer
        • Client Grant
        • Kafka
        • Password Grant
        • Public
        • Pulsar
      • Using Connections in Flows
    • JWKS Profiles
      • Using JWKS Profiles in Your Solution
  • PATTERNS
    • Solution Architecture
      • Events, Messages, Queues
    • Working with Data
      • Search Object Node & Pagination
      • Message Payload Content - Triggers and Actions
    • Industry Cookbooks
      • Field Services
  • Tenants
    • Tenant Workspace
    • Tenant Logs
      • Contextual Log Query Language (CLQL)
        • String Searches
        • Keyword Searches
        • Advanced Operators
    • Tenant API
      • API Keys
        • API Key Settings
        • API Key Permissions
      • Documentation
  • Release Notes
    • 2024
      • 2024.12.09
Powered by GitBook
On this page

Was this helpful?

  1. Components & Data
  2. Agents
  3. Agent Details

Definition

To update or modify the definition of an Object Type, choose Components > Agents in the navigational menu, then choose the Object Type. The Object Type detail view will default to the Definition tab, which includes:

  • Agent ID: required, permanent unique identifier for the Agent, used throughout the Tenant Workspace UI, throughout your solution, and as the Agent API endpoint for an Http Agent.

  • Name: editable, this required field is used throughout the Tenant Workspace UI

  • Description: optional, used to describe the function of the agent.

  • Type: sets the type of the Agent to one of the following allowed types:

    • HTTP to Flow — HTTP Agent type for APIs or Web Pages

    • Event to Flow — Event Processing agent that receives messages from the Contextual messaging service.

  • Flow: The specific flow and version of the flow selected and currently in use for this agent

  • Entry Points (Event-to-Flow only): If the flow supports multiple entry points (defined by the use of multiple Event-Start nodes in the flow), then the entry point to use for this agent is selectable. This allows a single flow to contain the logic for more than one agent, and for the entry point to be selectable on a per agent basis.

  • Flow Version: Displays the current version of the flow used by this agent, and if a newer version of the flow is available, provides an "Update to Version nnn" button that allows you to update to the latest version and restart all agent instances to use that version.

  • Image Version: The version of the agent "image". New agent versions are published periodically that introduce new features. By allowing the image version to be specified, the decision about when to upgrade the agent to the latest version is left in the hands of the developer.

  • Parallel Instance Scaling Type: The scaling type for this agent. This is related to the agent-type in the sense that some scaling types only work with specific agent types.

    • Lag-Based Scaling — Lag based scaling allows new instances to be launched when the number of messages waiting to be processed by the agent exceeds a defined threshold. This type only works with "Event to Flow" agents.

    • CPU-Based Scaling — CPU-based scaling allows new instances to be launched when the CPU utiilization of the current instances consistently exceeds a defined threshold. This type works with any agent type.

The table below shows the definition fields associated with each of the two different scaling types:

Lag-Based Scaling
CPU-Based Scaling

Minimum Instances — The minimum number of instances to execute.

Minimum Instances — The minimum number of instances to execute.

Maximum Instances — The maximum number of instances to execute.

Maximum Instances — The maximum number of instances to execute.

Event Lag Threshold — The threshold of events waiting to be processed to exceed before launching an additional instance.

CPU Threshold — The threshold of CPU time to exceed before launching an additional instance.

  • Instance Compute: The size of the agent to launch in terms of milli-CPUs and memory as shown in the table below.

Size
mCPU
Memory

Small

150

512 MiB

Medium

300

1024 MiB

Large

1000

4096 MiB

Extra Large (XL)

2000

8192 MiB

Extra-Extra Large (XXL)

4000

16384 MiB

  • Environment Variables: Allows developers to specify environment variables which provide configuration settings to the flow. The environment variables are accessible to function nodes within the flow.

Deleting an Agent

On the Agent Definition tab in the Tenant Workspace UI, there is a Danger Zone to delete the Object Type. Once confirmed, the Agent and all log data associated with that Agent will be immediately deleted, an operation which cannot be undone. However the flow associated with the agent is not deleted, allowing the agent to be recreated if needed.

PreviousAgent DetailsNextOperations

Last updated 9 months ago

Was this helpful?