Knowledge Bases

Knowledge Bases

Knowledge Bases

knowledge_bases

Methods

Create a Knowledge Base

post/v2/gen-ai/knowledge_bases

To create a knowledge base, send a POST request to /v2/gen-ai/knowledge_bases.

Retrieve Information About an Existing Knowledge Base

get/v2/gen-ai/knowledge_bases/{uuid}

To retrive information about an existing knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{uuid}.

Update a Knowledge Base

put/v2/gen-ai/knowledge_bases/{uuid}

To update a knowledge base, send a PUT request to /v2/gen-ai/knowledge_bases/{uuid}.

List Knowledge Bases

get/v2/gen-ai/knowledge_bases

To list all knowledge bases, send a GET request to /v2/gen-ai/knowledge_bases.

Delete a Knowledge Base

delete/v2/gen-ai/knowledge_bases/{uuid}

To delete a knowledge base, send a DELETE request to /v2/gen-ai/knowledge_bases/{uuid}.

Domain Types

API Knowledge Base

APIKnowledgeBaseobject

ShowShow

added_to_agent_atstring

optional

formatdate-time

created_atstring

optional

formatdate-time

database_idstring

optional

embedding_model_uuidstring

optional

is_publicboolean

optional

last_indexing_jobcompleted_datasourcesnumbercreated_atstringdata_source_uuidsarray of stringfinished_atstringknowledge_base_uuidstringphaseenumstarted_atstringstatusenumtokensnumbertotal_datasourcesnumberupdated_atstringuuidstringAPIIndexingJob

optional

namestring

optional

project_idstring

optional

regionstring

optional

tagsarray of string

optional

updated_atstring

optional

formatdate-time

user_idstring

optional

formatint64

uuidstring

optional

Knowledge BasesData Sources

knowledge_bases.data_sources

Methods

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.

List Data Sources for a Knowledge Base

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

To list all data sources for a knowledge base, send a GET request to /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}

To delete a data source from a knowledge base, send a DELETE request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}.

Domain Types

API File Upload Data Source

APIFileUploadDataSourceobject

File to upload as data source for knowledge base.

ShowShow

original_file_namestring

optional

size_in_bytesstring

optional

formatuint64

stored_object_keystring

optional

API Knowledge Base Data Source

APIKnowledgeBaseDataSourceobject

ShowShow

aws_data_sourceobject

optional

Hide ParametersShow Parameters

bucket_namestring

optional

item_pathstring

optional

regionstring

optional

bucket_namestring

optional

created_atstring

optional

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

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

regionstring

optional

spaces_data_sourcebucket_namestringitem_pathstringregionstringAPISpacesDataSource

optional

updated_atstring

optional

formatdate-time

uuidstring

optional

web_crawler_data_sourcebase_urlstringcrawling_optionenumembed_mediabooleanAPIWebCrawlerDataSource

optional

API Spaces Data Source

APISpacesDataSourceobject

ShowShow

bucket_namestring

optional

item_pathstring

optional

regionstring

optional

API Web Crawler Data Source

APIWebCrawlerDataSourceobject

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

ShowShow

bucket_namestring

optional

item_pathstring

optional

key_idstring

optional

regionstring

optional

secret_keystring

optional

Knowledge BasesIndexing Jobs

knowledge_bases.indexing_jobs

Methods

Start Indexing Job for a Knowledge Base

post/v2/gen-ai/indexing_jobs

To start an indexing job for a knowledge base, send a POST request to /v2/gen-ai/indexing_jobs.

Retrieve Status of Indexing Job for a Knowledge Base

get/v2/gen-ai/indexing_jobs/{uuid}

To get status of an indexing Job for a knowledge base, send a GET request to /v2/gen-ai/indexing_jobs/{uuid}.

List Indexing Jobs for a Knowledge Base

get/v2/gen-ai/indexing_jobs

To list all indexing jobs for a knowledge base, send a GET request to /v2/gen-ai/indexing_jobs.

List Data Sources for Indexing Job for a Knowledge Base

get/v2/gen-ai/indexing_jobs/{indexing_job_uuid}/data_sources

To list all datasources for an indexing job, send a GET request to /v2/gen-ai/indexing_jobs/{indexing_job_uuid}/data_sources.

Cancel Indexing Job for a Knowledge Base

put/v2/gen-ai/indexing_jobs/{uuid}/cancel

To cancel an indexing job for a knowledge base, send a PUT request to /v2/gen-ai/indexing_jobs/{uuid}/cancel.

Domain Types

API Indexed Data Source

APIIndexedDataSourceobject

ShowShow

completed_atstring

optional

formatdate-time

data_source_uuidstring

optional

error_detailsstring

optional

error_msgstring

optional

failed_item_countstring

optional

formatuint64

indexed_file_countstring

optional

formatuint64

indexed_item_countstring

optional

formatuint64

removed_item_countstring

optional

formatuint64

skipped_item_countstring

optional

formatuint64

started_atstring

optional

formatdate-time

statusenum

optional

"DATA_SOURCE_STATUS_UNKNOWN" OR "DATA_SOURCE_STATUS_IN_PROGRESS" OR "DATA_SOURCE_STATUS_UPDATED" OR 3 more

Hide ParametersShow Parameters

"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"

total_bytesstring

optional

formatuint64

total_bytes_indexedstring

optional

formatuint64

total_file_countstring

optional

formatuint64

API Indexing Job

APIIndexingJobobject

ShowShow

completed_datasourcesnumber

optional

formatint64

created_atstring

optional

formatdate-time

data_source_uuidsarray of string

optional

finished_atstring

optional

formatdate-time

knowledge_base_uuidstring

optional

phaseenum

optional

"BATCH_JOB_PHASE_UNKNOWN" OR "BATCH_JOB_PHASE_PENDING" OR "BATCH_JOB_PHASE_RUNNING" OR 4 more

Hide ParametersShow Parameters

"BATCH_JOB_PHASE_UNKNOWN"

"BATCH_JOB_PHASE_PENDING"

"BATCH_JOB_PHASE_RUNNING"

"BATCH_JOB_PHASE_SUCCEEDED"

"BATCH_JOB_PHASE_FAILED"

"BATCH_JOB_PHASE_ERROR"

"BATCH_JOB_PHASE_CANCELLED"

started_atstring

optional

formatdate-time

statusenum

optional

"INDEX_JOB_STATUS_UNKNOWN" OR "INDEX_JOB_STATUS_PARTIAL" OR "INDEX_JOB_STATUS_IN_PROGRESS" OR 4 more

Hide ParametersShow Parameters

"INDEX_JOB_STATUS_UNKNOWN"

"INDEX_JOB_STATUS_PARTIAL"

"INDEX_JOB_STATUS_IN_PROGRESS"

"INDEX_JOB_STATUS_COMPLETED"

"INDEX_JOB_STATUS_FAILED"

"INDEX_JOB_STATUS_NO_CHANGES"

"INDEX_JOB_STATUS_PENDING"

tokensnumber

optional

formatint64

total_datasourcesnumber

optional

formatint64

updated_atstring

optional

formatdate-time

uuidstring

optional