Description: The SimpleAgentSpec class defines the basic configuration for a SimpleAgent within the Eidolon framework. This agent is designed to be a flexible, modular component that can interact with various processing units and perform a range of actions based on its configuration.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - implementation | No | const | No | - | SimpleAgent |
| - description | No | string | No | - | Description |
| - system_prompt | No | string | No | - | System Prompt |
| - agent_refs | No | array of string | No | - | Agent Refs |
| - actions | No | array | No | - | Actions |
| - apu | No | Reference[APU] | No | In APU | The APU is the main interface for the Agent to interact with the LLM.
The APU provides a set of capabilities that encapsulate LLM functionality and creates a clear separation between business logic and the underlying LLM implementation.
To learn more, check out our blog article APU: What is it and how does it work?. |
| - apus | No | array | No | - | Apus |
| - title_generation_mode | No | enum (of string) | No | - | Title Generation Mode |
| - | No | object | No | - | - |
1. Property implementation
Description: SimpleAgent
Specific value: "SimpleAgent"
2. Property description
Title: Description
| |
|---|
| Type | string |
| Required | No |
| Default | null |
3. Property system_prompt
Title: System Prompt
| |
|---|
| Type | string |
| Required | No |
| Default | "You are a helpful assistant. Always use the provided tools, if appropriate, to complete the task." |
4. Property agent_refs
Title: Agent Refs
| |
|---|
| Type | array of string |
| Required | No |
| Default | [] |
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
4.1. agent_refs items
5. Property actions
Title: Actions
| |
|---|
| Type | array |
| Required | No |
| Default | [{"name": "converse", "title": null, "sub_title": null, "description": null, "user_prompt": "{{ body }}", "input_schema": {}, "output_schema": "str", "allow_file_upload": false, "supported_mime_types": [], "allowed_states": ["initialized", "idle", "http_error"], "output_state": "idle"}] |
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
5.1. ActionDefinition
5.1.1. Property name
Title: Name
| |
|---|
| Type | string |
| Required | No |
| Default | "converse" |
5.1.2. Property title
Title: Title
| |
|---|
| Type | string |
| Required | No |
| Default | null |
5.1.3. Property sub_title
Title: Sub Title
| |
|---|
| Type | string |
| Required | No |
| Default | null |
5.1.4. Property description
Title: Description
| |
|---|
| Type | string |
| Required | No |
| Default | null |
5.1.5. Property user_prompt
Title: User Prompt
| |
|---|
| Type | string |
| Required | No |
| Default | "{{ body }}" |
Title: Input Schema
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - | No | object | No | - | - |
5.1.6.1. Property additionalProperties
5.1.7. Property output_schema
Title: Output Schema
5.1.7.1. Property item 0
Must be one of:
- “str” Specific value:
"str"
5.1.7.2. Property item 1
5.1.8. Property allow_file_upload
Title: Allow File Upload
| |
|---|
| Type | boolean |
| Required | No |
| Default | false |
5.1.9. Property supported_mime_types
Title: Supported Mime Types
| |
|---|
| Type | array of string |
| Required | No |
| Default | [] |
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
5.1.9.1. supported_mime_types items
5.1.10. Property allowed_states
Title: Allowed States
| |
|---|
| Type | array of string |
| Required | No |
| Default | ["initialized", "idle", "http_error"] |
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
5.1.10.1. allowed_states items
5.1.11. Property output_state
Title: Output State
| |
|---|
| Type | string |
| Required | No |
| Default | "idle" |
6. Property apu
| |
|---|
| Type | Reference[APU] |
| Required | No |
| Default | {"implementation": "APU"} |
| Defined in | APU |
Description: The APU is the main interface for the Agent to interact with the LLM. The APU provides a set of capabilities that encapsulate LLM functionality and creates a clear separation between business logic and the underlying LLM implementation.
To learn more, check out our blog article APU: What is it and how does it work?.
7. Property apus
Title: Apus
| |
|---|
| Type | array |
| Required | No |
| Default | [] |
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|
| NamedAPU | - |
7.1. NamedAPU
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - title | No | string | No | - | Title |
| - apu | No | Reference[APU] | No | In APU | The APU is the main interface for the Agent to interact with the LLM.
The APU provides a set of capabilities that encapsulate LLM functionality and creates a clear separation between business logic and the underlying LLM implementation.
To learn more, check out our blog article APU: What is it and how does it work?. |
| - default | No | boolean | No | - | Default |
| - | No | object | No | - | - |
7.1.1. Property title
Title: Title
| |
|---|
| Type | string |
| Required | No |
| Default | null |
7.1.2. Property apu
| |
|---|
| Type | Reference[APU] |
| Required | No |
| Default | {"implementation": "APU"} |
| Defined in | APU |
Description: The APU is the main interface for the Agent to interact with the LLM. The APU provides a set of capabilities that encapsulate LLM functionality and creates a clear separation between business logic and the underlying LLM implementation.
To learn more, check out our blog article APU: What is it and how does it work?.
7.1.3. Property default
Title: Default
| |
|---|
| Type | boolean |
| Required | No |
| Default | false |
8. Property title_generation_mode
Title: Title Generation Mode
| |
|---|
| Type | enum (of string) |
| Required | No |
| Default | "on_request" |
Must be one of:
