Get Pipeline File Status

Deprecated

ManagedIngestionStatusResponse pipelines().files().getStatus(, )

GET/api/v1/pipelines/{pipeline_id}/files/{file_id}/status

Get status of a file for a pipeline.

ParametersExpand Collapse

FileGetStatusParams params

String pipelineId

Optional<String> fileId

ReturnsExpand Collapse

class ManagedIngestionStatusResponse:

Status status

Status of the ingestion.

One of the following:

CANCELLED("CANCELLED")

ERROR("ERROR")

IN_PROGRESS("IN_PROGRESS")

NOT_STARTED("NOT_STARTED")

PARTIAL_SUCCESS("PARTIAL_SUCCESS")

SUCCESS("SUCCESS")

Optional<LocalDateTime> deploymentDate

Date of the deployment.

formatdate-time

Optional<LocalDateTime> effectiveAt

When the status is effective

formatdate-time

Optional<List<Error>> error

List of errors that occurred during ingestion.

String jobId

ID of the job that failed.

formatuuid

String message

List of errors that occurred during ingestion.

Step step

Name of the job that failed.

One of the following:

DATA_SOURCE("DATA_SOURCE")

FILE_UPDATER("FILE_UPDATER")

INGESTION("INGESTION")

MANAGED_INGESTION("MANAGED_INGESTION")

METADATA_UPDATE("METADATA_UPDATE")

PARSE("PARSE")

TRANSFORM("TRANSFORM")

Optional<String> jobId

ID of the latest job.

formatuuid

Get Pipeline File Status

package ai.llamaindex.llamacloud.example;

import ai.llamaindex.llamacloud.client.LlamaCloudClient;
import ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;
import ai.llamaindex.llamacloud.models.pipelines.ManagedIngestionStatusResponse;
import ai.llamaindex.llamacloud.models.pipelines.files.FileGetStatusParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        FileGetStatusParams params = FileGetStatusParams.builder()
            .pipelineId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .fileId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .build();
        ManagedIngestionStatusResponse managedIngestionStatusResponse = client.pipelines().files().getStatus(params);
    }
}

{
  "status": "CANCELLED",
  "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": "DATA_SOURCE"
    }
  ],
  "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}

Returns Examples

{
  "status": "CANCELLED",
  "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": "DATA_SOURCE"
    }
  ],
  "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}