@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/src/local-docs-search.ts
CHANGED
|
@@ -186,7 +186,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
186
186
|
response:
|
|
187
187
|
'{ 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; }',
|
|
188
188
|
markdown:
|
|
189
|
-
"## 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
|
|
189
|
+
"## 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```",
|
|
190
190
|
perLanguage: {
|
|
191
191
|
go: {
|
|
192
192
|
method: 'client.Files.List',
|
|
@@ -387,16 +387,16 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
387
387
|
'file_input: string;',
|
|
388
388
|
'organization_id?: string;',
|
|
389
389
|
'project_id?: string;',
|
|
390
|
-
"configuration?: { categories: { name: string; description?: string; }[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; };",
|
|
390
|
+
"configuration?: { categories: { name: string; description?: string; }[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; };",
|
|
391
391
|
'configuration_id?: string;',
|
|
392
392
|
'transaction_id?: string;',
|
|
393
393
|
'webhook_configuration_ids?: string[];',
|
|
394
394
|
'webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[];',
|
|
395
395
|
],
|
|
396
396
|
response:
|
|
397
|
-
"{ 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; }",
|
|
397
|
+
"{ 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; }",
|
|
398
398
|
markdown:
|
|
399
|
-
"## 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```",
|
|
399
|
+
"## 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```",
|
|
400
400
|
perLanguage: {
|
|
401
401
|
go: {
|
|
402
402
|
method: 'client.Split.New',
|
|
@@ -453,9 +453,9 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
453
453
|
"status?: 'cancelled' | 'completed' | 'failed' | 'pending' | 'processing';",
|
|
454
454
|
],
|
|
455
455
|
response:
|
|
456
|
-
"{ 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; }",
|
|
456
|
+
"{ 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; }",
|
|
457
457
|
markdown:
|
|
458
|
-
"## 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```",
|
|
458
|
+
"## 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```",
|
|
459
459
|
perLanguage: {
|
|
460
460
|
go: {
|
|
461
461
|
method: 'client.Split.List',
|
|
@@ -502,9 +502,9 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
502
502
|
qualified: 'client.split.get',
|
|
503
503
|
params: ['split_job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
504
504
|
response:
|
|
505
|
-
"{ 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; }",
|
|
505
|
+
"{ 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; }",
|
|
506
506
|
markdown:
|
|
507
|
-
"## 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```",
|
|
507
|
+
"## 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```",
|
|
508
508
|
perLanguage: {
|
|
509
509
|
go: {
|
|
510
510
|
method: 'client.Split.Get',
|
|
@@ -600,9 +600,9 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
600
600
|
qualified: 'client.split.cancel',
|
|
601
601
|
params: ['split_job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
602
602
|
response:
|
|
603
|
-
"{ 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; }",
|
|
603
|
+
"{ 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; }",
|
|
604
604
|
markdown:
|
|
605
|
-
"## 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```",
|
|
605
|
+
"## 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```",
|
|
606
606
|
perLanguage: {
|
|
607
607
|
go: {
|
|
608
608
|
method: 'client.Split.Cancel',
|
|
@@ -650,7 +650,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
650
650
|
qualified: 'client.parsing.create',
|
|
651
651
|
params: [
|
|
652
652
|
"tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus' | string;",
|
|
653
|
-
"version: 'latest' | '2026-08-19' | '2026-06-15' | string;",
|
|
653
|
+
"version: 'latest' | '2026-09-07' | '2026-08-19' | '2026-06-15' | string;",
|
|
654
654
|
'organization_id?: string;',
|
|
655
655
|
'project_id?: string;',
|
|
656
656
|
'agentic_options?: { custom_prompt?: string; };',
|
|
@@ -665,7 +665,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
665
665
|
"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; }; };",
|
|
666
666
|
'page_ranges?: { max_pages?: number; target_pages?: string; };',
|
|
667
667
|
'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; }; };',
|
|
668
|
-
"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'; };",
|
|
668
|
+
"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'; };",
|
|
669
669
|
'source_url?: string;',
|
|
670
670
|
'user_metadata?: object;',
|
|
671
671
|
'webhook_configuration_ids?: string[];',
|
|
@@ -674,7 +674,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
674
674
|
response:
|
|
675
675
|
"{ 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; }",
|
|
676
676
|
markdown:
|
|
677
|
-
"## 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```",
|
|
677
|
+
"## 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```",
|
|
678
678
|
perLanguage: {
|
|
679
679
|
go: {
|
|
680
680
|
method: 'client.Parsing.New',
|
|
@@ -876,18 +876,67 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
876
876
|
},
|
|
877
877
|
},
|
|
878
878
|
},
|
|
879
|
+
{
|
|
880
|
+
name: 'delete',
|
|
881
|
+
endpoint: '/api/v2/parse/{job_id}',
|
|
882
|
+
httpMethod: 'delete',
|
|
883
|
+
summary: 'Delete Parse Job',
|
|
884
|
+
description:
|
|
885
|
+
'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.',
|
|
886
|
+
stainlessPath: '(resource) parsing > (method) delete',
|
|
887
|
+
qualified: 'client.parsing.delete',
|
|
888
|
+
params: ['job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
889
|
+
response: '{ id: string; project_id: string; }',
|
|
890
|
+
markdown:
|
|
891
|
+
"## 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```",
|
|
892
|
+
perLanguage: {
|
|
893
|
+
go: {
|
|
894
|
+
method: 'client.Parsing.Delete',
|
|
895
|
+
example:
|
|
896
|
+
'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',
|
|
897
|
+
},
|
|
898
|
+
python: {
|
|
899
|
+
method: 'parsing.delete',
|
|
900
|
+
example:
|
|
901
|
+
'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)',
|
|
902
|
+
},
|
|
903
|
+
java: {
|
|
904
|
+
method: 'parsing().delete',
|
|
905
|
+
example:
|
|
906
|
+
'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}',
|
|
907
|
+
},
|
|
908
|
+
csharp: {
|
|
909
|
+
method: 'Parsing.Delete',
|
|
910
|
+
example:
|
|
911
|
+
'ParsingDeleteParams parameters = new() { JobID = "job_id" };\n\nvar parsing = await client.Parsing.Delete(parameters);\n\nConsole.WriteLine(parsing);',
|
|
912
|
+
},
|
|
913
|
+
typescript: {
|
|
914
|
+
method: 'client.parsing.delete',
|
|
915
|
+
example:
|
|
916
|
+
"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);",
|
|
917
|
+
},
|
|
918
|
+
http: {
|
|
919
|
+
example:
|
|
920
|
+
'curl https://api.cloud.llamaindex.ai/api/v2/parse/$JOB_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
921
|
+
},
|
|
922
|
+
cli: {
|
|
923
|
+
method: 'parsing delete',
|
|
924
|
+
example: "llp parsing delete \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
925
|
+
},
|
|
926
|
+
},
|
|
927
|
+
},
|
|
879
928
|
{
|
|
880
929
|
name: 'list_versions',
|
|
881
930
|
endpoint: '/api/v2/parse/versions',
|
|
882
931
|
httpMethod: 'get',
|
|
883
932
|
summary: 'List Parse Versions',
|
|
884
|
-
description: 'List the parse versions accepted by each tier.',
|
|
933
|
+
description: 'List the parse versions accepted by each tier and what `latest` resolves to.',
|
|
885
934
|
stainlessPath: '(resource) parsing > (method) list_versions',
|
|
886
935
|
qualified: 'client.parsing.listVersions',
|
|
887
936
|
response:
|
|
888
|
-
"{ agentic: string[]; agentic_plus: string[]; cost_effective: string[]; fast: '2026-06-15' | '2025-12-11'[]; }",
|
|
937
|
+
"{ 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; }; }",
|
|
889
938
|
markdown:
|
|
890
|
-
"## 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```",
|
|
939
|
+
"## 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```",
|
|
891
940
|
perLanguage: {
|
|
892
941
|
go: {
|
|
893
942
|
method: 'client.Parsing.ListVersions',
|
|
@@ -937,15 +986,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
937
986
|
'file_input: string;',
|
|
938
987
|
'organization_id?: string;',
|
|
939
988
|
'project_id?: string;',
|
|
940
|
-
"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?:
|
|
989
|
+
"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; };",
|
|
941
990
|
'configuration_id?: string;',
|
|
942
991
|
'webhook_configuration_ids?: string[];',
|
|
943
992
|
'webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[];',
|
|
944
993
|
],
|
|
945
994
|
response:
|
|
946
|
-
"{ 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?:
|
|
995
|
+
"{ 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; }; }",
|
|
947
996
|
markdown:
|
|
948
|
-
"## 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?:
|
|
997
|
+
"## 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```",
|
|
949
998
|
perLanguage: {
|
|
950
999
|
go: {
|
|
951
1000
|
method: 'client.Extract.New',
|
|
@@ -1008,9 +1057,9 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1008
1057
|
"status?: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING' | 'THROTTLED';",
|
|
1009
1058
|
],
|
|
1010
1059
|
response:
|
|
1011
|
-
"{ 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?:
|
|
1060
|
+
"{ 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; }; }",
|
|
1012
1061
|
markdown:
|
|
1013
|
-
"## 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?:
|
|
1062
|
+
"## 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```",
|
|
1014
1063
|
perLanguage: {
|
|
1015
1064
|
go: {
|
|
1016
1065
|
method: 'client.Extract.List',
|
|
@@ -1058,9 +1107,9 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1058
1107
|
qualified: 'client.extract.get',
|
|
1059
1108
|
params: ['job_id: string;', 'expand?: string[];', 'organization_id?: string;', 'project_id?: string;'],
|
|
1060
1109
|
response:
|
|
1061
|
-
"{ 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?:
|
|
1110
|
+
"{ 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; }; }",
|
|
1062
1111
|
markdown:
|
|
1063
|
-
"## 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?:
|
|
1112
|
+
"## 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```",
|
|
1064
1113
|
perLanguage: {
|
|
1065
1114
|
go: {
|
|
1066
1115
|
method: 'client.Extract.Get',
|
|
@@ -1156,9 +1205,9 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1156
1205
|
qualified: 'client.extract.cancel',
|
|
1157
1206
|
params: ['job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
1158
1207
|
response:
|
|
1159
|
-
"{ 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?:
|
|
1208
|
+
"{ 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; }; }",
|
|
1160
1209
|
markdown:
|
|
1161
|
-
"## 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?:
|
|
1210
|
+
"## 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```",
|
|
1162
1211
|
perLanguage: {
|
|
1163
1212
|
go: {
|
|
1164
1213
|
method: 'client.Extract.Cancel',
|
|
@@ -1263,7 +1312,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1263
1312
|
response:
|
|
1264
1313
|
"{ 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; }",
|
|
1265
1314
|
markdown:
|
|
1266
|
-
"## 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?:
|
|
1315
|
+
"## 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```",
|
|
1267
1316
|
perLanguage: {
|
|
1268
1317
|
go: {
|
|
1269
1318
|
method: 'client.Extract.GenerateSchema',
|
|
@@ -1300,219 +1349,6 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1300
1349
|
},
|
|
1301
1350
|
},
|
|
1302
1351
|
},
|
|
1303
|
-
{
|
|
1304
|
-
name: 'create',
|
|
1305
|
-
endpoint: '/api/v1/classifier/jobs',
|
|
1306
|
-
httpMethod: 'post',
|
|
1307
|
-
summary: 'Create Classify Job',
|
|
1308
|
-
description: 'Create a classify job. Experimental: not production-ready and subject to change.',
|
|
1309
|
-
stainlessPath: '(resource) classifier.jobs > (method) create',
|
|
1310
|
-
qualified: 'client.classifier.jobs.create',
|
|
1311
|
-
params: [
|
|
1312
|
-
'file_ids: string[];',
|
|
1313
|
-
'rules: { description: string; type: string; }[];',
|
|
1314
|
-
'organization_id?: string;',
|
|
1315
|
-
'project_id?: string;',
|
|
1316
|
-
"mode?: 'FAST' | 'MULTIMODAL';",
|
|
1317
|
-
'parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: number[]; };',
|
|
1318
|
-
"webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[];",
|
|
1319
|
-
],
|
|
1320
|
-
response:
|
|
1321
|
-
"{ 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; }",
|
|
1322
|
-
markdown:
|
|
1323
|
-
"## 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```",
|
|
1324
|
-
perLanguage: {
|
|
1325
|
-
go: {
|
|
1326
|
-
method: 'client.Classifier.Jobs.New',
|
|
1327
|
-
example:
|
|
1328
|
-
'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',
|
|
1329
|
-
},
|
|
1330
|
-
python: {
|
|
1331
|
-
method: 'classifier.jobs.create',
|
|
1332
|
-
example:
|
|
1333
|
-
'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)',
|
|
1334
|
-
},
|
|
1335
|
-
java: {
|
|
1336
|
-
method: 'classifier().jobs().create',
|
|
1337
|
-
example:
|
|
1338
|
-
'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}',
|
|
1339
|
-
},
|
|
1340
|
-
csharp: {
|
|
1341
|
-
method: 'Classifier.Jobs.Create',
|
|
1342
|
-
example:
|
|
1343
|
-
'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);',
|
|
1344
|
-
},
|
|
1345
|
-
typescript: {
|
|
1346
|
-
method: 'client.classifier.jobs.create',
|
|
1347
|
-
example:
|
|
1348
|
-
"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);",
|
|
1349
|
-
},
|
|
1350
|
-
http: {
|
|
1351
|
-
example:
|
|
1352
|
-
'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 }\'',
|
|
1353
|
-
},
|
|
1354
|
-
cli: {
|
|
1355
|
-
method: 'jobs create',
|
|
1356
|
-
example:
|
|
1357
|
-
"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}\"",
|
|
1358
|
-
},
|
|
1359
|
-
},
|
|
1360
|
-
},
|
|
1361
|
-
{
|
|
1362
|
-
name: 'list',
|
|
1363
|
-
endpoint: '/api/v1/classifier/jobs',
|
|
1364
|
-
httpMethod: 'get',
|
|
1365
|
-
summary: 'List Classify Jobs',
|
|
1366
|
-
description: 'List classify jobs. Experimental: not production-ready and subject to change.',
|
|
1367
|
-
stainlessPath: '(resource) classifier.jobs > (method) list',
|
|
1368
|
-
qualified: 'client.classifier.jobs.list',
|
|
1369
|
-
params: [
|
|
1370
|
-
'organization_id?: string;',
|
|
1371
|
-
'page_size?: number;',
|
|
1372
|
-
'page_token?: string;',
|
|
1373
|
-
'project_id?: string;',
|
|
1374
|
-
],
|
|
1375
|
-
response:
|
|
1376
|
-
"{ 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; }",
|
|
1377
|
-
markdown:
|
|
1378
|
-
"## 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```",
|
|
1379
|
-
perLanguage: {
|
|
1380
|
-
go: {
|
|
1381
|
-
method: 'client.Classifier.Jobs.List',
|
|
1382
|
-
example:
|
|
1383
|
-
'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',
|
|
1384
|
-
},
|
|
1385
|
-
python: {
|
|
1386
|
-
method: 'classifier.jobs.list',
|
|
1387
|
-
example:
|
|
1388
|
-
'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)',
|
|
1389
|
-
},
|
|
1390
|
-
java: {
|
|
1391
|
-
method: 'classifier().jobs().list',
|
|
1392
|
-
example:
|
|
1393
|
-
'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}',
|
|
1394
|
-
},
|
|
1395
|
-
csharp: {
|
|
1396
|
-
method: 'Classifier.Jobs.List',
|
|
1397
|
-
example:
|
|
1398
|
-
'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}',
|
|
1399
|
-
},
|
|
1400
|
-
typescript: {
|
|
1401
|
-
method: 'client.classifier.jobs.list',
|
|
1402
|
-
example:
|
|
1403
|
-
"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}",
|
|
1404
|
-
},
|
|
1405
|
-
http: {
|
|
1406
|
-
example:
|
|
1407
|
-
'curl https://api.cloud.llamaindex.ai/api/v1/classifier/jobs \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
1408
|
-
},
|
|
1409
|
-
cli: {
|
|
1410
|
-
method: 'jobs list',
|
|
1411
|
-
example: "llp classifier:jobs list \\\n --api-key 'My API Key'",
|
|
1412
|
-
},
|
|
1413
|
-
},
|
|
1414
|
-
},
|
|
1415
|
-
{
|
|
1416
|
-
name: 'get',
|
|
1417
|
-
endpoint: '/api/v1/classifier/jobs/{classify_job_id}',
|
|
1418
|
-
httpMethod: 'get',
|
|
1419
|
-
summary: 'Get Classify Job',
|
|
1420
|
-
description: 'Get a classify job. Experimental: not production-ready and subject to change.',
|
|
1421
|
-
stainlessPath: '(resource) classifier.jobs > (method) get',
|
|
1422
|
-
qualified: 'client.classifier.jobs.get',
|
|
1423
|
-
params: ['classify_job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
1424
|
-
response:
|
|
1425
|
-
"{ 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; }",
|
|
1426
|
-
markdown:
|
|
1427
|
-
"## 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```",
|
|
1428
|
-
perLanguage: {
|
|
1429
|
-
go: {
|
|
1430
|
-
method: 'client.Classifier.Jobs.Get',
|
|
1431
|
-
example:
|
|
1432
|
-
'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',
|
|
1433
|
-
},
|
|
1434
|
-
python: {
|
|
1435
|
-
method: 'classifier.jobs.get',
|
|
1436
|
-
example:
|
|
1437
|
-
'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)',
|
|
1438
|
-
},
|
|
1439
|
-
java: {
|
|
1440
|
-
method: 'classifier().jobs().get',
|
|
1441
|
-
example:
|
|
1442
|
-
'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}',
|
|
1443
|
-
},
|
|
1444
|
-
csharp: {
|
|
1445
|
-
method: 'Classifier.Jobs.Get',
|
|
1446
|
-
example:
|
|
1447
|
-
'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);',
|
|
1448
|
-
},
|
|
1449
|
-
typescript: {
|
|
1450
|
-
method: 'client.classifier.jobs.get',
|
|
1451
|
-
example:
|
|
1452
|
-
"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);",
|
|
1453
|
-
},
|
|
1454
|
-
http: {
|
|
1455
|
-
example:
|
|
1456
|
-
'curl https://api.cloud.llamaindex.ai/api/v1/classifier/jobs/$CLASSIFY_JOB_ID \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
1457
|
-
},
|
|
1458
|
-
cli: {
|
|
1459
|
-
method: 'jobs get',
|
|
1460
|
-
example:
|
|
1461
|
-
"llp classifier:jobs get \\\n --api-key 'My API Key' \\\n --classify-job-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
1462
|
-
},
|
|
1463
|
-
},
|
|
1464
|
-
},
|
|
1465
|
-
{
|
|
1466
|
-
name: 'get_results',
|
|
1467
|
-
endpoint: '/api/v1/classifier/jobs/{classify_job_id}/results',
|
|
1468
|
-
httpMethod: 'get',
|
|
1469
|
-
summary: 'Get Classification Job Results',
|
|
1470
|
-
description:
|
|
1471
|
-
'Get the results of a classify job. Experimental: not production-ready and subject to change.',
|
|
1472
|
-
stainlessPath: '(resource) classifier.jobs > (method) get_results',
|
|
1473
|
-
qualified: 'client.classifier.jobs.getResults',
|
|
1474
|
-
params: ['classify_job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
1475
|
-
response:
|
|
1476
|
-
'{ 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; }',
|
|
1477
|
-
markdown:
|
|
1478
|
-
"## 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```",
|
|
1479
|
-
perLanguage: {
|
|
1480
|
-
go: {
|
|
1481
|
-
method: 'client.Classifier.Jobs.GetResults',
|
|
1482
|
-
example:
|
|
1483
|
-
'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',
|
|
1484
|
-
},
|
|
1485
|
-
python: {
|
|
1486
|
-
method: 'classifier.jobs.get_results',
|
|
1487
|
-
example:
|
|
1488
|
-
'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)',
|
|
1489
|
-
},
|
|
1490
|
-
java: {
|
|
1491
|
-
method: 'classifier().jobs().getResults',
|
|
1492
|
-
example:
|
|
1493
|
-
'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}',
|
|
1494
|
-
},
|
|
1495
|
-
csharp: {
|
|
1496
|
-
method: 'Classifier.Jobs.GetResults',
|
|
1497
|
-
example:
|
|
1498
|
-
'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);',
|
|
1499
|
-
},
|
|
1500
|
-
typescript: {
|
|
1501
|
-
method: 'client.classifier.jobs.getResults',
|
|
1502
|
-
example:
|
|
1503
|
-
"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);",
|
|
1504
|
-
},
|
|
1505
|
-
http: {
|
|
1506
|
-
example:
|
|
1507
|
-
'curl https://api.cloud.llamaindex.ai/api/v1/classifier/jobs/$CLASSIFY_JOB_ID/results \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
1508
|
-
},
|
|
1509
|
-
cli: {
|
|
1510
|
-
method: 'jobs get_results',
|
|
1511
|
-
example:
|
|
1512
|
-
"llp classifier:jobs get-results \\\n --api-key 'My API Key' \\\n --classify-job-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
1513
|
-
},
|
|
1514
|
-
},
|
|
1515
|
-
},
|
|
1516
1352
|
{
|
|
1517
1353
|
name: 'create',
|
|
1518
1354
|
endpoint: '/api/v2/batches',
|
|
@@ -1960,14 +1796,14 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1960
1796
|
qualified: 'client.configurations.create',
|
|
1961
1797
|
params: [
|
|
1962
1798
|
'name: string;',
|
|
1963
|
-
"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?:
|
|
1799
|
+
"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'; };",
|
|
1964
1800
|
'organization_id?: string;',
|
|
1965
1801
|
'project_id?: string;',
|
|
1966
1802
|
],
|
|
1967
1803
|
response:
|
|
1968
1804
|
"{ 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; }",
|
|
1969
1805
|
markdown:
|
|
1970
|
-
"## 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```",
|
|
1806
|
+
"## 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```",
|
|
1971
1807
|
perLanguage: {
|
|
1972
1808
|
go: {
|
|
1973
1809
|
method: 'client.Configurations.New',
|
|
@@ -2025,7 +1861,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2025
1861
|
response:
|
|
2026
1862
|
"{ 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; }",
|
|
2027
1863
|
markdown:
|
|
2028
|
-
"## 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?:
|
|
1864
|
+
"## 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```",
|
|
2029
1865
|
perLanguage: {
|
|
2030
1866
|
go: {
|
|
2031
1867
|
method: 'client.Configurations.List',
|
|
@@ -2074,7 +1910,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2074
1910
|
response:
|
|
2075
1911
|
"{ 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; }",
|
|
2076
1912
|
markdown:
|
|
2077
|
-
"## 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?:
|
|
1913
|
+
"## 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```",
|
|
2078
1914
|
perLanguage: {
|
|
2079
1915
|
go: {
|
|
2080
1916
|
method: 'client.Configurations.Get',
|
|
@@ -2124,12 +1960,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2124
1960
|
'organization_id?: string;',
|
|
2125
1961
|
'project_id?: string;',
|
|
2126
1962
|
'name?: string;',
|
|
2127
|
-
"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?:
|
|
1963
|
+
"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'; };",
|
|
2128
1964
|
],
|
|
2129
1965
|
response:
|
|
2130
1966
|
"{ 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; }",
|
|
2131
1967
|
markdown:
|
|
2132
|
-
"## 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```",
|
|
1968
|
+
"## 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```",
|
|
2133
1969
|
perLanguage: {
|
|
2134
1970
|
go: {
|
|
2135
1971
|
method: 'client.Configurations.Update',
|
|
@@ -2233,7 +2069,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2233
2069
|
response:
|
|
2234
2070
|
"{ 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'; }",
|
|
2235
2071
|
markdown:
|
|
2236
|
-
"## 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```",
|
|
2072
|
+
"## 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```",
|
|
2237
2073
|
perLanguage: {
|
|
2238
2074
|
go: {
|
|
2239
2075
|
method: 'client.WebhookConfigs.New',
|
|
@@ -2390,7 +2226,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2390
2226
|
response:
|
|
2391
2227
|
"{ 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'; }",
|
|
2392
2228
|
markdown:
|
|
2393
|
-
"## 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```",
|
|
2229
|
+
"## 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```",
|
|
2394
2230
|
perLanguage: {
|
|
2395
2231
|
go: {
|
|
2396
2232
|
method: 'client.WebhookConfigs.Update',
|
|
@@ -2844,21 +2680,21 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2844
2680
|
description: 'Get a data sink by ID.',
|
|
2845
2681
|
stainlessPath: '(resource) data_sinks > (method) get',
|
|
2846
2682
|
qualified: 'client.dataSinks.get',
|
|
2847
|
-
params: ['data_sink_id: string;'],
|
|
2683
|
+
params: ['data_sink_id: string;', 'project_id?: string;'],
|
|
2848
2684
|
response:
|
|
2849
2685
|
"{ 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; }",
|
|
2850
2686
|
markdown:
|
|
2851
|
-
"## 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```",
|
|
2687
|
+
"## 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```",
|
|
2852
2688
|
perLanguage: {
|
|
2853
2689
|
go: {
|
|
2854
2690
|
method: 'client.DataSinks.Get',
|
|
2855
2691
|
example:
|
|
2856
|
-
'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(
|
|
2692
|
+
'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',
|
|
2857
2693
|
},
|
|
2858
2694
|
python: {
|
|
2859
2695
|
method: 'data_sinks.get',
|
|
2860
2696
|
example:
|
|
2861
|
-
'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)',
|
|
2697
|
+
'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)',
|
|
2862
2698
|
},
|
|
2863
2699
|
java: {
|
|
2864
2700
|
method: 'dataSinks().get',
|
|
@@ -2897,13 +2733,14 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2897
2733
|
params: [
|
|
2898
2734
|
'data_sink_id: string;',
|
|
2899
2735
|
"sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT';",
|
|
2736
|
+
'project_id?: string;',
|
|
2900
2737
|
"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; };",
|
|
2901
2738
|
'name?: string;',
|
|
2902
2739
|
],
|
|
2903
2740
|
response:
|
|
2904
2741
|
"{ 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; }",
|
|
2905
2742
|
markdown:
|
|
2906
|
-
"## 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```",
|
|
2743
|
+
"## 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```",
|
|
2907
2744
|
perLanguage: {
|
|
2908
2745
|
go: {
|
|
2909
2746
|
method: 'client.DataSinks.Update',
|
|
@@ -2949,19 +2786,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2949
2786
|
description: 'Delete a data sink by ID.',
|
|
2950
2787
|
stainlessPath: '(resource) data_sinks > (method) delete',
|
|
2951
2788
|
qualified: 'client.dataSinks.delete',
|
|
2952
|
-
params: ['data_sink_id: string;'],
|
|
2789
|
+
params: ['data_sink_id: string;', 'project_id?: string;'],
|
|
2953
2790
|
markdown:
|
|
2954
|
-
"## 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```",
|
|
2791
|
+
"## 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```",
|
|
2955
2792
|
perLanguage: {
|
|
2956
2793
|
go: {
|
|
2957
2794
|
method: 'client.DataSinks.Delete',
|
|
2958
2795
|
example:
|
|
2959
|
-
'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(
|
|
2796
|
+
'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',
|
|
2960
2797
|
},
|
|
2961
2798
|
python: {
|
|
2962
2799
|
method: 'data_sinks.delete',
|
|
2963
2800
|
example:
|
|
2964
|
-
'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)',
|
|
2801
|
+
'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)',
|
|
2965
2802
|
},
|
|
2966
2803
|
java: {
|
|
2967
2804
|
method: 'dataSinks().delete',
|
|
@@ -3104,21 +2941,21 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3104
2941
|
description: 'Get a data source by ID.',
|
|
3105
2942
|
stainlessPath: '(resource) data_sources > (method) get',
|
|
3106
2943
|
qualified: 'client.dataSources.get',
|
|
3107
|
-
params: ['data_source_id: string;'],
|
|
2944
|
+
params: ['data_source_id: string;', 'project_id?: string;'],
|
|
3108
2945
|
response:
|
|
3109
2946
|
'{ 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; }',
|
|
3110
2947
|
markdown:
|
|
3111
|
-
"## 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```",
|
|
2948
|
+
"## 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```",
|
|
3112
2949
|
perLanguage: {
|
|
3113
2950
|
go: {
|
|
3114
2951
|
method: 'client.DataSources.Get',
|
|
3115
2952
|
example:
|
|
3116
|
-
'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(
|
|
2953
|
+
'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',
|
|
3117
2954
|
},
|
|
3118
2955
|
python: {
|
|
3119
2956
|
method: 'data_sources.get',
|
|
3120
2957
|
example:
|
|
3121
|
-
'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)',
|
|
2958
|
+
'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)',
|
|
3122
2959
|
},
|
|
3123
2960
|
java: {
|
|
3124
2961
|
method: 'dataSources().get',
|
|
@@ -3157,6 +2994,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3157
2994
|
params: [
|
|
3158
2995
|
'data_source_id: string;',
|
|
3159
2996
|
'source_type: string;',
|
|
2997
|
+
'project_id?: string;',
|
|
3160
2998
|
"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; };",
|
|
3161
2999
|
'custom_metadata?: object;',
|
|
3162
3000
|
'name?: string;',
|
|
@@ -3164,7 +3002,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3164
3002
|
response:
|
|
3165
3003
|
'{ 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; }',
|
|
3166
3004
|
markdown:
|
|
3167
|
-
"## 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```",
|
|
3005
|
+
"## 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```",
|
|
3168
3006
|
perLanguage: {
|
|
3169
3007
|
go: {
|
|
3170
3008
|
method: 'client.DataSources.Update',
|
|
@@ -3210,19 +3048,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3210
3048
|
description: 'Delete a data source by ID.',
|
|
3211
3049
|
stainlessPath: '(resource) data_sources > (method) delete',
|
|
3212
3050
|
qualified: 'client.dataSources.delete',
|
|
3213
|
-
params: ['data_source_id: string;'],
|
|
3051
|
+
params: ['data_source_id: string;', 'project_id?: string;'],
|
|
3214
3052
|
markdown:
|
|
3215
|
-
"## 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```",
|
|
3053
|
+
"## 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```",
|
|
3216
3054
|
perLanguage: {
|
|
3217
3055
|
go: {
|
|
3218
3056
|
method: 'client.DataSources.Delete',
|
|
3219
3057
|
example:
|
|
3220
|
-
'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(
|
|
3058
|
+
'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',
|
|
3221
3059
|
},
|
|
3222
3060
|
python: {
|
|
3223
3061
|
method: 'data_sources.delete',
|
|
3224
3062
|
example:
|
|
3225
|
-
'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)',
|
|
3063
|
+
'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)',
|
|
3226
3064
|
},
|
|
3227
3065
|
java: {
|
|
3228
3066
|
method: 'dataSources().delete',
|
|
@@ -3255,7 +3093,8 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3255
3093
|
endpoint: '/api/v1/pipelines',
|
|
3256
3094
|
httpMethod: 'get',
|
|
3257
3095
|
summary: 'Search Pipelines',
|
|
3258
|
-
description:
|
|
3096
|
+
description:
|
|
3097
|
+
'Search for pipelines by name, type, or project.\n\nDeprecated: use `GET /api/v2/pipelines`, which is paginated.',
|
|
3259
3098
|
stainlessPath: '(resource) pipelines > (method) list',
|
|
3260
3099
|
qualified: 'client.pipelines.list',
|
|
3261
3100
|
params: [
|
|
@@ -3268,7 +3107,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3268
3107
|
response:
|
|
3269
3108
|
"{ 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; }[]",
|
|
3270
3109
|
markdown:
|
|
3271
|
-
"## 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```",
|
|
3110
|
+
"## 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```",
|
|
3272
3111
|
perLanguage: {
|
|
3273
3112
|
go: {
|
|
3274
3113
|
method: 'client.Pipelines.List',
|
|
@@ -3305,6 +3144,62 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3305
3144
|
},
|
|
3306
3145
|
},
|
|
3307
3146
|
},
|
|
3147
|
+
{
|
|
3148
|
+
name: 'list_paginated',
|
|
3149
|
+
endpoint: '/api/v2/pipelines',
|
|
3150
|
+
httpMethod: 'get',
|
|
3151
|
+
summary: 'List Pipelines',
|
|
3152
|
+
description: 'List the pipelines in a project, newest first.',
|
|
3153
|
+
stainlessPath: '(resource) pipelines > (method) list_paginated',
|
|
3154
|
+
qualified: 'client.pipelines.listPaginated',
|
|
3155
|
+
params: [
|
|
3156
|
+
'name?: string;',
|
|
3157
|
+
'organization_id?: string;',
|
|
3158
|
+
'page_size?: number;',
|
|
3159
|
+
'page_token?: string;',
|
|
3160
|
+
"pipeline_type?: 'MANAGED' | 'PLAYGROUND';",
|
|
3161
|
+
'project_id?: string;',
|
|
3162
|
+
],
|
|
3163
|
+
response:
|
|
3164
|
+
"{ id: string; name: string; pipeline_type: 'MANAGED' | 'PLAYGROUND'; project_id: string; created_at?: string; status?: 'CREATED' | 'DELETING'; updated_at?: string; }",
|
|
3165
|
+
markdown:
|
|
3166
|
+
"## 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```",
|
|
3167
|
+
perLanguage: {
|
|
3168
|
+
go: {
|
|
3169
|
+
method: 'client.Pipelines.ListPaginated',
|
|
3170
|
+
example:
|
|
3171
|
+
'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',
|
|
3172
|
+
},
|
|
3173
|
+
python: {
|
|
3174
|
+
method: 'pipelines.list_paginated',
|
|
3175
|
+
example:
|
|
3176
|
+
'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)',
|
|
3177
|
+
},
|
|
3178
|
+
java: {
|
|
3179
|
+
method: 'pipelines().listPaginated',
|
|
3180
|
+
example:
|
|
3181
|
+
'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}',
|
|
3182
|
+
},
|
|
3183
|
+
csharp: {
|
|
3184
|
+
method: 'Pipelines.ListPaginated',
|
|
3185
|
+
example:
|
|
3186
|
+
'PipelineListPaginatedParams parameters = new();\n\nvar page = await client.Pipelines.ListPaginated(parameters);\nawait foreach (var item in page.Paginate())\n{\n Console.WriteLine(item);\n}',
|
|
3187
|
+
},
|
|
3188
|
+
typescript: {
|
|
3189
|
+
method: 'client.pipelines.listPaginated',
|
|
3190
|
+
example:
|
|
3191
|
+
"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}",
|
|
3192
|
+
},
|
|
3193
|
+
http: {
|
|
3194
|
+
example:
|
|
3195
|
+
'curl https://api.cloud.llamaindex.ai/api/v2/pipelines \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
3196
|
+
},
|
|
3197
|
+
cli: {
|
|
3198
|
+
method: 'pipelines list_paginated',
|
|
3199
|
+
example: "llp pipelines list-paginated \\\n --api-key 'My API Key'",
|
|
3200
|
+
},
|
|
3201
|
+
},
|
|
3202
|
+
},
|
|
3308
3203
|
{
|
|
3309
3204
|
name: 'create',
|
|
3310
3205
|
endpoint: '/api/v1/pipelines',
|
|
@@ -3379,21 +3274,21 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3379
3274
|
description: 'Get a pipeline by ID.',
|
|
3380
3275
|
stainlessPath: '(resource) pipelines > (method) get',
|
|
3381
3276
|
qualified: 'client.pipelines.get',
|
|
3382
|
-
params: ['pipeline_id: string;'],
|
|
3277
|
+
params: ['pipeline_id: string;', 'project_id?: string;'],
|
|
3383
3278
|
response:
|
|
3384
3279
|
"{ 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; }",
|
|
3385
3280
|
markdown:
|
|
3386
|
-
"## 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```",
|
|
3281
|
+
"## 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```",
|
|
3387
3282
|
perLanguage: {
|
|
3388
3283
|
go: {
|
|
3389
3284
|
method: 'client.Pipelines.Get',
|
|
3390
3285
|
example:
|
|
3391
|
-
'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(
|
|
3286
|
+
'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',
|
|
3392
3287
|
},
|
|
3393
3288
|
python: {
|
|
3394
3289
|
method: 'pipelines.get',
|
|
3395
3290
|
example:
|
|
3396
|
-
'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)',
|
|
3291
|
+
'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)',
|
|
3397
3292
|
},
|
|
3398
3293
|
java: {
|
|
3399
3294
|
method: 'pipelines().get',
|
|
@@ -3431,6 +3326,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3431
3326
|
qualified: 'client.pipelines.update',
|
|
3432
3327
|
params: [
|
|
3433
3328
|
'pipeline_id: string;',
|
|
3329
|
+
'project_id?: string;',
|
|
3434
3330
|
"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'; };",
|
|
3435
3331
|
'data_sink_id?: string;',
|
|
3436
3332
|
"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'; };",
|
|
@@ -3447,7 +3343,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3447
3343
|
response:
|
|
3448
3344
|
"{ 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; }",
|
|
3449
3345
|
markdown:
|
|
3450
|
-
"## 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```",
|
|
3346
|
+
"## 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```",
|
|
3451
3347
|
perLanguage: {
|
|
3452
3348
|
go: {
|
|
3453
3349
|
method: 'client.Pipelines.Update',
|
|
@@ -3494,19 +3390,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3494
3390
|
'Delete a pipeline and all associated resources.\n\nRemoves pipeline files, data sources, and vector store data.\nThis operation is irreversible.',
|
|
3495
3391
|
stainlessPath: '(resource) pipelines > (method) delete',
|
|
3496
3392
|
qualified: 'client.pipelines.delete',
|
|
3497
|
-
params: ['pipeline_id: string;'],
|
|
3393
|
+
params: ['pipeline_id: string;', 'project_id?: string;'],
|
|
3498
3394
|
markdown:
|
|
3499
|
-
"## 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```",
|
|
3395
|
+
"## 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```",
|
|
3500
3396
|
perLanguage: {
|
|
3501
3397
|
go: {
|
|
3502
3398
|
method: 'client.Pipelines.Delete',
|
|
3503
3399
|
example:
|
|
3504
|
-
'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(
|
|
3400
|
+
'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',
|
|
3505
3401
|
},
|
|
3506
3402
|
python: {
|
|
3507
3403
|
method: 'pipelines.delete',
|
|
3508
3404
|
example:
|
|
3509
|
-
'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)',
|
|
3405
|
+
'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)',
|
|
3510
3406
|
},
|
|
3511
3407
|
java: {
|
|
3512
3408
|
method: 'pipelines().delete',
|
|
@@ -3543,11 +3439,11 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3543
3439
|
'Get the ingestion status of a managed pipeline.\n\nReturns document counts, sync progress, and the last\neffective timestamp. Only available for managed pipelines.',
|
|
3544
3440
|
stainlessPath: '(resource) pipelines > (method) get_status',
|
|
3545
3441
|
qualified: 'client.pipelines.getStatus',
|
|
3546
|
-
params: ['pipeline_id: string;', 'full_details?: boolean;'],
|
|
3442
|
+
params: ['pipeline_id: string;', 'full_details?: boolean;', 'project_id?: string;'],
|
|
3547
3443
|
response:
|
|
3548
3444
|
"{ 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; }",
|
|
3549
3445
|
markdown:
|
|
3550
|
-
"## 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```",
|
|
3446
|
+
"## 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```",
|
|
3551
3447
|
perLanguage: {
|
|
3552
3448
|
go: {
|
|
3553
3449
|
method: 'client.Pipelines.GetStatus',
|
|
@@ -3682,21 +3578,21 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3682
3578
|
'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.',
|
|
3683
3579
|
stainlessPath: '(resource) pipelines.sync > (method) create',
|
|
3684
3580
|
qualified: 'client.pipelines.sync.create',
|
|
3685
|
-
params: ['pipeline_id: string;'],
|
|
3581
|
+
params: ['pipeline_id: string;', 'project_id?: string;'],
|
|
3686
3582
|
response:
|
|
3687
3583
|
"{ 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; }",
|
|
3688
3584
|
markdown:
|
|
3689
|
-
"## 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```",
|
|
3585
|
+
"## 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```",
|
|
3690
3586
|
perLanguage: {
|
|
3691
3587
|
go: {
|
|
3692
3588
|
method: 'client.Pipelines.Sync.New',
|
|
3693
3589
|
example:
|
|
3694
|
-
'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(
|
|
3590
|
+
'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',
|
|
3695
3591
|
},
|
|
3696
3592
|
python: {
|
|
3697
3593
|
method: 'pipelines.sync.create',
|
|
3698
3594
|
example:
|
|
3699
|
-
'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)',
|
|
3595
|
+
'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)',
|
|
3700
3596
|
},
|
|
3701
3597
|
java: {
|
|
3702
3598
|
method: 'pipelines().sync().create',
|
|
@@ -3732,21 +3628,21 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3732
3628
|
description: 'Cancel all running sync jobs for a pipeline.',
|
|
3733
3629
|
stainlessPath: '(resource) pipelines.sync > (method) cancel',
|
|
3734
3630
|
qualified: 'client.pipelines.sync.cancel',
|
|
3735
|
-
params: ['pipeline_id: string;'],
|
|
3631
|
+
params: ['pipeline_id: string;', 'project_id?: string;'],
|
|
3736
3632
|
response:
|
|
3737
3633
|
"{ 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; }",
|
|
3738
3634
|
markdown:
|
|
3739
|
-
"## 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```",
|
|
3635
|
+
"## 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```",
|
|
3740
3636
|
perLanguage: {
|
|
3741
3637
|
go: {
|
|
3742
3638
|
method: 'client.Pipelines.Sync.Cancel',
|
|
3743
3639
|
example:
|
|
3744
|
-
'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(
|
|
3640
|
+
'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',
|
|
3745
3641
|
},
|
|
3746
3642
|
python: {
|
|
3747
3643
|
method: 'pipelines.sync.cancel',
|
|
3748
3644
|
example:
|
|
3749
|
-
'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)',
|
|
3645
|
+
'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)',
|
|
3750
3646
|
},
|
|
3751
3647
|
java: {
|
|
3752
3648
|
method: 'pipelines().sync().cancel',
|
|
@@ -3782,21 +3678,21 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3782
3678
|
description: 'Get data sources for a pipeline.',
|
|
3783
3679
|
stainlessPath: '(resource) pipelines.data_sources > (method) get_data_sources',
|
|
3784
3680
|
qualified: 'client.pipelines.dataSources.getDataSources',
|
|
3785
|
-
params: ['pipeline_id: string;'],
|
|
3681
|
+
params: ['pipeline_id: string;', 'project_id?: string;'],
|
|
3786
3682
|
response:
|
|
3787
3683
|
"{ 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; }[]",
|
|
3788
3684
|
markdown:
|
|
3789
|
-
"## 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```",
|
|
3685
|
+
"## 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```",
|
|
3790
3686
|
perLanguage: {
|
|
3791
3687
|
go: {
|
|
3792
3688
|
method: 'client.Pipelines.DataSources.GetDataSources',
|
|
3793
3689
|
example:
|
|
3794
|
-
'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(
|
|
3690
|
+
'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',
|
|
3795
3691
|
},
|
|
3796
3692
|
python: {
|
|
3797
3693
|
method: 'pipelines.data_sources.get_data_sources',
|
|
3798
3694
|
example:
|
|
3799
|
-
'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)',
|
|
3695
|
+
'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)',
|
|
3800
3696
|
},
|
|
3801
3697
|
java: {
|
|
3802
3698
|
method: 'pipelines().dataSources().getDataSources',
|
|
@@ -3832,11 +3728,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3832
3728
|
description: 'Add data sources to a pipeline.',
|
|
3833
3729
|
stainlessPath: '(resource) pipelines.data_sources > (method) update_data_sources',
|
|
3834
3730
|
qualified: 'client.pipelines.dataSources.updateDataSources',
|
|
3835
|
-
params: [
|
|
3731
|
+
params: [
|
|
3732
|
+
'pipeline_id: string;',
|
|
3733
|
+
'body: { data_source_id: string; sync_interval?: number; }[];',
|
|
3734
|
+
'project_id?: string;',
|
|
3735
|
+
],
|
|
3836
3736
|
response:
|
|
3837
3737
|
"{ 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; }[]",
|
|
3838
3738
|
markdown:
|
|
3839
|
-
"## 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```",
|
|
3739
|
+
"## 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```",
|
|
3840
3740
|
perLanguage: {
|
|
3841
3741
|
go: {
|
|
3842
3742
|
method: 'client.Pipelines.DataSources.UpdateDataSources',
|
|
@@ -3882,11 +3782,16 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3882
3782
|
description: 'Update the configuration of a data source in a pipeline.',
|
|
3883
3783
|
stainlessPath: '(resource) pipelines.data_sources > (method) update',
|
|
3884
3784
|
qualified: 'client.pipelines.dataSources.update',
|
|
3885
|
-
params: [
|
|
3785
|
+
params: [
|
|
3786
|
+
'pipeline_id: string;',
|
|
3787
|
+
'data_source_id: string;',
|
|
3788
|
+
'project_id?: string;',
|
|
3789
|
+
'sync_interval?: number;',
|
|
3790
|
+
],
|
|
3886
3791
|
response:
|
|
3887
3792
|
"{ 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; }",
|
|
3888
3793
|
markdown:
|
|
3889
|
-
"## 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```",
|
|
3794
|
+
"## 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```",
|
|
3890
3795
|
perLanguage: {
|
|
3891
3796
|
go: {
|
|
3892
3797
|
method: 'client.Pipelines.DataSources.Update',
|
|
@@ -3932,11 +3837,11 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3932
3837
|
description: 'Get the status of a data source for a pipeline.',
|
|
3933
3838
|
stainlessPath: '(resource) pipelines.data_sources > (method) get_status',
|
|
3934
3839
|
qualified: 'client.pipelines.dataSources.getStatus',
|
|
3935
|
-
params: ['pipeline_id: string;', 'data_source_id: string;'],
|
|
3840
|
+
params: ['pipeline_id: string;', 'data_source_id: string;', 'project_id?: string;'],
|
|
3936
3841
|
response:
|
|
3937
3842
|
"{ 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; }",
|
|
3938
3843
|
markdown:
|
|
3939
|
-
"## 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```",
|
|
3844
|
+
"## 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```",
|
|
3940
3845
|
perLanguage: {
|
|
3941
3846
|
go: {
|
|
3942
3847
|
method: 'client.Pipelines.DataSources.GetStatus',
|
|
@@ -3982,11 +3887,16 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3982
3887
|
description: 'Run incremental ingestion: pull upstream changes from the data source into the data sink.',
|
|
3983
3888
|
stainlessPath: '(resource) pipelines.data_sources > (method) sync',
|
|
3984
3889
|
qualified: 'client.pipelines.dataSources.sync',
|
|
3985
|
-
params: [
|
|
3890
|
+
params: [
|
|
3891
|
+
'pipeline_id: string;',
|
|
3892
|
+
'data_source_id: string;',
|
|
3893
|
+
'project_id?: string;',
|
|
3894
|
+
'pipeline_file_ids?: string[];',
|
|
3895
|
+
],
|
|
3986
3896
|
response:
|
|
3987
3897
|
"{ 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; }",
|
|
3988
3898
|
markdown:
|
|
3989
|
-
"## 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```",
|
|
3899
|
+
"## 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```",
|
|
3990
3900
|
perLanguage: {
|
|
3991
3901
|
go: {
|
|
3992
3902
|
method: 'client.Pipelines.DataSources.Sync',
|
|
@@ -4235,11 +4145,16 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4235
4145
|
description: 'Get files for a pipeline.',
|
|
4236
4146
|
stainlessPath: '(resource) pipelines.files > (method) get_status_counts',
|
|
4237
4147
|
qualified: 'client.pipelines.files.getStatusCounts',
|
|
4238
|
-
params: [
|
|
4148
|
+
params: [
|
|
4149
|
+
'pipeline_id: string;',
|
|
4150
|
+
'data_source_id?: string;',
|
|
4151
|
+
'only_manually_uploaded?: boolean;',
|
|
4152
|
+
'project_id?: string;',
|
|
4153
|
+
],
|
|
4239
4154
|
response:
|
|
4240
4155
|
'{ counts: object; total_count: number; data_source_id?: string; only_manually_uploaded?: boolean; pipeline_id?: string; }',
|
|
4241
4156
|
markdown:
|
|
4242
|
-
"## 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```",
|
|
4157
|
+
"## 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```",
|
|
4243
4158
|
perLanguage: {
|
|
4244
4159
|
go: {
|
|
4245
4160
|
method: 'client.Pipelines.Files.GetStatusCounts',
|
|
@@ -4285,11 +4200,11 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4285
4200
|
description: 'Get status of a file for a pipeline.',
|
|
4286
4201
|
stainlessPath: '(resource) pipelines.files > (method) get_status',
|
|
4287
4202
|
qualified: 'client.pipelines.files.getStatus',
|
|
4288
|
-
params: ['pipeline_id: string;', 'file_id: string;'],
|
|
4203
|
+
params: ['pipeline_id: string;', 'file_id: string;', 'project_id?: string;'],
|
|
4289
4204
|
response:
|
|
4290
4205
|
"{ 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; }",
|
|
4291
4206
|
markdown:
|
|
4292
|
-
"## 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```",
|
|
4207
|
+
"## 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```",
|
|
4293
4208
|
perLanguage: {
|
|
4294
4209
|
go: {
|
|
4295
4210
|
method: 'client.Pipelines.Files.GetStatus',
|
|
@@ -4335,11 +4250,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4335
4250
|
description: 'Add files to a pipeline.',
|
|
4336
4251
|
stainlessPath: '(resource) pipelines.files > (method) create',
|
|
4337
4252
|
qualified: 'client.pipelines.files.create',
|
|
4338
|
-
params: [
|
|
4253
|
+
params: [
|
|
4254
|
+
'pipeline_id: string;',
|
|
4255
|
+
'body: { file_id: string; custom_metadata?: object; }[];',
|
|
4256
|
+
'project_id?: string;',
|
|
4257
|
+
],
|
|
4339
4258
|
response:
|
|
4340
4259
|
"{ 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; }[]",
|
|
4341
4260
|
markdown:
|
|
4342
|
-
"## 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```",
|
|
4261
|
+
"## 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```",
|
|
4343
4262
|
perLanguage: {
|
|
4344
4263
|
go: {
|
|
4345
4264
|
method: 'client.Pipelines.Files.New',
|
|
@@ -4385,11 +4304,11 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4385
4304
|
description: 'Update a file for a pipeline.',
|
|
4386
4305
|
stainlessPath: '(resource) pipelines.files > (method) update',
|
|
4387
4306
|
qualified: 'client.pipelines.files.update',
|
|
4388
|
-
params: ['pipeline_id: string;', 'file_id: string;', 'custom_metadata?: object;'],
|
|
4307
|
+
params: ['pipeline_id: string;', 'file_id: string;', 'project_id?: string;', 'custom_metadata?: object;'],
|
|
4389
4308
|
response:
|
|
4390
4309
|
"{ 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; }",
|
|
4391
4310
|
markdown:
|
|
4392
|
-
"## 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```",
|
|
4311
|
+
"## 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```",
|
|
4393
4312
|
perLanguage: {
|
|
4394
4313
|
go: {
|
|
4395
4314
|
method: 'client.Pipelines.Files.Update',
|
|
@@ -4435,9 +4354,9 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4435
4354
|
description: 'Delete a file from a pipeline.',
|
|
4436
4355
|
stainlessPath: '(resource) pipelines.files > (method) delete',
|
|
4437
4356
|
qualified: 'client.pipelines.files.delete',
|
|
4438
|
-
params: ['pipeline_id: string;', 'file_id: string;'],
|
|
4357
|
+
params: ['pipeline_id: string;', 'file_id: string;', 'project_id?: string;'],
|
|
4439
4358
|
markdown:
|
|
4440
|
-
"## 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```",
|
|
4359
|
+
"## 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```",
|
|
4441
4360
|
perLanguage: {
|
|
4442
4361
|
go: {
|
|
4443
4362
|
method: 'client.Pipelines.Files.Delete',
|
|
@@ -4491,12 +4410,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4491
4410
|
'offset?: number;',
|
|
4492
4411
|
'only_manually_uploaded?: boolean;',
|
|
4493
4412
|
'order_by?: string;',
|
|
4413
|
+
'project_id?: string;',
|
|
4494
4414
|
"statuses?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'[];",
|
|
4495
4415
|
],
|
|
4496
4416
|
response:
|
|
4497
4417
|
"{ 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; }",
|
|
4498
4418
|
markdown:
|
|
4499
|
-
"## 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```",
|
|
4419
|
+
"## 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```",
|
|
4500
4420
|
perLanguage: {
|
|
4501
4421
|
go: {
|
|
4502
4422
|
method: 'client.Pipelines.Files.List',
|
|
@@ -4542,10 +4462,10 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4542
4462
|
description: 'Import metadata for a pipeline.',
|
|
4543
4463
|
stainlessPath: '(resource) pipelines.metadata > (method) create',
|
|
4544
4464
|
qualified: 'client.pipelines.metadata.create',
|
|
4545
|
-
params: ['pipeline_id: string;', 'upload_file: string;'],
|
|
4465
|
+
params: ['pipeline_id: string;', 'upload_file: string;', 'project_id?: string;'],
|
|
4546
4466
|
response: 'object',
|
|
4547
4467
|
markdown:
|
|
4548
|
-
"## 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```",
|
|
4468
|
+
"## 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```",
|
|
4549
4469
|
perLanguage: {
|
|
4550
4470
|
go: {
|
|
4551
4471
|
method: 'client.Pipelines.Metadata.New',
|
|
@@ -4591,19 +4511,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4591
4511
|
description: 'Delete metadata for all files in a pipeline.',
|
|
4592
4512
|
stainlessPath: '(resource) pipelines.metadata > (method) delete_all',
|
|
4593
4513
|
qualified: 'client.pipelines.metadata.deleteAll',
|
|
4594
|
-
params: ['pipeline_id: string;'],
|
|
4514
|
+
params: ['pipeline_id: string;', 'project_id?: string;'],
|
|
4595
4515
|
markdown:
|
|
4596
|
-
"## 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```",
|
|
4516
|
+
"## 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```",
|
|
4597
4517
|
perLanguage: {
|
|
4598
4518
|
go: {
|
|
4599
4519
|
method: 'client.Pipelines.Metadata.DeleteAll',
|
|
4600
4520
|
example:
|
|
4601
|
-
'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(
|
|
4521
|
+
'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',
|
|
4602
4522
|
},
|
|
4603
4523
|
python: {
|
|
4604
4524
|
method: 'pipelines.metadata.delete_all',
|
|
4605
4525
|
example:
|
|
4606
|
-
'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)',
|
|
4526
|
+
'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)',
|
|
4607
4527
|
},
|
|
4608
4528
|
java: {
|
|
4609
4529
|
method: 'pipelines().metadata().deleteAll',
|
|
@@ -4642,11 +4562,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4642
4562
|
params: [
|
|
4643
4563
|
'pipeline_id: string;',
|
|
4644
4564
|
'body: { metadata: object; text: string; id?: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; }[];',
|
|
4565
|
+
'project_id?: string;',
|
|
4645
4566
|
],
|
|
4646
4567
|
response:
|
|
4647
4568
|
'{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }[]',
|
|
4648
4569
|
markdown:
|
|
4649
|
-
"## 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```",
|
|
4570
|
+
"## 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```",
|
|
4650
4571
|
perLanguage: {
|
|
4651
4572
|
go: {
|
|
4652
4573
|
method: 'client.Pipelines.Documents.New',
|
|
@@ -4698,13 +4619,14 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4698
4619
|
'limit?: number;',
|
|
4699
4620
|
'only_api_data_source_documents?: boolean;',
|
|
4700
4621
|
'only_direct_upload?: boolean;',
|
|
4622
|
+
'project_id?: string;',
|
|
4701
4623
|
'skip?: number;',
|
|
4702
4624
|
"status_refresh_policy?: 'cached' | 'ttl';",
|
|
4703
4625
|
],
|
|
4704
4626
|
response:
|
|
4705
4627
|
'{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }',
|
|
4706
4628
|
markdown:
|
|
4707
|
-
"## 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```",
|
|
4629
|
+
"## 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```",
|
|
4708
4630
|
perLanguage: {
|
|
4709
4631
|
go: {
|
|
4710
4632
|
method: 'client.Pipelines.Documents.List',
|
|
@@ -4756,11 +4678,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4756
4678
|
'data_source_id?: string;',
|
|
4757
4679
|
'file_id?: string;',
|
|
4758
4680
|
'only_direct_upload?: boolean;',
|
|
4681
|
+
'project_id?: string;',
|
|
4759
4682
|
],
|
|
4760
4683
|
response:
|
|
4761
4684
|
'{ counts: object; pipeline_id: string; total_count: number; data_source_id?: string; file_id?: string; only_direct_upload?: boolean; }',
|
|
4762
4685
|
markdown:
|
|
4763
|
-
"## 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```",
|
|
4686
|
+
"## 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```",
|
|
4764
4687
|
perLanguage: {
|
|
4765
4688
|
go: {
|
|
4766
4689
|
method: 'client.Pipelines.Documents.GetStatusCounts',
|
|
@@ -4806,11 +4729,11 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4806
4729
|
description: 'Return a single document for a pipeline.',
|
|
4807
4730
|
stainlessPath: '(resource) pipelines.documents > (method) get',
|
|
4808
4731
|
qualified: 'client.pipelines.documents.get',
|
|
4809
|
-
params: ['pipeline_id: string;', 'document_id: string;'],
|
|
4732
|
+
params: ['pipeline_id: string;', 'document_id: string;', 'project_id?: string;'],
|
|
4810
4733
|
response:
|
|
4811
4734
|
'{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }',
|
|
4812
4735
|
markdown:
|
|
4813
|
-
"## 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```",
|
|
4736
|
+
"## 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```",
|
|
4814
4737
|
perLanguage: {
|
|
4815
4738
|
go: {
|
|
4816
4739
|
method: 'client.Pipelines.Documents.Get',
|
|
@@ -4856,9 +4779,9 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4856
4779
|
description: 'Delete a document from a pipeline; runs async (vectors first, then MongoDB record).',
|
|
4857
4780
|
stainlessPath: '(resource) pipelines.documents > (method) delete',
|
|
4858
4781
|
qualified: 'client.pipelines.documents.delete',
|
|
4859
|
-
params: ['pipeline_id: string;', 'document_id: string;'],
|
|
4782
|
+
params: ['pipeline_id: string;', 'document_id: string;', 'project_id?: string;'],
|
|
4860
4783
|
markdown:
|
|
4861
|
-
"## 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```",
|
|
4784
|
+
"## 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```",
|
|
4862
4785
|
perLanguage: {
|
|
4863
4786
|
go: {
|
|
4864
4787
|
method: 'client.Pipelines.Documents.Delete',
|
|
@@ -4904,11 +4827,11 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4904
4827
|
description: 'Return a single document for a pipeline.',
|
|
4905
4828
|
stainlessPath: '(resource) pipelines.documents > (method) get_status',
|
|
4906
4829
|
qualified: 'client.pipelines.documents.getStatus',
|
|
4907
|
-
params: ['pipeline_id: string;', 'document_id: string;'],
|
|
4830
|
+
params: ['pipeline_id: string;', 'document_id: string;', 'project_id?: string;'],
|
|
4908
4831
|
response:
|
|
4909
4832
|
"{ 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; }",
|
|
4910
4833
|
markdown:
|
|
4911
|
-
"## 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```",
|
|
4834
|
+
"## 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```",
|
|
4912
4835
|
perLanguage: {
|
|
4913
4836
|
go: {
|
|
4914
4837
|
method: 'client.Pipelines.Documents.GetStatus',
|
|
@@ -4954,10 +4877,10 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4954
4877
|
description: 'Sync a specific document for a pipeline.',
|
|
4955
4878
|
stainlessPath: '(resource) pipelines.documents > (method) sync',
|
|
4956
4879
|
qualified: 'client.pipelines.documents.sync',
|
|
4957
|
-
params: ['pipeline_id: string;', 'document_id: string;'],
|
|
4880
|
+
params: ['pipeline_id: string;', 'document_id: string;', 'project_id?: string;'],
|
|
4958
4881
|
response: 'object',
|
|
4959
4882
|
markdown:
|
|
4960
|
-
"## 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```",
|
|
4883
|
+
"## 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```",
|
|
4961
4884
|
perLanguage: {
|
|
4962
4885
|
go: {
|
|
4963
4886
|
method: 'client.Pipelines.Documents.Sync',
|
|
@@ -5003,11 +4926,11 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5003
4926
|
description: 'Return a list of chunks for a pipeline document.',
|
|
5004
4927
|
stainlessPath: '(resource) pipelines.documents > (method) get_chunks',
|
|
5005
4928
|
qualified: 'client.pipelines.documents.getChunks',
|
|
5006
|
-
params: ['pipeline_id: string;', 'document_id: string;'],
|
|
4929
|
+
params: ['pipeline_id: string;', 'document_id: string;', 'project_id?: string;'],
|
|
5007
4930
|
response:
|
|
5008
4931
|
'{ 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; }[]',
|
|
5009
4932
|
markdown:
|
|
5010
|
-
"## 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```",
|
|
4933
|
+
"## 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```",
|
|
5011
4934
|
perLanguage: {
|
|
5012
4935
|
go: {
|
|
5013
4936
|
method: 'client.Pipelines.Documents.GetChunks',
|
|
@@ -5056,11 +4979,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5056
4979
|
params: [
|
|
5057
4980
|
'pipeline_id: string;',
|
|
5058
4981
|
'body: { metadata: object; text: string; id?: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; }[];',
|
|
4982
|
+
'project_id?: string;',
|
|
5059
4983
|
],
|
|
5060
4984
|
response:
|
|
5061
4985
|
'{ id: string; metadata: object; text: string; excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; page_positions?: number[]; status_metadata?: object; }[]',
|
|
5062
4986
|
markdown:
|
|
5063
|
-
"## 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```",
|
|
4987
|
+
"## 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```",
|
|
5064
4988
|
perLanguage: {
|
|
5065
4989
|
go: {
|
|
5066
4990
|
method: 'client.Pipelines.Documents.Upsert',
|
|
@@ -5805,7 +5729,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5805
5729
|
response:
|
|
5806
5730
|
'{ 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; }; }[]; }',
|
|
5807
5731
|
markdown:
|
|
5808
|
-
"## 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```",
|
|
5732
|
+
"## 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```",
|
|
5809
5733
|
perLanguage: {
|
|
5810
5734
|
go: {
|
|
5811
5735
|
method: 'client.Beta.Retrieval.Get',
|
|
@@ -7329,13 +7253,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
7329
7253
|
'document_input: { type: string; value: string; };',
|
|
7330
7254
|
'organization_id?: string;',
|
|
7331
7255
|
'project_id?: string;',
|
|
7332
|
-
"configuration?: { categories: { name: string; description?: string; }[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; };",
|
|
7256
|
+
"configuration?: { categories: { name: string; description?: string; }[]; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; custom_instructions?: string; min_pages_per_split?: number; }; };",
|
|
7333
7257
|
'configuration_id?: string;',
|
|
7334
7258
|
],
|
|
7335
7259
|
response:
|
|
7336
7260
|
'{ 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; }',
|
|
7337
7261
|
markdown:
|
|
7338
|
-
"## 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```",
|
|
7262
|
+
"## 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```",
|
|
7339
7263
|
perLanguage: {
|
|
7340
7264
|
go: {
|
|
7341
7265
|
method: 'client.Beta.Split.New',
|
|
@@ -7562,7 +7486,7 @@ const EMBEDDED_READMES: { language: string; content: string }[] = [
|
|
|
7562
7486
|
{
|
|
7563
7487
|
language: 'go',
|
|
7564
7488
|
content:
|
|
7565
|
-
'# 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',
|
|
7489
|
+
'# 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',
|
|
7566
7490
|
},
|
|
7567
7491
|
{
|
|
7568
7492
|
language: 'python',
|
|
@@ -7572,7 +7496,7 @@ const EMBEDDED_READMES: { language: string; content: string }[] = [
|
|
|
7572
7496
|
{
|
|
7573
7497
|
language: 'java',
|
|
7574
7498
|
content:
|
|
7575
|
-
'# 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',
|
|
7499
|
+
'# 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',
|
|
7576
7500
|
},
|
|
7577
7501
|
{
|
|
7578
7502
|
language: 'csharp',
|