Data Sources

List Data Sources for a Knowledge Base

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

Add Data Source to a Knowledge Base

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

Delete a Data Source from a Knowledge Base

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

Create Presigned URLs for Data Source File Upload

post/v2/gen-ai/knowledge_bases/data_sources/file_upload_presigned_urls

ModelsExpand Collapse

APIFileUploadDataSource = object { 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

APIKnowledgeBaseDataSource = object { aws_data_source, bucket_name, created_at, 10 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

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

APISpacesDataSource = object { 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

APIWebCrawlerDataSource = object { 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

AwsDataSource = object { bucket_name, item_path, key_id, 2 more }

AWS S3 Data Source

bucket_name: optional string

Spaces bucket name

item_path: optional string

key_id: optional string

The AWS Key ID

region: optional string

Region of bucket

secret_key: optional string

The AWS Secret Key