ProtectedadditionalThe list of local variable identifiers that can be made available to this agent during execution, these variables are context specific and do not exist for other agents.
This array is primarily used for documentation purposes in the AI Configuration View to show which variables can be made available to the agent. Referenced variables are NOT automatically handed over by the framework, this must be explicitly done in the agent implementation or in prompts.
ProtectedchatProtectedcontentProtectedcontentProtecteddefaultProtecteddefaultA markdown description of its functionality and its privacy-relevant requirements, including function call handlers that access some data autonomously.
The list of global function identifiers that are always available to this agent during execution, regardless of whether they are referenced in prompts.
This array is primarily used for documentation purposes in the AI Configuration View to show which functions are guaranteed to be available to the agent. Referenced functions are NOT automatically handed over by the framework, this must be explicitly done in the agent implementation.
Used to identify an agent, e.g. when it is requesting language models, etc.
ProtectedlanguageRequired language models. This includes the purpose and optional language model selector arguments. See #47.
ProtectedlanguageProtectedloggerHuman-readable name shown to users to identify the agent. Must be unique.
Use short names without "Agent" or "Chat" (see tags for adding further properties).
The prompts introduced and used by this agent.
ProtectedpromptProtectedsystemA list of tags to filter agents and to display capabilities in the UI
ProtectedtoolThe list of global variable identifiers that are always available to this agent during execution, regardless of whether they are referenced in prompts.
This array is primarily used for documentation purposes in the AI Configuration View to show which variables are guaranteed to be available to the agent. Referenced variables are NOT automatically handed over by the framework, this must be explicitly done in the agent implementation.
ProtectedaddProtectedaddProtectedcreateCreates a ToolCallChatResponseContent instance from the provided tool call data.
This method is called when parsing stream response tokens that contain tool call data. Subclasses can override this method to customize the creation of tool call response contents.
The ToolCall.
A ChatResponseContent representing the tool call.
ProtecteddeduplicateDeduplicate tools by name (falling back to id) while preserving the first occurrence and order.
ProtectedgetProtectedgetProtectedgetthe settings, such as temperature, to be used in all language model requests. Returns undefined by default.
ProtectedgetOptionalincludeResponseInProgress: booleanProtectedgetProtectedhandleProtectedinitializeProtectedonInvoked after the response by the LLM completed successfully.
The default implementation sets the state of the response to complete.
Subclasses may override this method to perform additional actions or keep the response open for processing further requests.
ProtectedparseProtectedparseProtectedselectProtectedsend
A chat agent is a specialized agent with a common interface for its invocation.