Retrieve

Retrieve Status of Indexing Job for a Knowledge Base

knowledge_bases.indexing_jobs.retrieve() ->

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}.

Parameters

uuidstr

Returns

IndexingJobRetrieveResponseclass

GetKnowledgeBaseIndexingJobOutput description

Hide ParametersShow Parameters

jobAPIIndexingJob

optional

IndexingJob description

from do_gradientai import GradientAI

client = GradientAI()
indexing_job = client.knowledge_bases.indexing_jobs.retrieve(
    "uuid",
)
print(indexing_job.job)

200 Example

{
  "job": {
    "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\""
  }
}