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

List

List Indexing Jobs for a Knowledge Base
knowledge_bases.indexing_jobs.list(IndexingJobListParams**kwargs) -> jobslistlinksAPILinksmetaAPIMetaIndexingJobListResponse
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.

Parameters
pageint
optional

Page number.

per_pageint
optional

Items per page.

Returns
IndexingJobListResponseclass

Indexing jobs

Hide ParametersShow Parameters
jobslist
optional
Optional[List[completed_datasourcesintcreated_atdatetimedata_source_uuidslistfinished_atdatetimeknowledge_base_uuidstrphaseliteralstarted_atdatetimestatusliteraltokensinttotal_datasourcesintupdated_atdatetimeuuidstrAPIIndexingJob]]

The indexing jobs

Hide ParametersShow Parameters
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
updated_atdatetime
optional

Last modified

formatdate-time
uuidstr
optional

Unique id

metaAPIMeta
optional

Meta information about the data set

from do_gradientai import GradientAI

client = GradientAI()
indexing_jobs = client.knowledge_bases.indexing_jobs.list()
print(indexing_jobs.jobs)
200 Example
{
  "jobs": [
    {
      "completed_datasources": 123,
      "created_at": "2023-01-01T00:00:00Z",
      "data_source_uuids": [
        "example string"
      ],
      "finished_at": "2023-01-01T00:00:00Z",
      "knowledge_base_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
      "phase": "BATCH_JOB_PHASE_UNKNOWN",
      "started_at": "2023-01-01T00:00:00Z",
      "status": "INDEX_JOB_STATUS_UNKNOWN",
      "tokens": 123,
      "total_datasources": 123,
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
    }
  ],
  "links": {
    "pages": {
      "first": "\"example string\"",
      "last": "\"example string\"",
      "next": "\"example string\"",
      "previous": "\"example string\""
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  }
}