@llamaindex/llama-cloud-mcp 2.3.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 -1
- package/code-tool-worker.js.map +1 -1
- package/code-tool-worker.mjs +2 -1
- 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/local-docs-search.d.mts.map +1 -1
- package/local-docs-search.d.ts.map +1 -1
- package/local-docs-search.js +51 -47
- package/local-docs-search.js.map +1 -1
- package/local-docs-search.mjs +51 -47
- package/local-docs-search.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 -1
- package/src/docs-search-tool.ts +1 -1
- package/src/local-docs-search.ts +51 -50
- 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.mjs
CHANGED
|
@@ -31,7 +31,7 @@ const EMBEDDED_METHODS = [
|
|
|
31
31
|
},
|
|
32
32
|
typescript: {
|
|
33
33
|
method: 'client.files.create',
|
|
34
|
-
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);",
|
|
34
|
+
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);",
|
|
35
35
|
},
|
|
36
36
|
},
|
|
37
37
|
},
|
|
@@ -276,12 +276,12 @@ const EMBEDDED_METHODS = [
|
|
|
276
276
|
'file_input: string;',
|
|
277
277
|
'organization_id?: string;',
|
|
278
278
|
'project_id?: string;',
|
|
279
|
-
"configuration?: { data_schema: object; cite_sources?: boolean; confidence_scores?: boolean; extract_version?: string; extraction_target?: 'per_doc' | 'per_page' | 'per_table_row';
|
|
279
|
+
"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'; };",
|
|
280
280
|
'configuration_id?: string;',
|
|
281
281
|
'webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: string; webhook_url?: string; }[];',
|
|
282
282
|
],
|
|
283
|
-
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';
|
|
284
|
-
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';
|
|
283
|
+
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; }; }",
|
|
284
|
+
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```",
|
|
285
285
|
perLanguage: {
|
|
286
286
|
http: {
|
|
287
287
|
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 }\'',
|
|
@@ -319,8 +319,8 @@ const EMBEDDED_METHODS = [
|
|
|
319
319
|
'project_id?: string;',
|
|
320
320
|
"status?: 'PENDING' | 'THROTTLED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED';",
|
|
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: "## 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';
|
|
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: "## 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```",
|
|
324
324
|
perLanguage: {
|
|
325
325
|
http: {
|
|
326
326
|
example: 'curl https://api.cloud.llamaindex.ai/api/v2/extract \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
@@ -344,8 +344,8 @@ const EMBEDDED_METHODS = [
|
|
|
344
344
|
stainlessPath: '(resource) extract > (method) get',
|
|
345
345
|
qualified: 'client.extract.get',
|
|
346
346
|
params: ['job_id: string;', 'expand?: string[];', 'organization_id?: string;', 'project_id?: string;'],
|
|
347
|
-
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';
|
|
348
|
-
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';
|
|
347
|
+
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; }; }",
|
|
348
|
+
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```",
|
|
349
349
|
perLanguage: {
|
|
350
350
|
http: {
|
|
351
351
|
example: 'curl https://api.cloud.llamaindex.ai/api/v2/extract/$JOB_ID \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
@@ -395,18 +395,18 @@ const EMBEDDED_METHODS = [
|
|
|
395
395
|
qualified: 'client.extract.validateSchema',
|
|
396
396
|
params: ['data_schema: object;'],
|
|
397
397
|
response: '{ data_schema: object; }',
|
|
398
|
-
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: {
|
|
398
|
+
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```",
|
|
399
399
|
perLanguage: {
|
|
400
400
|
http: {
|
|
401
|
-
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 "
|
|
401
|
+
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 }\'',
|
|
402
402
|
},
|
|
403
403
|
python: {
|
|
404
404
|
method: 'extract.validate_schema',
|
|
405
|
-
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 "
|
|
405
|
+
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)',
|
|
406
406
|
},
|
|
407
407
|
typescript: {
|
|
408
408
|
method: 'client.extract.validateSchema',
|
|
409
|
-
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: {
|
|
409
|
+
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);",
|
|
410
410
|
},
|
|
411
411
|
},
|
|
412
412
|
},
|
|
@@ -426,8 +426,8 @@ const EMBEDDED_METHODS = [
|
|
|
426
426
|
'name?: string;',
|
|
427
427
|
'prompt?: string;',
|
|
428
428
|
],
|
|
429
|
-
response: "{ name: string; parameters:
|
|
430
|
-
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';
|
|
429
|
+
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; }",
|
|
430
|
+
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```",
|
|
431
431
|
perLanguage: {
|
|
432
432
|
http: {
|
|
433
433
|
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 '{}'",
|
|
@@ -659,12 +659,12 @@ const EMBEDDED_METHODS = [
|
|
|
659
659
|
qualified: 'client.configurations.create',
|
|
660
660
|
params: [
|
|
661
661
|
'name: string;',
|
|
662
|
-
"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';
|
|
662
|
+
"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'; };",
|
|
663
663
|
'organization_id?: string;',
|
|
664
664
|
'project_id?: string;',
|
|
665
665
|
],
|
|
666
|
-
response: "{ id: string; name: string; parameters:
|
|
667
|
-
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```",
|
|
666
|
+
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; }",
|
|
667
|
+
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```",
|
|
668
668
|
perLanguage: {
|
|
669
669
|
http: {
|
|
670
670
|
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 }\'',
|
|
@@ -693,11 +693,11 @@ const EMBEDDED_METHODS = [
|
|
|
693
693
|
'organization_id?: string;',
|
|
694
694
|
'page_size?: number;',
|
|
695
695
|
'page_token?: string;',
|
|
696
|
-
"product_type?: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | 'unknown'[];",
|
|
696
|
+
"product_type?: 'split_v1' | 'extract_v2' | 'classify_v2' | 'parse_v2' | 'spreadsheet_v1' | 'unknown'[];",
|
|
697
697
|
'project_id?: string;',
|
|
698
698
|
],
|
|
699
|
-
response: "{ id: string; name: string; parameters:
|
|
700
|
-
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';
|
|
699
|
+
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; }",
|
|
700
|
+
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```",
|
|
701
701
|
perLanguage: {
|
|
702
702
|
http: {
|
|
703
703
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/configurations \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
@@ -721,8 +721,8 @@ const EMBEDDED_METHODS = [
|
|
|
721
721
|
stainlessPath: '(resource) configurations > (method) retrieve',
|
|
722
722
|
qualified: 'client.configurations.retrieve',
|
|
723
723
|
params: ['config_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
724
|
-
response: "{ id: string; name: string; parameters:
|
|
725
|
-
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';
|
|
724
|
+
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; }",
|
|
725
|
+
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```",
|
|
726
726
|
perLanguage: {
|
|
727
727
|
http: {
|
|
728
728
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/configurations/$CONFIG_ID \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
@@ -750,10 +750,10 @@ const EMBEDDED_METHODS = [
|
|
|
750
750
|
'organization_id?: string;',
|
|
751
751
|
'project_id?: string;',
|
|
752
752
|
'name?: string;',
|
|
753
|
-
"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';
|
|
753
|
+
"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'; };",
|
|
754
754
|
],
|
|
755
|
-
response: "{ id: string; name: string; parameters:
|
|
756
|
-
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```",
|
|
755
|
+
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; }",
|
|
756
|
+
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```",
|
|
757
757
|
perLanguage: {
|
|
758
758
|
http: {
|
|
759
759
|
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 '{}'",
|
|
@@ -1844,7 +1844,7 @@ const EMBEDDED_METHODS = [
|
|
|
1844
1844
|
},
|
|
1845
1845
|
typescript: {
|
|
1846
1846
|
method: 'client.pipelines.metadata.create',
|
|
1847
|
-
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);",
|
|
1847
|
+
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);",
|
|
1848
1848
|
},
|
|
1849
1849
|
},
|
|
1850
1850
|
},
|
|
@@ -2206,10 +2206,12 @@ const EMBEDDED_METHODS = [
|
|
|
2206
2206
|
params: [
|
|
2207
2207
|
'retriever_id: string;',
|
|
2208
2208
|
'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; }; }[];',
|
|
2209
|
+
'organization_id?: string;',
|
|
2210
|
+
'project_id?: string;',
|
|
2209
2211
|
'name?: string;',
|
|
2210
2212
|
],
|
|
2211
2213
|
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; }',
|
|
2212
|
-
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```",
|
|
2214
|
+
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```",
|
|
2213
2215
|
perLanguage: {
|
|
2214
2216
|
http: {
|
|
2215
2217
|
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 }\'',
|
|
@@ -2232,15 +2234,15 @@ const EMBEDDED_METHODS = [
|
|
|
2232
2234
|
description: 'Delete a Retriever by ID.',
|
|
2233
2235
|
stainlessPath: '(resource) retrievers > (method) delete',
|
|
2234
2236
|
qualified: 'client.retrievers.delete',
|
|
2235
|
-
params: ['retriever_id: string;'],
|
|
2236
|
-
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```",
|
|
2237
|
+
params: ['retriever_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
2238
|
+
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```",
|
|
2237
2239
|
perLanguage: {
|
|
2238
2240
|
http: {
|
|
2239
2241
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/retrievers/$RETRIEVER_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
2240
2242
|
},
|
|
2241
2243
|
python: {
|
|
2242
2244
|
method: 'retrievers.delete',
|
|
2243
|
-
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)',
|
|
2245
|
+
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)',
|
|
2244
2246
|
},
|
|
2245
2247
|
typescript: {
|
|
2246
2248
|
method: 'client.retrievers.delete',
|
|
@@ -2835,10 +2837,11 @@ const EMBEDDED_METHODS = [
|
|
|
2835
2837
|
'organization_id?: string;',
|
|
2836
2838
|
'project_id?: string;',
|
|
2837
2839
|
'display_name?: string;',
|
|
2840
|
+
'metadata?: object;',
|
|
2838
2841
|
'unique_id?: string;',
|
|
2839
2842
|
],
|
|
2840
|
-
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; }',
|
|
2841
|
-
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```",
|
|
2843
|
+
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; }',
|
|
2844
|
+
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```",
|
|
2842
2845
|
perLanguage: {
|
|
2843
2846
|
http: {
|
|
2844
2847
|
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 }\'',
|
|
@@ -2873,8 +2876,8 @@ const EMBEDDED_METHODS = [
|
|
|
2873
2876
|
'project_id?: string;',
|
|
2874
2877
|
'unique_id?: string;',
|
|
2875
2878
|
],
|
|
2876
|
-
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; }',
|
|
2877
|
-
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```",
|
|
2879
|
+
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; }',
|
|
2880
|
+
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```",
|
|
2878
2881
|
perLanguage: {
|
|
2879
2882
|
http: {
|
|
2880
2883
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/directories/$DIRECTORY_ID/files \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
@@ -2903,8 +2906,8 @@ const EMBEDDED_METHODS = [
|
|
|
2903
2906
|
'organization_id?: string;',
|
|
2904
2907
|
'project_id?: string;',
|
|
2905
2908
|
],
|
|
2906
|
-
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; }',
|
|
2907
|
-
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```",
|
|
2909
|
+
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; }',
|
|
2910
|
+
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```",
|
|
2908
2911
|
perLanguage: {
|
|
2909
2912
|
http: {
|
|
2910
2913
|
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"',
|
|
@@ -2934,10 +2937,11 @@ const EMBEDDED_METHODS = [
|
|
|
2934
2937
|
'project_id?: string;',
|
|
2935
2938
|
'directory_id?: string;',
|
|
2936
2939
|
'display_name?: string;',
|
|
2940
|
+
'metadata?: object;',
|
|
2937
2941
|
'unique_id?: string;',
|
|
2938
2942
|
],
|
|
2939
|
-
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; }',
|
|
2940
|
-
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```",
|
|
2943
|
+
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; }',
|
|
2944
|
+
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```",
|
|
2941
2945
|
perLanguage: {
|
|
2942
2946
|
http: {
|
|
2943
2947
|
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 '{}'",
|
|
@@ -2998,8 +3002,8 @@ const EMBEDDED_METHODS = [
|
|
|
2998
3002
|
'external_file_id?: string;',
|
|
2999
3003
|
'unique_id?: string;',
|
|
3000
3004
|
],
|
|
3001
|
-
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; }',
|
|
3002
|
-
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```",
|
|
3005
|
+
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; }',
|
|
3006
|
+
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```",
|
|
3003
3007
|
perLanguage: {
|
|
3004
3008
|
http: {
|
|
3005
3009
|
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'",
|
|
@@ -3010,7 +3014,7 @@ const EMBEDDED_METHODS = [
|
|
|
3010
3014
|
},
|
|
3011
3015
|
typescript: {
|
|
3012
3016
|
method: 'client.beta.directories.files.upload',
|
|
3013
|
-
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);",
|
|
3017
|
+
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);",
|
|
3014
3018
|
},
|
|
3015
3019
|
},
|
|
3016
3020
|
},
|
|
@@ -3204,7 +3208,7 @@ const EMBEDDED_METHODS = [
|
|
|
3204
3208
|
endpoint: '/api/v1/beta/split/jobs',
|
|
3205
3209
|
httpMethod: 'post',
|
|
3206
3210
|
summary: 'Create Split Job',
|
|
3207
|
-
description: 'Create a document split job
|
|
3211
|
+
description: 'Create a document split job.',
|
|
3208
3212
|
stainlessPath: '(resource) beta.split > (method) create',
|
|
3209
3213
|
qualified: 'client.beta.split.create',
|
|
3210
3214
|
params: [
|
|
@@ -3215,7 +3219,7 @@ const EMBEDDED_METHODS = [
|
|
|
3215
3219
|
'configuration_id?: string;',
|
|
3216
3220
|
],
|
|
3217
3221
|
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; }',
|
|
3218
|
-
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.\
|
|
3222
|
+
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```",
|
|
3219
3223
|
perLanguage: {
|
|
3220
3224
|
http: {
|
|
3221
3225
|
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 }\'',
|
|
@@ -3235,7 +3239,7 @@ const EMBEDDED_METHODS = [
|
|
|
3235
3239
|
endpoint: '/api/v1/beta/split/jobs',
|
|
3236
3240
|
httpMethod: 'get',
|
|
3237
3241
|
summary: 'List Split Jobs',
|
|
3238
|
-
description: 'List document split jobs
|
|
3242
|
+
description: 'List document split jobs.',
|
|
3239
3243
|
stainlessPath: '(resource) beta.split > (method) list',
|
|
3240
3244
|
qualified: 'client.beta.split.list',
|
|
3241
3245
|
params: [
|
|
@@ -3249,7 +3253,7 @@ const EMBEDDED_METHODS = [
|
|
|
3249
3253
|
"status?: 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled';",
|
|
3250
3254
|
],
|
|
3251
3255
|
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; }',
|
|
3252
|
-
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.\
|
|
3256
|
+
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```",
|
|
3253
3257
|
perLanguage: {
|
|
3254
3258
|
http: {
|
|
3255
3259
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/split/jobs \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|
|
@@ -3269,12 +3273,12 @@ const EMBEDDED_METHODS = [
|
|
|
3269
3273
|
endpoint: '/api/v1/beta/split/jobs/{split_job_id}',
|
|
3270
3274
|
httpMethod: 'get',
|
|
3271
3275
|
summary: 'Get Split Job',
|
|
3272
|
-
description: 'Get a document split job
|
|
3276
|
+
description: 'Get a document split job.',
|
|
3273
3277
|
stainlessPath: '(resource) beta.split > (method) get',
|
|
3274
3278
|
qualified: 'client.beta.split.get',
|
|
3275
3279
|
params: ['split_job_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
3276
3280
|
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; }',
|
|
3277
|
-
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\
|
|
3281
|
+
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```",
|
|
3278
3282
|
perLanguage: {
|
|
3279
3283
|
http: {
|
|
3280
3284
|
example: 'curl https://api.cloud.llamaindex.ai/api/v1/beta/split/jobs/$SPLIT_JOB_ID \\\n -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"',
|