Skip to content

SimpleAgent

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.

PropertyPatternTypeDeprecatedDefinitionTitle/Description
- implementationNoconstNo-SimpleAgent
- descriptionNoCombinationNo-Description
- system_promptNostringNo-System Prompt
- agent_refsNoarray of stringNo-Agent Refs
- actionsNoarray of objectNo-Actions
- apuNoReference[APU]No-APU
- apusNoarray of objectNo-Apus
- title_generation_modeNoenum (of string)No-Title Generation Mode
- NoobjectNo--

1. Property implementation

Typeconst
RequiredNo

Description: SimpleAgent

Specific value: "SimpleAgent"

2. Property description

Title: Description

Typecombining
RequiredNo
Additional properties[Any type: allowed]
Defaultnull
Any of(Option)
item 0
item 1

2.1. Property item 0

Typestring
RequiredNo

2.2. Property item 1

Typenull
RequiredNo

3. 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."

4. 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-

4.1. agent_refs items

Typestring
RequiredNo

5. Property actions

Title: Actions

Typearray of object
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-

5.1. ActionDefinition

Title: ActionDefinition

Typeobject
RequiredNo
Additional properties[Any type: allowed]
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- nameNostringNo-Name
- titleNoCombinationNo-Title
- sub_titleNoCombinationNo-Sub Title
- descriptionNoCombinationNo-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
- NoobjectNo--

5.1.1. Property name

Title: Name

Typestring
RequiredNo
Default"converse"

5.1.2. Property title

Title: Title

Typecombining
RequiredNo
Additional properties[Any type: allowed]
Defaultnull
Any of(Option)
item 0
item 1
5.1.2.1. Property item 0
Typestring
RequiredNo
5.1.2.2. Property item 1
Typenull
RequiredNo

5.1.3. Property sub_title

Title: Sub Title

Typecombining
RequiredNo
Additional properties[Any type: allowed]
Defaultnull
Any of(Option)
item 0
item 1
5.1.3.1. Property item 0
Typestring
RequiredNo
5.1.3.2. Property item 1
Typenull
RequiredNo

5.1.4. Property description

Title: Description

Typecombining
RequiredNo
Additional properties[Any type: allowed]
Defaultnull
Any of(Option)
item 0
item 1
5.1.4.1. Property item 0
Typestring
RequiredNo
5.1.4.2. Property item 1
Typenull
RequiredNo

5.1.5. Property user_prompt

Title: User Prompt

Typestring
RequiredNo
Default"{{ body }}"

5.1.6. Property input_schema

Title: Input Schema

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

5.1.7. Property output_schema

Title: Output Schema

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

Must be one of:

  • “str” Specific value: "str"
5.1.7.2. Property item 1
Typeobject
RequiredNo
Additional properties[Any type: allowed]

5.1.8. Property allow_file_upload

Title: Allow File Upload

Typeboolean
RequiredNo
Defaultfalse

5.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-
5.1.9.1. supported_mime_types items
Typestring
RequiredNo

5.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-
5.1.10.1. allowed_states items
Typestring
RequiredNo

5.1.11. Property output_state

Title: Output State

Typestring
RequiredNo
Default"idle"

6. Property apu

Title: APU

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

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

Typearray of object
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-

7.1. NamedAPU

Title: NamedAPU

Typeobject
RequiredNo
Additional properties[Any type: allowed]
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- titleNoCombinationNo-Title
- apuNoReference[APU]No-APU
- defaultNobooleanNo-Default
- NoobjectNo--

7.1.1. Property title

Title: Title

Typecombining
RequiredNo
Additional properties[Any type: allowed]
Defaultnull
Any of(Option)
item 0
item 1
7.1.1.1. Property item 0
Typestring
RequiredNo
7.1.1.2. Property item 1
Typenull
RequiredNo

7.1.2. Property apu

Title: APU

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

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

Typeboolean
RequiredNo
Defaultfalse

8. Property title_generation_mode

Title: Title Generation Mode

Typeenum (of string)
RequiredNo
Default"on_request"

Must be one of:

  • “none"
  • "on_request”