Create

Create a Knowledge Base

knowledge_bases.create(KnowledgeBaseCreateParams**kwargs) -> knowledge_baseAPIKnowledgeBaseKnowledgeBaseCreateResponse

post/v2/gen-ai/knowledge_bases

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

Parameters

database_idstr

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.

datasourcesiterable

optional

aws_data_sourceAwsDataSourceParambucket_namestrbucket_regionstrfile_upload_data_sourceAPIFileUploadDataSourceParamitem_pathstrspaces_data_sourceAPISpacesDataSourceParamweb_crawler_data_sourceAPIWebCrawlerDataSourceParamIterable[Datasource]

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_namestritem_pathstrkey_idstrregionstrsecret_keystrAwsDataSourceParam

optional

AWS S3 Data Source

bucket_namestr

optional

Deprecated, moved to data_source_details

bucket_regionstr

optional

Deprecated, moved to data_source_details

file_upload_data_sourceoriginal_file_namestrsize_in_bytesstrstored_object_keystrAPIFileUploadDataSourceParam

optional

File to upload as data source for knowledge base.

item_pathstr

optional

spaces_data_sourcebucket_namestritem_pathstrregionstrAPISpacesDataSourceParam

optional

Spaces Bucket Data Source

web_crawler_data_sourcebase_urlstrcrawling_optionliteralembed_mediaboolAPIWebCrawlerDataSourceParam

optional

WebCrawlerDataSource

embedding_model_uuidstr

optional

Identifier for the embedding model.

namestr

optional

Name of the knowledge base.

project_idstr

optional

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

regionstr

optional

The datacenter region to deploy the knowledge base in.

tagslist

optional

List[str]

Tags to organize your knowledge base.

vpc_uuidstr

optional

The VPC to deploy the knowledge base database in

Returns

KnowledgeBaseCreateResponseclass

Information about a newly created knowledge base

Hide ParametersShow Parameters

knowledge_baseAPIKnowledgeBase

optional

Knowledgebase Description

HTTPPython

from do_gradientai import GradientAI

client = GradientAI()
knowledge_base = client.knowledge_bases.create()
print(knowledge_base.knowledge_base)

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