Readonly
agentThe 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.
Readonly
descriptionA markdown description of its functionality and its privacy-relevant requirements, including function call handlers that access some data autonomously.
Readonly
functionsThe 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.
Readonly
idUsed to identify an agent, e.g. when it is requesting language models, etc.
Readonly
languageRequired language models. This includes the purpose and optional language model selector arguments. See #47.
Readonly
nameHuman-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).
Readonly
promptsThe prompts introduced and used by this agent.
Optional
Readonly
tagsA list of tags to filter agents and to display capabilities in the UI
Readonly
variablesThe 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.
Agents represent the main functionality of the AI system. They are responsible for processing user input, collecting information from the environment, invoking and processing LLM responses, and providing the final response to the user while recording their actions in the AI history.
Agents are meant to cover all use cases, from specialized scenarios to general purpose chat bots.
Agents are encouraged to provide a detailed description of their functionality and their processed inputs. They can also declare their used prompt templates, which makes them configurable for the user.