Get Pipeline Document Status

client.pipelines.documents.getStatus(, , ?): ManagedIngestionStatusResponse { status, deployment_date, effective_at, 2 more }

GET/api/v1/pipelines/{pipeline_id}/documents/{document_id}/status

Return a single document for a pipeline.

ParametersExpand Collapse

documentID: string

params: DocumentGetStatusParams { pipeline_id }

pipeline_id: string

ReturnsExpand Collapse

ManagedIngestionStatusResponse { status, deployment_date, effective_at, 2 more }

status: "NOT_STARTED" | "IN_PROGRESS" | "SUCCESS" | 3 more

Status of the ingestion.

One of the following:

"NOT_STARTED"

"IN_PROGRESS"

"SUCCESS"

"ERROR"

"PARTIAL_SUCCESS"

"CANCELLED"

deployment_date?: string | null

Date of the deployment.

formatdate-time

effective_at?: string | null

When the status is effective

formatdate-time

error?: Array<Error> | null

List of errors that occurred during ingestion.

job_id: string

ID of the job that failed.

formatuuid

message: string

List of errors that occurred during ingestion.

step: "MANAGED_INGESTION" | "DATA_SOURCE" | "FILE_UPDATER" | 4 more

Name of the job that failed.

One of the following:

"MANAGED_INGESTION"

"DATA_SOURCE"

"FILE_UPDATER"

"PARSE"

"TRANSFORM"

"INGESTION"

"METADATA_UPDATE"

job_id?: string | null

ID of the latest job.

formatuuid

Get Pipeline Document Status

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const managedIngestionStatusResponse = await client.pipelines.documents.getStatus('document_id', {
  pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});

console.log(managedIngestionStatusResponse.job_id);

{
  "status": "NOT_STARTED",
  "deployment_date": "2019-12-27T18:11:19.117Z",
  "effective_at": "2019-12-27T18:11:19.117Z",
  "error": [
    {
      "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "message": "message",
      "step": "MANAGED_INGESTION"
    }
  ],
  "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}

Returns Examples

{
  "status": "NOT_STARTED",
  "deployment_date": "2019-12-27T18:11:19.117Z",
  "effective_at": "2019-12-27T18:11:19.117Z",
  "error": [
    {
      "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "message": "message",
      "step": "MANAGED_INGESTION"
    }
  ],
  "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}