Skip to content
Gradient SDK Docs
  • Auto
  • Light
  • Dark

Indexing Jobs

Indexing Jobs

Indexing Jobs

Start Indexing Job for a Knowledge Base
post/v2/gen-ai/indexing_jobs
List Indexing Jobs for a Knowledge Base
get/v2/gen-ai/indexing_jobs
Retrieve Status of Indexing Job for a Knowledge Base
get/v2/gen-ai/indexing_jobs/{uuid}
List Data Sources for Indexing Job for a Knowledge Base
get/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
API Indexed Data Source
APIIndexedDataSourceobject
ShowShow
completed_atstring
optional

Timestamp when data source completed indexing

formatdate-time
data_source_uuidstring
optional

Uuid of the indexed data source

error_detailsstring
optional

A detailed error description

error_msgstring
optional

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

failed_item_countstring
optional

Total count of files that have failed

formatuint64
indexed_file_countstring
optional

Total count of files that have been indexed

formatuint64
indexed_item_countstring
optional

Total count of files that have been indexed

formatuint64
removed_item_countstring
optional

Total count of files that have been removed

formatuint64
skipped_item_countstring
optional

Total count of files that have been skipped

formatuint64
started_atstring
optional

Timestamp when data source started indexing

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

Total size of files in data source in bytes

formatuint64
total_bytes_indexedstring
optional

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

formatuint64
total_file_countstring
optional

Total file count in the data source

formatuint64
API Indexing Job
APIIndexingJobobject

IndexingJob description

ShowShow
completed_datasourcesnumber
optional

Number of datasources indexed completed

formatint64
created_atstring
optional

Creation date / time

formatdate-time
data_source_uuidsarray of string
optional
finished_atstring
optional
formatdate-time
knowledge_base_uuidstring
optional

Knowledge base id

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

Number of tokens

formatint64
total_datasourcesnumber
optional

Number of datasources being indexed

formatint64
updated_atstring
optional

Last modified

formatdate-time
uuidstring
optional

Unique id