List Pipeline Files2

Deprecated

pipelines.files.list(, ) -> SyncPaginatedPipelineFiles[PipelineFile]

GET/api/v1/pipelines/{pipeline_id}/files2

Get files for a pipeline.

Args: pipeline_id: ID of the pipeline data_source_id: Optional filter by data source ID only_manually_uploaded: Filter for only manually uploaded files file_name_contains: Optional filter by file name (substring match) limit: Limit number of results offset: Offset for pagination order_by: Field to order by

ParametersExpand Collapse

pipeline_id: str

data_source_id: Optional[str]

file_name_contains: Optional[str]

limit: Optional[int]

offset: Optional[int]

only_manually_uploaded: Optional[bool]

order_by: Optional[str]

ReturnsExpand Collapse

class PipelineFile: …

Schema for a file that is associated with a pipeline.

id: str

Unique identifier

formatuuid

pipeline_id: str

The ID of the pipeline that the file is associated with

formatuuid

config_hash: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]

Hashes for the configuration of the pipeline.

Accepts one of the following:

Dict[str, object]

List[object]

str

float

bool

created_at: Optional[datetime]

Creation datetime

formatdate-time

custom_metadata: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]

Custom metadata for the file

Accepts one of the following:

Dict[str, object]

List[object]

str

float

bool

data_source_id: Optional[str]

The ID of the data source that the file belongs to

formatuuid

external_file_id: Optional[str]

The ID of the file in the external system

file_id: Optional[str]

The ID of the file

formatuuid

file_size: Optional[int]

Size of the file in bytes

minimum0

file_type: Optional[str]

File type (e.g. pdf, docx, etc.)

maxLength3000

minLength1

indexed_page_count: Optional[int]

The number of pages that have been indexed for this file

last_modified_at: Optional[datetime]

The last modified time of the file

formatdate-time

name: Optional[str]

Name of the file

maxLength3000

minLength1

permission_info: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]

Permission information for the file

Accepts one of the following:

Dict[str, object]

List[object]

str

float

bool

project_id: Optional[str]

The ID of the project that the file belongs to

formatuuid

resource_info: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]

Resource information for the file

Accepts one of the following:

Dict[str, object]

List[object]

str

float

bool

status: Optional[Literal["NOT_STARTED", "IN_PROGRESS", "SUCCESS", 2 more]]

Status of the pipeline file

Accepts one of the following:

"NOT_STARTED"

"IN_PROGRESS"

"SUCCESS"

"ERROR"

"CANCELLED"

status_updated_at: Optional[datetime]

The last time the status was updated

formatdate-time

updated_at: Optional[datetime]

Update datetime

formatdate-time

List Pipeline Files2

import os
from llama_cloud import LlamaCloud

client = LlamaCloud(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
page = client.pipelines.files.list(
    pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
page = page.files[0]
print(page.id)

{
  "files": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "config_hash": {
        "foo": {
          "foo": "bar"
        }
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "custom_metadata": {
        "foo": {
          "foo": "bar"
        }
      },
      "data_source_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "external_file_id": "external_file_id",
      "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "file_size": 0,
      "file_type": "x",
      "indexed_page_count": 0,
      "last_modified_at": "2019-12-27T18:11:19.117Z",
      "name": "x",
      "permission_info": {
        "foo": {
          "foo": "bar"
        }
      },
      "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "resource_info": {
        "foo": {
          "foo": "bar"
        }
      },
      "status": "NOT_STARTED",
      "status_updated_at": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total_count": 0
}

Returns Examples

{
  "files": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "config_hash": {
        "foo": {
          "foo": "bar"
        }
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "custom_metadata": {
        "foo": {
          "foo": "bar"
        }
      },
      "data_source_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "external_file_id": "external_file_id",
      "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "file_size": 0,
      "file_type": "x",
      "indexed_page_count": 0,
      "last_modified_at": "2019-12-27T18:11:19.117Z",
      "name": "x",
      "permission_info": {
        "foo": {
          "foo": "bar"
        }
      },
      "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "resource_info": {
        "foo": {
          "foo": "bar"
        }
      },
      "status": "NOT_STARTED",
      "status_updated_at": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total_count": 0
}