Skip to content
  • Auto
  • Light
  • Dark

Data Sources

Data Sources

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}
List Data Sources for a Knowledge Base
get/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources
API File Upload Data Source
APIFileUploadDataSourceobject

File to upload as data source for knowledge base.

ShowShow
original_file_namestring
optional

The original file name

size_in_bytesstring
optional

The size of the file in bytes

formatuint64
stored_object_keystring
optional

The object key the file was stored as

API Knowledge Base Data Source
APIKnowledgeBaseDataSourceobject

Data Source configuration for Knowledge Bases

ShowShow
aws_data_sourceobject
optional

AWS S3 Data Source for Display

Hide ParametersShow Parameters
bucket_namestring
optional

Spaces bucket name

item_pathstring
optional
regionstring
optional

Region of bucket

bucket_namestring
optional

Name of storage bucket - Deprecated, moved to data_source_details

created_atstring
optional

Creation date / time

formatdate-time
file_upload_data_sourceoriginal_file_namestringsize_in_bytesstringstored_object_keystringAPIFileUploadDataSource
optional

File to upload as data source for knowledge base.

item_pathstring
optional

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

last_datasource_indexing_jobcompleted_atstringdata_source_uuidstringerror_detailsstringerror_msgstringfailed_item_countstringindexed_file_countstringindexed_item_countstringremoved_item_countstringskipped_item_countstringstarted_atstringstatusenumtotal_bytesstringtotal_bytes_indexedstringtotal_file_countstringAPIIndexedDataSource
optional
last_indexing_jobcompleted_datasourcesnumbercreated_atstringdata_source_uuidsarray of stringfinished_atstringknowledge_base_uuidstringphaseenumstarted_atstringstatusenumtokensnumbertotal_datasourcesnumberupdated_atstringuuidstringAPIIndexingJob
optional

IndexingJob description

regionstring
optional

Region code - Deprecated, moved to data_source_details

spaces_data_sourcebucket_namestringitem_pathstringregionstringAPISpacesDataSource
optional

Spaces Bucket Data Source

updated_atstring
optional

Last modified

formatdate-time
uuidstring
optional

Unique id of knowledge base

web_crawler_data_sourcebase_urlstringcrawling_optionenumembed_mediabooleanAPIWebCrawlerDataSource
optional

WebCrawlerDataSource

API Spaces Data Source
APISpacesDataSourceobject

Spaces Bucket Data Source

ShowShow
bucket_namestring
optional

Spaces bucket name

item_pathstring
optional
regionstring
optional

Region of bucket

API Web Crawler Data Source
APIWebCrawlerDataSourceobject

WebCrawlerDataSource

ShowShow
base_urlstring
optional

The base url to crawl.

crawling_optionenum
optional
"UNKNOWN" OR "SCOPED" OR "PATH" OR 2 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.
Hide ParametersShow Parameters
"UNKNOWN"
"SCOPED"
"PATH"
"DOMAIN"
"SUBDOMAINS"
embed_mediaboolean
optional

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

Aws Data Source
AwsDataSourceobject

AWS S3 Data Source

ShowShow
bucket_namestring
optional

Spaces bucket name

item_pathstring
optional
key_idstring
optional

The AWS Key ID

regionstring
optional

Region of bucket

secret_keystring
optional

The AWS Secret Key