Fetch Index Job

GET 
/v1/dataset/index/job/:job_id

Fetches an index job to the front-end.

Request

Path Parameters

job_id Job Idrequired

Responses

200

Successful Response

application/json

Schema

Schema

id Id (string)required

Job ID

index_id Index Id (string)required

Index ID

job_start_timestamp date-timerequired

The timestamp of when the job started.

job_end_timestamp

object

required

The timestamp of when the job ended.

anyOf

MOD1

string

total_datums_remaining_to_atomize Total Datums Remaining To Atomize (integer)required

The total datums remaining to atomize

total_atoms_remaining_to_embed

object

required

The total datums remaining to embed

anyOf

MOD1

integer

nearest_neighbor_indices_remaining_to_build Nearest Neighbor Indices Remaining To Build (integer)required

The total nearest neighbor indices remaining to build

projections_remaining_to_build Projections Remaining To Build (integer)required

The total projections remaining to build.

topic_models_remaining_to_build Topic Models Remaining To Build (integer)required

The total topic models remaining to build.

rebuild_topic_models Rebuild Topic Models (boolean)required

Whether topic models are rebuilding

Example (from schema)

{
  "id": "string",
  "index_id": "string",
  "job_start_timestamp": "2024-07-29T15:51:28.071Z",
  "job_end_timestamp": "2024-07-29T15:51:28.071Z",
  "total_datums_remaining_to_atomize": 0,
  "total_atoms_remaining_to_embed": 0,
  "nearest_neighbor_indices_remaining_to_build": 0,
  "projections_remaining_to_build": 0,
  "topic_models_remaining_to_build": 0,
  "rebuild_topic_models": true
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...