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
Information about a linked knowledge base
agent: Optional[APIAgent]An Agent
An Agent
anthropic_api_key: Optional[APIAnthropicAPIKeyInfo]Anthropic API Key Info
Anthropic API Key Info
Key creation date
Created by user id from DO
Key deleted date
Name
Key last updated date
Uuid
Api key infos
Api key infos
Creation date
Created by
Deleted date
Name
Uuid
api_keys: Optional[List[APIKey]]Api keys
Api keys
Api key
chatbot: Optional[Chatbot]A Chatbot
A Chatbot
Name of chatbot
chatbot_identifiers: Optional[List[ChatbotIdentifier]]Chatbot identifiers
Chatbot identifiers
Agent chatbot identifier
Child agents
Whether conversation logs are enabled for the agent
Creation date / time
deployment: Optional[Deployment]Description of deployment
Description of deployment
Creation date / time
Name
status: Optional[Literal["STATUS_UNKNOWN", "STATUS_WAITING_FOR_DEPLOYMENT", "STATUS_DEPLOYING", 7 more]]
Last modified
Access your deployed agent here
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
- 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 of agent
functions: Optional[List[Function]]
Api key
Creation date / time
Created by user id from DO
Agent description
Name
Last modified
Download your agent here
Unique id
guardrails: Optional[List[Guardrail]]The guardrails the agent is attached to
The guardrails the agent is attached to
type: Optional[Literal["GUARDRAIL_TYPE_UNKNOWN", "GUARDRAIL_TYPE_JAILBREAK", "GUARDRAIL_TYPE_SENSITIVE_DATA", "GUARDRAIL_TYPE_CONTENT_MODERATION"]]
Agent instruction. Instructions help your agent to perform its job effectively. See Write Effective Agent Instructions for best practices.
Knowledge bases
Knowledge bases
Time when the knowledge base was added to the agent
Creation date / time
Whether the knowledge base is public or not
last_indexing_job: Optional[APIIndexingJob]IndexingJob description
IndexingJob description
Number of datasources indexed completed
Creation date / time
Details on Data Sources included in the Indexing Job
Details on Data Sources included in the Indexing Job
Timestamp when data source completed indexing
Uuid of the indexed data source
A detailed error description
A string code provinding a hint which part of the system experienced an error
Total count of files that have failed
Total count of files that have been indexed
Total count of files that have been indexed
Total count of files that have been removed
Total count of files that have been skipped
Timestamp when data source started indexing
status: Optional[Literal["DATA_SOURCE_STATUS_UNKNOWN", "DATA_SOURCE_STATUS_IN_PROGRESS", "DATA_SOURCE_STATUS_UPDATED", 4 more]]
Total size of files in data source in bytes
Total size of files in data source in bytes that have been indexed
Total file count in the data source
Boolean value to determine if the indexing job details are available
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]]
Number of tokens [This field is deprecated]
Number of datasources being indexed
Total Items Failed
Total Items Indexed
Total Items Removed
Total Items Skipped
Total Tokens Consumed By the Indexing Job
Last modified
Unique id
Name of knowledge base
Region code
Tags to organize related resources
Last modified
Id of user that created the knowledge base
Unique id for knowledge base
logging_config: Optional[LoggingConfig]
Galileo project identifier
Name of the Galileo project
Whether insights are enabled
Timestamp when insights were enabled
Identifier for the log stream
Name of the log stream
model: Optional[APIAgentModel]Description of a Model
Description of a Model
agreement: Optional[APIAgreement]Agreement Description
Agreement Description
Creation date / time
Internally used name
Internally used version
True if it is a foundational model provided by do
Additional meta data
Name of the model
Unique id of the model, this model is based on
provider: Optional[Literal["MODEL_PROVIDER_DIGITALOCEAN", "MODEL_PROVIDER_ANTHROPIC", "MODEL_PROVIDER_OPENAI"]]
Last modified
Model has been fully uploaded
Download url
usecases: Optional[List[Literal["MODEL_USECASE_UNKNOWN", "MODEL_USECASE_AGENT", "MODEL_USECASE_FINETUNED", 4 more]]]Usecases of the model
Usecases of the model
Unique id
version: Optional[APIModelVersion]Version Information about a Model
Version Information about a Model
Major version number
Minor version number
Patch version number
model_provider_key: Optional[ModelProviderKey]
API key ID
Key creation date
Created by user id from DO
Key deleted date
Models supported by the openAI api key
Models supported by the openAI api key
agreement: Optional[APIAgreement]Agreement Description
Agreement Description
Creation date / time
Internally used name
Internally used version
True if it is a foundational model provided by do
Additional meta data
Name of the model
Unique id of the model, this model is based on
provider: Optional[Literal["MODEL_PROVIDER_DIGITALOCEAN", "MODEL_PROVIDER_ANTHROPIC", "MODEL_PROVIDER_OPENAI"]]
Last modified
Model has been fully uploaded
Download url
usecases: Optional[List[Literal["MODEL_USECASE_UNKNOWN", "MODEL_USECASE_AGENT", "MODEL_USECASE_FINETUNED", 4 more]]]Usecases of the model
Usecases of the model
Unique id
version: Optional[APIModelVersion]Version Information about a Model
Version Information about a Model
Major version number
Minor version number
Patch version number
Name of the key
provider: Optional[Literal["MODEL_PROVIDER_DIGITALOCEAN", "MODEL_PROVIDER_ANTHROPIC", "MODEL_PROVIDER_OPENAI"]]
Key last updated date
Agent name
openai_api_key: Optional[APIOpenAIAPIKeyInfo]OpenAI API Key Info
OpenAI API Key Info
Key creation date
Created by user id from DO
Key deleted date
Models supported by the openAI api key
Models supported by the openAI api key
agreement: Optional[APIAgreement]Agreement Description
Agreement Description
Creation date / time
Internally used name
Internally used version
True if it is a foundational model provided by do
Additional meta data
Name of the model
Unique id of the model, this model is based on
provider: Optional[Literal["MODEL_PROVIDER_DIGITALOCEAN", "MODEL_PROVIDER_ANTHROPIC", "MODEL_PROVIDER_OPENAI"]]
Last modified
Model has been fully uploaded
Download url
usecases: Optional[List[Literal["MODEL_USECASE_UNKNOWN", "MODEL_USECASE_AGENT", "MODEL_USECASE_FINETUNED", 4 more]]]Usecases of the model
Usecases of the model
Unique id
version: Optional[APIModelVersion]Version Information about a Model
Version Information about a Model
Major version number
Minor version number
Patch version number
Name
Key last updated date
Uuid
Parent agents
Whether the agent should provide in-response citations
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
- 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
Creation of route date / time
Route name
Agent tag to organize related resources
template: Optional[Template]Represents an AgentTemplate entity
Represents an AgentTemplate entity
The agent template's creation date
Deprecated - Use summary instead
guardrails: Optional[List[TemplateGuardrail]]List of guardrails associated with the agent template
List of guardrails associated with the agent template
Priority of the guardrail
Uuid of the guardrail
Instructions for the agent template
The 'k' value for the agent template
List of knowledge bases associated with the agent template
List of knowledge bases associated with the agent template
Time when the knowledge base was added to the agent
Creation date / time
Whether the knowledge base is public or not
last_indexing_job: Optional[APIIndexingJob]IndexingJob description
IndexingJob description
Number of datasources indexed completed
Creation date / time
Details on Data Sources included in the Indexing Job
Details on Data Sources included in the Indexing Job
Timestamp when data source completed indexing
Uuid of the indexed data source
A detailed error description
A string code provinding a hint which part of the system experienced an error
Total count of files that have failed
Total count of files that have been indexed
Total count of files that have been indexed
Total count of files that have been removed
Total count of files that have been skipped
Timestamp when data source started indexing
status: Optional[Literal["DATA_SOURCE_STATUS_UNKNOWN", "DATA_SOURCE_STATUS_IN_PROGRESS", "DATA_SOURCE_STATUS_UPDATED", 4 more]]
Total size of files in data source in bytes
Total size of files in data source in bytes that have been indexed
Total file count in the data source
Boolean value to determine if the indexing job details are available
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]]
Number of tokens [This field is deprecated]
Number of datasources being indexed
Total Items Failed
Total Items Indexed
Total Items Removed
Total Items Skipped
Total Tokens Consumed By the Indexing Job
Last modified
Unique id
Name of knowledge base
Region code
Tags to organize related resources
Last modified
Id of user that created the knowledge base
Unique id for knowledge base
The long description of the agent template
The max_tokens setting for the agent template
model: Optional[APIAgentModel]Description of a Model
Description of a Model
agreement: Optional[APIAgreement]Agreement Description
Agreement Description
Creation date / time
Internally used name
Internally used version
True if it is a foundational model provided by do
Additional meta data
Name of the model
Unique id of the model, this model is based on
provider: Optional[Literal["MODEL_PROVIDER_DIGITALOCEAN", "MODEL_PROVIDER_ANTHROPIC", "MODEL_PROVIDER_OPENAI"]]
Last modified
Model has been fully uploaded
Download url
usecases: Optional[List[Literal["MODEL_USECASE_UNKNOWN", "MODEL_USECASE_AGENT", "MODEL_USECASE_FINETUNED", 4 more]]]Usecases of the model
Usecases of the model
Unique id
version: Optional[APIModelVersion]Version Information about a Model
Version Information about a Model
Major version number
Minor version number
Patch version number
Name of the agent template
The short description of the agent template
The summary of the agent template
List of tags associated with the agent template
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
- AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template
- AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template
The top_p setting for the agent template
The agent template's last updated date
Unique id
Last modified
Access your agent under this url
Id of user that created the agent
Unique agent id
The latest version of the agent
VPC Egress IPs