Create

API Reference

Knowledge Bases

Create a Knowledge Base

client.knowledgeBases.create(?, ?): KnowledgeBaseCreateResponse { knowledge_base }

post/v2/gen-ai/knowledge_bases

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

ParametersExpand Collapse

body: KnowledgeBaseCreateParams { database_id, datasources, embedding_model_uuid, 5 more }

database_id?: string

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.

datasources?: Array<Datasource>

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

aws_data_source?: AwsDataSource { bucket_name, item_path, key_id, 2 more }

AWS S3 Data Source

bucket_name?: string

Spaces bucket name

item_path?: string

key_id?: string

The AWS Key ID

region?: string

Region of bucket

secret_key?: string

The AWS Secret Key

bucket_name?: string

Deprecated, moved to data_source_details

bucket_region?: string

Deprecated, moved to data_source_details

dropbox_data_source?: DropboxDataSource { folder, refresh_token }

Dropbox Data Source

folder?: string

refresh_token?: string

Refresh token. you can obrain a refresh token by following the oauth2 flow. see /v2/gen-ai/oauth2/dropbox/tokens for reference.

file_upload_data_source?: APIFileUploadDataSource { original_file_name, size_in_bytes, stored_object_key }

File to upload as data source for knowledge base.

original_file_name?: string

The original file name

size_in_bytes?: string

The size of the file in bytes

formatuint64

stored_object_key?: string

The object key the file was stored as

item_path?: string

spaces_data_source?: APISpacesDataSource { bucket_name, item_path, region }

Spaces Bucket Data Source

bucket_name?: string

Spaces bucket name

item_path?: string

region?: string

Region of bucket

web_crawler_data_source?: APIWebCrawlerDataSource { base_url, crawling_option, embed_media }

WebCrawlerDataSource

base_url?: string

The base url to crawl.

crawling_option?: "UNKNOWN" | "SCOPED" | "PATH" | 2 more

Options for specifying how URLs found on pages should be handled.

UNKNOWN: Default unknown value
SCOPED: Only include the base URL.
PATH: Crawl the base URL and linked pages within the URL path.
DOMAIN: Crawl the base URL and linked pages within the same domain.
SUBDOMAINS: Crawl the base URL and linked pages for any subdomain.

Accepts one of the following:

"UNKNOWN"

"SCOPED"

"PATH"

"DOMAIN"

"SUBDOMAINS"

embed_media?: boolean

Whether to ingest and index media (images, etc.) on web pages.

embedding_model_uuid?: string

Identifier for the embedding model.

name?: string

Name of the knowledge base.

project_id?: string

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

region?: string

The datacenter region to deploy the knowledge base in.

tags?: Array<string>

Tags to organize your knowledge base.

vpc_uuid?: string

The VPC to deploy the knowledge base database in

ReturnsExpand Collapse

KnowledgeBaseCreateResponse { knowledge_base }

Information about a newly created knowledge base

knowledge_base?: APIKnowledgeBase { added_to_agent_at, created_at, database_id, 10 more }

Knowledgebase Description

added_to_agent_at?: string

Time when the knowledge base was added to the agent

formatdate-time

created_at?: string

Creation date / time

formatdate-time

database_id?: string

embedding_model_uuid?: string

is_public?: boolean

Whether the knowledge base is public or not

last_indexing_job?: APIIndexingJob { completed_datasources, created_at, data_source_uuids, 12 more }

IndexingJob description

completed_datasources?: number

Number of datasources indexed completed

formatint64

created_at?: string

Creation date / time

formatdate-time

data_source_uuids?: Array<string>

finished_at?: string

knowledge_base_uuid?: string

Knowledge base id

phase?: "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?: string

status?: "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?: number

Number of tokens

formatint64

total_datasources?: number

Number of datasources being indexed

formatint64

total_items_failed?: string

Total Items Failed

formatuint64

total_items_indexed?: string

Total Items Indexed

formatuint64

total_items_skipped?: string

Total Items Skipped

formatuint64

updated_at?: string

Last modified

formatdate-time

uuid?: string

Unique id

name?: string

Name of knowledge base

project_id?: string

region?: string

Region code

tags?: Array<string>

Tags to organize related resources

updated_at?: string

Last modified

formatdate-time

user_id?: string

Id of user that created the knowledge base

formatint64

uuid?: string

Unique id for knowledge base

Create a Knowledge Base

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const knowledgeBase = await client.knowledgeBases.create();

console.log(knowledgeBase.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"
  }
}