Create

Create a Knowledge Base

knowledge_bases.create() -> KnowledgeBaseCreateResponse

post/v2/gen-ai/knowledge_bases

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

ParametersExpand Collapse

database_id: Optional[str]

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: Optional[Iterable[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: Optional[AwsDataSourceParam]

AWS S3 Data Source

bucket_name: Optional[str]

Deprecated, moved to data_source_details

bucket_region: Optional[str]

Deprecated, moved to data_source_details

dropbox_data_source: Optional[DatasourceDropboxDataSource]

Dropbox Data Source

folder: Optional[str]

refresh_token: Optional[str]

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: Optional[APIFileUploadDataSourceParam]

File to upload as data source for knowledge base.

item_path: Optional[str]

spaces_data_source: Optional[APISpacesDataSourceParam]

Spaces Bucket Data Source

web_crawler_data_source: Optional[APIWebCrawlerDataSourceParam]

WebCrawlerDataSource

embedding_model_uuid: Optional[str]

Identifier for the embedding model.

name: Optional[str]

Name of the knowledge base.

project_id: Optional[str]

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

region: Optional[str]

The datacenter region to deploy the knowledge base in.

tags: Optional[List[str]]

Tags to organize your knowledge base.

vpc_uuid: Optional[str]

The VPC to deploy the knowledge base database in

ReturnsExpand Collapse

class KnowledgeBaseCreateResponse: …

Information about a newly created knowledge base

knowledge_base: Optional[APIKnowledgeBase]

Knowledgebase Description

from gradient import Gradient

client = Gradient()
knowledge_base = client.knowledge_bases.create()
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"
  }
}