Create

Add Data Source to a Knowledge Base

post/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources

To add a data source to a knowledge base, send a POST request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources.

Path Parameters

knowledge_base_uuidstring

Body Parameters

aws_data_sourcebucket_namestringitem_pathstringkey_idstringregionstringsecret_keystringAwsDataSource

optional

AWS S3 Data Source

knowledge_base_uuidstring

optional

Knowledge base id

spaces_data_sourcebucket_namestringitem_pathstringregionstringAPISpacesDataSource

optional

Spaces Bucket Data Source

web_crawler_data_sourcebase_urlstringcrawling_optionenumembed_mediabooleanAPIWebCrawlerDataSource

optional

WebCrawlerDataSource

Returns

knowledge_base_data_sourceaws_data_sourceobjectbucket_namestringcreated_atstringfile_upload_data_sourceAPIFileUploadDataSourceitem_pathstringlast_datasource_indexing_jobAPIIndexedDataSourcelast_indexing_jobAPIIndexingJobregionstringspaces_data_sourceAPISpacesDataSourceupdated_atstringuuidstringweb_crawler_data_sourceAPIWebCrawlerDataSourceAPIKnowledgeBaseDataSource

optional

Data Source configuration for Knowledge Bases

HTTPPython

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

200 Example

{
  "knowledge_base_data_source": {
    "aws_data_source": {
      "bucket_name": "\"example name\"",
      "item_path": "\"example string\"",
      "region": "\"example string\""
    },
    "bucket_name": "\"example name\"",
    "created_at": "2023-01-01T00:00:00Z",
    "file_upload_data_source": {
      "original_file_name": "\"example name\"",
      "size_in_bytes": "\"12345\"",
      "stored_object_key": "\"example string\""
    },
    "item_path": "\"example string\"",
    "last_datasource_indexing_job": {
      "completed_at": "2023-01-01T00:00:00Z",
      "data_source_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
      "error_details": "\"example string\"",
      "error_msg": "\"example string\"",
      "failed_item_count": "\"12345\"",
      "indexed_file_count": "\"12345\"",
      "indexed_item_count": "\"12345\"",
      "removed_item_count": "\"12345\"",
      "skipped_item_count": "\"12345\"",
      "started_at": "2023-01-01T00:00:00Z",
      "status": "DATA_SOURCE_STATUS_UNKNOWN",
      "total_bytes": "\"12345\"",
      "total_bytes_indexed": "\"12345\"",
      "total_file_count": "\"12345\""
    },
    "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\""
    },
    "region": "\"example string\"",
    "spaces_data_source": {
      "bucket_name": "\"example name\"",
      "item_path": "\"example string\"",
      "region": "\"example string\""
    },
    "updated_at": "2023-01-01T00:00:00Z",
    "uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
    "web_crawler_data_source": {
      "base_url": "\"example string\"",
      "crawling_option": "UNKNOWN",
      "embed_media": true
    }
  }
}