Update Data Source options

put/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}

To update a data source (e.g. chunking options), send a PUT request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}.

Path ParametersExpand Collapse

knowledge_base_uuid: string

data_source_uuid: string

Body ParametersExpand Collapse

chunking_algorithm: optional "CHUNKING_ALGORITHM_UNKNOWN" or "CHUNKING_ALGORITHM_SECTION_BASED" or "CHUNKING_ALGORITHM_HIERARCHICAL" or 2 more

The chunking algorithm to use for processing data sources.

Note: This feature requires enabling the knowledgebase enhancements feature preview flag.

Accepts one of the following:

"CHUNKING_ALGORITHM_UNKNOWN"

"CHUNKING_ALGORITHM_SECTION_BASED"

"CHUNKING_ALGORITHM_HIERARCHICAL"

"CHUNKING_ALGORITHM_SEMANTIC"

"CHUNKING_ALGORITHM_FIXED_LENGTH"

chunking_options: optional object { child_chunk_size, max_chunk_size, parent_chunk_size, semantic_threshold }

Configuration options for the chunking algorithm.

Note: This feature requires enabling the knowledgebase enhancements feature preview flag.

child_chunk_size: optional number

Hierarchical options

formatint64

max_chunk_size: optional number

Section_Based and Fixed_Length options

formatint64

parent_chunk_size: optional number

Hierarchical options

formatint64

semantic_threshold: optional number

Semantic options

formatfloat

data_source_uuid: optional string

Data Source ID (Path Parameter)

knowledge_base_uuid: optional string

Knowledge Base ID (Path Parameter)

ReturnsExpand Collapse

knowledge_base_data_source: optional APIKnowledgeBaseDataSource { aws_data_source, bucket_name, chunking_algorithm, 12 more }

Data Source configuration for Knowledge Bases

aws_data_source: optional object { bucket_name, item_path, region }

AWS S3 Data Source for Display

bucket_name: optional string

Spaces bucket name

item_path: optional string

region: optional string

Region of bucket

bucket_name: optional string

Name of storage bucket - Deprecated, moved to data_source_details

chunking_algorithm: optional "CHUNKING_ALGORITHM_UNKNOWN" or "CHUNKING_ALGORITHM_SECTION_BASED" or "CHUNKING_ALGORITHM_HIERARCHICAL" or 2 more

The chunking algorithm to use for processing data sources.

Note: This feature requires enabling the knowledgebase enhancements feature preview flag.

Accepts one of the following:

"CHUNKING_ALGORITHM_UNKNOWN"

"CHUNKING_ALGORITHM_SECTION_BASED"

"CHUNKING_ALGORITHM_HIERARCHICAL"

"CHUNKING_ALGORITHM_SEMANTIC"

"CHUNKING_ALGORITHM_FIXED_LENGTH"

chunking_options: optional object { child_chunk_size, max_chunk_size, parent_chunk_size, semantic_threshold }

Configuration options for the chunking algorithm.

Note: This feature requires enabling the knowledgebase enhancements feature preview flag.

child_chunk_size: optional number

Hierarchical options

formatint64

max_chunk_size: optional number

Section_Based and Fixed_Length options

formatint64

parent_chunk_size: optional number

Hierarchical options

formatint64

semantic_threshold: optional number

Semantic options

formatfloat

created_at: optional string

Creation date / time

formatdate-time

dropbox_data_source: optional object { folder }

Dropbox Data Source for Display

folder: optional string

file_upload_data_source: optional APIFileUploadDataSource { original_file_name, size_in_bytes, stored_object_key }

File to upload as data source for knowledge base.

original_file_name: optional string

The original file name

size_in_bytes: optional string

The size of the file in bytes

formatuint64

stored_object_key: optional string

The object key the file was stored as

google_drive_data_source: optional object { folder_id, folder_name }

Google Drive Data Source for Display

folder_id: optional string

folder_name: optional string

Name of the selected folder if available

item_path: optional string

Path of folder or object in bucket - Deprecated, moved to data_source_details

last_datasource_indexing_job: optional APIIndexedDataSource { completed_at, data_source_uuid, error_details, 11 more }

completed_at: optional string

Timestamp when data source completed indexing

formatdate-time

data_source_uuid: optional string

Uuid of the indexed data source

error_details: optional string

A detailed error description

error_msg: optional string

A string code provinding a hint which part of the system experienced an error

failed_item_count: optional string

Total count of files that have failed

formatuint64

indexed_file_count: optional string

Total count of files that have been indexed

formatuint64

indexed_item_count: optional string

Total count of files that have been indexed

formatuint64

removed_item_count: optional string

Total count of files that have been removed

formatuint64

skipped_item_count: optional string

Total count of files that have been skipped

formatuint64

started_at: optional string

Timestamp when data source started indexing

formatdate-time

status: optional "DATA_SOURCE_STATUS_UNKNOWN" or "DATA_SOURCE_STATUS_IN_PROGRESS" or "DATA_SOURCE_STATUS_UPDATED" or 4 more

Accepts one of the following:

"DATA_SOURCE_STATUS_UNKNOWN"

"DATA_SOURCE_STATUS_IN_PROGRESS"

"DATA_SOURCE_STATUS_UPDATED"

"DATA_SOURCE_STATUS_PARTIALLY_UPDATED"

"DATA_SOURCE_STATUS_NOT_UPDATED"

"DATA_SOURCE_STATUS_FAILED"

"DATA_SOURCE_STATUS_CANCELLED"

total_bytes: optional string

Total size of files in data source in bytes

formatuint64

total_bytes_indexed: optional string

Total size of files in data source in bytes that have been indexed

formatuint64

total_file_count: optional string

Total file count in the data source

formatuint64

region: optional string

Region code - Deprecated, moved to data_source_details

spaces_data_source: optional APISpacesDataSource { bucket_name, item_path, region }

Spaces Bucket Data Source

bucket_name: optional string

Spaces bucket name

item_path: optional string

region: optional string

Region of bucket

updated_at: optional string

Last modified

formatdate-time

uuid: optional string

Unique id of knowledge base

web_crawler_data_source: optional APIWebCrawlerDataSource { base_url, crawling_option, embed_media, exclude_tags }

WebCrawlerDataSource

base_url: optional string

The base url to crawl.

crawling_option: optional "UNKNOWN" or "SCOPED" or "PATH" or 3 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.
SITEMAP: Crawl URLs discovered in the sitemap.

Accepts one of the following:

"UNKNOWN"

"SCOPED"

"PATH"

"DOMAIN"

"SUBDOMAINS"

"SITEMAP"

embed_media: optional boolean

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

exclude_tags: optional array of string

Declaring which tags to exclude in web pages while webcrawling

Update Data Source options

curl https://api.digitalocean.com/v2/gen-ai/knowledge_bases/$KNOWLEDGE_BASE_UUID/data_sources/$DATA_SOURCE_UUID \
    -X PUT \
    -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"

{
  "knowledge_base_data_source": {
    "aws_data_source": {
      "bucket_name": "example name",
      "item_path": "example string",
      "region": "example string"
    },
    "bucket_name": "example name",
    "chunking_algorithm": "CHUNKING_ALGORITHM_SECTION_BASED",
    "chunking_options": {
      "child_chunk_size": 350,
      "max_chunk_size": 750,
      "parent_chunk_size": 1000,
      "semantic_threshold": 0.5
    },
    "created_at": "2023-01-01T00:00:00Z",
    "dropbox_data_source": {
      "folder": "example string"
    },
    "file_upload_data_source": {
      "original_file_name": "example name",
      "size_in_bytes": "12345",
      "stored_object_key": "example string"
    },
    "google_drive_data_source": {
      "folder_id": "123e4567-e89b-12d3-a456-426614174000",
      "folder_name": "example name"
    },
    "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"
    },
    "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,
      "exclude_tags": [
        "example string"
      ]
    }
  }
}

Returns Examples

{
  "knowledge_base_data_source": {
    "aws_data_source": {
      "bucket_name": "example name",
      "item_path": "example string",
      "region": "example string"
    },
    "bucket_name": "example name",
    "chunking_algorithm": "CHUNKING_ALGORITHM_SECTION_BASED",
    "chunking_options": {
      "child_chunk_size": 350,
      "max_chunk_size": 750,
      "parent_chunk_size": 1000,
      "semantic_threshold": 0.5
    },
    "created_at": "2023-01-01T00:00:00Z",
    "dropbox_data_source": {
      "folder": "example string"
    },
    "file_upload_data_source": {
      "original_file_name": "example name",
      "size_in_bytes": "12345",
      "stored_object_key": "example string"
    },
    "google_drive_data_source": {
      "folder_id": "123e4567-e89b-12d3-a456-426614174000",
      "folder_name": "example name"
    },
    "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"
    },
    "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,
      "exclude_tags": [
        "example string"
      ]
    }
  }
}