Skip to content

SimpleAgent

Description: 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.

PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ implementationNoconstNo-Implementation
- apuNoReference[APU]No--
- agent_refsNoarray of stringNo-Agent Refs
- toolsNoarray of Reference[LogicUnit]No-Tools
- descriptionNostringNo-Description
- system_promptNostringNo-System Prompt
- actionsNoarrayNo-Actions
- apusNoarrayNo-Apus
- title_generation_modeNoenum (of string)No-Title Generation Mode
- prompt_templatesNoobjectNo-Prompt Templates

1. Property implementation

Title: Implementation

Typeconst
RequiredYes

Specific value: "SimpleAgent"

2. Property apu

TypeReference[APU]
RequiredNo
Default{"implementation": "APU"}

3. Property agent_refs

Title: Agent Refs

Typearray of string
RequiredNo
Default[]
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
agent_refs items-

3.1. agent_refs items

Typestring
RequiredNo

4. Property tools

Title: Tools

Typearray of [Reference[LogicUnit]](/docs/components/logicunit/overview)
RequiredNo
Default[]

Description: A list of tools available to the agent.

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
tools items-

4.1. tools items

TypeReference[LogicUnit]
RequiredNo
Default{"implementation": "eidolon_ai_sdk.apu.logic_unit.LogicUnit"}

5. Property description

Title: Description

Typestring
RequiredNo
Defaultnull

6. Property system_prompt

Title: System Prompt

Typestring
RequiredNo
Default"You are a helpful assistant. Always use the provided tools, if appropriate, to complete the task."

7. Property actions

Title: Actions

Typearray
RequiredNo
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 itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
ActionDefinition-

7.1. ActionDefinition

Typeobject
RequiredNo
Additional properties[Any type: allowed]
Defined in#/$defs/ActionDefinition
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- nameNostringNo-Name
- titleNostringNo-Title
- sub_titleNostringNo-Sub Title
- descriptionNostringNo-Description
- user_promptNostringNo-User Prompt
- input_schemaNoobjectNo-Input Schema
- output_schemaNoCombinationNo-Output Schema
- allow_file_uploadNobooleanNo-Allow File Upload
- supported_mime_typesNoarray of stringNo-Supported Mime Types
- allowed_statesNoarray of stringNo-Allowed States
- output_stateNostringNo-Output State

7.1.1. Property name

Title: Name

Typestring
RequiredNo
Default"converse"

7.1.2. Property title

Title: Title

Typestring
RequiredNo
Defaultnull

7.1.3. Property sub_title

Title: Sub Title

Typestring
RequiredNo
Defaultnull

7.1.4. Property description

Title: Description

Typestring
RequiredNo
Defaultnull

7.1.5. Property user_prompt

Title: User Prompt

Typestring
RequiredNo
Default"{{ body }}"

7.1.6. Property input_schema

Title: Input Schema

Typeobject
RequiredNo
Additional properties[Should-conform]
Default{}
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- NoobjectNo--
7.1.6.1. Property additionalProperties
Typeobject
RequiredNo
Additional properties[Any type: allowed]

7.1.7. Property output_schema

Title: Output Schema

Typecombining
RequiredNo
Additional properties[Any type: allowed]
Default"str"
Any of(Option)
item 0
item 1
7.1.7.1. Property item 0
Typeconst
RequiredNo

Specific value: "str"

7.1.7.2. Property item 1
Typeobject
RequiredNo
Additional properties[Any type: allowed]

7.1.8. Property allow_file_upload

Title: Allow File Upload

Typeboolean
RequiredNo
Defaultfalse

7.1.9. Property supported_mime_types

Title: Supported Mime Types

Typearray of string
RequiredNo
Default[]
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
supported_mime_types items-
7.1.9.1. supported_mime_types items
Typestring
RequiredNo

7.1.10. Property allowed_states

Title: Allowed States

Typearray of string
RequiredNo
Default["initialized", "idle", "http_error"]
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
allowed_states items-
7.1.10.1. allowed_states items
Typestring
RequiredNo

7.1.11. Property output_state

Title: Output State

Typestring
RequiredNo
Default"idle"

8. Property apus

Title: Apus

Typearray
RequiredNo
Default[]
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
NamedAPU-

8.1. NamedAPU

Typeobject
RequiredNo
Additional properties[Any type: allowed]
Defined in#/$defs/NamedAPU
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- titleNostringNo-Title
- apuNoReference[APU]No--
- defaultNobooleanNo-Default

8.1.1. Property title

Title: Title

Typestring
RequiredNo
Defaultnull

8.1.2. Property apu

TypeReference[APU]
RequiredNo
Default{"implementation": "APU"}

8.1.3. Property default

Title: Default

Typeboolean
RequiredNo
Defaultfalse

9. Property title_generation_mode

Title: Title Generation Mode

Typeenum (of string)
RequiredNo
Default"none"

Must be one of:

  • “none”
  • “on_request”
  • “auto”

10. Property prompt_templates

Title: Prompt Templates

Typeobject
RequiredNo
Additional properties[Should-conform]
Default{}

Description: A dictionary of Templates that can be used as jinja2 keys in system or action prompts

PropertyPatternTypeDeprecatedDefinitionTitle/Description
- NoReference[Template]No--

10.1. Property additionalProperties

TypeReference[Template]
RequiredNo
Default{"implementation": "eidolon_ai_sdk.agent.simple_agent.Template"}