@llamaindex/llama-cloud-mcp 2.2.0 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/code-tool-worker.d.mts.map +1 -1
- package/code-tool-worker.d.ts.map +1 -1
- package/code-tool-worker.js +2 -6
- package/code-tool-worker.js.map +1 -1
- package/code-tool-worker.mjs +2 -6
- package/code-tool-worker.mjs.map +1 -1
- package/docs-search-tool.js +1 -1
- package/docs-search-tool.js.map +1 -1
- package/docs-search-tool.mjs +1 -1
- package/docs-search-tool.mjs.map +1 -1
- package/instructions.js +1 -1
- package/instructions.js.map +1 -1
- package/instructions.mjs +1 -1
- package/instructions.mjs.map +1 -1
- package/local-docs-search.d.mts.map +1 -1
- package/local-docs-search.d.ts.map +1 -1
- package/local-docs-search.js +51 -193
- package/local-docs-search.js.map +1 -1
- package/local-docs-search.mjs +51 -193
- package/local-docs-search.mjs.map +1 -1
- package/methods.d.mts.map +1 -1
- package/methods.d.ts.map +1 -1
- package/methods.js +0 -30
- package/methods.js.map +1 -1
- package/methods.mjs +0 -30
- package/methods.mjs.map +1 -1
- package/package.json +2 -2
- package/server.js +1 -1
- package/server.mjs +1 -1
- package/src/code-tool-worker.ts +2 -6
- package/src/docs-search-tool.ts +1 -1
- package/src/instructions.ts +1 -1
- package/src/local-docs-search.ts +51 -225
- package/src/methods.ts +0 -30
- package/src/server.ts +1 -1
- package/src/util.ts +2 -2
- package/util.js +2 -2
- package/util.js.map +1 -1
- package/util.mjs +2 -2
- package/util.mjs.map +1 -1
package/local-docs-search.js
CHANGED
|
@@ -70,7 +70,7 @@ const EMBEDDED_METHODS = [
|
|
|
70
70
|
},
|
|
71
71
|
typescript: {
|
|
72
72
|
method: 'client.files.create',
|
|
73
|
-
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 file = await client.files.create({\n file: fs.createReadStream('path/to/file'),\n purpose: 'purpose',\n});\n\nconsole.log(file.id);",
|
|
73
|
+
example: "import fs from 'fs';\nimport 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 file = await client.files.create({\n file: fs.createReadStream('path/to/file'),\n purpose: 'purpose',\n});\n\nconsole.log(file.id);",
|
|
74
74
|
},
|
|
75
75
|
},
|
|
76
76
|
},
|
|
@@ -315,12 +315,12 @@ const EMBEDDED_METHODS = [
|
|
|
315
315
|
'file_input: string;',
|
|
316
316
|
'organization_id?: string;',
|
|
317
317
|
'project_id?: string;',
|
|
318
|
-
"configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row';
|
|
318
|
+
"configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; };",
|
|
319
319
|
'configuration_id?: string;',
|
|
320
320
|
'webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_url?: string; }[];',
|
|
321
321
|
],
|
|
322
|
-
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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row';
|
|
323
|
-
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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row';
|
|
322
|
+
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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; }; 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; }; }",
|
|
323
|
+
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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; }, configuration_id?: string, webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 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; }`\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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; }`\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\n - `confidence_scores?: boolean`\n Include confidence scores in results\n - `extract_version?: string`\n Extract algorithm version. Use 'latest' or a date string.\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\n - `parse_tier?: string`\n Parse tier to use before extraction. Defaults to the extract tier if not specified.\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?: 'cost_effective' | 'agentic'`\n Extract tier: cost_effective (5 credits/page) or agentic (15 credits/page)\n\n- `configuration_id?: string`\n Saved configuration ID\n\n- `webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; }; 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; }; }`\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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; }`\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_document_tokens?: number; num_output_tokens?: number; num_pages_extracted?: 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```",
|
|
324
324
|
perLanguage: {
|
|
325
325
|
http: {
|
|
326
326
|
example: 'curl https://api.cloud.llamaindex.ai/api/v2/extract \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \\\n -d \'{\n "file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"\n }\'',
|
|
@@ -358,8 +358,8 @@ const EMBEDDED_METHODS = [
|
|
|
358
358
|
'project_id?: string;',
|
|
359
359
|
"status?: 'PENDING' | 'THROTTLED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED';",
|
|
360
360
|
],
|
|
361
|
-
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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row';
|
|
362
|
-
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?: 'PENDING' | 'THROTTLED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED'): { 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; }`\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?: 'PENDING' | 'THROTTLED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED'`\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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row';
|
|
361
|
+
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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; }; 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; }; }",
|
|
362
|
+
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?: 'PENDING' | 'THROTTLED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED'): { 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; }`\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?: 'PENDING' | 'THROTTLED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED'`\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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; }; 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; }; }`\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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; }`\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_document_tokens?: number; num_output_tokens?: number; num_pages_extracted?: 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```",
|
|
363
363
|
perLanguage: {
|
|
364
364
|
http: {
|
|
365
365
|
example: 'curl https://api.cloud.llamaindex.ai/api/v2/extract \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
@@ -383,8 +383,8 @@ const EMBEDDED_METHODS = [
|
|
|
383
383
|
stainlessPath: '(resource) extract > (method) get',
|
|
384
384
|
qualified: 'client.extract.get',
|
|
385
385
|
params: ['job_id: string;', 'expand?: string[];', 'organization_id?: string;', 'project_id?: string;'],
|
|
386
|
-
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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row';
|
|
387
|
-
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; }`\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,\nand `expand=extract_metadata` for per-field metadata.\n\n### Parameters\n\n- `job_id: string`\n\n- `expand?: string[]`\n Additional fields to include: configuration, extract_metadata\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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row';
|
|
386
|
+
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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; }; 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; }; }",
|
|
387
|
+
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; }`\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,\nand `expand=extract_metadata` for per-field metadata.\n\n### Parameters\n\n- `job_id: string`\n\n- `expand?: string[]`\n Additional fields to include: configuration, extract_metadata\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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; }; 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; }; }`\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; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; }`\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_document_tokens?: number; num_output_tokens?: number; num_pages_extracted?: 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```",
|
|
388
388
|
perLanguage: {
|
|
389
389
|
http: {
|
|
390
390
|
example: 'curl https://api.cloud.llamaindex.ai/api/v2/extract/$JOB_ID \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
@@ -434,18 +434,18 @@ const EMBEDDED_METHODS = [
|
|
|
434
434
|
qualified: 'client.extract.validateSchema',
|
|
435
435
|
params: ['data_schema: object;'],
|
|
436
436
|
response: '{ data_schema: object; }',
|
|
437
|
-
markdown: "## validate_schema\n\n`client.extract.validateSchema(data_schema: object): { data_schema: object; }`\n\n**post** `/api/v2/extract/schema/validation`\n\nValidate a JSON schema for extraction.\n\n### Parameters\n\n- `data_schema: object`\n JSON Schema to validate for use with extract jobs\n\n### Returns\n\n- `{ data_schema: object; }`\n Response schema for schema validation.\n\n - `data_schema: object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst extractV2SchemaValidateResponse = await client.extract.validateSchema({ data_schema: {
|
|
437
|
+
markdown: "## validate_schema\n\n`client.extract.validateSchema(data_schema: object): { data_schema: object; }`\n\n**post** `/api/v2/extract/schema/validation`\n\nValidate a JSON schema for extraction.\n\n### Parameters\n\n- `data_schema: object`\n JSON Schema to validate for use with extract jobs\n\n### Returns\n\n- `{ data_schema: object; }`\n Response schema for schema validation.\n\n - `data_schema: object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst extractV2SchemaValidateResponse = await client.extract.validateSchema({ data_schema: {\n properties: {\n vendor_name: 'bar',\n invoice_number: 'bar',\n total_amount: 'bar',\n line_items: 'bar',\n},\n required: ['vendor_name', 'invoice_number', 'total_amount'],\n type: 'object',\n} });\n\nconsole.log(extractV2SchemaValidateResponse);\n```",
|
|
438
438
|
perLanguage: {
|
|
439
439
|
http: {
|
|
440
|
-
example: 'curl https://api.cloud.llamaindex.ai/api/v2/extract/schema/validation \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \\\n -d \'{\n "data_schema": {\n "
|
|
440
|
+
example: 'curl https://api.cloud.llamaindex.ai/api/v2/extract/schema/validation \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \\\n -d \'{\n "data_schema": {\n "properties": {\n "vendor_name": "bar",\n "invoice_number": "bar",\n "total_amount": "bar",\n "line_items": "bar"\n },\n "required": [\n "vendor_name",\n "invoice_number",\n "total_amount"\n ],\n "type": "object"\n }\n }\'',
|
|
441
441
|
},
|
|
442
442
|
python: {
|
|
443
443
|
method: 'extract.validate_schema',
|
|
444
|
-
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)\nextract_v2_schema_validate_response = client.extract.validate_schema(\n data_schema={\n "
|
|
444
|
+
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)\nextract_v2_schema_validate_response = client.extract.validate_schema(\n data_schema={\n "properties": {\n "vendor_name": "bar",\n "invoice_number": "bar",\n "total_amount": "bar",\n "line_items": "bar",\n },\n "required": ["vendor_name", "invoice_number", "total_amount"],\n "type": "object",\n },\n)\nprint(extract_v2_schema_validate_response.data_schema)',
|
|
445
445
|
},
|
|
446
446
|
typescript: {
|
|
447
447
|
method: 'client.extract.validateSchema',
|
|
448
|
-
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 extractV2SchemaValidateResponse = await client.extract.validateSchema({\n data_schema: {
|
|
448
|
+
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 extractV2SchemaValidateResponse = await client.extract.validateSchema({\n data_schema: {\n properties: {\n vendor_name: 'bar',\n invoice_number: 'bar',\n total_amount: 'bar',\n line_items: 'bar',\n },\n required: ['vendor_name', 'invoice_number', 'total_amount'],\n type: 'object',\n },\n});\n\nconsole.log(extractV2SchemaValidateResponse.data_schema);",
|
|
449
449
|
},
|
|
450
450
|
},
|
|
451
451
|
},
|
|
@@ -465,8 +465,8 @@ const EMBEDDED_METHODS = [
|
|
|
465
465
|
'name?: string;',
|
|
466
466
|
'prompt?: string;',
|
|
467
467
|
],
|
|
468
|
-
response: "{ name: string; parameters:
|
|
469
|
-
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: split_v1_parameters | extract_v2_parameters | classify_v2_parameters | parse_v2_parameters | 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: { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row';
|
|
468
|
+
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'; use_experimental_processing?: boolean; } | object; }",
|
|
469
|
+
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: split_v1_parameters | extract_v2_parameters | classify_v2_parameters | parse_v2_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: { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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_configurations?: 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'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; }`\n Request body for creating a product configuration.\n\n - `name: string`\n - `parameters: { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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; }; 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?: { extract_printed_page_number?: boolean; images_to_save?: 'screenshot' | 'embedded' | 'layout'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: object; }; 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; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic_plus' | 'agentic' | 'efficient'; }; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_url?: string; }[]; } | { 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'; 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```",
|
|
470
470
|
perLanguage: {
|
|
471
471
|
http: {
|
|
472
472
|
example: "curl https://api.cloud.llamaindex.ai/api/v2/extract/schema/generate \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $LLAMA_CLOUD_API_KEY\" \\\n -d '{}'",
|
|
@@ -698,12 +698,12 @@ const EMBEDDED_METHODS = [
|
|
|
698
698
|
qualified: 'client.configurations.create',
|
|
699
699
|
params: [
|
|
700
700
|
'name: string;',
|
|
701
|
-
"parameters: { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row';
|
|
701
|
+
"parameters: { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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; }; 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?: { extract_printed_page_number?: boolean; images_to_save?: 'screenshot' | 'embedded' | 'layout'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: object; }; 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; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic_plus' | 'agentic' | 'efficient'; }; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_url?: string; }[]; } | { 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'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; };",
|
|
702
702
|
'organization_id?: string;',
|
|
703
703
|
'project_id?: string;',
|
|
704
704
|
],
|
|
705
|
-
response: "{ id: string; name: string; parameters:
|
|
706
|
-
markdown: "## create\n\n`client.configurations.create(name: string, parameters: { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; lang?: string; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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_configurations?: object[]; } | { product_type: 'unknown'; }, organization_id?: string, project_id?: string): { id: string; name: string; parameters: split_v1_parameters | extract_v2_parameters | classify_v2_parameters | parse_v2_parameters | untyped_parameters; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**post** `/api/v1/beta/configurations`\n\nCreate or update a product configuration.\n\nIf a configuration with the same name already exists for this product\ntype and project, it will be updated (upsert semantics).\n\n### Parameters\n\n- `name: string`\n Human-readable name for this configuration.\n\n- `parameters: { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; lang?: string; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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; }; 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?: { extract_printed_page_number?: boolean; images_to_save?: 'screenshot' | 'embedded' | 'layout'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: object; }; 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; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic_plus' | 'agentic' | 'efficient'; }; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_url?: string; }[]; } | { 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: { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; lang?: string; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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_configurations?: object[]; } | { product_type: 'unknown'; }; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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: { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; lang?: string; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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; }; 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?: { extract_printed_page_number?: boolean; images_to_save?: 'screenshot' | 'embedded' | 'layout'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: object; }; 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; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic_plus' | 'agentic' | 'efficient'; }; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_url?: string; }[]; } | { product_type: 'unknown'; }`\n - `product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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: { categories: [{ name: 'x' }], product_type: 'split_v1' },\n});\n\nconsole.log(configurationResponse);\n```",
|
|
705
|
+
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'; use_experimental_processing?: boolean; } | object; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
|
|
706
|
+
markdown: "## create\n\n`client.configurations.create(name: string, parameters: { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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_configurations?: 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'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }, organization_id?: string, project_id?: string): { id: string; name: string; parameters: split_v1_parameters | extract_v2_parameters | classify_v2_parameters | parse_v2_parameters | object | untyped_parameters; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**post** `/api/v1/beta/configurations`\n\nCreate or update a product configuration.\n\nIf a configuration with the same name already exists for this product\ntype and project, it will be updated (upsert semantics).\n\n### Parameters\n\n- `name: string`\n Human-readable name for this configuration.\n\n- `parameters: { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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; }; 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?: { extract_printed_page_number?: boolean; images_to_save?: 'screenshot' | 'embedded' | 'layout'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: object; }; 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; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic_plus' | 'agentic' | 'efficient'; }; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_url?: string; }[]; } | { 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'; 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: { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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_configurations?: 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'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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: { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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; }; 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?: { extract_printed_page_number?: boolean; images_to_save?: 'screenshot' | 'embedded' | 'layout'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: object; }; 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; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic_plus' | 'agentic' | 'efficient'; }; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_url?: string; }[]; } | { 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'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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: { categories: [{ name: 'x' }], product_type: 'split_v1' },\n});\n\nconsole.log(configurationResponse);\n```",
|
|
707
707
|
perLanguage: {
|
|
708
708
|
http: {
|
|
709
709
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/configurations \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \\\n -d \'{\n "name": "x",\n "parameters": {\n "categories": [\n {\n "name": "x"\n }\n ],\n "product_type": "split_v1"\n }\n }\'',
|
|
@@ -732,11 +732,11 @@ const EMBEDDED_METHODS = [
|
|
|
732
732
|
'organization_id?: string;',
|
|
733
733
|
'page_size?: number;',
|
|
734
734
|
'page_token?: string;',
|
|
735
|
-
"product_type?: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | 'unknown'[];",
|
|
735
|
+
"product_type?: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | 'spreadsheet_v1' | 'unknown'[];",
|
|
736
736
|
'project_id?: string;',
|
|
737
737
|
],
|
|
738
|
-
response: "{ id: string; name: string; parameters:
|
|
739
|
-
markdown: "## list\n\n`client.configurations.list(latest_only?: boolean, name?: string, organization_id?: string, page_size?: number, page_token?: string, product_type?: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | 'unknown'[], project_id?: string): { id: string; name: string; parameters: split_v1_parameters | extract_v2_parameters | classify_v2_parameters | parse_v2_parameters | untyped_parameters; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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?: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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: { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row';
|
|
738
|
+
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'; use_experimental_processing?: boolean; } | object; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
|
|
739
|
+
markdown: "## list\n\n`client.configurations.list(latest_only?: boolean, name?: string, organization_id?: string, page_size?: number, page_token?: string, product_type?: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | 'spreadsheet_v1' | 'unknown'[], project_id?: string): { id: string; name: string; parameters: split_v1_parameters | extract_v2_parameters | classify_v2_parameters | parse_v2_parameters | object | untyped_parameters; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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?: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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: { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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_configurations?: 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'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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: { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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; }; 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?: { extract_printed_page_number?: boolean; images_to_save?: 'screenshot' | 'embedded' | 'layout'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: object; }; 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; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic_plus' | 'agentic' | 'efficient'; }; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_url?: string; }[]; } | { 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'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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```",
|
|
740
740
|
perLanguage: {
|
|
741
741
|
http: {
|
|
742
742
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/configurations \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
@@ -760,8 +760,8 @@ const EMBEDDED_METHODS = [
|
|
|
760
760
|
stainlessPath: '(resource) configurations > (method) retrieve',
|
|
761
761
|
qualified: 'client.configurations.retrieve',
|
|
762
762
|
params: ['config_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
763
|
-
response: "{ id: string; name: string; parameters:
|
|
764
|
-
markdown: "## retrieve\n\n`client.configurations.retrieve(config_id: string, organization_id?: string, project_id?: string): { id: string; name: string; parameters: split_v1_parameters | extract_v2_parameters | classify_v2_parameters | parse_v2_parameters | untyped_parameters; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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: { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row';
|
|
763
|
+
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'; use_experimental_processing?: boolean; } | object; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
|
|
764
|
+
markdown: "## retrieve\n\n`client.configurations.retrieve(config_id: string, organization_id?: string, project_id?: string): { id: string; name: string; parameters: split_v1_parameters | extract_v2_parameters | classify_v2_parameters | parse_v2_parameters | object | untyped_parameters; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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: { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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_configurations?: 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'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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: { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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; }; 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?: { extract_printed_page_number?: boolean; images_to_save?: 'screenshot' | 'embedded' | 'layout'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: object; }; 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; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic_plus' | 'agentic' | 'efficient'; }; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_url?: string; }[]; } | { 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'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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```",
|
|
765
765
|
perLanguage: {
|
|
766
766
|
http: {
|
|
767
767
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/configurations/$CONFIG_ID \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
@@ -789,10 +789,10 @@ const EMBEDDED_METHODS = [
|
|
|
789
789
|
'organization_id?: string;',
|
|
790
790
|
'project_id?: string;',
|
|
791
791
|
'name?: string;',
|
|
792
|
-
"parameters?: { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row';
|
|
792
|
+
"parameters?: { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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; }; 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?: { extract_printed_page_number?: boolean; images_to_save?: 'screenshot' | 'embedded' | 'layout'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: object; }; 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; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic_plus' | 'agentic' | 'efficient'; }; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_url?: string; }[]; } | { 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'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; };",
|
|
793
793
|
],
|
|
794
|
-
response: "{ id: string; name: string; parameters:
|
|
795
|
-
markdown: "## update\n\n`client.configurations.update(config_id: string, organization_id?: string, project_id?: string, name?: string, parameters?: { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; lang?: string; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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_configurations?: object[]; } | { product_type: 'unknown'; }): { id: string; name: string; parameters: split_v1_parameters | extract_v2_parameters | classify_v2_parameters | parse_v2_parameters | untyped_parameters; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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?: { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; lang?: string; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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; }; 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?: { extract_printed_page_number?: boolean; images_to_save?: 'screenshot' | 'embedded' | 'layout'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: object; }; 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; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic_plus' | 'agentic' | 'efficient'; }; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_url?: string; }[]; } | { product_type: 'unknown'; }`\n Updated parameters (omit to leave unchanged).\n\n### Returns\n\n- `{ id: string; name: string; parameters: { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; lang?: string; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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_configurations?: object[]; } | { product_type: 'unknown'; }; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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: { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; lang?: string; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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; }; 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?: { extract_printed_page_number?: boolean; images_to_save?: 'screenshot' | 'embedded' | 'layout'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: object; }; 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; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic_plus' | 'agentic' | 'efficient'; }; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_url?: string; }[]; } | { product_type: 'unknown'; }`\n - `product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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```",
|
|
794
|
+
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'; use_experimental_processing?: boolean; } | object; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
|
|
795
|
+
markdown: "## update\n\n`client.configurations.update(config_id: string, organization_id?: string, project_id?: string, name?: string, parameters?: { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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_configurations?: 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'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }): { id: string; name: string; parameters: split_v1_parameters | extract_v2_parameters | classify_v2_parameters | parse_v2_parameters | object | untyped_parameters; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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?: { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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; }; 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?: { extract_printed_page_number?: boolean; images_to_save?: 'screenshot' | 'embedded' | 'layout'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: object; }; 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; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic_plus' | 'agentic' | 'efficient'; }; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_url?: string; }[]; } | { 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'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n Updated parameters (omit to leave unchanged).\n\n### Returns\n\n- `{ id: string; name: string; parameters: { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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_configurations?: 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'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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: { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row'; max_pages?: number; parse_config_id?: string; parse_tier?: string; system_prompt?: string; target_pages?: string; tier?: 'cost_effective' | 'agentic'; } | { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { product_type: 'parse_v2'; tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus'; version: string | 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; }; 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?: { extract_printed_page_number?: boolean; images_to_save?: 'screenshot' | 'embedded' | 'layout'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: object; }; 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; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: parsing_languages[]; }; specialized_chart_parsing?: 'agentic_plus' | 'agentic' | 'efficient'; }; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_url?: string; }[]; } | { 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'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | '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```",
|
|
796
796
|
perLanguage: {
|
|
797
797
|
http: {
|
|
798
798
|
example: "curl https://api.cloud.llamaindex.ai/api/v1/beta/configurations/$CONFIG_ID \\\n -X PUT \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $LLAMA_CLOUD_API_KEY\" \\\n -d '{}'",
|
|
@@ -1883,7 +1883,7 @@ const EMBEDDED_METHODS = [
|
|
|
1883
1883
|
},
|
|
1884
1884
|
typescript: {
|
|
1885
1885
|
method: 'client.pipelines.metadata.create',
|
|
1886
|
-
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 metadata = await client.pipelines.metadata.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {\n upload_file: fs.createReadStream('path/to/file'),\n});\n\nconsole.log(metadata);",
|
|
1886
|
+
example: "import fs from 'fs';\nimport 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 metadata = await client.pipelines.metadata.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {\n upload_file: fs.createReadStream('path/to/file'),\n});\n\nconsole.log(metadata);",
|
|
1887
1887
|
},
|
|
1888
1888
|
},
|
|
1889
1889
|
},
|
|
@@ -2245,10 +2245,12 @@ const EMBEDDED_METHODS = [
|
|
|
2245
2245
|
params: [
|
|
2246
2246
|
'retriever_id: string;',
|
|
2247
2247
|
'pipelines: { description: string; name: string; pipeline_id: 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; }; }[];',
|
|
2248
|
+
'organization_id?: string;',
|
|
2249
|
+
'project_id?: string;',
|
|
2248
2250
|
'name?: string;',
|
|
2249
2251
|
],
|
|
2250
2252
|
response: '{ id: string; name: string; project_id: string; created_at?: string; pipelines?: { description: string; name: string; pipeline_id: string; preset_retrieval_parameters?: preset_retrieval_params; }[]; updated_at?: string; }',
|
|
2251
|
-
markdown: "## update\n\n`client.retrievers.update(retriever_id: string, pipelines: { description: string; name: string; pipeline_id: string; preset_retrieval_parameters?: preset_retrieval_params; }[], name?: string): { id: string; name: string; project_id: string; created_at?: string; pipelines?: retriever_pipeline[]; updated_at?: string; }`\n\n**put** `/api/v1/retrievers/{retriever_id}`\n\nUpdate an existing Retriever.\n\n### Parameters\n\n- `retriever_id: string`\n\n- `pipelines: { description: string; name: string; pipeline_id: 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; }; }[]`\n The pipelines this retriever uses.\n\n- `name?: string`\n A name for the retriever.\n\n### Returns\n\n- `{ id: string; name: string; project_id: string; created_at?: string; pipelines?: { description: string; name: string; pipeline_id: string; preset_retrieval_parameters?: preset_retrieval_params; }[]; updated_at?: string; }`\n An entity that retrieves context nodes from several sub RetrieverTools.\n\n - `id: string`\n - `name: string`\n - `project_id: string`\n - `created_at?: string`\n - `pipelines?: { description: string; name: string; pipeline_id: 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; }; }[]`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst retriever = await client.retrievers.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipelines: [{\n description: 'description',\n name: 'x',\n pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n}] });\n\nconsole.log(retriever);\n```",
|
|
2253
|
+
markdown: "## update\n\n`client.retrievers.update(retriever_id: string, pipelines: { description: string; name: string; pipeline_id: string; preset_retrieval_parameters?: preset_retrieval_params; }[], organization_id?: string, project_id?: string, name?: string): { id: string; name: string; project_id: string; created_at?: string; pipelines?: retriever_pipeline[]; updated_at?: string; }`\n\n**put** `/api/v1/retrievers/{retriever_id}`\n\nUpdate an existing Retriever.\n\n### Parameters\n\n- `retriever_id: string`\n\n- `pipelines: { description: string; name: string; pipeline_id: 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; }; }[]`\n The pipelines this retriever uses.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `name?: string`\n A name for the retriever.\n\n### Returns\n\n- `{ id: string; name: string; project_id: string; created_at?: string; pipelines?: { description: string; name: string; pipeline_id: string; preset_retrieval_parameters?: preset_retrieval_params; }[]; updated_at?: string; }`\n An entity that retrieves context nodes from several sub RetrieverTools.\n\n - `id: string`\n - `name: string`\n - `project_id: string`\n - `created_at?: string`\n - `pipelines?: { description: string; name: string; pipeline_id: 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; }; }[]`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst retriever = await client.retrievers.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipelines: [{\n description: 'description',\n name: 'x',\n pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n}] });\n\nconsole.log(retriever);\n```",
|
|
2252
2254
|
perLanguage: {
|
|
2253
2255
|
http: {
|
|
2254
2256
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/retrievers/$RETRIEVER_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \\\n -d \'{\n "pipelines": [\n {\n "description": "description",\n "name": "x",\n "pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n }\n ]\n }\'',
|
|
@@ -2271,15 +2273,15 @@ const EMBEDDED_METHODS = [
|
|
|
2271
2273
|
description: 'Delete a Retriever by ID.',
|
|
2272
2274
|
stainlessPath: '(resource) retrievers > (method) delete',
|
|
2273
2275
|
qualified: 'client.retrievers.delete',
|
|
2274
|
-
params: ['retriever_id: string;'],
|
|
2275
|
-
markdown: "## delete\n\n`client.retrievers.delete(retriever_id: string): void`\n\n**delete** `/api/v1/retrievers/{retriever_id}`\n\nDelete a Retriever by ID.\n\n### Parameters\n\n- `retriever_id: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nawait client.retrievers.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e')\n```",
|
|
2276
|
+
params: ['retriever_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
2277
|
+
markdown: "## delete\n\n`client.retrievers.delete(retriever_id: string, organization_id?: string, project_id?: string): void`\n\n**delete** `/api/v1/retrievers/{retriever_id}`\n\nDelete a Retriever by ID.\n\n### Parameters\n\n- `retriever_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nawait client.retrievers.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e')\n```",
|
|
2276
2278
|
perLanguage: {
|
|
2277
2279
|
http: {
|
|
2278
2280
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/retrievers/$RETRIEVER_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
2279
2281
|
},
|
|
2280
2282
|
python: {
|
|
2281
2283
|
method: 'retrievers.delete',
|
|
2282
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nclient.retrievers.delete(\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)',
|
|
2284
|
+
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nclient.retrievers.delete(\n retriever_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)',
|
|
2283
2285
|
},
|
|
2284
2286
|
typescript: {
|
|
2285
2287
|
method: 'client.retrievers.delete',
|
|
@@ -2564,152 +2566,6 @@ const EMBEDDED_METHODS = [
|
|
|
2564
2566
|
},
|
|
2565
2567
|
},
|
|
2566
2568
|
},
|
|
2567
|
-
{
|
|
2568
|
-
name: 'create',
|
|
2569
|
-
endpoint: '/api/v1/beta/parse-configurations',
|
|
2570
|
-
httpMethod: 'post',
|
|
2571
|
-
summary: 'Create Parse Configuration',
|
|
2572
|
-
description: 'Create a new parse configuration.\n\nArgs:\n config_create: Parse configuration creation data\n project: Validated project from dependency\n user: Current user\n\nReturns:\n The created parse configuration',
|
|
2573
|
-
stainlessPath: '(resource) beta.parse_configurations > (method) create',
|
|
2574
|
-
qualified: 'client.beta.parseConfigurations.create',
|
|
2575
|
-
params: [
|
|
2576
|
-
'name: string;',
|
|
2577
|
-
"parameters: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_links?: 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; 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?: 'screenshot' | 'embedded' | 'layout'[]; 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?: 'low' | 'medium' | 'high' | 'critical'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'raw_text' | 'blank_page' | 'error_message'; 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_url?: string; }[]; webhook_url?: string; };",
|
|
2578
|
-
'version: string;',
|
|
2579
|
-
'organization_id?: string;',
|
|
2580
|
-
'project_id?: string;',
|
|
2581
|
-
'creator?: string;',
|
|
2582
|
-
'source_id?: string;',
|
|
2583
|
-
'source_type?: string;',
|
|
2584
|
-
],
|
|
2585
|
-
response: '{ id: string; created_at: string; name: string; parameters: object; source_id: string; source_type: string; updated_at: string; version: string; creator?: string; }',
|
|
2586
|
-
markdown: "## create\n\n`client.beta.parseConfigurations.create(name: string, parameters: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_links?: 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; 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?: 'screenshot' | 'embedded' | 'layout'[]; 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?: 'low' | 'medium' | 'high' | 'critical'; 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; }, version: string, organization_id?: string, project_id?: string, creator?: string, source_id?: string, source_type?: string): { id: string; created_at: string; name: string; parameters: llama_parse_parameters; source_id: string; source_type: string; updated_at: string; version: string; creator?: string; }`\n\n**post** `/api/v1/beta/parse-configurations`\n\nCreate a new parse configuration.\n\nArgs:\n config_create: Parse configuration creation data\n project: Validated project from dependency\n user: Current user\n\nReturns:\n The created parse configuration\n\n### Parameters\n\n- `name: string`\n Name of the parse configuration\n\n- `parameters: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_links?: 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; 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?: 'screenshot' | 'embedded' | 'layout'[]; 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?: 'low' | 'medium' | 'high' | 'critical'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'raw_text' | 'blank_page' | 'error_message'; 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_url?: string; }[]; webhook_url?: string; }`\n LlamaParseParameters configuration\n - `adaptive_long_table?: boolean`\n - `aggressive_table_extraction?: boolean`\n - `annotate_links?: 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 - `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?: 'screenshot' | 'embedded' | 'layout'[]`\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?: 'low' | 'medium' | 'high' | 'critical'`\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?: 'raw_text' | 'blank_page' | 'error_message'`\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_url?: string; }[]`\n Outbound webhook endpoints to notify on job status changes\n - `webhook_url?: string`\n\n- `version: string`\n Version of the configuration\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `creator?: string`\n Creator of the configuration\n\n- `source_id?: string`\n ID of the source\n\n- `source_type?: string`\n Type of the source (e.g., 'project')\n\n### Returns\n\n- `{ id: string; created_at: string; name: string; parameters: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_links?: 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; 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?: 'screenshot' | 'embedded' | 'layout'[]; 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?: 'low' | 'medium' | 'high' | 'critical'; 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; }; source_id: string; source_type: string; updated_at: string; version: string; creator?: string; }`\n Parse configuration schema.\n\n - `id: string`\n - `created_at: string`\n - `name: string`\n - `parameters: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_links?: 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; 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?: 'screenshot' | 'embedded' | 'layout'[]; 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?: 'low' | 'medium' | 'high' | 'critical'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'raw_text' | 'blank_page' | 'error_message'; 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_url?: string; }[]; webhook_url?: string; }`\n - `source_id: string`\n - `source_type: string`\n - `updated_at: string`\n - `version: string`\n - `creator?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst parseConfiguration = await client.beta.parseConfigurations.create({\n name: 'name',\n parameters: {},\n version: 'version',\n});\n\nconsole.log(parseConfiguration);\n```",
|
|
2587
|
-
perLanguage: {
|
|
2588
|
-
http: {
|
|
2589
|
-
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/parse-configurations \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \\\n -d \'{\n "name": "name",\n "parameters": {},\n "version": "version"\n }\'',
|
|
2590
|
-
},
|
|
2591
|
-
python: {
|
|
2592
|
-
method: 'beta.parse_configurations.create',
|
|
2593
|
-
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)\nparse_configuration = client.beta.parse_configurations.create(\n name="name",\n parameters={},\n version="version",\n)\nprint(parse_configuration.id)',
|
|
2594
|
-
},
|
|
2595
|
-
typescript: {
|
|
2596
|
-
method: 'client.beta.parseConfigurations.create',
|
|
2597
|
-
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 parseConfiguration = await client.beta.parseConfigurations.create({\n name: 'name',\n parameters: {},\n version: 'version',\n});\n\nconsole.log(parseConfiguration.id);",
|
|
2598
|
-
},
|
|
2599
|
-
},
|
|
2600
|
-
},
|
|
2601
|
-
{
|
|
2602
|
-
name: 'list',
|
|
2603
|
-
endpoint: '/api/v1/beta/parse-configurations',
|
|
2604
|
-
httpMethod: 'get',
|
|
2605
|
-
summary: 'List Parse Configurations',
|
|
2606
|
-
description: 'List parse configurations for the current project.\n\nArgs:\n project: Validated project from dependency\n user: Current user\n page_size: Number of items per page\n page_token: Token for pagination\n name: Filter by configuration name\n creator: Filter by creator\n version: Filter by version\n\nReturns:\n Paginated response with parse configurations',
|
|
2607
|
-
stainlessPath: '(resource) beta.parse_configurations > (method) list',
|
|
2608
|
-
qualified: 'client.beta.parseConfigurations.list',
|
|
2609
|
-
params: [
|
|
2610
|
-
'creator?: string;',
|
|
2611
|
-
'name?: string;',
|
|
2612
|
-
'organization_id?: string;',
|
|
2613
|
-
'page_size?: number;',
|
|
2614
|
-
'page_token?: string;',
|
|
2615
|
-
'project_id?: string;',
|
|
2616
|
-
'version?: string;',
|
|
2617
|
-
],
|
|
2618
|
-
response: '{ id: string; created_at: string; name: string; parameters: object; source_id: string; source_type: string; updated_at: string; version: string; creator?: string; }',
|
|
2619
|
-
markdown: "## list\n\n`client.beta.parseConfigurations.list(creator?: string, name?: string, organization_id?: string, page_size?: number, page_token?: string, project_id?: string, version?: string): { id: string; created_at: string; name: string; parameters: llama_parse_parameters; source_id: string; source_type: string; updated_at: string; version: string; creator?: string; }`\n\n**get** `/api/v1/beta/parse-configurations`\n\nList parse configurations for the current project.\n\nArgs:\n project: Validated project from dependency\n user: Current user\n page_size: Number of items per page\n page_token: Token for pagination\n name: Filter by configuration name\n creator: Filter by creator\n version: Filter by version\n\nReturns:\n Paginated response with parse configurations\n\n### Parameters\n\n- `creator?: string`\n\n- `name?: string`\n\n- `organization_id?: string`\n\n- `page_size?: number`\n\n- `page_token?: string`\n\n- `project_id?: string`\n\n- `version?: string`\n\n### Returns\n\n- `{ id: string; created_at: string; name: string; parameters: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_links?: 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; 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?: 'screenshot' | 'embedded' | 'layout'[]; 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?: 'low' | 'medium' | 'high' | 'critical'; 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; }; source_id: string; source_type: string; updated_at: string; version: string; creator?: string; }`\n Parse configuration schema.\n\n - `id: string`\n - `created_at: string`\n - `name: string`\n - `parameters: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_links?: 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; 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?: 'screenshot' | 'embedded' | 'layout'[]; 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?: 'low' | 'medium' | 'high' | 'critical'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'raw_text' | 'blank_page' | 'error_message'; 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_url?: string; }[]; webhook_url?: string; }`\n - `source_id: string`\n - `source_type: string`\n - `updated_at: string`\n - `version: string`\n - `creator?: 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 parseConfiguration of client.beta.parseConfigurations.list()) {\n console.log(parseConfiguration);\n}\n```",
|
|
2620
|
-
perLanguage: {
|
|
2621
|
-
http: {
|
|
2622
|
-
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/parse-configurations \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
2623
|
-
},
|
|
2624
|
-
python: {
|
|
2625
|
-
method: 'beta.parse_configurations.list',
|
|
2626
|
-
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.parse_configurations.list()\npage = page.items[0]\nprint(page.id)',
|
|
2627
|
-
},
|
|
2628
|
-
typescript: {
|
|
2629
|
-
method: 'client.beta.parseConfigurations.list',
|
|
2630
|
-
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 parseConfiguration of client.beta.parseConfigurations.list()) {\n console.log(parseConfiguration.id);\n}",
|
|
2631
|
-
},
|
|
2632
|
-
},
|
|
2633
|
-
},
|
|
2634
|
-
{
|
|
2635
|
-
name: 'get',
|
|
2636
|
-
endpoint: '/api/v1/beta/parse-configurations/{config_id}',
|
|
2637
|
-
httpMethod: 'get',
|
|
2638
|
-
summary: 'Get Parse Configuration',
|
|
2639
|
-
description: 'Get a parse configuration by ID.\n\nArgs:\n config_id: The ID of the parse configuration\n project: Validated project from dependency\n user: Current user\n\nReturns:\n The parse configuration',
|
|
2640
|
-
stainlessPath: '(resource) beta.parse_configurations > (method) get',
|
|
2641
|
-
qualified: 'client.beta.parseConfigurations.get',
|
|
2642
|
-
params: ['config_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
2643
|
-
response: '{ id: string; created_at: string; name: string; parameters: object; source_id: string; source_type: string; updated_at: string; version: string; creator?: string; }',
|
|
2644
|
-
markdown: "## get\n\n`client.beta.parseConfigurations.get(config_id: string, organization_id?: string, project_id?: string): { id: string; created_at: string; name: string; parameters: llama_parse_parameters; source_id: string; source_type: string; updated_at: string; version: string; creator?: string; }`\n\n**get** `/api/v1/beta/parse-configurations/{config_id}`\n\nGet a parse configuration by ID.\n\nArgs:\n config_id: The ID of the parse configuration\n project: Validated project from dependency\n user: Current user\n\nReturns:\n The parse configuration\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; created_at: string; name: string; parameters: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_links?: 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; 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?: 'screenshot' | 'embedded' | 'layout'[]; 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?: 'low' | 'medium' | 'high' | 'critical'; 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; }; source_id: string; source_type: string; updated_at: string; version: string; creator?: string; }`\n Parse configuration schema.\n\n - `id: string`\n - `created_at: string`\n - `name: string`\n - `parameters: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_links?: 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; 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?: 'screenshot' | 'embedded' | 'layout'[]; 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?: 'low' | 'medium' | 'high' | 'critical'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'raw_text' | 'blank_page' | 'error_message'; 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_url?: string; }[]; webhook_url?: string; }`\n - `source_id: string`\n - `source_type: string`\n - `updated_at: string`\n - `version: string`\n - `creator?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst parseConfiguration = await client.beta.parseConfigurations.get('config_id');\n\nconsole.log(parseConfiguration);\n```",
|
|
2645
|
-
perLanguage: {
|
|
2646
|
-
http: {
|
|
2647
|
-
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/parse-configurations/$CONFIG_ID \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
2648
|
-
},
|
|
2649
|
-
python: {
|
|
2650
|
-
method: 'beta.parse_configurations.get',
|
|
2651
|
-
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)\nparse_configuration = client.beta.parse_configurations.get(\n config_id="config_id",\n)\nprint(parse_configuration.id)',
|
|
2652
|
-
},
|
|
2653
|
-
typescript: {
|
|
2654
|
-
method: 'client.beta.parseConfigurations.get',
|
|
2655
|
-
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 parseConfiguration = await client.beta.parseConfigurations.get('config_id');\n\nconsole.log(parseConfiguration.id);",
|
|
2656
|
-
},
|
|
2657
|
-
},
|
|
2658
|
-
},
|
|
2659
|
-
{
|
|
2660
|
-
name: 'update',
|
|
2661
|
-
endpoint: '/api/v1/beta/parse-configurations/{config_id}',
|
|
2662
|
-
httpMethod: 'put',
|
|
2663
|
-
summary: 'Update Parse Configuration',
|
|
2664
|
-
description: 'Update a parse configuration.\n\nArgs:\n config_id: The ID of the parse configuration to update\n config_update: Update data\n project: Validated project from dependency\n user: Current user\n\nReturns:\n The updated parse configuration',
|
|
2665
|
-
stainlessPath: '(resource) beta.parse_configurations > (method) update',
|
|
2666
|
-
qualified: 'client.beta.parseConfigurations.update',
|
|
2667
|
-
params: [
|
|
2668
|
-
'config_id: string;',
|
|
2669
|
-
'organization_id?: string;',
|
|
2670
|
-
'project_id?: string;',
|
|
2671
|
-
"parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_links?: 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; 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?: 'screenshot' | 'embedded' | 'layout'[]; 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?: 'low' | 'medium' | 'high' | 'critical'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'raw_text' | 'blank_page' | 'error_message'; 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_url?: string; }[]; webhook_url?: string; };",
|
|
2672
|
-
],
|
|
2673
|
-
response: '{ id: string; created_at: string; name: string; parameters: object; source_id: string; source_type: string; updated_at: string; version: string; creator?: string; }',
|
|
2674
|
-
markdown: "## update\n\n`client.beta.parseConfigurations.update(config_id: string, organization_id?: string, project_id?: string, parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_links?: 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; 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?: 'screenshot' | 'embedded' | 'layout'[]; 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?: 'low' | 'medium' | 'high' | 'critical'; 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; }): { id: string; created_at: string; name: string; parameters: llama_parse_parameters; source_id: string; source_type: string; updated_at: string; version: string; creator?: string; }`\n\n**put** `/api/v1/beta/parse-configurations/{config_id}`\n\nUpdate a parse configuration.\n\nArgs:\n config_id: The ID of the parse configuration to update\n config_update: Update data\n project: Validated project from dependency\n user: Current user\n\nReturns:\n The updated parse configuration\n\n### Parameters\n\n- `config_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `parameters?: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_links?: 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; 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?: 'screenshot' | 'embedded' | 'layout'[]; 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?: 'low' | 'medium' | 'high' | 'critical'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'raw_text' | 'blank_page' | 'error_message'; 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_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 - `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 - `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?: 'screenshot' | 'embedded' | 'layout'[]`\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?: 'low' | 'medium' | 'high' | 'critical'`\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?: 'raw_text' | 'blank_page' | 'error_message'`\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_url?: string; }[]`\n Outbound webhook endpoints to notify on job status changes\n - `webhook_url?: string`\n\n### Returns\n\n- `{ id: string; created_at: string; name: string; parameters: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_links?: 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; 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?: 'screenshot' | 'embedded' | 'layout'[]; 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?: 'low' | 'medium' | 'high' | 'critical'; 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; }; source_id: string; source_type: string; updated_at: string; version: string; creator?: string; }`\n Parse configuration schema.\n\n - `id: string`\n - `created_at: string`\n - `name: string`\n - `parameters: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; annotate_links?: 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; 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?: 'screenshot' | 'embedded' | 'layout'[]; 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?: 'low' | 'medium' | 'high' | 'critical'; project_id?: string; remove_hidden_text?: boolean; replace_failed_page_mode?: 'raw_text' | 'blank_page' | 'error_message'; 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_url?: string; }[]; webhook_url?: string; }`\n - `source_id: string`\n - `source_type: string`\n - `updated_at: string`\n - `version: string`\n - `creator?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst parseConfiguration = await client.beta.parseConfigurations.update('config_id');\n\nconsole.log(parseConfiguration);\n```",
|
|
2675
|
-
perLanguage: {
|
|
2676
|
-
http: {
|
|
2677
|
-
example: "curl https://api.cloud.llamaindex.ai/api/v1/beta/parse-configurations/$CONFIG_ID \\\n -X PUT \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $LLAMA_CLOUD_API_KEY\" \\\n -d '{}'",
|
|
2678
|
-
},
|
|
2679
|
-
python: {
|
|
2680
|
-
method: 'beta.parse_configurations.update',
|
|
2681
|
-
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)\nparse_configuration = client.beta.parse_configurations.update(\n config_id="config_id",\n)\nprint(parse_configuration.id)',
|
|
2682
|
-
},
|
|
2683
|
-
typescript: {
|
|
2684
|
-
method: 'client.beta.parseConfigurations.update',
|
|
2685
|
-
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 parseConfiguration = await client.beta.parseConfigurations.update('config_id');\n\nconsole.log(parseConfiguration.id);",
|
|
2686
|
-
},
|
|
2687
|
-
},
|
|
2688
|
-
},
|
|
2689
|
-
{
|
|
2690
|
-
name: 'delete',
|
|
2691
|
-
endpoint: '/api/v1/beta/parse-configurations/{config_id}',
|
|
2692
|
-
httpMethod: 'delete',
|
|
2693
|
-
summary: 'Delete Parse Configuration',
|
|
2694
|
-
description: 'Delete a parse configuration.\n\nArgs:\n config_id: The ID of the parse configuration to delete\n project: Validated project from dependency\n user: Current user',
|
|
2695
|
-
stainlessPath: '(resource) beta.parse_configurations > (method) delete',
|
|
2696
|
-
qualified: 'client.beta.parseConfigurations.delete',
|
|
2697
|
-
params: ['config_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
2698
|
-
markdown: "## delete\n\n`client.beta.parseConfigurations.delete(config_id: string, organization_id?: string, project_id?: string): void`\n\n**delete** `/api/v1/beta/parse-configurations/{config_id}`\n\nDelete a parse configuration.\n\nArgs:\n config_id: The ID of the parse configuration to delete\n project: Validated project from dependency\n user: Current user\n\n### Parameters\n\n- `config_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nawait client.beta.parseConfigurations.delete('config_id')\n```",
|
|
2699
|
-
perLanguage: {
|
|
2700
|
-
http: {
|
|
2701
|
-
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/parse-configurations/$CONFIG_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
2702
|
-
},
|
|
2703
|
-
python: {
|
|
2704
|
-
method: 'beta.parse_configurations.delete',
|
|
2705
|
-
example: 'import os\nfrom llama_cloud import LlamaCloud\n\nclient = LlamaCloud(\n api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted\n)\nclient.beta.parse_configurations.delete(\n config_id="config_id",\n)',
|
|
2706
|
-
},
|
|
2707
|
-
typescript: {
|
|
2708
|
-
method: 'client.beta.parseConfigurations.delete',
|
|
2709
|
-
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\nawait client.beta.parseConfigurations.delete('config_id');",
|
|
2710
|
-
},
|
|
2711
|
-
},
|
|
2712
|
-
},
|
|
2713
2569
|
{
|
|
2714
2570
|
name: 'create',
|
|
2715
2571
|
endpoint: '/api/v1/beta/sheets/jobs',
|
|
@@ -3020,10 +2876,11 @@ const EMBEDDED_METHODS = [
|
|
|
3020
2876
|
'organization_id?: string;',
|
|
3021
2877
|
'project_id?: string;',
|
|
3022
2878
|
'display_name?: string;',
|
|
2879
|
+
'metadata?: object;',
|
|
3023
2880
|
'unique_id?: string;',
|
|
3024
2881
|
],
|
|
3025
|
-
response: '{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; updated_at?: string; }',
|
|
3026
|
-
markdown: "## add\n\n`client.beta.directories.files.add(directory_id: string, file_id: string, organization_id?: string, project_id?: string, display_name?: string, unique_id?: string): { id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; updated_at?: string; }`\n\n**post** `/api/v1/beta/directories/{directory_id}/files`\n\nCreate a new file within the specified directory.\n\nThe directory must exist and belong to the project passed in.\nThe file_id must be provided and exist in the project.\n\n### Parameters\n\n- `directory_id: string`\n\n- `file_id: string`\n File ID for the storage location (required).\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `display_name?: string`\n Display name for the file. If not provided, will use the file's name.\n\n- `unique_id?: string`\n Unique identifier for the file in the directory. If not provided, will use the file's external_file_id or name.\n\n### Returns\n\n- `{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; updated_at?: string; }`\n API response schema for a directory file.\n\n - `id: string`\n - `directory_id: string`\n - `display_name: string`\n - `project_id: string`\n - `unique_id: string`\n - `created_at?: string`\n - `data_source_id?: string`\n - `deleted_at?: string`\n - `file_id?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst response = await client.beta.directories.files.add('directory_id', { file_id: 'file_id' });\n\nconsole.log(response);\n```",
|
|
2882
|
+
response: '{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; metadata?: object; updated_at?: string; }',
|
|
2883
|
+
markdown: "## add\n\n`client.beta.directories.files.add(directory_id: string, file_id: string, organization_id?: string, project_id?: string, display_name?: string, metadata?: object, unique_id?: string): { id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; metadata?: object; updated_at?: string; }`\n\n**post** `/api/v1/beta/directories/{directory_id}/files`\n\nCreate a new file within the specified directory.\n\nThe directory must exist and belong to the project passed in.\nThe file_id must be provided and exist in the project.\n\n### Parameters\n\n- `directory_id: string`\n\n- `file_id: string`\n File ID for the storage location (required).\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `display_name?: string`\n Display name for the file. If not provided, will use the file's name.\n\n- `metadata?: object`\n User-defined metadata key-value pairs to associate with the file.\n\n- `unique_id?: string`\n Unique identifier for the file in the directory. If not provided, will use the file's external_file_id or name.\n\n### Returns\n\n- `{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; metadata?: object; updated_at?: string; }`\n API response schema for a directory file.\n\n - `id: string`\n - `directory_id: string`\n - `display_name: string`\n - `project_id: string`\n - `unique_id: string`\n - `created_at?: string`\n - `data_source_id?: string`\n - `deleted_at?: string`\n - `file_id?: string`\n - `metadata?: object`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst response = await client.beta.directories.files.add('directory_id', { file_id: 'file_id' });\n\nconsole.log(response);\n```",
|
|
3027
2884
|
perLanguage: {
|
|
3028
2885
|
http: {
|
|
3029
2886
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/directories/$DIRECTORY_ID/files \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \\\n -d \'{\n "file_id": "file_id"\n }\'',
|
|
@@ -3058,8 +2915,8 @@ const EMBEDDED_METHODS = [
|
|
|
3058
2915
|
'project_id?: string;',
|
|
3059
2916
|
'unique_id?: string;',
|
|
3060
2917
|
],
|
|
3061
|
-
response: '{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; updated_at?: string; }',
|
|
3062
|
-
markdown: "## list\n\n`client.beta.directories.files.list(directory_id: string, display_name?: string, display_name_contains?: string, file_id?: string, include_deleted?: boolean, organization_id?: string, page_size?: number, page_token?: string, project_id?: string, unique_id?: string): { id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; updated_at?: string; }`\n\n**get** `/api/v1/beta/directories/{directory_id}/files`\n\nList all files within the specified directory with optional filtering and pagination.\n\n### Parameters\n\n- `directory_id: string`\n\n- `display_name?: string`\n\n- `display_name_contains?: string`\n\n- `file_id?: string`\n\n- `include_deleted?: boolean`\n\n- `organization_id?: string`\n\n- `page_size?: number`\n\n- `page_token?: string`\n\n- `project_id?: string`\n\n- `unique_id?: string`\n\n### Returns\n\n- `{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; updated_at?: string; }`\n API response schema for a directory file.\n\n - `id: string`\n - `directory_id: string`\n - `display_name: string`\n - `project_id: string`\n - `unique_id: string`\n - `created_at?: string`\n - `data_source_id?: string`\n - `deleted_at?: string`\n - `file_id?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\n// Automatically fetches more pages as needed.\nfor await (const fileListResponse of client.beta.directories.files.list('directory_id')) {\n console.log(fileListResponse);\n}\n```",
|
|
2918
|
+
response: '{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; metadata?: object; updated_at?: string; }',
|
|
2919
|
+
markdown: "## list\n\n`client.beta.directories.files.list(directory_id: string, display_name?: string, display_name_contains?: string, file_id?: string, include_deleted?: boolean, organization_id?: string, page_size?: number, page_token?: string, project_id?: string, unique_id?: string): { id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; metadata?: object; updated_at?: string; }`\n\n**get** `/api/v1/beta/directories/{directory_id}/files`\n\nList all files within the specified directory with optional filtering and pagination.\n\n### Parameters\n\n- `directory_id: string`\n\n- `display_name?: string`\n\n- `display_name_contains?: string`\n\n- `file_id?: string`\n\n- `include_deleted?: boolean`\n\n- `organization_id?: string`\n\n- `page_size?: number`\n\n- `page_token?: string`\n\n- `project_id?: string`\n\n- `unique_id?: string`\n\n### Returns\n\n- `{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; metadata?: object; updated_at?: string; }`\n API response schema for a directory file.\n\n - `id: string`\n - `directory_id: string`\n - `display_name: string`\n - `project_id: string`\n - `unique_id: string`\n - `created_at?: string`\n - `data_source_id?: string`\n - `deleted_at?: string`\n - `file_id?: string`\n - `metadata?: object`\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 fileListResponse of client.beta.directories.files.list('directory_id')) {\n console.log(fileListResponse);\n}\n```",
|
|
3063
2920
|
perLanguage: {
|
|
3064
2921
|
http: {
|
|
3065
2922
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/directories/$DIRECTORY_ID/files \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
@@ -3088,8 +2945,8 @@ const EMBEDDED_METHODS = [
|
|
|
3088
2945
|
'organization_id?: string;',
|
|
3089
2946
|
'project_id?: string;',
|
|
3090
2947
|
],
|
|
3091
|
-
response: '{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; updated_at?: string; }',
|
|
3092
|
-
markdown: "## get\n\n`client.beta.directories.files.get(directory_id: string, directory_file_id: string, organization_id?: string, project_id?: string): { id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; updated_at?: string; }`\n\n**get** `/api/v1/beta/directories/{directory_id}/files/{directory_file_id}`\n\nGet a file by its directory_file_id within the specified directory. If you're trying to get a file by its unique_id, use the list endpoint with a filter instead.\n\n### Parameters\n\n- `directory_id: string`\n\n- `directory_file_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; updated_at?: string; }`\n API response schema for a directory file.\n\n - `id: string`\n - `directory_id: string`\n - `display_name: string`\n - `project_id: string`\n - `unique_id: string`\n - `created_at?: string`\n - `data_source_id?: string`\n - `deleted_at?: string`\n - `file_id?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst file = await client.beta.directories.files.get('directory_file_id', { directory_id: 'directory_id' });\n\nconsole.log(file);\n```",
|
|
2948
|
+
response: '{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; metadata?: object; updated_at?: string; }',
|
|
2949
|
+
markdown: "## get\n\n`client.beta.directories.files.get(directory_id: string, directory_file_id: string, organization_id?: string, project_id?: string): { id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; metadata?: object; updated_at?: string; }`\n\n**get** `/api/v1/beta/directories/{directory_id}/files/{directory_file_id}`\n\nGet a file by its directory_file_id within the specified directory. If you're trying to get a file by its unique_id, use the list endpoint with a filter instead.\n\n### Parameters\n\n- `directory_id: string`\n\n- `directory_file_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; metadata?: object; updated_at?: string; }`\n API response schema for a directory file.\n\n - `id: string`\n - `directory_id: string`\n - `display_name: string`\n - `project_id: string`\n - `unique_id: string`\n - `created_at?: string`\n - `data_source_id?: string`\n - `deleted_at?: string`\n - `file_id?: string`\n - `metadata?: object`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst file = await client.beta.directories.files.get('directory_file_id', { directory_id: 'directory_id' });\n\nconsole.log(file);\n```",
|
|
3093
2950
|
perLanguage: {
|
|
3094
2951
|
http: {
|
|
3095
2952
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/directories/$DIRECTORY_ID/files/$DIRECTORY_FILE_ID \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
@@ -3119,10 +2976,11 @@ const EMBEDDED_METHODS = [
|
|
|
3119
2976
|
'project_id?: string;',
|
|
3120
2977
|
'directory_id?: string;',
|
|
3121
2978
|
'display_name?: string;',
|
|
2979
|
+
'metadata?: object;',
|
|
3122
2980
|
'unique_id?: string;',
|
|
3123
2981
|
],
|
|
3124
|
-
response: '{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; updated_at?: string; }',
|
|
3125
|
-
markdown: "## update\n\n`client.beta.directories.files.update(directory_id: string, directory_file_id: string, organization_id?: string, project_id?: string, directory_id?: string, display_name?: string, unique_id?: string): { id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; updated_at?: string; }`\n\n**patch** `/api/v1/beta/directories/{directory_id}/files/{directory_file_id}`\n\nUpdate file metadata within the specified directory.\n\nSupports moving files to a different directory by setting directory_id.\n\nNote: This endpoint uses directory_file_id (the internal ID). If you're trying to update a file by its unique_id, use the list endpoint with a filter to find the directory_file_id first.\n\n### Parameters\n\n- `directory_id: string`\n\n- `directory_file_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `directory_id?: string`\n Move file to a different directory.\n\n- `display_name?: string`\n Updated display name.\n\n- `unique_id?: string`\n Updated unique identifier.\n\n### Returns\n\n- `{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; updated_at?: string; }`\n API response schema for a directory file.\n\n - `id: string`\n - `directory_id: string`\n - `display_name: string`\n - `project_id: string`\n - `unique_id: string`\n - `created_at?: string`\n - `data_source_id?: string`\n - `deleted_at?: string`\n - `file_id?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst file = await client.beta.directories.files.update('directory_file_id', { path_directory_id: 'directory_id' });\n\nconsole.log(file);\n```",
|
|
2982
|
+
response: '{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; metadata?: object; updated_at?: string; }',
|
|
2983
|
+
markdown: "## update\n\n`client.beta.directories.files.update(directory_id: string, directory_file_id: string, organization_id?: string, project_id?: string, directory_id?: string, display_name?: string, metadata?: object, unique_id?: string): { id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; metadata?: object; updated_at?: string; }`\n\n**patch** `/api/v1/beta/directories/{directory_id}/files/{directory_file_id}`\n\nUpdate file metadata within the specified directory.\n\nSupports moving files to a different directory by setting directory_id.\n\nNote: This endpoint uses directory_file_id (the internal ID). If you're trying to update a file by its unique_id, use the list endpoint with a filter to find the directory_file_id first.\n\n### Parameters\n\n- `directory_id: string`\n\n- `directory_file_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `directory_id?: string`\n Move file to a different directory.\n\n- `display_name?: string`\n Updated display name.\n\n- `metadata?: object`\n User-defined metadata key-value pairs. Replaces the user metadata layer.\n\n- `unique_id?: string`\n Updated unique identifier.\n\n### Returns\n\n- `{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; metadata?: object; updated_at?: string; }`\n API response schema for a directory file.\n\n - `id: string`\n - `directory_id: string`\n - `display_name: string`\n - `project_id: string`\n - `unique_id: string`\n - `created_at?: string`\n - `data_source_id?: string`\n - `deleted_at?: string`\n - `file_id?: string`\n - `metadata?: object`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst file = await client.beta.directories.files.update('directory_file_id', { path_directory_id: 'directory_id' });\n\nconsole.log(file);\n```",
|
|
3126
2984
|
perLanguage: {
|
|
3127
2985
|
http: {
|
|
3128
2986
|
example: "curl https://api.cloud.llamaindex.ai/api/v1/beta/directories/$DIRECTORY_ID/files/$DIRECTORY_FILE_ID \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $LLAMA_CLOUD_API_KEY\" \\\n -d '{}'",
|
|
@@ -3183,8 +3041,8 @@ const EMBEDDED_METHODS = [
|
|
|
3183
3041
|
'external_file_id?: string;',
|
|
3184
3042
|
'unique_id?: string;',
|
|
3185
3043
|
],
|
|
3186
|
-
response: '{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; updated_at?: string; }',
|
|
3187
|
-
markdown: "## upload\n\n`client.beta.directories.files.upload(directory_id: string, upload_file: string, organization_id?: string, project_id?: string, display_name?: string, external_file_id?: string, unique_id?: string): { id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; updated_at?: string; }`\n\n**post** `/api/v1/beta/directories/{directory_id}/files/upload`\n\nUpload a file directly to a directory.\n\nUploads a file and creates a directory file entry in a single operation.\nIf unique_id or display_name are not provided, they will be derived from the file metadata.\n\n### Parameters\n\n- `directory_id: string`\n\n- `upload_file: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `display_name?: string`\n\n- `external_file_id?: string`\n\n- `unique_id?: string`\n\n### Returns\n\n- `{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; updated_at?: string; }`\n API response schema for a directory file.\n\n - `id: string`\n - `directory_id: string`\n - `display_name: string`\n - `project_id: string`\n - `unique_id: string`\n - `created_at?: string`\n - `data_source_id?: string`\n - `deleted_at?: string`\n - `file_id?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst response = await client.beta.directories.files.upload('directory_id', { upload_file: fs.createReadStream('path/to/file') });\n\nconsole.log(response);\n```",
|
|
3044
|
+
response: '{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; metadata?: object; updated_at?: string; }',
|
|
3045
|
+
markdown: "## upload\n\n`client.beta.directories.files.upload(directory_id: string, upload_file: string, organization_id?: string, project_id?: string, display_name?: string, external_file_id?: string, unique_id?: string): { id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; metadata?: object; updated_at?: string; }`\n\n**post** `/api/v1/beta/directories/{directory_id}/files/upload`\n\nUpload a file directly to a directory.\n\nUploads a file and creates a directory file entry in a single operation.\nIf unique_id or display_name are not provided, they will be derived from the file metadata.\n\n### Parameters\n\n- `directory_id: string`\n\n- `upload_file: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `display_name?: string`\n\n- `external_file_id?: string`\n\n- `unique_id?: string`\n\n### Returns\n\n- `{ id: string; directory_id: string; display_name: string; project_id: string; unique_id: string; created_at?: string; data_source_id?: string; deleted_at?: string; file_id?: string; metadata?: object; updated_at?: string; }`\n API response schema for a directory file.\n\n - `id: string`\n - `directory_id: string`\n - `display_name: string`\n - `project_id: string`\n - `unique_id: string`\n - `created_at?: string`\n - `data_source_id?: string`\n - `deleted_at?: string`\n - `file_id?: string`\n - `metadata?: object`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst response = await client.beta.directories.files.upload('directory_id', { upload_file: fs.createReadStream('path/to/file') });\n\nconsole.log(response);\n```",
|
|
3188
3046
|
perLanguage: {
|
|
3189
3047
|
http: {
|
|
3190
3048
|
example: "curl https://api.cloud.llamaindex.ai/api/v1/beta/directories/$DIRECTORY_ID/files/upload \\\n -H 'Content-Type: multipart/form-data' \\\n -H \"Authorization: Bearer $LLAMA_CLOUD_API_KEY\" \\\n -F 'upload_file=@/path/to/upload_file'",
|
|
@@ -3195,7 +3053,7 @@ const EMBEDDED_METHODS = [
|
|
|
3195
3053
|
},
|
|
3196
3054
|
typescript: {
|
|
3197
3055
|
method: 'client.beta.directories.files.upload',
|
|
3198
|
-
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.directories.files.upload('directory_id', {\n upload_file: fs.createReadStream('path/to/file'),\n});\n\nconsole.log(response.id);",
|
|
3056
|
+
example: "import fs from 'fs';\nimport 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.directories.files.upload('directory_id', {\n upload_file: fs.createReadStream('path/to/file'),\n});\n\nconsole.log(response.id);",
|
|
3199
3057
|
},
|
|
3200
3058
|
},
|
|
3201
3059
|
},
|
|
@@ -3389,7 +3247,7 @@ const EMBEDDED_METHODS = [
|
|
|
3389
3247
|
endpoint: '/api/v1/beta/split/jobs',
|
|
3390
3248
|
httpMethod: 'post',
|
|
3391
3249
|
summary: 'Create Split Job',
|
|
3392
|
-
description: 'Create a document split job
|
|
3250
|
+
description: 'Create a document split job.',
|
|
3393
3251
|
stainlessPath: '(resource) beta.split > (method) create',
|
|
3394
3252
|
qualified: 'client.beta.split.create',
|
|
3395
3253
|
params: [
|
|
@@ -3400,7 +3258,7 @@ const EMBEDDED_METHODS = [
|
|
|
3400
3258
|
'configuration_id?: string;',
|
|
3401
3259
|
],
|
|
3402
3260
|
response: '{ id: string; categories: { name: string; description?: string; }[]; document_input: { type: string; value: string; }; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; updated_at?: string; }',
|
|
3403
|
-
markdown: "## create\n\n`client.beta.split.create(document_input: { type: string; value: string; }, organization_id?: string, project_id?: string, configuration?: { categories: object[]; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; }, configuration_id?: string): { id: string; categories: split_category[]; document_input: split_document_input; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; updated_at?: string; }`\n\n**post** `/api/v1/beta/split/jobs`\n\nCreate a document split job.\
|
|
3261
|
+
markdown: "## create\n\n`client.beta.split.create(document_input: { type: string; value: string; }, organization_id?: string, project_id?: string, configuration?: { categories: object[]; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; }, configuration_id?: string): { id: string; categories: split_category[]; document_input: split_document_input; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; updated_at?: string; }`\n\n**post** `/api/v1/beta/split/jobs`\n\nCreate a document split job.\n\n### Parameters\n\n- `document_input: { type: string; value: string; }`\n Document to be split.\n - `type: string`\n Type of document input. Valid values are: file_id\n - `value: string`\n Document identifier.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `configuration?: { categories: { name: string; description?: string; }[]; splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }; }`\n Split configuration with categories and splitting strategy.\n - `categories: { name: string; description?: string; }[]`\n Categories to split documents into.\n - `splitting_strategy?: { allow_uncategorized?: 'include' | 'forbid' | 'omit'; }`\n Strategy for splitting documents.\n\n- `configuration_id?: string`\n Saved split configuration ID.\n\n### Returns\n\n- `{ id: string; categories: { name: string; description?: string; }[]; document_input: { type: string; value: string; }; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; updated_at?: string; }`\n Beta response — uses nested document_input object.\n\n - `id: string`\n - `categories: { name: string; description?: string; }[]`\n - `document_input: { type: string; value: string; }`\n - `project_id: string`\n - `status: string`\n - `user_id: string`\n - `configuration_id?: string`\n - `created_at?: string`\n - `error_message?: string`\n - `result?: { segments: { category: string; confidence_category: string; pages: number[]; }[]; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst split = await client.beta.split.create({ document_input: { type: 'type', value: 'value' } });\n\nconsole.log(split);\n```",
|
|
3404
3262
|
perLanguage: {
|
|
3405
3263
|
http: {
|
|
3406
3264
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/split/jobs \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \\\n -d \'{\n "document_input": {\n "type": "type",\n "value": "value"\n }\n }\'',
|
|
@@ -3420,7 +3278,7 @@ const EMBEDDED_METHODS = [
|
|
|
3420
3278
|
endpoint: '/api/v1/beta/split/jobs',
|
|
3421
3279
|
httpMethod: 'get',
|
|
3422
3280
|
summary: 'List Split Jobs',
|
|
3423
|
-
description: 'List document split jobs
|
|
3281
|
+
description: 'List document split jobs.',
|
|
3424
3282
|
stainlessPath: '(resource) beta.split > (method) list',
|
|
3425
3283
|
qualified: 'client.beta.split.list',
|
|
3426
3284
|
params: [
|
|
@@ -3434,7 +3292,7 @@ const EMBEDDED_METHODS = [
|
|
|
3434
3292
|
"status?: 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled';",
|
|
3435
3293
|
],
|
|
3436
3294
|
response: '{ id: string; categories: { name: string; description?: string; }[]; document_input: { type: string; value: string; }; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; updated_at?: string; }',
|
|
3437
|
-
markdown: "## list\n\n`client.beta.split.list(created_at_on_or_after?: string, created_at_on_or_before?: string, job_ids?: string[], organization_id?: string, page_size?: number, page_token?: string, project_id?: string, status?: 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled'): { id: string; categories: split_category[]; document_input: split_document_input; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; updated_at?: string; }`\n\n**get** `/api/v1/beta/split/jobs`\n\nList document split jobs.\
|
|
3295
|
+
markdown: "## list\n\n`client.beta.split.list(created_at_on_or_after?: string, created_at_on_or_before?: string, job_ids?: string[], organization_id?: string, page_size?: number, page_token?: string, project_id?: string, status?: 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled'): { id: string; categories: split_category[]; document_input: split_document_input; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; updated_at?: string; }`\n\n**get** `/api/v1/beta/split/jobs`\n\nList document split jobs.\n\n### Parameters\n\n- `created_at_on_or_after?: string`\n Include items created at or after this timestamp (inclusive)\n\n- `created_at_on_or_before?: string`\n Include items created at or before this timestamp (inclusive)\n\n- `job_ids?: string[]`\n Filter by specific job IDs\n\n- `organization_id?: string`\n\n- `page_size?: number`\n\n- `page_token?: string`\n\n- `project_id?: string`\n\n- `status?: 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled'`\n Filter by job status (pending, processing, completed, failed, cancelled)\n\n### Returns\n\n- `{ id: string; categories: { name: string; description?: string; }[]; document_input: { type: string; value: string; }; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; updated_at?: string; }`\n Beta response — uses nested document_input object.\n\n - `id: string`\n - `categories: { name: string; description?: string; }[]`\n - `document_input: { type: string; value: string; }`\n - `project_id: string`\n - `status: string`\n - `user_id: string`\n - `configuration_id?: string`\n - `created_at?: string`\n - `error_message?: string`\n - `result?: { segments: { category: string; confidence_category: string; pages: number[]; }[]; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\n// Automatically fetches more pages as needed.\nfor await (const splitListResponse of client.beta.split.list()) {\n console.log(splitListResponse);\n}\n```",
|
|
3438
3296
|
perLanguage: {
|
|
3439
3297
|
http: {
|
|
3440
3298
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/split/jobs \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
@@ -3454,12 +3312,12 @@ const EMBEDDED_METHODS = [
|
|
|
3454
3312
|
endpoint: '/api/v1/beta/split/jobs/{split_job_id}',
|
|
3455
3313
|
httpMethod: 'get',
|
|
3456
3314
|
summary: 'Get Split Job',
|
|
3457
|
-
description: 'Get a document split job
|
|
3315
|
+
description: 'Get a document split job.',
|
|
3458
3316
|
stainlessPath: '(resource) beta.split > (method) get',
|
|
3459
3317
|
qualified: 'client.beta.split.get',
|
|
3460
3318
|
params: ['split_job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
3461
3319
|
response: '{ id: string; categories: { name: string; description?: string; }[]; document_input: { type: string; value: string; }; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; updated_at?: string; }',
|
|
3462
|
-
markdown: "## get\n\n`client.beta.split.get(split_job_id: string, organization_id?: string, project_id?: string): { id: string; categories: split_category[]; document_input: split_document_input; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; updated_at?: string; }`\n\n**get** `/api/v1/beta/split/jobs/{split_job_id}`\n\nGet a document split job.\n\
|
|
3320
|
+
markdown: "## get\n\n`client.beta.split.get(split_job_id: string, organization_id?: string, project_id?: string): { id: string; categories: split_category[]; document_input: split_document_input; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: split_result_response; updated_at?: string; }`\n\n**get** `/api/v1/beta/split/jobs/{split_job_id}`\n\nGet a document split job.\n\n### Parameters\n\n- `split_job_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; categories: { name: string; description?: string; }[]; document_input: { type: string; value: string; }; project_id: string; status: string; user_id: string; configuration_id?: string; created_at?: string; error_message?: string; result?: { segments: split_segment_response[]; }; updated_at?: string; }`\n Beta response — uses nested document_input object.\n\n - `id: string`\n - `categories: { name: string; description?: string; }[]`\n - `document_input: { type: string; value: string; }`\n - `project_id: string`\n - `status: string`\n - `user_id: string`\n - `configuration_id?: string`\n - `created_at?: string`\n - `error_message?: string`\n - `result?: { segments: { category: string; confidence_category: string; pages: number[]; }[]; }`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst split = await client.beta.split.get('split_job_id');\n\nconsole.log(split);\n```",
|
|
3463
3321
|
perLanguage: {
|
|
3464
3322
|
http: {
|
|
3465
3323
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/split/jobs/$SPLIT_JOB_ID \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|