Update

Update a Knowledge Base

put/v2/gen-ai/knowledge_bases/{uuid}

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

Path Parameters

uuidstring

Body Parameters

database_idstring

optional

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

embedding_model_uuidstring

optional

Identifier for the foundation model.

namestring

optional

project_idstring

optional

tagsarray of string

optional

Tags to organize your knowledge base.

uuidstring

optional

Returns

knowledge_baseadded_to_agent_atstringcreated_atstringdatabase_idstringembedding_model_uuidstringis_publicbooleanlast_indexing_jobAPIIndexingJobnamestringproject_idstringregionstringtagsarray of stringupdated_atstringuser_idstringuuidstringAPIKnowledgeBase

optional

Request example cURL

curl https://api.digitalocean.com//v2/gen-ai/knowledge_bases/$UUID \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY" \
    -d '{}'

200 Example

{
  "knowledge_base": {
    "added_to_agent_at": "2019-12-27T18:11:19.117Z",
    "created_at": "2019-12-27T18:11:19.117Z",
    "database_id": "database_id",
    "embedding_model_uuid": "embedding_model_uuid",
    "is_public": true,
    "last_indexing_job": {
      "completed_datasources": 0,
      "created_at": "2019-12-27T18:11:19.117Z",
      "data_source_uuids": [
        "string"
      ],
      "finished_at": "2019-12-27T18:11:19.117Z",
      "knowledge_base_uuid": "knowledge_base_uuid",
      "phase": "BATCH_JOB_PHASE_UNKNOWN",
      "started_at": "2019-12-27T18:11:19.117Z",
      "status": "INDEX_JOB_STATUS_UNKNOWN",
      "tokens": 0,
      "total_datasources": 0,
      "updated_at": "2019-12-27T18:11:19.117Z",
      "uuid": "uuid"
    },
    "name": "name",
    "project_id": "project_id",
    "region": "region",
    "tags": [
      "string"
    ],
    "updated_at": "2019-12-27T18:11:19.117Z",
    "user_id": "user_id",
    "uuid": "uuid"
  }
}