Read an ingest job

GET

/api/v1/documents/ingests/{id}

const url = 'http://localhost:11044/api/v1/documents/ingests/example';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/documents/ingests/example \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Where the caller’s ingest has got: its stage, embedding progress, and how it ended.

Authorizations

apiKeyAuth
basicAuth

Parameters

Path Parameters

required

string

The job’s UUID, as returned in the 202 of an ingest or embed-missing request (and its Location), or listed by GET /api/v1/documents/ingests. Another user’s job, or one forgotten after its retention, is 404

Responses

200

The job

*/*

One document ingest job as its owner sees it: its stage, embedding progress, and how it ended. Answered by POST /documents/ingests, POST /documents/ingests/url, POST /documents/embed-missing and GET /documents/ingests/{id}

object

chunks

Chunks the stored document was cut into; null until the job succeeds, and when the store does not say

integer format: int32

chunksWithoutEmbeddings

Chunks of the stored document with no embedding, which never match a semantic search; null until the job succeeds, and when the store does not say. POST /documents/embed-missing can embed them

integer format: int32

error

Why the job failed, in words; null unless state is failed

string

required

Job id, a UUID; the {id} of GET /documents/ingests/{id}

string

name

required

What the job is called: the uploaded file’s name, the URL being ingested, or for an embed-missing job the document’s title (its URI when it has none)

string

progress

Chunks embedded so far, of how many; null until the job starts embedding

object

done

required

Chunks embedded so far; never more than total

integer format: int32

total

required

Chunks to embed: an estimate from the document’s text while the job runs, corrected to the true count when it succeeds; raised rather than exceeded when the document cuts into more

integer format: int32

resumes

required

Times the appliance restarted while the job was unfinished and picked it up again under the same id; 0 for a job that ran straight through

integer format: int32

startedAt

required

When the job was submitted, ISO-8601 instant

string

state

required

Stage the job is at: queued, waiting_for_memory, converting, writing, embedding, succeeded or failed; the last two are final

string

Allowed values: queued waiting_for_memory converting writing embedding succeeded failed

title

Title of the stored document; null until the job succeeds, and when the document has none

string

updatedAt

required

When the job last changed stage or embedded a batch of chunks, ISO-8601 instant; a value that stops moving while the job is unfinished suggests it is stuck

string

uri

URI of the stored document; null until the job succeeds

string

404

No such job for the caller

*/*

A 404 from an ingest-job endpoint: no such job or document for the caller. A job may be unknown, forgotten after its retention, or somebody else’s

object

error

required

What was not found, as a sentence to show the user

string