​
Parameters

ParameterTypeDefaultDescription
available_modelsList[str]NoneList of models available in the AgentOS
chatOptional[ChatConfig]NoneConfiguration for the Chat page
evalsOptional[EvalsConfig]NoneConfiguration for the Evals page
knowledgeOptional[KnowledgeConfig]NoneConfiguration for the Knowledge page
memoryOptional[MemoryConfig]NoneConfiguration for the Memory page
sessionOptional[SessionConfig]NoneConfiguration for the Session page
metricsOptional[MetricsConfig]NoneConfiguration for the Metrics page

​
ChatConfig

ParameterTypeDefaultDescription
quick_promptsDict[str, List[str]]NoneDefault prompts for each agent, team and workflow

​
EvalsConfig

ParameterTypeDefaultDescription
available_modelsList[str]NoneList of models available in the Evals page
display_namestrNoneDisplay name for the Evals page
dbsOptional[List[DatabaseConfig[EvalsDomainConfig]]]NoneList of configurations for each database

​
KnowledgeConfig

ParameterTypeDefaultDescription
display_namestrNoneDisplay name for the Knowledge page
dbsOptional[List[DatabaseConfig[KnowledgeDomainConfig]]]NoneList of configurations for each database

​
MemoryConfig

ParameterTypeDefaultDescription
display_namestrNoneDisplay name for the Memory page
dbsOptional[List[DatabaseConfig[MemoryDomainConfig]]]NoneList of configurations for each database

​
SessionConfig

ParameterTypeDefaultDescription
display_namestrNoneDisplay name for the Session page
dbsOptional[List[DatabaseConfig[SessionDomainConfig]]]NoneList of configurations for each database

​
MetricsConfig

ParameterTypeDefaultDescription
display_namestrNoneDisplay name for the Metrics page
dbsOptional[List[DatabaseConfig[MetricsDomainConfig]]]NoneList 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>
  ...

# Configuration for the Chat page
chat:
  quick_prompts:
    <AGENT_ID>:
      - <PROMPT_1>
      - <PROMPT_2>
      - <PROMPT_3>
      ...
    ...


# Configuration for the Evals page
evals:
  available_models:
    - <MODEL_STRING>
    ...
  display_name: <DISPLAY_NAME>
  dbs:
    - <DB_ID>
      domain_config:
        available_models:
          - <MODEL_STRING>
          ...
        display_name: <DISPLAY_NAME>
    ...


# Configuration for the Knowledge page
knowledge:
  display_name: <DISPLAY_NAME>
  dbs:
    - <DB_ID>
      domain_config:
        display_name: <DISPLAY_NAME>
    ...

# Configuration for the Memory page
memory:
  display_name: <DISPLAY_NAME>
  dbs:
    - <DB_ID>
      domain_config:
        display_name: <DISPLAY_NAME>
    ...

# Configuration for the Session page
session:
  display_name: <DISPLAY_NAME>
  dbs:
    - <DB_ID>
      domain_config:
        display_name: <DISPLAY_NAME>
    ...

# Configuration for the Metrics page
metrics:
  display_name: <DISPLAY_NAME>
  dbs:
    - <DB_ID>
      domain_config:
        display_name: <DISPLAY_NAME>
    ...