Create

Create a Knowledge Base

post/v2/gen-ai/knowledge_bases

To create a knowledge base, send a POST request to /v2/gen-ai/knowledge_bases.

Body Parameters

database_idstring

optional

Identifier of the DigitalOcean OpenSearch database this knowledge base will use, optional. If not provided, we create a new database for the knowledge base in the same region as the knowledge base.

datasourcesarray of object

optional

The data sources to use for this knowledge base. See Organize Data Sources for more information on data sources best practices.

Hide ParametersShow Parameters

aws_data_sourcebucket_namestringitem_pathstringkey_idstringregionstringsecret_keystringAwsDataSource

optional

AWS S3 Data Source

bucket_namestring

optional

Deprecated, moved to data_source_details

bucket_regionstring

optional

Deprecated, moved to data_source_details

file_upload_data_sourceoriginal_file_namestringsize_in_bytesstringstored_object_keystringAPIFileUploadDataSource

optional

File to upload as data source for knowledge base.

item_pathstring

optional

spaces_data_sourcebucket_namestringitem_pathstringregionstringAPISpacesDataSource

optional

Spaces Bucket Data Source

web_crawler_data_sourcebase_urlstringcrawling_optionenumembed_mediabooleanAPIWebCrawlerDataSource

optional

WebCrawlerDataSource

embedding_model_uuidstring

optional

Identifier for the embedding model.

namestring

optional

Name of the knowledge base.

project_idstring

optional

Identifier of the DigitalOcean project this knowledge base will belong to.

regionstring

optional

The datacenter region to deploy the knowledge base in.

tagsarray of string

optional

Tags to organize your knowledge base.

vpc_uuidstring

optional

The VPC to deploy the knowledge base database in

Returns

knowledge_baseadded_to_agent_atstringcreated_atstringdatabase_idstringembedding_model_uuidstringis_publicbooleanlast_indexing_jobAPIIndexingJobnamestringproject_idstringregionstringtagsarray of stringupdated_atstringuser_idstringuuidstringAPIKnowledgeBase

optional

Knowledgebase Description

HTTPPython

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

200 Example

{
  "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,
      "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\""
  }
}