Indexing Jobs

API Reference

Knowledge Bases

Indexing Jobs

Indexing Jobs

Start Indexing Job for a Knowledge Base

knowledge_bases.indexing_jobs.create(IndexingJobCreateParams**kwargs) -> jobAPIIndexingJobIndexingJobCreateResponse

post/v2/gen-ai/indexing_jobs

List Indexing Jobs for a Knowledge Base

knowledge_bases.indexing_jobs.list(IndexingJobListParams**kwargs) -> jobslistlinksAPILinksmetaAPIMetaIndexingJobListResponse

get/v2/gen-ai/indexing_jobs

Retrieve Status of Indexing Job for a Knowledge Base

knowledge_bases.indexing_jobs.retrieve(struuid) -> jobAPIIndexingJobIndexingJobRetrieveResponse

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

List Data Sources for Indexing Job for a Knowledge Base

knowledge_bases.indexing_jobs.retrieve_data_sources(strindexing_job_uuid) -> indexed_data_sourceslistIndexingJobRetrieveDataSourcesResponse

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

Cancel Indexing Job for a Knowledge Base

knowledge_bases.indexing_jobs.update_cancel(strpath_uuid, IndexingJobUpdateCancelParams**kwargs) -> jobAPIIndexingJobIndexingJobUpdateCancelResponse

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

API Indexed Data Source

APIIndexedDataSourceclass

ShowShow

completed_atdatetime

optional

Timestamp when data source completed indexing

formatdate-time

data_source_uuidstr

optional

Uuid of the indexed data source

error_detailsstr

optional

A detailed error description

error_msgstr

optional

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

failed_item_countstr

optional

Total count of files that have failed

formatuint64

indexed_file_countstr

optional

Total count of files that have been indexed

formatuint64

indexed_item_countstr

optional

Total count of files that have been indexed

formatuint64

removed_item_countstr

optional

Total count of files that have been removed

formatuint64

skipped_item_countstr

optional

Total count of files that have been skipped

formatuint64

started_atdatetime

optional

Timestamp when data source started indexing

formatdate-time

statusliteral

optional

Optional[Literal["DATA_SOURCE_STATUS_UNKNOWN", "DATA_SOURCE_STATUS_IN_PROGRESS", "DATA_SOURCE_STATUS_UPDATED", 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_bytesstr

optional

Total size of files in data source in bytes

formatuint64

total_bytes_indexedstr

optional

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

formatuint64

total_file_countstr

optional

Total file count in the data source

formatuint64

API Indexing Job

APIIndexingJobclass

IndexingJob description

ShowShow

completed_datasourcesint

optional

Number of datasources indexed completed

formatint64

created_atdatetime

optional

Creation date / time

formatdate-time

data_source_uuidslist

optional

Optional[List[str]]

finished_atdatetime

optional

formatdate-time

knowledge_base_uuidstr

optional

Knowledge base id

phaseliteral

optional

Optional[Literal["BATCH_JOB_PHASE_UNKNOWN", "BATCH_JOB_PHASE_PENDING", "BATCH_JOB_PHASE_RUNNING", 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_atdatetime

optional

formatdate-time

statusliteral

optional

Optional[Literal["INDEX_JOB_STATUS_UNKNOWN", "INDEX_JOB_STATUS_PARTIAL", "INDEX_JOB_STATUS_IN_PROGRESS", 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"

tokensint

optional

Number of tokens

formatint64

total_datasourcesint

optional

Number of datasources being indexed

formatint64

total_items_failedstr

optional

Total Items Failed

formatuint64

total_items_indexedstr

optional

Total Items Indexed

formatuint64

total_items_skippedstr

optional

Total Items Skipped

formatuint64

updated_atdatetime

optional

Last modified

formatdate-time

uuidstr

optional

Unique id