Skip to content
DigitalOcean Gradient™ AI Agentic Cloud SDK Docs
  • Auto
  • Light
  • Dark

Update

API Reference
Knowledge Bases
Update a Knowledge Base
knowledge_bases.update(strpath_uuid, KnowledgeBaseUpdateParams**kwargs) -> KnowledgeBaseUpdateResponse
put/v2/gen-ai/knowledge_bases/{uuid}

To update a knowledge base, send a PUT request to /v2/gen-ai/knowledge_bases/{uuid}.

ParametersExpand Collapse
uuid: str
database_id: Optional[str]

The id of the DigitalOcean database this knowledge base will use, optiona.

embedding_model_uuid: Optional[str]

Identifier for the foundation model.

name: Optional[str]

Knowledge base name

project_id: Optional[str]

The id of the DigitalOcean project this knowledge base will belong to

tags: Optional[SequenceNotStr[str]]

Tags to organize your knowledge base.

uuid: str
ReturnsExpand Collapse
class KnowledgeBaseUpdateResponse: …

Information about an updated knowledge base

knowledge_base: Optional[APIKnowledgeBase]

Knowledgebase Description

added_to_agent_at: Optional[datetime]

Time when the knowledge base was added to the agent

formatdate-time
created_at: Optional[datetime]

Creation date / time

formatdate-time
database_id: Optional[str]
embedding_model_uuid: Optional[str]
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

formatint64
created_at: Optional[datetime]

Creation date / time

formatdate-time
data_source_uuids: Optional[List[str]]
finished_at: Optional[datetime]
formatdate-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]]
Accepts one of the following:
"BATCH_JOB_PHASE_UNKNOWN"
"BATCH_JOB_PHASE_PENDING"
"BATCH_JOB_PHASE_RUNNING"
"BATCH_JOB_PHASE_SUCCEEDED"
"BATCH_JOB_PHASE_FAILED"
"BATCH_JOB_PHASE_ERROR"
"BATCH_JOB_PHASE_CANCELLED"
started_at: Optional[datetime]
formatdate-time
status: Optional[Literal["INDEX_JOB_STATUS_UNKNOWN", "INDEX_JOB_STATUS_PARTIAL", "INDEX_JOB_STATUS_IN_PROGRESS", 4 more]]
Accepts one of the following:
"INDEX_JOB_STATUS_UNKNOWN"
"INDEX_JOB_STATUS_PARTIAL"
"INDEX_JOB_STATUS_IN_PROGRESS"
"INDEX_JOB_STATUS_COMPLETED"
"INDEX_JOB_STATUS_FAILED"
"INDEX_JOB_STATUS_NO_CHANGES"
"INDEX_JOB_STATUS_PENDING"
tokens: Optional[int]

Number of tokens

formatint64
total_datasources: Optional[int]

Number of datasources being indexed

formatint64
total_items_failed: Optional[str]

Total Items Failed

formatuint64
total_items_indexed: Optional[str]

Total Items Indexed

formatuint64
total_items_skipped: Optional[str]

Total Items Skipped

formatuint64
updated_at: Optional[datetime]

Last modified

formatdate-time
uuid: Optional[str]

Unique id

name: Optional[str]

Name of knowledge base

project_id: Optional[str]
region: Optional[str]

Region code

tags: Optional[List[str]]

Tags to organize related resources

updated_at: Optional[datetime]

Last modified

formatdate-time
user_id: Optional[str]

Id of user that created the knowledge base

formatint64
uuid: Optional[str]

Unique id for knowledge base

Update a Knowledge Base
  • http
  • typescript
  • python
from gradient import Gradient

client = Gradient(
    access_token="My Access Token",
)
knowledge_base = client.knowledge_bases.update(
    path_uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
)
print(knowledge_base.knowledge_base)
{
  "knowledge_base": {
    "added_to_agent_at": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "database_id": "123e4567-e89b-12d3-a456-426614174000",
    "embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "is_public": true,
    "last_indexing_job": {
      "completed_datasources": 123,
      "created_at": "2023-01-01T00:00:00Z",
      "data_source_uuids": [
        "example string"
      ],
      "finished_at": "2023-01-01T00:00:00Z",
      "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "phase": "BATCH_JOB_PHASE_UNKNOWN",
      "started_at": "2023-01-01T00:00:00Z",
      "status": "INDEX_JOB_STATUS_UNKNOWN",
      "tokens": 123,
      "total_datasources": 123,
      "total_items_failed": "12345",
      "total_items_indexed": "12345",
      "total_items_skipped": "12345",
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    },
    "name": "example name",
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "region": "example string",
    "tags": [
      "example string"
    ],
    "updated_at": "2023-01-01T00:00:00Z",
    "user_id": "user_id",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}
Returns Examples
{
  "knowledge_base": {
    "added_to_agent_at": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "database_id": "123e4567-e89b-12d3-a456-426614174000",
    "embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "is_public": true,
    "last_indexing_job": {
      "completed_datasources": 123,
      "created_at": "2023-01-01T00:00:00Z",
      "data_source_uuids": [
        "example string"
      ],
      "finished_at": "2023-01-01T00:00:00Z",
      "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "phase": "BATCH_JOB_PHASE_UNKNOWN",
      "started_at": "2023-01-01T00:00:00Z",
      "status": "INDEX_JOB_STATUS_UNKNOWN",
      "tokens": 123,
      "total_datasources": 123,
      "total_items_failed": "12345",
      "total_items_indexed": "12345",
      "total_items_skipped": "12345",
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    },
    "name": "example name",
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "region": "example string",
    "tags": [
      "example string"
    ],
    "updated_at": "2023-01-01T00:00:00Z",
    "user_id": "user_id",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}