AgentOSConfig

Parameters

Parameter	Type	Default	Description
`available_models`	`Optional[List[str]]`	`None`	List of models available in the AgentOS
`chat`	`Optional[ChatConfig]`	`None`	Configuration for the Chat page of your AgentOS
`manifest`	`Optional[Dict[str, Manifest]]`	`None`	UI metadata for each agent, team and workflow, keyed by ID
`evals`	`Optional[EvalsConfig]`	`None`	Configuration for the Evals page of your AgentOS
`knowledge`	`Optional[KnowledgeConfig]`	`None`	Configuration for the Knowledge page of your AgentOS
`memory`	`Optional[MemoryConfig]`	`None`	Configuration for the Memory page of your AgentOS
`learning`	`Optional[LearningConfig]`	`None`	Configuration for the Learning page of your AgentOS
`session`	`Optional[SessionConfig]`	`None`	Configuration for the Session page of your AgentOS
`metrics`	`Optional[MetricsConfig]`	`None`	Configuration for the Metrics page of your AgentOS
`traces`	`Optional[TracesConfig]`	`None`	Configuration for the Traces page of your AgentOS

ChatConfig

Parameter	Type	Default	Description
`quick_prompts`	`Dict[str, List[str]]`	Required	Default prompts for each agent, team and workflow

Manifest

UI metadata shown in the AgentOS interface. description here is separate from Agent.description, Team.description and Workflow.description, which are sent to the model.

Parameter	Type	Default	Description
`description`	`Optional[str]`	`None`	Description shown on the home card
`labels`	`Optional[List[str]]`	`None`	Labels shown on the home card
`quick_prompts`	`Optional[List[str]]`	`None`	Prompts shown on the chat page

EvalsConfig

Parameter	Type	Default	Description
`display_name`	`Optional[str]`	`None`	Display name for the Evals page
`dbs`	`Optional[List[DatabaseConfig[EvalsDomainConfig]]]`	`None`	List of configurations for each database

KnowledgeConfig

Parameter	Type	Default	Description
`display_name`	`Optional[str]`	`None`	Display name for the Knowledge page
`dbs`	`Optional[List[KnowledgeDatabaseConfig]]`	`None`	List of configurations for each database
`knowledge_instances`	`Optional[List[KnowledgeInstanceConfig]]`	`None`	Knowledge instances to expose, each with `id`, `name`, `db_id`, `table` and an optional `description`

MemoryConfig

Parameter	Type	Default	Description
`display_name`	`Optional[str]`	`None`	Display name for the Memory page
`dbs`	`Optional[List[DatabaseConfig[MemoryDomainConfig]]]`	`None`	List of configurations for each database

LearningConfig

Parameter	Type	Default	Description
`display_name`	`Optional[str]`	`None`	Display name for the Learning page
`dbs`	`Optional[List[DatabaseConfig[LearningDomainConfig]]]`	`None`	List of configurations for each database

SessionConfig

Parameter	Type	Default	Description
`display_name`	`Optional[str]`	`None`	Display name for the Session page
`dbs`	`Optional[List[DatabaseConfig[SessionDomainConfig]]]`	`None`	List of configurations for each database

MetricsConfig

Parameter	Type	Default	Description
`display_name`	`Optional[str]`	`None`	Display name for the Metrics page
`dbs`	`Optional[List[DatabaseConfig[MetricsDomainConfig]]]`	`None`	List of configurations for each database

TracesConfig

Parameter	Type	Default	Description
`display_name`	`Optional[str]`	`None`	Display name for the Traces page
`dbs`	`Optional[List[DatabaseConfig[TracesDomainConfig]]]`	`None`	List of configurations for each database

Using a YAML Configuration File

You can also provide your AgentOS configuration via a YAML file.

You can define all the previously mentioned configuration options in the file:

# List of models available in the AgentOS
available_models:
  - <MODEL_STRING>
  # Add more entries as needed.
# Configuration for the Chat page
chat:
  quick_prompts:
    <AGENT_ID>:
      - <PROMPT_1>
      - <PROMPT_2>
      - <PROMPT_3>
      # Add more entries as needed.
    # Add more entries as needed.
# UI metadata for each agent, team and workflow, keyed by ID
manifest:
  <AGENT_ID>:
    description: <DESCRIPTION>
    labels:
      - <LABEL_1>
      # Add more entries as needed.
    quick_prompts:
      - <PROMPT_1>
      # Add more entries as needed.
# Configuration for the Evals page
evals:
  display_name: <DISPLAY_NAME>
  dbs:
    - db_id: <DB_ID>
      domain_config:
        display_name: <DISPLAY_NAME>
    # Add more entries as needed.
# Configuration for the Knowledge page
knowledge:
  display_name: <DISPLAY_NAME>
  dbs:
    - db_id: <DB_ID>
      domain_config:
        display_name: <DISPLAY_NAME>
    # Add more entries as needed.
# Configuration for the Memory page
memory:
  display_name: <DISPLAY_NAME>
  dbs:
    - db_id: <DB_ID>
      domain_config:
        display_name: <DISPLAY_NAME>
    # Add more entries as needed.
# Configuration for the Learning page
learning:
  display_name: <DISPLAY_NAME>
  dbs:
    - db_id: <DB_ID>
      domain_config:
        display_name: <DISPLAY_NAME>
    # Add more entries as needed.
# Configuration for the Session page
session:
  display_name: <DISPLAY_NAME>
  dbs:
    - db_id: <DB_ID>
      domain_config:
        display_name: <DISPLAY_NAME>
    # Add more entries as needed.
# Configuration for the Metrics page
metrics:
  display_name: <DISPLAY_NAME>
  dbs:
    - db_id: <DB_ID>
      domain_config:
        display_name: <DISPLAY_NAME>
    # Add more entries as needed.
# Configuration for the Traces page
traces:
  display_name: <DISPLAY_NAME>
  dbs:
    - db_id: <DB_ID>
      domain_config:
        display_name: <DISPLAY_NAME>
    # Add more entries as needed.