DocumentIngestionJobParams

DocumentIngestionJobParams = object

Defined in: packages/cloud/src/client/types.gen.ts:2704

Schema for the parameters of a document ingestion job.

Properties

custom_metadata?

optional custom_metadata: {[key: string]: unknown; } | null

Defined in: packages/cloud/src/client/types.gen.ts:2708

The custom metadata to attach to the documents.

---

resource_info?

optional resource_info: {[key: string]: unknown; } | null

Defined in: packages/cloud/src/client/types.gen.ts:2714

The resource info about the file

---

type?

optional type: "document_ingestion"

Defined in: packages/cloud/src/client/types.gen.ts:2717

---

should_delete?

optional should_delete: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:2721

Whether to delete the documents

---

document_ids?

optional document_ids: string[] | null

Defined in: packages/cloud/src/client/types.gen.ts:2725

The IDs for the Documents this execution ran against.

---

pipeline_file_id?

optional pipeline_file_id: string | null

Defined in: packages/cloud/src/client/types.gen.ts:2729

The ID for the File this execution ran against.

---

delete_info?

optional delete_info: DeleteParams | null

Defined in: packages/cloud/src/client/types.gen.ts:2733

The parameters for the delete job.

---

is_new_file?

optional is_new_file: boolean

Defined in: packages/cloud/src/client/types.gen.ts:2737

Whether the file is new

---

page_count?

optional page_count: number | null

Defined in: packages/cloud/src/client/types.gen.ts:2741

The number of pages in the file. Only used if used llama-parse