Knowledge Bases
Knowledge Bases
Attach Knowledge Bases to an Agent
Attach Knowledge Base to an Agent
Detach Knowledge Base from an Agent
ModelsExpand Collapse
class APILinkKnowledgeBaseOutput: …
Information about a linked knowledge base
agent: Optional[APIAgent]
An Agent
anthropic_api_key: Optional[APIAnthropicAPIKeyInfo]
Anthropic API Key Info
created_at: Optional[datetime]
Key creation date
created_by: Optional[str]
Created by user id from DO
deleted_at: Optional[datetime]
Key deleted date
name: Optional[str]
Name
updated_at: Optional[datetime]
Key last updated date
uuid: Optional[str]
Uuid
Api key infos
created_at: Optional[datetime]
Creation date
created_by: Optional[str]
Created by
deleted_at: Optional[datetime]
Deleted date
name: Optional[str]
Name
uuid: Optional[str]
Uuid
api_keys: Optional[List[APIKey]]
Api keys
api_key: Optional[str]
Api key
chatbot: Optional[Chatbot]
A Chatbot
name: Optional[str]
Name of chatbot
chatbot_identifiers: Optional[List[ChatbotIdentifier]]
Chatbot identifiers
agent_chatbot_identifier: Optional[str]
Agent chatbot identifier
Child agents
conversation_logs_enabled: Optional[bool]
Whether conversation logs are enabled for the agent
created_at: Optional[datetime]
Creation date / time
deployment: Optional[Deployment]
Description of deployment
created_at: Optional[datetime]
Creation date / time
name: Optional[str]
Name
status: Optional[Literal["STATUS_UNKNOWN", "STATUS_WAITING_FOR_DEPLOYMENT", "STATUS_DEPLOYING", 6 more]]
updated_at: Optional[datetime]
Last modified
url: Optional[str]
Access your deployed agent here
uuid: Optional[str]
Unique id
visibility: Optional[APIDeploymentVisibility]
- VISIBILITY_UNKNOWN: The status of the deployment is unknown
- VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests
- VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state
- VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet
- VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys
description: Optional[str]
Description of agent
functions: Optional[List[Function]]
api_key: Optional[str]
Api key
created_at: Optional[datetime]
Creation date / time
created_by: Optional[str]
Created by user id from DO
description: Optional[str]
Agent description
name: Optional[str]
Name
updated_at: Optional[datetime]
Last modified
url: Optional[str]
Download your agent here
uuid: Optional[str]
Unique id
guardrails: Optional[List[Guardrail]]
The guardrails the agent is attached to
type: Optional[Literal["GUARDRAIL_TYPE_UNKNOWN", "GUARDRAIL_TYPE_JAILBREAK", "GUARDRAIL_TYPE_SENSITIVE_DATA", "GUARDRAIL_TYPE_CONTENT_MODERATION"]]
instruction: Optional[str]
Agent instruction. Instructions help your agent to perform its job effectively. See Write Effective Agent Instructions for best practices.
Knowledge bases
added_to_agent_at: Optional[datetime]
Time when the knowledge base was added to the agent
created_at: Optional[datetime]
Creation date / time
is_public: Optional[bool]
Whether the knowledge base is public or not
last_indexing_job: Optional[APIIndexingJob]
IndexingJob description
completed_datasources: Optional[int]
Number of datasources indexed completed
created_at: Optional[datetime]
Creation date / time
knowledge_base_uuid: Optional[str]
Knowledge base id
phase: Optional[Literal["BATCH_JOB_PHASE_UNKNOWN", "BATCH_JOB_PHASE_PENDING", "BATCH_JOB_PHASE_RUNNING", 4 more]]
status: Optional[Literal["INDEX_JOB_STATUS_UNKNOWN", "INDEX_JOB_STATUS_PARTIAL", "INDEX_JOB_STATUS_IN_PROGRESS", 4 more]]
tokens: Optional[int]
Number of tokens
total_datasources: Optional[int]
Number of datasources being indexed
total_items_failed: Optional[str]
Total Items Failed
total_items_indexed: Optional[str]
Total Items Indexed
total_items_skipped: Optional[str]
Total Items Skipped
updated_at: Optional[datetime]
Last modified
uuid: Optional[str]
Unique id
name: Optional[str]
Name of knowledge base
region: Optional[str]
Region code
tags: Optional[List[str]]
Tags to organize related resources
updated_at: Optional[datetime]
Last modified
user_id: Optional[str]
Id of user that created the knowledge base
uuid: Optional[str]
Unique id for knowledge base
logging_config: Optional[LoggingConfig]
galileo_project_id: Optional[str]
Galileo project identifier
galileo_project_name: Optional[str]
Name of the Galileo project
insights_enabled: Optional[bool]
Whether insights are enabled
insights_enabled_at: Optional[datetime]
Timestamp when insights were enabled
log_stream_id: Optional[str]
Identifier for the log stream
log_stream_name: Optional[str]
Name of the log stream
model: Optional[APIAgentModel]
Description of a Model
agreement: Optional[APIAgreement]
Agreement Description
created_at: Optional[datetime]
Creation date / time
inference_name: Optional[str]
Internally used name
inference_version: Optional[str]
Internally used version
is_foundational: Optional[bool]
True if it is a foundational model provided by do
metadata: Optional[object]
Additional meta data
name: Optional[str]
Name of the model
parent_uuid: Optional[str]
Unique id of the model, this model is based on
provider: Optional[Literal["MODEL_PROVIDER_DIGITALOCEAN", "MODEL_PROVIDER_ANTHROPIC", "MODEL_PROVIDER_OPENAI"]]
updated_at: Optional[datetime]
Last modified
upload_complete: Optional[bool]
Model has been fully uploaded
url: Optional[str]
Download url
usecases: Optional[List[Literal["MODEL_USECASE_UNKNOWN", "MODEL_USECASE_AGENT", "MODEL_USECASE_FINETUNED", 4 more]]]
Usecases of the model
uuid: Optional[str]
Unique id
version: Optional[APIModelVersion]
Version Information about a Model
major: Optional[int]
Major version number
minor: Optional[int]
Minor version number
patch: Optional[int]
Patch version number
name: Optional[str]
Agent name
openai_api_key: Optional[APIOpenAIAPIKeyInfo]
OpenAI API Key Info
created_at: Optional[datetime]
Key creation date
created_by: Optional[str]
Created by user id from DO
deleted_at: Optional[datetime]
Key deleted date
Models supported by the openAI api key
agreement: Optional[APIAgreement]
Agreement Description
created_at: Optional[datetime]
Creation date / time
inference_name: Optional[str]
Internally used name
inference_version: Optional[str]
Internally used version
is_foundational: Optional[bool]
True if it is a foundational model provided by do
metadata: Optional[object]
Additional meta data
name: Optional[str]
Name of the model
parent_uuid: Optional[str]
Unique id of the model, this model is based on
provider: Optional[Literal["MODEL_PROVIDER_DIGITALOCEAN", "MODEL_PROVIDER_ANTHROPIC", "MODEL_PROVIDER_OPENAI"]]
updated_at: Optional[datetime]
Last modified
upload_complete: Optional[bool]
Model has been fully uploaded
url: Optional[str]
Download url
usecases: Optional[List[Literal["MODEL_USECASE_UNKNOWN", "MODEL_USECASE_AGENT", "MODEL_USECASE_FINETUNED", 4 more]]]
Usecases of the model
uuid: Optional[str]
Unique id
version: Optional[APIModelVersion]
Version Information about a Model
major: Optional[int]
Major version number
minor: Optional[int]
Minor version number
patch: Optional[int]
Patch version number
name: Optional[str]
Name
updated_at: Optional[datetime]
Key last updated date
uuid: Optional[str]
Uuid
Parent agents
provide_citations: Optional[bool]
Whether the agent should provide in-response citations
region: Optional[str]
Region code
retrieval_method: Optional[APIRetrievalMethod]
- RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown
- RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite
- RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back
- RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries
- RETRIEVAL_METHOD_NONE: The retrieval method is none
route_created_at: Optional[datetime]
Creation of route date / time
route_name: Optional[str]
Route name
tags: Optional[List[str]]
Agent tag to organize related resources
template: Optional[Template]
Represents an AgentTemplate entity
created_at: Optional[datetime]
The agent template's creation date
description: Optional[str]
Deprecated - Use summary instead
guardrails: Optional[List[TemplateGuardrail]]
List of guardrails associated with the agent template
priority: Optional[int]
Priority of the guardrail
uuid: Optional[str]
Uuid of the guardrail
instruction: Optional[str]
Instructions for the agent template
k: Optional[int]
The 'k' value for the agent template
List of knowledge bases associated with the agent template
added_to_agent_at: Optional[datetime]
Time when the knowledge base was added to the agent
created_at: Optional[datetime]
Creation date / time
is_public: Optional[bool]
Whether the knowledge base is public or not
last_indexing_job: Optional[APIIndexingJob]
IndexingJob description
completed_datasources: Optional[int]
Number of datasources indexed completed
created_at: Optional[datetime]
Creation date / time
knowledge_base_uuid: Optional[str]
Knowledge base id
phase: Optional[Literal["BATCH_JOB_PHASE_UNKNOWN", "BATCH_JOB_PHASE_PENDING", "BATCH_JOB_PHASE_RUNNING", 4 more]]
status: Optional[Literal["INDEX_JOB_STATUS_UNKNOWN", "INDEX_JOB_STATUS_PARTIAL", "INDEX_JOB_STATUS_IN_PROGRESS", 4 more]]
tokens: Optional[int]
Number of tokens
total_datasources: Optional[int]
Number of datasources being indexed
total_items_failed: Optional[str]
Total Items Failed
total_items_indexed: Optional[str]
Total Items Indexed
total_items_skipped: Optional[str]
Total Items Skipped
updated_at: Optional[datetime]
Last modified
uuid: Optional[str]
Unique id
name: Optional[str]
Name of knowledge base
region: Optional[str]
Region code
tags: Optional[List[str]]
Tags to organize related resources
updated_at: Optional[datetime]
Last modified
user_id: Optional[str]
Id of user that created the knowledge base
uuid: Optional[str]
Unique id for knowledge base
long_description: Optional[str]
The long description of the agent template
max_tokens: Optional[int]
The max_tokens setting for the agent template
model: Optional[APIAgentModel]
Description of a Model
agreement: Optional[APIAgreement]
Agreement Description
created_at: Optional[datetime]
Creation date / time
inference_name: Optional[str]
Internally used name
inference_version: Optional[str]
Internally used version
is_foundational: Optional[bool]
True if it is a foundational model provided by do
metadata: Optional[object]
Additional meta data
name: Optional[str]
Name of the model
parent_uuid: Optional[str]
Unique id of the model, this model is based on
provider: Optional[Literal["MODEL_PROVIDER_DIGITALOCEAN", "MODEL_PROVIDER_ANTHROPIC", "MODEL_PROVIDER_OPENAI"]]
updated_at: Optional[datetime]
Last modified
upload_complete: Optional[bool]
Model has been fully uploaded
url: Optional[str]
Download url
usecases: Optional[List[Literal["MODEL_USECASE_UNKNOWN", "MODEL_USECASE_AGENT", "MODEL_USECASE_FINETUNED", 4 more]]]
Usecases of the model
uuid: Optional[str]
Unique id
version: Optional[APIModelVersion]
Version Information about a Model
major: Optional[int]
Major version number
minor: Optional[int]
Minor version number
patch: Optional[int]
Patch version number
name: Optional[str]
Name of the agent template
short_description: Optional[str]
The short description of the agent template
summary: Optional[str]
The summary of the agent template
tags: Optional[List[str]]
List of tags associated with the agent template
temperature: Optional[float]
The temperature setting for the agent template
template_type: Optional[Literal["AGENT_TEMPLATE_TYPE_STANDARD", "AGENT_TEMPLATE_TYPE_ONE_CLICK"]]
- AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template
- AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template
top_p: Optional[float]
The top_p setting for the agent template
updated_at: Optional[datetime]
The agent template's last updated date
uuid: Optional[str]
Unique id
updated_at: Optional[datetime]
Last modified
url: Optional[str]
Access your agent under this url
user_id: Optional[str]
Id of user that created the agent
uuid: Optional[str]
Unique agent id
version_hash: Optional[str]
The latest version of the agent