@llamaindex/llama-cloud-mcp 2.15.0 → 2.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/code-tool-worker.d.mts.map +1 -1
- package/code-tool-worker.d.ts.map +1 -1
- package/code-tool-worker.js +2 -4
- package/code-tool-worker.js.map +1 -1
- package/code-tool-worker.mjs +2 -4
- package/code-tool-worker.mjs.map +1 -1
- package/local-docs-search.d.mts.map +1 -1
- package/local-docs-search.d.ts.map +1 -1
- package/local-docs-search.js +241 -298
- package/local-docs-search.js.map +1 -1
- package/local-docs-search.mjs +241 -298
- package/local-docs-search.mjs.map +1 -1
- package/methods.d.mts.map +1 -1
- package/methods.d.ts.map +1 -1
- package/methods.js +12 -24
- package/methods.js.map +1 -1
- package/methods.mjs +12 -24
- package/methods.mjs.map +1 -1
- package/package.json +2 -2
- package/src/code-tool-worker.ts +2 -4
- package/src/local-docs-search.ts +258 -334
- package/src/methods.ts +12 -24
package/local-docs-search.mjs
CHANGED
|
@@ -119,7 +119,7 @@ const EMBEDDED_METHODS = [
|
|
|
119
119
|
'project_id?: string;',
|
|
120
120
|
],
|
|
121
121
|
response: '{ id: string; name: string; project_id: string; download_url?: { expires_at: string; url: string; form_fields?: object; }; expires_at?: string; external_file_id?: string; file_type?: string; last_modified_at?: string; purpose?: string; }',
|
|
122
|
-
markdown: "## list\n\n`client.files.list(expand?: string[], external_file_id?: string, file_ids?: string[], file_name?: string, order_by?: string, organization_id?: string, page_size?: number, page_token?: string, project_id?: string): { id: string; name: string; project_id: string; download_url?: presigned_url; expires_at?: string; external_file_id?: string; file_type?: string; last_modified_at?: string; purpose?: string; }`\n\n**get** `/api/v1/beta/files`\n\nList files with optional filtering and pagination.\n\nFilter by `file_name`, `file_ids`, or `external_file_id`.\nSupports cursor-based pagination and custom ordering.\n\n### Parameters\n\n- `expand?: string[]`\n Fields to expand on each file.\n\n- `external_file_id?: string`\n Filter by external file ID.\n\n- `file_ids?: string[]`\n Filter by specific file IDs.\n\n- `file_name?: string`\n Filter by file name (exact match).\n\n- `order_by?: string`\n
|
|
122
|
+
markdown: "## list\n\n`client.files.list(expand?: string[], external_file_id?: string, file_ids?: string[], file_name?: string, order_by?: string, organization_id?: string, page_size?: number, page_token?: string, project_id?: string): { id: string; name: string; project_id: string; download_url?: presigned_url; expires_at?: string; external_file_id?: string; file_type?: string; last_modified_at?: string; purpose?: string; }`\n\n**get** `/api/v1/beta/files`\n\nList files with optional filtering and pagination.\n\nFilter by `file_name`, `file_ids`, or `external_file_id`.\nSupports cursor-based pagination and custom ordering.\n\n### Parameters\n\n- `expand?: string[]`\n Fields to expand on each file.\n\n- `external_file_id?: string`\n Filter by external file ID.\n\n- `file_ids?: string[]`\n Filter by specific file IDs.\n\n- `file_name?: string`\n Filter by file name (exact match).\n\n- `order_by?: string`\n Order the results. One of 'name' (ascending), 'id' (ascending) or 'created_at' (descending). An explicit asc/desc modifier and multi-field ordering are not supported; anything else is rejected.\n\n- `organization_id?: string`\n\n- `page_size?: number`\n The maximum number of items to return. Defaults to 50, maximum is 1000.\n\n- `page_token?: string`\n A page token received from a previous list call. Provide this to retrieve the subsequent page.\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; project_id: string; download_url?: { expires_at: string; url: string; form_fields?: object; }; expires_at?: string; external_file_id?: string; file_type?: string; last_modified_at?: string; purpose?: string; }`\n An uploaded file.\n\n - `id: string`\n - `name: string`\n - `project_id: string`\n - `download_url?: { expires_at: string; url: string; form_fields?: object; }`\n - `expires_at?: string`\n - `external_file_id?: string`\n - `file_type?: string`\n - `last_modified_at?: string`\n - `purpose?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\n// Automatically fetches more pages as needed.\nfor await (const fileListResponse of client.files.list()) {\n console.log(fileListResponse);\n}\n```",
|
|
123
123
|
perLanguage: {
|
|
124
124
|
go: {
|
|
125
125
|
method: 'client.Files.List',
|
|
@@ -289,14 +289,14 @@ const EMBEDDED_METHODS = [
|
|
|
289
289
|
'file_input: string;',
|
|
290
290
|
'organization_id?: string;',
|
|
291
291
|
'project_id?: string;',
|
|
292
|
-
"configuration?: { categories: { name: string; description?: string; }[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; };",
|
|
292
|
+
"configuration?: { categories: { name: string; description?: string; }[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; };",
|
|
293
293
|
'configuration_id?: string;',
|
|
294
294
|
'transaction_id?: string;',
|
|
295
295
|
'webhook_configuration_ids?: string[];',
|
|
296
296
|
'webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[];',
|
|
297
297
|
],
|
|
298
|
-
response: "{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; transaction_id?: string; updated_at?: string; }",
|
|
299
|
-
markdown: "## create\n\n`client.split.create(file_input: string, organization_id?: string, project_id?: string, configuration?: { categories: object[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; }, configuration_id?: string, transaction_id?: string, webhook_configuration_ids?: string[], webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]): { id: string; categories: split_category[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; splitting_strategy?: object; transaction_id?: string; updated_at?: string; }`\n\n**post** `/api/v1/split/jobs`\n\nCreate a document split job.\n\n### Parameters\n\n- `file_input: string`\n File ID or parse job ID\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `configuration?: { categories: { name: string; description?: string; }[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; }`\n Split configuration with categories and splitting strategy.\n - `categories: { name: string; description?: string; }[]`\n Categories to split documents into.\n - `splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }`\n Strategy for splitting documents.\n\n- `configuration_id?: string`\n Saved configuration ID\n\n- `transaction_id?: string`\n Idempotency key scoped to the project. Reusing a key returns the original job; the new request body is ignored.\n\n- `webhook_configuration_ids?: string[]`\n IDs of saved webhook configurations to notify for this job.\n\n- `webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]`\n Outbound webhook endpoints to notify on job status changes\n\n### Returns\n\n- `{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; transaction_id?: string; updated_at?: string; }`\n A split job.\n\n - `id: string`\n - `categories: { name: string; description?: string; }[]`\n - `document_input_type: 'file_id' | 'parse_job_id' | 'url'`\n - `file_input: string`\n - `project_id: string`\n - `status: string`\n - `user_id: string`\n - `configuration_id?: string`\n - `created_at?: string`\n - `error_message?: string`\n - `result?: { segments: { category: string; confidence_category: string; pages: number[]; }[]; }`\n - `splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }`\n - `transaction_id?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst split = await client.split.create({ file_input: 'dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee' });\n\nconsole.log(split);\n```",
|
|
298
|
+
response: "{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; transaction_id?: string; updated_at?: string; }",
|
|
299
|
+
markdown: "## create\n\n`client.split.create(file_input: string, organization_id?: string, project_id?: string, configuration?: { categories: object[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; }, configuration_id?: string, transaction_id?: string, webhook_configuration_ids?: string[], webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]): { id: string; categories: split_category[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; splitting_strategy?: object; transaction_id?: string; updated_at?: string; }`\n\n**post** `/api/v1/split/jobs`\n\nCreate a document split job.\n\n### Parameters\n\n- `file_input: string`\n File ID or parse job ID\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `configuration?: { categories: { name: string; description?: string; }[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; }`\n Split configuration with categories and splitting strategy.\n - `categories: { name: string; description?: string; }[]`\n Categories to split documents into.\n - `splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }`\n Strategy for splitting documents.\n\n- `configuration_id?: string`\n Saved configuration ID\n\n- `transaction_id?: string`\n Idempotency key scoped to the project. Reusing a key returns the original job; the new request body is ignored.\n\n- `webhook_configuration_ids?: string[]`\n IDs of saved webhook configurations to notify for this job.\n\n- `webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]`\n Outbound webhook endpoints to notify on job status changes\n\n### Returns\n\n- `{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; transaction_id?: string; updated_at?: string; }`\n A split job.\n\n - `id: string`\n - `categories: { name: string; description?: string; }[]`\n - `document_input_type: 'file_id' | 'parse_job_id' | 'url'`\n - `file_input: string`\n - `project_id: string`\n - `status: string`\n - `user_id: string`\n - `configuration_id?: string`\n - `created_at?: string`\n - `error_message?: string`\n - `result?: { segments: { category: string; confidence_category: string; pages: number[]; }[]; }`\n - `splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }`\n - `transaction_id?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst split = await client.split.create({ file_input: 'dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee' });\n\nconsole.log(split);\n```",
|
|
300
300
|
perLanguage: {
|
|
301
301
|
go: {
|
|
302
302
|
method: 'client.Split.New',
|
|
@@ -345,8 +345,8 @@ const EMBEDDED_METHODS = [
|
|
|
345
345
|
'project_id?: string;',
|
|
346
346
|
"status?: 'cancelled' | 'completed' | 'failed' | 'pending' | 'processing';",
|
|
347
347
|
],
|
|
348
|
-
response: "{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; transaction_id?: string; updated_at?: string; }",
|
|
349
|
-
markdown: "## list\n\n`client.split.list(created_at_on_or_after?: string, created_at_on_or_before?: string, job_ids?: string[], organization_id?: string, page_size?: number, page_token?: string, project_id?: string, status?: 'cancelled' | 'completed' | 'failed' | 'pending' | 'processing'): { id: string; categories: split_category[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; splitting_strategy?: object; transaction_id?: string; updated_at?: string; }`\n\n**get** `/api/v1/split/jobs`\n\nList document split jobs.\n\n### Parameters\n\n- `created_at_on_or_after?: string`\n Include items created at or after this timestamp (inclusive)\n\n- `created_at_on_or_before?: string`\n Include items created at or before this timestamp (inclusive)\n\n- `job_ids?: string[]`\n Filter by specific job IDs\n\n- `organization_id?: string`\n\n- `page_size?: number`\n\n- `page_token?: string`\n\n- `project_id?: string`\n\n- `status?: 'cancelled' | 'completed' | 'failed' | 'pending' | 'processing'`\n Filter by job status (pending, processing, completed, failed, cancelled)\n\n### Returns\n\n- `{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; transaction_id?: string; updated_at?: string; }`\n A split job.\n\n - `id: string`\n - `categories: { name: string; description?: string; }[]`\n - `document_input_type: 'file_id' | 'parse_job_id' | 'url'`\n - `file_input: string`\n - `project_id: string`\n - `status: string`\n - `user_id: string`\n - `configuration_id?: string`\n - `created_at?: string`\n - `error_message?: string`\n - `result?: { segments: { category: string; confidence_category: string; pages: number[]; }[]; }`\n - `splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }`\n - `transaction_id?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\n// Automatically fetches more pages as needed.\nfor await (const splitListResponse of client.split.list()) {\n console.log(splitListResponse);\n}\n```",
|
|
348
|
+
response: "{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; transaction_id?: string; updated_at?: string; }",
|
|
349
|
+
markdown: "## list\n\n`client.split.list(created_at_on_or_after?: string, created_at_on_or_before?: string, job_ids?: string[], organization_id?: string, page_size?: number, page_token?: string, project_id?: string, status?: 'cancelled' | 'completed' | 'failed' | 'pending' | 'processing'): { id: string; categories: split_category[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; splitting_strategy?: object; transaction_id?: string; updated_at?: string; }`\n\n**get** `/api/v1/split/jobs`\n\nList document split jobs.\n\n### Parameters\n\n- `created_at_on_or_after?: string`\n Include items created at or after this timestamp (inclusive)\n\n- `created_at_on_or_before?: string`\n Include items created at or before this timestamp (inclusive)\n\n- `job_ids?: string[]`\n Filter by specific job IDs\n\n- `organization_id?: string`\n\n- `page_size?: number`\n\n- `page_token?: string`\n\n- `project_id?: string`\n\n- `status?: 'cancelled' | 'completed' | 'failed' | 'pending' | 'processing'`\n Filter by job status (pending, processing, completed, failed, cancelled)\n\n### Returns\n\n- `{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; transaction_id?: string; updated_at?: string; }`\n A split job.\n\n - `id: string`\n - `categories: { name: string; description?: string; }[]`\n - `document_input_type: 'file_id' | 'parse_job_id' | 'url'`\n - `file_input: string`\n - `project_id: string`\n - `status: string`\n - `user_id: string`\n - `configuration_id?: string`\n - `created_at?: string`\n - `error_message?: string`\n - `result?: { segments: { category: string; confidence_category: string; pages: number[]; }[]; }`\n - `splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }`\n - `transaction_id?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\n// Automatically fetches more pages as needed.\nfor await (const splitListResponse of client.split.list()) {\n console.log(splitListResponse);\n}\n```",
|
|
350
350
|
perLanguage: {
|
|
351
351
|
go: {
|
|
352
352
|
method: 'client.Split.List',
|
|
@@ -386,8 +386,8 @@ const EMBEDDED_METHODS = [
|
|
|
386
386
|
stainlessPath: '(resource) split > (method) get',
|
|
387
387
|
qualified: 'client.split.get',
|
|
388
388
|
params: ['split_job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
389
|
-
response: "{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; transaction_id?: string; updated_at?: string; }",
|
|
390
|
-
markdown: "## get\n\n`client.split.get(split_job_id: string, organization_id?: string, project_id?: string): { id: string; categories: split_category[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; splitting_strategy?: object; transaction_id?: string; updated_at?: string; }`\n\n**get** `/api/v1/split/jobs/{split_job_id}`\n\nGet a document split job.\n\n### Parameters\n\n- `split_job_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; transaction_id?: string; updated_at?: string; }`\n A split job.\n\n - `id: string`\n - `categories: { name: string; description?: string; }[]`\n - `document_input_type: 'file_id' | 'parse_job_id' | 'url'`\n - `file_input: string`\n - `project_id: string`\n - `status: string`\n - `user_id: string`\n - `configuration_id?: string`\n - `created_at?: string`\n - `error_message?: string`\n - `result?: { segments: { category: string; confidence_category: string; pages: number[]; }[]; }`\n - `splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }`\n - `transaction_id?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst split = await client.split.get('split_job_id');\n\nconsole.log(split);\n```",
|
|
389
|
+
response: "{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; transaction_id?: string; updated_at?: string; }",
|
|
390
|
+
markdown: "## get\n\n`client.split.get(split_job_id: string, organization_id?: string, project_id?: string): { id: string; categories: split_category[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; splitting_strategy?: object; transaction_id?: string; updated_at?: string; }`\n\n**get** `/api/v1/split/jobs/{split_job_id}`\n\nGet a document split job.\n\n### Parameters\n\n- `split_job_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; transaction_id?: string; updated_at?: string; }`\n A split job.\n\n - `id: string`\n - `categories: { name: string; description?: string; }[]`\n - `document_input_type: 'file_id' | 'parse_job_id' | 'url'`\n - `file_input: string`\n - `project_id: string`\n - `status: string`\n - `user_id: string`\n - `configuration_id?: string`\n - `created_at?: string`\n - `error_message?: string`\n - `result?: { segments: { category: string; confidence_category: string; pages: number[]; }[]; }`\n - `splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }`\n - `transaction_id?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst split = await client.split.get('split_job_id');\n\nconsole.log(split);\n```",
|
|
391
391
|
perLanguage: {
|
|
392
392
|
go: {
|
|
393
393
|
method: 'client.Split.Get',
|
|
@@ -468,8 +468,8 @@ const EMBEDDED_METHODS = [
|
|
|
468
468
|
stainlessPath: '(resource) split > (method) cancel',
|
|
469
469
|
qualified: 'client.split.cancel',
|
|
470
470
|
params: ['split_job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
471
|
-
response: "{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; transaction_id?: string; updated_at?: string; }",
|
|
472
|
-
markdown: "## cancel\n\n`client.split.cancel(split_job_id: string, organization_id?: string, project_id?: string): { id: string; categories: split_category[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; splitting_strategy?: object; transaction_id?: string; updated_at?: string; }`\n\n**post** `/api/v1/split/jobs/{split_job_id}/cancel`\n\nCancel a running split job.\n\nRequests cancellation; the job transitions to CANCELLED asynchronously once processing stops. Returns the job, which may still be in its current non-terminal state. Jobs already in a terminal state (COMPLETED, FAILED, CANCELLED) cannot be cancelled.\n\n### Parameters\n\n- `split_job_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; transaction_id?: string; updated_at?: string; }`\n A split job.\n\n - `id: string`\n - `categories: { name: string; description?: string; }[]`\n - `document_input_type: 'file_id' | 'parse_job_id' | 'url'`\n - `file_input: string`\n - `project_id: string`\n - `status: string`\n - `user_id: string`\n - `configuration_id?: string`\n - `created_at?: string`\n - `error_message?: string`\n - `result?: { segments: { category: string; confidence_category: string; pages: number[]; }[]; }`\n - `splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }`\n - `transaction_id?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst response = await client.split.cancel('split_job_id');\n\nconsole.log(response);\n```",
|
|
471
|
+
response: "{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; transaction_id?: string; updated_at?: string; }",
|
|
472
|
+
markdown: "## cancel\n\n`client.split.cancel(split_job_id: string, organization_id?: string, project_id?: string): { id: string; categories: split_category[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; splitting_strategy?: object; transaction_id?: string; updated_at?: string; }`\n\n**post** `/api/v1/split/jobs/{split_job_id}/cancel`\n\nCancel a running split job.\n\nRequests cancellation; the job transitions to CANCELLED asynchronously once processing stops. Returns the job, which may still be in its current non-terminal state. Jobs already in a terminal state (COMPLETED, FAILED, CANCELLED) cannot be cancelled.\n\n### Parameters\n\n- `split_job_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; categories: { name: string; description?: string; }[]; document_input_type: 'file_id' | 'parse_job_id' | 'url'; file_input: string; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; transaction_id?: string; updated_at?: string; }`\n A split job.\n\n - `id: string`\n - `categories: { name: string; description?: string; }[]`\n - `document_input_type: 'file_id' | 'parse_job_id' | 'url'`\n - `file_input: string`\n - `project_id: string`\n - `status: string`\n - `user_id: string`\n - `configuration_id?: string`\n - `created_at?: string`\n - `error_message?: string`\n - `result?: { segments: { category: string; confidence_category: string; pages: number[]; }[]; }`\n - `splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }`\n - `transaction_id?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst response = await client.split.cancel('split_job_id');\n\nconsole.log(response);\n```",
|
|
473
473
|
perLanguage: {
|
|
474
474
|
go: {
|
|
475
475
|
method: 'client.Split.Cancel',
|
|
@@ -510,7 +510,7 @@ const EMBEDDED_METHODS = [
|
|
|
510
510
|
qualified: 'client.parsing.create',
|
|
511
511
|
params: [
|
|
512
512
|
"tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus' | string;",
|
|
513
|
-
"version: 'latest' | '2026-08-19' | '2026-06-15' | string;",
|
|
513
|
+
"version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string;",
|
|
514
514
|
'organization_id?: string;',
|
|
515
515
|
'project_id?: string;',
|
|
516
516
|
'agentic_options?: { custom_prompt?: string; };',
|
|
@@ -525,14 +525,14 @@ const EMBEDDED_METHODS = [
|
|
|
525
525
|
"output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: { compact_markdown_tables?: boolean; markdown_table_multiline_separator?: string; merge_continued_tables?: boolean; output_tables_as_markdown?: boolean; }; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; };",
|
|
526
526
|
'page_ranges?: { max_pages?: number; target_pages?: string; };',
|
|
527
527
|
'processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; };',
|
|
528
|
-
"processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; custom_prompt?: string; extract_layout?: boolean; high_res_ocr?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; }; language?: string; outlined_table_extraction?: boolean; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version?: 'latest' | '2026-08-19' | '2026-06-15' | string; }; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: string[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; };",
|
|
528
|
+
"processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; custom_prompt?: string; extract_layout?: boolean; high_res_ocr?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; }; language?: string; outlined_table_extraction?: boolean; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version?: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; }; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: string[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; };",
|
|
529
529
|
'source_url?: string;',
|
|
530
530
|
'user_metadata?: object;',
|
|
531
531
|
'webhook_configuration_ids?: string[];',
|
|
532
532
|
"webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[];",
|
|
533
533
|
],
|
|
534
534
|
response: "{ id: string; project_id: string; status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'; created_at?: string; error_message?: string; name?: string; tier?: string; updated_at?: string; usage?: { credits?: number; }; user_metadata?: object; }",
|
|
535
|
-
markdown: "## create\n\n`client.parsing.create(tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus' | string, version: 'latest' | '2026-08-19' | '2026-06-15' | string, organization_id?: string, project_id?: string, agentic_options?: { custom_prompt?: string; }, client_name?: string, configuration_id?: string, crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }, disable_cache?: boolean, fast_options?: object, file_id?: string, http_proxy?: string, input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }, output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }, page_ranges?: { max_pages?: number; target_pages?: string; }, processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }, processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }, source_url?: string, user_metadata?: object, webhook_configuration_ids?: string[], webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]): { id: string; project_id: string; status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'; created_at?: string; error_message?: string; name?: string; tier?: string; updated_at?: string; usage?: object; user_metadata?: object; }`\n\n**post** `/api/v2/parse`\n\nParse a file by file ID or URL.\n\nProvide either `file_id` (a previously uploaded file) or\n`source_url` (a publicly accessible URL). Configure parsing\nwith options like `tier`, `target_pages`, and `lang`.\n\n## Tiers\n\n- `fast` — rule-based, cheapest, no AI\n- `cost_effective` — balanced speed and quality\n- `agentic` — full AI-powered parsing\n- `agentic_plus` — premium AI with specialized features\n\nThe job runs asynchronously. Poll `GET /parse/{job_id}` with\n`expand=text` or `expand=markdown` to retrieve results.\n\n### Parameters\n\n- `tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus' | string`\n Parsing tier: 'fast' (rule-based, cheapest), 'cost_effective' (balanced), 'agentic' (AI-powered with custom prompts), or 'agentic_plus' (premium AI with highest accuracy)\n\n- `version: 'latest' | '2026-08-19' | '2026-06-15' | string`\n Version for the selected tier. Use `latest`, or pin one of that tier's dated versions.\n\nCurrent `latest` by tier:\n- `fast`: `2026-06-15`\n- `cost_effective`: `2026-08-19`\n- `agentic`: `2026-08-19`\n- `agentic_plus`: `2026-08-19`\n\nFull list: `GET /api/v2/parse/versions`.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `agentic_options?: { custom_prompt?: string; }`\n Options for AI-powered parsing tiers (cost_effective, agentic, agentic_plus).\n\nThese options customize how the AI processes and interprets document content.\nOnly applicable when using non-fast tiers.\n - `custom_prompt?: string`\n Custom instructions for the AI parser. Use to guide extraction behavior, specify output formatting, or provide domain-specific context. Example: 'Extract financial tables with currency symbols. Format dates as YYYY-MM-DD.'\n\n- `client_name?: string`\n Identifier for the client/application making the request. Used for analytics and debugging. Example: 'my-app-v2'\n\n- `configuration_id?: string`\n ID of a saved parse configuration. When set, `tier` and `version` default to the saved configuration's values — omit them or pass `'configured'`.\n\n- `crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }`\n Crop boundaries to process only a portion of each page. Values are ratios 0-1 from page edges\n - `bottom?: number`\n Bottom boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content below this line is excluded\n - `left?: number`\n Left boundary as ratio (0-1). 0=left edge, 1=right edge. Content left of this line is excluded\n - `right?: number`\n Right boundary as ratio (0-1). 0=left edge, 1=right edge. Content right of this line is excluded\n - `top?: number`\n Top boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content above this line is excluded\n\n- `disable_cache?: boolean`\n Bypass result caching and force re-parsing. Use when document content may have changed or you need fresh results\n\n- `fast_options?: object`\n Options for fast tier parsing (rule-based, no AI).\n\nFast tier uses deterministic algorithms for text extraction without AI enhancement.\nIt's the fastest and most cost-effective option, best suited for simple documents\nwith standard layouts. Currently has no configurable options but reserved for\nfuture expansion.\n\n- `file_id?: string`\n ID of an existing file in the project to parse. Mutually exclusive with source_url\n\n- `http_proxy?: string`\n HTTP/HTTPS proxy for fetching source_url. Ignored if using file_id\n\n- `input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }`\n Format-specific options (HTML, PDF, spreadsheet, presentation). Applied based on detected input file type\n - `html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }`\n HTML/web page parsing options (applies to .html, .htm files)\n - `image?: { camera_photo_correction?: boolean; }`\n Image parsing options (applies to .jpg, .jpeg, .png, .webp files)\n - `pdf?: object`\n PDF-specific parsing options (applies to .pdf files)\n - `presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }`\n Presentation parsing options (applies to .pptx, .ppt, .odp, .key files)\n - `spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }`\n Spreadsheet parsing options (applies to .xlsx, .xls, .csv, .ods files)\n\n- `output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: { compact_markdown_tables?: boolean; markdown_table_multiline_separator?: string; merge_continued_tables?: boolean; output_tables_as_markdown?: boolean; }; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }`\n Output formatting options for markdown, text, and extracted images\n - `additional_outputs?: string[]`\n Optional additional output artifacts to save alongside the primary parse output. Each value opts in to generating and persisting one extra file; the empty list (default) saves none. The three accepted values are: 'stripped_md' — per-page markdown stripped of formatting (links, bold/italic, images, HTML), saved as JSON for full-text-search indexing; fetch via `expand=stripped_markdown_content_metadata`. 'concatenated_stripped_txt' — all stripped pages concatenated into a single plain-text file with `\\n\\n---\\n\\n` between pages, useful for feeding the document into search or embedding pipelines as one blob; fetch via `expand=concatenated_stripped_markdown_content_metadata`. 'word_bbox' — raw word-level bounding boxes (one JSON object per word, with page number and x/y/w/h coordinates) saved as JSONL, useful for highlighting or grounding extracted answers back to the source document; fetch via `expand=raw_words_content_metadata`.\n - `extract_printed_page_number?: boolean`\n Extract the printed page number as it appears in the document (e.g., 'Page 5 of 10', 'v', 'A-3'). Useful for referencing original page numbers\n - `granular_bboxes?: 'cell' | 'line' | 'word'[]`\n Bounding-box granularity levels to compute for the parse. 'word' computes one bounding box per detected word; 'line' computes one per text line; 'cell' computes one per table cell. Multiple levels can be requested. Empty list (default) disables granular bboxes — only item-level layout boxes are returned on the result. When set, the computed boxes are not inlined on the result items; they are written to a separate `grounded_items` sidecar (JSONL, one row per page) and exposed as `result_content_metadata.grounded_items` (a presigned download URL) on the parse result. Each row matches the `GroundedJsonItem` shape.\n - `images_to_save?: 'embedded' | 'layout' | 'screenshot'[]`\n Image categories to save: 'screenshot' (full page renders), 'embedded' (images found within the document), 'layout' (cropped figures and diagrams). Defaults to saving 'layout' when the output links to cropped images; pass [] to save none\n - `markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: { compact_markdown_tables?: boolean; markdown_table_multiline_separator?: string; merge_continued_tables?: boolean; output_tables_as_markdown?: boolean; }; }`\n Markdown formatting options including table styles and link annotations\n - `save_output_pdf?: boolean`\n Save a PDF copy of the parsed document, retrievable via `expand=output_pdf_content_metadata`. Not produced for spreadsheet, plain-text, or audio inputs\n - `spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }`\n Spatial text output options for preserving document layout structure\n - `tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }`\n Options for exporting tables as XLSX spreadsheets\n\n- `page_ranges?: { max_pages?: number; target_pages?: string; }`\n Page selection: limit total pages or specify exact pages to process\n - `max_pages?: number`\n Maximum number of pages to process. Pages are processed in order starting from page 1. If both max_pages and target_pages are set, target_pages takes precedence\n - `target_pages?: string`\n Comma-separated list of specific pages to process using 1-based indexing. Supports individual pages and ranges. Examples: '1,3,5' (pages 1, 3, 5), '1-5' (pages 1 through 5 inclusive), '1,3,5-8,10' (pages 1, 3, 5-8, and 10). Pages are sorted and deduplicated automatically. Duplicate pages cause an error\n\n- `processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }`\n Job execution controls including timeouts and failure thresholds\n - `job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }`\n Quality thresholds that determine when a job should fail vs complete with partial results\n - `timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }`\n Timeout settings for job execution. Increase for large or complex documents\n\n- `processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; custom_prompt?: string; extract_layout?: boolean; high_res_ocr?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; }; language?: string; outlined_table_extraction?: boolean; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version?: 'latest' | '2026-08-19' | '2026-06-15' | string; }; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: string[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }`\n Document processing options including OCR, table extraction, and chart parsing\n - `aggressive_table_extraction?: boolean`\n Use aggressive heuristics to detect table boundaries, even without visible borders. Useful for documents with borderless or complex tables\n - `auto_mode_configuration?: { parsing_conf: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; custom_prompt?: string; extract_layout?: boolean; high_res_ocr?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; }; language?: string; outlined_table_extraction?: boolean; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version?: 'latest' | '2026-08-19' | '2026-06-15' | string; }; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]`\n Conditional processing rules that apply different parsing options based on page content, document structure, or filename patterns. Each entry defines trigger conditions and the parsing configuration to apply when triggered\n - `confidence_score_effort?: 'high'`\n Confidence scoring effort. Omit for standard scoring. 'high': more accurate assessment of the parsing quality of every page, plus a document-level score in the result metadata; costs an additional 5 credits per page\n - `cost_optimizer?: { enable?: boolean; }`\n Cost optimizer configuration for reducing parsing costs on simpler pages.\n\nWhen enabled, the parser analyzes each page and routes simpler pages to faster,\ncheaper processing while preserving quality for complex pages. Only works with\n'agentic' or 'agentic_plus' tiers.\n - `disable_heuristics?: boolean`\n Disable automatic heuristics including outlined table extraction and adaptive long table handling. Use when heuristics produce incorrect results\n - `forms?: 'default' | 'enrich'`\n Beta: set to 'enrich' to run an additional AI form-analysis pass on pages detected as forms, producing a structured tree of the form's sections, fields, and fillable grids. Retrieve the result with expand=forms. 'default' (the default) applies standard parsing with no extra pass. Not available on the fast tier\n - `ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }`\n Options for ignoring specific text types (diagonal, hidden, text in images)\n - `ocr_parameters?: { languages?: string[]; }`\n OCR configuration including language detection settings\n - `specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'`\n Enable AI-powered chart analysis. Modes: 'efficient' (fast, lower cost), 'agentic' (balanced), 'agentic_plus' (highest accuracy). Automatically enables extract_layout and precise_bounding_box when set\n\n- `source_url?: string`\n Public URL of the document to parse. Mutually exclusive with file_id\n\n- `user_metadata?: object`\n Arbitrary key/value tags to attach to this job. Returned when retrieving the job. Not searchable. Limits apply to the number of entries and the length of keys and values; oversized metadata is rejected.\n\n- `webhook_configuration_ids?: string[]`\n IDs of saved webhook configurations to notify for this job.\n\n- `webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]`\n Webhook endpoints for job status notifications. Multiple webhooks can be configured for different events or services\n\n### Returns\n\n- `{ id: string; project_id: string; status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'; created_at?: string; error_message?: string; name?: string; tier?: string; updated_at?: string; usage?: { credits?: number; }; user_metadata?: object; }`\n A parse job.\n\n - `id: string`\n - `project_id: string`\n - `status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'`\n - `created_at?: string`\n - `error_message?: string`\n - `name?: string`\n - `tier?: string`\n - `updated_at?: string`\n - `usage?: { credits?: number; }`\n - `user_metadata?: object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst parsing = await client.parsing.create({ tier: 'fast', version: 'latest' });\n\nconsole.log(parsing);\n```",
|
|
535
|
+
markdown: "## create\n\n`client.parsing.create(tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus' | string, version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string, organization_id?: string, project_id?: string, agentic_options?: { custom_prompt?: string; }, client_name?: string, configuration_id?: string, crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }, disable_cache?: boolean, fast_options?: object, file_id?: string, http_proxy?: string, input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }, output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }, page_ranges?: { max_pages?: number; target_pages?: string; }, processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }, processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }, source_url?: string, user_metadata?: object, webhook_configuration_ids?: string[], webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]): { id: string; project_id: string; status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'; created_at?: string; error_message?: string; name?: string; tier?: string; updated_at?: string; usage?: object; user_metadata?: object; }`\n\n**post** `/api/v2/parse`\n\nParse a file by file ID or URL.\n\nProvide either `file_id` (a previously uploaded file) or\n`source_url` (a publicly accessible URL). Configure parsing\nwith options like `tier`, `target_pages`, and `lang`.\n\n## Tiers\n\n- `fast` — rule-based, cheapest, no AI\n- `cost_effective` — balanced speed and quality\n- `agentic` — full AI-powered parsing\n- `agentic_plus` — premium AI with specialized features\n\nThe job runs asynchronously. Poll `GET /parse/{job_id}` with\n`expand=text` or `expand=markdown` to retrieve results.\n\n### Parameters\n\n- `tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus' | string`\n Parsing tier: 'fast' (rule-based, cheapest), 'cost_effective' (balanced), 'agentic' (AI-powered with custom prompts), or 'agentic_plus' (premium AI with highest accuracy)\n\n- `version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string`\n Version for the selected tier. Use `latest`, or pin one of that tier's dated versions.\n\nCurrent `latest` by tier:\n- `fast`: `2026-06-15`\n- `cost_effective`: `2026-08-19`\n- `agentic`: `2026-09-07`\n- `agentic_plus`: `2026-08-19`\n\nFull list: `GET /api/v2/parse/versions`.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `agentic_options?: { custom_prompt?: string; }`\n Options for AI-powered parsing tiers (cost_effective, agentic, agentic_plus).\n\nThese options customize how the AI processes and interprets document content.\nOnly applicable when using non-fast tiers.\n - `custom_prompt?: string`\n Custom instructions for the AI parser. Use to guide extraction behavior, specify output formatting, or provide domain-specific context. Example: 'Extract financial tables with currency symbols. Format dates as YYYY-MM-DD.'\n\n- `client_name?: string`\n Identifier for the client/application making the request. Used for analytics and debugging. Example: 'my-app-v2'\n\n- `configuration_id?: string`\n ID of a saved parse configuration. When set, `tier` and `version` default to the saved configuration's values — omit them or pass `'configured'`.\n\n- `crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }`\n Crop boundaries to process only a portion of each page. Values are ratios 0-1 from page edges\n - `bottom?: number`\n Bottom boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content below this line is excluded\n - `left?: number`\n Left boundary as ratio (0-1). 0=left edge, 1=right edge. Content left of this line is excluded\n - `right?: number`\n Right boundary as ratio (0-1). 0=left edge, 1=right edge. Content right of this line is excluded\n - `top?: number`\n Top boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content above this line is excluded\n\n- `disable_cache?: boolean`\n Bypass result caching and force re-parsing. Use when document content may have changed or you need fresh results\n\n- `fast_options?: object`\n Options for fast tier parsing (rule-based, no AI).\n\nFast tier uses deterministic algorithms for text extraction without AI enhancement.\nIt's the fastest and most cost-effective option, best suited for simple documents\nwith standard layouts. Currently has no configurable options but reserved for\nfuture expansion.\n\n- `file_id?: string`\n ID of an existing file in the project to parse. Mutually exclusive with source_url\n\n- `http_proxy?: string`\n HTTP/HTTPS proxy for fetching source_url. Ignored if using file_id\n\n- `input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }`\n Format-specific options (HTML, PDF, spreadsheet, presentation). Applied based on detected input file type\n - `html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }`\n HTML/web page parsing options (applies to .html, .htm files)\n - `image?: { camera_photo_correction?: boolean; }`\n Image parsing options (applies to .jpg, .jpeg, .png, .webp files)\n - `pdf?: object`\n PDF-specific parsing options (applies to .pdf files)\n - `presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }`\n Presentation parsing options (applies to .pptx, .ppt, .odp, .key files)\n - `spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }`\n Spreadsheet parsing options (applies to .xlsx, .xls, .csv, .ods files)\n\n- `output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: { compact_markdown_tables?: boolean; markdown_table_multiline_separator?: string; merge_continued_tables?: boolean; output_tables_as_markdown?: boolean; }; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }`\n Output formatting options for markdown, text, and extracted images\n - `additional_outputs?: string[]`\n Optional additional output artifacts to save alongside the primary parse output. Each value opts in to generating and persisting one extra file; the empty list (default) saves none. The three accepted values are: 'stripped_md' — per-page markdown stripped of formatting (links, bold/italic, images, HTML), saved as JSON for full-text-search indexing; fetch via `expand=stripped_markdown_content_metadata`. 'concatenated_stripped_txt' — all stripped pages concatenated into a single plain-text file with `\\n\\n---\\n\\n` between pages, useful for feeding the document into search or embedding pipelines as one blob; fetch via `expand=concatenated_stripped_markdown_content_metadata`. 'word_bbox' — raw word-level bounding boxes (one JSON object per word, with page number and x/y/w/h coordinates) saved as JSONL, useful for highlighting or grounding extracted answers back to the source document; fetch via `expand=raw_words_content_metadata`.\n - `extract_printed_page_number?: boolean`\n Extract the printed page number as it appears in the document (e.g., 'Page 5 of 10', 'v', 'A-3'). Useful for referencing original page numbers\n - `granular_bboxes?: 'cell' | 'line' | 'word'[]`\n Bounding-box granularity levels to compute for the parse. 'word' computes one bounding box per detected word; 'line' computes one per text line; 'cell' computes one per table cell. Multiple levels can be requested. Empty list (default) disables granular bboxes — only item-level layout boxes are returned on the result. When set, the computed boxes are not inlined on the result items; they are written to a separate `grounded_items` sidecar (JSONL, one row per page) and exposed as `result_content_metadata.grounded_items` (a presigned download URL) on the parse result. Each row matches the `GroundedJsonItem` shape.\n - `images_to_save?: 'embedded' | 'layout' | 'screenshot'[]`\n Image categories to save: 'screenshot' (full page renders), 'embedded' (images found within the document), 'layout' (cropped figures and diagrams). Defaults to saving 'layout' when the output links to cropped images; pass [] to save none\n - `markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: { compact_markdown_tables?: boolean; markdown_table_multiline_separator?: string; merge_continued_tables?: boolean; output_tables_as_markdown?: boolean; }; }`\n Markdown formatting options including table styles and link annotations\n - `save_output_pdf?: boolean`\n Save a PDF copy of the parsed document, retrievable via `expand=output_pdf_content_metadata`. Not produced for spreadsheet, plain-text, or audio inputs\n - `spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }`\n Spatial text output options for preserving document layout structure\n - `tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }`\n Options for exporting tables as XLSX spreadsheets\n\n- `page_ranges?: { max_pages?: number; target_pages?: string; }`\n Page selection: limit total pages or specify exact pages to process\n - `max_pages?: number`\n Maximum number of pages to process. Pages are processed in order starting from page 1. If both max_pages and target_pages are set, target_pages takes precedence\n - `target_pages?: string`\n Comma-separated list of specific pages to process using 1-based indexing. Supports individual pages and ranges. Examples: '1,3,5' (pages 1, 3, 5), '1-5' (pages 1 through 5 inclusive), '1,3,5-8,10' (pages 1, 3, 5-8, and 10). Pages are sorted and deduplicated automatically. Duplicate pages cause an error\n\n- `processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }`\n Job execution controls including timeouts and failure thresholds\n - `job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }`\n Quality thresholds that determine when a job should fail vs complete with partial results\n - `timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }`\n Timeout settings for job execution. Increase for large or complex documents\n\n- `processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; custom_prompt?: string; extract_layout?: boolean; high_res_ocr?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; }; language?: string; outlined_table_extraction?: boolean; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version?: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; }; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: string[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }`\n Document processing options including OCR, table extraction, and chart parsing\n - `aggressive_table_extraction?: boolean`\n Use aggressive heuristics to detect table boundaries, even without visible borders. Useful for documents with borderless or complex tables\n - `auto_mode_configuration?: { parsing_conf: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; custom_prompt?: string; extract_layout?: boolean; high_res_ocr?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; }; language?: string; outlined_table_extraction?: boolean; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version?: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; }; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]`\n Conditional processing rules that apply different parsing options based on page content, document structure, or filename patterns. Each entry defines trigger conditions and the parsing configuration to apply when triggered\n - `confidence_score_effort?: 'high'`\n Confidence scoring effort. Omit for standard scoring. 'high': more accurate assessment of the parsing quality of every page, plus a document-level score in the result metadata; costs an additional 5 credits per page\n - `cost_optimizer?: { enable?: boolean; }`\n Cost optimizer configuration for reducing parsing costs on simpler pages.\n\nWhen enabled, the parser analyzes each page and routes simpler pages to faster,\ncheaper processing while preserving quality for complex pages. Only works with\n'agentic' or 'agentic_plus' tiers.\n - `disable_heuristics?: boolean`\n Disable automatic heuristics including outlined table extraction and adaptive long table handling. Use when heuristics produce incorrect results\n - `forms?: 'default' | 'enrich'`\n Beta: set to 'enrich' to run an additional AI form-analysis pass on pages detected as forms, producing a structured tree of the form's sections, fields, and fillable grids. Retrieve the result with expand=forms. 'default' (the default) applies standard parsing with no extra pass. Not available on the fast tier\n - `ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }`\n Options for ignoring specific text types (diagonal, hidden, text in images)\n - `ocr_parameters?: { languages?: string[]; }`\n OCR configuration including language detection settings\n - `specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'`\n Enable AI-powered chart analysis. Modes: 'efficient' (fast, lower cost), 'agentic' (balanced), 'agentic_plus' (highest accuracy). Automatically enables extract_layout and precise_bounding_box when set\n\n- `source_url?: string`\n Public URL of the document to parse. Mutually exclusive with file_id\n\n- `user_metadata?: object`\n Arbitrary key/value tags to attach to this job. Returned when retrieving the job. Not searchable. Limits apply to the number of entries and the length of keys and values; oversized metadata is rejected.\n\n- `webhook_configuration_ids?: string[]`\n IDs of saved webhook configurations to notify for this job.\n\n- `webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]`\n Webhook endpoints for job status notifications. Multiple webhooks can be configured for different events or services\n\n### Returns\n\n- `{ id: string; project_id: string; status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'; created_at?: string; error_message?: string; name?: string; tier?: string; updated_at?: string; usage?: { credits?: number; }; user_metadata?: object; }`\n A parse job.\n\n - `id: string`\n - `project_id: string`\n - `status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'`\n - `created_at?: string`\n - `error_message?: string`\n - `name?: string`\n - `tier?: string`\n - `updated_at?: string`\n - `usage?: { credits?: number; }`\n - `user_metadata?: object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst parsing = await client.parsing.create({ tier: 'fast', version: 'latest' });\n\nconsole.log(parsing);\n```",
|
|
536
536
|
perLanguage: {
|
|
537
537
|
go: {
|
|
538
538
|
method: 'client.Parsing.New',
|
|
@@ -701,16 +701,57 @@ const EMBEDDED_METHODS = [
|
|
|
701
701
|
},
|
|
702
702
|
},
|
|
703
703
|
},
|
|
704
|
+
{
|
|
705
|
+
name: 'delete',
|
|
706
|
+
endpoint: '/api/v2/parse/{job_id}',
|
|
707
|
+
httpMethod: 'delete',
|
|
708
|
+
summary: 'Delete Parse Job',
|
|
709
|
+
description: 'Delete a parse job and its results.\n\nThe job must be in a terminal state (COMPLETED, FAILED, CANCELLED). Cancel a job that is still running before deleting it.\n\nReturns the identifiers of the deleted job.',
|
|
710
|
+
stainlessPath: '(resource) parsing > (method) delete',
|
|
711
|
+
qualified: 'client.parsing.delete',
|
|
712
|
+
params: ['job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
713
|
+
response: '{ id: string; project_id: string; }',
|
|
714
|
+
markdown: "## delete\n\n`client.parsing.delete(job_id: string, organization_id?: string, project_id?: string): { id: string; project_id: string; }`\n\n**delete** `/api/v2/parse/{job_id}`\n\nDelete a parse job and its results.\n\nThe job must be in a terminal state (COMPLETED, FAILED, CANCELLED). Cancel a job that is still running before deleting it.\n\nReturns the identifiers of the deleted job.\n\n### Parameters\n\n- `job_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; project_id: string; }`\n Confirmation that a parse job was deleted.\n\nA deleted job can no longer be fetched, so the response echoes back what it\nwas rather than pointing at it. Returning the identifiers instead of an\nempty body lets a caller assert on the delete it just made without a\nfollow-up request.\n\n - `id: string`\n - `project_id: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst parsing = await client.parsing.delete('job_id');\n\nconsole.log(parsing);\n```",
|
|
715
|
+
perLanguage: {
|
|
716
|
+
go: {
|
|
717
|
+
method: 'client.Parsing.Delete',
|
|
718
|
+
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tparsing, err := client.Parsing.Delete(\n\t\tcontext.TODO(),\n\t\t"job_id",\n\t\tllamacloud.ParsingDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", parsing.ID)\n}\n',
|
|
719
|
+
},
|
|
720
|
+
python: {
|
|
721
|
+
method: 'parsing.delete',
|
|
722
|
+
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nparsing = client.parsing.delete(\n job_id="job_id",\n)\nprint(parsing.id)',
|
|
723
|
+
},
|
|
724
|
+
java: {
|
|
725
|
+
method: 'parsing().delete',
|
|
726
|
+
example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingDeleteParams;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingDeleteResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n ParsingDeleteResponse parsing = client.parsing().delete("job_id");\n }\n}',
|
|
727
|
+
},
|
|
728
|
+
csharp: {
|
|
729
|
+
method: 'Parsing.Delete',
|
|
730
|
+
example: 'ParsingDeleteParams parameters = new() { JobID = "job_id" };\n\nvar parsing = await client.Parsing.Delete(parameters);\n\nConsole.WriteLine(parsing);',
|
|
731
|
+
},
|
|
732
|
+
typescript: {
|
|
733
|
+
method: 'client.parsing.delete',
|
|
734
|
+
example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\nconst parsing = await client.parsing.delete('job_id');\n\nconsole.log(parsing.id);",
|
|
735
|
+
},
|
|
736
|
+
http: {
|
|
737
|
+
example: 'curl https://api.cloud.llamaindex.ai/api/v2/parse/$JOB_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
738
|
+
},
|
|
739
|
+
cli: {
|
|
740
|
+
method: 'parsing delete',
|
|
741
|
+
example: "llp parsing delete \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
742
|
+
},
|
|
743
|
+
},
|
|
744
|
+
},
|
|
704
745
|
{
|
|
705
746
|
name: 'list_versions',
|
|
706
747
|
endpoint: '/api/v2/parse/versions',
|
|
707
748
|
httpMethod: 'get',
|
|
708
749
|
summary: 'List Parse Versions',
|
|
709
|
-
description: 'List the parse versions accepted by each tier.',
|
|
750
|
+
description: 'List the parse versions accepted by each tier and what `latest` resolves to.',
|
|
710
751
|
stainlessPath: '(resource) parsing > (method) list_versions',
|
|
711
752
|
qualified: 'client.parsing.listVersions',
|
|
712
|
-
response: "{ agentic: string[]; agentic_plus: string[]; cost_effective: string[]; fast: '2026-06-15' | '2025-12-11'[]; }",
|
|
713
|
-
markdown: "## list_versions\n\n`client.parsing.listVersions(): { agentic: string[]; agentic_plus: string[]; cost_effective: string[]; fast: '2026-06-15' | '2025-12-11'[]; }`\n\n**get** `/api/v2/parse/versions`\n\nList the parse versions accepted by each tier.\n\n### Returns\n\n- `{ agentic: string[]; agentic_plus: string[]; cost_effective: string[]; fast: '2026-06-15' | '2025-12-11'[]; }`\n Versions accepted by the parse API, grouped by tier.\n\n - `agentic: string[]`\n - `agentic_plus: string[]`\n - `cost_effective: string[]`\n - `fast: '2026-06-15' | '2025-12-11'[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst response = await client.parsing.listVersions();\n\nconsole.log(response);\n```",
|
|
753
|
+
response: "{ agentic: string[]; agentic_plus: string[]; cost_effective: string[]; fast: '2026-06-15' | '2025-12-11'[]; latest: { agentic: string; agentic_plus: string; cost_effective: string; fast: string; }; }",
|
|
754
|
+
markdown: "## list_versions\n\n`client.parsing.listVersions(): { agentic: string[]; agentic_plus: string[]; cost_effective: string[]; fast: '2026-06-15' | '2025-12-11'[]; latest: object; }`\n\n**get** `/api/v2/parse/versions`\n\nList the parse versions accepted by each tier and what `latest` resolves to.\n\n### Returns\n\n- `{ agentic: string[]; agentic_plus: string[]; cost_effective: string[]; fast: '2026-06-15' | '2025-12-11'[]; latest: { agentic: string; agentic_plus: string; cost_effective: string; fast: string; }; }`\n Versions accepted by the parse API, grouped by tier.\n\n - `agentic: string[]`\n - `agentic_plus: string[]`\n - `cost_effective: string[]`\n - `fast: '2026-06-15' | '2025-12-11'[]`\n - `latest: { agentic: string; agentic_plus: string; cost_effective: string; fast: string; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst response = await client.parsing.listVersions();\n\nconsole.log(response);\n```",
|
|
714
755
|
perLanguage: {
|
|
715
756
|
go: {
|
|
716
757
|
method: 'client.Parsing.ListVersions',
|
|
@@ -753,13 +794,13 @@ const EMBEDDED_METHODS = [
|
|
|
753
794
|
'file_input: string;',
|
|
754
795
|
'organization_id?: string;',
|
|
755
796
|
'project_id?: string;',
|
|
756
|
-
"configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?:
|
|
797
|
+
"configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; };",
|
|
757
798
|
'configuration_id?: string;',
|
|
758
799
|
'webhook_configuration_ids?: string[];',
|
|
759
800
|
'webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[];',
|
|
760
801
|
],
|
|
761
|
-
response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?:
|
|
762
|
-
markdown: "## create\n\n`client.extract.create(file_input: string, organization_id?: string, project_id?: string, configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?:
|
|
802
|
+
response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; }; configuration_id?: string; error_message?: string; extract_metadata?: { field_metadata?: extracted_field_metadata; parse_job_id?: string; parse_tier?: string; }; extract_result?: object | object[]; metadata?: { usage?: object; }; usage?: { credits?: number; extract_credits?: number; parse_credits?: number; }; }",
|
|
803
|
+
markdown: "## create\n\n`client.extract.create(file_input: string, organization_id?: string, project_id?: string, configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; }, configuration_id?: string, webhook_configuration_ids?: string[], webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]): { id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: extract_configuration; configuration_id?: string; error_message?: string; extract_metadata?: extract_job_metadata; extract_result?: object | object[]; metadata?: object; usage?: object; }`\n\n**post** `/api/v2/extract`\n\nCreate an extraction job.\n\nExtracts structured data from a document using either a saved\nconfiguration or an inline JSON Schema.\n\n## Input\n\nProvide exactly one of:\n- `configuration_id` — reference a saved extraction config\n- `configuration` — inline configuration with a `data_schema`\n\n## Document input\n\nSet `file_input` to a file ID (`dfl-...`) or a\ncompleted parse job ID (`pjb-...`).\n\nThe job runs asynchronously. Poll `GET /extract/{job_id}` or\nregister a webhook to monitor completion.\n\n### Parameters\n\n- `file_input: string`\n File ID or parse job ID to extract from\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; }`\n Extract configuration combining parse and extract settings.\n - `data_schema: object`\n JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first.\n - `cite_sources?: boolean`\n Include citations in results. Returned under `extract_metadata` (auto-included when set). Text-level on `turbo` (no bounding boxes).\n - `confidence_scores?: boolean`\n Include confidence scores in results. Returned under `extract_metadata` (auto-included when set).\n - `disable_cache?: boolean`\n Disable reuse and storage of Extract results\n - `extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'`\n Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row\n - `max_pages?: number`\n Maximum number of pages to process. Omit for no limit.\n - `parse_config_id?: string`\n Saved parse configuration ID to control how the document is parsed before extraction. Turbo extract does not support parse configuration or produce a parse output; use another tier if your workflow requires parsed text.\n - `parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'`\n Parse tier to use before extraction. Defaults to the extract tier if not specified. Turbo extract does not support parse configuration or produce a parse output; use another tier if your workflow requires parsed text.\n - `sheet_names?: string[]`\n Optional worksheet names to extract when spreadsheet_mode is on. Overrides target_pages for spreadsheets; omit to extract every sheet. Names are matched exactly (case-sensitive) — pass them as a list, e.g. [\"Sheet 1\", \"My Sheet\"].\n - `spreadsheet_mode?: boolean`\n Beta. When true, extract structured data directly from a spreadsheet workbook (.xlsx/.xls/.csv) — the agent reads cells straight from the workbook instead of the standard document path. Off by default (spreadsheets keep the standard path). Requires the agentic_plus tier. Billed on the standard per-page extract rate, against a page count derived from workbook size. Citations and confidence scores are not available in this mode.\n - `system_prompt?: string`\n Custom system prompt to guide extraction behavior\n - `target_pages?: string`\n Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.\n - `tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'`\n Extract tier: cost_effective (5 credits/page), agentic (15 credits/page), agentic_plus (50 credits/page), or turbo (35 credits/page)\n - `version?: string`\n Use 'latest' for the latest release for the selected tier or a date string (YYYY-MM-DD format) to pin to the nearest release at or before that date. Job responses always report the concrete resolved version the job runs, fixed at job creation; saved configurations keep the value as provided.\n\n- `configuration_id?: string`\n Saved configuration ID\n\n- `webhook_configuration_ids?: string[]`\n IDs of saved webhook configurations to notify for this job.\n\n- `webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]`\n Outbound webhook endpoints to notify on job status changes\n\n### Returns\n\n- `{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; }; configuration_id?: string; error_message?: string; extract_metadata?: { field_metadata?: extracted_field_metadata; parse_job_id?: string; parse_tier?: string; }; extract_result?: object | object[]; metadata?: { usage?: object; }; usage?: { credits?: number; extract_credits?: number; parse_credits?: number; }; }`\n An extraction job.\n\n - `id: string`\n - `created_at: string`\n - `file_input: string`\n - `project_id: string`\n - `status: string`\n - `updated_at: string`\n - `configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; }`\n - `configuration_id?: string`\n - `error_message?: string`\n - `extract_metadata?: { field_metadata?: { document_metadata?: object; page_metadata?: object[]; row_metadata?: object[]; }; parse_job_id?: string; parse_tier?: string; }`\n - `extract_result?: object | object[]`\n - `metadata?: { usage?: { num_pages_billed?: number; num_pages_extracted?: number; }; }`\n - `usage?: { credits?: number; extract_credits?: number; parse_credits?: number; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst extractV2Job = await client.extract.create({ file_input: 'dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee' });\n\nconsole.log(extractV2Job);\n```",
|
|
763
804
|
perLanguage: {
|
|
764
805
|
go: {
|
|
765
806
|
method: 'client.Extract.New',
|
|
@@ -813,8 +854,8 @@ const EMBEDDED_METHODS = [
|
|
|
813
854
|
'project_id?: string;',
|
|
814
855
|
"status?: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING' | 'THROTTLED';",
|
|
815
856
|
],
|
|
816
|
-
response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?:
|
|
817
|
-
markdown: "## list\n\n`client.extract.list(configuration_id?: string, created_at_on_or_after?: string, created_at_on_or_before?: string, document_input_type?: string, document_input_value?: string, expand?: string[], file_input?: string, job_ids?: string[], organization_id?: string, page_size?: number, page_token?: string, project_id?: string, status?: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING' | 'THROTTLED'): { id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: extract_configuration; configuration_id?: string; error_message?: string; extract_metadata?: extract_job_metadata; extract_result?: object | object[]; metadata?: object; usage?: object; }`\n\n**get** `/api/v2/extract`\n\nList extraction jobs with optional filtering and pagination.\n\nFilter by `configuration_id`, `status`, `file_input`,\nor creation date range. Results are returned newest-first.\nUse `expand=configuration` to include the full configuration used,\nand `expand=extract_metadata` for per-field metadata.\n\n### Parameters\n\n- `configuration_id?: string`\n Filter by configuration ID\n\n- `created_at_on_or_after?: string`\n Include items created at or after this timestamp (inclusive)\n\n- `created_at_on_or_before?: string`\n Include items created at or before this timestamp (inclusive)\n\n- `document_input_type?: string`\n Filter by document input type (file_id or parse_job_id)\n\n- `document_input_value?: string`\n Deprecated: use file_input instead\n\n- `expand?: string[]`\n Additional fields to include: configuration, extract_metadata\n\n- `file_input?: string`\n Filter by file input value\n\n- `job_ids?: string[]`\n Filter by specific job IDs\n\n- `organization_id?: string`\n\n- `page_size?: number`\n Number of items per page\n\n- `page_token?: string`\n Token for pagination\n\n- `project_id?: string`\n\n- `status?: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING' | 'THROTTLED'`\n Filter by status\n\n### Returns\n\n- `{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?:
|
|
857
|
+
response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; }; configuration_id?: string; error_message?: string; extract_metadata?: { field_metadata?: extracted_field_metadata; parse_job_id?: string; parse_tier?: string; }; extract_result?: object | object[]; metadata?: { usage?: object; }; usage?: { credits?: number; extract_credits?: number; parse_credits?: number; }; }",
|
|
858
|
+
markdown: "## list\n\n`client.extract.list(configuration_id?: string, created_at_on_or_after?: string, created_at_on_or_before?: string, document_input_type?: string, document_input_value?: string, expand?: string[], file_input?: string, job_ids?: string[], organization_id?: string, page_size?: number, page_token?: string, project_id?: string, status?: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING' | 'THROTTLED'): { id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: extract_configuration; configuration_id?: string; error_message?: string; extract_metadata?: extract_job_metadata; extract_result?: object | object[]; metadata?: object; usage?: object; }`\n\n**get** `/api/v2/extract`\n\nList extraction jobs with optional filtering and pagination.\n\nFilter by `configuration_id`, `status`, `file_input`,\nor creation date range. Results are returned newest-first.\nUse `expand=configuration` to include the full configuration used,\nand `expand=extract_metadata` for per-field metadata.\n\n### Parameters\n\n- `configuration_id?: string`\n Filter by configuration ID\n\n- `created_at_on_or_after?: string`\n Include items created at or after this timestamp (inclusive)\n\n- `created_at_on_or_before?: string`\n Include items created at or before this timestamp (inclusive)\n\n- `document_input_type?: string`\n Filter by document input type (file_id or parse_job_id)\n\n- `document_input_value?: string`\n Deprecated: use file_input instead\n\n- `expand?: string[]`\n Additional fields to include: configuration, extract_metadata\n\n- `file_input?: string`\n Filter by file input value\n\n- `job_ids?: string[]`\n Filter by specific job IDs\n\n- `organization_id?: string`\n\n- `page_size?: number`\n Number of items per page\n\n- `page_token?: string`\n Token for pagination\n\n- `project_id?: string`\n\n- `status?: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING' | 'THROTTLED'`\n Filter by status\n\n### Returns\n\n- `{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; }; configuration_id?: string; error_message?: string; extract_metadata?: { field_metadata?: extracted_field_metadata; parse_job_id?: string; parse_tier?: string; }; extract_result?: object | object[]; metadata?: { usage?: object; }; usage?: { credits?: number; extract_credits?: number; parse_credits?: number; }; }`\n An extraction job.\n\n - `id: string`\n - `created_at: string`\n - `file_input: string`\n - `project_id: string`\n - `status: string`\n - `updated_at: string`\n - `configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; }`\n - `configuration_id?: string`\n - `error_message?: string`\n - `extract_metadata?: { field_metadata?: { document_metadata?: object; page_metadata?: object[]; row_metadata?: object[]; }; parse_job_id?: string; parse_tier?: string; }`\n - `extract_result?: object | object[]`\n - `metadata?: { usage?: { num_pages_billed?: number; num_pages_extracted?: number; }; }`\n - `usage?: { credits?: number; extract_credits?: number; parse_credits?: number; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\n// Automatically fetches more pages as needed.\nfor await (const extractV2Job of client.extract.list()) {\n console.log(extractV2Job);\n}\n```",
|
|
818
859
|
perLanguage: {
|
|
819
860
|
go: {
|
|
820
861
|
method: 'client.Extract.List',
|
|
@@ -854,8 +895,8 @@ const EMBEDDED_METHODS = [
|
|
|
854
895
|
stainlessPath: '(resource) extract > (method) get',
|
|
855
896
|
qualified: 'client.extract.get',
|
|
856
897
|
params: ['job_id: string;', 'expand?: string[];', 'organization_id?: string;', 'project_id?: string;'],
|
|
857
|
-
response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?:
|
|
858
|
-
markdown: "## get\n\n`client.extract.get(job_id: string, expand?: string[], organization_id?: string, project_id?: string): { id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: extract_configuration; configuration_id?: string; error_message?: string; extract_metadata?: extract_job_metadata; extract_result?: object | object[]; metadata?: object; usage?: object; }`\n\n**get** `/api/v2/extract/{job_id}`\n\nGet a single extraction job by ID.\n\nReturns the job status and results when complete.\nUse `expand=configuration` to include the full configuration used,\n`expand=extract_metadata` for per-field metadata, and\n`expand=usage` for credits billed against the job.\n\n### Parameters\n\n- `job_id: string`\n\n- `expand?: string[]`\n Additional fields to include: configuration, extract_metadata, usage\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?:
|
|
898
|
+
response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; }; configuration_id?: string; error_message?: string; extract_metadata?: { field_metadata?: extracted_field_metadata; parse_job_id?: string; parse_tier?: string; }; extract_result?: object | object[]; metadata?: { usage?: object; }; usage?: { credits?: number; extract_credits?: number; parse_credits?: number; }; }",
|
|
899
|
+
markdown: "## get\n\n`client.extract.get(job_id: string, expand?: string[], organization_id?: string, project_id?: string): { id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: extract_configuration; configuration_id?: string; error_message?: string; extract_metadata?: extract_job_metadata; extract_result?: object | object[]; metadata?: object; usage?: object; }`\n\n**get** `/api/v2/extract/{job_id}`\n\nGet a single extraction job by ID.\n\nReturns the job status and results when complete.\nUse `expand=configuration` to include the full configuration used,\n`expand=extract_metadata` for per-field metadata, and\n`expand=usage` for credits billed against the job.\n\n### Parameters\n\n- `job_id: string`\n\n- `expand?: string[]`\n Additional fields to include: configuration, extract_metadata, usage\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; }; configuration_id?: string; error_message?: string; extract_metadata?: { field_metadata?: extracted_field_metadata; parse_job_id?: string; parse_tier?: string; }; extract_result?: object | object[]; metadata?: { usage?: object; }; usage?: { credits?: number; extract_credits?: number; parse_credits?: number; }; }`\n An extraction job.\n\n - `id: string`\n - `created_at: string`\n - `file_input: string`\n - `project_id: string`\n - `status: string`\n - `updated_at: string`\n - `configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; }`\n - `configuration_id?: string`\n - `error_message?: string`\n - `extract_metadata?: { field_metadata?: { document_metadata?: object; page_metadata?: object[]; row_metadata?: object[]; }; parse_job_id?: string; parse_tier?: string; }`\n - `extract_result?: object | object[]`\n - `metadata?: { usage?: { num_pages_billed?: number; num_pages_extracted?: number; }; }`\n - `usage?: { credits?: number; extract_credits?: number; parse_credits?: number; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst extractV2Job = await client.extract.get('job_id');\n\nconsole.log(extractV2Job);\n```",
|
|
859
900
|
perLanguage: {
|
|
860
901
|
go: {
|
|
861
902
|
method: 'client.Extract.Get',
|
|
@@ -936,8 +977,8 @@ const EMBEDDED_METHODS = [
|
|
|
936
977
|
stainlessPath: '(resource) extract > (method) cancel',
|
|
937
978
|
qualified: 'client.extract.cancel',
|
|
938
979
|
params: ['job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
939
|
-
response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?:
|
|
940
|
-
markdown: "## cancel\n\n`client.extract.cancel(job_id: string, organization_id?: string, project_id?: string): { id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: extract_configuration; configuration_id?: string; error_message?: string; extract_metadata?: extract_job_metadata; extract_result?: object | object[]; metadata?: object; usage?: object; }`\n\n**post** `/api/v2/extract/{job_id}/cancel`\n\nCancel a running extraction job.\n\nStops processing and marks the job as CANCELLED. Returns the updated job. Jobs already in a terminal state (COMPLETED, FAILED, CANCELLED) cannot be cancelled.\n\n### Parameters\n\n- `job_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?:
|
|
980
|
+
response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; }; configuration_id?: string; error_message?: string; extract_metadata?: { field_metadata?: extracted_field_metadata; parse_job_id?: string; parse_tier?: string; }; extract_result?: object | object[]; metadata?: { usage?: object; }; usage?: { credits?: number; extract_credits?: number; parse_credits?: number; }; }",
|
|
981
|
+
markdown: "## cancel\n\n`client.extract.cancel(job_id: string, organization_id?: string, project_id?: string): { id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: extract_configuration; configuration_id?: string; error_message?: string; extract_metadata?: extract_job_metadata; extract_result?: object | object[]; metadata?: object; usage?: object; }`\n\n**post** `/api/v2/extract/{job_id}/cancel`\n\nCancel a running extraction job.\n\nStops processing and marks the job as CANCELLED. Returns the updated job. Jobs already in a terminal state (COMPLETED, FAILED, CANCELLED) cannot be cancelled.\n\n### Parameters\n\n- `job_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; }; configuration_id?: string; error_message?: string; extract_metadata?: { field_metadata?: extracted_field_metadata; parse_job_id?: string; parse_tier?: string; }; extract_result?: object | object[]; metadata?: { usage?: object; }; usage?: { credits?: number; extract_credits?: number; parse_credits?: number; }; }`\n An extraction job.\n\n - `id: string`\n - `created_at: string`\n - `file_input: string`\n - `project_id: string`\n - `status: string`\n - `updated_at: string`\n - `configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; }`\n - `configuration_id?: string`\n - `error_message?: string`\n - `extract_metadata?: { field_metadata?: { document_metadata?: object; page_metadata?: object[]; row_metadata?: object[]; }; parse_job_id?: string; parse_tier?: string; }`\n - `extract_result?: object | object[]`\n - `metadata?: { usage?: { num_pages_billed?: number; num_pages_extracted?: number; }; }`\n - `usage?: { credits?: number; extract_credits?: number; parse_credits?: number; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst extractV2Job = await client.extract.cancel('job_id');\n\nconsole.log(extractV2Job);\n```",
|
|
941
982
|
perLanguage: {
|
|
942
983
|
go: {
|
|
943
984
|
method: 'client.Extract.Cancel',
|
|
@@ -1026,7 +1067,7 @@ const EMBEDDED_METHODS = [
|
|
|
1026
1067
|
'prompt?: string;',
|
|
1027
1068
|
],
|
|
1028
1069
|
response: "{ name: string; parameters: object | object | object | object | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | object; }",
|
|
1029
|
-
markdown: "## generate_schema\n\n`client.extract.generateSchema(organization_id?: string, project_id?: string, data_schema?: object, file_id?: string, name?: string, prompt?: string): { name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; }`\n\n**post** `/api/v2/extract/schema/generate`\n\nGenerate a JSON schema and return a product configuration request.\n\n### Parameters\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `data_schema?: object`\n Optional schema to validate, refine, or extend\n\n- `file_id?: string`\n Optional file ID to analyze for schema generation\n\n- `name?: string`\n Name for the generated configuration (auto-generated if omitted)\n\n- `prompt?: string`\n Natural language description of the data structure to extract\n\n### Returns\n\n- `{ name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?:
|
|
1070
|
+
markdown: "## generate_schema\n\n`client.extract.generateSchema(organization_id?: string, project_id?: string, data_schema?: object, file_id?: string, name?: string, prompt?: string): { name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; }`\n\n**post** `/api/v2/extract/schema/generate`\n\nGenerate a JSON schema and return a product configuration request.\n\n### Parameters\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `data_schema?: object`\n Optional schema to validate, refine, or extend\n\n- `file_id?: string`\n Optional file ID to analyze for schema generation\n\n- `name?: string`\n Name for the generated configuration (auto-generated if omitted)\n\n- `prompt?: string`\n Natural language description of the data structure to extract\n\n### Returns\n\n- `{ name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; }`\n Request body for creating a product configuration.\n\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst configurationCreate = await client.extract.generateSchema();\n\nconsole.log(configurationCreate);\n```",
|
|
1030
1071
|
perLanguage: {
|
|
1031
1072
|
go: {
|
|
1032
1073
|
method: 'client.Extract.GenerateSchema',
|
|
@@ -1057,183 +1098,6 @@ const EMBEDDED_METHODS = [
|
|
|
1057
1098
|
},
|
|
1058
1099
|
},
|
|
1059
1100
|
},
|
|
1060
|
-
{
|
|
1061
|
-
name: 'create',
|
|
1062
|
-
endpoint: '/api/v1/classifier/jobs',
|
|
1063
|
-
httpMethod: 'post',
|
|
1064
|
-
summary: 'Create Classify Job',
|
|
1065
|
-
description: 'Create a classify job. Experimental: not production-ready and subject to change.',
|
|
1066
|
-
stainlessPath: '(resource) classifier.jobs > (method) create',
|
|
1067
|
-
qualified: 'client.classifier.jobs.create',
|
|
1068
|
-
params: [
|
|
1069
|
-
'file_ids: string[];',
|
|
1070
|
-
'rules: { description: string; type: string; }[];',
|
|
1071
|
-
'organization_id?: string;',
|
|
1072
|
-
'project_id?: string;',
|
|
1073
|
-
"mode?: 'FAST' | 'MULTIMODAL';",
|
|
1074
|
-
'parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: number[]; };',
|
|
1075
|
-
"webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[];",
|
|
1076
|
-
],
|
|
1077
|
-
response: "{ id: string; project_id: string; rules: { description: string; type: string; }[]; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; user_id: string; created_at?: string; effective_at?: string; error_message?: string; job_record_id?: string; mode?: 'FAST' | 'MULTIMODAL'; parsing_configuration?: { lang?: parsing_languages; max_pages?: number; target_pages?: number[]; }; updated_at?: string; }",
|
|
1078
|
-
markdown: "## create\n\n`client.classifier.jobs.create(file_ids: string[], rules: { description: string; type: string; }[], organization_id?: string, project_id?: string, mode?: 'FAST' | 'MULTIMODAL', parsing_configuration?: { lang?: parsing_languages; max_pages?: number; target_pages?: number[]; }, webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]): { id: string; project_id: string; rules: classifier_rule[]; status: status_enum; user_id: string; created_at?: string; effective_at?: string; error_message?: string; job_record_id?: string; mode?: 'FAST' | 'MULTIMODAL'; parsing_configuration?: classify_parsing_configuration; updated_at?: string; }`\n\n**post** `/api/v1/classifier/jobs`\n\nCreate a classify job. Experimental: not production-ready and subject to change.\n\n### Parameters\n\n- `file_ids: string[]`\n The IDs of the files to classify\n\n- `rules: { description: string; type: string; }[]`\n The rules to classify the files\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `mode?: 'FAST' | 'MULTIMODAL'`\n The classification mode to use\n\n- `parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: number[]; }`\n The configuration for the parsing job\n - `lang?: string`\n The language to parse the files in\n - `max_pages?: number`\n The maximum number of pages to parse\n - `target_pages?: number[]`\n The pages to target for parsing (0-indexed, so first page is at 0)\n\n- `webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]`\n List of webhook configurations for notifications\n\n### Returns\n\n- `{ id: string; project_id: string; rules: { description: string; type: string; }[]; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; user_id: string; created_at?: string; effective_at?: string; error_message?: string; job_record_id?: string; mode?: 'FAST' | 'MULTIMODAL'; parsing_configuration?: { lang?: parsing_languages; max_pages?: number; target_pages?: number[]; }; updated_at?: string; }`\n A classify job.\n\n - `id: string`\n - `project_id: string`\n - `rules: { description: string; type: string; }[]`\n - `status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'`\n - `user_id: string`\n - `created_at?: string`\n - `effective_at?: string`\n - `error_message?: string`\n - `job_record_id?: string`\n - `mode?: 'FAST' | 'MULTIMODAL'`\n - `parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: number[]; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst classifyJob = await client.classifier.jobs.create({ file_ids: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'], rules: [{ description: 'contains invoice number, line items, and total amount', type: 'invoice' }] });\n\nconsole.log(classifyJob);\n```",
|
|
1079
|
-
perLanguage: {
|
|
1080
|
-
go: {
|
|
1081
|
-
method: 'client.Classifier.Jobs.New',
|
|
1082
|
-
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tclassifyJob, err := client.Classifier.Jobs.New(context.TODO(), llamacloud.ClassifierJobNewParams{\n\t\tFileIDs: []string{"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"},\n\t\tRules: []llamacloud.ClassifierRuleParam{{\n\t\t\tDescription: "contains invoice number, line items, and total amount",\n\t\t\tType: "invoice",\n\t\t}},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", classifyJob.ID)\n}\n',
|
|
1083
|
-
},
|
|
1084
|
-
python: {
|
|
1085
|
-
method: 'classifier.jobs.create',
|
|
1086
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nclassify_job = client.classifier.jobs.create(\n file_ids=["182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"],\n rules=[{\n "description": "contains invoice number, line items, and total amount",\n "type": "invoice",\n }],\n)\nprint(classify_job.id)',
|
|
1087
|
-
},
|
|
1088
|
-
java: {
|
|
1089
|
-
method: 'classifier().jobs().create',
|
|
1090
|
-
example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.classifier.jobs.ClassifierRule;\nimport ai.llamaindex.llamacloud.models.classifier.jobs.ClassifyJob;\nimport ai.llamaindex.llamacloud.models.classifier.jobs.JobCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n JobCreateParams params = JobCreateParams.builder()\n .addFileId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n .addRule(ClassifierRule.builder()\n .description("contains invoice number, line items, and total amount")\n .type("invoice")\n .build())\n .build();\n ClassifyJob classifyJob = client.classifier().jobs().create(params);\n }\n}',
|
|
1091
|
-
},
|
|
1092
|
-
csharp: {
|
|
1093
|
-
method: 'Classifier.Jobs.Create',
|
|
1094
|
-
example: 'JobCreateParams parameters = new()\n{\n FileIds =\n [\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n ],\n Rules =\n [\n new()\n {\n Description = "contains invoice number, line items, and total amount",\n Type = "invoice",\n },\n ],\n};\n\nvar classifyJob = await client.Classifier.Jobs.Create(parameters);\n\nConsole.WriteLine(classifyJob);',
|
|
1095
|
-
},
|
|
1096
|
-
typescript: {
|
|
1097
|
-
method: 'client.classifier.jobs.create',
|
|
1098
|
-
example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\nconst classifyJob = await client.classifier.jobs.create({\n file_ids: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'],\n rules: [\n { description: 'contains invoice number, line items, and total amount', type: 'invoice' },\n ],\n});\n\nconsole.log(classifyJob.id);",
|
|
1099
|
-
},
|
|
1100
|
-
http: {
|
|
1101
|
-
example: 'curl https://api.cloud.llamaindex.ai/api/v1/classifier/jobs \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \\\n -d \'{\n "file_ids": [\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n ],\n "rules": [\n {\n "description": "contains invoice number, line items, and total amount",\n "type": "invoice"\n }\n ]\n }\'',
|
|
1102
|
-
},
|
|
1103
|
-
cli: {
|
|
1104
|
-
method: 'jobs create',
|
|
1105
|
-
example: "llp classifier:jobs create \\\n --api-key 'My API Key' \\\n --file-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --rule \"{description: 'contains invoice number, line items, and total amount', type: invoice}\"",
|
|
1106
|
-
},
|
|
1107
|
-
},
|
|
1108
|
-
},
|
|
1109
|
-
{
|
|
1110
|
-
name: 'list',
|
|
1111
|
-
endpoint: '/api/v1/classifier/jobs',
|
|
1112
|
-
httpMethod: 'get',
|
|
1113
|
-
summary: 'List Classify Jobs',
|
|
1114
|
-
description: 'List classify jobs. Experimental: not production-ready and subject to change.',
|
|
1115
|
-
stainlessPath: '(resource) classifier.jobs > (method) list',
|
|
1116
|
-
qualified: 'client.classifier.jobs.list',
|
|
1117
|
-
params: [
|
|
1118
|
-
'organization_id?: string;',
|
|
1119
|
-
'page_size?: number;',
|
|
1120
|
-
'page_token?: string;',
|
|
1121
|
-
'project_id?: string;',
|
|
1122
|
-
],
|
|
1123
|
-
response: "{ id: string; project_id: string; rules: { description: string; type: string; }[]; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; user_id: string; created_at?: string; effective_at?: string; error_message?: string; job_record_id?: string; mode?: 'FAST' | 'MULTIMODAL'; parsing_configuration?: { lang?: parsing_languages; max_pages?: number; target_pages?: number[]; }; updated_at?: string; }",
|
|
1124
|
-
markdown: "## list\n\n`client.classifier.jobs.list(organization_id?: string, page_size?: number, page_token?: string, project_id?: string): { id: string; project_id: string; rules: classifier_rule[]; status: status_enum; user_id: string; created_at?: string; effective_at?: string; error_message?: string; job_record_id?: string; mode?: 'FAST' | 'MULTIMODAL'; parsing_configuration?: classify_parsing_configuration; updated_at?: string; }`\n\n**get** `/api/v1/classifier/jobs`\n\nList classify jobs. Experimental: not production-ready and subject to change.\n\n### Parameters\n\n- `organization_id?: string`\n\n- `page_size?: number`\n\n- `page_token?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; project_id: string; rules: { description: string; type: string; }[]; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; user_id: string; created_at?: string; effective_at?: string; error_message?: string; job_record_id?: string; mode?: 'FAST' | 'MULTIMODAL'; parsing_configuration?: { lang?: parsing_languages; max_pages?: number; target_pages?: number[]; }; updated_at?: string; }`\n A classify job.\n\n - `id: string`\n - `project_id: string`\n - `rules: { description: string; type: string; }[]`\n - `status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'`\n - `user_id: string`\n - `created_at?: string`\n - `effective_at?: string`\n - `error_message?: string`\n - `job_record_id?: string`\n - `mode?: 'FAST' | 'MULTIMODAL'`\n - `parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: number[]; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\n// Automatically fetches more pages as needed.\nfor await (const classifyJob of client.classifier.jobs.list()) {\n console.log(classifyJob);\n}\n```",
|
|
1125
|
-
perLanguage: {
|
|
1126
|
-
go: {
|
|
1127
|
-
method: 'client.Classifier.Jobs.List',
|
|
1128
|
-
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpage, err := client.Classifier.Jobs.List(context.TODO(), llamacloud.ClassifierJobListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n',
|
|
1129
|
-
},
|
|
1130
|
-
python: {
|
|
1131
|
-
method: 'classifier.jobs.list',
|
|
1132
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\npage = client.classifier.jobs.list()\npage = page.items[0]\nprint(page.id)',
|
|
1133
|
-
},
|
|
1134
|
-
java: {
|
|
1135
|
-
method: 'classifier().jobs().list',
|
|
1136
|
-
example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.classifier.jobs.JobListPage;\nimport ai.llamaindex.llamacloud.models.classifier.jobs.JobListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n JobListPage page = client.classifier().jobs().list();\n }\n}',
|
|
1137
|
-
},
|
|
1138
|
-
csharp: {
|
|
1139
|
-
method: 'Classifier.Jobs.List',
|
|
1140
|
-
example: 'JobListParams parameters = new();\n\nvar page = await client.Classifier.Jobs.List(parameters);\nawait foreach (var item in page.Paginate())\n{\n Console.WriteLine(item);\n}',
|
|
1141
|
-
},
|
|
1142
|
-
typescript: {
|
|
1143
|
-
method: 'client.classifier.jobs.list',
|
|
1144
|
-
example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const classifyJob of client.classifier.jobs.list()) {\n console.log(classifyJob.id);\n}",
|
|
1145
|
-
},
|
|
1146
|
-
http: {
|
|
1147
|
-
example: 'curl https://api.cloud.llamaindex.ai/api/v1/classifier/jobs \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
1148
|
-
},
|
|
1149
|
-
cli: {
|
|
1150
|
-
method: 'jobs list',
|
|
1151
|
-
example: "llp classifier:jobs list \\\n --api-key 'My API Key'",
|
|
1152
|
-
},
|
|
1153
|
-
},
|
|
1154
|
-
},
|
|
1155
|
-
{
|
|
1156
|
-
name: 'get',
|
|
1157
|
-
endpoint: '/api/v1/classifier/jobs/{classify_job_id}',
|
|
1158
|
-
httpMethod: 'get',
|
|
1159
|
-
summary: 'Get Classify Job',
|
|
1160
|
-
description: 'Get a classify job. Experimental: not production-ready and subject to change.',
|
|
1161
|
-
stainlessPath: '(resource) classifier.jobs > (method) get',
|
|
1162
|
-
qualified: 'client.classifier.jobs.get',
|
|
1163
|
-
params: ['classify_job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
1164
|
-
response: "{ id: string; project_id: string; rules: { description: string; type: string; }[]; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; user_id: string; created_at?: string; effective_at?: string; error_message?: string; job_record_id?: string; mode?: 'FAST' | 'MULTIMODAL'; parsing_configuration?: { lang?: parsing_languages; max_pages?: number; target_pages?: number[]; }; updated_at?: string; }",
|
|
1165
|
-
markdown: "## get\n\n`client.classifier.jobs.get(classify_job_id: string, organization_id?: string, project_id?: string): { id: string; project_id: string; rules: classifier_rule[]; status: status_enum; user_id: string; created_at?: string; effective_at?: string; error_message?: string; job_record_id?: string; mode?: 'FAST' | 'MULTIMODAL'; parsing_configuration?: classify_parsing_configuration; updated_at?: string; }`\n\n**get** `/api/v1/classifier/jobs/{classify_job_id}`\n\nGet a classify job. Experimental: not production-ready and subject to change.\n\n### Parameters\n\n- `classify_job_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; project_id: string; rules: { description: string; type: string; }[]; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; user_id: string; created_at?: string; effective_at?: string; error_message?: string; job_record_id?: string; mode?: 'FAST' | 'MULTIMODAL'; parsing_configuration?: { lang?: parsing_languages; max_pages?: number; target_pages?: number[]; }; updated_at?: string; }`\n A classify job.\n\n - `id: string`\n - `project_id: string`\n - `rules: { description: string; type: string; }[]`\n - `status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'`\n - `user_id: string`\n - `created_at?: string`\n - `effective_at?: string`\n - `error_message?: string`\n - `job_record_id?: string`\n - `mode?: 'FAST' | 'MULTIMODAL'`\n - `parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: number[]; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst classifyJob = await client.classifier.jobs.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(classifyJob);\n```",
|
|
1166
|
-
perLanguage: {
|
|
1167
|
-
go: {
|
|
1168
|
-
method: 'client.Classifier.Jobs.Get',
|
|
1169
|
-
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tclassifyJob, err := client.Classifier.Jobs.Get(\n\t\tcontext.TODO(),\n\t\t"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n\t\tllamacloud.ClassifierJobGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", classifyJob.ID)\n}\n',
|
|
1170
|
-
},
|
|
1171
|
-
python: {
|
|
1172
|
-
method: 'classifier.jobs.get',
|
|
1173
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nclassify_job = client.classifier.jobs.get(\n classify_job_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(classify_job.id)',
|
|
1174
|
-
},
|
|
1175
|
-
java: {
|
|
1176
|
-
method: 'classifier().jobs().get',
|
|
1177
|
-
example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.classifier.jobs.ClassifyJob;\nimport ai.llamaindex.llamacloud.models.classifier.jobs.JobGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n ClassifyJob classifyJob = client.classifier().jobs().get("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");\n }\n}',
|
|
1178
|
-
},
|
|
1179
|
-
csharp: {
|
|
1180
|
-
method: 'Classifier.Jobs.Get',
|
|
1181
|
-
example: 'JobGetParams parameters = new()\n{\n ClassifyJobID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n};\n\nvar classifyJob = await client.Classifier.Jobs.Get(parameters);\n\nConsole.WriteLine(classifyJob);',
|
|
1182
|
-
},
|
|
1183
|
-
typescript: {
|
|
1184
|
-
method: 'client.classifier.jobs.get',
|
|
1185
|
-
example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\nconst classifyJob = await client.classifier.jobs.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(classifyJob.id);",
|
|
1186
|
-
},
|
|
1187
|
-
http: {
|
|
1188
|
-
example: 'curl https://api.cloud.llamaindex.ai/api/v1/classifier/jobs/$CLASSIFY_JOB_ID \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
1189
|
-
},
|
|
1190
|
-
cli: {
|
|
1191
|
-
method: 'jobs get',
|
|
1192
|
-
example: "llp classifier:jobs get \\\n --api-key 'My API Key' \\\n --classify-job-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
1193
|
-
},
|
|
1194
|
-
},
|
|
1195
|
-
},
|
|
1196
|
-
{
|
|
1197
|
-
name: 'get_results',
|
|
1198
|
-
endpoint: '/api/v1/classifier/jobs/{classify_job_id}/results',
|
|
1199
|
-
httpMethod: 'get',
|
|
1200
|
-
summary: 'Get Classification Job Results',
|
|
1201
|
-
description: 'Get the results of a classify job. Experimental: not production-ready and subject to change.',
|
|
1202
|
-
stainlessPath: '(resource) classifier.jobs > (method) get_results',
|
|
1203
|
-
qualified: 'client.classifier.jobs.getResults',
|
|
1204
|
-
params: ['classify_job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
1205
|
-
response: '{ items: { id: string; classify_job_id: string; created_at?: string; file_id?: string; result?: { confidence: number; reasoning: string; type: string; }; updated_at?: string; }[]; next_page_token?: string; total_size?: number; }',
|
|
1206
|
-
markdown: "## get_results\n\n`client.classifier.jobs.getResults(classify_job_id: string, organization_id?: string, project_id?: string): { items: object[]; next_page_token?: string; total_size?: number; }`\n\n**get** `/api/v1/classifier/jobs/{classify_job_id}/results`\n\nGet the results of a classify job. Experimental: not production-ready and subject to change.\n\n### Parameters\n\n- `classify_job_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ items: { id: string; classify_job_id: string; created_at?: string; file_id?: string; result?: { confidence: number; reasoning: string; type: string; }; updated_at?: string; }[]; next_page_token?: string; total_size?: number; }`\n Response model for the classify endpoint following AIP-132 pagination standard.\n\n - `items: { id: string; classify_job_id: string; created_at?: string; file_id?: string; result?: { confidence: number; reasoning: string; type: string; }; updated_at?: string; }[]`\n - `next_page_token?: string`\n - `total_size?: number`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst response = await client.classifier.jobs.getResults('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(response);\n```",
|
|
1207
|
-
perLanguage: {
|
|
1208
|
-
go: {
|
|
1209
|
-
method: 'client.Classifier.Jobs.GetResults',
|
|
1210
|
-
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tresponse, err := client.Classifier.Jobs.GetResults(\n\t\tcontext.TODO(),\n\t\t"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n\t\tllamacloud.ClassifierJobGetResultsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.Items)\n}\n',
|
|
1211
|
-
},
|
|
1212
|
-
python: {
|
|
1213
|
-
method: 'classifier.jobs.get_results',
|
|
1214
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nresponse = client.classifier.jobs.get_results(\n classify_job_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(response.items)',
|
|
1215
|
-
},
|
|
1216
|
-
java: {
|
|
1217
|
-
method: 'classifier().jobs().getResults',
|
|
1218
|
-
example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.classifier.jobs.JobGetResultsParams;\nimport ai.llamaindex.llamacloud.models.classifier.jobs.JobGetResultsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n JobGetResultsResponse response = client.classifier().jobs().getResults("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");\n }\n}',
|
|
1219
|
-
},
|
|
1220
|
-
csharp: {
|
|
1221
|
-
method: 'Classifier.Jobs.GetResults',
|
|
1222
|
-
example: 'JobGetResultsParams parameters = new()\n{\n ClassifyJobID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n};\n\nvar response = await client.Classifier.Jobs.GetResults(parameters);\n\nConsole.WriteLine(response);',
|
|
1223
|
-
},
|
|
1224
|
-
typescript: {
|
|
1225
|
-
method: 'client.classifier.jobs.getResults',
|
|
1226
|
-
example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.classifier.jobs.getResults('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(response.items);",
|
|
1227
|
-
},
|
|
1228
|
-
http: {
|
|
1229
|
-
example: 'curl https://api.cloud.llamaindex.ai/api/v1/classifier/jobs/$CLASSIFY_JOB_ID/results \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
1230
|
-
},
|
|
1231
|
-
cli: {
|
|
1232
|
-
method: 'jobs get_results',
|
|
1233
|
-
example: "llp classifier:jobs get-results \\\n --api-key 'My API Key' \\\n --classify-job-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
1234
|
-
},
|
|
1235
|
-
},
|
|
1236
|
-
},
|
|
1237
1101
|
{
|
|
1238
1102
|
name: 'create',
|
|
1239
1103
|
endpoint: '/api/v2/batches',
|
|
@@ -1609,12 +1473,12 @@ const EMBEDDED_METHODS = [
|
|
|
1609
1473
|
qualified: 'client.configurations.create',
|
|
1610
1474
|
params: [
|
|
1611
1475
|
'name: string;',
|
|
1612
|
-
"parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?:
|
|
1476
|
+
"parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; };",
|
|
1613
1477
|
'organization_id?: string;',
|
|
1614
1478
|
'project_id?: string;',
|
|
1615
1479
|
],
|
|
1616
1480
|
response: "{ id: string; name: string; parameters: object | object | object | object | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | object; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
|
|
1617
|
-
markdown: "## create\n\n`client.configurations.create(name: string, parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }, organization_id?: string, project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**post** `/api/v1/beta/configurations`\n\nUpsert a product configuration; updates if one with the same name + product type + project exists, otherwise creates.\n\n### Parameters\n\n- `name: string`\n Human-readable name for this configuration.\n\n- `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n Product-specific configuration parameters.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n Response schema for a single product configuration.\n\n - `id: string`\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'`\n - `version: string`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst configurationResponse = await client.configurations.create({\n name: 'x',\n parameters: { product_type: 'classify_v2', rules: [{ description: 'contains invoice number, line items, and total amount', type: 'invoice' }] },\n});\n\nconsole.log(configurationResponse);\n```",
|
|
1481
|
+
markdown: "## create\n\n`client.configurations.create(name: string, parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }, organization_id?: string, project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**post** `/api/v1/beta/configurations`\n\nUpsert a product configuration; updates if one with the same name + product type + project exists, otherwise creates.\n\n### Parameters\n\n- `name: string`\n Human-readable name for this configuration.\n\n- `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n Product-specific configuration parameters.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n Response schema for a single product configuration.\n\n - `id: string`\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'`\n - `version: string`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst configurationResponse = await client.configurations.create({\n name: 'x',\n parameters: { product_type: 'classify_v2', rules: [{ description: 'contains invoice number, line items, and total amount', type: 'invoice' }] },\n});\n\nconsole.log(configurationResponse);\n```",
|
|
1618
1482
|
perLanguage: {
|
|
1619
1483
|
go: {
|
|
1620
1484
|
method: 'client.Configurations.New',
|
|
@@ -1663,7 +1527,7 @@ const EMBEDDED_METHODS = [
|
|
|
1663
1527
|
'project_id?: string;',
|
|
1664
1528
|
],
|
|
1665
1529
|
response: "{ id: string; name: string; parameters: object | object | object | object | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | object; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
|
|
1666
|
-
markdown: "## list\n\n`client.configurations.list(latest_only?: boolean, name?: string, organization_id?: string, page_size?: number, page_token?: string, product_type?: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'[], project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/beta/configurations`\n\nList product configurations for the current project.\n\n### Parameters\n\n- `latest_only?: boolean`\n Return only the latest version per configuration name.\n\n- `name?: string`\n Filter by configuration name.\n\n- `organization_id?: string`\n\n- `page_size?: number`\n Number of items per page.\n\n- `page_token?: string`\n Pagination token.\n\n- `product_type?: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'[]`\n Filter by one or more product types. Repeat the parameter for multiple values.\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?:
|
|
1530
|
+
markdown: "## list\n\n`client.configurations.list(latest_only?: boolean, name?: string, organization_id?: string, page_size?: number, page_token?: string, product_type?: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'[], project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/beta/configurations`\n\nList product configurations for the current project.\n\n### Parameters\n\n- `latest_only?: boolean`\n Return only the latest version per configuration name.\n\n- `name?: string`\n Filter by configuration name.\n\n- `organization_id?: string`\n\n- `page_size?: number`\n Number of items per page.\n\n- `page_token?: string`\n Pagination token.\n\n- `product_type?: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'[]`\n Filter by one or more product types. Repeat the parameter for multiple values.\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n Response schema for a single product configuration.\n\n - `id: string`\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'`\n - `version: string`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\n// Automatically fetches more pages as needed.\nfor await (const configurationResponse of client.configurations.list()) {\n console.log(configurationResponse);\n}\n```",
|
|
1667
1531
|
perLanguage: {
|
|
1668
1532
|
go: {
|
|
1669
1533
|
method: 'client.Configurations.List',
|
|
@@ -1704,7 +1568,7 @@ const EMBEDDED_METHODS = [
|
|
|
1704
1568
|
qualified: 'client.configurations.retrieve',
|
|
1705
1569
|
params: ['config_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
1706
1570
|
response: "{ id: string; name: string; parameters: object | object | object | object | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | object; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
|
|
1707
|
-
markdown: "## retrieve\n\n`client.configurations.retrieve(config_id: string, organization_id?: string, project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/beta/configurations/{config_id}`\n\nGet a single product configuration by ID.\n\n### Parameters\n\n- `config_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?:
|
|
1571
|
+
markdown: "## retrieve\n\n`client.configurations.retrieve(config_id: string, organization_id?: string, project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/beta/configurations/{config_id}`\n\nGet a single product configuration by ID.\n\n### Parameters\n\n- `config_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n Response schema for a single product configuration.\n\n - `id: string`\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'`\n - `version: string`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst configurationResponse = await client.configurations.retrieve('config_id');\n\nconsole.log(configurationResponse);\n```",
|
|
1708
1572
|
perLanguage: {
|
|
1709
1573
|
go: {
|
|
1710
1574
|
method: 'client.Configurations.Get',
|
|
@@ -1748,10 +1612,10 @@ const EMBEDDED_METHODS = [
|
|
|
1748
1612
|
'organization_id?: string;',
|
|
1749
1613
|
'project_id?: string;',
|
|
1750
1614
|
'name?: string;',
|
|
1751
|
-
"parameters?: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?:
|
|
1615
|
+
"parameters?: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; };",
|
|
1752
1616
|
],
|
|
1753
1617
|
response: "{ id: string; name: string; parameters: object | object | object | object | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | object; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
|
|
1754
|
-
markdown: "## update\n\n`client.configurations.update(config_id: string, organization_id?: string, project_id?: string, name?: string, parameters?: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**put** `/api/v1/beta/configurations/{config_id}`\n\nUpdate an existing product configuration.\n\n### Parameters\n\n- `config_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `name?: string`\n Updated name (omit to leave unchanged).\n\n- `parameters?: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n Updated parameters (omit to leave unchanged).\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n Response schema for a single product configuration.\n\n - `id: string`\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'`\n - `version: string`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst configurationResponse = await client.configurations.update('config_id');\n\nconsole.log(configurationResponse);\n```",
|
|
1618
|
+
markdown: "## update\n\n`client.configurations.update(config_id: string, organization_id?: string, project_id?: string, name?: string, parameters?: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**put** `/api/v1/beta/configurations/{config_id}`\n\nUpdate an existing product configuration.\n\n### Parameters\n\n- `config_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `name?: string`\n Updated name (omit to leave unchanged).\n\n- `parameters?: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n Updated parameters (omit to leave unchanged).\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n Response schema for a single product configuration.\n\n - `id: string`\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'`\n - `version: string`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst configurationResponse = await client.configurations.update('config_id');\n\nconsole.log(configurationResponse);\n```",
|
|
1755
1619
|
perLanguage: {
|
|
1756
1620
|
go: {
|
|
1757
1621
|
method: 'client.Configurations.Update',
|
|
@@ -1840,7 +1704,7 @@ const EMBEDDED_METHODS = [
|
|
|
1840
1704
|
'webhook_signing_secret?: string;',
|
|
1841
1705
|
],
|
|
1842
1706
|
response: "{ id: string; has_secret: boolean; tenant_id: string; tenant_type: 'project'; webhook_url: string; created_at?: string; updated_at?: string; webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; }",
|
|
1843
|
-
markdown: "## create\n\n`client.webhookConfigs.create(webhook_url: string, organization_id?: string, project_id?: string, webhook_events?: string[], webhook_headers?: object, webhook_output_format?: 'json' | 'string', webhook_signing_secret?: string): { id: string; has_secret: boolean; tenant_id: string; tenant_type: 'project'; webhook_url: string; created_at?: string; updated_at?: string; webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; }`\n\n**post** `/api/v1/beta/webhook-configs`\n\nCreate a reusable webhook configuration for the current project.\n\n### Parameters\n\n- `webhook_url: string`\n URL to receive webhook POST notifications.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `webhook_events?: string[]`\n Events to subscribe to. If null, all events are delivered.\n\n- `webhook_headers?: object`\n Custom HTTP headers sent with each webhook request.\n\n- `webhook_output_format?: 'json' | 'string'`\n Response format sent to the webhook: 'string' (default) or 'json'.\n\n- `webhook_signing_secret?: string`\n Shared secret used to sign deliveries to this endpoint. Write-only: it is never returned in responses.\n\n### Returns\n\n- `{ id: string; has_secret: boolean; tenant_id: string; tenant_type: 'project'; webhook_url: string; created_at?: string; updated_at?: string; webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; }`\n A stored webhook configuration. The signing secret is never included.\n\n - `id: string`\n - `has_secret: boolean`\n - `tenant_id: string`\n - `tenant_type: 'project'`\n - `webhook_url: string`\n - `created_at?: string`\n - `updated_at?: string`\n - `webhook_events?: string[]`\n - `webhook_headers?: object`\n - `webhook_output_format?: 'json' | 'string'`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst webhookConfigResponse = await client.webhookConfigs.create({ webhook_url: 'https://example.com/webhooks/llamacloud' });\n\nconsole.log(webhookConfigResponse);\n```",
|
|
1707
|
+
markdown: "## create\n\n`client.webhookConfigs.create(webhook_url: string, organization_id?: string, project_id?: string, webhook_events?: string[], webhook_headers?: object, webhook_output_format?: 'json' | 'string', webhook_signing_secret?: string): { id: string; has_secret: boolean; tenant_id: string; tenant_type: 'project'; webhook_url: string; created_at?: string; updated_at?: string; webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; }`\n\n**post** `/api/v1/beta/webhook-configs`\n\nCreate a reusable webhook configuration for the current project.\n\n### Parameters\n\n- `webhook_url: string`\n URL to receive webhook POST notifications.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `webhook_events?: string[]`\n Events to subscribe to. If null, all events are delivered. An empty list subscribes to nothing and is rejected.\n\n- `webhook_headers?: object`\n Custom HTTP headers sent with each webhook request.\n\n- `webhook_output_format?: 'json' | 'string'`\n Response format sent to the webhook: 'string' (default) or 'json'.\n\n- `webhook_signing_secret?: string`\n Shared secret used to sign deliveries to this endpoint. Write-only: it is never returned in responses.\n\n### Returns\n\n- `{ id: string; has_secret: boolean; tenant_id: string; tenant_type: 'project'; webhook_url: string; created_at?: string; updated_at?: string; webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; }`\n A stored webhook configuration. The signing secret is never included.\n\n - `id: string`\n - `has_secret: boolean`\n - `tenant_id: string`\n - `tenant_type: 'project'`\n - `webhook_url: string`\n - `created_at?: string`\n - `updated_at?: string`\n - `webhook_events?: string[]`\n - `webhook_headers?: object`\n - `webhook_output_format?: 'json' | 'string'`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst webhookConfigResponse = await client.webhookConfigs.create({ webhook_url: 'https://example.com/webhooks/llamacloud' });\n\nconsole.log(webhookConfigResponse);\n```",
|
|
1844
1708
|
perLanguage: {
|
|
1845
1709
|
go: {
|
|
1846
1710
|
method: 'client.WebhookConfigs.New',
|
|
@@ -1972,7 +1836,7 @@ const EMBEDDED_METHODS = [
|
|
|
1972
1836
|
'webhook_url?: string;',
|
|
1973
1837
|
],
|
|
1974
1838
|
response: "{ id: string; has_secret: boolean; tenant_id: string; tenant_type: 'project'; webhook_url: string; created_at?: string; updated_at?: string; webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; }",
|
|
1975
|
-
markdown: "## update\n\n`client.webhookConfigs.update(config_id: string, organization_id?: string, project_id?: string, webhook_events?: string[], webhook_headers?: object, webhook_output_format?: 'json' | 'string', webhook_signing_secret?: string, webhook_url?: string): { id: string; has_secret: boolean; tenant_id: string; tenant_type: 'project'; webhook_url: string; created_at?: string; updated_at?: string; webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; }`\n\n**put** `/api/v1/beta/webhook-configs/{config_id}`\n\nUpdate a webhook configuration. Only fields present in the request change.\n\n### Parameters\n\n- `config_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `webhook_events?: string[]`\n Updated event subscriptions.\n\n- `webhook_headers?: object`\n Updated headers.\n\n- `webhook_output_format?: 'json' | 'string'`\n Updated output format.\n\n- `webhook_signing_secret?: string`\n Updated signing secret (write-only). Send to rotate the secret.\n\n- `webhook_url?: string`\n Updated webhook URL.\n\n### Returns\n\n- `{ id: string; has_secret: boolean; tenant_id: string; tenant_type: 'project'; webhook_url: string; created_at?: string; updated_at?: string; webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; }`\n A stored webhook configuration. The signing secret is never included.\n\n - `id: string`\n - `has_secret: boolean`\n - `tenant_id: string`\n - `tenant_type: 'project'`\n - `webhook_url: string`\n - `created_at?: string`\n - `updated_at?: string`\n - `webhook_events?: string[]`\n - `webhook_headers?: object`\n - `webhook_output_format?: 'json' | 'string'`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst webhookConfigResponse = await client.webhookConfigs.update('config_id');\n\nconsole.log(webhookConfigResponse);\n```",
|
|
1839
|
+
markdown: "## update\n\n`client.webhookConfigs.update(config_id: string, organization_id?: string, project_id?: string, webhook_events?: string[], webhook_headers?: object, webhook_output_format?: 'json' | 'string', webhook_signing_secret?: string, webhook_url?: string): { id: string; has_secret: boolean; tenant_id: string; tenant_type: 'project'; webhook_url: string; created_at?: string; updated_at?: string; webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; }`\n\n**put** `/api/v1/beta/webhook-configs/{config_id}`\n\nUpdate a webhook configuration. Only fields present in the request change.\n\n### Parameters\n\n- `config_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `webhook_events?: string[]`\n Updated event subscriptions. Omit to leave unchanged; [] is rejected.\n\n- `webhook_headers?: object`\n Updated headers.\n\n- `webhook_output_format?: 'json' | 'string'`\n Updated output format.\n\n- `webhook_signing_secret?: string`\n Updated signing secret (write-only). Send to rotate the secret.\n\n- `webhook_url?: string`\n Updated webhook URL.\n\n### Returns\n\n- `{ id: string; has_secret: boolean; tenant_id: string; tenant_type: 'project'; webhook_url: string; created_at?: string; updated_at?: string; webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; }`\n A stored webhook configuration. The signing secret is never included.\n\n - `id: string`\n - `has_secret: boolean`\n - `tenant_id: string`\n - `tenant_type: 'project'`\n - `webhook_url: string`\n - `created_at?: string`\n - `updated_at?: string`\n - `webhook_events?: string[]`\n - `webhook_headers?: object`\n - `webhook_output_format?: 'json' | 'string'`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst webhookConfigResponse = await client.webhookConfigs.update('config_id');\n\nconsole.log(webhookConfigResponse);\n```",
|
|
1976
1840
|
perLanguage: {
|
|
1977
1841
|
go: {
|
|
1978
1842
|
method: 'client.WebhookConfigs.Update',
|
|
@@ -2354,17 +2218,17 @@ const EMBEDDED_METHODS = [
|
|
|
2354
2218
|
description: 'Get a data sink by ID.',
|
|
2355
2219
|
stainlessPath: '(resource) data_sinks > (method) get',
|
|
2356
2220
|
qualified: 'client.dataSinks.get',
|
|
2357
|
-
params: ['data_sink_id: string;'],
|
|
2221
|
+
params: ['data_sink_id: string;', 'project_id?: string;'],
|
|
2358
2222
|
response: "{ id: string; component: object | object | object | object | object | object | object | object; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }",
|
|
2359
|
-
markdown: "## get\n\n`client.dataSinks.get(data_sink_id: string): { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/data-sinks/{data_sink_id}`\n\nGet a data sink by ID.\n\n### Parameters\n\n- `data_sink_id: string`\n\n### Returns\n\n- `{ id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n Schema for a data sink.\n\n - `id: string`\n - `component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: { distance_method?: 'cosine' | 'hamming' | 'ip' | 'jaccard' | 'l1' | 'l2'; ef_construction?: number; ef_search?: number; m?: number; vector_type?: 'bit' | 'half_vec' | 'sparse_vec' | 'vector'; }; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }`\n - `name: string`\n - `project_id: string`\n - `sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst dataSink = await client.dataSinks.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(dataSink);\n```",
|
|
2223
|
+
markdown: "## get\n\n`client.dataSinks.get(data_sink_id: string, project_id?: string): { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/data-sinks/{data_sink_id}`\n\nGet a data sink by ID.\n\n### Parameters\n\n- `data_sink_id: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n Schema for a data sink.\n\n - `id: string`\n - `component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: { distance_method?: 'cosine' | 'hamming' | 'ip' | 'jaccard' | 'l1' | 'l2'; ef_construction?: number; ef_search?: number; m?: number; vector_type?: 'bit' | 'half_vec' | 'sparse_vec' | 'vector'; }; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }`\n - `name: string`\n - `project_id: string`\n - `sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst dataSink = await client.dataSinks.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(dataSink);\n```",
|
|
2360
2224
|
perLanguage: {
|
|
2361
2225
|
go: {
|
|
2362
2226
|
method: 'client.DataSinks.Get',
|
|
2363
|
-
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tdataSink, err := client.DataSinks.Get(
|
|
2227
|
+
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tdataSink, err := client.DataSinks.Get(\n\t\tcontext.TODO(),\n\t\t"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n\t\tllamacloud.DataSinkGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", dataSink.ID)\n}\n',
|
|
2364
2228
|
},
|
|
2365
2229
|
python: {
|
|
2366
2230
|
method: 'data_sinks.get',
|
|
2367
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\ndata_sink = client.data_sinks.get(\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(data_sink.id)',
|
|
2231
|
+
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\ndata_sink = client.data_sinks.get(\n data_sink_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(data_sink.id)',
|
|
2368
2232
|
},
|
|
2369
2233
|
java: {
|
|
2370
2234
|
method: 'dataSinks().get',
|
|
@@ -2398,11 +2262,12 @@ const EMBEDDED_METHODS = [
|
|
|
2398
2262
|
params: [
|
|
2399
2263
|
'data_sink_id: string;',
|
|
2400
2264
|
"sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT';",
|
|
2265
|
+
'project_id?: string;',
|
|
2401
2266
|
"component?: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: { distance_method?: 'cosine' | 'hamming' | 'ip' | 'jaccard' | 'l1' | 'l2'; ef_construction?: number; ef_search?: number; m?: number; vector_type?: 'bit' | 'half_vec' | 'sparse_vec' | 'vector'; }; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; };",
|
|
2402
2267
|
'name?: string;',
|
|
2403
2268
|
],
|
|
2404
2269
|
response: "{ id: string; component: object | object | object | object | object | object | object | object; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }",
|
|
2405
|
-
markdown: "## update\n\n`client.dataSinks.update(data_sink_id: string, sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT', component?: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }, name?: string): { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n\n**put** `/api/v1/data-sinks/{data_sink_id}`\n\nUpdate a data sink by ID.\n\n### Parameters\n\n- `data_sink_id: string`\n\n- `sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'`\n\n- `component?: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: { distance_method?: 'cosine' | 'hamming' | 'ip' | 'jaccard' | 'l1' | 'l2'; ef_construction?: number; ef_search?: number; m?: number; vector_type?: 'bit' | 'half_vec' | 'sparse_vec' | 'vector'; }; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }`\n Component that implements the data sink\n\n- `name?: string`\n The name of the data sink.\n\n### Returns\n\n- `{ id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n Schema for a data sink.\n\n - `id: string`\n - `component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: { distance_method?: 'cosine' | 'hamming' | 'ip' | 'jaccard' | 'l1' | 'l2'; ef_construction?: number; ef_search?: number; m?: number; vector_type?: 'bit' | 'half_vec' | 'sparse_vec' | 'vector'; }; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }`\n - `name: string`\n - `project_id: string`\n - `sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst dataSink = await client.dataSinks.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { sink_type: 'ASTRA_DB' });\n\nconsole.log(dataSink);\n```",
|
|
2270
|
+
markdown: "## update\n\n`client.dataSinks.update(data_sink_id: string, sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT', project_id?: string, component?: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }, name?: string): { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n\n**put** `/api/v1/data-sinks/{data_sink_id}`\n\nUpdate a data sink by ID.\n\n### Parameters\n\n- `data_sink_id: string`\n\n- `sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'`\n\n- `project_id?: string`\n\n- `component?: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: { distance_method?: 'cosine' | 'hamming' | 'ip' | 'jaccard' | 'l1' | 'l2'; ef_construction?: number; ef_search?: number; m?: number; vector_type?: 'bit' | 'half_vec' | 'sparse_vec' | 'vector'; }; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }`\n Component that implements the data sink\n\n- `name?: string`\n The name of the data sink.\n\n### Returns\n\n- `{ id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n Schema for a data sink.\n\n - `id: string`\n - `component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: { distance_method?: 'cosine' | 'hamming' | 'ip' | 'jaccard' | 'l1' | 'l2'; ef_construction?: number; ef_search?: number; m?: number; vector_type?: 'bit' | 'half_vec' | 'sparse_vec' | 'vector'; }; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }`\n - `name: string`\n - `project_id: string`\n - `sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst dataSink = await client.dataSinks.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { sink_type: 'ASTRA_DB' });\n\nconsole.log(dataSink);\n```",
|
|
2406
2271
|
perLanguage: {
|
|
2407
2272
|
go: {
|
|
2408
2273
|
method: 'client.DataSinks.Update',
|
|
@@ -2441,16 +2306,16 @@ const EMBEDDED_METHODS = [
|
|
|
2441
2306
|
description: 'Delete a data sink by ID.',
|
|
2442
2307
|
stainlessPath: '(resource) data_sinks > (method) delete',
|
|
2443
2308
|
qualified: 'client.dataSinks.delete',
|
|
2444
|
-
params: ['data_sink_id: string;'],
|
|
2445
|
-
markdown: "## delete\n\n`client.dataSinks.delete(data_sink_id: string): void`\n\n**delete** `/api/v1/data-sinks/{data_sink_id}`\n\nDelete a data sink by ID.\n\n### Parameters\n\n- `data_sink_id: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nawait client.dataSinks.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e')\n```",
|
|
2309
|
+
params: ['data_sink_id: string;', 'project_id?: string;'],
|
|
2310
|
+
markdown: "## delete\n\n`client.dataSinks.delete(data_sink_id: string, project_id?: string): void`\n\n**delete** `/api/v1/data-sinks/{data_sink_id}`\n\nDelete a data sink by ID.\n\n### Parameters\n\n- `data_sink_id: string`\n\n- `project_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nawait client.dataSinks.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e')\n```",
|
|
2446
2311
|
perLanguage: {
|
|
2447
2312
|
go: {
|
|
2448
2313
|
method: 'client.DataSinks.Delete',
|
|
2449
|
-
example: 'package main\n\nimport (\n\t"context"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\terr := client.DataSinks.Delete(
|
|
2314
|
+
example: 'package main\n\nimport (\n\t"context"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\terr := client.DataSinks.Delete(\n\t\tcontext.TODO(),\n\t\t"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n\t\tllamacloud.DataSinkDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n',
|
|
2450
2315
|
},
|
|
2451
2316
|
python: {
|
|
2452
2317
|
method: 'data_sinks.delete',
|
|
2453
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nclient.data_sinks.delete(\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)',
|
|
2318
|
+
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nclient.data_sinks.delete(\n data_sink_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)',
|
|
2454
2319
|
},
|
|
2455
2320
|
java: {
|
|
2456
2321
|
method: 'dataSinks().delete',
|
|
@@ -2570,17 +2435,17 @@ const EMBEDDED_METHODS = [
|
|
|
2570
2435
|
description: 'Get a data source by ID.',
|
|
2571
2436
|
stainlessPath: '(resource) data_sources > (method) get',
|
|
2572
2437
|
qualified: 'client.dataSources.get',
|
|
2573
|
-
params: ['data_source_id: string;'],
|
|
2438
|
+
params: ['data_source_id: string;', 'project_id?: string;'],
|
|
2574
2439
|
response: '{ id: string; component: object | object | object | object | object | object | object | object | object | object | object | object; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: object; }',
|
|
2575
|
-
markdown: "## get\n\n`client.dataSources.get(data_source_id: string): { id: string; component: object | cloud_s3_data_source | cloud_az_storage_blob_data_source | cloud_google_drive_data_source | cloud_one_drive_data_source | cloud_sharepoint_data_source | cloud_slack_data_source | cloud_notion_page_data_source | cloud_confluence_data_source | cloud_jira_data_source | cloud_jira_data_source_v2 | cloud_box_data_source; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: data_source_reader_version_metadata; }`\n\n**get** `/api/v1/data-sources/{data_source_id}`\n\nGet a data source by ID.\n\n### Parameters\n\n- `data_source_id: string`\n\n### Returns\n\n- `{ id: string; component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }; }`\n Schema for a data source.\n\n - `id: string`\n - `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n - `name: string`\n - `project_id: string`\n - `source_type: string`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `updated_at?: string`\n - `version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst dataSource = await client.dataSources.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(dataSource);\n```",
|
|
2440
|
+
markdown: "## get\n\n`client.dataSources.get(data_source_id: string, project_id?: string): { id: string; component: object | cloud_s3_data_source | cloud_az_storage_blob_data_source | cloud_google_drive_data_source | cloud_one_drive_data_source | cloud_sharepoint_data_source | cloud_slack_data_source | cloud_notion_page_data_source | cloud_confluence_data_source | cloud_jira_data_source | cloud_jira_data_source_v2 | cloud_box_data_source; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: data_source_reader_version_metadata; }`\n\n**get** `/api/v1/data-sources/{data_source_id}`\n\nGet a data source by ID.\n\n### Parameters\n\n- `data_source_id: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }; }`\n Schema for a data source.\n\n - `id: string`\n - `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n - `name: string`\n - `project_id: string`\n - `source_type: string`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `updated_at?: string`\n - `version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst dataSource = await client.dataSources.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(dataSource);\n```",
|
|
2576
2441
|
perLanguage: {
|
|
2577
2442
|
go: {
|
|
2578
2443
|
method: 'client.DataSources.Get',
|
|
2579
|
-
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tdataSource, err := client.DataSources.Get(
|
|
2444
|
+
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tdataSource, err := client.DataSources.Get(\n\t\tcontext.TODO(),\n\t\t"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n\t\tllamacloud.DataSourceGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", dataSource.ID)\n}\n',
|
|
2580
2445
|
},
|
|
2581
2446
|
python: {
|
|
2582
2447
|
method: 'data_sources.get',
|
|
2583
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\ndata_source = client.data_sources.get(\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(data_source.id)',
|
|
2448
|
+
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\ndata_source = client.data_sources.get(\n data_source_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(data_source.id)',
|
|
2584
2449
|
},
|
|
2585
2450
|
java: {
|
|
2586
2451
|
method: 'dataSources().get',
|
|
@@ -2614,12 +2479,13 @@ const EMBEDDED_METHODS = [
|
|
|
2614
2479
|
params: [
|
|
2615
2480
|
'data_source_id: string;',
|
|
2616
2481
|
'source_type: string;',
|
|
2482
|
+
'project_id?: string;',
|
|
2617
2483
|
"component?: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; };",
|
|
2618
2484
|
'custom_metadata?: object;',
|
|
2619
2485
|
'name?: string;',
|
|
2620
2486
|
],
|
|
2621
2487
|
response: '{ id: string; component: object | object | object | object | object | object | object | object | object | object | object | object; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: object; }',
|
|
2622
|
-
markdown: "## update\n\n`client.dataSources.update(data_source_id: string, source_type: string, component?: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }, custom_metadata?: object, name?: string): { id: string; component: object | cloud_s3_data_source | cloud_az_storage_blob_data_source | cloud_google_drive_data_source | cloud_one_drive_data_source | cloud_sharepoint_data_source | cloud_slack_data_source | cloud_notion_page_data_source | cloud_confluence_data_source | cloud_jira_data_source | cloud_jira_data_source_v2 | cloud_box_data_source; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: data_source_reader_version_metadata; }`\n\n**put** `/api/v1/data-sources/{data_source_id}`\n\nUpdate a data source by ID.\n\n### Parameters\n\n- `data_source_id: string`\n\n- `source_type: string`\n\n- `component?: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n Component that implements the data source\n\n- `custom_metadata?: object`\n Custom metadata that will be present on all data loaded from the data source\n\n- `name?: string`\n The name of the data source.\n\n### Returns\n\n- `{ id: string; component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }; }`\n Schema for a data source.\n\n - `id: string`\n - `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n - `name: string`\n - `project_id: string`\n - `source_type: string`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `updated_at?: string`\n - `version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst dataSource = await client.dataSources.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { source_type: 'AZURE_STORAGE_BLOB' });\n\nconsole.log(dataSource);\n```",
|
|
2488
|
+
markdown: "## update\n\n`client.dataSources.update(data_source_id: string, source_type: string, project_id?: string, component?: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }, custom_metadata?: object, name?: string): { id: string; component: object | cloud_s3_data_source | cloud_az_storage_blob_data_source | cloud_google_drive_data_source | cloud_one_drive_data_source | cloud_sharepoint_data_source | cloud_slack_data_source | cloud_notion_page_data_source | cloud_confluence_data_source | cloud_jira_data_source | cloud_jira_data_source_v2 | cloud_box_data_source; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: data_source_reader_version_metadata; }`\n\n**put** `/api/v1/data-sources/{data_source_id}`\n\nUpdate a data source by ID.\n\n### Parameters\n\n- `data_source_id: string`\n\n- `source_type: string`\n\n- `project_id?: string`\n\n- `component?: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n Component that implements the data source\n\n- `custom_metadata?: object`\n Custom metadata that will be present on all data loaded from the data source\n\n- `name?: string`\n The name of the data source.\n\n### Returns\n\n- `{ id: string; component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }; }`\n Schema for a data source.\n\n - `id: string`\n - `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n - `name: string`\n - `project_id: string`\n - `source_type: string`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `updated_at?: string`\n - `version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst dataSource = await client.dataSources.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { source_type: 'AZURE_STORAGE_BLOB' });\n\nconsole.log(dataSource);\n```",
|
|
2623
2489
|
perLanguage: {
|
|
2624
2490
|
go: {
|
|
2625
2491
|
method: 'client.DataSources.Update',
|
|
@@ -2658,16 +2524,16 @@ const EMBEDDED_METHODS = [
|
|
|
2658
2524
|
description: 'Delete a data source by ID.',
|
|
2659
2525
|
stainlessPath: '(resource) data_sources > (method) delete',
|
|
2660
2526
|
qualified: 'client.dataSources.delete',
|
|
2661
|
-
params: ['data_source_id: string;'],
|
|
2662
|
-
markdown: "## delete\n\n`client.dataSources.delete(data_source_id: string): void`\n\n**delete** `/api/v1/data-sources/{data_source_id}`\n\nDelete a data source by ID.\n\n### Parameters\n\n- `data_source_id: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nawait client.dataSources.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e')\n```",
|
|
2527
|
+
params: ['data_source_id: string;', 'project_id?: string;'],
|
|
2528
|
+
markdown: "## delete\n\n`client.dataSources.delete(data_source_id: string, project_id?: string): void`\n\n**delete** `/api/v1/data-sources/{data_source_id}`\n\nDelete a data source by ID.\n\n### Parameters\n\n- `data_source_id: string`\n\n- `project_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nawait client.dataSources.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e')\n```",
|
|
2663
2529
|
perLanguage: {
|
|
2664
2530
|
go: {
|
|
2665
2531
|
method: 'client.DataSources.Delete',
|
|
2666
|
-
example: 'package main\n\nimport (\n\t"context"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\terr := client.DataSources.Delete(
|
|
2532
|
+
example: 'package main\n\nimport (\n\t"context"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\terr := client.DataSources.Delete(\n\t\tcontext.TODO(),\n\t\t"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n\t\tllamacloud.DataSourceDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n',
|
|
2667
2533
|
},
|
|
2668
2534
|
python: {
|
|
2669
2535
|
method: 'data_sources.delete',
|
|
2670
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nclient.data_sources.delete(\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)',
|
|
2536
|
+
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nclient.data_sources.delete(\n data_source_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)',
|
|
2671
2537
|
},
|
|
2672
2538
|
java: {
|
|
2673
2539
|
method: 'dataSources().delete',
|
|
@@ -2695,7 +2561,7 @@ const EMBEDDED_METHODS = [
|
|
|
2695
2561
|
endpoint: '/api/v1/pipelines',
|
|
2696
2562
|
httpMethod: 'get',
|
|
2697
2563
|
summary: 'Search Pipelines',
|
|
2698
|
-
description: 'Search for pipelines by name, type, or project.',
|
|
2564
|
+
description: 'Search for pipelines by name, type, or project.\n\nDeprecated: use `GET /api/v2/pipelines`, which is paginated.',
|
|
2699
2565
|
stainlessPath: '(resource) pipelines > (method) list',
|
|
2700
2566
|
qualified: 'client.pipelines.list',
|
|
2701
2567
|
params: [
|
|
@@ -2706,7 +2572,7 @@ const EMBEDDED_METHODS = [
|
|
|
2706
2572
|
'project_name?: string;',
|
|
2707
2573
|
],
|
|
2708
2574
|
response: "{ id: string; embedding_config: object | object | object | object | object | { component?: object; type?: 'MANAGED_OPENAI_EMBEDDING'; } | object | object; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: object; embedding_model_config?: { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: object; managed_pipeline_id?: string; metadata_config?: object; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: object; sparse_model_config?: object; status?: 'CREATED' | 'DELETING'; transform_config?: object | object; updated_at?: string; }[]",
|
|
2709
|
-
markdown: "## list\n\n`client.pipelines.list(organization_id?: string, pipeline_name?: string, pipeline_type?: 'MANAGED' | 'PLAYGROUND', project_id?: string, project_name?: string): object[]`\n\n**get** `/api/v1/pipelines`\n\nSearch for pipelines by name, type, or project.\n\n### Parameters\n\n- `organization_id?: string`\n\n- `pipeline_name?: string`\n\n- `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n Enum for representing the type of a pipeline\n\n- `project_id?: string`\n\n- `project_name?: string`\n\n### Returns\n\n- `{ id: string; embedding_config: object | object | object | object | object | { component?: object; type?: 'MANAGED_OPENAI_EMBEDDING'; } | object | object; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: object; embedding_model_config?: { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: object; managed_pipeline_id?: string; metadata_config?: object; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: object; sparse_model_config?: object; status?: 'CREATED' | 'DELETING'; transform_config?: object | object; updated_at?: string; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipelines = await client.pipelines.list();\n\nconsole.log(pipelines);\n```",
|
|
2575
|
+
markdown: "## list\n\n`client.pipelines.list(organization_id?: string, pipeline_name?: string, pipeline_type?: 'MANAGED' | 'PLAYGROUND', project_id?: string, project_name?: string): object[]`\n\n**get** `/api/v1/pipelines`\n\nSearch for pipelines by name, type, or project.\n\nDeprecated: use `GET /api/v2/pipelines`, which is paginated.\n\n### Parameters\n\n- `organization_id?: string`\n\n- `pipeline_name?: string`\n\n- `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n Enum for representing the type of a pipeline\n\n- `project_id?: string`\n\n- `project_name?: string`\n\n### Returns\n\n- `{ id: string; embedding_config: object | object | object | object | object | { component?: object; type?: 'MANAGED_OPENAI_EMBEDDING'; } | object | object; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: object; embedding_model_config?: { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: object; managed_pipeline_id?: string; metadata_config?: object; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: object; sparse_model_config?: object; status?: 'CREATED' | 'DELETING'; transform_config?: object | object; updated_at?: string; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipelines = await client.pipelines.list();\n\nconsole.log(pipelines);\n```",
|
|
2710
2576
|
perLanguage: {
|
|
2711
2577
|
go: {
|
|
2712
2578
|
method: 'client.Pipelines.List',
|
|
@@ -2737,6 +2603,54 @@ const EMBEDDED_METHODS = [
|
|
|
2737
2603
|
},
|
|
2738
2604
|
},
|
|
2739
2605
|
},
|
|
2606
|
+
{
|
|
2607
|
+
name: 'list_paginated',
|
|
2608
|
+
endpoint: '/api/v2/pipelines',
|
|
2609
|
+
httpMethod: 'get',
|
|
2610
|
+
summary: 'List Pipelines',
|
|
2611
|
+
description: 'List the pipelines in a project, newest first.',
|
|
2612
|
+
stainlessPath: '(resource) pipelines > (method) list_paginated',
|
|
2613
|
+
qualified: 'client.pipelines.listPaginated',
|
|
2614
|
+
params: [
|
|
2615
|
+
'name?: string;',
|
|
2616
|
+
'organization_id?: string;',
|
|
2617
|
+
'page_size?: number;',
|
|
2618
|
+
'page_token?: string;',
|
|
2619
|
+
"pipeline_type?: 'MANAGED' | 'PLAYGROUND';",
|
|
2620
|
+
'project_id?: string;',
|
|
2621
|
+
],
|
|
2622
|
+
response: "{ id: string; name: string; pipeline_type: 'MANAGED' | 'PLAYGROUND'; project_id: string; created_at?: string; status?: 'CREATED' | 'DELETING'; updated_at?: string; }",
|
|
2623
|
+
markdown: "## list_paginated\n\n`client.pipelines.listPaginated(name?: string, organization_id?: string, page_size?: number, page_token?: string, pipeline_type?: 'MANAGED' | 'PLAYGROUND', project_id?: string): { id: string; name: string; pipeline_type: 'MANAGED' | 'PLAYGROUND'; project_id: string; created_at?: string; status?: 'CREATED' | 'DELETING'; updated_at?: string; }`\n\n**get** `/api/v2/pipelines`\n\nList the pipelines in a project, newest first.\n\n### Parameters\n\n- `name?: string`\n\n- `organization_id?: string`\n\n- `page_size?: number`\n\n- `page_token?: string`\n\n- `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; pipeline_type: 'MANAGED' | 'PLAYGROUND'; project_id: string; created_at?: string; status?: 'CREATED' | 'DELETING'; updated_at?: string; }`\n A pipeline in a project.\n\n - `id: string`\n - `name: string`\n - `pipeline_type: 'MANAGED' | 'PLAYGROUND'`\n - `project_id: string`\n - `created_at?: string`\n - `status?: 'CREATED' | 'DELETING'`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\n// Automatically fetches more pages as needed.\nfor await (const pipelineListPaginatedResponse of client.pipelines.listPaginated()) {\n console.log(pipelineListPaginatedResponse);\n}\n```",
|
|
2624
|
+
perLanguage: {
|
|
2625
|
+
go: {
|
|
2626
|
+
method: 'client.Pipelines.ListPaginated',
|
|
2627
|
+
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpage, err := client.Pipelines.ListPaginated(context.TODO(), llamacloud.PipelineListPaginatedParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n',
|
|
2628
|
+
},
|
|
2629
|
+
python: {
|
|
2630
|
+
method: 'pipelines.list_paginated',
|
|
2631
|
+
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\npage = client.pipelines.list_paginated()\npage = page.items[0]\nprint(page.id)',
|
|
2632
|
+
},
|
|
2633
|
+
java: {
|
|
2634
|
+
method: 'pipelines().listPaginated',
|
|
2635
|
+
example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.pipelines.PipelineListPaginatedPage;\nimport ai.llamaindex.llamacloud.models.pipelines.PipelineListPaginatedParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n PipelineListPaginatedPage page = client.pipelines().listPaginated();\n }\n}',
|
|
2636
|
+
},
|
|
2637
|
+
csharp: {
|
|
2638
|
+
method: 'Pipelines.ListPaginated',
|
|
2639
|
+
example: 'PipelineListPaginatedParams parameters = new();\n\nvar page = await client.Pipelines.ListPaginated(parameters);\nawait foreach (var item in page.Paginate())\n{\n Console.WriteLine(item);\n}',
|
|
2640
|
+
},
|
|
2641
|
+
typescript: {
|
|
2642
|
+
method: 'client.pipelines.listPaginated',
|
|
2643
|
+
example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const pipelineListPaginatedResponse of client.pipelines.listPaginated()) {\n console.log(pipelineListPaginatedResponse.id);\n}",
|
|
2644
|
+
},
|
|
2645
|
+
http: {
|
|
2646
|
+
example: 'curl https://api.cloud.llamaindex.ai/api/v2/pipelines \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
2647
|
+
},
|
|
2648
|
+
cli: {
|
|
2649
|
+
method: 'pipelines list_paginated',
|
|
2650
|
+
example: "llp pipelines list-paginated \\\n --api-key 'My API Key'",
|
|
2651
|
+
},
|
|
2652
|
+
},
|
|
2653
|
+
},
|
|
2740
2654
|
{
|
|
2741
2655
|
name: 'create',
|
|
2742
2656
|
endpoint: '/api/v1/pipelines',
|
|
@@ -2802,17 +2716,17 @@ const EMBEDDED_METHODS = [
|
|
|
2802
2716
|
description: 'Get a pipeline by ID.',
|
|
2803
2717
|
stainlessPath: '(resource) pipelines > (method) get',
|
|
2804
2718
|
qualified: 'client.pipelines.get',
|
|
2805
|
-
params: ['pipeline_id: string;'],
|
|
2719
|
+
params: ['pipeline_id: string;', 'project_id?: string;'],
|
|
2806
2720
|
response: "{ id: string; embedding_config: object | object | object | object | object | { component?: object; type?: 'MANAGED_OPENAI_EMBEDDING'; } | object | object; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: object; embedding_model_config?: { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: object; managed_pipeline_id?: string; metadata_config?: object; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: object; sparse_model_config?: object; status?: 'CREATED' | 'DELETING'; transform_config?: object | object; updated_at?: string; }",
|
|
2807
|
-
markdown: "## get\n\n`client.pipelines.get(pipeline_id: string): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}`\n\nGet a pipeline by ID.\n\n### Parameters\n\n- `pipeline_id: string`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }; managed_pipeline_id?: string; metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }; sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }; status?: 'CREATED' | 'DELETING'; transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }; updated_at?: string; }`\n Schema for a pipeline.\n\n - `id: string`\n - `embedding_config: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n - `name: string`\n - `project_id: string`\n - `config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }`\n - `created_at?: string`\n - `data_sink?: { id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n - `embedding_model_config?: { id: string; embedding_config: { component?: object; type?: 'AZURE_EMBEDDING'; } | { component?: object; type?: 'BEDROCK_EMBEDDING'; } | { component?: object; type?: 'COHERE_EMBEDDING'; } | { component?: object; type?: 'GEMINI_EMBEDDING'; } | { component?: object; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: object; type?: 'OPENAI_EMBEDDING'; } | { component?: object; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; created_at?: string; updated_at?: string; }`\n - `embedding_model_config_id?: string`\n - `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n - `managed_pipeline_id?: string`\n - `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n - `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n - `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n - `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n - `status?: 'CREATED' | 'DELETING'`\n - `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipeline = await client.pipelines.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(pipeline);\n```",
|
|
2721
|
+
markdown: "## get\n\n`client.pipelines.get(pipeline_id: string, project_id?: string): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}`\n\nGet a pipeline by ID.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }; managed_pipeline_id?: string; metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }; sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }; status?: 'CREATED' | 'DELETING'; transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }; updated_at?: string; }`\n Schema for a pipeline.\n\n - `id: string`\n - `embedding_config: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n - `name: string`\n - `project_id: string`\n - `config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }`\n - `created_at?: string`\n - `data_sink?: { id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n - `embedding_model_config?: { id: string; embedding_config: { component?: object; type?: 'AZURE_EMBEDDING'; } | { component?: object; type?: 'BEDROCK_EMBEDDING'; } | { component?: object; type?: 'COHERE_EMBEDDING'; } | { component?: object; type?: 'GEMINI_EMBEDDING'; } | { component?: object; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: object; type?: 'OPENAI_EMBEDDING'; } | { component?: object; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; created_at?: string; updated_at?: string; }`\n - `embedding_model_config_id?: string`\n - `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n - `managed_pipeline_id?: string`\n - `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n - `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n - `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n - `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n - `status?: 'CREATED' | 'DELETING'`\n - `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipeline = await client.pipelines.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(pipeline);\n```",
|
|
2808
2722
|
perLanguage: {
|
|
2809
2723
|
go: {
|
|
2810
2724
|
method: 'client.Pipelines.Get',
|
|
2811
|
-
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpipeline, err := client.Pipelines.Get(
|
|
2725
|
+
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpipeline, err := client.Pipelines.Get(\n\t\tcontext.TODO(),\n\t\t"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n\t\tllamacloud.PipelineGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipeline.ID)\n}\n',
|
|
2812
2726
|
},
|
|
2813
2727
|
python: {
|
|
2814
2728
|
method: 'pipelines.get',
|
|
2815
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\npipeline = client.pipelines.get(\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(pipeline.id)',
|
|
2729
|
+
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\npipeline = client.pipelines.get(\n pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(pipeline.id)',
|
|
2816
2730
|
},
|
|
2817
2731
|
java: {
|
|
2818
2732
|
method: 'pipelines().get',
|
|
@@ -2845,6 +2759,7 @@ const EMBEDDED_METHODS = [
|
|
|
2845
2759
|
qualified: 'client.pipelines.update',
|
|
2846
2760
|
params: [
|
|
2847
2761
|
'pipeline_id: string;',
|
|
2762
|
+
'project_id?: string;',
|
|
2848
2763
|
"data_sink?: { component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; };",
|
|
2849
2764
|
'data_sink_id?: string;',
|
|
2850
2765
|
"embedding_config?: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; };",
|
|
@@ -2859,7 +2774,7 @@ const EMBEDDED_METHODS = [
|
|
|
2859
2774
|
"transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; };",
|
|
2860
2775
|
],
|
|
2861
2776
|
response: "{ id: string; embedding_config: object | object | object | object | object | { component?: object; type?: 'MANAGED_OPENAI_EMBEDDING'; } | object | object; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: object; embedding_model_config?: { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: object; managed_pipeline_id?: string; metadata_config?: object; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: object; sparse_model_config?: object; status?: 'CREATED' | 'DELETING'; transform_config?: object | object; updated_at?: string; }",
|
|
2862
|
-
markdown: "## update\n\n`client.pipelines.update(pipeline_id: string, data_sink?: { component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; }, data_sink_id?: string, embedding_config?: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }, embedding_model_config_id?: string, llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }, managed_pipeline_id?: string, metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }, name?: string, preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }, sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }, status?: string, transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**put** `/api/v1/pipelines/{pipeline_id}`\n\nUpdate an existing pipeline's configuration.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_sink?: { component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; }`\n Schema for creating a data sink.\n - `component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: { distance_method?: 'cosine' | 'hamming' | 'ip' | 'jaccard' | 'l1' | 'l2'; ef_construction?: number; ef_search?: number; m?: number; vector_type?: 'bit' | 'half_vec' | 'sparse_vec' | 'vector'; }; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }`\n Component that implements the data sink\n - `name: string`\n The name of the data sink.\n - `sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'`\n\n- `data_sink_id?: string`\n Data sink ID. When provided instead of data_sink, the data sink will be looked up by ID.\n\n- `embedding_config?: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n\n- `embedding_model_config_id?: string`\n Embedding model config ID. When provided instead of embedding_config, the embedding model config will be looked up by ID.\n\n- `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n Settings that can be configured for how to use LlamaParse to parse files within a LlamaCloud pipeline.\n - `adaptive_long_table?: boolean`\n - `aggressive_table_extraction?: boolean`\n - `annotate_line_numbers?: boolean`\n - `annotate_links?: boolean`\n - `annotate_revisions?: boolean`\n - `auto_mode?: boolean`\n - `auto_mode_configuration_json?: string`\n - `auto_mode_trigger_on_image_in_page?: boolean`\n - `auto_mode_trigger_on_regexp_in_page?: string`\n - `auto_mode_trigger_on_table_in_page?: boolean`\n - `auto_mode_trigger_on_text_in_page?: string`\n - `azure_openai_api_version?: string`\n - `azure_openai_deployment_name?: string`\n - `azure_openai_endpoint?: string`\n - `azure_openai_key?: string`\n - `bbox_bottom?: number`\n - `bbox_left?: number`\n - `bbox_right?: number`\n - `bbox_top?: number`\n - `bounding_box?: string`\n - `compact_markdown_table?: boolean`\n - `complemental_formatting_instruction?: string`\n - `confidence_score_effort?: string`\n - `content_guideline_instruction?: string`\n - `continuous_mode?: boolean`\n - `disable_image_extraction?: boolean`\n - `disable_ocr?: boolean`\n - `disable_reconstruction?: boolean`\n - `do_not_cache?: boolean`\n - `do_not_unroll_columns?: boolean`\n - `enable_cost_optimizer?: boolean`\n - `extract_charts?: boolean`\n - `extract_layout?: boolean`\n - `extract_printed_page_number?: boolean`\n - `fast_mode?: boolean`\n - `formatting_instruction?: string`\n - `gpt4o_api_key?: string`\n - `gpt4o_mode?: boolean`\n - `guess_xlsx_sheet_name?: boolean`\n - `hide_footers?: boolean`\n - `hide_headers?: boolean`\n - `high_res_ocr?: boolean`\n - `html_make_all_elements_visible?: boolean`\n - `html_remove_fixed_elements?: boolean`\n - `html_remove_navigation_elements?: boolean`\n - `http_proxy?: string`\n - `ignore_document_elements_for_layout_detection?: boolean`\n - `images_to_save?: 'embedded' | 'layout' | 'screenshot'[]`\n - `inline_images_in_markdown?: boolean`\n - `input_s3_path?: string`\n - `input_s3_region?: string`\n - `input_url?: string`\n - `internal_is_screenshot_job?: boolean`\n - `invalidate_cache?: boolean`\n - `is_formatting_instruction?: boolean`\n - `job_timeout_extra_time_per_page_in_seconds?: number`\n - `job_timeout_in_seconds?: number`\n - `keep_page_separator_when_merging_tables?: boolean`\n - `languages?: string[]`\n - `layout_aware?: boolean`\n - `line_level_bounding_box?: boolean`\n - `markdown_table_multiline_header_separator?: string`\n - `max_pages?: number`\n - `max_pages_enforced?: number`\n - `merge_tables_across_pages_in_markdown?: boolean`\n - `model?: string`\n - `outlined_table_extraction?: boolean`\n - `output_pdf_of_document?: boolean`\n - `output_s3_path_prefix?: string`\n - `output_s3_region?: string`\n - `output_tables_as_HTML?: boolean`\n - `page_error_tolerance?: number`\n - `page_footer_prefix?: string`\n - `page_footer_suffix?: string`\n - `page_header_prefix?: string`\n - `page_header_suffix?: string`\n - `page_prefix?: string`\n - `page_separator?: string`\n - `page_suffix?: string`\n - `parse_mode?: string`\n Enum for representing the mode of parsing to be used.\n - `parsing_instruction?: string`\n - `precise_bounding_box?: boolean`\n - `premium_mode?: boolean`\n - `presentation_out_of_bounds_content?: boolean`\n - `presentation_skip_embedded_data?: boolean`\n - `preserve_layout_alignment_across_pages?: boolean`\n - `preserve_very_small_text?: boolean`\n - `preset?: string`\n - `priority?: 'critical' | 'high' | 'low' | 'medium'`\n The priority for the request. This field may be ignored or overwritten depending on the organization tier.\n - `project_id?: string`\n - `remove_hidden_text?: boolean`\n - `replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'`\n Enum for representing the different available page error handling modes.\n - `replace_failed_page_with_error_message_prefix?: string`\n - `replace_failed_page_with_error_message_suffix?: string`\n - `save_images?: boolean`\n - `skip_diagonal_text?: boolean`\n - `specialized_chart_parsing_agentic?: boolean`\n - `specialized_chart_parsing_efficient?: boolean`\n - `specialized_chart_parsing_plus?: boolean`\n - `specialized_image_parsing?: boolean`\n - `spreadsheet_extract_sub_tables?: boolean`\n - `spreadsheet_force_formula_computation?: boolean`\n - `spreadsheet_include_hidden_sheets?: boolean`\n - `strict_mode_buggy_font?: boolean`\n - `strict_mode_image_extraction?: boolean`\n - `strict_mode_image_ocr?: boolean`\n - `strict_mode_reconstruction?: boolean`\n - `structured_output?: boolean`\n - `structured_output_json_schema?: string`\n - `structured_output_json_schema_name?: string`\n - `system_prompt?: string`\n - `system_prompt_append?: string`\n - `take_screenshot?: boolean`\n - `target_pages?: string`\n - `tier?: string`\n - `use_vendor_multimodal_model?: boolean`\n - `user_prompt?: string`\n - `vendor_multimodal_api_key?: string`\n - `vendor_multimodal_model_name?: string`\n - `version?: string`\n - `webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]`\n Outbound webhook endpoints to notify on job status changes\n - `webhook_url?: string`\n\n- `managed_pipeline_id?: string`\n The ID of the ManagedPipeline this playground pipeline is linked to.\n\n- `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n Metadata configuration for the pipeline.\n - `excluded_embed_metadata_keys?: string[]`\n List of metadata keys to exclude from embeddings\n - `excluded_llm_metadata_keys?: string[]`\n List of metadata keys to exclude from LLM during retrieval\n\n- `name?: string`\n\n- `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n Schema for the search params for an retrieval execution that can be preset for a pipeline.\n - `alpha?: number`\n Alpha value for hybrid retrieval to determine the weights between dense and sparse retrieval. 0 is sparse retrieval and 1 is dense retrieval.\n - `class_name?: string`\n - `dense_similarity_cutoff?: number`\n Minimum similarity score wrt query for retrieval\n - `dense_similarity_top_k?: number`\n Number of nodes for dense retrieval.\n - `enable_reranking?: boolean`\n Enable reranking for retrieval\n - `files_top_k?: number`\n Number of files to retrieve (only for retrieval mode files_via_metadata and files_via_content).\n - `rerank_top_n?: number`\n Number of reranked nodes for returning.\n - `retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'`\n The retrieval mode for the query.\n - `retrieve_image_nodes?: boolean`\n Whether to retrieve image nodes.\n - `retrieve_page_figure_nodes?: boolean`\n Whether to retrieve page figure nodes.\n - `retrieve_page_screenshot_nodes?: boolean`\n Whether to retrieve page screenshot nodes.\n - `search_filters?: { filters: { key: string; value: number | string | string[] | number[] | number[]; operator?: string; } | { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }[]; condition?: 'and' | 'not' | 'or'; }`\n Metadata filters for vector stores.\n - `search_filters_inference_schema?: object`\n JSON Schema that will be used to infer search_filters. Omit or leave as null to skip inference.\n - `sparse_similarity_top_k?: number`\n Number of nodes for sparse retrieval.\n\n- `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n Configuration for sparse embedding models used in hybrid search.\n\nThis allows users to choose between Splade and BM25 models for\nsparse retrieval in managed data sinks.\n - `class_name?: string`\n - `model_type?: 'auto' | 'bm25' | 'splade'`\n The sparse model type to use. 'bm25' uses Qdrant's FastEmbed BM25 model (default for new pipelines), 'splade' uses HuggingFace Splade model, 'auto' selects based on deployment mode (BYOC uses term frequency, Cloud uses Splade).\n\n- `status?: string`\n Status of the pipeline deployment.\n\n- `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n Configuration for the transformation.\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }; managed_pipeline_id?: string; metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }; sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }; status?: 'CREATED' | 'DELETING'; transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }; updated_at?: string; }`\n Schema for a pipeline.\n\n - `id: string`\n - `embedding_config: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n - `name: string`\n - `project_id: string`\n - `config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }`\n - `created_at?: string`\n - `data_sink?: { id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n - `embedding_model_config?: { id: string; embedding_config: { component?: object; type?: 'AZURE_EMBEDDING'; } | { component?: object; type?: 'BEDROCK_EMBEDDING'; } | { component?: object; type?: 'COHERE_EMBEDDING'; } | { component?: object; type?: 'GEMINI_EMBEDDING'; } | { component?: object; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: object; type?: 'OPENAI_EMBEDDING'; } | { component?: object; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; created_at?: string; updated_at?: string; }`\n - `embedding_model_config_id?: string`\n - `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n - `managed_pipeline_id?: string`\n - `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n - `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n - `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n - `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n - `status?: 'CREATED' | 'DELETING'`\n - `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipeline = await client.pipelines.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(pipeline);\n```",
|
|
2777
|
+
markdown: "## update\n\n`client.pipelines.update(pipeline_id: string, project_id?: string, data_sink?: { component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; }, data_sink_id?: string, embedding_config?: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }, embedding_model_config_id?: string, llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }, managed_pipeline_id?: string, metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }, name?: string, preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }, sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }, status?: string, transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**put** `/api/v1/pipelines/{pipeline_id}`\n\nUpdate an existing pipeline's configuration.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `project_id?: string`\n\n- `data_sink?: { component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; }`\n Schema for creating a data sink.\n - `component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: { distance_method?: 'cosine' | 'hamming' | 'ip' | 'jaccard' | 'l1' | 'l2'; ef_construction?: number; ef_search?: number; m?: number; vector_type?: 'bit' | 'half_vec' | 'sparse_vec' | 'vector'; }; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }`\n Component that implements the data sink\n - `name: string`\n The name of the data sink.\n - `sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'`\n\n- `data_sink_id?: string`\n Data sink ID. When provided instead of data_sink, the data sink will be looked up by ID.\n\n- `embedding_config?: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n\n- `embedding_model_config_id?: string`\n Embedding model config ID. When provided instead of embedding_config, the embedding model config will be looked up by ID.\n\n- `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n Settings that can be configured for how to use LlamaParse to parse files within a LlamaCloud pipeline.\n - `adaptive_long_table?: boolean`\n - `aggressive_table_extraction?: boolean`\n - `annotate_line_numbers?: boolean`\n - `annotate_links?: boolean`\n - `annotate_revisions?: boolean`\n - `auto_mode?: boolean`\n - `auto_mode_configuration_json?: string`\n - `auto_mode_trigger_on_image_in_page?: boolean`\n - `auto_mode_trigger_on_regexp_in_page?: string`\n - `auto_mode_trigger_on_table_in_page?: boolean`\n - `auto_mode_trigger_on_text_in_page?: string`\n - `azure_openai_api_version?: string`\n - `azure_openai_deployment_name?: string`\n - `azure_openai_endpoint?: string`\n - `azure_openai_key?: string`\n - `bbox_bottom?: number`\n - `bbox_left?: number`\n - `bbox_right?: number`\n - `bbox_top?: number`\n - `bounding_box?: string`\n - `compact_markdown_table?: boolean`\n - `complemental_formatting_instruction?: string`\n - `confidence_score_effort?: string`\n - `content_guideline_instruction?: string`\n - `continuous_mode?: boolean`\n - `disable_image_extraction?: boolean`\n - `disable_ocr?: boolean`\n - `disable_reconstruction?: boolean`\n - `do_not_cache?: boolean`\n - `do_not_unroll_columns?: boolean`\n - `enable_cost_optimizer?: boolean`\n - `extract_charts?: boolean`\n - `extract_layout?: boolean`\n - `extract_printed_page_number?: boolean`\n - `fast_mode?: boolean`\n - `formatting_instruction?: string`\n - `gpt4o_api_key?: string`\n - `gpt4o_mode?: boolean`\n - `guess_xlsx_sheet_name?: boolean`\n - `hide_footers?: boolean`\n - `hide_headers?: boolean`\n - `high_res_ocr?: boolean`\n - `html_make_all_elements_visible?: boolean`\n - `html_remove_fixed_elements?: boolean`\n - `html_remove_navigation_elements?: boolean`\n - `http_proxy?: string`\n - `ignore_document_elements_for_layout_detection?: boolean`\n - `images_to_save?: 'embedded' | 'layout' | 'screenshot'[]`\n - `inline_images_in_markdown?: boolean`\n - `input_s3_path?: string`\n - `input_s3_region?: string`\n - `input_url?: string`\n - `internal_is_screenshot_job?: boolean`\n - `invalidate_cache?: boolean`\n - `is_formatting_instruction?: boolean`\n - `job_timeout_extra_time_per_page_in_seconds?: number`\n - `job_timeout_in_seconds?: number`\n - `keep_page_separator_when_merging_tables?: boolean`\n - `languages?: string[]`\n - `layout_aware?: boolean`\n - `line_level_bounding_box?: boolean`\n - `markdown_table_multiline_header_separator?: string`\n - `max_pages?: number`\n - `max_pages_enforced?: number`\n - `merge_tables_across_pages_in_markdown?: boolean`\n - `model?: string`\n - `outlined_table_extraction?: boolean`\n - `output_pdf_of_document?: boolean`\n - `output_s3_path_prefix?: string`\n - `output_s3_region?: string`\n - `output_tables_as_HTML?: boolean`\n - `page_error_tolerance?: number`\n - `page_footer_prefix?: string`\n - `page_footer_suffix?: string`\n - `page_header_prefix?: string`\n - `page_header_suffix?: string`\n - `page_prefix?: string`\n - `page_separator?: string`\n - `page_suffix?: string`\n - `parse_mode?: string`\n Enum for representing the mode of parsing to be used.\n - `parsing_instruction?: string`\n - `precise_bounding_box?: boolean`\n - `premium_mode?: boolean`\n - `presentation_out_of_bounds_content?: boolean`\n - `presentation_skip_embedded_data?: boolean`\n - `preserve_layout_alignment_across_pages?: boolean`\n - `preserve_very_small_text?: boolean`\n - `preset?: string`\n - `priority?: 'critical' | 'high' | 'low' | 'medium'`\n The priority for the request. This field may be ignored or overwritten depending on the organization tier.\n - `project_id?: string`\n - `remove_hidden_text?: boolean`\n - `replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'`\n Enum for representing the different available page error handling modes.\n - `replace_failed_page_with_error_message_prefix?: string`\n - `replace_failed_page_with_error_message_suffix?: string`\n - `save_images?: boolean`\n - `skip_diagonal_text?: boolean`\n - `specialized_chart_parsing_agentic?: boolean`\n - `specialized_chart_parsing_efficient?: boolean`\n - `specialized_chart_parsing_plus?: boolean`\n - `specialized_image_parsing?: boolean`\n - `spreadsheet_extract_sub_tables?: boolean`\n - `spreadsheet_force_formula_computation?: boolean`\n - `spreadsheet_include_hidden_sheets?: boolean`\n - `strict_mode_buggy_font?: boolean`\n - `strict_mode_image_extraction?: boolean`\n - `strict_mode_image_ocr?: boolean`\n - `strict_mode_reconstruction?: boolean`\n - `structured_output?: boolean`\n - `structured_output_json_schema?: string`\n - `structured_output_json_schema_name?: string`\n - `system_prompt?: string`\n - `system_prompt_append?: string`\n - `take_screenshot?: boolean`\n - `target_pages?: string`\n - `tier?: string`\n - `use_vendor_multimodal_model?: boolean`\n - `user_prompt?: string`\n - `vendor_multimodal_api_key?: string`\n - `vendor_multimodal_model_name?: string`\n - `version?: string`\n - `webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]`\n Outbound webhook endpoints to notify on job status changes\n - `webhook_url?: string`\n\n- `managed_pipeline_id?: string`\n The ID of the ManagedPipeline this playground pipeline is linked to.\n\n- `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n Metadata configuration for the pipeline.\n - `excluded_embed_metadata_keys?: string[]`\n List of metadata keys to exclude from embeddings\n - `excluded_llm_metadata_keys?: string[]`\n List of metadata keys to exclude from LLM during retrieval\n\n- `name?: string`\n\n- `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n Schema for the search params for an retrieval execution that can be preset for a pipeline.\n - `alpha?: number`\n Alpha value for hybrid retrieval to determine the weights between dense and sparse retrieval. 0 is sparse retrieval and 1 is dense retrieval.\n - `class_name?: string`\n - `dense_similarity_cutoff?: number`\n Minimum similarity score wrt query for retrieval\n - `dense_similarity_top_k?: number`\n Number of nodes for dense retrieval.\n - `enable_reranking?: boolean`\n Enable reranking for retrieval\n - `files_top_k?: number`\n Number of files to retrieve (only for retrieval mode files_via_metadata and files_via_content).\n - `rerank_top_n?: number`\n Number of reranked nodes for returning.\n - `retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'`\n The retrieval mode for the query.\n - `retrieve_image_nodes?: boolean`\n Whether to retrieve image nodes.\n - `retrieve_page_figure_nodes?: boolean`\n Whether to retrieve page figure nodes.\n - `retrieve_page_screenshot_nodes?: boolean`\n Whether to retrieve page screenshot nodes.\n - `search_filters?: { filters: { key: string; value: number | string | string[] | number[] | number[]; operator?: string; } | { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }[]; condition?: 'and' | 'not' | 'or'; }`\n Metadata filters for vector stores.\n - `search_filters_inference_schema?: object`\n JSON Schema that will be used to infer search_filters. Omit or leave as null to skip inference.\n - `sparse_similarity_top_k?: number`\n Number of nodes for sparse retrieval.\n\n- `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n Configuration for sparse embedding models used in hybrid search.\n\nThis allows users to choose between Splade and BM25 models for\nsparse retrieval in managed data sinks.\n - `class_name?: string`\n - `model_type?: 'auto' | 'bm25' | 'splade'`\n The sparse model type to use. 'bm25' uses Qdrant's FastEmbed BM25 model (default for new pipelines), 'splade' uses HuggingFace Splade model, 'auto' selects based on deployment mode (BYOC uses term frequency, Cloud uses Splade).\n\n- `status?: string`\n Status of the pipeline deployment.\n\n- `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n Configuration for the transformation.\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }; managed_pipeline_id?: string; metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }; sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }; status?: 'CREATED' | 'DELETING'; transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }; updated_at?: string; }`\n Schema for a pipeline.\n\n - `id: string`\n - `embedding_config: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n - `name: string`\n - `project_id: string`\n - `config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }`\n - `created_at?: string`\n - `data_sink?: { id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n - `embedding_model_config?: { id: string; embedding_config: { component?: object; type?: 'AZURE_EMBEDDING'; } | { component?: object; type?: 'BEDROCK_EMBEDDING'; } | { component?: object; type?: 'COHERE_EMBEDDING'; } | { component?: object; type?: 'GEMINI_EMBEDDING'; } | { component?: object; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: object; type?: 'OPENAI_EMBEDDING'; } | { component?: object; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; created_at?: string; updated_at?: string; }`\n - `embedding_model_config_id?: string`\n - `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n - `managed_pipeline_id?: string`\n - `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n - `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n - `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n - `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n - `status?: 'CREATED' | 'DELETING'`\n - `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipeline = await client.pipelines.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(pipeline);\n```",
|
|
2863
2778
|
perLanguage: {
|
|
2864
2779
|
go: {
|
|
2865
2780
|
method: 'client.Pipelines.Update',
|
|
@@ -2898,16 +2813,16 @@ const EMBEDDED_METHODS = [
|
|
|
2898
2813
|
description: 'Delete a pipeline and all associated resources.\n\nRemoves pipeline files, data sources, and vector store data.\nThis operation is irreversible.',
|
|
2899
2814
|
stainlessPath: '(resource) pipelines > (method) delete',
|
|
2900
2815
|
qualified: 'client.pipelines.delete',
|
|
2901
|
-
params: ['pipeline_id: string;'],
|
|
2902
|
-
markdown: "## delete\n\n`client.pipelines.delete(pipeline_id: string): void`\n\n**delete** `/api/v1/pipelines/{pipeline_id}`\n\nDelete a pipeline and all associated resources.\n\nRemoves pipeline files, data sources, and vector store data.\nThis operation is irreversible.\n\n### Parameters\n\n- `pipeline_id: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nawait client.pipelines.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e')\n```",
|
|
2816
|
+
params: ['pipeline_id: string;', 'project_id?: string;'],
|
|
2817
|
+
markdown: "## delete\n\n`client.pipelines.delete(pipeline_id: string, project_id?: string): void`\n\n**delete** `/api/v1/pipelines/{pipeline_id}`\n\nDelete a pipeline and all associated resources.\n\nRemoves pipeline files, data sources, and vector store data.\nThis operation is irreversible.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `project_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nawait client.pipelines.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e')\n```",
|
|
2903
2818
|
perLanguage: {
|
|
2904
2819
|
go: {
|
|
2905
2820
|
method: 'client.Pipelines.Delete',
|
|
2906
|
-
example: 'package main\n\nimport (\n\t"context"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\terr := client.Pipelines.Delete(
|
|
2821
|
+
example: 'package main\n\nimport (\n\t"context"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\terr := client.Pipelines.Delete(\n\t\tcontext.TODO(),\n\t\t"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n\t\tllamacloud.PipelineDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n',
|
|
2907
2822
|
},
|
|
2908
2823
|
python: {
|
|
2909
2824
|
method: 'pipelines.delete',
|
|
2910
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nclient.pipelines.delete(\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)',
|
|
2825
|
+
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nclient.pipelines.delete(\n pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)',
|
|
2911
2826
|
},
|
|
2912
2827
|
java: {
|
|
2913
2828
|
method: 'pipelines().delete',
|
|
@@ -2938,9 +2853,9 @@ const EMBEDDED_METHODS = [
|
|
|
2938
2853
|
description: 'Get the ingestion status of a managed pipeline.\n\nReturns document counts, sync progress, and the last\neffective timestamp. Only available for managed pipelines.',
|
|
2939
2854
|
stainlessPath: '(resource) pipelines > (method) get_status',
|
|
2940
2855
|
qualified: 'client.pipelines.getStatus',
|
|
2941
|
-
params: ['pipeline_id: string;', 'full_details?: boolean;'],
|
|
2856
|
+
params: ['pipeline_id: string;', 'full_details?: boolean;', 'project_id?: string;'],
|
|
2942
2857
|
response: "{ status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: { job_id: string; message: string; step: string; }[]; job_id?: string; }",
|
|
2943
|
-
markdown: "## get_status\n\n`client.pipelines.getStatus(pipeline_id: string, full_details?: boolean): { status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: object[]; job_id?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/status`\n\nGet the ingestion status of a managed pipeline.\n\nReturns document counts, sync progress, and the last\neffective timestamp. Only available for managed pipelines.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `full_details?: boolean`\n\n### Returns\n\n- `{ status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: { job_id: string; message: string; step: string; }[]; job_id?: string; }`\n\n - `status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'`\n - `deployment_date?: string`\n - `effective_at?: string`\n - `error?: { job_id: string; message: string; step: string; }[]`\n - `job_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst managedIngestionStatusResponse = await client.pipelines.getStatus('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(managedIngestionStatusResponse);\n```",
|
|
2858
|
+
markdown: "## get_status\n\n`client.pipelines.getStatus(pipeline_id: string, full_details?: boolean, project_id?: string): { status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: object[]; job_id?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/status`\n\nGet the ingestion status of a managed pipeline.\n\nReturns document counts, sync progress, and the last\neffective timestamp. Only available for managed pipelines.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `full_details?: boolean`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: { job_id: string; message: string; step: string; }[]; job_id?: string; }`\n\n - `status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'`\n - `deployment_date?: string`\n - `effective_at?: string`\n - `error?: { job_id: string; message: string; step: string; }[]`\n - `job_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst managedIngestionStatusResponse = await client.pipelines.getStatus('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(managedIngestionStatusResponse);\n```",
|
|
2944
2859
|
perLanguage: {
|
|
2945
2860
|
go: {
|
|
2946
2861
|
method: 'client.Pipelines.GetStatus',
|
|
@@ -3055,17 +2970,17 @@ const EMBEDDED_METHODS = [
|
|
|
3055
2970
|
description: 'Trigger an incremental sync for a managed pipeline.\n\nProcesses new and updated documents from data sources and\nfiles, then updates the index for retrieval.',
|
|
3056
2971
|
stainlessPath: '(resource) pipelines.sync > (method) create',
|
|
3057
2972
|
qualified: 'client.pipelines.sync.create',
|
|
3058
|
-
params: ['pipeline_id: string;'],
|
|
2973
|
+
params: ['pipeline_id: string;', 'project_id?: string;'],
|
|
3059
2974
|
response: "{ id: string; embedding_config: object | object | object | object | object | { component?: object; type?: 'MANAGED_OPENAI_EMBEDDING'; } | object | object; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: object; embedding_model_config?: { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: object; managed_pipeline_id?: string; metadata_config?: object; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: object; sparse_model_config?: object; status?: 'CREATED' | 'DELETING'; transform_config?: object | object; updated_at?: string; }",
|
|
3060
|
-
markdown: "## create\n\n`client.pipelines.sync.create(pipeline_id: string): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**post** `/api/v1/pipelines/{pipeline_id}/sync`\n\nTrigger an incremental sync for a managed pipeline.\n\nProcesses new and updated documents from data sources and\nfiles, then updates the index for retrieval.\n\n### Parameters\n\n- `pipeline_id: string`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }; managed_pipeline_id?: string; metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }; sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }; status?: 'CREATED' | 'DELETING'; transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }; updated_at?: string; }`\n Schema for a pipeline.\n\n - `id: string`\n - `embedding_config: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n - `name: string`\n - `project_id: string`\n - `config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }`\n - `created_at?: string`\n - `data_sink?: { id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n - `embedding_model_config?: { id: string; embedding_config: { component?: object; type?: 'AZURE_EMBEDDING'; } | { component?: object; type?: 'BEDROCK_EMBEDDING'; } | { component?: object; type?: 'COHERE_EMBEDDING'; } | { component?: object; type?: 'GEMINI_EMBEDDING'; } | { component?: object; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: object; type?: 'OPENAI_EMBEDDING'; } | { component?: object; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; created_at?: string; updated_at?: string; }`\n - `embedding_model_config_id?: string`\n - `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n - `managed_pipeline_id?: string`\n - `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n - `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n - `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n - `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n - `status?: 'CREATED' | 'DELETING'`\n - `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipeline = await client.pipelines.sync.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(pipeline);\n```",
|
|
2975
|
+
markdown: "## create\n\n`client.pipelines.sync.create(pipeline_id: string, project_id?: string): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**post** `/api/v1/pipelines/{pipeline_id}/sync`\n\nTrigger an incremental sync for a managed pipeline.\n\nProcesses new and updated documents from data sources and\nfiles, then updates the index for retrieval.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }; managed_pipeline_id?: string; metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }; sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }; status?: 'CREATED' | 'DELETING'; transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }; updated_at?: string; }`\n Schema for a pipeline.\n\n - `id: string`\n - `embedding_config: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n - `name: string`\n - `project_id: string`\n - `config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }`\n - `created_at?: string`\n - `data_sink?: { id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n - `embedding_model_config?: { id: string; embedding_config: { component?: object; type?: 'AZURE_EMBEDDING'; } | { component?: object; type?: 'BEDROCK_EMBEDDING'; } | { component?: object; type?: 'COHERE_EMBEDDING'; } | { component?: object; type?: 'GEMINI_EMBEDDING'; } | { component?: object; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: object; type?: 'OPENAI_EMBEDDING'; } | { component?: object; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; created_at?: string; updated_at?: string; }`\n - `embedding_model_config_id?: string`\n - `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n - `managed_pipeline_id?: string`\n - `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n - `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n - `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n - `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n - `status?: 'CREATED' | 'DELETING'`\n - `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipeline = await client.pipelines.sync.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(pipeline);\n```",
|
|
3061
2976
|
perLanguage: {
|
|
3062
2977
|
go: {
|
|
3063
2978
|
method: 'client.Pipelines.Sync.New',
|
|
3064
|
-
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpipeline, err := client.Pipelines.Sync.New(
|
|
2979
|
+
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpipeline, err := client.Pipelines.Sync.New(\n\t\tcontext.TODO(),\n\t\t"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n\t\tllamacloud.PipelineSyncNewParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipeline.ID)\n}\n',
|
|
3065
2980
|
},
|
|
3066
2981
|
python: {
|
|
3067
2982
|
method: 'pipelines.sync.create',
|
|
3068
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\npipeline = client.pipelines.sync.create(\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(pipeline.id)',
|
|
2983
|
+
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\npipeline = client.pipelines.sync.create(\n pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(pipeline.id)',
|
|
3069
2984
|
},
|
|
3070
2985
|
java: {
|
|
3071
2986
|
method: 'pipelines().sync().create',
|
|
@@ -3096,17 +3011,17 @@ const EMBEDDED_METHODS = [
|
|
|
3096
3011
|
description: 'Cancel all running sync jobs for a pipeline.',
|
|
3097
3012
|
stainlessPath: '(resource) pipelines.sync > (method) cancel',
|
|
3098
3013
|
qualified: 'client.pipelines.sync.cancel',
|
|
3099
|
-
params: ['pipeline_id: string;'],
|
|
3014
|
+
params: ['pipeline_id: string;', 'project_id?: string;'],
|
|
3100
3015
|
response: "{ id: string; embedding_config: object | object | object | object | object | { component?: object; type?: 'MANAGED_OPENAI_EMBEDDING'; } | object | object; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: object; embedding_model_config?: { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: object; managed_pipeline_id?: string; metadata_config?: object; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: object; sparse_model_config?: object; status?: 'CREATED' | 'DELETING'; transform_config?: object | object; updated_at?: string; }",
|
|
3101
|
-
markdown: "## cancel\n\n`client.pipelines.sync.cancel(pipeline_id: string): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**post** `/api/v1/pipelines/{pipeline_id}/sync/cancel`\n\nCancel all running sync jobs for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }; managed_pipeline_id?: string; metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }; sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }; status?: 'CREATED' | 'DELETING'; transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }; updated_at?: string; }`\n Schema for a pipeline.\n\n - `id: string`\n - `embedding_config: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n - `name: string`\n - `project_id: string`\n - `config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }`\n - `created_at?: string`\n - `data_sink?: { id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n - `embedding_model_config?: { id: string; embedding_config: { component?: object; type?: 'AZURE_EMBEDDING'; } | { component?: object; type?: 'BEDROCK_EMBEDDING'; } | { component?: object; type?: 'COHERE_EMBEDDING'; } | { component?: object; type?: 'GEMINI_EMBEDDING'; } | { component?: object; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: object; type?: 'OPENAI_EMBEDDING'; } | { component?: object; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; created_at?: string; updated_at?: string; }`\n - `embedding_model_config_id?: string`\n - `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n - `managed_pipeline_id?: string`\n - `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n - `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n - `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n - `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n - `status?: 'CREATED' | 'DELETING'`\n - `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipeline = await client.pipelines.sync.cancel('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(pipeline);\n```",
|
|
3016
|
+
markdown: "## cancel\n\n`client.pipelines.sync.cancel(pipeline_id: string, project_id?: string): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**post** `/api/v1/pipelines/{pipeline_id}/sync/cancel`\n\nCancel all running sync jobs for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }; managed_pipeline_id?: string; metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }; sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }; status?: 'CREATED' | 'DELETING'; transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }; updated_at?: string; }`\n Schema for a pipeline.\n\n - `id: string`\n - `embedding_config: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n - `name: string`\n - `project_id: string`\n - `config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }`\n - `created_at?: string`\n - `data_sink?: { id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n - `embedding_model_config?: { id: string; embedding_config: { component?: object; type?: 'AZURE_EMBEDDING'; } | { component?: object; type?: 'BEDROCK_EMBEDDING'; } | { component?: object; type?: 'COHERE_EMBEDDING'; } | { component?: object; type?: 'GEMINI_EMBEDDING'; } | { component?: object; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: object; type?: 'OPENAI_EMBEDDING'; } | { component?: object; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; created_at?: string; updated_at?: string; }`\n - `embedding_model_config_id?: string`\n - `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n - `managed_pipeline_id?: string`\n - `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n - `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n - `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n - `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n - `status?: 'CREATED' | 'DELETING'`\n - `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipeline = await client.pipelines.sync.cancel('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(pipeline);\n```",
|
|
3102
3017
|
perLanguage: {
|
|
3103
3018
|
go: {
|
|
3104
3019
|
method: 'client.Pipelines.Sync.Cancel',
|
|
3105
|
-
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpipeline, err := client.Pipelines.Sync.Cancel(
|
|
3020
|
+
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpipeline, err := client.Pipelines.Sync.Cancel(\n\t\tcontext.TODO(),\n\t\t"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n\t\tllamacloud.PipelineSyncCancelParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipeline.ID)\n}\n',
|
|
3106
3021
|
},
|
|
3107
3022
|
python: {
|
|
3108
3023
|
method: 'pipelines.sync.cancel',
|
|
3109
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\npipeline = client.pipelines.sync.cancel(\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(pipeline.id)',
|
|
3024
|
+
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\npipeline = client.pipelines.sync.cancel(\n pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(pipeline.id)',
|
|
3110
3025
|
},
|
|
3111
3026
|
java: {
|
|
3112
3027
|
method: 'pipelines().sync().cancel',
|
|
@@ -3137,17 +3052,17 @@ const EMBEDDED_METHODS = [
|
|
|
3137
3052
|
description: 'Get data sources for a pipeline.',
|
|
3138
3053
|
stainlessPath: '(resource) pipelines.data_sources > (method) get_data_sources',
|
|
3139
3054
|
qualified: 'client.pipelines.dataSources.getDataSources',
|
|
3140
|
-
params: ['pipeline_id: string;'],
|
|
3055
|
+
params: ['pipeline_id: string;', 'project_id?: string;'],
|
|
3141
3056
|
response: "{ id: string; component: object | object | object | object | object | object | object | object | object | object | object | object; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: object; }[]",
|
|
3142
|
-
markdown: "## get_data_sources\n\n`client.pipelines.dataSources.getDataSources(pipeline_id: string): object[]`\n\n**get** `/api/v1/pipelines/{pipeline_id}/data-sources`\n\nGet data sources for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n### Returns\n\n- `{ id: string; component: object | object | object | object | object | object | object | object | object | object | object | object; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: object; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipelineDataSources = await client.pipelines.dataSources.getDataSources('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(pipelineDataSources);\n```",
|
|
3057
|
+
markdown: "## get_data_sources\n\n`client.pipelines.dataSources.getDataSources(pipeline_id: string, project_id?: string): object[]`\n\n**get** `/api/v1/pipelines/{pipeline_id}/data-sources`\n\nGet data sources for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; component: object | object | object | object | object | object | object | object | object | object | object | object; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: object; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipelineDataSources = await client.pipelines.dataSources.getDataSources('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(pipelineDataSources);\n```",
|
|
3143
3058
|
perLanguage: {
|
|
3144
3059
|
go: {
|
|
3145
3060
|
method: 'client.Pipelines.DataSources.GetDataSources',
|
|
3146
|
-
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpipelineDataSources, err := client.Pipelines.DataSources.GetDataSources(
|
|
3061
|
+
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpipelineDataSources, err := client.Pipelines.DataSources.GetDataSources(\n\t\tcontext.TODO(),\n\t\t"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n\t\tllamacloud.PipelineDataSourceGetDataSourcesParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipelineDataSources)\n}\n',
|
|
3147
3062
|
},
|
|
3148
3063
|
python: {
|
|
3149
3064
|
method: 'pipelines.data_sources.get_data_sources',
|
|
3150
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\npipeline_data_sources = client.pipelines.data_sources.get_data_sources(\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(pipeline_data_sources)',
|
|
3065
|
+
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\npipeline_data_sources = client.pipelines.data_sources.get_data_sources(\n pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(pipeline_data_sources)',
|
|
3151
3066
|
},
|
|
3152
3067
|
java: {
|
|
3153
3068
|
method: 'pipelines().dataSources().getDataSources',
|
|
@@ -3178,9 +3093,13 @@ const EMBEDDED_METHODS = [
|
|
|
3178
3093
|
description: 'Add data sources to a pipeline.',
|
|
3179
3094
|
stainlessPath: '(resource) pipelines.data_sources > (method) update_data_sources',
|
|
3180
3095
|
qualified: 'client.pipelines.dataSources.updateDataSources',
|
|
3181
|
-
params: [
|
|
3096
|
+
params: [
|
|
3097
|
+
'pipeline_id: string;',
|
|
3098
|
+
'body: { data_source_id: string; sync_interval?: number; }[];',
|
|
3099
|
+
'project_id?: string;',
|
|
3100
|
+
],
|
|
3182
3101
|
response: "{ id: string; component: object | object | object | object | object | object | object | object | object | object | object | object; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: object; }[]",
|
|
3183
|
-
markdown: "## update_data_sources\n\n`client.pipelines.dataSources.updateDataSources(pipeline_id: string, body: { data_source_id: string; sync_interval?: number; }[]): object[]`\n\n**put** `/api/v1/pipelines/{pipeline_id}/data-sources`\n\nAdd data sources to a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `body: { data_source_id: string; sync_interval?: number; }[]`\n\n### Returns\n\n- `{ id: string; component: object | object | object | object | object | object | object | object | object | object | object | object; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: object; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipelineDataSources = await client.pipelines.dataSources.updateDataSources('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { body: [{ data_source_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }] });\n\nconsole.log(pipelineDataSources);\n```",
|
|
3102
|
+
markdown: "## update_data_sources\n\n`client.pipelines.dataSources.updateDataSources(pipeline_id: string, body: { data_source_id: string; sync_interval?: number; }[], project_id?: string): object[]`\n\n**put** `/api/v1/pipelines/{pipeline_id}/data-sources`\n\nAdd data sources to a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `body: { data_source_id: string; sync_interval?: number; }[]`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; component: object | object | object | object | object | object | object | object | object | object | object | object; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: object; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipelineDataSources = await client.pipelines.dataSources.updateDataSources('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { body: [{ data_source_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }] });\n\nconsole.log(pipelineDataSources);\n```",
|
|
3184
3103
|
perLanguage: {
|
|
3185
3104
|
go: {
|
|
3186
3105
|
method: 'client.Pipelines.DataSources.UpdateDataSources',
|
|
@@ -3219,9 +3138,14 @@ const EMBEDDED_METHODS = [
|
|
|
3219
3138
|
description: 'Update the configuration of a data source in a pipeline.',
|
|
3220
3139
|
stainlessPath: '(resource) pipelines.data_sources > (method) update',
|
|
3221
3140
|
qualified: 'client.pipelines.dataSources.update',
|
|
3222
|
-
params: [
|
|
3141
|
+
params: [
|
|
3142
|
+
'pipeline_id: string;',
|
|
3143
|
+
'data_source_id: string;',
|
|
3144
|
+
'project_id?: string;',
|
|
3145
|
+
'sync_interval?: number;',
|
|
3146
|
+
],
|
|
3223
3147
|
response: "{ id: string; component: object | object | object | object | object | object | object | object | object | object | object | object; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: object; }",
|
|
3224
|
-
markdown: "## update\n\n`client.pipelines.dataSources.update(pipeline_id: string, data_source_id: string, sync_interval?: number): { id: string; component: object | cloud_s3_data_source | cloud_az_storage_blob_data_source | cloud_google_drive_data_source | cloud_one_drive_data_source | cloud_sharepoint_data_source | cloud_slack_data_source | cloud_notion_page_data_source | cloud_confluence_data_source | cloud_jira_data_source | cloud_jira_data_source_v2 | cloud_box_data_source; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: data_source_reader_version_metadata; }`\n\n**put** `/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}`\n\nUpdate the configuration of a data source in a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id: string`\n\n- `sync_interval?: number`\n The interval at which the data source should be synced.\n\n### Returns\n\n- `{ id: string; component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }; }`\n Schema for a data source in a pipeline.\n\n - `id: string`\n - `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n - `data_source_id: string`\n - `last_synced_at: string`\n - `name: string`\n - `pipeline_id: string`\n - `project_id: string`\n - `source_type: string`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'`\n - `status_updated_at?: string`\n - `sync_interval?: number`\n - `sync_schedule_set_by?: string`\n - `updated_at?: string`\n - `version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipelineDataSource = await client.pipelines.dataSources.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(pipelineDataSource);\n```",
|
|
3148
|
+
markdown: "## update\n\n`client.pipelines.dataSources.update(pipeline_id: string, data_source_id: string, project_id?: string, sync_interval?: number): { id: string; component: object | cloud_s3_data_source | cloud_az_storage_blob_data_source | cloud_google_drive_data_source | cloud_one_drive_data_source | cloud_sharepoint_data_source | cloud_slack_data_source | cloud_notion_page_data_source | cloud_confluence_data_source | cloud_jira_data_source | cloud_jira_data_source_v2 | cloud_box_data_source; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: data_source_reader_version_metadata; }`\n\n**put** `/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}`\n\nUpdate the configuration of a data source in a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id: string`\n\n- `project_id?: string`\n\n- `sync_interval?: number`\n The interval at which the data source should be synced.\n\n### Returns\n\n- `{ id: string; component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }; }`\n Schema for a data source in a pipeline.\n\n - `id: string`\n - `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n - `data_source_id: string`\n - `last_synced_at: string`\n - `name: string`\n - `pipeline_id: string`\n - `project_id: string`\n - `source_type: string`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'`\n - `status_updated_at?: string`\n - `sync_interval?: number`\n - `sync_schedule_set_by?: string`\n - `updated_at?: string`\n - `version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipelineDataSource = await client.pipelines.dataSources.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(pipelineDataSource);\n```",
|
|
3225
3149
|
perLanguage: {
|
|
3226
3150
|
go: {
|
|
3227
3151
|
method: 'client.Pipelines.DataSources.Update',
|
|
@@ -3260,9 +3184,9 @@ const EMBEDDED_METHODS = [
|
|
|
3260
3184
|
description: 'Get the status of a data source for a pipeline.',
|
|
3261
3185
|
stainlessPath: '(resource) pipelines.data_sources > (method) get_status',
|
|
3262
3186
|
qualified: 'client.pipelines.dataSources.getStatus',
|
|
3263
|
-
params: ['pipeline_id: string;', 'data_source_id: string;'],
|
|
3187
|
+
params: ['pipeline_id: string;', 'data_source_id: string;', 'project_id?: string;'],
|
|
3264
3188
|
response: "{ status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: { job_id: string; message: string; step: string; }[]; job_id?: string; }",
|
|
3265
|
-
markdown: "## get_status\n\n`client.pipelines.dataSources.getStatus(pipeline_id: string, data_source_id: string): { status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: object[]; job_id?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/status`\n\nGet the status of a data source for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id: string`\n\n### Returns\n\n- `{ status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: { job_id: string; message: string; step: string; }[]; job_id?: string; }`\n\n - `status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'`\n - `deployment_date?: string`\n - `effective_at?: string`\n - `error?: { job_id: string; message: string; step: string; }[]`\n - `job_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst managedIngestionStatusResponse = await client.pipelines.dataSources.getStatus('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(managedIngestionStatusResponse);\n```",
|
|
3189
|
+
markdown: "## get_status\n\n`client.pipelines.dataSources.getStatus(pipeline_id: string, data_source_id: string, project_id?: string): { status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: object[]; job_id?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/status`\n\nGet the status of a data source for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: { job_id: string; message: string; step: string; }[]; job_id?: string; }`\n\n - `status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'`\n - `deployment_date?: string`\n - `effective_at?: string`\n - `error?: { job_id: string; message: string; step: string; }[]`\n - `job_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst managedIngestionStatusResponse = await client.pipelines.dataSources.getStatus('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(managedIngestionStatusResponse);\n```",
|
|
3266
3190
|
perLanguage: {
|
|
3267
3191
|
go: {
|
|
3268
3192
|
method: 'client.Pipelines.DataSources.GetStatus',
|
|
@@ -3301,9 +3225,14 @@ const EMBEDDED_METHODS = [
|
|
|
3301
3225
|
description: 'Run incremental ingestion: pull upstream changes from the data source into the data sink.',
|
|
3302
3226
|
stainlessPath: '(resource) pipelines.data_sources > (method) sync',
|
|
3303
3227
|
qualified: 'client.pipelines.dataSources.sync',
|
|
3304
|
-
params: [
|
|
3228
|
+
params: [
|
|
3229
|
+
'pipeline_id: string;',
|
|
3230
|
+
'data_source_id: string;',
|
|
3231
|
+
'project_id?: string;',
|
|
3232
|
+
'pipeline_file_ids?: string[];',
|
|
3233
|
+
],
|
|
3305
3234
|
response: "{ id: string; embedding_config: object | object | object | object | object | { component?: object; type?: 'MANAGED_OPENAI_EMBEDDING'; } | object | object; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: object; embedding_model_config?: { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: object; managed_pipeline_id?: string; metadata_config?: object; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: object; sparse_model_config?: object; status?: 'CREATED' | 'DELETING'; transform_config?: object | object; updated_at?: string; }",
|
|
3306
|
-
markdown: "## sync\n\n`client.pipelines.dataSources.sync(pipeline_id: string, data_source_id: string, pipeline_file_ids?: string[]): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**post** `/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/sync`\n\nRun incremental ingestion: pull upstream changes from the data source into the data sink.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id: string`\n\n- `pipeline_file_ids?: string[]`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }; managed_pipeline_id?: string; metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }; sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }; status?: 'CREATED' | 'DELETING'; transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }; updated_at?: string; }`\n Schema for a pipeline.\n\n - `id: string`\n - `embedding_config: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n - `name: string`\n - `project_id: string`\n - `config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }`\n - `created_at?: string`\n - `data_sink?: { id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n - `embedding_model_config?: { id: string; embedding_config: { component?: object; type?: 'AZURE_EMBEDDING'; } | { component?: object; type?: 'BEDROCK_EMBEDDING'; } | { component?: object; type?: 'COHERE_EMBEDDING'; } | { component?: object; type?: 'GEMINI_EMBEDDING'; } | { component?: object; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: object; type?: 'OPENAI_EMBEDDING'; } | { component?: object; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; created_at?: string; updated_at?: string; }`\n - `embedding_model_config_id?: string`\n - `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n - `managed_pipeline_id?: string`\n - `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n - `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n - `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n - `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n - `status?: 'CREATED' | 'DELETING'`\n - `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipeline = await client.pipelines.dataSources.sync('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(pipeline);\n```",
|
|
3235
|
+
markdown: "## sync\n\n`client.pipelines.dataSources.sync(pipeline_id: string, data_source_id: string, project_id?: string, pipeline_file_ids?: string[]): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**post** `/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/sync`\n\nRun incremental ingestion: pull upstream changes from the data source into the data sink.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id: string`\n\n- `project_id?: string`\n\n- `pipeline_file_ids?: string[]`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }; managed_pipeline_id?: string; metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }; sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }; status?: 'CREATED' | 'DELETING'; transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }; updated_at?: string; }`\n Schema for a pipeline.\n\n - `id: string`\n - `embedding_config: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n - `name: string`\n - `project_id: string`\n - `config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }`\n - `created_at?: string`\n - `data_sink?: { id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n - `embedding_model_config?: { id: string; embedding_config: { component?: object; type?: 'AZURE_EMBEDDING'; } | { component?: object; type?: 'BEDROCK_EMBEDDING'; } | { component?: object; type?: 'COHERE_EMBEDDING'; } | { component?: object; type?: 'GEMINI_EMBEDDING'; } | { component?: object; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: object; type?: 'OPENAI_EMBEDDING'; } | { component?: object; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; created_at?: string; updated_at?: string; }`\n - `embedding_model_config_id?: string`\n - `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n - `managed_pipeline_id?: string`\n - `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n - `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n - `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n - `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n - `status?: 'CREATED' | 'DELETING'`\n - `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipeline = await client.pipelines.dataSources.sync('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(pipeline);\n```",
|
|
3307
3236
|
perLanguage: {
|
|
3308
3237
|
go: {
|
|
3309
3238
|
method: 'client.Pipelines.DataSources.Sync',
|
|
@@ -3512,9 +3441,14 @@ const EMBEDDED_METHODS = [
|
|
|
3512
3441
|
description: 'Get files for a pipeline.',
|
|
3513
3442
|
stainlessPath: '(resource) pipelines.files > (method) get_status_counts',
|
|
3514
3443
|
qualified: 'client.pipelines.files.getStatusCounts',
|
|
3515
|
-
params: [
|
|
3444
|
+
params: [
|
|
3445
|
+
'pipeline_id: string;',
|
|
3446
|
+
'data_source_id?: string;',
|
|
3447
|
+
'only_manually_uploaded?: boolean;',
|
|
3448
|
+
'project_id?: string;',
|
|
3449
|
+
],
|
|
3516
3450
|
response: '{ counts: object; total_count: number; data_source_id?: string; only_manually_uploaded?: boolean; pipeline_id?: string; }',
|
|
3517
|
-
markdown: "## get_status_counts\n\n`client.pipelines.files.getStatusCounts(pipeline_id: string, data_source_id?: string, only_manually_uploaded?: boolean): { counts: object; total_count: number; data_source_id?: string; only_manually_uploaded?: boolean; pipeline_id?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/files/status-counts`\n\nGet files for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id?: string`\n\n- `only_manually_uploaded?: boolean`\n\n### Returns\n\n- `{ counts: object; total_count: number; data_source_id?: string; only_manually_uploaded?: boolean; pipeline_id?: string; }`\n\n - `counts: object`\n - `total_count: number`\n - `data_source_id?: string`\n - `only_manually_uploaded?: boolean`\n - `pipeline_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst response = await client.pipelines.files.getStatusCounts('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(response);\n```",
|
|
3451
|
+
markdown: "## get_status_counts\n\n`client.pipelines.files.getStatusCounts(pipeline_id: string, data_source_id?: string, only_manually_uploaded?: boolean, project_id?: string): { counts: object; total_count: number; data_source_id?: string; only_manually_uploaded?: boolean; pipeline_id?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/files/status-counts`\n\nGet files for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id?: string`\n\n- `only_manually_uploaded?: boolean`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ counts: object; total_count: number; data_source_id?: string; only_manually_uploaded?: boolean; pipeline_id?: string; }`\n\n - `counts: object`\n - `total_count: number`\n - `data_source_id?: string`\n - `only_manually_uploaded?: boolean`\n - `pipeline_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst response = await client.pipelines.files.getStatusCounts('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(response);\n```",
|
|
3518
3452
|
perLanguage: {
|
|
3519
3453
|
go: {
|
|
3520
3454
|
method: 'client.Pipelines.Files.GetStatusCounts',
|
|
@@ -3553,9 +3487,9 @@ const EMBEDDED_METHODS = [
|
|
|
3553
3487
|
description: 'Get status of a file for a pipeline.',
|
|
3554
3488
|
stainlessPath: '(resource) pipelines.files > (method) get_status',
|
|
3555
3489
|
qualified: 'client.pipelines.files.getStatus',
|
|
3556
|
-
params: ['pipeline_id: string;', 'file_id: string;'],
|
|
3490
|
+
params: ['pipeline_id: string;', 'file_id: string;', 'project_id?: string;'],
|
|
3557
3491
|
response: "{ status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: { job_id: string; message: string; step: string; }[]; job_id?: string; }",
|
|
3558
|
-
markdown: "## get_status\n\n`client.pipelines.files.getStatus(pipeline_id: string, file_id: string): { status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: object[]; job_id?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/files/{file_id}/status`\n\nGet status of a file for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `file_id: string`\n\n### Returns\n\n- `{ status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: { job_id: string; message: string; step: string; }[]; job_id?: string; }`\n\n - `status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'`\n - `deployment_date?: string`\n - `effective_at?: string`\n - `error?: { job_id: string; message: string; step: string; }[]`\n - `job_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst managedIngestionStatusResponse = await client.pipelines.files.getStatus('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(managedIngestionStatusResponse);\n```",
|
|
3492
|
+
markdown: "## get_status\n\n`client.pipelines.files.getStatus(pipeline_id: string, file_id: string, project_id?: string): { status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: object[]; job_id?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/files/{file_id}/status`\n\nGet status of a file for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `file_id: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: { job_id: string; message: string; step: string; }[]; job_id?: string; }`\n\n - `status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'`\n - `deployment_date?: string`\n - `effective_at?: string`\n - `error?: { job_id: string; message: string; step: string; }[]`\n - `job_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst managedIngestionStatusResponse = await client.pipelines.files.getStatus('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(managedIngestionStatusResponse);\n```",
|
|
3559
3493
|
perLanguage: {
|
|
3560
3494
|
go: {
|
|
3561
3495
|
method: 'client.Pipelines.Files.GetStatus',
|
|
@@ -3594,9 +3528,13 @@ const EMBEDDED_METHODS = [
|
|
|
3594
3528
|
description: 'Add files to a pipeline.',
|
|
3595
3529
|
stainlessPath: '(resource) pipelines.files > (method) create',
|
|
3596
3530
|
qualified: 'client.pipelines.files.create',
|
|
3597
|
-
params: [
|
|
3531
|
+
params: [
|
|
3532
|
+
'pipeline_id: string;',
|
|
3533
|
+
'body: { file_id: string; custom_metadata?: object; }[];',
|
|
3534
|
+
'project_id?: string;',
|
|
3535
|
+
],
|
|
3598
3536
|
response: "{ id: string; pipeline_id: string; config_hash?: object; created_at?: string; custom_metadata?: object; data_source_id?: string; external_file_id?: string; file_id?: string; file_size?: number; file_type?: string; indexed_page_count?: number; last_modified_at?: string; name?: string; permission_info?: object; project_id?: string; resource_info?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; updated_at?: string; }[]",
|
|
3599
|
-
markdown: "## create\n\n`client.pipelines.files.create(pipeline_id: string, body: { file_id: string; custom_metadata?: object; }[]): object[]`\n\n**put** `/api/v1/pipelines/{pipeline_id}/files`\n\nAdd files to a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `body: { file_id: string; custom_metadata?: object; }[]`\n\n### Returns\n\n- `{ id: string; pipeline_id: string; config_hash?: object; created_at?: string; custom_metadata?: object; data_source_id?: string; external_file_id?: string; file_id?: string; file_size?: number; file_type?: string; indexed_page_count?: number; last_modified_at?: string; name?: string; permission_info?: object; project_id?: string; resource_info?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; updated_at?: string; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipelineFiles = await client.pipelines.files.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { body: [{ file_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }] });\n\nconsole.log(pipelineFiles);\n```",
|
|
3537
|
+
markdown: "## create\n\n`client.pipelines.files.create(pipeline_id: string, body: { file_id: string; custom_metadata?: object; }[], project_id?: string): object[]`\n\n**put** `/api/v1/pipelines/{pipeline_id}/files`\n\nAdd files to a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `body: { file_id: string; custom_metadata?: object; }[]`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; pipeline_id: string; config_hash?: object; created_at?: string; custom_metadata?: object; data_source_id?: string; external_file_id?: string; file_id?: string; file_size?: number; file_type?: string; indexed_page_count?: number; last_modified_at?: string; name?: string; permission_info?: object; project_id?: string; resource_info?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; updated_at?: string; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipelineFiles = await client.pipelines.files.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { body: [{ file_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }] });\n\nconsole.log(pipelineFiles);\n```",
|
|
3600
3538
|
perLanguage: {
|
|
3601
3539
|
go: {
|
|
3602
3540
|
method: 'client.Pipelines.Files.New',
|
|
@@ -3635,9 +3573,9 @@ const EMBEDDED_METHODS = [
|
|
|
3635
3573
|
description: 'Update a file for a pipeline.',
|
|
3636
3574
|
stainlessPath: '(resource) pipelines.files > (method) update',
|
|
3637
3575
|
qualified: 'client.pipelines.files.update',
|
|
3638
|
-
params: ['pipeline_id: string;', 'file_id: string;', 'custom_metadata?: object;'],
|
|
3576
|
+
params: ['pipeline_id: string;', 'file_id: string;', 'project_id?: string;', 'custom_metadata?: object;'],
|
|
3639
3577
|
response: "{ id: string; pipeline_id: string; config_hash?: object; created_at?: string; custom_metadata?: object; data_source_id?: string; external_file_id?: string; file_id?: string; file_size?: number; file_type?: string; indexed_page_count?: number; last_modified_at?: string; name?: string; permission_info?: object; project_id?: string; resource_info?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; updated_at?: string; }",
|
|
3640
|
-
markdown: "## update\n\n`client.pipelines.files.update(pipeline_id: string, file_id: string, custom_metadata?: object): { id: string; pipeline_id: string; config_hash?: object; created_at?: string; custom_metadata?: object; data_source_id?: string; external_file_id?: string; file_id?: string; file_size?: number; file_type?: string; indexed_page_count?: number; last_modified_at?: string; name?: string; permission_info?: object; project_id?: string; resource_info?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; updated_at?: string; }`\n\n**put** `/api/v1/pipelines/{pipeline_id}/files/{file_id}`\n\nUpdate a file for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `file_id: string`\n\n- `custom_metadata?: object`\n Custom metadata for the file\n\n### Returns\n\n- `{ id: string; pipeline_id: string; config_hash?: object; created_at?: string; custom_metadata?: object; data_source_id?: string; external_file_id?: string; file_id?: string; file_size?: number; file_type?: string; indexed_page_count?: number; last_modified_at?: string; name?: string; permission_info?: object; project_id?: string; resource_info?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; updated_at?: string; }`\n A file associated with a pipeline.\n\n - `id: string`\n - `pipeline_id: string`\n - `config_hash?: object`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `data_source_id?: string`\n - `external_file_id?: string`\n - `file_id?: string`\n - `file_size?: number`\n - `file_type?: string`\n - `indexed_page_count?: number`\n - `last_modified_at?: string`\n - `name?: string`\n - `permission_info?: object`\n - `project_id?: string`\n - `resource_info?: object`\n - `status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'`\n - `status_updated_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipelineFile = await client.pipelines.files.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(pipelineFile);\n```",
|
|
3578
|
+
markdown: "## update\n\n`client.pipelines.files.update(pipeline_id: string, file_id: string, project_id?: string, custom_metadata?: object): { id: string; pipeline_id: string; config_hash?: object; created_at?: string; custom_metadata?: object; data_source_id?: string; external_file_id?: string; file_id?: string; file_size?: number; file_type?: string; indexed_page_count?: number; last_modified_at?: string; name?: string; permission_info?: object; project_id?: string; resource_info?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; updated_at?: string; }`\n\n**put** `/api/v1/pipelines/{pipeline_id}/files/{file_id}`\n\nUpdate a file for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `file_id: string`\n\n- `project_id?: string`\n\n- `custom_metadata?: object`\n Custom metadata for the file\n\n### Returns\n\n- `{ id: string; pipeline_id: string; config_hash?: object; created_at?: string; custom_metadata?: object; data_source_id?: string; external_file_id?: string; file_id?: string; file_size?: number; file_type?: string; indexed_page_count?: number; last_modified_at?: string; name?: string; permission_info?: object; project_id?: string; resource_info?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; updated_at?: string; }`\n A file associated with a pipeline.\n\n - `id: string`\n - `pipeline_id: string`\n - `config_hash?: object`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `data_source_id?: string`\n - `external_file_id?: string`\n - `file_id?: string`\n - `file_size?: number`\n - `file_type?: string`\n - `indexed_page_count?: number`\n - `last_modified_at?: string`\n - `name?: string`\n - `permission_info?: object`\n - `project_id?: string`\n - `resource_info?: object`\n - `status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'`\n - `status_updated_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipelineFile = await client.pipelines.files.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(pipelineFile);\n```",
|
|
3641
3579
|
perLanguage: {
|
|
3642
3580
|
go: {
|
|
3643
3581
|
method: 'client.Pipelines.Files.Update',
|
|
@@ -3676,8 +3614,8 @@ const EMBEDDED_METHODS = [
|
|
|
3676
3614
|
description: 'Delete a file from a pipeline.',
|
|
3677
3615
|
stainlessPath: '(resource) pipelines.files > (method) delete',
|
|
3678
3616
|
qualified: 'client.pipelines.files.delete',
|
|
3679
|
-
params: ['pipeline_id: string;', 'file_id: string;'],
|
|
3680
|
-
markdown: "## delete\n\n`client.pipelines.files.delete(pipeline_id: string, file_id: string): void`\n\n**delete** `/api/v1/pipelines/{pipeline_id}/files/{file_id}`\n\nDelete a file from a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `file_id: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nawait client.pipelines.files.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' })\n```",
|
|
3617
|
+
params: ['pipeline_id: string;', 'file_id: string;', 'project_id?: string;'],
|
|
3618
|
+
markdown: "## delete\n\n`client.pipelines.files.delete(pipeline_id: string, file_id: string, project_id?: string): void`\n\n**delete** `/api/v1/pipelines/{pipeline_id}/files/{file_id}`\n\nDelete a file from a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `file_id: string`\n\n- `project_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nawait client.pipelines.files.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' })\n```",
|
|
3681
3619
|
perLanguage: {
|
|
3682
3620
|
go: {
|
|
3683
3621
|
method: 'client.Pipelines.Files.Delete',
|
|
@@ -3724,10 +3662,11 @@ const EMBEDDED_METHODS = [
|
|
|
3724
3662
|
'offset?: number;',
|
|
3725
3663
|
'only_manually_uploaded?: boolean;',
|
|
3726
3664
|
'order_by?: string;',
|
|
3665
|
+
'project_id?: string;',
|
|
3727
3666
|
"statuses?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'[];",
|
|
3728
3667
|
],
|
|
3729
3668
|
response: "{ id: string; pipeline_id: string; config_hash?: object; created_at?: string; custom_metadata?: object; data_source_id?: string; external_file_id?: string; file_id?: string; file_size?: number; file_type?: string; indexed_page_count?: number; last_modified_at?: string; name?: string; permission_info?: object; project_id?: string; resource_info?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; updated_at?: string; }",
|
|
3730
|
-
markdown: "## list\n\n`client.pipelines.files.list(pipeline_id: string, data_source_id?: string, file_name_contains?: string, limit?: number, offset?: number, only_manually_uploaded?: boolean, order_by?: string, statuses?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'[]): { id: string; pipeline_id: string; config_hash?: object; created_at?: string; custom_metadata?: object; data_source_id?: string; external_file_id?: string; file_id?: string; file_size?: number; file_type?: string; indexed_page_count?: number; last_modified_at?: string; name?: string; permission_info?: object; project_id?: string; resource_info?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/files2`\n\nList files for a pipeline with optional filtering, sorting, and pagination.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id?: string`\n\n- `file_name_contains?: string`\n\n- `limit?: number`\n\n- `offset?: number`\n\n- `only_manually_uploaded?: boolean`\n\n- `order_by?: string`\n\n- `statuses?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'[]`\n Filter by file statuses\n\n### Returns\n\n- `{ id: string; pipeline_id: string; config_hash?: object; created_at?: string; custom_metadata?: object; data_source_id?: string; external_file_id?: string; file_id?: string; file_size?: number; file_type?: string; indexed_page_count?: number; last_modified_at?: string; name?: string; permission_info?: object; project_id?: string; resource_info?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; updated_at?: string; }`\n A file associated with a pipeline.\n\n - `id: string`\n - `pipeline_id: string`\n - `config_hash?: object`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `data_source_id?: string`\n - `external_file_id?: string`\n - `file_id?: string`\n - `file_size?: number`\n - `file_type?: string`\n - `indexed_page_count?: number`\n - `last_modified_at?: string`\n - `name?: string`\n - `permission_info?: object`\n - `project_id?: string`\n - `resource_info?: object`\n - `status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'`\n - `status_updated_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\n// Automatically fetches more pages as needed.\nfor await (const pipelineFile of client.pipelines.files.list('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e')) {\n console.log(pipelineFile);\n}\n```",
|
|
3669
|
+
markdown: "## list\n\n`client.pipelines.files.list(pipeline_id: string, data_source_id?: string, file_name_contains?: string, limit?: number, offset?: number, only_manually_uploaded?: boolean, order_by?: string, project_id?: string, statuses?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'[]): { id: string; pipeline_id: string; config_hash?: object; created_at?: string; custom_metadata?: object; data_source_id?: string; external_file_id?: string; file_id?: string; file_size?: number; file_type?: string; indexed_page_count?: number; last_modified_at?: string; name?: string; permission_info?: object; project_id?: string; resource_info?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/files2`\n\nList files for a pipeline with optional filtering, sorting, and pagination.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id?: string`\n\n- `file_name_contains?: string`\n\n- `limit?: number`\n\n- `offset?: number`\n\n- `only_manually_uploaded?: boolean`\n\n- `order_by?: string`\n\n- `project_id?: string`\n\n- `statuses?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'[]`\n Filter by file statuses\n\n### Returns\n\n- `{ id: string; pipeline_id: string; config_hash?: object; created_at?: string; custom_metadata?: object; data_source_id?: string; external_file_id?: string; file_id?: string; file_size?: number; file_type?: string; indexed_page_count?: number; last_modified_at?: string; name?: string; permission_info?: object; project_id?: string; resource_info?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; updated_at?: string; }`\n A file associated with a pipeline.\n\n - `id: string`\n - `pipeline_id: string`\n - `config_hash?: object`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `data_source_id?: string`\n - `external_file_id?: string`\n - `file_id?: string`\n - `file_size?: number`\n - `file_type?: string`\n - `indexed_page_count?: number`\n - `last_modified_at?: string`\n - `name?: string`\n - `permission_info?: object`\n - `project_id?: string`\n - `resource_info?: object`\n - `status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'`\n - `status_updated_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\n// Automatically fetches more pages as needed.\nfor await (const pipelineFile of client.pipelines.files.list('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e')) {\n console.log(pipelineFile);\n}\n```",
|
|
3731
3670
|
perLanguage: {
|
|
3732
3671
|
go: {
|
|
3733
3672
|
method: 'client.Pipelines.Files.List',
|
|
@@ -3766,9 +3705,9 @@ const EMBEDDED_METHODS = [
|
|
|
3766
3705
|
description: 'Import metadata for a pipeline.',
|
|
3767
3706
|
stainlessPath: '(resource) pipelines.metadata > (method) create',
|
|
3768
3707
|
qualified: 'client.pipelines.metadata.create',
|
|
3769
|
-
params: ['pipeline_id: string;', 'upload_file: string;'],
|
|
3708
|
+
params: ['pipeline_id: string;', 'upload_file: string;', 'project_id?: string;'],
|
|
3770
3709
|
response: 'object',
|
|
3771
|
-
markdown: "## create\n\n`client.pipelines.metadata.create(pipeline_id: string, upload_file: string): object`\n\n**put** `/api/v1/pipelines/{pipeline_id}/metadata`\n\nImport metadata for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `upload_file: string`\n\n### Returns\n\n- `object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst metadata = await client.pipelines.metadata.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { upload_file: fs.createReadStream('path/to/file') });\n\nconsole.log(metadata);\n```",
|
|
3710
|
+
markdown: "## create\n\n`client.pipelines.metadata.create(pipeline_id: string, upload_file: string, project_id?: string): object`\n\n**put** `/api/v1/pipelines/{pipeline_id}/metadata`\n\nImport metadata for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `upload_file: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst metadata = await client.pipelines.metadata.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { upload_file: fs.createReadStream('path/to/file') });\n\nconsole.log(metadata);\n```",
|
|
3772
3711
|
perLanguage: {
|
|
3773
3712
|
go: {
|
|
3774
3713
|
method: 'client.Pipelines.Metadata.New',
|
|
@@ -3807,16 +3746,16 @@ const EMBEDDED_METHODS = [
|
|
|
3807
3746
|
description: 'Delete metadata for all files in a pipeline.',
|
|
3808
3747
|
stainlessPath: '(resource) pipelines.metadata > (method) delete_all',
|
|
3809
3748
|
qualified: 'client.pipelines.metadata.deleteAll',
|
|
3810
|
-
params: ['pipeline_id: string;'],
|
|
3811
|
-
markdown: "## delete_all\n\n`client.pipelines.metadata.deleteAll(pipeline_id: string): void`\n\n**delete** `/api/v1/pipelines/{pipeline_id}/metadata`\n\nDelete metadata for all files in a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nawait client.pipelines.metadata.deleteAll('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e')\n```",
|
|
3749
|
+
params: ['pipeline_id: string;', 'project_id?: string;'],
|
|
3750
|
+
markdown: "## delete_all\n\n`client.pipelines.metadata.deleteAll(pipeline_id: string, project_id?: string): void`\n\n**delete** `/api/v1/pipelines/{pipeline_id}/metadata`\n\nDelete metadata for all files in a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `project_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nawait client.pipelines.metadata.deleteAll('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e')\n```",
|
|
3812
3751
|
perLanguage: {
|
|
3813
3752
|
go: {
|
|
3814
3753
|
method: 'client.Pipelines.Metadata.DeleteAll',
|
|
3815
|
-
example: 'package main\n\nimport (\n\t"context"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\terr := client.Pipelines.Metadata.DeleteAll(
|
|
3754
|
+
example: 'package main\n\nimport (\n\t"context"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\terr := client.Pipelines.Metadata.DeleteAll(\n\t\tcontext.TODO(),\n\t\t"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n\t\tllamacloud.PipelineMetadataDeleteAllParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n',
|
|
3816
3755
|
},
|
|
3817
3756
|
python: {
|
|
3818
3757
|
method: 'pipelines.metadata.delete_all',
|
|
3819
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nclient.pipelines.metadata.delete_all(\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)',
|
|
3758
|
+
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nclient.pipelines.metadata.delete_all(\n pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)',
|
|
3820
3759
|
},
|
|
3821
3760
|
java: {
|
|
3822
3761
|
method: 'pipelines().metadata().deleteAll',
|
|
@@ -3850,9 +3789,10 @@ const EMBEDDED_METHODS = [
|
|
|
3850
3789
|
params: [
|
|
3851
3790
|
'pipeline_id: string;',
|
|
3852
3791
|
'body: { metadata: object; text: string; id?: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; }[];',
|
|
3792
|
+
'project_id?: string;',
|
|
3853
3793
|
],
|
|
3854
3794
|
response: '{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }[]',
|
|
3855
|
-
markdown: "## create\n\n`client.pipelines.documents.create(pipeline_id: string, body: { metadata: object; text: string; id?: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; }[]): object[]`\n\n**post** `/api/v1/pipelines/{pipeline_id}/documents`\n\nBatch create documents for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `body: { metadata: object; text: string; id?: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; }[]`\n\n### Returns\n\n- `{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst cloudDocuments = await client.pipelines.documents.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { body: [{\n metadata: { foo: 'bar' },\n text: 'text',\n}] });\n\nconsole.log(cloudDocuments);\n```",
|
|
3795
|
+
markdown: "## create\n\n`client.pipelines.documents.create(pipeline_id: string, body: { metadata: object; text: string; id?: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; }[], project_id?: string): object[]`\n\n**post** `/api/v1/pipelines/{pipeline_id}/documents`\n\nBatch create documents for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `body: { metadata: object; text: string; id?: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; }[]`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst cloudDocuments = await client.pipelines.documents.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { body: [{\n metadata: { foo: 'bar' },\n text: 'text',\n}] });\n\nconsole.log(cloudDocuments);\n```",
|
|
3856
3796
|
perLanguage: {
|
|
3857
3797
|
go: {
|
|
3858
3798
|
method: 'client.Pipelines.Documents.New',
|
|
@@ -3897,11 +3837,12 @@ const EMBEDDED_METHODS = [
|
|
|
3897
3837
|
'limit?: number;',
|
|
3898
3838
|
'only_api_data_source_documents?: boolean;',
|
|
3899
3839
|
'only_direct_upload?: boolean;',
|
|
3840
|
+
'project_id?: string;',
|
|
3900
3841
|
'skip?: number;',
|
|
3901
3842
|
"status_refresh_policy?: 'cached' | 'ttl';",
|
|
3902
3843
|
],
|
|
3903
3844
|
response: '{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }',
|
|
3904
|
-
markdown: "## list\n\n`client.pipelines.documents.list(pipeline_id: string, file_id?: string, limit?: number, only_api_data_source_documents?: boolean, only_direct_upload?: boolean, skip?: number, status_refresh_policy?: 'cached' | 'ttl'): { id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/documents/paginated`\n\nReturn a list of documents for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `file_id?: string`\n\n- `limit?: number`\n\n- `only_api_data_source_documents?: boolean`\n\n- `only_direct_upload?: boolean`\n\n- `skip?: number`\n\n- `status_refresh_policy?: 'cached' | 'ttl'`\n\n### Returns\n\n- `{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }`\n Cloud document stored in S3.\n\n - `id: string`\n - `metadata: object`\n - `text: string`\n - `excluded_embed_metadata_keys?: string[]`\n - `excluded_llm_metadata_keys?: string[]`\n - `page_positions?: number[]`\n - `status_metadata?: object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\n// Automatically fetches more pages as needed.\nfor await (const cloudDocument of client.pipelines.documents.list('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e')) {\n console.log(cloudDocument);\n}\n```",
|
|
3845
|
+
markdown: "## list\n\n`client.pipelines.documents.list(pipeline_id: string, file_id?: string, limit?: number, only_api_data_source_documents?: boolean, only_direct_upload?: boolean, project_id?: string, skip?: number, status_refresh_policy?: 'cached' | 'ttl'): { id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/documents/paginated`\n\nReturn a list of documents for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `file_id?: string`\n\n- `limit?: number`\n\n- `only_api_data_source_documents?: boolean`\n\n- `only_direct_upload?: boolean`\n\n- `project_id?: string`\n\n- `skip?: number`\n\n- `status_refresh_policy?: 'cached' | 'ttl'`\n\n### Returns\n\n- `{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }`\n Cloud document stored in S3.\n\n - `id: string`\n - `metadata: object`\n - `text: string`\n - `excluded_embed_metadata_keys?: string[]`\n - `excluded_llm_metadata_keys?: string[]`\n - `page_positions?: number[]`\n - `status_metadata?: object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\n// Automatically fetches more pages as needed.\nfor await (const cloudDocument of client.pipelines.documents.list('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e')) {\n console.log(cloudDocument);\n}\n```",
|
|
3905
3846
|
perLanguage: {
|
|
3906
3847
|
go: {
|
|
3907
3848
|
method: 'client.Pipelines.Documents.List',
|
|
@@ -3945,9 +3886,10 @@ const EMBEDDED_METHODS = [
|
|
|
3945
3886
|
'data_source_id?: string;',
|
|
3946
3887
|
'file_id?: string;',
|
|
3947
3888
|
'only_direct_upload?: boolean;',
|
|
3889
|
+
'project_id?: string;',
|
|
3948
3890
|
],
|
|
3949
3891
|
response: '{ counts: object; pipeline_id: string; total_count: number; data_source_id?: string; file_id?: string; only_direct_upload?: boolean; }',
|
|
3950
|
-
markdown: "## get_status_counts\n\n`client.pipelines.documents.getStatusCounts(pipeline_id: string, data_source_id?: string, file_id?: string, only_direct_upload?: boolean): { counts: object; pipeline_id: string; total_count: number; data_source_id?: string; file_id?: string; only_direct_upload?: boolean; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/documents/status-counts`\n\nCount the documents in a pipeline, grouped by ingestion status.\n\nCounts reflect each document's last recorded status rather than a freshly computed one, so a document that changed status in the last few moments may still be counted under its previous one. Use `GET /pipelines/{pipeline_id}/documents/{document_id}/status` when a single document's status has to be up to the moment.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id?: string`\n\n- `file_id?: string`\n\n- `only_direct_upload?: boolean`\n\n### Returns\n\n- `{ counts: object; pipeline_id: string; total_count: number; data_source_id?: string; file_id?: string; only_direct_upload?: boolean; }`\n Counts of the documents in a pipeline, grouped by ingestion status.\n\n - `counts: object`\n - `pipeline_id: string`\n - `total_count: number`\n - `data_source_id?: string`\n - `file_id?: string`\n - `only_direct_upload?: boolean`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst response = await client.pipelines.documents.getStatusCounts('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(response);\n```",
|
|
3892
|
+
markdown: "## get_status_counts\n\n`client.pipelines.documents.getStatusCounts(pipeline_id: string, data_source_id?: string, file_id?: string, only_direct_upload?: boolean, project_id?: string): { counts: object; pipeline_id: string; total_count: number; data_source_id?: string; file_id?: string; only_direct_upload?: boolean; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/documents/status-counts`\n\nCount the documents in a pipeline, grouped by ingestion status.\n\nCounts reflect each document's last recorded status rather than a freshly computed one, so a document that changed status in the last few moments may still be counted under its previous one. Use `GET /pipelines/{pipeline_id}/documents/{document_id}/status` when a single document's status has to be up to the moment.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id?: string`\n\n- `file_id?: string`\n\n- `only_direct_upload?: boolean`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ counts: object; pipeline_id: string; total_count: number; data_source_id?: string; file_id?: string; only_direct_upload?: boolean; }`\n Counts of the documents in a pipeline, grouped by ingestion status.\n\n - `counts: object`\n - `pipeline_id: string`\n - `total_count: number`\n - `data_source_id?: string`\n - `file_id?: string`\n - `only_direct_upload?: boolean`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst response = await client.pipelines.documents.getStatusCounts('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(response);\n```",
|
|
3951
3893
|
perLanguage: {
|
|
3952
3894
|
go: {
|
|
3953
3895
|
method: 'client.Pipelines.Documents.GetStatusCounts',
|
|
@@ -3986,9 +3928,9 @@ const EMBEDDED_METHODS = [
|
|
|
3986
3928
|
description: 'Return a single document for a pipeline.',
|
|
3987
3929
|
stainlessPath: '(resource) pipelines.documents > (method) get',
|
|
3988
3930
|
qualified: 'client.pipelines.documents.get',
|
|
3989
|
-
params: ['pipeline_id: string;', 'document_id: string;'],
|
|
3931
|
+
params: ['pipeline_id: string;', 'document_id: string;', 'project_id?: string;'],
|
|
3990
3932
|
response: '{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }',
|
|
3991
|
-
markdown: "## get\n\n`client.pipelines.documents.get(pipeline_id: string, document_id: string): { id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/documents/{document_id}`\n\nReturn a single document for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `document_id: string`\n\n### Returns\n\n- `{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }`\n Cloud document stored in S3.\n\n - `id: string`\n - `metadata: object`\n - `text: string`\n - `excluded_embed_metadata_keys?: string[]`\n - `excluded_llm_metadata_keys?: string[]`\n - `page_positions?: number[]`\n - `status_metadata?: object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst cloudDocument = await client.pipelines.documents.get('document_id', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(cloudDocument);\n```",
|
|
3933
|
+
markdown: "## get\n\n`client.pipelines.documents.get(pipeline_id: string, document_id: string, project_id?: string): { id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/documents/{document_id}`\n\nReturn a single document for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `document_id: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }`\n Cloud document stored in S3.\n\n - `id: string`\n - `metadata: object`\n - `text: string`\n - `excluded_embed_metadata_keys?: string[]`\n - `excluded_llm_metadata_keys?: string[]`\n - `page_positions?: number[]`\n - `status_metadata?: object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst cloudDocument = await client.pipelines.documents.get('document_id', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(cloudDocument);\n```",
|
|
3992
3934
|
perLanguage: {
|
|
3993
3935
|
go: {
|
|
3994
3936
|
method: 'client.Pipelines.Documents.Get',
|
|
@@ -4027,8 +3969,8 @@ const EMBEDDED_METHODS = [
|
|
|
4027
3969
|
description: 'Delete a document from a pipeline; runs async (vectors first, then MongoDB record).',
|
|
4028
3970
|
stainlessPath: '(resource) pipelines.documents > (method) delete',
|
|
4029
3971
|
qualified: 'client.pipelines.documents.delete',
|
|
4030
|
-
params: ['pipeline_id: string;', 'document_id: string;'],
|
|
4031
|
-
markdown: "## delete\n\n`client.pipelines.documents.delete(pipeline_id: string, document_id: string): void`\n\n**delete** `/api/v1/pipelines/{pipeline_id}/documents/{document_id}`\n\nDelete a document from a pipeline; runs async (vectors first, then MongoDB record).\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `document_id: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nawait client.pipelines.documents.delete('document_id', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' })\n```",
|
|
3972
|
+
params: ['pipeline_id: string;', 'document_id: string;', 'project_id?: string;'],
|
|
3973
|
+
markdown: "## delete\n\n`client.pipelines.documents.delete(pipeline_id: string, document_id: string, project_id?: string): void`\n\n**delete** `/api/v1/pipelines/{pipeline_id}/documents/{document_id}`\n\nDelete a document from a pipeline; runs async (vectors first, then MongoDB record).\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `document_id: string`\n\n- `project_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nawait client.pipelines.documents.delete('document_id', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' })\n```",
|
|
4032
3974
|
perLanguage: {
|
|
4033
3975
|
go: {
|
|
4034
3976
|
method: 'client.Pipelines.Documents.Delete',
|
|
@@ -4067,9 +4009,9 @@ const EMBEDDED_METHODS = [
|
|
|
4067
4009
|
description: 'Return a single document for a pipeline.',
|
|
4068
4010
|
stainlessPath: '(resource) pipelines.documents > (method) get_status',
|
|
4069
4011
|
qualified: 'client.pipelines.documents.getStatus',
|
|
4070
|
-
params: ['pipeline_id: string;', 'document_id: string;'],
|
|
4012
|
+
params: ['pipeline_id: string;', 'document_id: string;', 'project_id?: string;'],
|
|
4071
4013
|
response: "{ status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: { job_id: string; message: string; step: string; }[]; job_id?: string; }",
|
|
4072
|
-
markdown: "## get_status\n\n`client.pipelines.documents.getStatus(pipeline_id: string, document_id: string): { status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: object[]; job_id?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/documents/{document_id}/status`\n\nReturn a single document for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `document_id: string`\n\n### Returns\n\n- `{ status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: { job_id: string; message: string; step: string; }[]; job_id?: string; }`\n\n - `status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'`\n - `deployment_date?: string`\n - `effective_at?: string`\n - `error?: { job_id: string; message: string; step: string; }[]`\n - `job_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst managedIngestionStatusResponse = await client.pipelines.documents.getStatus('document_id', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(managedIngestionStatusResponse);\n```",
|
|
4014
|
+
markdown: "## get_status\n\n`client.pipelines.documents.getStatus(pipeline_id: string, document_id: string, project_id?: string): { status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: object[]; job_id?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}/documents/{document_id}/status`\n\nReturn a single document for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `document_id: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'; deployment_date?: string; effective_at?: string; error?: { job_id: string; message: string; step: string; }[]; job_id?: string; }`\n\n - `status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS'`\n - `deployment_date?: string`\n - `effective_at?: string`\n - `error?: { job_id: string; message: string; step: string; }[]`\n - `job_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst managedIngestionStatusResponse = await client.pipelines.documents.getStatus('document_id', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(managedIngestionStatusResponse);\n```",
|
|
4073
4015
|
perLanguage: {
|
|
4074
4016
|
go: {
|
|
4075
4017
|
method: 'client.Pipelines.Documents.GetStatus',
|
|
@@ -4108,9 +4050,9 @@ const EMBEDDED_METHODS = [
|
|
|
4108
4050
|
description: 'Sync a specific document for a pipeline.',
|
|
4109
4051
|
stainlessPath: '(resource) pipelines.documents > (method) sync',
|
|
4110
4052
|
qualified: 'client.pipelines.documents.sync',
|
|
4111
|
-
params: ['pipeline_id: string;', 'document_id: string;'],
|
|
4053
|
+
params: ['pipeline_id: string;', 'document_id: string;', 'project_id?: string;'],
|
|
4112
4054
|
response: 'object',
|
|
4113
|
-
markdown: "## sync\n\n`client.pipelines.documents.sync(pipeline_id: string, document_id: string): object`\n\n**post** `/api/v1/pipelines/{pipeline_id}/documents/{document_id}/sync`\n\nSync a specific document for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `document_id: string`\n\n### Returns\n\n- `object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst response = await client.pipelines.documents.sync('document_id', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(response);\n```",
|
|
4055
|
+
markdown: "## sync\n\n`client.pipelines.documents.sync(pipeline_id: string, document_id: string, project_id?: string): object`\n\n**post** `/api/v1/pipelines/{pipeline_id}/documents/{document_id}/sync`\n\nSync a specific document for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `document_id: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst response = await client.pipelines.documents.sync('document_id', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(response);\n```",
|
|
4114
4056
|
perLanguage: {
|
|
4115
4057
|
go: {
|
|
4116
4058
|
method: 'client.Pipelines.Documents.Sync',
|
|
@@ -4149,9 +4091,9 @@ const EMBEDDED_METHODS = [
|
|
|
4149
4091
|
description: 'Return a list of chunks for a pipeline document.',
|
|
4150
4092
|
stainlessPath: '(resource) pipelines.documents > (method) get_chunks',
|
|
4151
4093
|
qualified: 'client.pipelines.documents.getChunks',
|
|
4152
|
-
params: ['pipeline_id: string;', 'document_id: string;'],
|
|
4094
|
+
params: ['pipeline_id: string;', 'document_id: string;', 'project_id?: string;'],
|
|
4153
4095
|
response: '{ class_name?: string; embedding?: number[]; end_char_idx?: number; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; extra_info?: object; id_?: string; metadata_seperator?: string; metadata_template?: string; mimetype?: string; relationships?: object; start_char_idx?: number; text?: string; text_template?: string; }[]',
|
|
4154
|
-
markdown: "## get_chunks\n\n`client.pipelines.documents.getChunks(pipeline_id: string, document_id: string): object[]`\n\n**get** `/api/v1/pipelines/{pipeline_id}/documents/{document_id}/chunks`\n\nReturn a list of chunks for a pipeline document.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `document_id: string`\n\n### Returns\n\n- `{ class_name?: string; embedding?: number[]; end_char_idx?: number; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; extra_info?: object; id_?: string; metadata_seperator?: string; metadata_template?: string; mimetype?: string; relationships?: object; start_char_idx?: number; text?: string; text_template?: string; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst textNodes = await client.pipelines.documents.getChunks('document_id', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(textNodes);\n```",
|
|
4096
|
+
markdown: "## get_chunks\n\n`client.pipelines.documents.getChunks(pipeline_id: string, document_id: string, project_id?: string): object[]`\n\n**get** `/api/v1/pipelines/{pipeline_id}/documents/{document_id}/chunks`\n\nReturn a list of chunks for a pipeline document.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `document_id: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ class_name?: string; embedding?: number[]; end_char_idx?: number; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; extra_info?: object; id_?: string; metadata_seperator?: string; metadata_template?: string; mimetype?: string; relationships?: object; start_char_idx?: number; text?: string; text_template?: string; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst textNodes = await client.pipelines.documents.getChunks('document_id', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(textNodes);\n```",
|
|
4155
4097
|
perLanguage: {
|
|
4156
4098
|
go: {
|
|
4157
4099
|
method: 'client.Pipelines.Documents.GetChunks',
|
|
@@ -4193,9 +4135,10 @@ const EMBEDDED_METHODS = [
|
|
|
4193
4135
|
params: [
|
|
4194
4136
|
'pipeline_id: string;',
|
|
4195
4137
|
'body: { metadata: object; text: string; id?: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; }[];',
|
|
4138
|
+
'project_id?: string;',
|
|
4196
4139
|
],
|
|
4197
4140
|
response: '{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }[]',
|
|
4198
|
-
markdown: "## upsert\n\n`client.pipelines.documents.upsert(pipeline_id: string, body: { metadata: object; text: string; id?: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; }[]): object[]`\n\n**put** `/api/v1/pipelines/{pipeline_id}/documents`\n\nBatch create or update a document for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `body: { metadata: object; text: string; id?: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; }[]`\n\n### Returns\n\n- `{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst cloudDocuments = await client.pipelines.documents.upsert('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { body: [{\n metadata: { foo: 'bar' },\n text: 'text',\n}] });\n\nconsole.log(cloudDocuments);\n```",
|
|
4141
|
+
markdown: "## upsert\n\n`client.pipelines.documents.upsert(pipeline_id: string, body: { metadata: object; text: string; id?: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; }[], project_id?: string): object[]`\n\n**put** `/api/v1/pipelines/{pipeline_id}/documents`\n\nBatch create or update a document for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `body: { metadata: object; text: string; id?: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; }[]`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst cloudDocuments = await client.pipelines.documents.upsert('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { body: [{\n metadata: { foo: 'bar' },\n text: 'text',\n}] });\n\nconsole.log(cloudDocuments);\n```",
|
|
4199
4142
|
perLanguage: {
|
|
4200
4143
|
go: {
|
|
4201
4144
|
method: 'client.Pipelines.Documents.Upsert',
|
|
@@ -4824,7 +4767,7 @@ const EMBEDDED_METHODS = [
|
|
|
4824
4767
|
'vector_pipeline_weight?: number;',
|
|
4825
4768
|
],
|
|
4826
4769
|
response: '{ results: { content: string; metadata?: object; rerank_score?: number; score?: number; static_fields?: { attachments?: object[]; chunk_end_char?: number; chunk_index?: number; chunk_start_char?: number; chunk_token_count?: number; page_range_end?: number; page_range_start?: number; parsed_directory_file_id?: string; }; }[]; }',
|
|
4827
|
-
markdown: "## retrieve\n\n`client.beta.retrieval.retrieve(index_id: string, query: string, organization_id?: string, project_id?: string, custom_filters?: object, full_text_pipeline_weight?: number, num_candidates?: number, rerank?: { enabled?: boolean; top_n?: number; }, score_threshold?: number, static_filters?: { parsed_directory_file_id?: { operator: 'eq' | 'gt' | 'gte' | 'in' | 'lt' | 'lte' | 'ne' | 'nin'; value: string | string[]; }; }, top_k?: number, vector_pipeline_weight?: number): { results: object[]; }`\n\n**post** `/api/v1/retrieval/retrieve`\n\nRetrieve relevant chunks via hybrid search (vector + full-text), with filtering on built-in or user-defined metadata.\n\n### Parameters\n\n- `index_id: string`\n ID of the index to retrieve against.\n\n- `query: string`\n Natural-language query to retrieve relevant chunks.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `custom_filters?: object`\n Filters on user-defined metadata fields.\n\n- `full_text_pipeline_weight?: number`\n Weight of the full-text search pipeline (0-1).\n\n- `num_candidates?: number`\n Number of candidates for approximate nearest neighbor search.\n\n- `rerank?: { enabled?: boolean; top_n?: number; }`\n Reranking configuration applied after hybrid search. Enabled by default.\n - `enabled?: boolean`\n Set to false to disable reranking.\n - `top_n?: number`\n Number of results to return after reranking.\n\n- `score_threshold?: number`\n Minimum score threshold for returned results.\n\n- `static_filters?: { parsed_directory_file_id?: { operator: 'eq' | 'gt' | 'gte' | 'in' | 'lt' | 'lte' | 'ne' | 'nin'; value: string | string[]; }; }`\n Filters on built-in document fields (page range, chunk index, etc.).\n - `parsed_directory_file_id?: { operator: 'eq' | 'gt' | 'gte' | 'in' | 'lt' | 'lte' | 'ne' | 'nin'; value: string | string[]; }`\n Filter on a string field.\n\n- `top_k?: number`\n Maximum number of results to return.\n\n- `vector_pipeline_weight?: number`\n Weight of the vector search pipeline (0-1).\n\n### Returns\n\n- `{ results: { content: string; metadata?: object; rerank_score?: number; score?: number; static_fields?: { attachments?: object[]; chunk_end_char?: number; chunk_index?: number; chunk_start_char?: number; chunk_token_count?: number; page_range_end?: number; page_range_start?: number; parsed_directory_file_id?: string; }; }[]; }`\n Response containing retrieval results.\n\n - `results: { content: string; metadata?: object; rerank_score?: number; score?: number; static_fields?: { attachments?: { attachment_name: string; source_id: string; type: string; }[]; chunk_end_char?: number; chunk_index?: number; chunk_start_char?: number; chunk_token_count?: number; page_range_end?: number; page_range_start?: number; parsed_directory_file_id?: string; }; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst retrieval = await client.beta.retrieval.retrieve({ index_id: 'idx-abc123', query: 'What are the key findings?' });\n\nconsole.log(retrieval);\n```",
|
|
4770
|
+
markdown: "## retrieve\n\n`client.beta.retrieval.retrieve(index_id: string, query: string, organization_id?: string, project_id?: string, custom_filters?: object, full_text_pipeline_weight?: number, num_candidates?: number, rerank?: { enabled?: boolean; top_n?: number; }, score_threshold?: number, static_filters?: { parsed_directory_file_id?: { operator: 'eq' | 'gt' | 'gte' | 'in' | 'lt' | 'lte' | 'ne' | 'nin'; value: string | string[]; }; }, top_k?: number, vector_pipeline_weight?: number): { results: object[]; }`\n\n**post** `/api/v1/retrieval/retrieve`\n\nRetrieve relevant chunks via hybrid search (vector + full-text), with filtering on built-in or user-defined metadata.\n\n### Parameters\n\n- `index_id: string`\n ID of the index to retrieve against.\n\n- `query: string`\n Natural-language query to retrieve relevant chunks.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `custom_filters?: object`\n Filters on user-defined metadata fields.\n\n- `full_text_pipeline_weight?: number`\n Weight of the full-text search pipeline (0-1).\n\n- `num_candidates?: number`\n Number of candidates for approximate nearest neighbor search.\n\n- `rerank?: { enabled?: boolean; top_n?: number; }`\n Reranking configuration applied after hybrid search. Enabled by default.\n - `enabled?: boolean`\n Set to false to disable reranking.\n - `top_n?: number`\n Number of results to return after reranking.\n\n- `score_threshold?: number`\n Minimum score threshold for returned results.\n\n- `static_filters?: { parsed_directory_file_id?: { operator: 'eq' | 'gt' | 'gte' | 'in' | 'lt' | 'lte' | 'ne' | 'nin'; value: string | string[]; }; }`\n Filters on built-in document fields (page range, chunk index, etc.).\n - `parsed_directory_file_id?: { operator: 'eq' | 'gt' | 'gte' | 'in' | 'lt' | 'lte' | 'ne' | 'nin'; value: string | string[]; }`\n Filter on a string field.\n\n- `top_k?: number`\n Maximum number of results to return. Values above 500 are capped at 500.\n\n- `vector_pipeline_weight?: number`\n Weight of the vector search pipeline (0-1).\n\n### Returns\n\n- `{ results: { content: string; metadata?: object; rerank_score?: number; score?: number; static_fields?: { attachments?: object[]; chunk_end_char?: number; chunk_index?: number; chunk_start_char?: number; chunk_token_count?: number; page_range_end?: number; page_range_start?: number; parsed_directory_file_id?: string; }; }[]; }`\n Response containing retrieval results.\n\n - `results: { content: string; metadata?: object; rerank_score?: number; score?: number; static_fields?: { attachments?: { attachment_name: string; source_id: string; type: string; }[]; chunk_end_char?: number; chunk_index?: number; chunk_start_char?: number; chunk_token_count?: number; page_range_end?: number; page_range_start?: number; parsed_directory_file_id?: string; }; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst retrieval = await client.beta.retrieval.retrieve({ index_id: 'idx-abc123', query: 'What are the key findings?' });\n\nconsole.log(retrieval);\n```",
|
|
4828
4771
|
perLanguage: {
|
|
4829
4772
|
go: {
|
|
4830
4773
|
method: 'client.Beta.Retrieval.Get',
|
|
@@ -6116,11 +6059,11 @@ const EMBEDDED_METHODS = [
|
|
|
6116
6059
|
'document_input: { type: string; value: string; };',
|
|
6117
6060
|
'organization_id?: string;',
|
|
6118
6061
|
'project_id?: string;',
|
|
6119
|
-
"configuration?: { categories: { name: string; description?: string; }[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; };",
|
|
6062
|
+
"configuration?: { categories: { name: string; description?: string; }[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; };",
|
|
6120
6063
|
'configuration_id?: string;',
|
|
6121
6064
|
],
|
|
6122
6065
|
response: '{ id: string; categories: { name: string; description?: string; }[]; document_input: { type: string; value: string; }; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; updated_at?: string; }',
|
|
6123
|
-
markdown: "## create\n\n`client.beta.split.create(document_input: { type: string; value: string; }, organization_id?: string, project_id?: string, configuration?: { categories: object[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; }, configuration_id?: string): { id: string; categories: split_category[]; document_input: split_document_input; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; updated_at?: string; }`\n\n**post** `/api/v1/beta/split/jobs`\n\nCreate a document split job.\n\n### Parameters\n\n- `document_input: { type: string; value: string; }`\n Document to be split.\n - `type: string`\n Type of document input. Valid values are: file_id\n - `value: string`\n Document identifier.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `configuration?: { categories: { name: string; description?: string; }[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; }`\n Split configuration with categories and splitting strategy.\n - `categories: { name: string; description?: string; }[]`\n Categories to split documents into.\n - `splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }`\n Strategy for splitting documents.\n\n- `configuration_id?: string`\n Saved split configuration ID.\n\n### Returns\n\n- `{ id: string; categories: { name: string; description?: string; }[]; document_input: { type: string; value: string; }; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; updated_at?: string; }`\n Beta response — uses nested document_input object.\n\n - `id: string`\n - `categories: { name: string; description?: string; }[]`\n - `document_input: { type: string; value: string; }`\n - `project_id: string`\n - `status: string`\n - `user_id: string`\n - `configuration_id?: string`\n - `created_at?: string`\n - `error_message?: string`\n - `result?: { segments: { category: string; confidence_category: string; pages: number[]; }[]; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst split = await client.beta.split.create({ document_input: { type: 'type', value: 'value' } });\n\nconsole.log(split);\n```",
|
|
6066
|
+
markdown: "## create\n\n`client.beta.split.create(document_input: { type: string; value: string; }, organization_id?: string, project_id?: string, configuration?: { categories: object[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; }, configuration_id?: string): { id: string; categories: split_category[]; document_input: split_document_input; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; updated_at?: string; }`\n\n**post** `/api/v1/beta/split/jobs`\n\nCreate a document split job.\n\n### Parameters\n\n- `document_input: { type: string; value: string; }`\n Document to be split.\n - `type: string`\n Type of document input. Valid values are: file_id\n - `value: string`\n Document identifier.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `configuration?: { categories: { name: string; description?: string; }[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; }`\n Split configuration with categories and splitting strategy.\n - `categories: { name: string; description?: string; }[]`\n Categories to split documents into.\n - `splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }`\n Strategy for splitting documents.\n\n- `configuration_id?: string`\n Saved split configuration ID.\n\n### Returns\n\n- `{ id: string; categories: { name: string; description?: string; }[]; document_input: { type: string; value: string; }; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; updated_at?: string; }`\n Beta response — uses nested document_input object.\n\n - `id: string`\n - `categories: { name: string; description?: string; }[]`\n - `document_input: { type: string; value: string; }`\n - `project_id: string`\n - `status: string`\n - `user_id: string`\n - `configuration_id?: string`\n - `created_at?: string`\n - `error_message?: string`\n - `result?: { segments: { category: string; confidence_category: string; pages: number[]; }[]; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst split = await client.beta.split.create({ document_input: { type: 'type', value: 'value' } });\n\nconsole.log(split);\n```",
|
|
6124
6067
|
perLanguage: {
|
|
6125
6068
|
go: {
|
|
6126
6069
|
method: 'client.Beta.Split.New',
|
|
@@ -6313,7 +6256,7 @@ const EMBEDDED_METHODS = [
|
|
|
6313
6256
|
const EMBEDDED_READMES = [
|
|
6314
6257
|
{
|
|
6315
6258
|
language: 'go',
|
|
6316
|
-
content: '# Llama Cloud Go API Library\n\n<a href="https://pkg.go.dev/github.com/run-llama/llama-parse-go"><img src="https://pkg.go.dev/badge/github.com/run-llama/llama-parse-go.svg" alt="Go Reference"></a>\n\nThe Llama Cloud Go library provides convenient access to the [Llama Cloud REST API](https://developers.llamaindex.ai/)\nfrom applications written in Go.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Llama Cloud MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[](https://cursor.com/en-US/install-mcp?name=%40llamaindex%2Fllama-cloud-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsbGFtYWluZGV4L2xsYW1hLWNsb3VkLW1jcCJdLCJlbnYiOnsiTExBTUFfQ0xPVURfQVBJX0tFWSI6Ik15IEFQSSBLZXkifX0)\n[](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40llamaindex%2Fllama-cloud-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40llamaindex%2Fllama-cloud-mcp%22%5D%2C%22env%22%3A%7B%22LLAMA_CLOUD_API_KEY%22%3A%22My%20API%20Key%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n<!-- x-release-please-start-version -->\n\n```go\nimport (\n\t"github.com/run-llama/llama-parse-go" // imported as SDK_PackageName\n)\n```\n\n<!-- x-release-please-end -->\n\nOr to pin the version:\n\n<!-- x-release-please-start-version -->\n\n```sh\ngo get -u \'github.com/run-llama/llama-parse-go@v1.5.1\'\n```\n\n<!-- x-release-please-end -->\n\n## Requirements\n\nThis library requires Go 1.22+.\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```go\npackage main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"), // defaults to os.LookupEnv("LLAMA_CLOUD_API_KEY")\n\t)\n\tparsing, err := client.Parsing.New(context.TODO(), llamacloud.ParsingNewParams{\n\t\tTier: llamacloud.ParsingNewParamsTierAgentic,\n\t\tVersion: llamacloud.ParsingNewParamsVersionLatest,\n\t\tFileID: llamacloud.String("abc1234"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", parsing.ID)\n}\n\n```\n\n### Request fields\n\nAll request parameters are wrapped in a generic `Field` type,\nwhich we use to distinguish zero values from null or omitted fields.\n\nThis prevents accidentally sending a zero value if you forget a required parameter,\nand enables explicitly sending `null`, `false`, `\'\'`, or `0` on optional parameters.\nAny field not specified is not sent.\n\nTo construct fields with values, use the helpers `String()`, `Int()`, `Float()`, or most commonly, the generic `F[T]()`.\nTo send a null, use `Null[T]()`, and to send a nonconforming value, use `Raw[T](any)`. For example:\n\n```go\nparams := FooParams{\n\tName: SDK_PackageName.F("hello"),\n\n\t// Explicitly send `"description": null`\n\tDescription: SDK_PackageName.Null[string](),\n\n\tPoint: SDK_PackageName.F(SDK_PackageName.Point{\n\t\tX: SDK_PackageName.Int(0),\n\t\tY: SDK_PackageName.Int(1),\n\n\t\t// In cases where the API specifies a given type,\n\t\t// but you want to send something else, use `Raw`:\n\t\tZ: SDK_PackageName.Raw[int64](0.01), // sends a float\n\t}),\n}\n```\n\n### Response objects\n\nAll fields in response structs are value types (not pointers or wrappers).\n\nIf a given field is `null`, not present, or invalid, the corresponding field\nwill simply be its zero value.\n\nAll response structs also include a special `JSON` field, containing more detailed\ninformation about each property, which you can use like so:\n\n```go\nif res.Name == "" {\n\t// true if `"name"` is either not present or explicitly null\n\tres.JSON.Name.IsNull()\n\n\t// true if the `"name"` key was not present in the response JSON at all\n\tres.JSON.Name.IsMissing()\n\n\t// When the API returns data that cannot be coerced to the expected type:\n\tif res.JSON.Name.IsInvalid() {\n\t\traw := res.JSON.Name.Raw()\n\n\t\tlegacyName := struct{\n\t\t\tFirst string `json:"first"`\n\t\t\tLast string `json:"last"`\n\t\t}{}\n\t\tjson.Unmarshal([]byte(raw), &legacyName)\n\t\tname = legacyName.First + " " + legacyName.Last\n\t}\n}\n```\n\nThese `.JSON` structs also include an `Extras` map containing\nany properties in the json response that were not specified\nin the struct. This can be useful for API features not yet\npresent in the SDK.\n\n```go\nbody := res.JSON.ExtraFields["my_unexpected_field"].Raw()\n```\n\n### RequestOptions\n\nThis library uses the functional options pattern. Functions defined in the\n`SDK_PackageOptionName` package return a `RequestOption`, which is a closure that mutates a\n`RequestConfig`. These options can be supplied to the client or at individual\nrequests. For example:\n\n```go\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\t// Adds a header to every request made by the client\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "custom_header_info"),\n)\n\nclient.Beta.Indexes.List(context.TODO(), ...,\n\t// Override the header\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "some_other_custom_header_info"),\n\t// Add an undocumented field to the request body, using sjson syntax\n\tSDK_PackageOptionName.WithJSONSet("some.json.path", map[string]string{"my": "object"}),\n)\n```\n\nSee the [full list of request options](https://pkg.go.dev/github.com/run-llama/llama-parse-go/SDK_PackageOptionName).\n\n### Pagination\n\nThis library provides some conveniences for working with paginated list endpoints.\n\nYou can use `.ListAutoPaging()` methods to iterate through items across all pages:\n\n```go\niter := client.Extract.ListAutoPaging(context.TODO(), llamacloud.ExtractListParams{\n\tPageSize: llamacloud.Int(20),\n})\n// Automatically fetches more pages as needed.\nfor iter.Next() {\n\textractV2Job := iter.Current()\n\tfmt.Printf("%+v\\n", extractV2Job)\n}\nif err := iter.Err(); err != nil {\n\tpanic(err.Error())\n}\n```\n\nOr you can use simple `.List()` methods to fetch a single page and receive a standard response object\nwith additional helper methods like `.GetNextPage()`, e.g.:\n\n```go\npage, err := client.Extract.List(context.TODO(), llamacloud.ExtractListParams{\n\tPageSize: llamacloud.Int(20),\n})\nfor page != nil {\n\tfor _, extract := range page.Items {\n\t\tfmt.Printf("%+v\\n", extract)\n\t}\n\tpage, err = page.GetNextPage()\n}\nif err != nil {\n\tpanic(err.Error())\n}\n```\n\n### Errors\n\nWhen the API returns a non-success status code, we return an error with type\n`*SDK_PackageName.Error`. This contains the `StatusCode`, `*http.Request`, and\n`*http.Response` values of the request, as well as the JSON of the error body\n(much like other response objects in the SDK).\n\nTo handle errors, we recommend that you use the `errors.As` pattern:\n\n```go\n_, err := client.Beta.Indexes.List(context.TODO(), llamacloud.BetaIndexListParams{\n\tProjectID: llamacloud.String("my-project-id"),\n})\nif err != nil {\n\tvar apierr *llamacloud.Error\n\tif errors.As(err, &apierr) {\n\t\tprintln(string(apierr.DumpRequest(true))) // Prints the serialized HTTP request\n\t\tprintln(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response\n\t}\n\tpanic(err.Error()) // GET "/api/v1/indexes": 400 Bad Request { ... }\n}\n```\n\nWhen other errors occur, they are returned unwrapped; for example,\nif HTTP transport fails, you might receive `*url.Error` wrapping `*net.OpError`.\n\n### Timeouts\n\nRequests do not time out by default; use context to configure a timeout for a request lifecycle.\n\nNote that if a request is [retried](#retries), the context timeout does not start over.\nTo set a per-retry timeout, use `SDK_PackageOptionName.WithRequestTimeout()`.\n\n```go\n// This sets the timeout for the request, including all the retries.\nctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)\ndefer cancel()\nclient.Beta.Indexes.List(\n\tctx,\n\tllamacloud.BetaIndexListParams{\n\t\tProjectID: llamacloud.String("my-project-id"),\n\t},\n\t// This sets the per-retry timeout\n\toption.WithRequestTimeout(20*time.Second),\n)\n```\n\n### File uploads\n\nRequest parameters that correspond to file uploads in multipart requests are typed as\n`param.Field[io.Reader]`. The contents of the `io.Reader` will by default be sent as a multipart form\npart with the file name of "anonymous_file" and content-type of "application/octet-stream".\n\nThe file name and content-type can be customized by implementing `Name() string` or `ContentType()\nstring` on the run-time type of `io.Reader`. Note that `os.File` implements `Name() string`, so a\nfile returned by `os.Open` will be sent with the file name on disk.\n\nWe also provide a helper `SDK_PackageName.FileParam(reader io.Reader, filename string, contentType string)`\nwhich can be used to wrap any `io.Reader` with the appropriate file name and content type.\n\n```go\n// A file from the file system\nfile, err := os.Open("/path/to/file")\nllamacloud.FileNewParams{\n\tFile: file,\n\tPurpose: "purpose",\n}\n\n// A file from a string\nllamacloud.FileNewParams{\n\tFile: strings.NewReader("my file contents"),\n\tPurpose: "purpose",\n}\n\n// With a custom filename and contentType\nllamacloud.FileNewParams{\n\tFile: llamacloud.File(strings.NewReader(`{"hello": "foo"}`), "file.go", "application/json"),\n\tPurpose: "purpose",\n}\n```\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nWe retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit,\nand >=500 Internal errors.\n\nYou can use the `WithMaxRetries` option to configure or disable this:\n\n```go\n// Configure the default for all requests:\nclient := llamacloud.NewClient(\n\toption.WithMaxRetries(0), // default is 2\n)\n\n// Override per-request:\nclient.Beta.Indexes.List(\n\tcontext.TODO(),\n\tllamacloud.BetaIndexListParams{\n\t\tProjectID: llamacloud.String("my-project-id"),\n\t},\n\toption.WithMaxRetries(5),\n)\n```\n\n\n### Accessing raw response data (e.g. response headers)\n\nYou can access the raw HTTP response data by using the `option.WithResponseInto()` request option. This is useful when\nyou need to examine response headers, status codes, or other details.\n\n```go\n// Create a variable to store the HTTP response\nvar response *http.Response\npage, err := client.Beta.Indexes.List(\n\tcontext.TODO(),\n\tllamacloud.BetaIndexListParams{\n\t\tProjectID: llamacloud.String("my-project-id"),\n\t},\n\toption.WithResponseInto(&response),\n)\nif err != nil {\n\t// handle error\n}\nfmt.Printf("%+v\\n", page)\n\nfmt.Printf("Status Code: %d\\n", response.StatusCode)\nfmt.Printf("Headers: %+#v\\n", response.Header)\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.Get`, `client.Post`, and other HTTP verbs.\n`RequestOptions` on the client, such as retries, will be respected when making these requests.\n\n```go\nvar (\n // params can be an io.Reader, a []byte, an encoding/json serializable object,\n // or a "…Params" struct defined in this library.\n params map[string]interface{}\n\n // result can be an []byte, *http.Response, a encoding/json deserializable object,\n // or a model defined in this library.\n result *http.Response\n)\nerr := client.Post(context.Background(), "/unspecified", params, &result)\nif err != nil {\n …\n}\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use either the `SDK_PackageOptionName.WithQuerySet()`\nor the `SDK_PackageOptionName.WithJSONSet()` methods.\n\n```go\nparams := FooNewParams{\n ID: SDK_PackageName.F("id_xxxx"),\n Data: SDK_PackageName.F(FooNewParamsData{\n FirstName: SDK_PackageName.F("John"),\n }),\n}\nclient.Foo.New(context.Background(), params, SDK_PackageOptionName.WithJSONSet("data.last_name", "Doe"))\n```\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may either access the raw JSON of the response as a string\nwith `result.JSON.RawJSON()`, or get the raw JSON of a particular field on the result with\n`result.JSON.Foo.Raw()`.\n\nAny fields that are not present on the response struct will be saved and can be accessed by `result.JSON.ExtraFields()` which returns the extra fields as a `map[string]Field`.\n\n### Middleware\n\nWe provide `SDK_PackageOptionName.WithMiddleware` which applies the given\nmiddleware to requests.\n\n```go\nfunc Logger(req *http.Request, next SDK_PackageOptionName.MiddlewareNext) (res *http.Response, err error) {\n\t// Before the request\n\tstart := time.Now()\n\tLogReq(req)\n\n\t// Forward the request to the next handler\n\tres, err = next(req)\n\n\t// Handle stuff after the request\n\tend := time.Now()\n\tLogRes(res, err, start - end)\n\n return res, err\n}\n\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\tSDK_PackageOptionName.WithMiddleware(Logger),\n)\n```\n\nWhen multiple middlewares are provided as variadic arguments, the middlewares\nare applied left to right. If `SDK_PackageOptionName.WithMiddleware` is given\nmultiple times, for example first in the client then the method, the\nmiddleware in the client will run first and the middleware given in the method\nwill run next.\n\nYou may also replace the default `http.Client` with\n`SDK_PackageOptionName.WithHTTPClient(client)`. Only one http client is\naccepted (this overwrites any previous client) and receives requests after any\nmiddleware has been applied.\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/run-llama/llama-parse-go/issues) with questions, bugs, or suggestions.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n',
|
|
6259
|
+
content: '# Llama Cloud Go API Library\n\n<a href="https://pkg.go.dev/github.com/run-llama/llama-parse-go"><img src="https://pkg.go.dev/badge/github.com/run-llama/llama-parse-go.svg" alt="Go Reference"></a>\n\nThe Llama Cloud Go library provides convenient access to the [Llama Cloud REST API](https://developers.llamaindex.ai/)\nfrom applications written in Go.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Llama Cloud MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[](https://cursor.com/en-US/install-mcp?name=%40llamaindex%2Fllama-cloud-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsbGFtYWluZGV4L2xsYW1hLWNsb3VkLW1jcCJdLCJlbnYiOnsiTExBTUFfQ0xPVURfQVBJX0tFWSI6Ik15IEFQSSBLZXkifX0)\n[](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40llamaindex%2Fllama-cloud-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40llamaindex%2Fllama-cloud-mcp%22%5D%2C%22env%22%3A%7B%22LLAMA_CLOUD_API_KEY%22%3A%22My%20API%20Key%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n<!-- x-release-please-start-version -->\n\n```go\nimport (\n\t"github.com/run-llama/llama-parse-go" // imported as SDK_PackageName\n)\n```\n\n<!-- x-release-please-end -->\n\nOr to pin the version:\n\n<!-- x-release-please-start-version -->\n\n```sh\ngo get -u \'github.com/run-llama/llama-parse-go@v1.6.0\'\n```\n\n<!-- x-release-please-end -->\n\n## Requirements\n\nThis library requires Go 1.22+.\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```go\npackage main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"), // defaults to os.LookupEnv("LLAMA_CLOUD_API_KEY")\n\t)\n\tparsing, err := client.Parsing.New(context.TODO(), llamacloud.ParsingNewParams{\n\t\tTier: llamacloud.ParsingNewParamsTierAgentic,\n\t\tVersion: llamacloud.ParsingNewParamsVersionLatest,\n\t\tFileID: llamacloud.String("abc1234"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", parsing.ID)\n}\n\n```\n\n### Request fields\n\nAll request parameters are wrapped in a generic `Field` type,\nwhich we use to distinguish zero values from null or omitted fields.\n\nThis prevents accidentally sending a zero value if you forget a required parameter,\nand enables explicitly sending `null`, `false`, `\'\'`, or `0` on optional parameters.\nAny field not specified is not sent.\n\nTo construct fields with values, use the helpers `String()`, `Int()`, `Float()`, or most commonly, the generic `F[T]()`.\nTo send a null, use `Null[T]()`, and to send a nonconforming value, use `Raw[T](any)`. For example:\n\n```go\nparams := FooParams{\n\tName: SDK_PackageName.F("hello"),\n\n\t// Explicitly send `"description": null`\n\tDescription: SDK_PackageName.Null[string](),\n\n\tPoint: SDK_PackageName.F(SDK_PackageName.Point{\n\t\tX: SDK_PackageName.Int(0),\n\t\tY: SDK_PackageName.Int(1),\n\n\t\t// In cases where the API specifies a given type,\n\t\t// but you want to send something else, use `Raw`:\n\t\tZ: SDK_PackageName.Raw[int64](0.01), // sends a float\n\t}),\n}\n```\n\n### Response objects\n\nAll fields in response structs are value types (not pointers or wrappers).\n\nIf a given field is `null`, not present, or invalid, the corresponding field\nwill simply be its zero value.\n\nAll response structs also include a special `JSON` field, containing more detailed\ninformation about each property, which you can use like so:\n\n```go\nif res.Name == "" {\n\t// true if `"name"` is either not present or explicitly null\n\tres.JSON.Name.IsNull()\n\n\t// true if the `"name"` key was not present in the response JSON at all\n\tres.JSON.Name.IsMissing()\n\n\t// When the API returns data that cannot be coerced to the expected type:\n\tif res.JSON.Name.IsInvalid() {\n\t\traw := res.JSON.Name.Raw()\n\n\t\tlegacyName := struct{\n\t\t\tFirst string `json:"first"`\n\t\t\tLast string `json:"last"`\n\t\t}{}\n\t\tjson.Unmarshal([]byte(raw), &legacyName)\n\t\tname = legacyName.First + " " + legacyName.Last\n\t}\n}\n```\n\nThese `.JSON` structs also include an `Extras` map containing\nany properties in the json response that were not specified\nin the struct. This can be useful for API features not yet\npresent in the SDK.\n\n```go\nbody := res.JSON.ExtraFields["my_unexpected_field"].Raw()\n```\n\n### RequestOptions\n\nThis library uses the functional options pattern. Functions defined in the\n`SDK_PackageOptionName` package return a `RequestOption`, which is a closure that mutates a\n`RequestConfig`. These options can be supplied to the client or at individual\nrequests. For example:\n\n```go\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\t// Adds a header to every request made by the client\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "custom_header_info"),\n)\n\nclient.Beta.Indexes.List(context.TODO(), ...,\n\t// Override the header\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "some_other_custom_header_info"),\n\t// Add an undocumented field to the request body, using sjson syntax\n\tSDK_PackageOptionName.WithJSONSet("some.json.path", map[string]string{"my": "object"}),\n)\n```\n\nSee the [full list of request options](https://pkg.go.dev/github.com/run-llama/llama-parse-go/SDK_PackageOptionName).\n\n### Pagination\n\nThis library provides some conveniences for working with paginated list endpoints.\n\nYou can use `.ListAutoPaging()` methods to iterate through items across all pages:\n\n```go\niter := client.Extract.ListAutoPaging(context.TODO(), llamacloud.ExtractListParams{\n\tPageSize: llamacloud.Int(20),\n})\n// Automatically fetches more pages as needed.\nfor iter.Next() {\n\textractV2Job := iter.Current()\n\tfmt.Printf("%+v\\n", extractV2Job)\n}\nif err := iter.Err(); err != nil {\n\tpanic(err.Error())\n}\n```\n\nOr you can use simple `.List()` methods to fetch a single page and receive a standard response object\nwith additional helper methods like `.GetNextPage()`, e.g.:\n\n```go\npage, err := client.Extract.List(context.TODO(), llamacloud.ExtractListParams{\n\tPageSize: llamacloud.Int(20),\n})\nfor page != nil {\n\tfor _, extract := range page.Items {\n\t\tfmt.Printf("%+v\\n", extract)\n\t}\n\tpage, err = page.GetNextPage()\n}\nif err != nil {\n\tpanic(err.Error())\n}\n```\n\n### Errors\n\nWhen the API returns a non-success status code, we return an error with type\n`*SDK_PackageName.Error`. This contains the `StatusCode`, `*http.Request`, and\n`*http.Response` values of the request, as well as the JSON of the error body\n(much like other response objects in the SDK).\n\nTo handle errors, we recommend that you use the `errors.As` pattern:\n\n```go\n_, err := client.Beta.Indexes.List(context.TODO(), llamacloud.BetaIndexListParams{\n\tProjectID: llamacloud.String("my-project-id"),\n})\nif err != nil {\n\tvar apierr *llamacloud.Error\n\tif errors.As(err, &apierr) {\n\t\tprintln(string(apierr.DumpRequest(true))) // Prints the serialized HTTP request\n\t\tprintln(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response\n\t}\n\tpanic(err.Error()) // GET "/api/v1/indexes": 400 Bad Request { ... }\n}\n```\n\nWhen other errors occur, they are returned unwrapped; for example,\nif HTTP transport fails, you might receive `*url.Error` wrapping `*net.OpError`.\n\n### Timeouts\n\nRequests do not time out by default; use context to configure a timeout for a request lifecycle.\n\nNote that if a request is [retried](#retries), the context timeout does not start over.\nTo set a per-retry timeout, use `SDK_PackageOptionName.WithRequestTimeout()`.\n\n```go\n// This sets the timeout for the request, including all the retries.\nctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)\ndefer cancel()\nclient.Beta.Indexes.List(\n\tctx,\n\tllamacloud.BetaIndexListParams{\n\t\tProjectID: llamacloud.String("my-project-id"),\n\t},\n\t// This sets the per-retry timeout\n\toption.WithRequestTimeout(20*time.Second),\n)\n```\n\n### File uploads\n\nRequest parameters that correspond to file uploads in multipart requests are typed as\n`param.Field[io.Reader]`. The contents of the `io.Reader` will by default be sent as a multipart form\npart with the file name of "anonymous_file" and content-type of "application/octet-stream".\n\nThe file name and content-type can be customized by implementing `Name() string` or `ContentType()\nstring` on the run-time type of `io.Reader`. Note that `os.File` implements `Name() string`, so a\nfile returned by `os.Open` will be sent with the file name on disk.\n\nWe also provide a helper `SDK_PackageName.FileParam(reader io.Reader, filename string, contentType string)`\nwhich can be used to wrap any `io.Reader` with the appropriate file name and content type.\n\n```go\n// A file from the file system\nfile, err := os.Open("/path/to/file")\nllamacloud.FileNewParams{\n\tFile: file,\n\tPurpose: "purpose",\n}\n\n// A file from a string\nllamacloud.FileNewParams{\n\tFile: strings.NewReader("my file contents"),\n\tPurpose: "purpose",\n}\n\n// With a custom filename and contentType\nllamacloud.FileNewParams{\n\tFile: llamacloud.File(strings.NewReader(`{"hello": "foo"}`), "file.go", "application/json"),\n\tPurpose: "purpose",\n}\n```\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nWe retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit,\nand >=500 Internal errors.\n\nYou can use the `WithMaxRetries` option to configure or disable this:\n\n```go\n// Configure the default for all requests:\nclient := llamacloud.NewClient(\n\toption.WithMaxRetries(0), // default is 2\n)\n\n// Override per-request:\nclient.Beta.Indexes.List(\n\tcontext.TODO(),\n\tllamacloud.BetaIndexListParams{\n\t\tProjectID: llamacloud.String("my-project-id"),\n\t},\n\toption.WithMaxRetries(5),\n)\n```\n\n\n### Accessing raw response data (e.g. response headers)\n\nYou can access the raw HTTP response data by using the `option.WithResponseInto()` request option. This is useful when\nyou need to examine response headers, status codes, or other details.\n\n```go\n// Create a variable to store the HTTP response\nvar response *http.Response\npage, err := client.Beta.Indexes.List(\n\tcontext.TODO(),\n\tllamacloud.BetaIndexListParams{\n\t\tProjectID: llamacloud.String("my-project-id"),\n\t},\n\toption.WithResponseInto(&response),\n)\nif err != nil {\n\t// handle error\n}\nfmt.Printf("%+v\\n", page)\n\nfmt.Printf("Status Code: %d\\n", response.StatusCode)\nfmt.Printf("Headers: %+#v\\n", response.Header)\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.Get`, `client.Post`, and other HTTP verbs.\n`RequestOptions` on the client, such as retries, will be respected when making these requests.\n\n```go\nvar (\n // params can be an io.Reader, a []byte, an encoding/json serializable object,\n // or a "…Params" struct defined in this library.\n params map[string]interface{}\n\n // result can be an []byte, *http.Response, a encoding/json deserializable object,\n // or a model defined in this library.\n result *http.Response\n)\nerr := client.Post(context.Background(), "/unspecified", params, &result)\nif err != nil {\n …\n}\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use either the `SDK_PackageOptionName.WithQuerySet()`\nor the `SDK_PackageOptionName.WithJSONSet()` methods.\n\n```go\nparams := FooNewParams{\n ID: SDK_PackageName.F("id_xxxx"),\n Data: SDK_PackageName.F(FooNewParamsData{\n FirstName: SDK_PackageName.F("John"),\n }),\n}\nclient.Foo.New(context.Background(), params, SDK_PackageOptionName.WithJSONSet("data.last_name", "Doe"))\n```\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may either access the raw JSON of the response as a string\nwith `result.JSON.RawJSON()`, or get the raw JSON of a particular field on the result with\n`result.JSON.Foo.Raw()`.\n\nAny fields that are not present on the response struct will be saved and can be accessed by `result.JSON.ExtraFields()` which returns the extra fields as a `map[string]Field`.\n\n### Middleware\n\nWe provide `SDK_PackageOptionName.WithMiddleware` which applies the given\nmiddleware to requests.\n\n```go\nfunc Logger(req *http.Request, next SDK_PackageOptionName.MiddlewareNext) (res *http.Response, err error) {\n\t// Before the request\n\tstart := time.Now()\n\tLogReq(req)\n\n\t// Forward the request to the next handler\n\tres, err = next(req)\n\n\t// Handle stuff after the request\n\tend := time.Now()\n\tLogRes(res, err, start - end)\n\n return res, err\n}\n\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\tSDK_PackageOptionName.WithMiddleware(Logger),\n)\n```\n\nWhen multiple middlewares are provided as variadic arguments, the middlewares\nare applied left to right. If `SDK_PackageOptionName.WithMiddleware` is given\nmultiple times, for example first in the client then the method, the\nmiddleware in the client will run first and the middleware given in the method\nwill run next.\n\nYou may also replace the default `http.Client` with\n`SDK_PackageOptionName.WithHTTPClient(client)`. Only one http client is\naccepted (this overwrites any previous client) and receives requests after any\nmiddleware has been applied.\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/run-llama/llama-parse-go/issues) with questions, bugs, or suggestions.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n',
|
|
6317
6260
|
},
|
|
6318
6261
|
{
|
|
6319
6262
|
language: 'python',
|
|
@@ -6321,7 +6264,7 @@ const EMBEDDED_READMES = [
|
|
|
6321
6264
|
},
|
|
6322
6265
|
{
|
|
6323
6266
|
language: 'java',
|
|
6324
|
-
content: '# Llama Cloud Java API Library\n\n<!-- x-release-please-start-version -->\n[](https://central.sonatype.com/artifact/ai.llamaindex.llamacloud/llama-cloud/1.5.1)\n[](https://javadoc.io/doc/ai.llamaindex.llamacloud/llama-cloud/1.5.1)\n<!-- x-release-please-end -->\n\nThe Llama Cloud Java SDK provides convenient access to the [Llama Cloud REST API](https://developers.llamaindex.ai/) from applications written in Java.\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Llama Cloud MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[](https://cursor.com/en-US/install-mcp?name=%40llamaindex%2Fllama-cloud-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsbGFtYWluZGV4L2xsYW1hLWNsb3VkLW1jcCJdLCJlbnYiOnsiTExBTUFfQ0xPVURfQVBJX0tFWSI6Ik15IEFQSSBLZXkifX0)\n[](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40llamaindex%2Fllama-cloud-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40llamaindex%2Fllama-cloud-mcp%22%5D%2C%22env%22%3A%7B%22LLAMA_CLOUD_API_KEY%22%3A%22My%20API%20Key%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n<!-- x-release-please-start-version -->\n\nThe REST API documentation can be found on [developers.llamaindex.ai](https://developers.llamaindex.ai/). Javadocs are available on [javadoc.io](https://javadoc.io/doc/ai.llamaindex.llamacloud/llama-cloud/1.5.1).\n\n<!-- x-release-please-end -->\n\n## Installation\n\n<!-- x-release-please-start-version -->\n\n### Gradle\n\n~~~kotlin\nimplementation("ai.llamaindex:llama-cloud:1.5.1")\n~~~\n\n### Maven\n\n~~~xml\n<dependency>\n <groupId>ai.llamaindex</groupId>\n <artifactId>llama-cloud</artifactId>\n <version>1.5.1</version>\n</dependency>\n~~~\n\n<!-- x-release-please-end -->\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateResponse;\n\n// Configures using the `llamacloud.apiKey` and `llamacloud.baseUrl` system properties\n// Or configures using the `LLAMA_CLOUD_API_KEY` and `LLAMA_CLOUD_BASE_URL` environment variables\nLlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\nParsingCreateParams params = ParsingCreateParams.builder()\n .tier(ParsingCreateParams.Tier.AGENTIC)\n .version(ParsingCreateParams.Version.LATEST)\n .fileId("abc1234")\n .build();\nParsingCreateResponse parsing = client.parsing().create(params);\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\n\n// Configures using the `llamacloud.apiKey` and `llamacloud.baseUrl` system properties\n// Or configures using the `LLAMA_CLOUD_API_KEY` and `LLAMA_CLOUD_BASE_URL` environment variables\nLlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n```\n\nOr manually:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .apiKey("My API Key")\n .build();\n```\n\nOr using a combination of the two approaches:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n // Configures using the `llamacloud.apiKey` and `llamacloud.baseUrl` system properties\n // Or configures using the `LLAMA_CLOUD_API_KEY` and `LLAMA_CLOUD_BASE_URL` environment variables\n .fromEnv()\n .apiKey("My API Key")\n .build();\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------- | -------------------- | ---------------------- | -------- | ----------------------------------- |\n| `apiKey` | `llamacloud.apiKey` | `LLAMA_CLOUD_API_KEY` | true | - |\n| `baseUrl` | `llamacloud.baseUrl` | `LLAMA_CLOUD_BASE_URL` | true | `"https://api.cloud.llamaindex.ai"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don\'t create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\n\nLlamaCloudClient clientWithOptions = client.withOptions(optionsBuilder -> {\n optionsBuilder.baseUrl("https://example.com");\n optionsBuilder.maxRetries(42);\n});\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the Llama Cloud API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.\n\nFor example, `client.parsing().create(...)` should be called with an instance of `ParsingCreateParams`, and it will return an instance of `ParsingCreateResponse`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateResponse;\nimport java.util.concurrent.CompletableFuture;\n\n// Configures using the `llamacloud.apiKey` and `llamacloud.baseUrl` system properties\n// Or configures using the `LLAMA_CLOUD_API_KEY` and `LLAMA_CLOUD_BASE_URL` environment variables\nLlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\nParsingCreateParams params = ParsingCreateParams.builder()\n .tier(ParsingCreateParams.Tier.AGENTIC)\n .version(ParsingCreateParams.Version.LATEST)\n .fileId("abc1234")\n .build();\nCompletableFuture<ParsingCreateResponse> parsing = client.async().parsing().create(params);\n```\n\nOr create an asynchronous client from the beginning:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClientAsync;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClientAsync;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateResponse;\nimport java.util.concurrent.CompletableFuture;\n\n// Configures using the `llamacloud.apiKey` and `llamacloud.baseUrl` system properties\n// Or configures using the `LLAMA_CLOUD_API_KEY` and `LLAMA_CLOUD_BASE_URL` environment variables\nLlamaCloudClientAsync client = LlamaCloudOkHttpClientAsync.fromEnv();\n\nParsingCreateParams params = ParsingCreateParams.builder()\n .tier(ParsingCreateParams.Tier.AGENTIC)\n .version(ParsingCreateParams.Version.LATEST)\n .fileId("abc1234")\n .build();\nCompletableFuture<ParsingCreateResponse> parsing = client.parsing().create(params);\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods return `CompletableFuture`s.\n\n\n\n## File uploads\n\nThe SDK defines methods that accept files.\n\nTo upload a file, pass a [`Path`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html):\n\n```java\nimport ai.llamaindex.llamacloud.models.files.FileCreateParams;\nimport ai.llamaindex.llamacloud.models.files.FileCreateResponse;\nimport java.nio.file.Paths;\n\nFileCreateParams params = FileCreateParams.builder()\n .purpose("purpose")\n .file(Paths.get("/path/to/file"))\n .build();\nFileCreateResponse file = client.files().create(params);\n```\n\nOr an arbitrary [`InputStream`](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html):\n\n```java\nimport ai.llamaindex.llamacloud.models.files.FileCreateParams;\nimport ai.llamaindex.llamacloud.models.files.FileCreateResponse;\nimport java.net.URL;\n\nFileCreateParams params = FileCreateParams.builder()\n .purpose("purpose")\n .file(new URL("https://example.com//path/to/file").openStream())\n .build();\nFileCreateResponse file = client.files().create(params);\n```\n\nOr a `byte[]` array:\n\n```java\nimport ai.llamaindex.llamacloud.models.files.FileCreateParams;\nimport ai.llamaindex.llamacloud.models.files.FileCreateResponse;\n\nFileCreateParams params = FileCreateParams.builder()\n .purpose("purpose")\n .file("content".getBytes())\n .build();\nFileCreateResponse file = client.files().create(params);\n```\n\nNote that when passing a non-`Path` its filename is unknown so it will not be included in the request. To manually set a filename, pass a [`MultipartField`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/core/Values.kt):\n\n```java\nimport ai.llamaindex.llamacloud.core.MultipartField;\nimport ai.llamaindex.llamacloud.models.files.FileCreateParams;\nimport ai.llamaindex.llamacloud.models.files.FileCreateResponse;\nimport java.io.InputStream;\nimport java.net.URL;\n\nFileCreateParams params = FileCreateParams.builder()\n .purpose("purpose")\n .file(MultipartField.<InputStream>builder()\n .value(new URL("https://example.com//path/to/file").openStream())\n .filename("/path/to/file")\n .build())\n .build();\nFileCreateResponse file = client.files().create(params);\n```\n\n\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Java classes. However, these methods don\'t provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```java\nimport ai.llamaindex.llamacloud.core.http.Headers;\nimport ai.llamaindex.llamacloud.core.http.HttpResponseFor;\nimport ai.llamaindex.llamacloud.models.beta.indexes.IndexListPage;\nimport ai.llamaindex.llamacloud.models.beta.indexes.IndexListParams;\n\nIndexListParams params = IndexListParams.builder()\n .projectId("my-project-id")\n .build();\nHttpResponseFor<IndexListPage> page = client.beta().indexes().withRawResponse().list(params);\n\nint statusCode = page.statusCode();\nHeaders headers = page.headers();\n```\n\nYou can still deserialize the response into an instance of a Java class if needed:\n\n```java\nimport ai.llamaindex.llamacloud.models.beta.indexes.IndexListPage;\n\nIndexListPage parsedPage = page.parse();\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`LlamaCloudServiceException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/LlamaCloudServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/UnexpectedStatusCodeException.kt) |\n\n- [`LlamaCloudIoException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/LlamaCloudIoException.kt): I/O networking errors.\n\n- [`LlamaCloudRetryableException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/LlamaCloudRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`LlamaCloudInvalidDataException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/LlamaCloudInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that\'s supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`LlamaCloudException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/LlamaCloudException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns an [`Iterable`](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html)\n\n```java\nimport ai.llamaindex.llamacloud.models.extract.ExtractListPage;\nimport ai.llamaindex.llamacloud.models.extract.ExtractV2Job;\n\nExtractListPage page = client.extract().list();\n\n// Process as an Iterable\nfor (ExtractV2Job extract : page.autoPager()) {\n System.out.println(extract);\n}\n\n// Process as a Stream\npage.autoPager()\n .stream()\n .limit(50)\n .forEach(extract -> System.out.println(extract));\n```\n\nWhen using the asynchronous client, the method returns an [`AsyncStreamResponse`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/core/http/AsyncStreamResponse.kt):\n\n```java\nimport ai.llamaindex.llamacloud.core.http.AsyncStreamResponse;\nimport ai.llamaindex.llamacloud.models.extract.ExtractListPageAsync;\nimport ai.llamaindex.llamacloud.models.extract.ExtractV2Job;\nimport java.util.Optional;\nimport java.util.concurrent.CompletableFuture;\n\nCompletableFuture<ExtractListPageAsync> pageFuture = client.async().extract().list();\n\npageFuture.thenRun(page -> page.autoPager().subscribe(extract -> {\n System.out.println(extract);\n}));\n\n// If you need to handle errors or completion of the stream\npageFuture.thenRun(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {\n @Override\n public void onNext(ExtractV2Job extract) {\n System.out.println(extract);\n }\n\n @Override\n public void onComplete(Optional<Throwable> error) {\n if (error.isPresent()) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error.get());\n } else {\n System.out.println("No more!");\n }\n }\n}));\n\n// Or use futures\npageFuture.thenRun(page -> page.autoPager()\n .subscribe(extract -> {\n System.out.println(extract);\n })\n .onCompleteFuture()\n .whenComplete((unused, error) -> {\n if (error != null) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error);\n } else {\n System.out.println("No more!");\n }\n }));\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```java\nimport ai.llamaindex.llamacloud.models.extract.ExtractListPage;\nimport ai.llamaindex.llamacloud.models.extract.ExtractV2Job;\n\nExtractListPage page = client.extract().list();\nwhile (true) {\n for (ExtractV2Job extract : page.items()) {\n System.out.println(extract);\n }\n\n if (!page.hasNextPage()) {\n break;\n }\n\n page = page.nextPage();\n}\n```\n\n## Logging\n\nEnable logging by setting the `LLAMA_CLOUD_LOG` environment variable to `info`:\n\n```sh\nexport LLAMA_CLOUD_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport LLAMA_CLOUD_LOG=debug\n```\n\nOr configure the client manually using the `logLevel` method:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.core.LogLevel;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n .logLevel(LogLevel.INFO)\n .build();\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `llama-cloud-core` is published with a [configuration file](llama-cloud-core/src/main/resources/META-INF/proguard/llama-cloud-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you\'re _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`LlamaCloudOkHttpClient`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClient.kt) or [`LlamaCloudOkHttpClientAsync`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don\'t work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .build();\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```java\nimport ai.llamaindex.llamacloud.models.beta.indexes.IndexListPage;\n\nIndexListPage page = client.beta().indexes().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport java.time.Duration;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .build();\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport java.net.InetSocketAddress;\nimport java.net.Proxy;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n .proxy(new Proxy(\n Proxy.Type.HTTP, new InetSocketAddress(\n "https://example.com", 8080\n )\n ))\n .build();\n```\n\nIf the proxy responds with `407 Proxy Authentication Required`, supply credentials by also configuring `proxyAuthenticator`:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.core.http.ProxyAuthenticator;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n .proxy(...)\n // Or a custom implementation of `ProxyAuthenticator`.\n .proxyAuthenticator(ProxyAuthenticator.basic("username", "password"))\n .build();\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport java.time.Duration;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .build();\n```\n\nIf both options are unset, OkHttp\'s default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .build();\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `llama-cloud-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`LlamaCloudClient`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClient.kt), [`LlamaCloudClientAsync`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientAsync.kt), [`LlamaCloudClientImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientImpl.kt), and [`LlamaCloudClientAsyncImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientAsyncImpl.kt), all of which can work with any HTTP client\n- `llama-cloud-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`LlamaCloudOkHttpClient`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClient.kt) and [`LlamaCloudOkHttpClientAsync`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClientAsync.kt), which provide a way to construct [`LlamaCloudClientImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientImpl.kt) and [`LlamaCloudClientAsyncImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientAsyncImpl.kt), respectively, using OkHttp\n- `llama-cloud`\n - Depends on and exposes the APIs of both `llama-cloud-core` and `llama-cloud-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK\'s default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`llama-cloud` dependency](#installation) with `llama-cloud-core`\n2. Copy `llama-cloud-client-okhttp`\'s [`OkHttpClient`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`LlamaCloudClientImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientImpl.kt) or [`LlamaCloudClientAsyncImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientAsyncImpl.kt), similarly to [`LlamaCloudOkHttpClient`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClient.kt) or [`LlamaCloudOkHttpClientAsync`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`llama-cloud` dependency](#installation) with `llama-cloud-core`\n2. Write a class that implements the [`HttpClient`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/core/http/HttpClient.kt) interface\n3. Construct [`LlamaCloudClientImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientImpl.kt) or [`LlamaCloudClientAsyncImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientAsyncImpl.kt), similarly to [`LlamaCloudOkHttpClient`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClient.kt) or [`LlamaCloudOkHttpClientAsync`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```java\nimport ai.llamaindex.llamacloud.core.JsonValue;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\n\nParsingCreateParams params = ParsingCreateParams.builder()\n .putAdditionalHeader("Secret-Header", "42")\n .putAdditionalQueryParam("secret_query_param", "42")\n .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))\n .build();\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set undocumented parameters on _nested_ headers, query params, or body classes, call the `putAdditionalProperty` method on the nested class:\n\n```java\nimport ai.llamaindex.llamacloud.core.JsonValue;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\n\nParsingCreateParams params = ParsingCreateParams.builder()\n .agenticOptions(ParsingCreateParams.AgenticOptions.builder()\n .putAdditionalProperty("secretProperty", JsonValue.from("42"))\n .build())\n .build();\n```\n\nThese properties can be accessed on the nested built object later using the `_additionalProperties()` method.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/core/Values.kt) object to its setter:\n\n```java\nimport ai.llamaindex.llamacloud.core.JsonValue;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\n\nParsingCreateParams params = ParsingCreateParams.builder()\n .tier(JsonValue.from(42))\n .version(ParsingCreateParams.Version.LATEST)\n .fileId("abc1234")\n .build();\n```\n\nThe most straightforward way to create a [`JsonValue`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/core/Values.kt) is using its `from(...)` method:\n\n```java\nimport ai.llamaindex.llamacloud.core.JsonValue;\nimport java.util.List;\nimport java.util.Map;\n\n// Create primitive JSON values\nJsonValue nullValue = JsonValue.from(null);\nJsonValue booleanValue = JsonValue.from(true);\nJsonValue numberValue = JsonValue.from(42);\nJsonValue stringValue = JsonValue.from("Hello World!");\n\n// Create a JSON array value equivalent to `["Hello", "World"]`\nJsonValue arrayValue = JsonValue.from(List.of(\n "Hello", "World"\n));\n\n// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`\nJsonValue objectValue = JsonValue.from(Map.of(\n "a", 1,\n "b", 2\n));\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// "a": [1, 2],\n// "b": [3, 4]\n// }\nJsonValue complexValue = JsonValue.from(Map.of(\n "a", List.of(\n 1, 2\n ),\n "b", List.of(\n 3, 4\n )\n));\n```\n\nNormally a `Builder` class\'s `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/core/Values.kt):\n\n```java\nimport ai.llamaindex.llamacloud.core.JsonMissing;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\n\nParsingCreateParams params = ParsingCreateParams.builder()\n .version(ParsingCreateParams.Version.LATEST)\n .tier(JsonMissing.of())\n .build();\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```java\nimport ai.llamaindex.llamacloud.core.JsonValue;\nimport java.util.Map;\n\nMap<String, JsonValue> additionalProperties = client.parsing().create(params)._additionalProperties();\nJsonValue secretPropertyValue = additionalProperties.get("secretProperty");\n\nString result = secretPropertyValue.accept(new JsonValue.Visitor<>() {\n @Override\n public String visitNull() {\n return "It\'s null!";\n }\n\n @Override\n public String visitBoolean(boolean value) {\n return "It\'s a boolean!";\n }\n\n @Override\n public String visitNumber(Number value) {\n return "It\'s a number!";\n }\n\n // Other methods include `visitMissing`, `visitString`, `visitArray`, and `visitObject`\n // The default implementation of each unimplemented method delegates to `visitDefault`, which throws by default, but can also be overridden\n});\n```\n\nTo access a property\'s raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```java\nimport ai.llamaindex.llamacloud.core.JsonField;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\nimport java.util.Optional;\n\nJsonField<ParsingCreateParams.Tier> tier = client.parsing().create(params)._tier();\n\nif (tier.isMissing()) {\n // The property is absent from the JSON response\n} else if (tier.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n Optional<String> jsonString = tier.asString();\n\n // Try to deserialize into a custom type\n MyClass myObject = tier.asUnknown().orElseThrow().convert(MyClass.class);\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn\'t match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`LlamaCloudInvalidDataException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/LlamaCloudInvalidDataException.kt) only if you directly access the property.\n\nValidating the response is _not_ forwards compatible with new types from the API for existing fields.\n\nIf you would still prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```java\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateResponse;\n\nParsingCreateResponse parsing = client.parsing().create(params).validate();\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```java\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateResponse;\n\nParsingCreateResponse parsing = client.parsing().create(\n params, RequestOptions.builder().responseValidation(true).build()\n);\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .build();\n```\n\n## FAQ\n\n### Why don\'t you use plain `enum` classes?\n\nJava `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField<T>` instead of just plain `T`?\n\nUsing `JsonField<T>` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don\'t you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don\'t want to introduce a breaking change every time we add a field to a class.\n\n### Why don\'t you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don\'t play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/run-llama/llama-parse-java/issues) with questions, bugs, or suggestions.\n',
|
|
6267
|
+
content: '# Llama Cloud Java API Library\n\n<!-- x-release-please-start-version -->\n[](https://central.sonatype.com/artifact/ai.llamaindex.llamacloud/llama-cloud/1.6.0)\n[](https://javadoc.io/doc/ai.llamaindex.llamacloud/llama-cloud/1.6.0)\n<!-- x-release-please-end -->\n\nThe Llama Cloud Java SDK provides convenient access to the [Llama Cloud REST API](https://developers.llamaindex.ai/) from applications written in Java.\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Llama Cloud MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[](https://cursor.com/en-US/install-mcp?name=%40llamaindex%2Fllama-cloud-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsbGFtYWluZGV4L2xsYW1hLWNsb3VkLW1jcCJdLCJlbnYiOnsiTExBTUFfQ0xPVURfQVBJX0tFWSI6Ik15IEFQSSBLZXkifX0)\n[](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40llamaindex%2Fllama-cloud-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40llamaindex%2Fllama-cloud-mcp%22%5D%2C%22env%22%3A%7B%22LLAMA_CLOUD_API_KEY%22%3A%22My%20API%20Key%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n<!-- x-release-please-start-version -->\n\nThe REST API documentation can be found on [developers.llamaindex.ai](https://developers.llamaindex.ai/). Javadocs are available on [javadoc.io](https://javadoc.io/doc/ai.llamaindex.llamacloud/llama-cloud/1.6.0).\n\n<!-- x-release-please-end -->\n\n## Installation\n\n<!-- x-release-please-start-version -->\n\n### Gradle\n\n~~~kotlin\nimplementation("ai.llamaindex:llama-cloud:1.6.0")\n~~~\n\n### Maven\n\n~~~xml\n<dependency>\n <groupId>ai.llamaindex</groupId>\n <artifactId>llama-cloud</artifactId>\n <version>1.6.0</version>\n</dependency>\n~~~\n\n<!-- x-release-please-end -->\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateResponse;\n\n// Configures using the `llamacloud.apiKey` and `llamacloud.baseUrl` system properties\n// Or configures using the `LLAMA_CLOUD_API_KEY` and `LLAMA_CLOUD_BASE_URL` environment variables\nLlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\nParsingCreateParams params = ParsingCreateParams.builder()\n .tier(ParsingCreateParams.Tier.AGENTIC)\n .version(ParsingCreateParams.Version.LATEST)\n .fileId("abc1234")\n .build();\nParsingCreateResponse parsing = client.parsing().create(params);\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\n\n// Configures using the `llamacloud.apiKey` and `llamacloud.baseUrl` system properties\n// Or configures using the `LLAMA_CLOUD_API_KEY` and `LLAMA_CLOUD_BASE_URL` environment variables\nLlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n```\n\nOr manually:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .apiKey("My API Key")\n .build();\n```\n\nOr using a combination of the two approaches:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n // Configures using the `llamacloud.apiKey` and `llamacloud.baseUrl` system properties\n // Or configures using the `LLAMA_CLOUD_API_KEY` and `LLAMA_CLOUD_BASE_URL` environment variables\n .fromEnv()\n .apiKey("My API Key")\n .build();\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------- | -------------------- | ---------------------- | -------- | ----------------------------------- |\n| `apiKey` | `llamacloud.apiKey` | `LLAMA_CLOUD_API_KEY` | true | - |\n| `baseUrl` | `llamacloud.baseUrl` | `LLAMA_CLOUD_BASE_URL` | true | `"https://api.cloud.llamaindex.ai"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don\'t create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\n\nLlamaCloudClient clientWithOptions = client.withOptions(optionsBuilder -> {\n optionsBuilder.baseUrl("https://example.com");\n optionsBuilder.maxRetries(42);\n});\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the Llama Cloud API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.\n\nFor example, `client.parsing().create(...)` should be called with an instance of `ParsingCreateParams`, and it will return an instance of `ParsingCreateResponse`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateResponse;\nimport java.util.concurrent.CompletableFuture;\n\n// Configures using the `llamacloud.apiKey` and `llamacloud.baseUrl` system properties\n// Or configures using the `LLAMA_CLOUD_API_KEY` and `LLAMA_CLOUD_BASE_URL` environment variables\nLlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\nParsingCreateParams params = ParsingCreateParams.builder()\n .tier(ParsingCreateParams.Tier.AGENTIC)\n .version(ParsingCreateParams.Version.LATEST)\n .fileId("abc1234")\n .build();\nCompletableFuture<ParsingCreateResponse> parsing = client.async().parsing().create(params);\n```\n\nOr create an asynchronous client from the beginning:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClientAsync;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClientAsync;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateResponse;\nimport java.util.concurrent.CompletableFuture;\n\n// Configures using the `llamacloud.apiKey` and `llamacloud.baseUrl` system properties\n// Or configures using the `LLAMA_CLOUD_API_KEY` and `LLAMA_CLOUD_BASE_URL` environment variables\nLlamaCloudClientAsync client = LlamaCloudOkHttpClientAsync.fromEnv();\n\nParsingCreateParams params = ParsingCreateParams.builder()\n .tier(ParsingCreateParams.Tier.AGENTIC)\n .version(ParsingCreateParams.Version.LATEST)\n .fileId("abc1234")\n .build();\nCompletableFuture<ParsingCreateResponse> parsing = client.parsing().create(params);\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods return `CompletableFuture`s.\n\n\n\n## File uploads\n\nThe SDK defines methods that accept files.\n\nTo upload a file, pass a [`Path`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html):\n\n```java\nimport ai.llamaindex.llamacloud.models.files.FileCreateParams;\nimport ai.llamaindex.llamacloud.models.files.FileCreateResponse;\nimport java.nio.file.Paths;\n\nFileCreateParams params = FileCreateParams.builder()\n .purpose("purpose")\n .file(Paths.get("/path/to/file"))\n .build();\nFileCreateResponse file = client.files().create(params);\n```\n\nOr an arbitrary [`InputStream`](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html):\n\n```java\nimport ai.llamaindex.llamacloud.models.files.FileCreateParams;\nimport ai.llamaindex.llamacloud.models.files.FileCreateResponse;\nimport java.net.URL;\n\nFileCreateParams params = FileCreateParams.builder()\n .purpose("purpose")\n .file(new URL("https://example.com//path/to/file").openStream())\n .build();\nFileCreateResponse file = client.files().create(params);\n```\n\nOr a `byte[]` array:\n\n```java\nimport ai.llamaindex.llamacloud.models.files.FileCreateParams;\nimport ai.llamaindex.llamacloud.models.files.FileCreateResponse;\n\nFileCreateParams params = FileCreateParams.builder()\n .purpose("purpose")\n .file("content".getBytes())\n .build();\nFileCreateResponse file = client.files().create(params);\n```\n\nNote that when passing a non-`Path` its filename is unknown so it will not be included in the request. To manually set a filename, pass a [`MultipartField`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/core/Values.kt):\n\n```java\nimport ai.llamaindex.llamacloud.core.MultipartField;\nimport ai.llamaindex.llamacloud.models.files.FileCreateParams;\nimport ai.llamaindex.llamacloud.models.files.FileCreateResponse;\nimport java.io.InputStream;\nimport java.net.URL;\n\nFileCreateParams params = FileCreateParams.builder()\n .purpose("purpose")\n .file(MultipartField.<InputStream>builder()\n .value(new URL("https://example.com//path/to/file").openStream())\n .filename("/path/to/file")\n .build())\n .build();\nFileCreateResponse file = client.files().create(params);\n```\n\n\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Java classes. However, these methods don\'t provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```java\nimport ai.llamaindex.llamacloud.core.http.Headers;\nimport ai.llamaindex.llamacloud.core.http.HttpResponseFor;\nimport ai.llamaindex.llamacloud.models.beta.indexes.IndexListPage;\nimport ai.llamaindex.llamacloud.models.beta.indexes.IndexListParams;\n\nIndexListParams params = IndexListParams.builder()\n .projectId("my-project-id")\n .build();\nHttpResponseFor<IndexListPage> page = client.beta().indexes().withRawResponse().list(params);\n\nint statusCode = page.statusCode();\nHeaders headers = page.headers();\n```\n\nYou can still deserialize the response into an instance of a Java class if needed:\n\n```java\nimport ai.llamaindex.llamacloud.models.beta.indexes.IndexListPage;\n\nIndexListPage parsedPage = page.parse();\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`LlamaCloudServiceException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/LlamaCloudServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/UnexpectedStatusCodeException.kt) |\n\n- [`LlamaCloudIoException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/LlamaCloudIoException.kt): I/O networking errors.\n\n- [`LlamaCloudRetryableException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/LlamaCloudRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`LlamaCloudInvalidDataException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/LlamaCloudInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that\'s supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`LlamaCloudException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/LlamaCloudException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns an [`Iterable`](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html)\n\n```java\nimport ai.llamaindex.llamacloud.models.extract.ExtractListPage;\nimport ai.llamaindex.llamacloud.models.extract.ExtractV2Job;\n\nExtractListPage page = client.extract().list();\n\n// Process as an Iterable\nfor (ExtractV2Job extract : page.autoPager()) {\n System.out.println(extract);\n}\n\n// Process as a Stream\npage.autoPager()\n .stream()\n .limit(50)\n .forEach(extract -> System.out.println(extract));\n```\n\nWhen using the asynchronous client, the method returns an [`AsyncStreamResponse`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/core/http/AsyncStreamResponse.kt):\n\n```java\nimport ai.llamaindex.llamacloud.core.http.AsyncStreamResponse;\nimport ai.llamaindex.llamacloud.models.extract.ExtractListPageAsync;\nimport ai.llamaindex.llamacloud.models.extract.ExtractV2Job;\nimport java.util.Optional;\nimport java.util.concurrent.CompletableFuture;\n\nCompletableFuture<ExtractListPageAsync> pageFuture = client.async().extract().list();\n\npageFuture.thenRun(page -> page.autoPager().subscribe(extract -> {\n System.out.println(extract);\n}));\n\n// If you need to handle errors or completion of the stream\npageFuture.thenRun(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {\n @Override\n public void onNext(ExtractV2Job extract) {\n System.out.println(extract);\n }\n\n @Override\n public void onComplete(Optional<Throwable> error) {\n if (error.isPresent()) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error.get());\n } else {\n System.out.println("No more!");\n }\n }\n}));\n\n// Or use futures\npageFuture.thenRun(page -> page.autoPager()\n .subscribe(extract -> {\n System.out.println(extract);\n })\n .onCompleteFuture()\n .whenComplete((unused, error) -> {\n if (error != null) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error);\n } else {\n System.out.println("No more!");\n }\n }));\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```java\nimport ai.llamaindex.llamacloud.models.extract.ExtractListPage;\nimport ai.llamaindex.llamacloud.models.extract.ExtractV2Job;\n\nExtractListPage page = client.extract().list();\nwhile (true) {\n for (ExtractV2Job extract : page.items()) {\n System.out.println(extract);\n }\n\n if (!page.hasNextPage()) {\n break;\n }\n\n page = page.nextPage();\n}\n```\n\n## Logging\n\nEnable logging by setting the `LLAMA_CLOUD_LOG` environment variable to `info`:\n\n```sh\nexport LLAMA_CLOUD_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport LLAMA_CLOUD_LOG=debug\n```\n\nOr configure the client manually using the `logLevel` method:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.core.LogLevel;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n .logLevel(LogLevel.INFO)\n .build();\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `llama-cloud-core` is published with a [configuration file](llama-cloud-core/src/main/resources/META-INF/proguard/llama-cloud-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you\'re _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`LlamaCloudOkHttpClient`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClient.kt) or [`LlamaCloudOkHttpClientAsync`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don\'t work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .build();\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```java\nimport ai.llamaindex.llamacloud.models.beta.indexes.IndexListPage;\n\nIndexListPage page = client.beta().indexes().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport java.time.Duration;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .build();\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport java.net.InetSocketAddress;\nimport java.net.Proxy;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n .proxy(new Proxy(\n Proxy.Type.HTTP, new InetSocketAddress(\n "https://example.com", 8080\n )\n ))\n .build();\n```\n\nIf the proxy responds with `407 Proxy Authentication Required`, supply credentials by also configuring `proxyAuthenticator`:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.core.http.ProxyAuthenticator;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n .proxy(...)\n // Or a custom implementation of `ProxyAuthenticator`.\n .proxyAuthenticator(ProxyAuthenticator.basic("username", "password"))\n .build();\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport java.time.Duration;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .build();\n```\n\nIf both options are unset, OkHttp\'s default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .build();\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `llama-cloud-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`LlamaCloudClient`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClient.kt), [`LlamaCloudClientAsync`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientAsync.kt), [`LlamaCloudClientImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientImpl.kt), and [`LlamaCloudClientAsyncImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientAsyncImpl.kt), all of which can work with any HTTP client\n- `llama-cloud-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`LlamaCloudOkHttpClient`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClient.kt) and [`LlamaCloudOkHttpClientAsync`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClientAsync.kt), which provide a way to construct [`LlamaCloudClientImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientImpl.kt) and [`LlamaCloudClientAsyncImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientAsyncImpl.kt), respectively, using OkHttp\n- `llama-cloud`\n - Depends on and exposes the APIs of both `llama-cloud-core` and `llama-cloud-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK\'s default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`llama-cloud` dependency](#installation) with `llama-cloud-core`\n2. Copy `llama-cloud-client-okhttp`\'s [`OkHttpClient`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`LlamaCloudClientImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientImpl.kt) or [`LlamaCloudClientAsyncImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientAsyncImpl.kt), similarly to [`LlamaCloudOkHttpClient`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClient.kt) or [`LlamaCloudOkHttpClientAsync`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`llama-cloud` dependency](#installation) with `llama-cloud-core`\n2. Write a class that implements the [`HttpClient`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/core/http/HttpClient.kt) interface\n3. Construct [`LlamaCloudClientImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientImpl.kt) or [`LlamaCloudClientAsyncImpl`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/client/LlamaCloudClientAsyncImpl.kt), similarly to [`LlamaCloudOkHttpClient`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClient.kt) or [`LlamaCloudOkHttpClientAsync`](llama-cloud-client-okhttp/src/main/kotlin/ai/llamaindex/llamacloud/client/okhttp/LlamaCloudOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```java\nimport ai.llamaindex.llamacloud.core.JsonValue;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\n\nParsingCreateParams params = ParsingCreateParams.builder()\n .putAdditionalHeader("Secret-Header", "42")\n .putAdditionalQueryParam("secret_query_param", "42")\n .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))\n .build();\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set undocumented parameters on _nested_ headers, query params, or body classes, call the `putAdditionalProperty` method on the nested class:\n\n```java\nimport ai.llamaindex.llamacloud.core.JsonValue;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\n\nParsingCreateParams params = ParsingCreateParams.builder()\n .agenticOptions(ParsingCreateParams.AgenticOptions.builder()\n .putAdditionalProperty("secretProperty", JsonValue.from("42"))\n .build())\n .build();\n```\n\nThese properties can be accessed on the nested built object later using the `_additionalProperties()` method.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/core/Values.kt) object to its setter:\n\n```java\nimport ai.llamaindex.llamacloud.core.JsonValue;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\n\nParsingCreateParams params = ParsingCreateParams.builder()\n .tier(JsonValue.from(42))\n .version(ParsingCreateParams.Version.LATEST)\n .fileId("abc1234")\n .build();\n```\n\nThe most straightforward way to create a [`JsonValue`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/core/Values.kt) is using its `from(...)` method:\n\n```java\nimport ai.llamaindex.llamacloud.core.JsonValue;\nimport java.util.List;\nimport java.util.Map;\n\n// Create primitive JSON values\nJsonValue nullValue = JsonValue.from(null);\nJsonValue booleanValue = JsonValue.from(true);\nJsonValue numberValue = JsonValue.from(42);\nJsonValue stringValue = JsonValue.from("Hello World!");\n\n// Create a JSON array value equivalent to `["Hello", "World"]`\nJsonValue arrayValue = JsonValue.from(List.of(\n "Hello", "World"\n));\n\n// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`\nJsonValue objectValue = JsonValue.from(Map.of(\n "a", 1,\n "b", 2\n));\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// "a": [1, 2],\n// "b": [3, 4]\n// }\nJsonValue complexValue = JsonValue.from(Map.of(\n "a", List.of(\n 1, 2\n ),\n "b", List.of(\n 3, 4\n )\n));\n```\n\nNormally a `Builder` class\'s `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/core/Values.kt):\n\n```java\nimport ai.llamaindex.llamacloud.core.JsonMissing;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\n\nParsingCreateParams params = ParsingCreateParams.builder()\n .version(ParsingCreateParams.Version.LATEST)\n .tier(JsonMissing.of())\n .build();\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```java\nimport ai.llamaindex.llamacloud.core.JsonValue;\nimport java.util.Map;\n\nMap<String, JsonValue> additionalProperties = client.parsing().create(params)._additionalProperties();\nJsonValue secretPropertyValue = additionalProperties.get("secretProperty");\n\nString result = secretPropertyValue.accept(new JsonValue.Visitor<>() {\n @Override\n public String visitNull() {\n return "It\'s null!";\n }\n\n @Override\n public String visitBoolean(boolean value) {\n return "It\'s a boolean!";\n }\n\n @Override\n public String visitNumber(Number value) {\n return "It\'s a number!";\n }\n\n // Other methods include `visitMissing`, `visitString`, `visitArray`, and `visitObject`\n // The default implementation of each unimplemented method delegates to `visitDefault`, which throws by default, but can also be overridden\n});\n```\n\nTo access a property\'s raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```java\nimport ai.llamaindex.llamacloud.core.JsonField;\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateParams;\nimport java.util.Optional;\n\nJsonField<ParsingCreateParams.Tier> tier = client.parsing().create(params)._tier();\n\nif (tier.isMissing()) {\n // The property is absent from the JSON response\n} else if (tier.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n Optional<String> jsonString = tier.asString();\n\n // Try to deserialize into a custom type\n MyClass myObject = tier.asUnknown().orElseThrow().convert(MyClass.class);\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn\'t match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`LlamaCloudInvalidDataException`](llama-cloud-core/src/main/kotlin/ai/llamaindex/llamacloud/errors/LlamaCloudInvalidDataException.kt) only if you directly access the property.\n\nValidating the response is _not_ forwards compatible with new types from the API for existing fields.\n\nIf you would still prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```java\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateResponse;\n\nParsingCreateResponse parsing = client.parsing().create(params).validate();\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```java\nimport ai.llamaindex.llamacloud.models.parsing.ParsingCreateResponse;\n\nParsingCreateResponse parsing = client.parsing().create(\n params, RequestOptions.builder().responseValidation(true).build()\n);\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\n\nLlamaCloudClient client = LlamaCloudOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .build();\n```\n\n## FAQ\n\n### Why don\'t you use plain `enum` classes?\n\nJava `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField<T>` instead of just plain `T`?\n\nUsing `JsonField<T>` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don\'t you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don\'t want to introduce a breaking change every time we add a field to a class.\n\n### Why don\'t you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don\'t play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/run-llama/llama-parse-java/issues) with questions, bugs, or suggestions.\n',
|
|
6325
6268
|
},
|
|
6326
6269
|
{
|
|
6327
6270
|
language: 'csharp',
|