Data Sources

API Reference

Knowledge Bases

Data Sources

Data Sources

Add Data Source to a Knowledge Base

knowledge_bases.data_sources.create(strpath_knowledge_base_uuid, DataSourceCreateParams**kwargs) -> knowledge_base_data_sourceAPIKnowledgeBaseDataSourceDataSourceCreateResponse

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

Delete a Data Source from a Knowledge Base

knowledge_bases.data_sources.delete(strdata_source_uuid, DataSourceDeleteParams**kwargs) -> data_source_uuidstrknowledge_base_uuidstrDataSourceDeleteResponse

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

List Data Sources for a Knowledge Base

knowledge_bases.data_sources.list(strknowledge_base_uuid, DataSourceListParams**kwargs) -> knowledge_base_data_sourceslistlinksAPILinksmetaAPIMetaDataSourceListResponse

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

API File Upload Data Source

APIFileUploadDataSourceclass

File to upload as data source for knowledge base.

ShowShow

original_file_namestr

optional

The original file name

size_in_bytesstr

optional

The size of the file in bytes

formatuint64

stored_object_keystr

optional

The object key the file was stored as

API Knowledge Base Data Source

APIKnowledgeBaseDataSourceclass

Data Source configuration for Knowledge Bases

ShowShow

aws_data_sourcebucket_namestritem_pathstrregionstrAwsDataSource

optional

AWS S3 Data Source for Display

Hide ParametersShow Parameters

bucket_namestr

optional

Spaces bucket name

item_pathstr

optional

regionstr

optional

Region of bucket

bucket_namestr

optional

Name of storage bucket - Deprecated, moved to data_source_details

created_atdatetime

optional

Creation date / time

formatdate-time

dropbox_data_sourcefolderstrDropboxDataSource

optional

Dropbox Data Source for Display

Hide ParametersShow Parameters

folderstr

optional

file_upload_data_sourceAPIFileUploadDataSource

optional

File to upload as data source for knowledge base.

item_pathstr

optional

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

last_datasource_indexing_jobAPIIndexedDataSource

optional

last_indexing_jobAPIIndexingJob

optional

IndexingJob description

regionstr

optional

Region code - Deprecated, moved to data_source_details

spaces_data_sourceAPISpacesDataSource

optional

Spaces Bucket Data Source

updated_atdatetime

optional

Last modified

formatdate-time

uuidstr

optional

Unique id of knowledge base

web_crawler_data_sourceAPIWebCrawlerDataSource

optional

WebCrawlerDataSource

API Spaces Data Source

APISpacesDataSourceclass

Spaces Bucket Data Source

ShowShow

bucket_namestr

optional

Spaces bucket name

item_pathstr

optional

regionstr

optional

Region of bucket

API Web Crawler Data Source

APIWebCrawlerDataSourceclass

WebCrawlerDataSource

ShowShow

base_urlstr

optional

The base url to crawl.

crawling_optionliteral

optional

Optional[Literal["UNKNOWN", "SCOPED", "PATH", 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_mediabool

optional

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

Aws Data Source

AwsDataSourceclass

AWS S3 Data Source

ShowShow

bucket_namestr

optional

Spaces bucket name

item_pathstr

optional

key_idstr

optional

The AWS Key ID

regionstr

optional

Region of bucket

secret_keystr

optional

The AWS Secret Key