@llamaindex/llama-cloud-mcp 2.14.1 → 2.15.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.
@@ -277,244 +277,6 @@ const EMBEDDED_METHODS = [
277
277
  },
278
278
  },
279
279
  },
280
- {
281
- name: 'create',
282
- endpoint: '/api/v1/sheets/jobs',
283
- httpMethod: 'post',
284
- summary: 'Create Spreadsheet Job',
285
- description: 'Create a spreadsheet parsing job.\n\nProvide at most one of `configuration` (an inline parsing configuration) or\n`configuration_id` (a saved configuration preset). If neither is provided, a\ndefault configuration is used. Optionally include `webhook_configurations`\nto receive `sheets.*` status notifications.',
286
- stainlessPath: '(resource) sheets > (method) create',
287
- qualified: 'client.sheets.create',
288
- params: [
289
- 'file_id: string;',
290
- 'organization_id?: string;',
291
- 'project_id?: string;',
292
- "config?: { 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; };",
293
- "configuration?: { 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; };",
294
- 'configuration_id?: string;',
295
- 'webhook_configuration_ids?: string[];',
296
- 'webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[];',
297
- ],
298
- response: "{ id: string; configuration: object; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: object; configuration_id?: string; errors?: string[]; file?: object; metadata_state_transitions?: object; parameters?: { webhook_configurations?: object[]; }; regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]; success?: boolean; worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]; }",
299
- markdown: "## create\n\n`client.sheets.create(file_id: string, organization_id?: string, project_id?: string, config?: { 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; }, configuration?: { 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; }, 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; configuration: sheets_parsing_config; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: sheets_parsing_config; configuration_id?: string; errors?: string[]; file?: file; metadata_state_transitions?: object; parameters?: object; regions?: object[]; success?: boolean; worksheet_metadata?: object[]; }`\n\n**post** `/api/v1/sheets/jobs`\n\nCreate a spreadsheet parsing job.\n\nProvide at most one of `configuration` (an inline parsing configuration) or\n`configuration_id` (a saved configuration preset). If neither is provided, a\ndefault configuration is used. Optionally include `webhook_configurations`\nto receive `sheets.*` status notifications.\n\n### Parameters\n\n- `file_id: string`\n The ID of the file to parse\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `config?: { 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; }`\n Configuration for spreadsheet parsing and region extraction\n - `extraction_range?: string`\n A1 notation of the range to extract a single region from. If None, the entire sheet is used.\n - `flatten_hierarchical_tables?: boolean`\n Return a flattened dataframe when a detected table is recognized as hierarchical.\n - `generate_additional_metadata?: boolean`\n Deprecated: controlled by `tier`. Whether to generate additional metadata (title, description) for each extracted region. Honored only on `agentic`.\n - `include_hidden_cells?: boolean`\n Whether to include hidden cells when extracting regions from the spreadsheet.\n - `sheet_names?: string[]`\n The names of the sheets to extract regions from. If empty, all sheets will be processed.\n - `specialization?: string`\n Deprecated: controlled by `tier`. Optional specialization mode for domain-specific extraction. Supported values: 'financial-standard', 'financial-enhanced', 'financial-precise'. Default None uses the general-purpose pipeline. Honored only on `agentic`.\n - `table_merge_sensitivity?: 'strong' | 'weak'`\n Deprecated: controlled by `tier`. Influences how likely similar-looking regions are merged into a single table. Honored only on `agentic`.\n - `tier?: 'agentic' | 'cost_effective'`\n Spreadsheet extraction tier. `cost_effective` uses the rule-based/ML-only pipeline; `agentic` uses the full pipeline.\n - `use_experimental_processing?: boolean`\n Deprecated: controlled by `tier`. Enables experimental processing. Honored only on `agentic`.\n\n- `configuration?: { 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; }`\n Configuration for spreadsheet parsing and region extraction\n - `extraction_range?: string`\n A1 notation of the range to extract a single region from. If None, the entire sheet is used.\n - `flatten_hierarchical_tables?: boolean`\n Return a flattened dataframe when a detected table is recognized as hierarchical.\n - `generate_additional_metadata?: boolean`\n Deprecated: controlled by `tier`. Whether to generate additional metadata (title, description) for each extracted region. Honored only on `agentic`.\n - `include_hidden_cells?: boolean`\n Whether to include hidden cells when extracting regions from the spreadsheet.\n - `sheet_names?: string[]`\n The names of the sheets to extract regions from. If empty, all sheets will be processed.\n - `specialization?: string`\n Deprecated: controlled by `tier`. Optional specialization mode for domain-specific extraction. Supported values: 'financial-standard', 'financial-enhanced', 'financial-precise'. Default None uses the general-purpose pipeline. Honored only on `agentic`.\n - `table_merge_sensitivity?: 'strong' | 'weak'`\n Deprecated: controlled by `tier`. Influences how likely similar-looking regions are merged into a single table. Honored only on `agentic`.\n - `tier?: 'agentic' | 'cost_effective'`\n Spreadsheet extraction tier. `cost_effective` uses the rule-based/ML-only pipeline; `agentic` uses the full pipeline.\n - `use_experimental_processing?: boolean`\n Deprecated: controlled by `tier`. Enables experimental processing. Honored only on `agentic`.\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; configuration: { 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; }; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: { 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; }; configuration_id?: string; errors?: string[]; file?: { id: string; name: string; project_id: string; created_at?: string; data_source_id?: string; expires_at?: string; external_file_id?: string; file_size?: number; file_type?: string; last_modified_at?: string; permission_info?: object; purpose?: string; resource_info?: object; updated_at?: string; }; metadata_state_transitions?: object; parameters?: { webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; }; regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]; success?: boolean; worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]; }`\n A spreadsheet parsing job.\n\n - `id: string`\n - `configuration: { 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; }`\n - `created_at: string`\n - `file_id: string`\n - `project_id: string`\n - `status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'`\n - `updated_at: string`\n - `user_id: string`\n - `config?: { 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; }`\n - `configuration_id?: string`\n - `errors?: string[]`\n - `file?: { id: string; name: string; project_id: string; created_at?: string; data_source_id?: string; expires_at?: string; external_file_id?: string; file_size?: number; file_type?: string; last_modified_at?: string; permission_info?: object; purpose?: string; resource_info?: object; updated_at?: string; }`\n - `metadata_state_transitions?: object`\n - `parameters?: { webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; }`\n - `regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]`\n - `success?: boolean`\n - `worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst sheetsJob = await client.sheets.create({ file_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(sheetsJob);\n```",
300
- perLanguage: {
301
- go: {
302
- method: 'client.Sheets.New',
303
- example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tsheetsJob, err := client.Sheets.New(context.TODO(), llamacloud.SheetNewParams{\n\t\tFileID: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sheetsJob.ID)\n}\n',
304
- },
305
- python: {
306
- method: 'sheets.create',
307
- example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nsheets_job = client.sheets.create(\n file_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(sheets_job.id)',
308
- },
309
- java: {
310
- method: 'sheets().create',
311
- example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.beta.sheets.SheetsJob;\nimport ai.llamaindex.llamacloud.models.sheets.SheetCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n SheetCreateParams params = SheetCreateParams.builder()\n .fileId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n .build();\n SheetsJob sheetsJob = client.sheets().create(params);\n }\n}',
312
- },
313
- csharp: {
314
- method: 'Sheets.Create',
315
- example: 'SheetCreateParams parameters = new()\n{\n FileID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n};\n\nvar sheetsJob = await client.Sheets.Create(parameters);\n\nConsole.WriteLine(sheetsJob);',
316
- },
317
- typescript: {
318
- method: 'client.sheets.create',
319
- example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\nconst sheetsJob = await client.sheets.create({ file_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(sheetsJob.id);",
320
- },
321
- http: {
322
- example: 'curl https://api.cloud.llamaindex.ai/api/v1/sheets/jobs \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \\\n -d \'{\n "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n "configuration_id": "cfg-11111111-2222-3333-4444-555555555555",\n "webhook_configuration_ids": [\n "whc-...",\n "whc-..."\n ]\n }\'',
323
- },
324
- cli: {
325
- method: 'sheets create',
326
- example: "llp sheets create \\\n --api-key 'My API Key' \\\n --file-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
327
- },
328
- },
329
- },
330
- {
331
- name: 'list',
332
- endpoint: '/api/v1/sheets/jobs',
333
- httpMethod: 'get',
334
- summary: 'List Spreadsheet Jobs',
335
- description: 'List spreadsheet parsing jobs.',
336
- stainlessPath: '(resource) sheets > (method) list',
337
- qualified: 'client.sheets.list',
338
- params: [
339
- 'configuration_id?: string;',
340
- 'created_at_on_or_after?: string;',
341
- 'created_at_on_or_before?: string;',
342
- 'include_results?: boolean;',
343
- 'job_ids?: string[];',
344
- 'organization_id?: string;',
345
- 'page_size?: number;',
346
- 'page_token?: string;',
347
- 'project_id?: string;',
348
- "status?: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS';",
349
- ],
350
- response: "{ id: string; configuration: object; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: object; configuration_id?: string; errors?: string[]; file?: object; metadata_state_transitions?: object; parameters?: { webhook_configurations?: object[]; }; regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]; success?: boolean; worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]; }",
351
- markdown: "## list\n\n`client.sheets.list(configuration_id?: string, created_at_on_or_after?: string, created_at_on_or_before?: string, include_results?: boolean, job_ids?: string[], organization_id?: string, page_size?: number, page_token?: string, project_id?: string, status?: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'): { id: string; configuration: sheets_parsing_config; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: sheets_parsing_config; configuration_id?: string; errors?: string[]; file?: file; metadata_state_transitions?: object; parameters?: object; regions?: object[]; success?: boolean; worksheet_metadata?: object[]; }`\n\n**get** `/api/v1/sheets/jobs`\n\nList spreadsheet parsing jobs.\n\n### Parameters\n\n- `configuration_id?: string`\n Filter by saved 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- `include_results?: boolean`\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' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'`\n Filter by job status\n\n### Returns\n\n- `{ id: string; configuration: { 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; }; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: { 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; }; configuration_id?: string; errors?: string[]; file?: { id: string; name: string; project_id: string; created_at?: string; data_source_id?: string; expires_at?: string; external_file_id?: string; file_size?: number; file_type?: string; last_modified_at?: string; permission_info?: object; purpose?: string; resource_info?: object; updated_at?: string; }; metadata_state_transitions?: object; parameters?: { webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; }; regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]; success?: boolean; worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]; }`\n A spreadsheet parsing job.\n\n - `id: string`\n - `configuration: { 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; }`\n - `created_at: string`\n - `file_id: string`\n - `project_id: string`\n - `status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'`\n - `updated_at: string`\n - `user_id: string`\n - `config?: { 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; }`\n - `configuration_id?: string`\n - `errors?: string[]`\n - `file?: { id: string; name: string; project_id: string; created_at?: string; data_source_id?: string; expires_at?: string; external_file_id?: string; file_size?: number; file_type?: string; last_modified_at?: string; permission_info?: object; purpose?: string; resource_info?: object; updated_at?: string; }`\n - `metadata_state_transitions?: object`\n - `parameters?: { webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; }`\n - `regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]`\n - `success?: boolean`\n - `worksheet_metadata?: { sheet_name: string; description?: string; title?: 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 sheetsJob of client.sheets.list()) {\n console.log(sheetsJob);\n}\n```",
352
- perLanguage: {
353
- go: {
354
- method: 'client.Sheets.List',
355
- example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpage, err := client.Sheets.List(context.TODO(), llamacloud.SheetListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n',
356
- },
357
- python: {
358
- method: 'sheets.list',
359
- example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\npage = client.sheets.list()\npage = page.items[0]\nprint(page.id)',
360
- },
361
- java: {
362
- method: 'sheets().list',
363
- example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.sheets.SheetListPage;\nimport ai.llamaindex.llamacloud.models.sheets.SheetListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n SheetListPage page = client.sheets().list();\n }\n}',
364
- },
365
- csharp: {
366
- method: 'Sheets.List',
367
- example: 'SheetListParams parameters = new();\n\nvar page = await client.Sheets.List(parameters);\nawait foreach (var item in page.Paginate())\n{\n Console.WriteLine(item);\n}',
368
- },
369
- typescript: {
370
- method: 'client.sheets.list',
371
- example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const sheetsJob of client.sheets.list()) {\n console.log(sheetsJob.id);\n}",
372
- },
373
- http: {
374
- example: 'curl https://api.cloud.llamaindex.ai/api/v1/sheets/jobs \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
375
- },
376
- cli: {
377
- method: 'sheets list',
378
- example: "llp sheets list \\\n --api-key 'My API Key'",
379
- },
380
- },
381
- },
382
- {
383
- name: 'get',
384
- endpoint: '/api/v1/sheets/jobs/{spreadsheet_job_id}',
385
- httpMethod: 'get',
386
- summary: 'Get Spreadsheet Job',
387
- description: 'Get a spreadsheet parsing job. When `include_results=True` (default), embeds extracted regions and results if complete, skipping the separate `/results` call.',
388
- stainlessPath: '(resource) sheets > (method) get',
389
- qualified: 'client.sheets.get',
390
- params: [
391
- 'spreadsheet_job_id: string;',
392
- 'expand?: string[];',
393
- 'include_results?: boolean;',
394
- 'organization_id?: string;',
395
- 'project_id?: string;',
396
- ],
397
- response: "{ id: string; configuration: object; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: object; configuration_id?: string; errors?: string[]; file?: object; metadata_state_transitions?: object; parameters?: { webhook_configurations?: object[]; }; regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]; success?: boolean; worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]; }",
398
- markdown: "## get\n\n`client.sheets.get(spreadsheet_job_id: string, expand?: string[], include_results?: boolean, organization_id?: string, project_id?: string): { id: string; configuration: sheets_parsing_config; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: sheets_parsing_config; configuration_id?: string; errors?: string[]; file?: file; metadata_state_transitions?: object; parameters?: object; regions?: object[]; success?: boolean; worksheet_metadata?: object[]; }`\n\n**get** `/api/v1/sheets/jobs/{spreadsheet_job_id}`\n\nGet a spreadsheet parsing job. When `include_results=True` (default), embeds extracted regions and results if complete, skipping the separate `/results` call.\n\n### Parameters\n\n- `spreadsheet_job_id: string`\n\n- `expand?: string[]`\n Optional fields to populate on the response. Valid values: metadata_state_transitions.\n\n- `include_results?: boolean`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; configuration: { 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; }; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: { 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; }; configuration_id?: string; errors?: string[]; file?: { id: string; name: string; project_id: string; created_at?: string; data_source_id?: string; expires_at?: string; external_file_id?: string; file_size?: number; file_type?: string; last_modified_at?: string; permission_info?: object; purpose?: string; resource_info?: object; updated_at?: string; }; metadata_state_transitions?: object; parameters?: { webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; }; regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]; success?: boolean; worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]; }`\n A spreadsheet parsing job.\n\n - `id: string`\n - `configuration: { 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; }`\n - `created_at: string`\n - `file_id: string`\n - `project_id: string`\n - `status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'`\n - `updated_at: string`\n - `user_id: string`\n - `config?: { 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; }`\n - `configuration_id?: string`\n - `errors?: string[]`\n - `file?: { id: string; name: string; project_id: string; created_at?: string; data_source_id?: string; expires_at?: string; external_file_id?: string; file_size?: number; file_type?: string; last_modified_at?: string; permission_info?: object; purpose?: string; resource_info?: object; updated_at?: string; }`\n - `metadata_state_transitions?: object`\n - `parameters?: { webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; }`\n - `regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]`\n - `success?: boolean`\n - `worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst sheetsJob = await client.sheets.get('spreadsheet_job_id');\n\nconsole.log(sheetsJob);\n```",
399
- perLanguage: {
400
- go: {
401
- method: 'client.Sheets.Get',
402
- example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tsheetsJob, err := client.Sheets.Get(\n\t\tcontext.TODO(),\n\t\t"spreadsheet_job_id",\n\t\tllamacloud.SheetGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sheetsJob.ID)\n}\n',
403
- },
404
- python: {
405
- method: 'sheets.get',
406
- example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nsheets_job = client.sheets.get(\n spreadsheet_job_id="spreadsheet_job_id",\n)\nprint(sheets_job.id)',
407
- },
408
- java: {
409
- method: 'sheets().get',
410
- example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.beta.sheets.SheetsJob;\nimport ai.llamaindex.llamacloud.models.sheets.SheetGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n SheetsJob sheetsJob = client.sheets().get("spreadsheet_job_id");\n }\n}',
411
- },
412
- csharp: {
413
- method: 'Sheets.Get',
414
- example: 'SheetGetParams parameters = new() { SpreadsheetJobID = "spreadsheet_job_id" };\n\nvar sheetsJob = await client.Sheets.Get(parameters);\n\nConsole.WriteLine(sheetsJob);',
415
- },
416
- typescript: {
417
- method: 'client.sheets.get',
418
- example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\nconst sheetsJob = await client.sheets.get('spreadsheet_job_id');\n\nconsole.log(sheetsJob.id);",
419
- },
420
- http: {
421
- example: 'curl https://api.cloud.llamaindex.ai/api/v1/sheets/jobs/$SPREADSHEET_JOB_ID \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
422
- },
423
- cli: {
424
- method: 'sheets get',
425
- example: "llp sheets get \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id",
426
- },
427
- },
428
- },
429
- {
430
- name: 'get_result_table',
431
- endpoint: '/api/v1/sheets/jobs/{spreadsheet_job_id}/regions/{region_id}/result/{region_type}',
432
- httpMethod: 'get',
433
- summary: 'Get Result Region',
434
- description: 'Generate a presigned URL to download a specific extracted region.',
435
- stainlessPath: '(resource) sheets > (method) get_result_table',
436
- qualified: 'client.sheets.getResultTable',
437
- params: [
438
- 'spreadsheet_job_id: string;',
439
- 'region_id: string;',
440
- "region_type: 'cell_metadata' | 'extra' | 'table';",
441
- 'expires_at_seconds?: number;',
442
- 'organization_id?: string;',
443
- 'project_id?: string;',
444
- ],
445
- response: '{ expires_at: string; url: string; form_fields?: object; }',
446
- markdown: "## get_result_table\n\n`client.sheets.getResultTable(spreadsheet_job_id: string, region_id: string, region_type: 'cell_metadata' | 'extra' | 'table', expires_at_seconds?: number, organization_id?: string, project_id?: string): { expires_at: string; url: string; form_fields?: object; }`\n\n**get** `/api/v1/sheets/jobs/{spreadsheet_job_id}/regions/{region_id}/result/{region_type}`\n\nGenerate a presigned URL to download a specific extracted region.\n\n### Parameters\n\n- `spreadsheet_job_id: string`\n\n- `region_id: string`\n\n- `region_type: 'cell_metadata' | 'extra' | 'table'`\n\n- `expires_at_seconds?: number`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ expires_at: string; url: string; form_fields?: object; }`\n Schema for a presigned URL.\n\n - `expires_at: string`\n - `url: string`\n - `form_fields?: object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst presignedURL = await client.sheets.getResultTable('cell_metadata', { spreadsheet_job_id: 'spreadsheet_job_id', region_id: 'region_id' });\n\nconsole.log(presignedURL);\n```",
447
- perLanguage: {
448
- go: {
449
- method: 'client.Sheets.GetResultTable',
450
- example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpresignedURL, err := client.Sheets.GetResultTable(\n\t\tcontext.TODO(),\n\t\tllamacloud.SheetGetResultTableParamsRegionTypeCellMetadata,\n\t\tllamacloud.SheetGetResultTableParams{\n\t\t\tSpreadsheetJobID: "spreadsheet_job_id",\n\t\t\tRegionID: "region_id",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", presignedURL.ExpiresAt)\n}\n',
451
- },
452
- python: {
453
- method: 'sheets.get_result_table',
454
- example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\npresigned_url = client.sheets.get_result_table(\n region_type="cell_metadata",\n spreadsheet_job_id="spreadsheet_job_id",\n region_id="region_id",\n)\nprint(presigned_url.expires_at)',
455
- },
456
- java: {
457
- method: 'sheets().getResultTable',
458
- example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.files.PresignedUrl;\nimport ai.llamaindex.llamacloud.models.sheets.SheetGetResultTableParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n SheetGetResultTableParams params = SheetGetResultTableParams.builder()\n .spreadsheetJobId("spreadsheet_job_id")\n .regionId("region_id")\n .regionType(SheetGetResultTableParams.RegionType.CELL_METADATA)\n .build();\n PresignedUrl presignedUrl = client.sheets().getResultTable(params);\n }\n}',
459
- },
460
- csharp: {
461
- method: 'Sheets.GetResultTable',
462
- example: 'SheetGetResultTableParams parameters = new()\n{\n SpreadsheetJobID = "spreadsheet_job_id",\n RegionID = "region_id",\n RegionType = RegionType.CellMetadata,\n};\n\nvar presignedUrl = await client.Sheets.GetResultTable(parameters);\n\nConsole.WriteLine(presignedUrl);',
463
- },
464
- typescript: {
465
- method: 'client.sheets.getResultTable',
466
- example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\nconst presignedURL = await client.sheets.getResultTable('cell_metadata', {\n spreadsheet_job_id: 'spreadsheet_job_id',\n region_id: 'region_id',\n});\n\nconsole.log(presignedURL.expires_at);",
467
- },
468
- http: {
469
- example: 'curl https://api.cloud.llamaindex.ai/api/v1/sheets/jobs/$SPREADSHEET_JOB_ID/regions/$REGION_ID/result/$REGION_TYPE \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
470
- },
471
- cli: {
472
- method: 'sheets get_result_table',
473
- example: "llp sheets get-result-table \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id \\\n --region-id region_id \\\n --region-type cell_metadata",
474
- },
475
- },
476
- },
477
- {
478
- name: 'delete_job',
479
- endpoint: '/api/v1/sheets/jobs/{spreadsheet_job_id}',
480
- httpMethod: 'delete',
481
- summary: 'Delete Spreadsheet Job',
482
- description: 'Delete a spreadsheet parsing job and its associated data.',
483
- stainlessPath: '(resource) sheets > (method) delete_job',
484
- qualified: 'client.sheets.deleteJob',
485
- params: ['spreadsheet_job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
486
- response: 'object',
487
- markdown: "## delete_job\n\n`client.sheets.deleteJob(spreadsheet_job_id: string, organization_id?: string, project_id?: string): object`\n\n**delete** `/api/v1/sheets/jobs/{spreadsheet_job_id}`\n\nDelete a spreadsheet parsing job and its associated data.\n\n### Parameters\n\n- `spreadsheet_job_id: string`\n\n- `organization_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.sheets.deleteJob('spreadsheet_job_id');\n\nconsole.log(response);\n```",
488
- perLanguage: {
489
- go: {
490
- method: 'client.Sheets.DeleteJob',
491
- example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tresponse, err := client.Sheets.DeleteJob(\n\t\tcontext.TODO(),\n\t\t"spreadsheet_job_id",\n\t\tllamacloud.SheetDeleteJobParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n',
492
- },
493
- python: {
494
- method: 'sheets.delete_job',
495
- example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nresponse = client.sheets.delete_job(\n spreadsheet_job_id="spreadsheet_job_id",\n)\nprint(response)',
496
- },
497
- java: {
498
- method: 'sheets().deleteJob',
499
- example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.sheets.SheetDeleteJobParams;\nimport ai.llamaindex.llamacloud.models.sheets.SheetDeleteJobResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n SheetDeleteJobResponse response = client.sheets().deleteJob("spreadsheet_job_id");\n }\n}',
500
- },
501
- csharp: {
502
- method: 'Sheets.DeleteJob',
503
- example: 'SheetDeleteJobParams parameters = new()\n{\n SpreadsheetJobID = "spreadsheet_job_id"\n};\n\nvar response = await client.Sheets.DeleteJob(parameters);\n\nConsole.WriteLine(response);',
504
- },
505
- typescript: {
506
- method: 'client.sheets.deleteJob',
507
- example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.sheets.deleteJob('spreadsheet_job_id');\n\nconsole.log(response);",
508
- },
509
- http: {
510
- example: 'curl https://api.cloud.llamaindex.ai/api/v1/sheets/jobs/$SPREADSHEET_JOB_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
511
- },
512
- cli: {
513
- method: 'sheets delete_job',
514
- example: "llp sheets delete-job \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id",
515
- },
516
- },
517
- },
518
280
  {
519
281
  name: 'create',
520
282
  endpoint: '/api/v1/split/jobs',
@@ -760,7 +522,7 @@ const EMBEDDED_METHODS = [
760
522
  'file_id?: string;',
761
523
  'http_proxy?: string;',
762
524
  '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; }; };',
763
- "output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { 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; }; };",
525
+ "output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: { compact_markdown_tables?: boolean; markdown_table_multiline_separator?: string; merge_continued_tables?: boolean; output_tables_as_markdown?: boolean; }; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; };",
764
526
  'page_ranges?: { max_pages?: number; target_pages?: string; };',
765
527
  'processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; };',
766
528
  "processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; custom_prompt?: string; extract_layout?: boolean; high_res_ocr?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; }; language?: string; outlined_table_extraction?: boolean; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version?: 'latest' | '2026-08-19' | '2026-06-15' | string; }; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: string[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; };",
@@ -770,7 +532,7 @@ const EMBEDDED_METHODS = [
770
532
  "webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[];",
771
533
  ],
772
534
  response: "{ id: string; project_id: string; status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'; created_at?: string; error_message?: string; name?: string; tier?: string; updated_at?: string; usage?: { credits?: number; }; user_metadata?: object; }",
773
- markdown: "## create\n\n`client.parsing.create(tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus' | string, version: 'latest' | '2026-08-19' | '2026-06-15' | string, organization_id?: string, project_id?: string, agentic_options?: { custom_prompt?: string; }, client_name?: string, configuration_id?: string, crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }, disable_cache?: boolean, fast_options?: object, file_id?: string, http_proxy?: string, input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }, output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_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_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_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: { compact_markdown_tables?: boolean; markdown_table_multiline_separator?: string; merge_continued_tables?: boolean; output_tables_as_markdown?: boolean; }; }`\n Markdown formatting options including table styles and link annotations\n - `save_output_pdf?: boolean`\n Save a PDF copy of the parsed document, retrievable via `expand=output_pdf_content_metadata`. Not produced for spreadsheet, plain-text, or audio inputs\n - `spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }`\n Spatial text output options for preserving document layout structure\n - `tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }`\n Options for exporting tables as XLSX spreadsheets\n\n- `page_ranges?: { max_pages?: number; target_pages?: string; }`\n Page selection: limit total pages or specify exact pages to process\n - `max_pages?: number`\n Maximum number of pages to process. Pages are processed in order starting from page 1. If both max_pages and target_pages are set, target_pages takes precedence\n - `target_pages?: string`\n Comma-separated list of specific pages to process using 1-based indexing. Supports individual pages and ranges. Examples: '1,3,5' (pages 1, 3, 5), '1-5' (pages 1 through 5 inclusive), '1,3,5-8,10' (pages 1, 3, 5-8, and 10). Pages are sorted and deduplicated automatically. Duplicate pages cause an error\n\n- `processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }`\n Job execution controls including timeouts and failure thresholds\n - `job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }`\n Quality thresholds that determine when a job should fail vs complete with partial results\n - `timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }`\n Timeout settings for job execution. Increase for large or complex documents\n\n- `processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; custom_prompt?: string; extract_layout?: boolean; high_res_ocr?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; }; language?: string; outlined_table_extraction?: boolean; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version?: 'latest' | '2026-08-19' | '2026-06-15' | string; }; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: string[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }`\n Document processing options including OCR, table extraction, and chart parsing\n - `aggressive_table_extraction?: boolean`\n Use aggressive heuristics to detect table boundaries, even without visible borders. Useful for documents with borderless or complex tables\n - `auto_mode_configuration?: { parsing_conf: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; custom_prompt?: string; extract_layout?: boolean; high_res_ocr?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; }; language?: string; outlined_table_extraction?: boolean; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version?: 'latest' | '2026-08-19' | '2026-06-15' | string; }; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]`\n Conditional processing rules that apply different parsing options based on page content, document structure, or filename patterns. Each entry defines trigger conditions and the parsing configuration to apply when triggered\n - `confidence_score_effort?: 'high'`\n Confidence scoring effort. Omit for standard scoring. 'high': more accurate assessment of the parsing quality of every page, plus a document-level score in the result metadata; costs an additional 5 credits per page\n - `cost_optimizer?: { enable?: boolean; }`\n Cost optimizer configuration for reducing parsing costs on simpler pages.\n\nWhen enabled, the parser analyzes each page and routes simpler pages to faster,\ncheaper processing while preserving quality for complex pages. Only works with\n'agentic' or 'agentic_plus' tiers.\n - `disable_heuristics?: boolean`\n Disable automatic heuristics including outlined table extraction and adaptive long table handling. Use when heuristics produce incorrect results\n - `forms?: 'default' | 'enrich'`\n Beta: set to 'enrich' to run an additional AI form-analysis pass on pages detected as forms, producing a structured tree of the form's sections, fields, and fillable grids. Retrieve the result with expand=forms. 'default' (the default) applies standard parsing with no extra pass. Not available on the fast tier\n - `ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }`\n Options for ignoring specific text types (diagonal, hidden, text in images)\n - `ocr_parameters?: { languages?: string[]; }`\n OCR configuration including language detection settings\n - `specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'`\n Enable AI-powered chart analysis. Modes: 'efficient' (fast, lower cost), 'agentic' (balanced), 'agentic_plus' (highest accuracy). Automatically enables extract_layout and precise_bounding_box when set\n\n- `source_url?: string`\n Public URL of the document to parse. Mutually exclusive with file_id\n\n- `user_metadata?: object`\n Arbitrary key/value tags to attach to this job. Returned when retrieving the job. Not searchable. Limits apply to the number of entries and the length of keys and values; oversized metadata is rejected.\n\n- `webhook_configuration_ids?: string[]`\n IDs of saved webhook configurations to notify for this job.\n\n- `webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]`\n Webhook endpoints for job status notifications. Multiple webhooks can be configured for different events or services\n\n### Returns\n\n- `{ id: string; project_id: string; status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'; created_at?: string; error_message?: string; name?: string; tier?: string; updated_at?: string; usage?: { credits?: number; }; user_metadata?: object; }`\n A parse job.\n\n - `id: string`\n - `project_id: string`\n - `status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'`\n - `created_at?: string`\n - `error_message?: string`\n - `name?: string`\n - `tier?: string`\n - `updated_at?: string`\n - `usage?: { credits?: number; }`\n - `user_metadata?: object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst parsing = await client.parsing.create({ tier: 'fast', version: 'latest' });\n\nconsole.log(parsing);\n```",
535
+ markdown: "## create\n\n`client.parsing.create(tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus' | string, version: 'latest' | '2026-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```",
774
536
  perLanguage: {
775
537
  go: {
776
538
  method: 'client.Parsing.New',
@@ -816,8 +578,8 @@ const EMBEDDED_METHODS = [
816
578
  'organization_id?: string;',
817
579
  'project_id?: string;',
818
580
  ],
819
- response: "{ job: { 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; }; forms?: { pages: object | object[]; }; images_content_metadata?: { images: object[]; total_count: number; }; items?: { pages: object | object[]; }; job_metadata?: object; markdown?: { pages: object | object[]; }; markdown_full?: string; metadata?: { pages: object[]; }; raw_parameters?: object; result_content_metadata?: object; text?: { pages: object[]; }; text_full?: string; }",
820
- markdown: "## get\n\n`client.parsing.get(job_id: string, expand?: string[], image_filenames?: string, organization_id?: string, project_id?: string): { job: object; forms?: object; images_content_metadata?: object; items?: object; job_metadata?: object; markdown?: object; markdown_full?: string; metadata?: object; raw_parameters?: object; result_content_metadata?: object; text?: object; text_full?: string; }`\n\n**get** `/api/v2/parse/{job_id}`\n\nRetrieve a parse job with optional expanded content.\n\nBy default returns job metadata only. Use `expand` to include\nparsed content:\n\n- `text` — plain text output\n- `markdown` — markdown output\n- `items` — structured page-by-page output\n- `job_metadata` — processing details\n- `usage` — credits billed against the job\n\nContent metadata fields (e.g. `text_content_metadata`) return\npresigned URLs for downloading large results.\n\n### Parameters\n\n- `job_id: string`\n\n- `expand?: string[]`\n Fields to include: text, markdown, items, metadata, forms, job_metadata, usage, text_content_metadata, markdown_content_metadata, items_content_metadata, metadata_content_metadata, forms_content_metadata, raw_words_content_metadata, xlsx_content_metadata, output_pdf_content_metadata, images_content_metadata. Metadata fields include presigned URLs.\n\n- `image_filenames?: string`\n Filter to specific image filenames (optional). Example: image_0.png,image_1.jpg\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ job: { 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; }; forms?: { pages: { forms: form[]; page_number: number; success: true; page_height?: number; page_width?: number; } | { error: string; page_number: number; success: false; }[]; }; images_content_metadata?: { images: { filename: string; index: number; bbox?: object; category?: 'embedded' | 'layout' | 'screenshot'; content_type?: string; presigned_url?: string; size_bytes?: number; }[]; total_count: number; }; items?: { pages: { items: code_item | footer_item | header_item | heading_item | image_item | link_item | list_item | table_item | text_item[]; page_height: number; page_number: number; page_width: number; success: true; revisions?: object[]; } | { error: string; page_number: number; success: false; }[]; }; job_metadata?: object; markdown?: { pages: { markdown: string; page_number: number; success: true; footer?: string; header?: string; } | { error: string; page_number: number; success: false; }[]; }; markdown_full?: string; metadata?: { pages: { page_number: number; confidence?: number; cost_optimized?: boolean; original_orientation_angle?: number; printed_page_number?: string; slide_section_name?: string; speaker_notes?: string; triggered_auto_mode?: boolean; }[]; }; raw_parameters?: object; result_content_metadata?: object; text?: { pages: { page_number: number; text: string; }[]; }; text_full?: string; }`\n Parse result response with job status and optional content or metadata.\n\nThe job field is always included. Other fields are included based on expand parameters.\n\n - `job: { 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 - `forms?: { pages: { forms: { json: form_field | form_section | form_table[]; list: form_list_item; }[]; page_number: number; success: true; page_height?: number; page_width?: number; } | { error: string; page_number: number; success: false; }[]; }`\n - `images_content_metadata?: { images: { filename: string; index: number; bbox?: { h: number; w: number; x: number; y: number; }; category?: 'embedded' | 'layout' | 'screenshot'; content_type?: string; presigned_url?: string; size_bytes?: number; }[]; total_count: number; }`\n - `items?: { pages: { items: { md: string; value: string; bbox?: b_box[]; language?: string; type?: 'code'; } | { items: code_item | heading_item | image_item | link_item | list_item | table_item | text_item[]; md: string; bbox?: b_box[]; type?: 'footer'; } | { items: code_item | heading_item | image_item | link_item | list_item | table_item | text_item[]; md: string; bbox?: b_box[]; type?: 'header'; } | { level: number; md: string; value: string; bbox?: b_box[]; type?: 'heading'; } | { caption: string; md: string; url: string; bbox?: b_box[]; type?: 'image'; } | { md: string; text: string; url: string; bbox?: b_box[]; type?: 'link'; } | { items: text_item | list_item[]; md: string; ordered: boolean; bbox?: b_box[]; type?: 'list'; } | { csv: string; html: string; md: string; rows: string | number[][]; bbox?: b_box[]; merged_from_pages?: number[]; merged_into_page?: number; parse_concerns?: object[]; type?: 'table'; } | { md: string; value: string; bbox?: b_box[]; type?: 'text'; }[]; page_height: number; page_number: number; page_width: number; success: true; revisions?: { content: string; revision_bbox: { h: number; w: number; x: number; y: number; }; target: string; target_bbox: { h: number; w: number; x: number; y: number; }; type: 'comment' | 'deleted' | 'formatted' | 'inserted' | 'moved_from' | 'moved_to'; author?: string; end_index?: number; start_index?: number; target_spans?: { target: string; target_bbox: object; end_index?: number; start_index?: number; }[]; }[]; } | { error: string; page_number: number; success: false; }[]; }`\n - `job_metadata?: object`\n - `markdown?: { pages: { markdown: string; page_number: number; success: true; footer?: string; header?: string; } | { error: string; page_number: number; success: false; }[]; }`\n - `markdown_full?: string`\n - `metadata?: { pages: { page_number: number; confidence?: number; cost_optimized?: boolean; original_orientation_angle?: number; printed_page_number?: string; slide_section_name?: string; speaker_notes?: string; triggered_auto_mode?: boolean; }[]; }`\n - `raw_parameters?: object`\n - `result_content_metadata?: object`\n - `text?: { pages: { page_number: number; text: string; }[]; }`\n - `text_full?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst parsing = await client.parsing.get('job_id');\n\nconsole.log(parsing);\n```",
581
+ response: "{ job: { 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; }; forms?: { pages: object | object[]; }; images_content_metadata?: { images: object[]; total_count: number; }; items?: { pages: object | object[]; }; job_metadata?: object; markdown?: { pages: object | object[]; }; markdown_full?: string; metadata?: { pages: object[]; document?: object; }; raw_parameters?: object; result_content_metadata?: object; text?: { pages: object[]; }; text_full?: string; }",
582
+ markdown: "## get\n\n`client.parsing.get(job_id: string, expand?: string[], image_filenames?: string, organization_id?: string, project_id?: string): { job: object; forms?: object; images_content_metadata?: object; items?: object; job_metadata?: object; markdown?: object; markdown_full?: string; metadata?: object; raw_parameters?: object; result_content_metadata?: object; text?: object; text_full?: string; }`\n\n**get** `/api/v2/parse/{job_id}`\n\nRetrieve a parse job with optional expanded content.\n\nBy default returns job metadata only. Use `expand` to include\nparsed content:\n\n- `text` — plain text output\n- `markdown` — markdown output\n- `items` — structured page-by-page output\n- `job_metadata` — processing details\n- `usage` — credits billed against the job\n\nContent metadata fields (e.g. `text_content_metadata`) return\npresigned URLs for downloading large results.\n\n### Parameters\n\n- `job_id: string`\n\n- `expand?: string[]`\n Fields to include: text, markdown, items, metadata, forms, job_metadata, usage, text_content_metadata, markdown_content_metadata, items_content_metadata, metadata_content_metadata, forms_content_metadata, raw_words_content_metadata, xlsx_content_metadata, output_pdf_content_metadata, images_content_metadata. Metadata fields include presigned URLs.\n\n- `image_filenames?: string`\n Filter to specific image filenames (optional). Example: image_0.png,image_1.jpg\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ job: { 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; }; forms?: { pages: { forms: form[]; page_number: number; success: true; page_height?: number; page_width?: number; } | { error: string; page_number: number; success: false; }[]; }; images_content_metadata?: { images: { filename: string; index: number; bbox?: object; category?: 'embedded' | 'layout' | 'screenshot'; content_type?: string; presigned_url?: string; size_bytes?: number; }[]; total_count: number; }; items?: { pages: { items: code_item | footer_item | header_item | heading_item | image_item | link_item | list_item | table_item | text_item[]; page_height: number; page_number: number; page_width: number; success: true; revisions?: object[]; } | { error: string; page_number: number; success: false; }[]; }; job_metadata?: object; markdown?: { pages: { markdown: string; page_number: number; success: true; footer?: string; header?: string; line_numbers?: object[]; } | { error: string; page_number: number; success: false; }[]; }; markdown_full?: string; metadata?: { pages: { page_number: number; confidence?: number; cost_optimized?: boolean; original_orientation_angle?: number; printed_page_number?: string; slide_section_name?: string; speaker_notes?: string; triggered_auto_mode?: boolean; }[]; document?: { confidence?: number; confidence_breakdown?: object; }; }; raw_parameters?: object; result_content_metadata?: object; text?: { pages: { page_number: number; text: string; }[]; }; text_full?: string; }`\n Parse result response with job status and optional content or metadata.\n\nThe job field is always included. Other fields are included based on expand parameters.\n\n - `job: { 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 - `forms?: { pages: { forms: { json: form_field | form_section | form_table[]; list: form_list_item; }[]; page_number: number; success: true; page_height?: number; page_width?: number; } | { error: string; page_number: number; success: false; }[]; }`\n - `images_content_metadata?: { images: { filename: string; index: number; bbox?: { h: number; w: number; x: number; y: number; }; category?: 'embedded' | 'layout' | 'screenshot'; content_type?: string; presigned_url?: string; size_bytes?: number; }[]; total_count: number; }`\n - `items?: { pages: { items: { md: string; value: string; bbox?: b_box[]; language?: string; type?: 'code'; } | { items: code_item | heading_item | image_item | link_item | list_item | table_item | text_item[]; md: string; bbox?: b_box[]; type?: 'footer'; } | { items: code_item | heading_item | image_item | link_item | list_item | table_item | text_item[]; md: string; bbox?: b_box[]; type?: 'header'; } | { level: number; md: string; value: string; bbox?: b_box[]; type?: 'heading'; } | { caption: string; md: string; url: string; bbox?: b_box[]; type?: 'image'; } | { md: string; text: string; url: string; bbox?: b_box[]; type?: 'link'; } | { items: text_item | list_item[]; md: string; ordered: boolean; bbox?: b_box[]; type?: 'list'; } | { csv: string; html: string; md: string; rows: string | number[][]; bbox?: b_box[]; merged_from_pages?: number[]; merged_into_page?: number; parse_concerns?: object[]; type?: 'table'; } | { md: string; value: string; bbox?: b_box[]; type?: 'text'; }[]; page_height: number; page_number: number; page_width: number; success: true; revisions?: { content: string; revision_bbox: { h: number; w: number; x: number; y: number; }; target: string; target_bbox: { h: number; w: number; x: number; y: number; }; type: 'comment' | 'deleted' | 'formatted' | 'inserted' | 'moved_from' | 'moved_to'; author?: string; end_index?: number; start_index?: number; target_spans?: { target: string; target_bbox: object; end_index?: number; start_index?: number; }[]; }[]; } | { error: string; page_number: number; success: false; }[]; }`\n - `job_metadata?: object`\n - `markdown?: { pages: { markdown: string; page_number: number; success: true; footer?: string; header?: string; line_numbers?: { end_index: number; line_number: string; start_index: number; }[]; } | { error: string; page_number: number; success: false; }[]; }`\n - `markdown_full?: string`\n - `metadata?: { pages: { page_number: number; confidence?: number; cost_optimized?: boolean; original_orientation_angle?: number; printed_page_number?: string; slide_section_name?: string; speaker_notes?: string; triggered_auto_mode?: boolean; }[]; document?: { confidence?: number; confidence_breakdown?: { min_page_score: number; scored_pages: number; total_pages: number; }; }; }`\n - `raw_parameters?: object`\n - `result_content_metadata?: object`\n - `text?: { pages: { page_number: number; text: string; }[]; }`\n - `text_full?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst parsing = await client.parsing.get('job_id');\n\nconsole.log(parsing);\n```",
821
583
  perLanguage: {
822
584
  go: {
823
585
  method: 'client.Parsing.Get',
@@ -991,13 +753,13 @@ const EMBEDDED_METHODS = [
991
753
  'file_input: string;',
992
754
  'organization_id?: string;',
993
755
  'project_id?: string;',
994
- "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?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; version?: string; };",
756
+ "configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; };",
995
757
  'configuration_id?: string;',
996
758
  'webhook_configuration_ids?: string[];',
997
759
  'webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[];',
998
760
  ],
999
- response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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; }; }",
1000
- markdown: "## create\n\n`client.extract.create(file_input: string, organization_id?: string, project_id?: string, configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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?: string`\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'`\n Extract tier: cost_effective (5 credits/page), agentic (15 credits/page), or agentic_plus (50 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?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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```",
761
+ response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; 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; }; }",
762
+ markdown: "## create\n\n`client.extract.create(file_input: string, organization_id?: string, project_id?: string, configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; 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?: string; 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?: string`\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, experimental)\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?: string; 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?: string; 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```",
1001
763
  perLanguage: {
1002
764
  go: {
1003
765
  method: 'client.Extract.New',
@@ -1051,8 +813,8 @@ const EMBEDDED_METHODS = [
1051
813
  'project_id?: string;',
1052
814
  "status?: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING' | 'THROTTLED';",
1053
815
  ],
1054
- response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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; }; }",
1055
- markdown: "## list\n\n`client.extract.list(configuration_id?: string, created_at_on_or_after?: string, created_at_on_or_before?: string, document_input_type?: string, document_input_value?: string, expand?: string[], file_input?: string, job_ids?: string[], organization_id?: string, page_size?: number, page_token?: string, project_id?: string, status?: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING' | 'THROTTLED'): { id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: extract_configuration; configuration_id?: string; error_message?: string; extract_metadata?: extract_job_metadata; extract_result?: object | object[]; metadata?: object; usage?: object; }`\n\n**get** `/api/v2/extract`\n\nList extraction jobs with optional filtering and pagination.\n\nFilter by `configuration_id`, `status`, `file_input`,\nor creation date range. Results are returned newest-first.\nUse `expand=configuration` to include the full configuration used,\nand `expand=extract_metadata` for per-field metadata.\n\n### Parameters\n\n- `configuration_id?: string`\n Filter by configuration ID\n\n- `created_at_on_or_after?: string`\n Include items created at or after this timestamp (inclusive)\n\n- `created_at_on_or_before?: string`\n Include items created at or before this timestamp (inclusive)\n\n- `document_input_type?: string`\n Filter by document input type (file_id or parse_job_id)\n\n- `document_input_value?: string`\n Deprecated: use file_input instead\n\n- `expand?: string[]`\n Additional fields to include: configuration, extract_metadata\n\n- `file_input?: string`\n Filter by file input value\n\n- `job_ids?: string[]`\n Filter by specific job IDs\n\n- `organization_id?: string`\n\n- `page_size?: number`\n Number of items per page\n\n- `page_token?: string`\n Token for pagination\n\n- `project_id?: string`\n\n- `status?: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING' | 'THROTTLED'`\n Filter by status\n\n### Returns\n\n- `{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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```",
816
+ response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; 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; }; }",
817
+ markdown: "## list\n\n`client.extract.list(configuration_id?: string, created_at_on_or_after?: string, created_at_on_or_before?: string, document_input_type?: string, document_input_value?: string, expand?: string[], file_input?: string, job_ids?: string[], organization_id?: string, page_size?: number, page_token?: string, project_id?: string, status?: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING' | 'THROTTLED'): { id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: extract_configuration; configuration_id?: string; error_message?: string; extract_metadata?: extract_job_metadata; extract_result?: object | object[]; metadata?: object; usage?: object; }`\n\n**get** `/api/v2/extract`\n\nList extraction jobs with optional filtering and pagination.\n\nFilter by `configuration_id`, `status`, `file_input`,\nor creation date range. Results are returned newest-first.\nUse `expand=configuration` to include the full configuration used,\nand `expand=extract_metadata` for per-field metadata.\n\n### Parameters\n\n- `configuration_id?: string`\n Filter by configuration ID\n\n- `created_at_on_or_after?: string`\n Include items created at or after this timestamp (inclusive)\n\n- `created_at_on_or_before?: string`\n Include items created at or before this timestamp (inclusive)\n\n- `document_input_type?: string`\n Filter by document input type (file_id or parse_job_id)\n\n- `document_input_value?: string`\n Deprecated: use file_input instead\n\n- `expand?: string[]`\n Additional fields to include: configuration, extract_metadata\n\n- `file_input?: string`\n Filter by file input value\n\n- `job_ids?: string[]`\n Filter by specific job IDs\n\n- `organization_id?: string`\n\n- `page_size?: number`\n Number of items per page\n\n- `page_token?: string`\n Token for pagination\n\n- `project_id?: string`\n\n- `status?: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING' | 'THROTTLED'`\n Filter by status\n\n### Returns\n\n- `{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; 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?: string; 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```",
1056
818
  perLanguage: {
1057
819
  go: {
1058
820
  method: 'client.Extract.List',
@@ -1092,8 +854,8 @@ const EMBEDDED_METHODS = [
1092
854
  stainlessPath: '(resource) extract > (method) get',
1093
855
  qualified: 'client.extract.get',
1094
856
  params: ['job_id: string;', 'expand?: string[];', 'organization_id?: string;', 'project_id?: string;'],
1095
- response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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; }; }",
1096
- markdown: "## get\n\n`client.extract.get(job_id: string, expand?: string[], organization_id?: string, project_id?: string): { id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: extract_configuration; configuration_id?: string; error_message?: string; extract_metadata?: extract_job_metadata; extract_result?: object | object[]; metadata?: object; usage?: object; }`\n\n**get** `/api/v2/extract/{job_id}`\n\nGet a single extraction job by ID.\n\nReturns the job status and results when complete.\nUse `expand=configuration` to include the full configuration used,\n`expand=extract_metadata` for per-field metadata, and\n`expand=usage` for credits billed against the job.\n\n### Parameters\n\n- `job_id: string`\n\n- `expand?: string[]`\n Additional fields to include: configuration, extract_metadata, usage\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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```",
857
+ response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; }; configuration_id?: string; error_message?: string; extract_metadata?: { field_metadata?: extracted_field_metadata; parse_job_id?: string; parse_tier?: string; }; extract_result?: object | object[]; metadata?: { usage?: object; }; usage?: { credits?: number; extract_credits?: number; parse_credits?: number; }; }",
858
+ markdown: "## 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?: string; 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?: string; 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```",
1097
859
  perLanguage: {
1098
860
  go: {
1099
861
  method: 'client.Extract.Get',
@@ -1174,8 +936,8 @@ const EMBEDDED_METHODS = [
1174
936
  stainlessPath: '(resource) extract > (method) cancel',
1175
937
  qualified: 'client.extract.cancel',
1176
938
  params: ['job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
1177
- response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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; }; }",
1178
- markdown: "## cancel\n\n`client.extract.cancel(job_id: string, organization_id?: string, project_id?: string): { id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: extract_configuration; configuration_id?: string; error_message?: string; extract_metadata?: extract_job_metadata; extract_result?: object | object[]; metadata?: object; usage?: object; }`\n\n**post** `/api/v2/extract/{job_id}/cancel`\n\nCancel a running extraction job.\n\nStops processing and marks the job as CANCELLED. Returns the updated job. Jobs already in a terminal state (COMPLETED, FAILED, CANCELLED) cannot be cancelled.\n\n### Parameters\n\n- `job_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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```",
939
+ response: "{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; 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; }; }",
940
+ markdown: "## cancel\n\n`client.extract.cancel(job_id: string, organization_id?: string, project_id?: string): { id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: extract_configuration; configuration_id?: string; error_message?: string; extract_metadata?: extract_job_metadata; extract_result?: object | object[]; metadata?: object; usage?: object; }`\n\n**post** `/api/v2/extract/{job_id}/cancel`\n\nCancel a running extraction job.\n\nStops processing and marks the job as CANCELLED. Returns the updated job. Jobs already in a terminal state (COMPLETED, FAILED, CANCELLED) cannot be cancelled.\n\n### Parameters\n\n- `job_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; created_at: string; file_input: string; project_id: string; status: string; updated_at: string; configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; 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?: string; 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```",
1179
941
  perLanguage: {
1180
942
  go: {
1181
943
  method: 'client.Extract.Cancel',
@@ -1264,7 +1026,7 @@ const EMBEDDED_METHODS = [
1264
1026
  'prompt?: string;',
1265
1027
  ],
1266
1028
  response: "{ name: string; parameters: object | object | object | object | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | object; }",
1267
- markdown: "## generate_schema\n\n`client.extract.generateSchema(organization_id?: string, project_id?: string, data_schema?: object, file_id?: string, name?: string, prompt?: string): { name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; }`\n\n**post** `/api/v2/extract/schema/generate`\n\nGenerate a JSON schema and return a product configuration request.\n\n### Parameters\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `data_schema?: object`\n Optional schema to validate, refine, or extend\n\n- `file_id?: string`\n Optional file ID to analyze for schema generation\n\n- `name?: string`\n Name for the generated configuration (auto-generated if omitted)\n\n- `prompt?: string`\n Natural language description of the data structure to extract\n\n### Returns\n\n- `{ name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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'; }; }`\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?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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_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\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```",
1029
+ markdown: "## generate_schema\n\n`client.extract.generateSchema(organization_id?: string, project_id?: string, data_schema?: object, file_id?: string, name?: string, prompt?: string): { name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; }`\n\n**post** `/api/v2/extract/schema/generate`\n\nGenerate a JSON schema and return a product configuration request.\n\n### Parameters\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `data_schema?: object`\n Optional schema to validate, refine, or extend\n\n- `file_id?: string`\n Optional file ID to analyze for schema generation\n\n- `name?: string`\n Name for the generated configuration (auto-generated if omitted)\n\n- `prompt?: string`\n Natural language description of the data structure to extract\n\n### Returns\n\n- `{ name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 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'; }; }`\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?: 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\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```",
1268
1030
  perLanguage: {
1269
1031
  go: {
1270
1032
  method: 'client.Extract.GenerateSchema',
@@ -1847,12 +1609,12 @@ const EMBEDDED_METHODS = [
1847
1609
  qualified: 'client.configurations.create',
1848
1610
  params: [
1849
1611
  'name: string;',
1850
- "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'; 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_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'; };",
1612
+ "parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 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'; };",
1851
1613
  'organization_id?: string;',
1852
1614
  'project_id?: string;',
1853
1615
  ],
1854
1616
  response: "{ id: string; name: string; parameters: object | object | object | object | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | object; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
1855
- markdown: "## create\n\n`client.configurations.create(name: string, parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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'; 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_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'; 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'; 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_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```",
1617
+ markdown: "## create\n\n`client.configurations.create(name: string, parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }, organization_id?: string, project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**post** `/api/v1/beta/configurations`\n\nUpsert a product configuration; updates if one with the same name + product type + project exists, otherwise creates.\n\n### Parameters\n\n- `name: string`\n Human-readable name for this configuration.\n\n- `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n Product-specific configuration parameters.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n Response schema for a single product configuration.\n\n - `id: string`\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'`\n - `version: string`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst configurationResponse = await client.configurations.create({\n name: 'x',\n parameters: { product_type: 'classify_v2', rules: [{ description: 'contains invoice number, line items, and total amount', type: 'invoice' }] },\n});\n\nconsole.log(configurationResponse);\n```",
1856
1618
  perLanguage: {
1857
1619
  go: {
1858
1620
  method: 'client.Configurations.New',
@@ -1901,7 +1663,7 @@ const EMBEDDED_METHODS = [
1901
1663
  'project_id?: string;',
1902
1664
  ],
1903
1665
  response: "{ id: string; name: string; parameters: object | object | object | object | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | object; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
1904
- markdown: "## list\n\n`client.configurations.list(latest_only?: boolean, name?: string, organization_id?: string, page_size?: number, page_token?: string, product_type?: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'[], project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/beta/configurations`\n\nList product configurations for the current project.\n\n### Parameters\n\n- `latest_only?: boolean`\n Return only the latest version per configuration name.\n\n- `name?: string`\n Filter by configuration name.\n\n- `organization_id?: string`\n\n- `page_size?: number`\n Number of items per page.\n\n- `page_token?: string`\n Pagination token.\n\n- `product_type?: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'[]`\n Filter by one or more product types. Repeat the parameter for multiple values.\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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'; 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_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\n// Automatically fetches more pages as needed.\nfor await (const configurationResponse of client.configurations.list()) {\n console.log(configurationResponse);\n}\n```",
1666
+ markdown: "## list\n\n`client.configurations.list(latest_only?: boolean, name?: string, organization_id?: string, page_size?: number, page_token?: string, product_type?: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'[], project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/beta/configurations`\n\nList product configurations for the current project.\n\n### Parameters\n\n- `latest_only?: boolean`\n Return only the latest version per configuration name.\n\n- `name?: string`\n Filter by configuration name.\n\n- `organization_id?: string`\n\n- `page_size?: number`\n Number of items per page.\n\n- `page_token?: string`\n Pagination token.\n\n- `product_type?: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'[]`\n Filter by one or more product types. Repeat the parameter for multiple values.\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 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\n// Automatically fetches more pages as needed.\nfor await (const configurationResponse of client.configurations.list()) {\n console.log(configurationResponse);\n}\n```",
1905
1667
  perLanguage: {
1906
1668
  go: {
1907
1669
  method: 'client.Configurations.List',
@@ -1942,7 +1704,7 @@ const EMBEDDED_METHODS = [
1942
1704
  qualified: 'client.configurations.retrieve',
1943
1705
  params: ['config_id: string;', 'organization_id?: string;', 'project_id?: string;'],
1944
1706
  response: "{ id: string; name: string; parameters: object | object | object | object | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | object; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
1945
- markdown: "## retrieve\n\n`client.configurations.retrieve(config_id: string, organization_id?: string, project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/beta/configurations/{config_id}`\n\nGet a single product configuration by ID.\n\n### Parameters\n\n- `config_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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'; 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_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.retrieve('config_id');\n\nconsole.log(configurationResponse);\n```",
1707
+ markdown: "## retrieve\n\n`client.configurations.retrieve(config_id: string, organization_id?: string, project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/beta/configurations/{config_id}`\n\nGet a single product configuration by ID.\n\n### Parameters\n\n- `config_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 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.retrieve('config_id');\n\nconsole.log(configurationResponse);\n```",
1946
1708
  perLanguage: {
1947
1709
  go: {
1948
1710
  method: 'client.Configurations.Get',
@@ -1986,10 +1748,10 @@ const EMBEDDED_METHODS = [
1986
1748
  'organization_id?: string;',
1987
1749
  'project_id?: string;',
1988
1750
  'name?: string;',
1989
- "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'; 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_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'; };",
1751
+ "parameters?: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: 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'; };",
1990
1752
  ],
1991
1753
  response: "{ id: string; name: string; parameters: object | object | object | object | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | object; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
1992
- markdown: "## update\n\n`client.configurations.update(config_id: string, organization_id?: string, project_id?: string, name?: string, parameters?: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective'; 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'; 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_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'; 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'; 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_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```",
1754
+ markdown: "## update\n\n`client.configurations.update(config_id: string, organization_id?: string, project_id?: string, name?: string, parameters?: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**put** `/api/v1/beta/configurations/{config_id}`\n\nUpdate an existing product configuration.\n\n### Parameters\n\n- `config_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `name?: string`\n Updated name (omit to leave unchanged).\n\n- `parameters?: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n Updated parameters (omit to leave unchanged).\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n Response schema for a single product configuration.\n\n - `id: string`\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; disable_cache?: boolean; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; sheet_names?: string[]; spreadsheet_mode?: boolean; system_prompt?: string; target_pages?: string; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'turbo'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-08-19' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; inline_images?: boolean; tables?: object; }; save_output_pdf?: boolean; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }; page_ranges?: { max_pages?: number; target_pages?: string; }; processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }; processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: object; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; confidence_score_effort?: 'high'; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; forms?: 'default' | 'enrich'; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; tier?: 'agentic' | 'cost_effective'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'`\n - `version: string`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst configurationResponse = await client.configurations.update('config_id');\n\nconsole.log(configurationResponse);\n```",
1993
1755
  perLanguage: {
1994
1756
  go: {
1995
1757
  method: 'client.Configurations.Update',
@@ -2991,7 +2753,7 @@ const EMBEDDED_METHODS = [
2991
2753
  'data_sink_id?: string;',
2992
2754
  "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'; };",
2993
2755
  'embedding_model_config_id?: string;',
2994
- "llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: 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; };",
2756
+ "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; };",
2995
2757
  'managed_pipeline_id?: string;',
2996
2758
  'metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; };',
2997
2759
  "pipeline_type?: 'MANAGED' | 'PLAYGROUND';",
@@ -3001,7 +2763,7 @@ const EMBEDDED_METHODS = [
3001
2763
  "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'; }; };",
3002
2764
  ],
3003
2765
  response: "{ id: string; embedding_config: object | object | object | object | object | { component?: object; type?: 'MANAGED_OPENAI_EMBEDDING'; } | object | object; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: object; embedding_model_config?: { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: object; managed_pipeline_id?: string; metadata_config?: object; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: object; sparse_model_config?: object; status?: 'CREATED' | 'DELETING'; transform_config?: object | object; updated_at?: string; }",
3004
- markdown: "## create\n\n`client.pipelines.create(name: string, organization_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_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?: 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**post** `/api/v1/pipelines`\n\nCreate a new managed ingestion pipeline.\n\nA pipeline connects data sources to a vector store for RAG.\nAfter creation, call `POST /pipelines/{id}/sync` to start\ningesting documents.\n\n### Parameters\n\n- `name: string`\n\n- `organization_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_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_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- `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n Type of pipeline. Either PLAYGROUND or MANAGED.\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 Preset retrieval parameters for the 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_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_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.create({ name: 'x' });\n\nconsole.log(pipeline);\n```",
2766
+ markdown: "## create\n\n`client.pipelines.create(name: string, organization_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[]; }, 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?: 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**post** `/api/v1/pipelines`\n\nCreate a new managed ingestion pipeline.\n\nA pipeline connects data sources to a vector store for RAG.\nAfter creation, call `POST /pipelines/{id}/sync` to start\ningesting documents.\n\n### Parameters\n\n- `name: string`\n\n- `organization_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- `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n Type of pipeline. Either PLAYGROUND or MANAGED.\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 Preset retrieval parameters for the 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.create({ name: 'x' });\n\nconsole.log(pipeline);\n```",
3005
2767
  perLanguage: {
3006
2768
  go: {
3007
2769
  method: 'client.Pipelines.New',
@@ -3042,7 +2804,7 @@ const EMBEDDED_METHODS = [
3042
2804
  qualified: 'client.pipelines.get',
3043
2805
  params: ['pipeline_id: string;'],
3044
2806
  response: "{ id: string; embedding_config: object | object | object | object | object | { component?: object; type?: 'MANAGED_OPENAI_EMBEDDING'; } | object | object; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: object; embedding_model_config?: { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: object; managed_pipeline_id?: string; metadata_config?: object; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: object; sparse_model_config?: object; status?: 'CREATED' | 'DELETING'; transform_config?: object | object; updated_at?: string; }",
3045
- markdown: "## get\n\n`client.pipelines.get(pipeline_id: string): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}`\n\nGet a pipeline by ID.\n\n### Parameters\n\n- `pipeline_id: string`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_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_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```",
2807
+ markdown: "## get\n\n`client.pipelines.get(pipeline_id: string): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**get** `/api/v1/pipelines/{pipeline_id}`\n\nGet a pipeline by ID.\n\n### Parameters\n\n- `pipeline_id: string`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }; managed_pipeline_id?: string; metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }; sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }; status?: 'CREATED' | 'DELETING'; transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }; updated_at?: string; }`\n Schema for a pipeline.\n\n - `id: string`\n - `embedding_config: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n - `name: string`\n - `project_id: string`\n - `config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }`\n - `created_at?: string`\n - `data_sink?: { id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n - `embedding_model_config?: { id: string; embedding_config: { component?: object; type?: 'AZURE_EMBEDDING'; } | { component?: object; type?: 'BEDROCK_EMBEDDING'; } | { component?: object; type?: 'COHERE_EMBEDDING'; } | { component?: object; type?: 'GEMINI_EMBEDDING'; } | { component?: object; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: object; type?: 'OPENAI_EMBEDDING'; } | { component?: object; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; created_at?: string; updated_at?: string; }`\n - `embedding_model_config_id?: string`\n - `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n - `managed_pipeline_id?: string`\n - `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n - `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n - `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n - `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n - `status?: 'CREATED' | 'DELETING'`\n - `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipeline = await client.pipelines.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(pipeline);\n```",
3046
2808
  perLanguage: {
3047
2809
  go: {
3048
2810
  method: 'client.Pipelines.Get',
@@ -3087,7 +2849,7 @@ const EMBEDDED_METHODS = [
3087
2849
  'data_sink_id?: string;',
3088
2850
  "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'; };",
3089
2851
  'embedding_model_config_id?: string;',
3090
- "llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: 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; };",
2852
+ "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; };",
3091
2853
  'managed_pipeline_id?: string;',
3092
2854
  'metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; };',
3093
2855
  'name?: string;',
@@ -3097,7 +2859,7 @@ const EMBEDDED_METHODS = [
3097
2859
  "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'; }; };",
3098
2860
  ],
3099
2861
  response: "{ id: string; embedding_config: object | object | object | object | object | { component?: object; type?: 'MANAGED_OPENAI_EMBEDDING'; } | object | object; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: object; embedding_model_config?: { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: object; managed_pipeline_id?: string; metadata_config?: object; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: object; sparse_model_config?: object; status?: 'CREATED' | 'DELETING'; transform_config?: object | object; updated_at?: string; }",
3100
- markdown: "## update\n\n`client.pipelines.update(pipeline_id: string, data_sink?: { component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; }, data_sink_id?: string, embedding_config?: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }, embedding_model_config_id?: string, llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_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_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_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_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_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```",
2862
+ markdown: "## update\n\n`client.pipelines.update(pipeline_id: string, data_sink?: { component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; }, data_sink_id?: string, embedding_config?: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }, embedding_model_config_id?: string, llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }, managed_pipeline_id?: string, metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }, name?: string, preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }, sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }, status?: string, transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**put** `/api/v1/pipelines/{pipeline_id}`\n\nUpdate an existing pipeline's configuration.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_sink?: { component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; }`\n Schema for creating a data sink.\n - `component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: { distance_method?: 'cosine' | 'hamming' | 'ip' | 'jaccard' | 'l1' | 'l2'; ef_construction?: number; ef_search?: number; m?: number; vector_type?: 'bit' | 'half_vec' | 'sparse_vec' | 'vector'; }; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }`\n Component that implements the data sink\n - `name: string`\n The name of the data sink.\n - `sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'`\n\n- `data_sink_id?: string`\n Data sink ID. When provided instead of data_sink, the data sink will be looked up by ID.\n\n- `embedding_config?: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n\n- `embedding_model_config_id?: string`\n Embedding model config ID. When provided instead of embedding_config, the embedding model config will be looked up by ID.\n\n- `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n Settings that can be configured for how to use LlamaParse to parse files within a LlamaCloud pipeline.\n - `adaptive_long_table?: boolean`\n - `aggressive_table_extraction?: boolean`\n - `annotate_line_numbers?: boolean`\n - `annotate_links?: boolean`\n - `annotate_revisions?: boolean`\n - `auto_mode?: boolean`\n - `auto_mode_configuration_json?: string`\n - `auto_mode_trigger_on_image_in_page?: boolean`\n - `auto_mode_trigger_on_regexp_in_page?: string`\n - `auto_mode_trigger_on_table_in_page?: boolean`\n - `auto_mode_trigger_on_text_in_page?: string`\n - `azure_openai_api_version?: string`\n - `azure_openai_deployment_name?: string`\n - `azure_openai_endpoint?: string`\n - `azure_openai_key?: string`\n - `bbox_bottom?: number`\n - `bbox_left?: number`\n - `bbox_right?: number`\n - `bbox_top?: number`\n - `bounding_box?: string`\n - `compact_markdown_table?: boolean`\n - `complemental_formatting_instruction?: string`\n - `confidence_score_effort?: string`\n - `content_guideline_instruction?: string`\n - `continuous_mode?: boolean`\n - `disable_image_extraction?: boolean`\n - `disable_ocr?: boolean`\n - `disable_reconstruction?: boolean`\n - `do_not_cache?: boolean`\n - `do_not_unroll_columns?: boolean`\n - `enable_cost_optimizer?: boolean`\n - `extract_charts?: boolean`\n - `extract_layout?: boolean`\n - `extract_printed_page_number?: boolean`\n - `fast_mode?: boolean`\n - `formatting_instruction?: string`\n - `gpt4o_api_key?: string`\n - `gpt4o_mode?: boolean`\n - `guess_xlsx_sheet_name?: boolean`\n - `hide_footers?: boolean`\n - `hide_headers?: boolean`\n - `high_res_ocr?: boolean`\n - `html_make_all_elements_visible?: boolean`\n - `html_remove_fixed_elements?: boolean`\n - `html_remove_navigation_elements?: boolean`\n - `http_proxy?: string`\n - `ignore_document_elements_for_layout_detection?: boolean`\n - `images_to_save?: 'embedded' | 'layout' | 'screenshot'[]`\n - `inline_images_in_markdown?: boolean`\n - `input_s3_path?: string`\n - `input_s3_region?: string`\n - `input_url?: string`\n - `internal_is_screenshot_job?: boolean`\n - `invalidate_cache?: boolean`\n - `is_formatting_instruction?: boolean`\n - `job_timeout_extra_time_per_page_in_seconds?: number`\n - `job_timeout_in_seconds?: number`\n - `keep_page_separator_when_merging_tables?: boolean`\n - `languages?: string[]`\n - `layout_aware?: boolean`\n - `line_level_bounding_box?: boolean`\n - `markdown_table_multiline_header_separator?: string`\n - `max_pages?: number`\n - `max_pages_enforced?: number`\n - `merge_tables_across_pages_in_markdown?: boolean`\n - `model?: string`\n - `outlined_table_extraction?: boolean`\n - `output_pdf_of_document?: boolean`\n - `output_s3_path_prefix?: string`\n - `output_s3_region?: string`\n - `output_tables_as_HTML?: boolean`\n - `page_error_tolerance?: number`\n - `page_footer_prefix?: string`\n - `page_footer_suffix?: string`\n - `page_header_prefix?: string`\n - `page_header_suffix?: string`\n - `page_prefix?: string`\n - `page_separator?: string`\n - `page_suffix?: string`\n - `parse_mode?: string`\n Enum for representing the mode of parsing to be used.\n - `parsing_instruction?: string`\n - `precise_bounding_box?: boolean`\n - `premium_mode?: boolean`\n - `presentation_out_of_bounds_content?: boolean`\n - `presentation_skip_embedded_data?: boolean`\n - `preserve_layout_alignment_across_pages?: boolean`\n - `preserve_very_small_text?: boolean`\n - `preset?: string`\n - `priority?: 'critical' | 'high' | 'low' | 'medium'`\n The priority for the request. This field may be ignored or overwritten depending on the organization tier.\n - `project_id?: string`\n - `remove_hidden_text?: boolean`\n - `replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'`\n Enum for representing the different available page error handling modes.\n - `replace_failed_page_with_error_message_prefix?: string`\n - `replace_failed_page_with_error_message_suffix?: string`\n - `save_images?: boolean`\n - `skip_diagonal_text?: boolean`\n - `specialized_chart_parsing_agentic?: boolean`\n - `specialized_chart_parsing_efficient?: boolean`\n - `specialized_chart_parsing_plus?: boolean`\n - `specialized_image_parsing?: boolean`\n - `spreadsheet_extract_sub_tables?: boolean`\n - `spreadsheet_force_formula_computation?: boolean`\n - `spreadsheet_include_hidden_sheets?: boolean`\n - `strict_mode_buggy_font?: boolean`\n - `strict_mode_image_extraction?: boolean`\n - `strict_mode_image_ocr?: boolean`\n - `strict_mode_reconstruction?: boolean`\n - `structured_output?: boolean`\n - `structured_output_json_schema?: string`\n - `structured_output_json_schema_name?: string`\n - `system_prompt?: string`\n - `system_prompt_append?: string`\n - `take_screenshot?: boolean`\n - `target_pages?: string`\n - `tier?: string`\n - `use_vendor_multimodal_model?: boolean`\n - `user_prompt?: string`\n - `vendor_multimodal_api_key?: string`\n - `vendor_multimodal_model_name?: string`\n - `version?: string`\n - `webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]`\n Outbound webhook endpoints to notify on job status changes\n - `webhook_url?: string`\n\n- `managed_pipeline_id?: string`\n The ID of the ManagedPipeline this playground pipeline is linked to.\n\n- `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n Metadata configuration for the pipeline.\n - `excluded_embed_metadata_keys?: string[]`\n List of metadata keys to exclude from embeddings\n - `excluded_llm_metadata_keys?: string[]`\n List of metadata keys to exclude from LLM during retrieval\n\n- `name?: string`\n\n- `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n Schema for the search params for an retrieval execution that can be preset for a pipeline.\n - `alpha?: number`\n Alpha value for hybrid retrieval to determine the weights between dense and sparse retrieval. 0 is sparse retrieval and 1 is dense retrieval.\n - `class_name?: string`\n - `dense_similarity_cutoff?: number`\n Minimum similarity score wrt query for retrieval\n - `dense_similarity_top_k?: number`\n Number of nodes for dense retrieval.\n - `enable_reranking?: boolean`\n Enable reranking for retrieval\n - `files_top_k?: number`\n Number of files to retrieve (only for retrieval mode files_via_metadata and files_via_content).\n - `rerank_top_n?: number`\n Number of reranked nodes for returning.\n - `retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'`\n The retrieval mode for the query.\n - `retrieve_image_nodes?: boolean`\n Whether to retrieve image nodes.\n - `retrieve_page_figure_nodes?: boolean`\n Whether to retrieve page figure nodes.\n - `retrieve_page_screenshot_nodes?: boolean`\n Whether to retrieve page screenshot nodes.\n - `search_filters?: { filters: { key: string; value: number | string | string[] | number[] | number[]; operator?: string; } | { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }[]; condition?: 'and' | 'not' | 'or'; }`\n Metadata filters for vector stores.\n - `search_filters_inference_schema?: object`\n JSON Schema that will be used to infer search_filters. Omit or leave as null to skip inference.\n - `sparse_similarity_top_k?: number`\n Number of nodes for sparse retrieval.\n\n- `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n Configuration for sparse embedding models used in hybrid search.\n\nThis allows users to choose between Splade and BM25 models for\nsparse retrieval in managed data sinks.\n - `class_name?: string`\n - `model_type?: 'auto' | 'bm25' | 'splade'`\n The sparse model type to use. 'bm25' uses Qdrant's FastEmbed BM25 model (default for new pipelines), 'splade' uses HuggingFace Splade model, 'auto' selects based on deployment mode (BYOC uses term frequency, Cloud uses Splade).\n\n- `status?: string`\n Status of the pipeline deployment.\n\n- `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n Configuration for the transformation.\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }; managed_pipeline_id?: string; metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }; sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }; status?: 'CREATED' | 'DELETING'; transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }; updated_at?: string; }`\n Schema for a pipeline.\n\n - `id: string`\n - `embedding_config: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n - `name: string`\n - `project_id: string`\n - `config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }`\n - `created_at?: string`\n - `data_sink?: { id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n - `embedding_model_config?: { id: string; embedding_config: { component?: object; type?: 'AZURE_EMBEDDING'; } | { component?: object; type?: 'BEDROCK_EMBEDDING'; } | { component?: object; type?: 'COHERE_EMBEDDING'; } | { component?: object; type?: 'GEMINI_EMBEDDING'; } | { component?: object; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: object; type?: 'OPENAI_EMBEDDING'; } | { component?: object; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; created_at?: string; updated_at?: string; }`\n - `embedding_model_config_id?: string`\n - `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n - `managed_pipeline_id?: string`\n - `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n - `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n - `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n - `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n - `status?: 'CREATED' | 'DELETING'`\n - `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipeline = await client.pipelines.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(pipeline);\n```",
3101
2863
  perLanguage: {
3102
2864
  go: {
3103
2865
  method: 'client.Pipelines.Update',
@@ -3225,7 +2987,7 @@ const EMBEDDED_METHODS = [
3225
2987
  'data_sink_id?: string;',
3226
2988
  "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'; };",
3227
2989
  'embedding_model_config_id?: string;',
3228
- "llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: 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; };",
2990
+ "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; };",
3229
2991
  'managed_pipeline_id?: string;',
3230
2992
  'metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; };',
3231
2993
  "pipeline_type?: 'MANAGED' | 'PLAYGROUND';",
@@ -3235,7 +2997,7 @@ const EMBEDDED_METHODS = [
3235
2997
  "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'; }; };",
3236
2998
  ],
3237
2999
  response: "{ id: string; embedding_config: object | object | object | object | object | { component?: object; type?: 'MANAGED_OPENAI_EMBEDDING'; } | object | object; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: object; embedding_model_config?: { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: object; managed_pipeline_id?: string; metadata_config?: object; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: object; sparse_model_config?: object; status?: 'CREATED' | 'DELETING'; transform_config?: object | object; updated_at?: string; }",
3238
- markdown: "## upsert\n\n`client.pipelines.upsert(name: string, organization_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_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?: 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`\n\nUpsert a pipeline.\n\nUpdates the pipeline if one with the same name and project\nalready exists, otherwise creates a new one.\n\n### Parameters\n\n- `name: string`\n\n- `organization_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_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_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- `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n Type of pipeline. Either PLAYGROUND or MANAGED.\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 Preset retrieval parameters for the 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_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_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.upsert({ name: 'x' });\n\nconsole.log(pipeline);\n```",
3000
+ markdown: "## upsert\n\n`client.pipelines.upsert(name: string, organization_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[]; }, 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?: 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`\n\nUpsert a pipeline.\n\nUpdates the pipeline if one with the same name and project\nalready exists, otherwise creates a new one.\n\n### Parameters\n\n- `name: string`\n\n- `organization_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- `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n Type of pipeline. Either PLAYGROUND or MANAGED.\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 Preset retrieval parameters for the 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.upsert({ name: 'x' });\n\nconsole.log(pipeline);\n```",
3239
3001
  perLanguage: {
3240
3002
  go: {
3241
3003
  method: 'client.Pipelines.Upsert',
@@ -3295,7 +3057,7 @@ const EMBEDDED_METHODS = [
3295
3057
  qualified: 'client.pipelines.sync.create',
3296
3058
  params: ['pipeline_id: string;'],
3297
3059
  response: "{ id: string; embedding_config: object | object | object | object | object | { component?: object; type?: 'MANAGED_OPENAI_EMBEDDING'; } | object | object; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: object; embedding_model_config?: { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: object; managed_pipeline_id?: string; metadata_config?: object; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: object; sparse_model_config?: object; status?: 'CREATED' | 'DELETING'; transform_config?: object | object; updated_at?: string; }",
3298
- markdown: "## create\n\n`client.pipelines.sync.create(pipeline_id: string): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**post** `/api/v1/pipelines/{pipeline_id}/sync`\n\nTrigger an incremental sync for a managed pipeline.\n\nProcesses new and updated documents from data sources and\nfiles, then updates the index for retrieval.\n\n### Parameters\n\n- `pipeline_id: string`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_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_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```",
3060
+ markdown: "## create\n\n`client.pipelines.sync.create(pipeline_id: string): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**post** `/api/v1/pipelines/{pipeline_id}/sync`\n\nTrigger an incremental sync for a managed pipeline.\n\nProcesses new and updated documents from data sources and\nfiles, then updates the index for retrieval.\n\n### Parameters\n\n- `pipeline_id: string`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }; managed_pipeline_id?: string; metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }; sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }; status?: 'CREATED' | 'DELETING'; transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }; updated_at?: string; }`\n Schema for a pipeline.\n\n - `id: string`\n - `embedding_config: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n - `name: string`\n - `project_id: string`\n - `config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }`\n - `created_at?: string`\n - `data_sink?: { id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n - `embedding_model_config?: { id: string; embedding_config: { component?: object; type?: 'AZURE_EMBEDDING'; } | { component?: object; type?: 'BEDROCK_EMBEDDING'; } | { component?: object; type?: 'COHERE_EMBEDDING'; } | { component?: object; type?: 'GEMINI_EMBEDDING'; } | { component?: object; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: object; type?: 'OPENAI_EMBEDDING'; } | { component?: object; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; created_at?: string; updated_at?: string; }`\n - `embedding_model_config_id?: string`\n - `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n - `managed_pipeline_id?: string`\n - `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n - `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n - `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n - `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n - `status?: 'CREATED' | 'DELETING'`\n - `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipeline = await client.pipelines.sync.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(pipeline);\n```",
3299
3061
  perLanguage: {
3300
3062
  go: {
3301
3063
  method: 'client.Pipelines.Sync.New',
@@ -3336,7 +3098,7 @@ const EMBEDDED_METHODS = [
3336
3098
  qualified: 'client.pipelines.sync.cancel',
3337
3099
  params: ['pipeline_id: string;'],
3338
3100
  response: "{ id: string; embedding_config: object | object | object | object | object | { component?: object; type?: 'MANAGED_OPENAI_EMBEDDING'; } | object | object; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: object; embedding_model_config?: { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: object; managed_pipeline_id?: string; metadata_config?: object; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: object; sparse_model_config?: object; status?: 'CREATED' | 'DELETING'; transform_config?: object | object; updated_at?: string; }",
3339
- markdown: "## cancel\n\n`client.pipelines.sync.cancel(pipeline_id: string): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**post** `/api/v1/pipelines/{pipeline_id}/sync/cancel`\n\nCancel all running sync jobs for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_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_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```",
3101
+ markdown: "## cancel\n\n`client.pipelines.sync.cancel(pipeline_id: string): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**post** `/api/v1/pipelines/{pipeline_id}/sync/cancel`\n\nCancel all running sync jobs for a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }; managed_pipeline_id?: string; metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }; sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }; status?: 'CREATED' | 'DELETING'; transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }; updated_at?: string; }`\n Schema for a pipeline.\n\n - `id: string`\n - `embedding_config: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n - `name: string`\n - `project_id: string`\n - `config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }`\n - `created_at?: string`\n - `data_sink?: { id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n - `embedding_model_config?: { id: string; embedding_config: { component?: object; type?: 'AZURE_EMBEDDING'; } | { component?: object; type?: 'BEDROCK_EMBEDDING'; } | { component?: object; type?: 'COHERE_EMBEDDING'; } | { component?: object; type?: 'GEMINI_EMBEDDING'; } | { component?: object; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: object; type?: 'OPENAI_EMBEDDING'; } | { component?: object; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; created_at?: string; updated_at?: string; }`\n - `embedding_model_config_id?: string`\n - `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n - `managed_pipeline_id?: string`\n - `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n - `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n - `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n - `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n - `status?: 'CREATED' | 'DELETING'`\n - `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipeline = await client.pipelines.sync.cancel('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(pipeline);\n```",
3340
3102
  perLanguage: {
3341
3103
  go: {
3342
3104
  method: 'client.Pipelines.Sync.Cancel',
@@ -3541,7 +3303,7 @@ const EMBEDDED_METHODS = [
3541
3303
  qualified: 'client.pipelines.dataSources.sync',
3542
3304
  params: ['pipeline_id: string;', 'data_source_id: string;', 'pipeline_file_ids?: string[];'],
3543
3305
  response: "{ id: string; embedding_config: object | object | object | object | object | { component?: object; type?: 'MANAGED_OPENAI_EMBEDDING'; } | object | object; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: object; embedding_model_config?: { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: object; managed_pipeline_id?: string; metadata_config?: object; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: object; sparse_model_config?: object; status?: 'CREATED' | 'DELETING'; transform_config?: object | object; updated_at?: string; }",
3544
- markdown: "## sync\n\n`client.pipelines.dataSources.sync(pipeline_id: string, data_source_id: string, pipeline_file_ids?: string[]): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**post** `/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/sync`\n\nRun incremental ingestion: pull upstream changes from the data source into the data sink.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id: string`\n\n- `pipeline_file_ids?: string[]`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_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_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```",
3306
+ markdown: "## sync\n\n`client.pipelines.dataSources.sync(pipeline_id: string, data_source_id: string, pipeline_file_ids?: string[]): { id: string; embedding_config: azure_openai_embedding_config | bedrock_embedding_config | cohere_embedding_config | gemini_embedding_config | hugging_face_inference_api_embedding_config | object | openai_embedding_config | vertex_ai_embedding_config; name: string; project_id: string; config_hash?: object; created_at?: string; data_sink?: data_sink; embedding_model_config?: object; embedding_model_config_id?: string; llama_parse_parameters?: llama_parse_parameters; managed_pipeline_id?: string; metadata_config?: pipeline_metadata_config; pipeline_type?: pipeline_type; preset_retrieval_parameters?: preset_retrieval_params; sparse_model_config?: sparse_model_config; status?: 'CREATED' | 'DELETING'; transform_config?: auto_transform_config | advanced_mode_transform_config; updated_at?: string; }`\n\n**post** `/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/sync`\n\nRun incremental ingestion: pull upstream changes from the data source into the data sink.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id: string`\n\n- `pipeline_file_ids?: string[]`\n\n### Returns\n\n- `{ id: string; embedding_config: { component?: azure_openai_embedding; type?: 'AZURE_EMBEDDING'; } | { component?: bedrock_embedding; type?: 'BEDROCK_EMBEDDING'; } | { component?: cohere_embedding; type?: 'COHERE_EMBEDDING'; } | { component?: gemini_embedding; type?: 'GEMINI_EMBEDDING'; } | { component?: hugging_face_inference_api_embedding; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: openai_embedding; type?: 'OPENAI_EMBEDDING'; } | { component?: vertex_text_embedding; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }; created_at?: string; data_sink?: { id: string; component: object | cloud_pinecone_vector_store | cloud_postgres_vector_store | cloud_qdrant_vector_store | cloud_azure_ai_search_vector_store | cloud_mongodb_atlas_vector_search | cloud_milvus_vector_store | cloud_astra_db_vector_store; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }; embedding_model_config?: { id: string; embedding_config: object | object | object | object | object | object | object; name: string; project_id: string; created_at?: string; updated_at?: string; }; embedding_model_config_id?: string; llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: parsing_languages[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: parsing_mode; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: fail_page_mode; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: object[]; webhook_url?: string; }; managed_pipeline_id?: string; metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }; pipeline_type?: 'MANAGED' | 'PLAYGROUND'; preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: retrieval_mode; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: metadata_filters; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }; sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }; status?: 'CREATED' | 'DELETING'; transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: object | object | object | object | object; mode?: 'advanced'; segmentation_config?: object | object | object; }; updated_at?: string; }`\n Schema for a pipeline.\n\n - `id: string`\n - `embedding_config: { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; azure_deployment?: string; azure_endpoint?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'AZURE_EMBEDDING'; } | { component?: { additional_kwargs?: object; aws_access_key_id?: string; aws_secret_access_key?: string; aws_session_token?: string; class_name?: string; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; profile_name?: string; region_name?: string; timeout?: number; }; type?: 'BEDROCK_EMBEDDING'; } | { component?: { api_key: string; class_name?: string; embed_batch_size?: number; embedding_type?: string; input_type?: string; model_name?: string; num_workers?: number; truncate?: string; }; type?: 'COHERE_EMBEDDING'; } | { component?: { api_base?: string; api_key?: string; class_name?: string; embed_batch_size?: number; model_name?: string; num_workers?: number; output_dimensionality?: number; task_type?: string; title?: string; transport?: string; }; type?: 'GEMINI_EMBEDDING'; } | { component?: { token?: string | boolean; class_name?: string; cookies?: object; embed_batch_size?: number; headers?: object; model_name?: string; num_workers?: number; pooling?: 'cls' | 'last' | 'mean'; query_instruction?: string; task?: string; text_instruction?: string; timeout?: number; }; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: { class_name?: string; embed_batch_size?: number; model_name?: 'openai-text-embedding-3-small'; num_workers?: number; }; type?: 'MANAGED_OPENAI_EMBEDDING'; } | { component?: { additional_kwargs?: object; api_base?: string; api_key?: string; api_version?: string; class_name?: string; default_headers?: object; dimensions?: number; embed_batch_size?: number; max_retries?: number; model_name?: string; num_workers?: number; reuse_client?: boolean; timeout?: number; }; type?: 'OPENAI_EMBEDDING'; } | { component?: { client_email: string; location: string; private_key: string; private_key_id: string; project: string; token_uri: string; additional_kwargs?: object; class_name?: string; embed_batch_size?: number; embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity'; model_name?: string; num_workers?: number; }; type?: 'VERTEXAI_EMBEDDING'; }`\n - `name: string`\n - `project_id: string`\n - `config_hash?: { embedding_config_hash?: string; parsing_config_hash?: string; transform_config_hash?: string; }`\n - `created_at?: string`\n - `data_sink?: { id: string; component: object | { api_key: string; index_name: string; class_name?: string; insert_kwargs?: object; namespace?: string; supports_nested_metadata_filters?: true; } | { database: string; embed_dim: number; host: string; password: string; port: number; schema_name: string; table_name: string; user: string; class_name?: string; hnsw_settings?: pg_vector_hnsw_settings; hybrid_search?: boolean; perform_setup?: boolean; supports_nested_metadata_filters?: boolean; } | { api_key: string; collection_name: string; url: string; class_name?: string; client_kwargs?: object; max_retries?: number; supports_nested_metadata_filters?: true; } | { search_service_api_key: string; search_service_endpoint: string; class_name?: string; client_id?: string; client_secret?: string; embedding_dimension?: number; filterable_metadata_field_keys?: object; index_name?: string; search_service_api_version?: string; supports_nested_metadata_filters?: true; tenant_id?: string; } | { collection_name: string; db_name: string; mongodb_uri: string; class_name?: string; embedding_dimension?: number; fulltext_index_name?: string; supports_nested_metadata_filters?: boolean; vector_index_name?: string; } | { uri: string; token?: string; class_name?: string; collection_name?: string; embedding_dimension?: number; supports_nested_metadata_filters?: boolean; } | { token: string; api_endpoint: string; collection_name: string; embedding_dimension: number; class_name?: string; keyspace?: string; supports_nested_metadata_filters?: true; }; name: string; project_id: string; sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT'; created_at?: string; updated_at?: string; }`\n - `embedding_model_config?: { id: string; embedding_config: { component?: object; type?: 'AZURE_EMBEDDING'; } | { component?: object; type?: 'BEDROCK_EMBEDDING'; } | { component?: object; type?: 'COHERE_EMBEDDING'; } | { component?: object; type?: 'GEMINI_EMBEDDING'; } | { component?: object; type?: 'HUGGINGFACE_API_EMBEDDING'; } | { component?: object; type?: 'OPENAI_EMBEDDING'; } | { component?: object; type?: 'VERTEXAI_EMBEDDING'; }; name: string; project_id: string; created_at?: string; updated_at?: string; }`\n - `embedding_model_config_id?: string`\n - `llama_parse_parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_line_numbers?: boolean; annotate_links?: boolean; annotate_revisions?: boolean; auto_mode?: boolean; auto_mode_configuration_json?: string; auto_mode_trigger_on_image_in_page?: boolean; auto_mode_trigger_on_regexp_in_page?: string; auto_mode_trigger_on_table_in_page?: boolean; auto_mode_trigger_on_text_in_page?: string; azure_openai_api_version?: string; azure_openai_deployment_name?: string; azure_openai_endpoint?: string; azure_openai_key?: string; bbox_bottom?: number; bbox_left?: number; bbox_right?: number; bbox_top?: number; bounding_box?: string; compact_markdown_table?: boolean; complemental_formatting_instruction?: string; confidence_score_effort?: string; content_guideline_instruction?: string; continuous_mode?: boolean; disable_image_extraction?: boolean; disable_ocr?: boolean; disable_reconstruction?: boolean; do_not_cache?: boolean; do_not_unroll_columns?: boolean; enable_cost_optimizer?: boolean; extract_charts?: boolean; extract_layout?: boolean; extract_printed_page_number?: boolean; fast_mode?: boolean; formatting_instruction?: string; gpt4o_api_key?: string; gpt4o_mode?: boolean; guess_xlsx_sheet_name?: boolean; hide_footers?: boolean; hide_headers?: boolean; high_res_ocr?: boolean; html_make_all_elements_visible?: boolean; html_remove_fixed_elements?: boolean; html_remove_navigation_elements?: boolean; http_proxy?: string; ignore_document_elements_for_layout_detection?: boolean; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; inline_images_in_markdown?: boolean; input_s3_path?: string; input_s3_region?: string; input_url?: string; internal_is_screenshot_job?: boolean; invalidate_cache?: boolean; is_formatting_instruction?: boolean; job_timeout_extra_time_per_page_in_seconds?: number; job_timeout_in_seconds?: number; keep_page_separator_when_merging_tables?: boolean; languages?: string[]; layout_aware?: boolean; line_level_bounding_box?: boolean; markdown_table_multiline_header_separator?: string; max_pages?: number; max_pages_enforced?: number; merge_tables_across_pages_in_markdown?: boolean; model?: string; outlined_table_extraction?: boolean; output_pdf_of_document?: boolean; output_s3_path_prefix?: string; output_s3_region?: string; output_tables_as_HTML?: boolean; page_error_tolerance?: number; page_footer_prefix?: string; page_footer_suffix?: string; page_header_prefix?: string; page_header_suffix?: string; page_prefix?: string; page_separator?: string; page_suffix?: string; parse_mode?: string; parsing_instruction?: string; precise_bounding_box?: boolean; premium_mode?: boolean; presentation_out_of_bounds_content?: boolean; presentation_skip_embedded_data?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; preset?: string; priority?: 'critical' | 'high' | 'low' | 'medium'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'blank_page' | 'error_message' | 'raw_text'; replace_failed_page_with_error_message_prefix?: string; replace_failed_page_with_error_message_suffix?: string; save_images?: boolean; skip_diagonal_text?: boolean; specialized_chart_parsing_agentic?: boolean; specialized_chart_parsing_efficient?: boolean; specialized_chart_parsing_plus?: boolean; specialized_image_parsing?: boolean; spreadsheet_extract_sub_tables?: boolean; spreadsheet_force_formula_computation?: boolean; spreadsheet_include_hidden_sheets?: boolean; strict_mode_buggy_font?: boolean; strict_mode_image_extraction?: boolean; strict_mode_image_ocr?: boolean; strict_mode_reconstruction?: boolean; structured_output?: boolean; structured_output_json_schema?: string; structured_output_json_schema_name?: string; system_prompt?: string; system_prompt_append?: string; take_screenshot?: boolean; target_pages?: string; tier?: string; use_vendor_multimodal_model?: boolean; user_prompt?: string; vendor_multimodal_api_key?: string; vendor_multimodal_model_name?: string; version?: string; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; webhook_url?: string; }`\n - `managed_pipeline_id?: string`\n - `metadata_config?: { excluded_embed_metadata_keys?: string[]; excluded_llm_metadata_keys?: string[]; }`\n - `pipeline_type?: 'MANAGED' | 'PLAYGROUND'`\n - `preset_retrieval_parameters?: { alpha?: number; class_name?: string; dense_similarity_cutoff?: number; dense_similarity_top_k?: number; enable_reranking?: boolean; files_top_k?: number; rerank_top_n?: number; retrieval_mode?: 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata'; retrieve_image_nodes?: boolean; retrieve_page_figure_nodes?: boolean; retrieve_page_screenshot_nodes?: boolean; search_filters?: { filters: object | metadata_filters[]; condition?: 'and' | 'not' | 'or'; }; search_filters_inference_schema?: object; sparse_similarity_top_k?: number; }`\n - `sparse_model_config?: { class_name?: string; model_type?: 'auto' | 'bm25' | 'splade'; }`\n - `status?: 'CREATED' | 'DELETING'`\n - `transform_config?: { chunk_overlap?: number; chunk_size?: number; mode?: 'auto'; } | { chunking_config?: { mode?: 'none'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'character'; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'token'; separator?: string; } | { chunk_overlap?: number; chunk_size?: number; mode?: 'sentence'; paragraph_separator?: string; separator?: string; } | { breakpoint_percentile_threshold?: number; buffer_size?: number; mode?: 'semantic'; }; mode?: 'advanced'; segmentation_config?: { mode?: 'none'; } | { mode?: 'page'; page_separator?: string; } | { mode?: 'element'; }; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipeline = await client.pipelines.dataSources.sync('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(pipeline);\n```",
3545
3307
  perLanguage: {
3546
3308
  go: {
3547
3309
  method: 'client.Pipelines.DataSources.Sync',
@@ -5819,244 +5581,6 @@ const EMBEDDED_METHODS = [
5819
5581
  },
5820
5582
  },
5821
5583
  },
5822
- {
5823
- name: 'create',
5824
- endpoint: '/api/v1/beta/sheets/jobs',
5825
- httpMethod: 'post',
5826
- summary: 'Create Spreadsheet Job',
5827
- description: 'Create a spreadsheet parsing job.\n\nProvide at most one of `configuration` (an inline parsing configuration) or\n`configuration_id` (a saved configuration preset). If neither is provided, a\ndefault configuration is used. Optionally include `webhook_configurations`\nto receive `sheets.*` status notifications.',
5828
- stainlessPath: '(resource) beta.sheets > (method) create',
5829
- qualified: 'client.beta.sheets.create',
5830
- params: [
5831
- 'file_id: string;',
5832
- 'organization_id?: string;',
5833
- 'project_id?: string;',
5834
- "config?: { 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; };",
5835
- "configuration?: { 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; };",
5836
- 'configuration_id?: string;',
5837
- 'webhook_configuration_ids?: string[];',
5838
- 'webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[];',
5839
- ],
5840
- response: "{ id: string; configuration: object; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: object; configuration_id?: string; errors?: string[]; file?: object; metadata_state_transitions?: object; parameters?: { webhook_configurations?: object[]; }; regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]; success?: boolean; worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]; }",
5841
- markdown: "## create\n\n`client.beta.sheets.create(file_id: string, organization_id?: string, project_id?: string, config?: { 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; }, configuration?: { 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; }, 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; configuration: sheets_parsing_config; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: sheets_parsing_config; configuration_id?: string; errors?: string[]; file?: file; metadata_state_transitions?: object; parameters?: object; regions?: object[]; success?: boolean; worksheet_metadata?: object[]; }`\n\n**post** `/api/v1/beta/sheets/jobs`\n\nCreate a spreadsheet parsing job.\n\nProvide at most one of `configuration` (an inline parsing configuration) or\n`configuration_id` (a saved configuration preset). If neither is provided, a\ndefault configuration is used. Optionally include `webhook_configurations`\nto receive `sheets.*` status notifications.\n\n### Parameters\n\n- `file_id: string`\n The ID of the file to parse\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `config?: { 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; }`\n Configuration for spreadsheet parsing and region extraction\n - `extraction_range?: string`\n A1 notation of the range to extract a single region from. If None, the entire sheet is used.\n - `flatten_hierarchical_tables?: boolean`\n Return a flattened dataframe when a detected table is recognized as hierarchical.\n - `generate_additional_metadata?: boolean`\n Deprecated: controlled by `tier`. Whether to generate additional metadata (title, description) for each extracted region. Honored only on `agentic`.\n - `include_hidden_cells?: boolean`\n Whether to include hidden cells when extracting regions from the spreadsheet.\n - `sheet_names?: string[]`\n The names of the sheets to extract regions from. If empty, all sheets will be processed.\n - `specialization?: string`\n Deprecated: controlled by `tier`. Optional specialization mode for domain-specific extraction. Supported values: 'financial-standard', 'financial-enhanced', 'financial-precise'. Default None uses the general-purpose pipeline. Honored only on `agentic`.\n - `table_merge_sensitivity?: 'strong' | 'weak'`\n Deprecated: controlled by `tier`. Influences how likely similar-looking regions are merged into a single table. Honored only on `agentic`.\n - `tier?: 'agentic' | 'cost_effective'`\n Spreadsheet extraction tier. `cost_effective` uses the rule-based/ML-only pipeline; `agentic` uses the full pipeline.\n - `use_experimental_processing?: boolean`\n Deprecated: controlled by `tier`. Enables experimental processing. Honored only on `agentic`.\n\n- `configuration?: { 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; }`\n Configuration for spreadsheet parsing and region extraction\n - `extraction_range?: string`\n A1 notation of the range to extract a single region from. If None, the entire sheet is used.\n - `flatten_hierarchical_tables?: boolean`\n Return a flattened dataframe when a detected table is recognized as hierarchical.\n - `generate_additional_metadata?: boolean`\n Deprecated: controlled by `tier`. Whether to generate additional metadata (title, description) for each extracted region. Honored only on `agentic`.\n - `include_hidden_cells?: boolean`\n Whether to include hidden cells when extracting regions from the spreadsheet.\n - `sheet_names?: string[]`\n The names of the sheets to extract regions from. If empty, all sheets will be processed.\n - `specialization?: string`\n Deprecated: controlled by `tier`. Optional specialization mode for domain-specific extraction. Supported values: 'financial-standard', 'financial-enhanced', 'financial-precise'. Default None uses the general-purpose pipeline. Honored only on `agentic`.\n - `table_merge_sensitivity?: 'strong' | 'weak'`\n Deprecated: controlled by `tier`. Influences how likely similar-looking regions are merged into a single table. Honored only on `agentic`.\n - `tier?: 'agentic' | 'cost_effective'`\n Spreadsheet extraction tier. `cost_effective` uses the rule-based/ML-only pipeline; `agentic` uses the full pipeline.\n - `use_experimental_processing?: boolean`\n Deprecated: controlled by `tier`. Enables experimental processing. Honored only on `agentic`.\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; configuration: { 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; }; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: { 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; }; configuration_id?: string; errors?: string[]; file?: { id: string; name: string; project_id: string; created_at?: string; data_source_id?: string; expires_at?: string; external_file_id?: string; file_size?: number; file_type?: string; last_modified_at?: string; permission_info?: object; purpose?: string; resource_info?: object; updated_at?: string; }; metadata_state_transitions?: object; parameters?: { webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; }; regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]; success?: boolean; worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]; }`\n A spreadsheet parsing job.\n\n - `id: string`\n - `configuration: { 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; }`\n - `created_at: string`\n - `file_id: string`\n - `project_id: string`\n - `status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'`\n - `updated_at: string`\n - `user_id: string`\n - `config?: { 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; }`\n - `configuration_id?: string`\n - `errors?: string[]`\n - `file?: { id: string; name: string; project_id: string; created_at?: string; data_source_id?: string; expires_at?: string; external_file_id?: string; file_size?: number; file_type?: string; last_modified_at?: string; permission_info?: object; purpose?: string; resource_info?: object; updated_at?: string; }`\n - `metadata_state_transitions?: object`\n - `parameters?: { webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; }`\n - `regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]`\n - `success?: boolean`\n - `worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst sheetsJob = await client.beta.sheets.create({ file_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(sheetsJob);\n```",
5842
- perLanguage: {
5843
- go: {
5844
- method: 'client.Beta.Sheets.New',
5845
- example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tsheetsJob, err := client.Beta.Sheets.New(context.TODO(), llamacloud.BetaSheetNewParams{\n\t\tFileID: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sheetsJob.ID)\n}\n',
5846
- },
5847
- python: {
5848
- method: 'beta.sheets.create',
5849
- example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nsheets_job = client.beta.sheets.create(\n file_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(sheets_job.id)',
5850
- },
5851
- java: {
5852
- method: 'beta().sheets().create',
5853
- example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.beta.sheets.SheetCreateParams;\nimport ai.llamaindex.llamacloud.models.beta.sheets.SheetsJob;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n SheetCreateParams params = SheetCreateParams.builder()\n .fileId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n .build();\n SheetsJob sheetsJob = client.beta().sheets().create(params);\n }\n}',
5854
- },
5855
- csharp: {
5856
- method: 'Beta.Sheets.Create',
5857
- example: 'SheetCreateParams parameters = new()\n{\n FileID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n};\n\nvar sheetsJob = await client.Beta.Sheets.Create(parameters);\n\nConsole.WriteLine(sheetsJob);',
5858
- },
5859
- typescript: {
5860
- method: 'client.beta.sheets.create',
5861
- example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\nconst sheetsJob = await client.beta.sheets.create({\n file_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n});\n\nconsole.log(sheetsJob.id);",
5862
- },
5863
- http: {
5864
- example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/sheets/jobs \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \\\n -d \'{\n "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n "configuration_id": "cfg-11111111-2222-3333-4444-555555555555",\n "webhook_configuration_ids": [\n "whc-...",\n "whc-..."\n ]\n }\'',
5865
- },
5866
- cli: {
5867
- method: 'sheets create',
5868
- example: "llp beta:sheets create \\\n --api-key 'My API Key' \\\n --file-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
5869
- },
5870
- },
5871
- },
5872
- {
5873
- name: 'list',
5874
- endpoint: '/api/v1/beta/sheets/jobs',
5875
- httpMethod: 'get',
5876
- summary: 'List Spreadsheet Jobs',
5877
- description: 'List spreadsheet parsing jobs.',
5878
- stainlessPath: '(resource) beta.sheets > (method) list',
5879
- qualified: 'client.beta.sheets.list',
5880
- params: [
5881
- 'configuration_id?: string;',
5882
- 'created_at_on_or_after?: string;',
5883
- 'created_at_on_or_before?: string;',
5884
- 'include_results?: boolean;',
5885
- 'job_ids?: string[];',
5886
- 'organization_id?: string;',
5887
- 'page_size?: number;',
5888
- 'page_token?: string;',
5889
- 'project_id?: string;',
5890
- "status?: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS';",
5891
- ],
5892
- response: "{ id: string; configuration: object; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: object; configuration_id?: string; errors?: string[]; file?: object; metadata_state_transitions?: object; parameters?: { webhook_configurations?: object[]; }; regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]; success?: boolean; worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]; }",
5893
- markdown: "## list\n\n`client.beta.sheets.list(configuration_id?: string, created_at_on_or_after?: string, created_at_on_or_before?: string, include_results?: boolean, job_ids?: string[], organization_id?: string, page_size?: number, page_token?: string, project_id?: string, status?: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'): { id: string; configuration: sheets_parsing_config; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: sheets_parsing_config; configuration_id?: string; errors?: string[]; file?: file; metadata_state_transitions?: object; parameters?: object; regions?: object[]; success?: boolean; worksheet_metadata?: object[]; }`\n\n**get** `/api/v1/beta/sheets/jobs`\n\nList spreadsheet parsing jobs.\n\n### Parameters\n\n- `configuration_id?: string`\n Filter by saved 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- `include_results?: boolean`\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' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'`\n Filter by job status\n\n### Returns\n\n- `{ id: string; configuration: { 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; }; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: { 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; }; configuration_id?: string; errors?: string[]; file?: { id: string; name: string; project_id: string; created_at?: string; data_source_id?: string; expires_at?: string; external_file_id?: string; file_size?: number; file_type?: string; last_modified_at?: string; permission_info?: object; purpose?: string; resource_info?: object; updated_at?: string; }; metadata_state_transitions?: object; parameters?: { webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; }; regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]; success?: boolean; worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]; }`\n A spreadsheet parsing job.\n\n - `id: string`\n - `configuration: { 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; }`\n - `created_at: string`\n - `file_id: string`\n - `project_id: string`\n - `status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'`\n - `updated_at: string`\n - `user_id: string`\n - `config?: { 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; }`\n - `configuration_id?: string`\n - `errors?: string[]`\n - `file?: { id: string; name: string; project_id: string; created_at?: string; data_source_id?: string; expires_at?: string; external_file_id?: string; file_size?: number; file_type?: string; last_modified_at?: string; permission_info?: object; purpose?: string; resource_info?: object; updated_at?: string; }`\n - `metadata_state_transitions?: object`\n - `parameters?: { webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; }`\n - `regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]`\n - `success?: boolean`\n - `worksheet_metadata?: { sheet_name: string; description?: string; title?: 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 sheetsJob of client.beta.sheets.list()) {\n console.log(sheetsJob);\n}\n```",
5894
- perLanguage: {
5895
- go: {
5896
- method: 'client.Beta.Sheets.List',
5897
- example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpage, err := client.Beta.Sheets.List(context.TODO(), llamacloud.BetaSheetListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n',
5898
- },
5899
- python: {
5900
- method: 'beta.sheets.list',
5901
- example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\npage = client.beta.sheets.list()\npage = page.items[0]\nprint(page.id)',
5902
- },
5903
- java: {
5904
- method: 'beta().sheets().list',
5905
- example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.beta.sheets.SheetListPage;\nimport ai.llamaindex.llamacloud.models.beta.sheets.SheetListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n SheetListPage page = client.beta().sheets().list();\n }\n}',
5906
- },
5907
- csharp: {
5908
- method: 'Beta.Sheets.List',
5909
- example: 'SheetListParams parameters = new();\n\nvar page = await client.Beta.Sheets.List(parameters);\nawait foreach (var item in page.Paginate())\n{\n Console.WriteLine(item);\n}',
5910
- },
5911
- typescript: {
5912
- method: 'client.beta.sheets.list',
5913
- example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const sheetsJob of client.beta.sheets.list()) {\n console.log(sheetsJob.id);\n}",
5914
- },
5915
- http: {
5916
- example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/sheets/jobs \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
5917
- },
5918
- cli: {
5919
- method: 'sheets list',
5920
- example: "llp beta:sheets list \\\n --api-key 'My API Key'",
5921
- },
5922
- },
5923
- },
5924
- {
5925
- name: 'get',
5926
- endpoint: '/api/v1/beta/sheets/jobs/{spreadsheet_job_id}',
5927
- httpMethod: 'get',
5928
- summary: 'Get Spreadsheet Job',
5929
- description: 'Get a spreadsheet parsing job. When `include_results=True` (default), embeds extracted regions and results if complete, skipping the separate `/results` call.',
5930
- stainlessPath: '(resource) beta.sheets > (method) get',
5931
- qualified: 'client.beta.sheets.get',
5932
- params: [
5933
- 'spreadsheet_job_id: string;',
5934
- 'expand?: string[];',
5935
- 'include_results?: boolean;',
5936
- 'organization_id?: string;',
5937
- 'project_id?: string;',
5938
- ],
5939
- response: "{ id: string; configuration: object; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: object; configuration_id?: string; errors?: string[]; file?: object; metadata_state_transitions?: object; parameters?: { webhook_configurations?: object[]; }; regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]; success?: boolean; worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]; }",
5940
- markdown: "## get\n\n`client.beta.sheets.get(spreadsheet_job_id: string, expand?: string[], include_results?: boolean, organization_id?: string, project_id?: string): { id: string; configuration: sheets_parsing_config; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: sheets_parsing_config; configuration_id?: string; errors?: string[]; file?: file; metadata_state_transitions?: object; parameters?: object; regions?: object[]; success?: boolean; worksheet_metadata?: object[]; }`\n\n**get** `/api/v1/beta/sheets/jobs/{spreadsheet_job_id}`\n\nGet a spreadsheet parsing job. When `include_results=True` (default), embeds extracted regions and results if complete, skipping the separate `/results` call.\n\n### Parameters\n\n- `spreadsheet_job_id: string`\n\n- `expand?: string[]`\n Optional fields to populate on the response. Valid values: metadata_state_transitions.\n\n- `include_results?: boolean`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; configuration: { 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; }; created_at: string; file_id: string; project_id: string; status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'; updated_at: string; user_id: string; config?: { 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; }; configuration_id?: string; errors?: string[]; file?: { id: string; name: string; project_id: string; created_at?: string; data_source_id?: string; expires_at?: string; external_file_id?: string; file_size?: number; file_type?: string; last_modified_at?: string; permission_info?: object; purpose?: string; resource_info?: object; updated_at?: string; }; metadata_state_transitions?: object; parameters?: { webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; }; regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]; success?: boolean; worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]; }`\n A spreadsheet parsing job.\n\n - `id: string`\n - `configuration: { 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; }`\n - `created_at: string`\n - `file_id: string`\n - `project_id: string`\n - `status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS'`\n - `updated_at: string`\n - `user_id: string`\n - `config?: { 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; }`\n - `configuration_id?: string`\n - `errors?: string[]`\n - `file?: { id: string; name: string; project_id: string; created_at?: string; data_source_id?: string; expires_at?: string; external_file_id?: string; file_size?: number; file_type?: string; last_modified_at?: string; permission_info?: object; purpose?: string; resource_info?: object; updated_at?: string; }`\n - `metadata_state_transitions?: object`\n - `parameters?: { webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_signing_secret?: string; webhook_url?: string; }[]; }`\n - `regions?: { location: string; region_type: string; sheet_name: string; description?: string; region_id?: string; title?: string; }[]`\n - `success?: boolean`\n - `worksheet_metadata?: { sheet_name: string; description?: string; title?: string; }[]`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst sheetsJob = await client.beta.sheets.get('spreadsheet_job_id');\n\nconsole.log(sheetsJob);\n```",
5941
- perLanguage: {
5942
- go: {
5943
- method: 'client.Beta.Sheets.Get',
5944
- example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tsheetsJob, err := client.Beta.Sheets.Get(\n\t\tcontext.TODO(),\n\t\t"spreadsheet_job_id",\n\t\tllamacloud.BetaSheetGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sheetsJob.ID)\n}\n',
5945
- },
5946
- python: {
5947
- method: 'beta.sheets.get',
5948
- example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nsheets_job = client.beta.sheets.get(\n spreadsheet_job_id="spreadsheet_job_id",\n)\nprint(sheets_job.id)',
5949
- },
5950
- java: {
5951
- method: 'beta().sheets().get',
5952
- example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.beta.sheets.SheetGetParams;\nimport ai.llamaindex.llamacloud.models.beta.sheets.SheetsJob;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n SheetsJob sheetsJob = client.beta().sheets().get("spreadsheet_job_id");\n }\n}',
5953
- },
5954
- csharp: {
5955
- method: 'Beta.Sheets.Get',
5956
- example: 'SheetGetParams parameters = new() { SpreadsheetJobID = "spreadsheet_job_id" };\n\nvar sheetsJob = await client.Beta.Sheets.Get(parameters);\n\nConsole.WriteLine(sheetsJob);',
5957
- },
5958
- typescript: {
5959
- method: 'client.beta.sheets.get',
5960
- example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\nconst sheetsJob = await client.beta.sheets.get('spreadsheet_job_id');\n\nconsole.log(sheetsJob.id);",
5961
- },
5962
- http: {
5963
- example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/sheets/jobs/$SPREADSHEET_JOB_ID \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
5964
- },
5965
- cli: {
5966
- method: 'sheets get',
5967
- example: "llp beta:sheets get \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id",
5968
- },
5969
- },
5970
- },
5971
- {
5972
- name: 'get_result_table',
5973
- endpoint: '/api/v1/beta/sheets/jobs/{spreadsheet_job_id}/regions/{region_id}/result/{region_type}',
5974
- httpMethod: 'get',
5975
- summary: 'Get Result Region',
5976
- description: 'Generate a presigned URL to download a specific extracted region.',
5977
- stainlessPath: '(resource) beta.sheets > (method) get_result_table',
5978
- qualified: 'client.beta.sheets.getResultTable',
5979
- params: [
5980
- 'spreadsheet_job_id: string;',
5981
- 'region_id: string;',
5982
- "region_type: 'cell_metadata' | 'extra' | 'table';",
5983
- 'expires_at_seconds?: number;',
5984
- 'organization_id?: string;',
5985
- 'project_id?: string;',
5986
- ],
5987
- response: '{ expires_at: string; url: string; form_fields?: object; }',
5988
- markdown: "## get_result_table\n\n`client.beta.sheets.getResultTable(spreadsheet_job_id: string, region_id: string, region_type: 'cell_metadata' | 'extra' | 'table', expires_at_seconds?: number, organization_id?: string, project_id?: string): { expires_at: string; url: string; form_fields?: object; }`\n\n**get** `/api/v1/beta/sheets/jobs/{spreadsheet_job_id}/regions/{region_id}/result/{region_type}`\n\nGenerate a presigned URL to download a specific extracted region.\n\n### Parameters\n\n- `spreadsheet_job_id: string`\n\n- `region_id: string`\n\n- `region_type: 'cell_metadata' | 'extra' | 'table'`\n\n- `expires_at_seconds?: number`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ expires_at: string; url: string; form_fields?: object; }`\n Schema for a presigned URL.\n\n - `expires_at: string`\n - `url: string`\n - `form_fields?: object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst presignedURL = await client.beta.sheets.getResultTable('cell_metadata', { spreadsheet_job_id: 'spreadsheet_job_id', region_id: 'region_id' });\n\nconsole.log(presignedURL);\n```",
5989
- perLanguage: {
5990
- go: {
5991
- method: 'client.Beta.Sheets.GetResultTable',
5992
- example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpresignedURL, err := client.Beta.Sheets.GetResultTable(\n\t\tcontext.TODO(),\n\t\tllamacloud.BetaSheetGetResultTableParamsRegionTypeCellMetadata,\n\t\tllamacloud.BetaSheetGetResultTableParams{\n\t\t\tSpreadsheetJobID: "spreadsheet_job_id",\n\t\t\tRegionID: "region_id",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", presignedURL.ExpiresAt)\n}\n',
5993
- },
5994
- python: {
5995
- method: 'beta.sheets.get_result_table',
5996
- example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\npresigned_url = client.beta.sheets.get_result_table(\n region_type="cell_metadata",\n spreadsheet_job_id="spreadsheet_job_id",\n region_id="region_id",\n)\nprint(presigned_url.expires_at)',
5997
- },
5998
- java: {
5999
- method: 'beta().sheets().getResultTable',
6000
- example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.beta.sheets.SheetGetResultTableParams;\nimport ai.llamaindex.llamacloud.models.files.PresignedUrl;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n SheetGetResultTableParams params = SheetGetResultTableParams.builder()\n .spreadsheetJobId("spreadsheet_job_id")\n .regionId("region_id")\n .regionType(SheetGetResultTableParams.RegionType.CELL_METADATA)\n .build();\n PresignedUrl presignedUrl = client.beta().sheets().getResultTable(params);\n }\n}',
6001
- },
6002
- csharp: {
6003
- method: 'Beta.Sheets.GetResultTable',
6004
- example: 'SheetGetResultTableParams parameters = new()\n{\n SpreadsheetJobID = "spreadsheet_job_id",\n RegionID = "region_id",\n RegionType = RegionType.CellMetadata,\n};\n\nvar presignedUrl = await client.Beta.Sheets.GetResultTable(parameters);\n\nConsole.WriteLine(presignedUrl);',
6005
- },
6006
- typescript: {
6007
- method: 'client.beta.sheets.getResultTable',
6008
- example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\nconst presignedURL = await client.beta.sheets.getResultTable('cell_metadata', {\n spreadsheet_job_id: 'spreadsheet_job_id',\n region_id: 'region_id',\n});\n\nconsole.log(presignedURL.expires_at);",
6009
- },
6010
- http: {
6011
- example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/sheets/jobs/$SPREADSHEET_JOB_ID/regions/$REGION_ID/result/$REGION_TYPE \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
6012
- },
6013
- cli: {
6014
- method: 'sheets get_result_table',
6015
- example: "llp beta:sheets get-result-table \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id \\\n --region-id region_id \\\n --region-type cell_metadata",
6016
- },
6017
- },
6018
- },
6019
- {
6020
- name: 'delete_job',
6021
- endpoint: '/api/v1/beta/sheets/jobs/{spreadsheet_job_id}',
6022
- httpMethod: 'delete',
6023
- summary: 'Delete Spreadsheet Job',
6024
- description: 'Delete a spreadsheet parsing job and its associated data.',
6025
- stainlessPath: '(resource) beta.sheets > (method) delete_job',
6026
- qualified: 'client.beta.sheets.deleteJob',
6027
- params: ['spreadsheet_job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
6028
- response: 'object',
6029
- markdown: "## delete_job\n\n`client.beta.sheets.deleteJob(spreadsheet_job_id: string, organization_id?: string, project_id?: string): object`\n\n**delete** `/api/v1/beta/sheets/jobs/{spreadsheet_job_id}`\n\nDelete a spreadsheet parsing job and its associated data.\n\n### Parameters\n\n- `spreadsheet_job_id: string`\n\n- `organization_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.beta.sheets.deleteJob('spreadsheet_job_id');\n\nconsole.log(response);\n```",
6030
- perLanguage: {
6031
- go: {
6032
- method: 'client.Beta.Sheets.DeleteJob',
6033
- example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/run-llama/llama-parse-go"\n\t"github.com/run-llama/llama-parse-go/option"\n)\n\nfunc main() {\n\tclient := llamacloud.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tresponse, err := client.Beta.Sheets.DeleteJob(\n\t\tcontext.TODO(),\n\t\t"spreadsheet_job_id",\n\t\tllamacloud.BetaSheetDeleteJobParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n',
6034
- },
6035
- python: {
6036
- method: 'beta.sheets.delete_job',
6037
- example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nresponse = client.beta.sheets.delete_job(\n spreadsheet_job_id="spreadsheet_job_id",\n)\nprint(response)',
6038
- },
6039
- java: {
6040
- method: 'beta().sheets().deleteJob',
6041
- example: 'package ai.llamaindex.llamacloud.example;\n\nimport ai.llamaindex.llamacloud.client.LlamaCloudClient;\nimport ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;\nimport ai.llamaindex.llamacloud.models.beta.sheets.SheetDeleteJobParams;\nimport ai.llamaindex.llamacloud.models.beta.sheets.SheetDeleteJobResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();\n\n SheetDeleteJobResponse response = client.beta().sheets().deleteJob("spreadsheet_job_id");\n }\n}',
6042
- },
6043
- csharp: {
6044
- method: 'Beta.Sheets.DeleteJob',
6045
- example: 'SheetDeleteJobParams parameters = new()\n{\n SpreadsheetJobID = "spreadsheet_job_id"\n};\n\nvar response = await client.Beta.Sheets.DeleteJob(parameters);\n\nConsole.WriteLine(response);',
6046
- },
6047
- typescript: {
6048
- method: 'client.beta.sheets.deleteJob',
6049
- example: "import LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud({\n apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.beta.sheets.deleteJob('spreadsheet_job_id');\n\nconsole.log(response);",
6050
- },
6051
- http: {
6052
- example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/sheets/jobs/$SPREADSHEET_JOB_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
6053
- },
6054
- cli: {
6055
- method: 'sheets delete_job',
6056
- example: "llp beta:sheets delete-job \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id",
6057
- },
6058
- },
6059
- },
6060
5584
  {
6061
5585
  name: 'create',
6062
5586
  endpoint: '/api/v1/beta/directories',
@@ -6789,7 +6313,7 @@ const EMBEDDED_METHODS = [
6789
6313
  const EMBEDDED_READMES = [
6790
6314
  {
6791
6315
  language: 'go',
6792
- content: '# Llama Cloud Go API Library\n\n<a href="https://pkg.go.dev/github.com/run-llama/llama-parse-go"><img src="https://pkg.go.dev/badge/github.com/run-llama/llama-parse-go.svg" alt="Go Reference"></a>\n\nThe Llama Cloud Go library provides convenient access to the [Llama Cloud REST API](https://developers.llamaindex.ai/)\nfrom applications written in Go.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Llama Cloud MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40llamaindex%2Fllama-cloud-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsbGFtYWluZGV4L2xsYW1hLWNsb3VkLW1jcCJdLCJlbnYiOnsiTExBTUFfQ0xPVURfQVBJX0tFWSI6Ik15IEFQSSBLZXkifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](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.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.NewFile(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',
6316
+ content: '# Llama Cloud Go API Library\n\n<a href="https://pkg.go.dev/github.com/run-llama/llama-parse-go"><img src="https://pkg.go.dev/badge/github.com/run-llama/llama-parse-go.svg" alt="Go Reference"></a>\n\nThe Llama Cloud Go library provides convenient access to the [Llama Cloud REST API](https://developers.llamaindex.ai/)\nfrom applications written in Go.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Llama Cloud MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40llamaindex%2Fllama-cloud-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsbGFtYWluZGV4L2xsYW1hLWNsb3VkLW1jcCJdLCJlbnYiOnsiTExBTUFfQ0xPVURfQVBJX0tFWSI6Ik15IEFQSSBLZXkifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](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',
6793
6317
  },
6794
6318
  {
6795
6319
  language: 'python',
@@ -6797,7 +6321,7 @@ const EMBEDDED_READMES = [
6797
6321
  },
6798
6322
  {
6799
6323
  language: 'java',
6800
- content: '# Llama Cloud Java API Library\n\n<!-- x-release-please-start-version -->\n[![Maven Central](https://img.shields.io/maven-central/v/ai.llamaindex.llamacloud/llama-cloud)](https://central.sonatype.com/artifact/ai.llamaindex.llamacloud/llama-cloud/1.5.0)\n[![javadoc](https://javadoc.io/badge2/ai.llamaindex.llamacloud/llama-cloud/1.5.0/javadoc.svg)](https://javadoc.io/doc/ai.llamaindex.llamacloud/llama-cloud/1.5.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[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40llamaindex%2Fllama-cloud-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsbGFtYWluZGV4L2xsYW1hLWNsb3VkLW1jcCJdLCJlbnYiOnsiTExBTUFfQ0xPVURfQVBJX0tFWSI6Ik15IEFQSSBLZXkifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](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.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.5.0")\n~~~\n\n### Maven\n\n~~~xml\n<dependency>\n <groupId>ai.llamaindex</groupId>\n <artifactId>llama-cloud</artifactId>\n <version>1.5.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',
6324
+ content: '# Llama Cloud Java API Library\n\n<!-- x-release-please-start-version -->\n[![Maven Central](https://img.shields.io/maven-central/v/ai.llamaindex.llamacloud/llama-cloud)](https://central.sonatype.com/artifact/ai.llamaindex.llamacloud/llama-cloud/1.5.1)\n[![javadoc](https://javadoc.io/badge2/ai.llamaindex.llamacloud/llama-cloud/1.5.1/javadoc.svg)](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[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40llamaindex%2Fllama-cloud-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsbGFtYWluZGV4L2xsYW1hLWNsb3VkLW1jcCJdLCJlbnYiOnsiTExBTUFfQ0xPVURfQVBJX0tFWSI6Ik15IEFQSSBLZXkifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](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',
6801
6325
  },
6802
6326
  {
6803
6327
  language: 'csharp',