@llamaindex/llama-cloud-mcp 2.10.0 → 2.11.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/local-docs-search.d.mts.map +1 -1
- package/local-docs-search.d.ts.map +1 -1
- package/local-docs-search.js +161 -161
- package/local-docs-search.js.map +1 -1
- package/local-docs-search.mjs +161 -161
- package/local-docs-search.mjs.map +1 -1
- package/package.json +2 -2
- package/server.js +1 -1
- package/server.js.map +1 -1
- package/server.mjs +1 -1
- package/server.mjs.map +1 -1
- package/src/local-docs-search.ts +161 -176
- package/src/server.ts +1 -1
package/local-docs-search.mjs
CHANGED
|
@@ -43,7 +43,7 @@ const EMBEDDED_METHODS = [
|
|
|
43
43
|
},
|
|
44
44
|
cli: {
|
|
45
45
|
method: 'files create',
|
|
46
|
-
example: "
|
|
46
|
+
example: "llp files create \\\n --api-key 'My API Key' \\\n --file 'Example data' \\\n --purpose purpose",
|
|
47
47
|
},
|
|
48
48
|
},
|
|
49
49
|
},
|
|
@@ -87,7 +87,7 @@ const EMBEDDED_METHODS = [
|
|
|
87
87
|
},
|
|
88
88
|
cli: {
|
|
89
89
|
method: 'files query',
|
|
90
|
-
example: "
|
|
90
|
+
example: "llp files query \\\n --api-key 'My API Key'",
|
|
91
91
|
},
|
|
92
92
|
},
|
|
93
93
|
},
|
|
@@ -134,7 +134,7 @@ const EMBEDDED_METHODS = [
|
|
|
134
134
|
},
|
|
135
135
|
cli: {
|
|
136
136
|
method: 'files list',
|
|
137
|
-
example: "
|
|
137
|
+
example: "llp files list \\\n --api-key 'My API Key'",
|
|
138
138
|
},
|
|
139
139
|
},
|
|
140
140
|
},
|
|
@@ -170,7 +170,7 @@ const EMBEDDED_METHODS = [
|
|
|
170
170
|
},
|
|
171
171
|
cli: {
|
|
172
172
|
method: 'files delete',
|
|
173
|
-
example: "
|
|
173
|
+
example: "llp files delete \\\n --api-key 'My API Key' \\\n --file-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
174
174
|
},
|
|
175
175
|
},
|
|
176
176
|
},
|
|
@@ -212,7 +212,7 @@ const EMBEDDED_METHODS = [
|
|
|
212
212
|
},
|
|
213
213
|
cli: {
|
|
214
214
|
method: 'files get',
|
|
215
|
-
example: "
|
|
215
|
+
example: "llp files get \\\n --api-key 'My API Key' \\\n --file-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
216
216
|
},
|
|
217
217
|
},
|
|
218
218
|
},
|
|
@@ -257,7 +257,7 @@ const EMBEDDED_METHODS = [
|
|
|
257
257
|
},
|
|
258
258
|
cli: {
|
|
259
259
|
method: 'sheets create',
|
|
260
|
-
example: "
|
|
260
|
+
example: "llp sheets create \\\n --api-key 'My API Key' \\\n --file-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
261
261
|
},
|
|
262
262
|
},
|
|
263
263
|
},
|
|
@@ -305,7 +305,7 @@ const EMBEDDED_METHODS = [
|
|
|
305
305
|
},
|
|
306
306
|
cli: {
|
|
307
307
|
method: 'sheets list',
|
|
308
|
-
example: "
|
|
308
|
+
example: "llp sheets list \\\n --api-key 'My API Key'",
|
|
309
309
|
},
|
|
310
310
|
},
|
|
311
311
|
},
|
|
@@ -348,7 +348,7 @@ const EMBEDDED_METHODS = [
|
|
|
348
348
|
},
|
|
349
349
|
cli: {
|
|
350
350
|
method: 'sheets get',
|
|
351
|
-
example: "
|
|
351
|
+
example: "llp sheets get \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id",
|
|
352
352
|
},
|
|
353
353
|
},
|
|
354
354
|
},
|
|
@@ -392,7 +392,7 @@ const EMBEDDED_METHODS = [
|
|
|
392
392
|
},
|
|
393
393
|
cli: {
|
|
394
394
|
method: 'sheets get_result_table',
|
|
395
|
-
example: "
|
|
395
|
+
example: "llp sheets get-result-table \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id \\\n --region-id region_id \\\n --region-type cell_metadata",
|
|
396
396
|
},
|
|
397
397
|
},
|
|
398
398
|
},
|
|
@@ -429,7 +429,7 @@ const EMBEDDED_METHODS = [
|
|
|
429
429
|
},
|
|
430
430
|
cli: {
|
|
431
431
|
method: 'sheets delete_job',
|
|
432
|
-
example: "
|
|
432
|
+
example: "llp sheets delete-job \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id",
|
|
433
433
|
},
|
|
434
434
|
},
|
|
435
435
|
},
|
|
@@ -443,7 +443,7 @@ const EMBEDDED_METHODS = [
|
|
|
443
443
|
qualified: 'client.parsing.create',
|
|
444
444
|
params: [
|
|
445
445
|
"tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus' | string;",
|
|
446
|
-
"version: 'latest' | '2026-06-26' | '2026-06-18' | '
|
|
446
|
+
"version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string;",
|
|
447
447
|
'organization_id?: string;',
|
|
448
448
|
'project_id?: string;',
|
|
449
449
|
'agentic_options?: { custom_prompt?: string; };',
|
|
@@ -458,14 +458,14 @@ const EMBEDDED_METHODS = [
|
|
|
458
458
|
"output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: { compact_markdown_tables?: boolean; markdown_table_multiline_separator?: string; merge_continued_tables?: boolean; output_tables_as_markdown?: boolean; }; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; };",
|
|
459
459
|
'page_ranges?: { max_pages?: number; target_pages?: string; };',
|
|
460
460
|
'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; }; };',
|
|
461
|
-
"processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; custom_prompt?: string; extract_layout?: boolean; high_res_ocr?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; }; language?: string; outlined_table_extraction?: boolean; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version?: 'latest' | '2026-06-26' | '2026-06-18' | '
|
|
461
|
+
"processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; custom_prompt?: string; extract_layout?: boolean; high_res_ocr?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; }; language?: string; outlined_table_extraction?: boolean; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version?: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; }; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: string[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; };",
|
|
462
462
|
'source_url?: string;',
|
|
463
463
|
'user_metadata?: object;',
|
|
464
464
|
'webhook_configuration_ids?: string[];',
|
|
465
465
|
"webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[];",
|
|
466
466
|
],
|
|
467
467
|
response: "{ id: string; project_id: string; status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'; created_at?: string; error_message?: string; name?: string; tier?: string; updated_at?: string; user_metadata?: object; }",
|
|
468
|
-
markdown: "## create\n\n`client.parsing.create(tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus' | string, version: 'latest' | '2026-06-26' | '2026-06-18' | '2025-12-11' | string, organization_id?: string, project_id?: string, agentic_options?: { custom_prompt?: string; }, client_name?: string, configuration_id?: string, crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }, disable_cache?: boolean, fast_options?: object, file_id?: string, http_proxy?: string, input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }, output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; 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' | 'agentic_plus' | 'efficient'; }, source_url?: string, user_metadata?: object, webhook_configuration_ids?: string[], webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]): { id: string; project_id: string; status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'; created_at?: string; error_message?: string; name?: string; tier?: string; updated_at?: string; user_metadata?: object; }`\n\n**post** `/api/v2/parse`\n\nParse a file by file ID or URL.\n\nProvide either `file_id` (a previously uploaded file) or\n`source_url` (a publicly accessible URL). Configure parsing\nwith options like `tier`, `target_pages`, and `lang`.\n\n## Tiers\n\n- `fast` — rule-based, cheapest, no AI\n- `cost_effective` — balanced speed and quality\n- `agentic` — full AI-powered parsing\n- `agentic_plus` — premium AI with specialized features\n\nThe job runs asynchronously. Poll `GET /parse/{job_id}` with\n`expand=text` or `expand=markdown` to retrieve results.\n\n### Parameters\n\n- `tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus' | string`\n Parsing tier: 'fast' (rule-based, cheapest), 'cost_effective' (balanced), 'agentic' (AI-powered with custom prompts), or 'agentic_plus' (premium AI with highest accuracy)\n\n- `version: 'latest' | '2026-06-26' | '2026-06-18' | '2025-12-11' | string`\n Version for the selected tier. Use `latest`, or pin one of that tier's dated versions.\n\nCurrent `latest` by tier:\n- `fast`: `2025-12-11`\n- `cost_effective`: `2026-06-26`\n- `agentic`: `2026-06-18`\n- `agentic_plus`: `2026-06-18`\n\nFull list: `GET /api/v2/parse/versions`.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `agentic_options?: { custom_prompt?: string; }`\n Options for AI-powered parsing tiers (cost_effective, agentic, agentic_plus).\n\nThese options customize how the AI processes and interprets document content.\nOnly applicable when using non-fast tiers.\n - `custom_prompt?: string`\n Custom instructions for the AI parser. Use to guide extraction behavior, specify output formatting, or provide domain-specific context. Example: 'Extract financial tables with currency symbols. Format dates as YYYY-MM-DD.'\n\n- `client_name?: string`\n Identifier for the client/application making the request. Used for analytics and debugging. Example: 'my-app-v2'\n\n- `configuration_id?: string`\n ID of a saved parse configuration. When set, `tier` and `version` default to the saved configuration's values — omit them or pass `'configured'`.\n\n- `crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }`\n Crop boundaries to process only a portion of each page. Values are ratios 0-1 from page edges\n - `bottom?: number`\n Bottom boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content below this line is excluded\n - `left?: number`\n Left boundary as ratio (0-1). 0=left edge, 1=right edge. Content left of this line is excluded\n - `right?: number`\n Right boundary as ratio (0-1). 0=left edge, 1=right edge. Content right of this line is excluded\n - `top?: number`\n Top boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content above this line is excluded\n\n- `disable_cache?: boolean`\n Bypass result caching and force re-parsing. Use when document content may have changed or you need fresh results\n\n- `fast_options?: object`\n Options for fast tier parsing (rule-based, no AI).\n\nFast tier uses deterministic algorithms for text extraction without AI enhancement.\nIt's the fastest and most cost-effective option, best suited for simple documents\nwith standard layouts. Currently has no configurable options but reserved for\nfuture expansion.\n\n- `file_id?: string`\n ID of an existing file in the project to parse. Mutually exclusive with source_url\n\n- `http_proxy?: string`\n HTTP/HTTPS proxy for fetching source_url. Ignored if using file_id\n\n- `input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }`\n Format-specific options (HTML, PDF, spreadsheet, presentation). Applied based on detected input file type\n - `html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }`\n HTML/web page parsing options (applies to .html, .htm files)\n - `image?: { camera_photo_correction?: boolean; }`\n Image parsing options (applies to .jpg, .jpeg, .png, .webp files)\n - `pdf?: object`\n PDF-specific parsing options (applies to .pdf files)\n - `presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }`\n Presentation parsing options (applies to .pptx, .ppt, .odp, .key files)\n - `spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }`\n Spreadsheet parsing options (applies to .xlsx, .xls, .csv, .ods files)\n\n- `output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: { compact_markdown_tables?: boolean; markdown_table_multiline_separator?: string; merge_continued_tables?: boolean; output_tables_as_markdown?: boolean; }; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }`\n Output formatting options for markdown, text, and extracted images\n - `additional_outputs?: string[]`\n Optional additional output artifacts to save alongside the primary parse output. Each value opts in to generating and persisting one extra file; the empty list (default) saves none. The three accepted values are: 'stripped_md' — per-page markdown stripped of formatting (links, bold/italic, images, HTML), saved as JSON for full-text-search indexing; fetch via `expand=stripped_markdown_content_metadata`. 'concatenated_stripped_txt' — all stripped pages concatenated into a single plain-text file with `\\n\\n---\\n\\n` between pages, useful for feeding the document into search or embedding pipelines as one blob; fetch via `expand=concatenated_stripped_markdown_content_metadata`. 'word_bbox' — raw word-level bounding boxes (one JSON object per word, with page number and x/y/w/h coordinates) saved as JSONL, useful for highlighting or grounding extracted answers back to the source document; fetch via `expand=raw_words_content_metadata`.\n - `extract_printed_page_number?: boolean`\n Extract the printed page number as it appears in the document (e.g., 'Page 5 of 10', 'v', 'A-3'). Useful for referencing original page numbers\n - `granular_bboxes?: 'cell' | 'line' | 'word'[]`\n Bounding-box granularity levels to compute for the parse. 'word' computes one bounding box per detected word; 'line' computes one per text line; 'cell' computes one per table cell. Multiple levels can be requested. Empty list (default) disables granular bboxes — only item-level layout boxes are returned on the result. When set, the computed boxes are not inlined on the result items; they are written to a separate `grounded_items` sidecar (JSONL, one row per page) and exposed as `result_content_metadata.grounded_items` (a presigned download URL) on the parse result. Each row matches the `GroundedJsonItem` shape.\n - `images_to_save?: 'embedded' | 'layout' | 'screenshot'[]`\n Image categories to extract and save. Options: 'screenshot' (full page renders useful for visual QA), 'embedded' (images found within the document), 'layout' (cropped regions from layout detection like figures and diagrams). Empty list saves no images\n - `markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: { compact_markdown_tables?: boolean; markdown_table_multiline_separator?: string; merge_continued_tables?: boolean; output_tables_as_markdown?: boolean; }; }`\n Markdown formatting options including table styles and link annotations\n - `spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }`\n Spatial text output options for preserving document layout structure\n - `tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }`\n Options for exporting tables as XLSX spreadsheets\n\n- `page_ranges?: { max_pages?: number; target_pages?: string; }`\n Page selection: limit total pages or specify exact pages to process\n - `max_pages?: number`\n Maximum number of pages to process. Pages are processed in order starting from page 1. If both max_pages and target_pages are set, target_pages takes precedence\n - `target_pages?: string`\n Comma-separated list of specific pages to process using 1-based indexing. Supports individual pages and ranges. Examples: '1,3,5' (pages 1, 3, 5), '1-5' (pages 1 through 5 inclusive), '1,3,5-8,10' (pages 1, 3, 5-8, and 10). Pages are sorted and deduplicated automatically. Duplicate pages cause an error\n\n- `processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }`\n Job execution controls including timeouts and failure thresholds\n - `job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }`\n Quality thresholds that determine when a job should fail vs complete with partial results\n - `timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }`\n Timeout settings for job execution. Increase for large or complex documents\n\n- `processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; custom_prompt?: string; extract_layout?: boolean; high_res_ocr?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; }; language?: string; outlined_table_extraction?: boolean; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version?: 'latest' | '2026-06-26' | '2026-06-18' | '2025-12-11' | string; }; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: string[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }`\n Document processing options including OCR, table extraction, and chart parsing\n - `aggressive_table_extraction?: boolean`\n Use aggressive heuristics to detect table boundaries, even without visible borders. Useful for documents with borderless or complex tables\n - `auto_mode_configuration?: { parsing_conf: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; custom_prompt?: string; extract_layout?: boolean; high_res_ocr?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; }; language?: string; outlined_table_extraction?: boolean; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version?: 'latest' | '2026-06-26' | '2026-06-18' | '2025-12-11' | string; }; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]`\n Conditional processing rules that apply different parsing options based on page content, document structure, or filename patterns. Each entry defines trigger conditions and the parsing configuration to apply when triggered\n - `cost_optimizer?: { enable?: boolean; }`\n Cost optimizer configuration for reducing parsing costs on simpler pages.\n\nWhen enabled, the parser analyzes each page and routes simpler pages to faster,\ncheaper processing while preserving quality for complex pages. Only works with\n'agentic' or 'agentic_plus' tiers.\n - `disable_heuristics?: boolean`\n Disable automatic heuristics including outlined table extraction and adaptive long table handling. Use when heuristics produce incorrect results\n - `ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }`\n Options for ignoring specific text types (diagonal, hidden, text in images)\n - `ocr_parameters?: { languages?: string[]; }`\n OCR configuration including language detection settings\n - `specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'`\n Enable AI-powered chart analysis. Modes: 'efficient' (fast, lower cost), 'agentic' (balanced), 'agentic_plus' (highest accuracy). Automatically enables extract_layout and precise_bounding_box when set\n\n- `source_url?: string`\n Public URL of the document to parse. Mutually exclusive with file_id\n\n- `user_metadata?: object`\n Arbitrary key/value tags to attach to this job. Returned when retrieving the job. Not searchable. Limits apply to the number of entries and the length of keys and values; oversized metadata is rejected.\n\n- `webhook_configuration_ids?: string[]`\n IDs of saved webhook configurations to notify for this job.\n\n- `webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]`\n Webhook endpoints for job status notifications. Multiple webhooks can be configured for different events or services\n\n### Returns\n\n- `{ id: string; project_id: string; status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'; created_at?: string; error_message?: string; name?: string; tier?: string; updated_at?: string; user_metadata?: object; }`\n A parse job.\n\n - `id: string`\n - `project_id: string`\n - `status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'`\n - `created_at?: string`\n - `error_message?: string`\n - `name?: string`\n - `tier?: string`\n - `updated_at?: string`\n - `user_metadata?: object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst parsing = await client.parsing.create({ tier: 'fast', version: 'latest' });\n\nconsole.log(parsing);\n```",
|
|
468
|
+
markdown: "## create\n\n`client.parsing.create(tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus' | string, version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string, organization_id?: string, project_id?: string, agentic_options?: { custom_prompt?: string; }, client_name?: string, configuration_id?: string, crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }, disable_cache?: boolean, fast_options?: object, file_id?: string, http_proxy?: string, input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }, output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; 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' | 'agentic_plus' | 'efficient'; }, source_url?: string, user_metadata?: object, webhook_configuration_ids?: string[], webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]): { id: string; project_id: string; status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'; created_at?: string; error_message?: string; name?: string; tier?: string; updated_at?: string; user_metadata?: object; }`\n\n**post** `/api/v2/parse`\n\nParse a file by file ID or URL.\n\nProvide either `file_id` (a previously uploaded file) or\n`source_url` (a publicly accessible URL). Configure parsing\nwith options like `tier`, `target_pages`, and `lang`.\n\n## Tiers\n\n- `fast` — rule-based, cheapest, no AI\n- `cost_effective` — balanced speed and quality\n- `agentic` — full AI-powered parsing\n- `agentic_plus` — premium AI with specialized features\n\nThe job runs asynchronously. Poll `GET /parse/{job_id}` with\n`expand=text` or `expand=markdown` to retrieve results.\n\n### Parameters\n\n- `tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus' | string`\n Parsing tier: 'fast' (rule-based, cheapest), 'cost_effective' (balanced), 'agentic' (AI-powered with custom prompts), or 'agentic_plus' (premium AI with highest accuracy)\n\n- `version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string`\n Version for the selected tier. Use `latest`, or pin one of that tier's dated versions.\n\nCurrent `latest` by tier:\n- `fast`: `2026-06-15`\n- `cost_effective`: `2026-06-26`\n- `agentic`: `2026-06-18`\n- `agentic_plus`: `2026-07-08`\n\nFull list: `GET /api/v2/parse/versions`.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `agentic_options?: { custom_prompt?: string; }`\n Options for AI-powered parsing tiers (cost_effective, agentic, agentic_plus).\n\nThese options customize how the AI processes and interprets document content.\nOnly applicable when using non-fast tiers.\n - `custom_prompt?: string`\n Custom instructions for the AI parser. Use to guide extraction behavior, specify output formatting, or provide domain-specific context. Example: 'Extract financial tables with currency symbols. Format dates as YYYY-MM-DD.'\n\n- `client_name?: string`\n Identifier for the client/application making the request. Used for analytics and debugging. Example: 'my-app-v2'\n\n- `configuration_id?: string`\n ID of a saved parse configuration. When set, `tier` and `version` default to the saved configuration's values — omit them or pass `'configured'`.\n\n- `crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }`\n Crop boundaries to process only a portion of each page. Values are ratios 0-1 from page edges\n - `bottom?: number`\n Bottom boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content below this line is excluded\n - `left?: number`\n Left boundary as ratio (0-1). 0=left edge, 1=right edge. Content left of this line is excluded\n - `right?: number`\n Right boundary as ratio (0-1). 0=left edge, 1=right edge. Content right of this line is excluded\n - `top?: number`\n Top boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content above this line is excluded\n\n- `disable_cache?: boolean`\n Bypass result caching and force re-parsing. Use when document content may have changed or you need fresh results\n\n- `fast_options?: object`\n Options for fast tier parsing (rule-based, no AI).\n\nFast tier uses deterministic algorithms for text extraction without AI enhancement.\nIt's the fastest and most cost-effective option, best suited for simple documents\nwith standard layouts. Currently has no configurable options but reserved for\nfuture expansion.\n\n- `file_id?: string`\n ID of an existing file in the project to parse. Mutually exclusive with source_url\n\n- `http_proxy?: string`\n HTTP/HTTPS proxy for fetching source_url. Ignored if using file_id\n\n- `input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }`\n Format-specific options (HTML, PDF, spreadsheet, presentation). Applied based on detected input file type\n - `html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }`\n HTML/web page parsing options (applies to .html, .htm files)\n - `image?: { camera_photo_correction?: boolean; }`\n Image parsing options (applies to .jpg, .jpeg, .png, .webp files)\n - `pdf?: object`\n PDF-specific parsing options (applies to .pdf files)\n - `presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }`\n Presentation parsing options (applies to .pptx, .ppt, .odp, .key files)\n - `spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }`\n Spreadsheet parsing options (applies to .xlsx, .xls, .csv, .ods files)\n\n- `output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: { compact_markdown_tables?: boolean; markdown_table_multiline_separator?: string; merge_continued_tables?: boolean; output_tables_as_markdown?: boolean; }; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }; }`\n Output formatting options for markdown, text, and extracted images\n - `additional_outputs?: string[]`\n Optional additional output artifacts to save alongside the primary parse output. Each value opts in to generating and persisting one extra file; the empty list (default) saves none. The three accepted values are: 'stripped_md' — per-page markdown stripped of formatting (links, bold/italic, images, HTML), saved as JSON for full-text-search indexing; fetch via `expand=stripped_markdown_content_metadata`. 'concatenated_stripped_txt' — all stripped pages concatenated into a single plain-text file with `\\n\\n---\\n\\n` between pages, useful for feeding the document into search or embedding pipelines as one blob; fetch via `expand=concatenated_stripped_markdown_content_metadata`. 'word_bbox' — raw word-level bounding boxes (one JSON object per word, with page number and x/y/w/h coordinates) saved as JSONL, useful for highlighting or grounding extracted answers back to the source document; fetch via `expand=raw_words_content_metadata`.\n - `extract_printed_page_number?: boolean`\n Extract the printed page number as it appears in the document (e.g., 'Page 5 of 10', 'v', 'A-3'). Useful for referencing original page numbers\n - `granular_bboxes?: 'cell' | 'line' | 'word'[]`\n Bounding-box granularity levels to compute for the parse. 'word' computes one bounding box per detected word; 'line' computes one per text line; 'cell' computes one per table cell. Multiple levels can be requested. Empty list (default) disables granular bboxes — only item-level layout boxes are returned on the result. When set, the computed boxes are not inlined on the result items; they are written to a separate `grounded_items` sidecar (JSONL, one row per page) and exposed as `result_content_metadata.grounded_items` (a presigned download URL) on the parse result. Each row matches the `GroundedJsonItem` shape.\n - `images_to_save?: 'embedded' | 'layout' | 'screenshot'[]`\n Image categories to extract and save. Options: 'screenshot' (full page renders useful for visual QA), 'embedded' (images found within the document), 'layout' (cropped regions from layout detection like figures and diagrams). Empty list saves no images\n - `markdown?: { annotate_links?: boolean; inline_images?: boolean; tables?: { compact_markdown_tables?: boolean; markdown_table_multiline_separator?: string; merge_continued_tables?: boolean; output_tables_as_markdown?: boolean; }; }`\n Markdown formatting options including table styles and link annotations\n - `spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }`\n Spatial text output options for preserving document layout structure\n - `tables_as_spreadsheet?: { enable?: boolean; guess_sheet_name?: boolean; }`\n Options for exporting tables as XLSX spreadsheets\n\n- `page_ranges?: { max_pages?: number; target_pages?: string; }`\n Page selection: limit total pages or specify exact pages to process\n - `max_pages?: number`\n Maximum number of pages to process. Pages are processed in order starting from page 1. If both max_pages and target_pages are set, target_pages takes precedence\n - `target_pages?: string`\n Comma-separated list of specific pages to process using 1-based indexing. Supports individual pages and ranges. Examples: '1,3,5' (pages 1, 3, 5), '1-5' (pages 1 through 5 inclusive), '1,3,5-8,10' (pages 1, 3, 5-8, and 10). Pages are sorted and deduplicated automatically. Duplicate pages cause an error\n\n- `processing_control?: { job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }; timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }; }`\n Job execution controls including timeouts and failure thresholds\n - `job_failure_conditions?: { allowed_page_failure_ratio?: number; fail_on_buggy_font?: boolean; fail_on_image_extraction_error?: boolean; fail_on_image_ocr_error?: boolean; fail_on_markdown_reconstruction_error?: boolean; }`\n Quality thresholds that determine when a job should fail vs complete with partial results\n - `timeouts?: { base_in_seconds?: number; extra_time_per_page_in_seconds?: number; }`\n Timeout settings for job execution. Increase for large or complex documents\n\n- `processing_options?: { aggressive_table_extraction?: boolean; auto_mode_configuration?: { parsing_conf: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; custom_prompt?: string; extract_layout?: boolean; high_res_ocr?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; }; language?: string; outlined_table_extraction?: boolean; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version?: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; }; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]; cost_optimizer?: { enable?: boolean; }; disable_heuristics?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }; ocr_parameters?: { languages?: string[]; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; }`\n Document processing options including OCR, table extraction, and chart parsing\n - `aggressive_table_extraction?: boolean`\n Use aggressive heuristics to detect table boundaries, even without visible borders. Useful for documents with borderless or complex tables\n - `auto_mode_configuration?: { parsing_conf: { adaptive_long_table?: boolean; aggressive_table_extraction?: boolean; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; custom_prompt?: string; extract_layout?: boolean; high_res_ocr?: boolean; ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; }; language?: string; outlined_table_extraction?: boolean; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spatial_text?: { do_not_unroll_columns?: boolean; preserve_layout_alignment_across_pages?: boolean; preserve_very_small_text?: boolean; }; specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'; tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version?: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; }; filename_match_glob?: string; filename_match_glob_list?: string[]; filename_regexp?: string; filename_regexp_mode?: string; full_page_image_in_page?: boolean; full_page_image_in_page_threshold?: number | string; image_in_page?: boolean; layout_element_in_page?: string; layout_element_in_page_confidence_threshold?: number | string; page_contains_at_least_n_charts?: number | string; page_contains_at_least_n_images?: number | string; page_contains_at_least_n_layout_elements?: number | string; page_contains_at_least_n_lines?: number | string; page_contains_at_least_n_links?: number | string; page_contains_at_least_n_numbers?: number | string; page_contains_at_least_n_percent_numbers?: number | string; page_contains_at_least_n_tables?: number | string; page_contains_at_least_n_words?: number | string; page_contains_at_most_n_charts?: number | string; page_contains_at_most_n_images?: number | string; page_contains_at_most_n_layout_elements?: number | string; page_contains_at_most_n_lines?: number | string; page_contains_at_most_n_links?: number | string; page_contains_at_most_n_numbers?: number | string; page_contains_at_most_n_percent_numbers?: number | string; page_contains_at_most_n_tables?: number | string; page_contains_at_most_n_words?: number | string; page_longer_than_n_chars?: number | string; page_md_error?: boolean; page_shorter_than_n_chars?: number | string; regexp_in_page?: string; regexp_in_page_mode?: string; table_in_page?: boolean; text_in_page?: string; trigger_mode?: string; }[]`\n Conditional processing rules that apply different parsing options based on page content, document structure, or filename patterns. Each entry defines trigger conditions and the parsing configuration to apply when triggered\n - `cost_optimizer?: { enable?: boolean; }`\n Cost optimizer configuration for reducing parsing costs on simpler pages.\n\nWhen enabled, the parser analyzes each page and routes simpler pages to faster,\ncheaper processing while preserving quality for complex pages. Only works with\n'agentic' or 'agentic_plus' tiers.\n - `disable_heuristics?: boolean`\n Disable automatic heuristics including outlined table extraction and adaptive long table handling. Use when heuristics produce incorrect results\n - `ignore?: { ignore_diagonal_text?: boolean; ignore_hidden_text?: boolean; ignore_text_in_image?: boolean; }`\n Options for ignoring specific text types (diagonal, hidden, text in images)\n - `ocr_parameters?: { languages?: string[]; }`\n OCR configuration including language detection settings\n - `specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient'`\n Enable AI-powered chart analysis. Modes: 'efficient' (fast, lower cost), 'agentic' (balanced), 'agentic_plus' (highest accuracy). Automatically enables extract_layout and precise_bounding_box when set\n\n- `source_url?: string`\n Public URL of the document to parse. Mutually exclusive with file_id\n\n- `user_metadata?: object`\n Arbitrary key/value tags to attach to this job. Returned when retrieving the job. Not searchable. Limits apply to the number of entries and the length of keys and values; oversized metadata is rejected.\n\n- `webhook_configuration_ids?: string[]`\n IDs of saved webhook configurations to notify for this job.\n\n- `webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]`\n Webhook endpoints for job status notifications. Multiple webhooks can be configured for different events or services\n\n### Returns\n\n- `{ id: string; project_id: string; status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'; created_at?: string; error_message?: string; name?: string; tier?: string; updated_at?: string; user_metadata?: object; }`\n A parse job.\n\n - `id: string`\n - `project_id: string`\n - `status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING'`\n - `created_at?: string`\n - `error_message?: string`\n - `name?: string`\n - `tier?: string`\n - `updated_at?: string`\n - `user_metadata?: object`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst parsing = await client.parsing.create({ tier: 'fast', version: 'latest' });\n\nconsole.log(parsing);\n```",
|
|
469
469
|
perLanguage: {
|
|
470
470
|
go: {
|
|
471
471
|
method: 'client.Parsing.New',
|
|
@@ -488,7 +488,7 @@ const EMBEDDED_METHODS = [
|
|
|
488
488
|
},
|
|
489
489
|
cli: {
|
|
490
490
|
method: 'parsing create',
|
|
491
|
-
example: "
|
|
491
|
+
example: "llp parsing create \\\n --api-key 'My API Key' \\\n --tier fast \\\n --version latest",
|
|
492
492
|
},
|
|
493
493
|
},
|
|
494
494
|
},
|
|
@@ -531,7 +531,7 @@ const EMBEDDED_METHODS = [
|
|
|
531
531
|
},
|
|
532
532
|
cli: {
|
|
533
533
|
method: 'parsing get',
|
|
534
|
-
example: "
|
|
534
|
+
example: "llp parsing get \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
535
535
|
},
|
|
536
536
|
},
|
|
537
537
|
},
|
|
@@ -577,7 +577,7 @@ const EMBEDDED_METHODS = [
|
|
|
577
577
|
},
|
|
578
578
|
cli: {
|
|
579
579
|
method: 'parsing list',
|
|
580
|
-
example: "
|
|
580
|
+
example: "llp parsing list \\\n --api-key 'My API Key'",
|
|
581
581
|
},
|
|
582
582
|
},
|
|
583
583
|
},
|
|
@@ -621,7 +621,7 @@ const EMBEDDED_METHODS = [
|
|
|
621
621
|
},
|
|
622
622
|
cli: {
|
|
623
623
|
method: 'extract create',
|
|
624
|
-
example: "
|
|
624
|
+
example: "llp extract create \\\n --api-key 'My API Key' \\\n --file-input dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
|
|
625
625
|
},
|
|
626
626
|
},
|
|
627
627
|
},
|
|
@@ -672,7 +672,7 @@ const EMBEDDED_METHODS = [
|
|
|
672
672
|
},
|
|
673
673
|
cli: {
|
|
674
674
|
method: 'extract list',
|
|
675
|
-
example: "
|
|
675
|
+
example: "llp extract list \\\n --api-key 'My API Key'",
|
|
676
676
|
},
|
|
677
677
|
},
|
|
678
678
|
},
|
|
@@ -709,7 +709,7 @@ const EMBEDDED_METHODS = [
|
|
|
709
709
|
},
|
|
710
710
|
cli: {
|
|
711
711
|
method: 'extract get',
|
|
712
|
-
example: "
|
|
712
|
+
example: "llp extract get \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
713
713
|
},
|
|
714
714
|
},
|
|
715
715
|
},
|
|
@@ -746,7 +746,7 @@ const EMBEDDED_METHODS = [
|
|
|
746
746
|
},
|
|
747
747
|
cli: {
|
|
748
748
|
method: 'extract delete',
|
|
749
|
-
example: "
|
|
749
|
+
example: "llp extract delete \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
750
750
|
},
|
|
751
751
|
},
|
|
752
752
|
},
|
|
@@ -783,7 +783,7 @@ const EMBEDDED_METHODS = [
|
|
|
783
783
|
},
|
|
784
784
|
cli: {
|
|
785
785
|
method: 'extract validate_schema',
|
|
786
|
-
example: "
|
|
786
|
+
example: "llp extract validate-schema \\\n --api-key 'My API Key' \\\n --data-schema '{properties: {invoice_number: bar, line_items: bar, total_amount: bar, vendor_name: bar}, required: [invoice_number, total_amount, vendor_name], type: object}'",
|
|
787
787
|
},
|
|
788
788
|
},
|
|
789
789
|
},
|
|
@@ -804,7 +804,7 @@ const EMBEDDED_METHODS = [
|
|
|
804
804
|
'prompt?: string;',
|
|
805
805
|
],
|
|
806
806
|
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; }",
|
|
807
|
-
markdown: "## generate_schema\n\n`client.extract.generateSchema(organization_id?: string, project_id?: string, data_schema?: object, file_id?: string, name?: string, prompt?: string): { name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; }`\n\n**post** `/api/v2/extract/schema/generate`\n\nGenerate a JSON schema and return a product configuration request.\n\n### Parameters\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `data_schema?: object`\n Optional schema to validate, refine, or extend\n\n- `file_id?: string`\n Optional file ID to analyze for schema generation\n\n- `name?: string`\n Name for the generated configuration (auto-generated if omitted)\n\n- `prompt?: string`\n Natural language description of the data structure to extract\n\n### Returns\n\n- `{ name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-06-26' | '2026-06-18' | '
|
|
807
|
+
markdown: "## generate_schema\n\n`client.extract.generateSchema(organization_id?: string, project_id?: string, data_schema?: object, file_id?: string, name?: string, prompt?: string): { name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; }`\n\n**post** `/api/v2/extract/schema/generate`\n\nGenerate a JSON schema and return a product configuration request.\n\n### Parameters\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `data_schema?: object`\n Optional schema to validate, refine, or extend\n\n- `file_id?: string`\n Optional file ID to analyze for schema generation\n\n- `name?: string`\n Name for the generated configuration (auto-generated if omitted)\n\n- `prompt?: string`\n Natural language description of the data structure to extract\n\n### Returns\n\n- `{ name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; }`\n Request body for creating a product configuration.\n\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; 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' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; 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```",
|
|
808
808
|
perLanguage: {
|
|
809
809
|
go: {
|
|
810
810
|
method: 'client.Extract.GenerateSchema',
|
|
@@ -827,7 +827,7 @@ const EMBEDDED_METHODS = [
|
|
|
827
827
|
},
|
|
828
828
|
cli: {
|
|
829
829
|
method: 'extract generate_schema',
|
|
830
|
-
example: "
|
|
830
|
+
example: "llp extract generate-schema \\\n --api-key 'My API Key'",
|
|
831
831
|
},
|
|
832
832
|
},
|
|
833
833
|
},
|
|
@@ -872,7 +872,7 @@ const EMBEDDED_METHODS = [
|
|
|
872
872
|
},
|
|
873
873
|
cli: {
|
|
874
874
|
method: 'jobs create',
|
|
875
|
-
example: "
|
|
875
|
+
example: "llp classifier:jobs create \\\n --api-key 'My API Key' \\\n --file-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --rule \"{description: 'contains invoice number, line items, and total amount', type: invoice}\"",
|
|
876
876
|
},
|
|
877
877
|
},
|
|
878
878
|
},
|
|
@@ -914,7 +914,7 @@ const EMBEDDED_METHODS = [
|
|
|
914
914
|
},
|
|
915
915
|
cli: {
|
|
916
916
|
method: 'jobs list',
|
|
917
|
-
example: "
|
|
917
|
+
example: "llp classifier:jobs list \\\n --api-key 'My API Key'",
|
|
918
918
|
},
|
|
919
919
|
},
|
|
920
920
|
},
|
|
@@ -951,7 +951,7 @@ const EMBEDDED_METHODS = [
|
|
|
951
951
|
},
|
|
952
952
|
cli: {
|
|
953
953
|
method: 'jobs get',
|
|
954
|
-
example: "
|
|
954
|
+
example: "llp classifier:jobs get \\\n --api-key 'My API Key' \\\n --classify-job-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
955
955
|
},
|
|
956
956
|
},
|
|
957
957
|
},
|
|
@@ -988,7 +988,7 @@ const EMBEDDED_METHODS = [
|
|
|
988
988
|
},
|
|
989
989
|
cli: {
|
|
990
990
|
method: 'jobs get_results',
|
|
991
|
-
example: "
|
|
991
|
+
example: "llp classifier:jobs get-results \\\n --api-key 'My API Key' \\\n --classify-job-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
992
992
|
},
|
|
993
993
|
},
|
|
994
994
|
},
|
|
@@ -1030,7 +1030,7 @@ const EMBEDDED_METHODS = [
|
|
|
1030
1030
|
},
|
|
1031
1031
|
cli: {
|
|
1032
1032
|
method: 'batches create',
|
|
1033
|
-
example: "
|
|
1033
|
+
example: "llp batches create \\\n --api-key 'My API Key' \\\n --config '{job: {configuration_id: cfg-PARSE_AGENTIC, type: parse_v2}}' \\\n --source-directory-id dir-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
|
|
1034
1034
|
},
|
|
1035
1035
|
},
|
|
1036
1036
|
},
|
|
@@ -1076,7 +1076,7 @@ const EMBEDDED_METHODS = [
|
|
|
1076
1076
|
},
|
|
1077
1077
|
cli: {
|
|
1078
1078
|
method: 'batches list',
|
|
1079
|
-
example: "
|
|
1079
|
+
example: "llp batches list \\\n --api-key 'My API Key'",
|
|
1080
1080
|
},
|
|
1081
1081
|
},
|
|
1082
1082
|
},
|
|
@@ -1113,7 +1113,7 @@ const EMBEDDED_METHODS = [
|
|
|
1113
1113
|
},
|
|
1114
1114
|
cli: {
|
|
1115
1115
|
method: 'batches get',
|
|
1116
|
-
example: "
|
|
1116
|
+
example: "llp batches get \\\n --api-key 'My API Key' \\\n --batch-id batch_id",
|
|
1117
1117
|
},
|
|
1118
1118
|
},
|
|
1119
1119
|
},
|
|
@@ -1160,7 +1160,7 @@ const EMBEDDED_METHODS = [
|
|
|
1160
1160
|
},
|
|
1161
1161
|
cli: {
|
|
1162
1162
|
method: 'classify create',
|
|
1163
|
-
example: "
|
|
1163
|
+
example: "llp classify create \\\n --api-key 'My API Key'",
|
|
1164
1164
|
},
|
|
1165
1165
|
},
|
|
1166
1166
|
},
|
|
@@ -1207,7 +1207,7 @@ const EMBEDDED_METHODS = [
|
|
|
1207
1207
|
},
|
|
1208
1208
|
cli: {
|
|
1209
1209
|
method: 'classify list',
|
|
1210
|
-
example: "
|
|
1210
|
+
example: "llp classify list \\\n --api-key 'My API Key'",
|
|
1211
1211
|
},
|
|
1212
1212
|
},
|
|
1213
1213
|
},
|
|
@@ -1244,7 +1244,7 @@ const EMBEDDED_METHODS = [
|
|
|
1244
1244
|
},
|
|
1245
1245
|
cli: {
|
|
1246
1246
|
method: 'classify get',
|
|
1247
|
-
example: "
|
|
1247
|
+
example: "llp classify get \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
1248
1248
|
},
|
|
1249
1249
|
},
|
|
1250
1250
|
},
|
|
@@ -1258,12 +1258,12 @@ const EMBEDDED_METHODS = [
|
|
|
1258
1258
|
qualified: 'client.configurations.create',
|
|
1259
1259
|
params: [
|
|
1260
1260
|
'name: string;',
|
|
1261
|
-
"parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-06-26' | '2026-06-18' | '
|
|
1261
|
+
"parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; 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' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; };",
|
|
1262
1262
|
'organization_id?: string;',
|
|
1263
1263
|
'project_id?: string;',
|
|
1264
1264
|
],
|
|
1265
1265
|
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: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
|
|
1266
|
-
markdown: "## create\n\n`client.configurations.create(name: string, parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-06-26' | '2026-06-18' | '2025-12-11' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }, organization_id?: string, project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**post** `/api/v1/beta/configurations`\n\nUpsert a product configuration; updates if one with the same name + product type + project exists, otherwise creates.\n\n### Parameters\n\n- `name: string`\n Human-readable name for this configuration.\n\n- `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-06-26' | '2026-06-18' | '2025-12-11' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; 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' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n Product-specific configuration parameters.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-06-26' | '2026-06-18' | '2025-12-11' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n Response schema for a single product configuration.\n\n - `id: string`\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-06-26' | '2026-06-18' | '2025-12-11' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; 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' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'`\n - `version: string`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst configurationResponse = await client.configurations.create({\n name: 'x',\n parameters: { product_type: 'classify_v2', rules: [{ description: 'contains invoice number, line items, and total amount', type: 'invoice' }] },\n});\n\nconsole.log(configurationResponse);\n```",
|
|
1266
|
+
markdown: "## create\n\n`client.configurations.create(name: string, parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }, organization_id?: string, project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**post** `/api/v1/beta/configurations`\n\nUpsert a product configuration; updates if one with the same name + product type + project exists, otherwise creates.\n\n### Parameters\n\n- `name: string`\n Human-readable name for this configuration.\n\n- `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; 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' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n Product-specific configuration parameters.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n Response schema for a single product configuration.\n\n - `id: string`\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; 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' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'`\n - `version: string`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst configurationResponse = await client.configurations.create({\n name: 'x',\n parameters: { product_type: 'classify_v2', rules: [{ description: 'contains invoice number, line items, and total amount', type: 'invoice' }] },\n});\n\nconsole.log(configurationResponse);\n```",
|
|
1267
1267
|
perLanguage: {
|
|
1268
1268
|
go: {
|
|
1269
1269
|
method: 'client.Configurations.New',
|
|
@@ -1286,7 +1286,7 @@ const EMBEDDED_METHODS = [
|
|
|
1286
1286
|
},
|
|
1287
1287
|
cli: {
|
|
1288
1288
|
method: 'configurations create',
|
|
1289
|
-
example: "
|
|
1289
|
+
example: "llp configurations create \\\n --api-key 'My API Key' \\\n --name x \\\n --parameters \"{product_type: classify_v2, rules: [{description: 'contains invoice number, line items, and total amount', type: invoice}]}\"",
|
|
1290
1290
|
},
|
|
1291
1291
|
},
|
|
1292
1292
|
},
|
|
@@ -1308,7 +1308,7 @@ const EMBEDDED_METHODS = [
|
|
|
1308
1308
|
'project_id?: string;',
|
|
1309
1309
|
],
|
|
1310
1310
|
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: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
|
|
1311
|
-
markdown: "## list\n\n`client.configurations.list(latest_only?: boolean, name?: string, organization_id?: string, page_size?: number, page_token?: string, product_type?: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'[], project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/beta/configurations`\n\nList product configurations for the current project.\n\n### Parameters\n\n- `latest_only?: boolean`\n Return only the latest version per configuration name.\n\n- `name?: string`\n Filter by configuration name.\n\n- `organization_id?: string`\n\n- `page_size?: number`\n Number of items per page.\n\n- `page_token?: string`\n Pagination token.\n\n- `product_type?: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'[]`\n Filter by one or more product types. Repeat the parameter for multiple values.\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-06-26' | '2026-06-18' | '
|
|
1311
|
+
markdown: "## list\n\n`client.configurations.list(latest_only?: boolean, name?: string, organization_id?: string, page_size?: number, page_token?: string, product_type?: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'[], project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/beta/configurations`\n\nList product configurations for the current project.\n\n### Parameters\n\n- `latest_only?: boolean`\n Return only the latest version per configuration name.\n\n- `name?: string`\n Filter by configuration name.\n\n- `organization_id?: string`\n\n- `page_size?: number`\n Number of items per page.\n\n- `page_token?: string`\n Pagination token.\n\n- `product_type?: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'[]`\n Filter by one or more product types. Repeat the parameter for multiple values.\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n Response schema for a single product configuration.\n\n - `id: string`\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; 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' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'`\n - `version: string`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\n// Automatically fetches more pages as needed.\nfor await (const configurationResponse of client.configurations.list()) {\n console.log(configurationResponse);\n}\n```",
|
|
1312
1312
|
perLanguage: {
|
|
1313
1313
|
go: {
|
|
1314
1314
|
method: 'client.Configurations.List',
|
|
@@ -1331,7 +1331,7 @@ const EMBEDDED_METHODS = [
|
|
|
1331
1331
|
},
|
|
1332
1332
|
cli: {
|
|
1333
1333
|
method: 'configurations list',
|
|
1334
|
-
example: "
|
|
1334
|
+
example: "llp configurations list \\\n --api-key 'My API Key'",
|
|
1335
1335
|
},
|
|
1336
1336
|
},
|
|
1337
1337
|
},
|
|
@@ -1345,7 +1345,7 @@ const EMBEDDED_METHODS = [
|
|
|
1345
1345
|
qualified: 'client.configurations.retrieve',
|
|
1346
1346
|
params: ['config_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
1347
1347
|
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: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
|
|
1348
|
-
markdown: "## retrieve\n\n`client.configurations.retrieve(config_id: string, organization_id?: string, project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/beta/configurations/{config_id}`\n\nGet a single product configuration by ID.\n\n### Parameters\n\n- `config_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-06-26' | '2026-06-18' | '
|
|
1348
|
+
markdown: "## retrieve\n\n`client.configurations.retrieve(config_id: string, organization_id?: string, project_id?: string): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**get** `/api/v1/beta/configurations/{config_id}`\n\nGet a single product configuration by ID.\n\n### Parameters\n\n- `config_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n Response schema for a single product configuration.\n\n - `id: string`\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; 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' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'`\n - `version: string`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst configurationResponse = await client.configurations.retrieve('config_id');\n\nconsole.log(configurationResponse);\n```",
|
|
1349
1349
|
perLanguage: {
|
|
1350
1350
|
go: {
|
|
1351
1351
|
method: 'client.Configurations.Get',
|
|
@@ -1368,7 +1368,7 @@ const EMBEDDED_METHODS = [
|
|
|
1368
1368
|
},
|
|
1369
1369
|
cli: {
|
|
1370
1370
|
method: 'configurations retrieve',
|
|
1371
|
-
example: "
|
|
1371
|
+
example: "llp configurations retrieve \\\n --api-key 'My API Key' \\\n --config-id config_id",
|
|
1372
1372
|
},
|
|
1373
1373
|
},
|
|
1374
1374
|
},
|
|
@@ -1385,10 +1385,10 @@ const EMBEDDED_METHODS = [
|
|
|
1385
1385
|
'organization_id?: string;',
|
|
1386
1386
|
'project_id?: string;',
|
|
1387
1387
|
'name?: string;',
|
|
1388
|
-
"parameters?: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-06-26' | '2026-06-18' | '
|
|
1388
|
+
"parameters?: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; 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' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; };",
|
|
1389
1389
|
],
|
|
1390
1390
|
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: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }",
|
|
1391
|
-
markdown: "## update\n\n`client.configurations.update(config_id: string, organization_id?: string, project_id?: string, name?: string, parameters?: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-06-26' | '2026-06-18' | '2025-12-11' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**put** `/api/v1/beta/configurations/{config_id}`\n\nUpdate an existing product configuration.\n\n### Parameters\n\n- `config_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `name?: string`\n Updated name (omit to leave unchanged).\n\n- `parameters?: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-06-26' | '2026-06-18' | '2025-12-11' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; 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' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n Updated parameters (omit to leave unchanged).\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-06-26' | '2026-06-18' | '2025-12-11' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n Response schema for a single product configuration.\n\n - `id: string`\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-06-26' | '2026-06-18' | '2025-12-11' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; 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' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'`\n - `version: string`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst configurationResponse = await client.configurations.update('config_id');\n\nconsole.log(configurationResponse);\n```",
|
|
1391
|
+
markdown: "## update\n\n`client.configurations.update(config_id: string, organization_id?: string, project_id?: string, name?: string, parameters?: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }): { id: string; name: string; parameters: classify_v2_parameters | extract_v2_parameters | parse_v2_parameters | split_v1_parameters | object | untyped_parameters; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n\n**put** `/api/v1/beta/configurations/{config_id}`\n\nUpdate an existing product configuration.\n\n### Parameters\n\n- `config_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `name?: string`\n Updated name (omit to leave unchanged).\n\n- `parameters?: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; 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' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n Updated parameters (omit to leave unchanged).\n\n### Returns\n\n- `{ id: string; name: string; parameters: { product_type: 'classify_v2'; rules: object[]; mode?: 'FAST'; parsing_configuration?: object; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: object; client_name?: string; crop_box?: object; disable_cache?: boolean; fast_options?: object; input_options?: object; output_options?: object; page_ranges?: object; processing_control?: object; processing_options?: object; webhook_configuration_ids?: string[]; webhook_configurations?: object[]; } | { categories: split_category[]; product_type: 'split_v1'; splitting_strategy?: object; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }; product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'; version: string; created_at?: string; updated_at?: string; }`\n Response schema for a single product configuration.\n\n - `id: string`\n - `name: string`\n - `parameters: { product_type: 'classify_v2'; rules: { description: string; type: string; }[]; mode?: 'FAST'; parsing_configuration?: { lang?: string; max_pages?: number; target_pages?: string; }; } | { data_schema: object; product_type: 'extract_v2'; cite_sources?: boolean; confidence_scores?: boolean; 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?: 'agentic' | 'cost_effective'; version?: string; } | { product_type: 'parse_v2'; tier: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast'; version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string; agentic_options?: { custom_prompt?: string; }; client_name?: string; crop_box?: { bottom?: number; left?: number; right?: number; top?: number; }; disable_cache?: boolean; fast_options?: object; input_options?: { html?: { make_all_elements_visible?: boolean; remove_fixed_elements?: boolean; remove_navigation_elements?: boolean; }; image?: { camera_photo_correction?: boolean; }; pdf?: object; presentation?: { out_of_bounds_content?: boolean; skip_embedded_data?: boolean; }; spreadsheet?: { detect_sub_tables_in_sheets?: boolean; force_formula_computation_in_sheets?: boolean; include_hidden_sheets?: boolean; }; }; output_options?: { additional_outputs?: string[]; extract_printed_page_number?: boolean; granular_bboxes?: 'cell' | 'line' | 'word'[]; images_to_save?: 'embedded' | 'layout' | 'screenshot'[]; markdown?: { annotate_links?: boolean; 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' | 'agentic_plus' | 'efficient'; }; webhook_configuration_ids?: string[]; webhook_configurations?: { webhook_events?: string[]; webhook_headers?: object; webhook_output_format?: 'json' | 'string'; webhook_signing_secret?: string; webhook_url?: string; }[]; } | { categories: { name: string; description?: string; }[]; product_type: 'split_v1'; splitting_strategy?: { allow_uncategorized?: 'forbid' | 'include' | 'omit'; }; } | { product_type: 'spreadsheet_v1'; extraction_range?: string; flatten_hierarchical_tables?: boolean; generate_additional_metadata?: boolean; include_hidden_cells?: boolean; sheet_names?: string[]; specialization?: string; table_merge_sensitivity?: 'strong' | 'weak'; use_experimental_processing?: boolean; } | { product_type: 'unknown'; }`\n - `product_type: 'classify_v2' | 'extract_v2' | 'parse_v2' | 'split_v1' | 'spreadsheet_v1' | 'unknown'`\n - `version: string`\n - `created_at?: string`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst configurationResponse = await client.configurations.update('config_id');\n\nconsole.log(configurationResponse);\n```",
|
|
1392
1392
|
perLanguage: {
|
|
1393
1393
|
go: {
|
|
1394
1394
|
method: 'client.Configurations.Update',
|
|
@@ -1411,7 +1411,7 @@ const EMBEDDED_METHODS = [
|
|
|
1411
1411
|
},
|
|
1412
1412
|
cli: {
|
|
1413
1413
|
method: 'configurations update',
|
|
1414
|
-
example: "
|
|
1414
|
+
example: "llp configurations update \\\n --api-key 'My API Key' \\\n --config-id config_id",
|
|
1415
1415
|
},
|
|
1416
1416
|
},
|
|
1417
1417
|
},
|
|
@@ -1447,7 +1447,7 @@ const EMBEDDED_METHODS = [
|
|
|
1447
1447
|
},
|
|
1448
1448
|
cli: {
|
|
1449
1449
|
method: 'configurations delete',
|
|
1450
|
-
example: "
|
|
1450
|
+
example: "llp configurations delete \\\n --api-key 'My API Key' \\\n --config-id config_id",
|
|
1451
1451
|
},
|
|
1452
1452
|
},
|
|
1453
1453
|
},
|
|
@@ -1484,7 +1484,7 @@ const EMBEDDED_METHODS = [
|
|
|
1484
1484
|
},
|
|
1485
1485
|
cli: {
|
|
1486
1486
|
method: 'projects list',
|
|
1487
|
-
example: "
|
|
1487
|
+
example: "llp projects list \\\n --api-key 'My API Key'",
|
|
1488
1488
|
},
|
|
1489
1489
|
},
|
|
1490
1490
|
},
|
|
@@ -1521,7 +1521,7 @@ const EMBEDDED_METHODS = [
|
|
|
1521
1521
|
},
|
|
1522
1522
|
cli: {
|
|
1523
1523
|
method: 'projects get',
|
|
1524
|
-
example: "
|
|
1524
|
+
example: "llp projects get \\\n --api-key 'My API Key' \\\n --project-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
1525
1525
|
},
|
|
1526
1526
|
},
|
|
1527
1527
|
},
|
|
@@ -1558,7 +1558,7 @@ const EMBEDDED_METHODS = [
|
|
|
1558
1558
|
},
|
|
1559
1559
|
cli: {
|
|
1560
1560
|
method: 'data_sinks list',
|
|
1561
|
-
example: "
|
|
1561
|
+
example: "llp data-sinks list \\\n --api-key 'My API Key'",
|
|
1562
1562
|
},
|
|
1563
1563
|
},
|
|
1564
1564
|
},
|
|
@@ -1601,7 +1601,7 @@ const EMBEDDED_METHODS = [
|
|
|
1601
1601
|
},
|
|
1602
1602
|
cli: {
|
|
1603
1603
|
method: 'data_sinks create',
|
|
1604
|
-
example: "
|
|
1604
|
+
example: "llp data-sinks create \\\n --api-key 'My API Key' \\\n --component '{foo: bar}' \\\n --name name \\\n --sink-type ASTRA_DB",
|
|
1605
1605
|
},
|
|
1606
1606
|
},
|
|
1607
1607
|
},
|
|
@@ -1638,7 +1638,7 @@ const EMBEDDED_METHODS = [
|
|
|
1638
1638
|
},
|
|
1639
1639
|
cli: {
|
|
1640
1640
|
method: 'data_sinks get',
|
|
1641
|
-
example: "
|
|
1641
|
+
example: "llp data-sinks get \\\n --api-key 'My API Key' \\\n --data-sink-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
1642
1642
|
},
|
|
1643
1643
|
},
|
|
1644
1644
|
},
|
|
@@ -1680,7 +1680,7 @@ const EMBEDDED_METHODS = [
|
|
|
1680
1680
|
},
|
|
1681
1681
|
cli: {
|
|
1682
1682
|
method: 'data_sinks update',
|
|
1683
|
-
example: "
|
|
1683
|
+
example: "llp data-sinks update \\\n --api-key 'My API Key' \\\n --data-sink-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --sink-type ASTRA_DB",
|
|
1684
1684
|
},
|
|
1685
1685
|
},
|
|
1686
1686
|
},
|
|
@@ -1716,7 +1716,7 @@ const EMBEDDED_METHODS = [
|
|
|
1716
1716
|
},
|
|
1717
1717
|
cli: {
|
|
1718
1718
|
method: 'data_sinks delete',
|
|
1719
|
-
example: "
|
|
1719
|
+
example: "llp data-sinks delete \\\n --api-key 'My API Key' \\\n --data-sink-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
1720
1720
|
},
|
|
1721
1721
|
},
|
|
1722
1722
|
},
|
|
@@ -1753,7 +1753,7 @@ const EMBEDDED_METHODS = [
|
|
|
1753
1753
|
},
|
|
1754
1754
|
cli: {
|
|
1755
1755
|
method: 'data_sources list',
|
|
1756
|
-
example: "
|
|
1756
|
+
example: "llp data-sources list \\\n --api-key 'My API Key'",
|
|
1757
1757
|
},
|
|
1758
1758
|
},
|
|
1759
1759
|
},
|
|
@@ -1766,7 +1766,7 @@ const EMBEDDED_METHODS = [
|
|
|
1766
1766
|
stainlessPath: '(resource) data_sources > (method) create',
|
|
1767
1767
|
qualified: 'client.dataSources.create',
|
|
1768
1768
|
params: [
|
|
1769
|
-
"component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; };",
|
|
1769
|
+
"component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; };",
|
|
1770
1770
|
'name: string;',
|
|
1771
1771
|
'source_type: string;',
|
|
1772
1772
|
'organization_id?: string;',
|
|
@@ -1774,7 +1774,7 @@ const EMBEDDED_METHODS = [
|
|
|
1774
1774
|
'custom_metadata?: object;',
|
|
1775
1775
|
],
|
|
1776
1776
|
response: '{ id: string; component: object | object | object | object | object | object | object | object | object | object | object | object; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: object; }',
|
|
1777
|
-
markdown: "## create\n\n`client.dataSources.create(component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }, name: string, source_type: string, organization_id?: string, project_id?: string, custom_metadata?: object): { id: string; component: object | cloud_s3_data_source | cloud_az_storage_blob_data_source | cloud_google_drive_data_source | cloud_one_drive_data_source | cloud_sharepoint_data_source | cloud_slack_data_source | cloud_notion_page_data_source | cloud_confluence_data_source | cloud_jira_data_source | cloud_jira_data_source_v2 | cloud_box_data_source; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: data_source_reader_version_metadata; }`\n\n**post** `/api/v1/data-sources`\n\nCreate a new data source.\n\n### Parameters\n\n- `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n Component that implements the data source\n\n- `name: string`\n The name of the data source.\n\n- `source_type: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `custom_metadata?: object`\n Custom metadata that will be present on all data loaded from the data source\n\n### Returns\n\n- `{ id: string; component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }; }`\n Schema for a data source.\n\n - `id: string`\n - `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n - `name: string`\n - `project_id: string`\n - `source_type: string`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `updated_at?: string`\n - `version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst dataSource = await client.dataSources.create({\n component: { foo: 'bar' },\n name: 'name',\n source_type: 'AZURE_STORAGE_BLOB',\n});\n\nconsole.log(dataSource);\n```",
|
|
1777
|
+
markdown: "## create\n\n`client.dataSources.create(component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }, name: string, source_type: string, organization_id?: string, project_id?: string, custom_metadata?: object): { id: string; component: object | cloud_s3_data_source | cloud_az_storage_blob_data_source | cloud_google_drive_data_source | cloud_one_drive_data_source | cloud_sharepoint_data_source | cloud_slack_data_source | cloud_notion_page_data_source | cloud_confluence_data_source | cloud_jira_data_source | cloud_jira_data_source_v2 | cloud_box_data_source; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: data_source_reader_version_metadata; }`\n\n**post** `/api/v1/data-sources`\n\nCreate a new data source.\n\n### Parameters\n\n- `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n Component that implements the data source\n\n- `name: string`\n The name of the data source.\n\n- `source_type: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `custom_metadata?: object`\n Custom metadata that will be present on all data loaded from the data source\n\n### Returns\n\n- `{ id: string; component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }; }`\n Schema for a data source.\n\n - `id: string`\n - `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n - `name: string`\n - `project_id: string`\n - `source_type: string`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `updated_at?: string`\n - `version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst dataSource = await client.dataSources.create({\n component: { foo: 'bar' },\n name: 'name',\n source_type: 'AZURE_STORAGE_BLOB',\n});\n\nconsole.log(dataSource);\n```",
|
|
1778
1778
|
perLanguage: {
|
|
1779
1779
|
go: {
|
|
1780
1780
|
method: 'client.DataSources.New',
|
|
@@ -1797,7 +1797,7 @@ const EMBEDDED_METHODS = [
|
|
|
1797
1797
|
},
|
|
1798
1798
|
cli: {
|
|
1799
1799
|
method: 'data_sources create',
|
|
1800
|
-
example: "
|
|
1800
|
+
example: "llp data-sources create \\\n --api-key 'My API Key' \\\n --component '{foo: bar}' \\\n --name name \\\n --source-type AZURE_STORAGE_BLOB",
|
|
1801
1801
|
},
|
|
1802
1802
|
},
|
|
1803
1803
|
},
|
|
@@ -1811,7 +1811,7 @@ const EMBEDDED_METHODS = [
|
|
|
1811
1811
|
qualified: 'client.dataSources.get',
|
|
1812
1812
|
params: ['data_source_id: string;'],
|
|
1813
1813
|
response: '{ id: string; component: object | object | object | object | object | object | object | object | object | object | object | object; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: object; }',
|
|
1814
|
-
markdown: "## get\n\n`client.dataSources.get(data_source_id: string): { id: string; component: object | cloud_s3_data_source | cloud_az_storage_blob_data_source | cloud_google_drive_data_source | cloud_one_drive_data_source | cloud_sharepoint_data_source | cloud_slack_data_source | cloud_notion_page_data_source | cloud_confluence_data_source | cloud_jira_data_source | cloud_jira_data_source_v2 | cloud_box_data_source; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: data_source_reader_version_metadata; }`\n\n**get** `/api/v1/data-sources/{data_source_id}`\n\nGet a data source by ID.\n\n### Parameters\n\n- `data_source_id: string`\n\n### Returns\n\n- `{ id: string; component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }; }`\n Schema for a data source.\n\n - `id: string`\n - `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n - `name: string`\n - `project_id: string`\n - `source_type: string`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `updated_at?: string`\n - `version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst dataSource = await client.dataSources.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(dataSource);\n```",
|
|
1814
|
+
markdown: "## get\n\n`client.dataSources.get(data_source_id: string): { id: string; component: object | cloud_s3_data_source | cloud_az_storage_blob_data_source | cloud_google_drive_data_source | cloud_one_drive_data_source | cloud_sharepoint_data_source | cloud_slack_data_source | cloud_notion_page_data_source | cloud_confluence_data_source | cloud_jira_data_source | cloud_jira_data_source_v2 | cloud_box_data_source; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: data_source_reader_version_metadata; }`\n\n**get** `/api/v1/data-sources/{data_source_id}`\n\nGet a data source by ID.\n\n### Parameters\n\n- `data_source_id: string`\n\n### Returns\n\n- `{ id: string; component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }; }`\n Schema for a data source.\n\n - `id: string`\n - `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n - `name: string`\n - `project_id: string`\n - `source_type: string`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `updated_at?: string`\n - `version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst dataSource = await client.dataSources.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(dataSource);\n```",
|
|
1815
1815
|
perLanguage: {
|
|
1816
1816
|
go: {
|
|
1817
1817
|
method: 'client.DataSources.Get',
|
|
@@ -1834,7 +1834,7 @@ const EMBEDDED_METHODS = [
|
|
|
1834
1834
|
},
|
|
1835
1835
|
cli: {
|
|
1836
1836
|
method: 'data_sources get',
|
|
1837
|
-
example: "
|
|
1837
|
+
example: "llp data-sources get \\\n --api-key 'My API Key' \\\n --data-source-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
1838
1838
|
},
|
|
1839
1839
|
},
|
|
1840
1840
|
},
|
|
@@ -1849,12 +1849,12 @@ const EMBEDDED_METHODS = [
|
|
|
1849
1849
|
params: [
|
|
1850
1850
|
'data_source_id: string;',
|
|
1851
1851
|
'source_type: string;',
|
|
1852
|
-
"component?: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; };",
|
|
1852
|
+
"component?: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; };",
|
|
1853
1853
|
'custom_metadata?: object;',
|
|
1854
1854
|
'name?: string;',
|
|
1855
1855
|
],
|
|
1856
1856
|
response: '{ id: string; component: object | object | object | object | object | object | object | object | object | object | object | object; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: object; }',
|
|
1857
|
-
markdown: "## update\n\n`client.dataSources.update(data_source_id: string, source_type: string, component?: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }, custom_metadata?: object, name?: string): { id: string; component: object | cloud_s3_data_source | cloud_az_storage_blob_data_source | cloud_google_drive_data_source | cloud_one_drive_data_source | cloud_sharepoint_data_source | cloud_slack_data_source | cloud_notion_page_data_source | cloud_confluence_data_source | cloud_jira_data_source | cloud_jira_data_source_v2 | cloud_box_data_source; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: data_source_reader_version_metadata; }`\n\n**put** `/api/v1/data-sources/{data_source_id}`\n\nUpdate a data source by ID.\n\n### Parameters\n\n- `data_source_id: string`\n\n- `source_type: string`\n\n- `component?: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n Component that implements the data source\n\n- `custom_metadata?: object`\n Custom metadata that will be present on all data loaded from the data source\n\n- `name?: string`\n The name of the data source.\n\n### Returns\n\n- `{ id: string; component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }; }`\n Schema for a data source.\n\n - `id: string`\n - `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n - `name: string`\n - `project_id: string`\n - `source_type: string`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `updated_at?: string`\n - `version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst dataSource = await client.dataSources.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { source_type: 'AZURE_STORAGE_BLOB' });\n\nconsole.log(dataSource);\n```",
|
|
1857
|
+
markdown: "## update\n\n`client.dataSources.update(data_source_id: string, source_type: string, component?: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }, custom_metadata?: object, name?: string): { id: string; component: object | cloud_s3_data_source | cloud_az_storage_blob_data_source | cloud_google_drive_data_source | cloud_one_drive_data_source | cloud_sharepoint_data_source | cloud_slack_data_source | cloud_notion_page_data_source | cloud_confluence_data_source | cloud_jira_data_source | cloud_jira_data_source_v2 | cloud_box_data_source; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: data_source_reader_version_metadata; }`\n\n**put** `/api/v1/data-sources/{data_source_id}`\n\nUpdate a data source by ID.\n\n### Parameters\n\n- `data_source_id: string`\n\n- `source_type: string`\n\n- `component?: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n Component that implements the data source\n\n- `custom_metadata?: object`\n Custom metadata that will be present on all data loaded from the data source\n\n- `name?: string`\n The name of the data source.\n\n### Returns\n\n- `{ id: string; component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }; name: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; updated_at?: string; version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }; }`\n Schema for a data source.\n\n - `id: string`\n - `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n - `name: string`\n - `project_id: string`\n - `source_type: string`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `updated_at?: string`\n - `version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst dataSource = await client.dataSources.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { source_type: 'AZURE_STORAGE_BLOB' });\n\nconsole.log(dataSource);\n```",
|
|
1858
1858
|
perLanguage: {
|
|
1859
1859
|
go: {
|
|
1860
1860
|
method: 'client.DataSources.Update',
|
|
@@ -1877,7 +1877,7 @@ const EMBEDDED_METHODS = [
|
|
|
1877
1877
|
},
|
|
1878
1878
|
cli: {
|
|
1879
1879
|
method: 'data_sources update',
|
|
1880
|
-
example: "
|
|
1880
|
+
example: "llp data-sources update \\\n --api-key 'My API Key' \\\n --data-source-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --source-type AZURE_STORAGE_BLOB",
|
|
1881
1881
|
},
|
|
1882
1882
|
},
|
|
1883
1883
|
},
|
|
@@ -1913,7 +1913,7 @@ const EMBEDDED_METHODS = [
|
|
|
1913
1913
|
},
|
|
1914
1914
|
cli: {
|
|
1915
1915
|
method: 'data_sources delete',
|
|
1916
|
-
example: "
|
|
1916
|
+
example: "llp data-sources delete \\\n --api-key 'My API Key' \\\n --data-source-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
1917
1917
|
},
|
|
1918
1918
|
},
|
|
1919
1919
|
},
|
|
@@ -1956,7 +1956,7 @@ const EMBEDDED_METHODS = [
|
|
|
1956
1956
|
},
|
|
1957
1957
|
cli: {
|
|
1958
1958
|
method: 'pipelines list',
|
|
1959
|
-
example: "
|
|
1959
|
+
example: "llp pipelines list \\\n --api-key 'My API Key'",
|
|
1960
1960
|
},
|
|
1961
1961
|
},
|
|
1962
1962
|
},
|
|
@@ -2009,7 +2009,7 @@ const EMBEDDED_METHODS = [
|
|
|
2009
2009
|
},
|
|
2010
2010
|
cli: {
|
|
2011
2011
|
method: 'pipelines create',
|
|
2012
|
-
example: "
|
|
2012
|
+
example: "llp pipelines create \\\n --api-key 'My API Key' \\\n --name x",
|
|
2013
2013
|
},
|
|
2014
2014
|
},
|
|
2015
2015
|
},
|
|
@@ -2046,7 +2046,7 @@ const EMBEDDED_METHODS = [
|
|
|
2046
2046
|
},
|
|
2047
2047
|
cli: {
|
|
2048
2048
|
method: 'pipelines get',
|
|
2049
|
-
example: "
|
|
2049
|
+
example: "llp pipelines get \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2050
2050
|
},
|
|
2051
2051
|
},
|
|
2052
2052
|
},
|
|
@@ -2097,7 +2097,7 @@ const EMBEDDED_METHODS = [
|
|
|
2097
2097
|
},
|
|
2098
2098
|
cli: {
|
|
2099
2099
|
method: 'pipelines update',
|
|
2100
|
-
example: "
|
|
2100
|
+
example: "llp pipelines update \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2101
2101
|
},
|
|
2102
2102
|
},
|
|
2103
2103
|
},
|
|
@@ -2133,7 +2133,7 @@ const EMBEDDED_METHODS = [
|
|
|
2133
2133
|
},
|
|
2134
2134
|
cli: {
|
|
2135
2135
|
method: 'pipelines delete',
|
|
2136
|
-
example: "
|
|
2136
|
+
example: "llp pipelines delete \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2137
2137
|
},
|
|
2138
2138
|
},
|
|
2139
2139
|
},
|
|
@@ -2170,7 +2170,7 @@ const EMBEDDED_METHODS = [
|
|
|
2170
2170
|
},
|
|
2171
2171
|
cli: {
|
|
2172
2172
|
method: 'pipelines get_status',
|
|
2173
|
-
example: "
|
|
2173
|
+
example: "llp pipelines get-status \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2174
2174
|
},
|
|
2175
2175
|
},
|
|
2176
2176
|
},
|
|
@@ -2223,7 +2223,7 @@ const EMBEDDED_METHODS = [
|
|
|
2223
2223
|
},
|
|
2224
2224
|
cli: {
|
|
2225
2225
|
method: 'pipelines upsert',
|
|
2226
|
-
example: "
|
|
2226
|
+
example: "llp pipelines upsert \\\n --api-key 'My API Key' \\\n --name x",
|
|
2227
2227
|
},
|
|
2228
2228
|
},
|
|
2229
2229
|
},
|
|
@@ -2242,7 +2242,7 @@ const EMBEDDED_METHODS = [
|
|
|
2242
2242
|
},
|
|
2243
2243
|
cli: {
|
|
2244
2244
|
method: 'pipelines run_search',
|
|
2245
|
-
example: "
|
|
2245
|
+
example: "llp pipelines run-search \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --query x",
|
|
2246
2246
|
},
|
|
2247
2247
|
},
|
|
2248
2248
|
},
|
|
@@ -2279,7 +2279,7 @@ const EMBEDDED_METHODS = [
|
|
|
2279
2279
|
},
|
|
2280
2280
|
cli: {
|
|
2281
2281
|
method: 'sync create',
|
|
2282
|
-
example: "
|
|
2282
|
+
example: "llp pipelines:sync create \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2283
2283
|
},
|
|
2284
2284
|
},
|
|
2285
2285
|
},
|
|
@@ -2316,7 +2316,7 @@ const EMBEDDED_METHODS = [
|
|
|
2316
2316
|
},
|
|
2317
2317
|
cli: {
|
|
2318
2318
|
method: 'sync cancel',
|
|
2319
|
-
example: "
|
|
2319
|
+
example: "llp pipelines:sync cancel \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2320
2320
|
},
|
|
2321
2321
|
},
|
|
2322
2322
|
},
|
|
@@ -2353,7 +2353,7 @@ const EMBEDDED_METHODS = [
|
|
|
2353
2353
|
},
|
|
2354
2354
|
cli: {
|
|
2355
2355
|
method: 'data_sources get_data_sources',
|
|
2356
|
-
example: "
|
|
2356
|
+
example: "llp pipelines:data-sources get-data-sources \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2357
2357
|
},
|
|
2358
2358
|
},
|
|
2359
2359
|
},
|
|
@@ -2390,7 +2390,7 @@ const EMBEDDED_METHODS = [
|
|
|
2390
2390
|
},
|
|
2391
2391
|
cli: {
|
|
2392
2392
|
method: 'data_sources update_data_sources',
|
|
2393
|
-
example: "
|
|
2393
|
+
example: "llp pipelines:data-sources update-data-sources \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --body '{data_source_id: 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e}'",
|
|
2394
2394
|
},
|
|
2395
2395
|
},
|
|
2396
2396
|
},
|
|
@@ -2404,7 +2404,7 @@ const EMBEDDED_METHODS = [
|
|
|
2404
2404
|
qualified: 'client.pipelines.dataSources.update',
|
|
2405
2405
|
params: ['pipeline_id: string;', 'data_source_id: string;', 'sync_interval?: number;'],
|
|
2406
2406
|
response: "{ id: string; component: object | object | object | object | object | object | object | object | object | object | object | object; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: object; }",
|
|
2407
|
-
markdown: "## update\n\n`client.pipelines.dataSources.update(pipeline_id: string, data_source_id: string, sync_interval?: number): { id: string; component: object | cloud_s3_data_source | cloud_az_storage_blob_data_source | cloud_google_drive_data_source | cloud_one_drive_data_source | cloud_sharepoint_data_source | cloud_slack_data_source | cloud_notion_page_data_source | cloud_confluence_data_source | cloud_jira_data_source | cloud_jira_data_source_v2 | cloud_box_data_source; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: data_source_reader_version_metadata; }`\n\n**put** `/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}`\n\nUpdate the configuration of a data source in a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id: string`\n\n- `sync_interval?: number`\n The interval at which the data source should be synced.\n\n### Returns\n\n- `{ id: string; component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }; }`\n Schema for a data source in a pipeline.\n\n - `id: string`\n - `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n - `data_source_id: string`\n - `last_synced_at: string`\n - `name: string`\n - `pipeline_id: string`\n - `project_id: string`\n - `source_type: string`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'`\n - `status_updated_at?: string`\n - `sync_interval?: number`\n - `sync_schedule_set_by?: string`\n - `updated_at?: string`\n - `version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipelineDataSource = await client.pipelines.dataSources.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(pipelineDataSource);\n```",
|
|
2407
|
+
markdown: "## update\n\n`client.pipelines.dataSources.update(pipeline_id: string, data_source_id: string, sync_interval?: number): { id: string; component: object | cloud_s3_data_source | cloud_az_storage_blob_data_source | cloud_google_drive_data_source | cloud_one_drive_data_source | cloud_sharepoint_data_source | cloud_slack_data_source | cloud_notion_page_data_source | cloud_confluence_data_source | cloud_jira_data_source | cloud_jira_data_source_v2 | cloud_box_data_source; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: data_source_reader_version_metadata; }`\n\n**put** `/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}`\n\nUpdate the configuration of a data source in a pipeline.\n\n### Parameters\n\n- `pipeline_id: string`\n\n- `data_source_id: string`\n\n- `sync_interval?: number`\n The interval at which the data source should be synced.\n\n### Returns\n\n- `{ id: string; component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: failure_handling_config; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }; data_source_id: string; last_synced_at: string; name: string; pipeline_id: string; project_id: string; source_type: string; created_at?: string; custom_metadata?: object; status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'; status_updated_at?: string; sync_interval?: number; sync_schedule_set_by?: string; updated_at?: string; version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }; }`\n Schema for a data source in a pipeline.\n\n - `id: string`\n - `component: object | { bucket: string; aws_access_id?: string; aws_access_secret?: string; class_name?: string; prefix?: string; regex_pattern?: string; s3_endpoint_url?: string; supports_access_control?: boolean; } | { account_url: string; container_name: string; account_key?: string; account_name?: string; blob?: string; class_name?: string; client_id?: string; client_secret?: string; prefix?: string; supports_access_control?: boolean; tenant_id?: string; } | { folder_id: string; class_name?: string; folder_name?: string; service_account_key?: object; supports_access_control?: boolean; } | { client_id: string; client_secret: string; tenant_id: string; user_principal_name: string; class_name?: string; folder_id?: string; folder_path?: string; required_exts?: string[]; supports_access_control?: true; } | { client_id: string; client_secret: string; tenant_id: string; class_name?: string; drive_name?: string; exclude_path_patterns?: string[]; folder_id?: string; folder_path?: string; get_permissions?: boolean; include_path_patterns?: string[]; required_exts?: string[]; site_id?: string; site_name?: string; supports_access_control?: true; } | { slack_token: string; channel_ids?: string; channel_patterns?: string; class_name?: string; earliest_date?: string; earliest_date_timestamp?: number; latest_date?: string; latest_date_timestamp?: number; supports_access_control?: boolean; } | { integration_token: string; class_name?: string; database_ids?: string; page_ids?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; server_url: string; api_token?: string; class_name?: string; cql?: string; failure_handling?: { skip_list_failures?: boolean; }; index_restricted_pages?: boolean; keep_markdown_format?: boolean; label?: string; page_ids?: string; space_key?: string; supports_access_control?: boolean; sync_permissions?: boolean; user_name?: string; } | { authentication_mechanism: string; query: string; api_token?: string; class_name?: string; cloud_id?: string; email?: string; server_url?: string; supports_access_control?: boolean; } | { authentication_mechanism: string; query: string; server_url: string; api_token?: string; api_version?: '2' | '3'; class_name?: string; cloud_id?: string; email?: string; expand?: string; fields?: string[]; get_permissions?: boolean; requests_per_minute?: number; supports_access_control?: boolean; } | { authentication_mechanism: 'ccg' | 'developer_token'; class_name?: string; client_id?: string; client_secret?: string; developer_token?: string; enterprise_id?: string; folder_id?: string; supports_access_control?: boolean; user_id?: string; }`\n - `data_source_id: string`\n - `last_synced_at: string`\n - `name: string`\n - `pipeline_id: string`\n - `project_id: string`\n - `source_type: string`\n - `created_at?: string`\n - `custom_metadata?: object`\n - `status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'`\n - `status_updated_at?: string`\n - `sync_interval?: number`\n - `sync_schedule_set_by?: string`\n - `updated_at?: string`\n - `version_metadata?: { reader_version?: '1.0' | '2.0' | '2.1'; }`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst pipelineDataSource = await client.pipelines.dataSources.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });\n\nconsole.log(pipelineDataSource);\n```",
|
|
2408
2408
|
perLanguage: {
|
|
2409
2409
|
go: {
|
|
2410
2410
|
method: 'client.Pipelines.DataSources.Update',
|
|
@@ -2427,7 +2427,7 @@ const EMBEDDED_METHODS = [
|
|
|
2427
2427
|
},
|
|
2428
2428
|
cli: {
|
|
2429
2429
|
method: 'data_sources update',
|
|
2430
|
-
example: "
|
|
2430
|
+
example: "llp pipelines:data-sources update \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --data-source-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2431
2431
|
},
|
|
2432
2432
|
},
|
|
2433
2433
|
},
|
|
@@ -2464,7 +2464,7 @@ const EMBEDDED_METHODS = [
|
|
|
2464
2464
|
},
|
|
2465
2465
|
cli: {
|
|
2466
2466
|
method: 'data_sources get_status',
|
|
2467
|
-
example: "
|
|
2467
|
+
example: "llp pipelines:data-sources get-status \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --data-source-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2468
2468
|
},
|
|
2469
2469
|
},
|
|
2470
2470
|
},
|
|
@@ -2501,7 +2501,7 @@ const EMBEDDED_METHODS = [
|
|
|
2501
2501
|
},
|
|
2502
2502
|
cli: {
|
|
2503
2503
|
method: 'data_sources sync',
|
|
2504
|
-
example: "
|
|
2504
|
+
example: "llp pipelines:data-sources sync \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --data-source-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2505
2505
|
},
|
|
2506
2506
|
},
|
|
2507
2507
|
},
|
|
@@ -2538,7 +2538,7 @@ const EMBEDDED_METHODS = [
|
|
|
2538
2538
|
},
|
|
2539
2539
|
cli: {
|
|
2540
2540
|
method: 'images list_page_screenshots',
|
|
2541
|
-
example: "
|
|
2541
|
+
example: "llp pipelines:images list-page-screenshots \\\n --api-key 'My API Key' \\\n --id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2542
2542
|
},
|
|
2543
2543
|
},
|
|
2544
2544
|
},
|
|
@@ -2575,7 +2575,7 @@ const EMBEDDED_METHODS = [
|
|
|
2575
2575
|
},
|
|
2576
2576
|
cli: {
|
|
2577
2577
|
method: 'images get_page_screenshot',
|
|
2578
|
-
example: "
|
|
2578
|
+
example: "llp pipelines:images get-page-screenshot \\\n --api-key 'My API Key' \\\n --id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --page-index 0",
|
|
2579
2579
|
},
|
|
2580
2580
|
},
|
|
2581
2581
|
},
|
|
@@ -2618,7 +2618,7 @@ const EMBEDDED_METHODS = [
|
|
|
2618
2618
|
},
|
|
2619
2619
|
cli: {
|
|
2620
2620
|
method: 'images get_page_figure',
|
|
2621
|
-
example: "
|
|
2621
|
+
example: "llp pipelines:images get-page-figure \\\n --api-key 'My API Key' \\\n --id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --page-index 0 \\\n --figure-name figure_name",
|
|
2622
2622
|
},
|
|
2623
2623
|
},
|
|
2624
2624
|
},
|
|
@@ -2655,7 +2655,7 @@ const EMBEDDED_METHODS = [
|
|
|
2655
2655
|
},
|
|
2656
2656
|
cli: {
|
|
2657
2657
|
method: 'images list_page_figures',
|
|
2658
|
-
example: "
|
|
2658
|
+
example: "llp pipelines:images list-page-figures \\\n --api-key 'My API Key' \\\n --id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2659
2659
|
},
|
|
2660
2660
|
},
|
|
2661
2661
|
},
|
|
@@ -2692,7 +2692,7 @@ const EMBEDDED_METHODS = [
|
|
|
2692
2692
|
},
|
|
2693
2693
|
cli: {
|
|
2694
2694
|
method: 'files get_status_counts',
|
|
2695
|
-
example: "
|
|
2695
|
+
example: "llp pipelines:files get-status-counts \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2696
2696
|
},
|
|
2697
2697
|
},
|
|
2698
2698
|
},
|
|
@@ -2729,7 +2729,7 @@ const EMBEDDED_METHODS = [
|
|
|
2729
2729
|
},
|
|
2730
2730
|
cli: {
|
|
2731
2731
|
method: 'files get_status',
|
|
2732
|
-
example: "
|
|
2732
|
+
example: "llp pipelines:files get-status \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --file-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2733
2733
|
},
|
|
2734
2734
|
},
|
|
2735
2735
|
},
|
|
@@ -2766,7 +2766,7 @@ const EMBEDDED_METHODS = [
|
|
|
2766
2766
|
},
|
|
2767
2767
|
cli: {
|
|
2768
2768
|
method: 'files create',
|
|
2769
|
-
example: "
|
|
2769
|
+
example: "llp pipelines:files create \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --body '{file_id: 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e}'",
|
|
2770
2770
|
},
|
|
2771
2771
|
},
|
|
2772
2772
|
},
|
|
@@ -2803,7 +2803,7 @@ const EMBEDDED_METHODS = [
|
|
|
2803
2803
|
},
|
|
2804
2804
|
cli: {
|
|
2805
2805
|
method: 'files update',
|
|
2806
|
-
example: "
|
|
2806
|
+
example: "llp pipelines:files update \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --file-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2807
2807
|
},
|
|
2808
2808
|
},
|
|
2809
2809
|
},
|
|
@@ -2839,7 +2839,7 @@ const EMBEDDED_METHODS = [
|
|
|
2839
2839
|
},
|
|
2840
2840
|
cli: {
|
|
2841
2841
|
method: 'files delete',
|
|
2842
|
-
example: "
|
|
2842
|
+
example: "llp pipelines:files delete \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --file-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2843
2843
|
},
|
|
2844
2844
|
},
|
|
2845
2845
|
},
|
|
@@ -2885,7 +2885,7 @@ const EMBEDDED_METHODS = [
|
|
|
2885
2885
|
},
|
|
2886
2886
|
cli: {
|
|
2887
2887
|
method: 'files list',
|
|
2888
|
-
example: "
|
|
2888
|
+
example: "llp pipelines:files list \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2889
2889
|
},
|
|
2890
2890
|
},
|
|
2891
2891
|
},
|
|
@@ -2922,7 +2922,7 @@ const EMBEDDED_METHODS = [
|
|
|
2922
2922
|
},
|
|
2923
2923
|
cli: {
|
|
2924
2924
|
method: 'metadata create',
|
|
2925
|
-
example: "
|
|
2925
|
+
example: "llp pipelines:metadata create \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --upload-file 'Example data'",
|
|
2926
2926
|
},
|
|
2927
2927
|
},
|
|
2928
2928
|
},
|
|
@@ -2958,7 +2958,7 @@ const EMBEDDED_METHODS = [
|
|
|
2958
2958
|
},
|
|
2959
2959
|
cli: {
|
|
2960
2960
|
method: 'metadata delete_all',
|
|
2961
|
-
example: "
|
|
2961
|
+
example: "llp pipelines:metadata delete-all \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2962
2962
|
},
|
|
2963
2963
|
},
|
|
2964
2964
|
},
|
|
@@ -2998,7 +2998,7 @@ const EMBEDDED_METHODS = [
|
|
|
2998
2998
|
},
|
|
2999
2999
|
cli: {
|
|
3000
3000
|
method: 'documents create',
|
|
3001
|
-
example: "
|
|
3001
|
+
example: "llp pipelines:documents create \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --body '{metadata: {foo: bar}, text: text}'",
|
|
3002
3002
|
},
|
|
3003
3003
|
},
|
|
3004
3004
|
},
|
|
@@ -3043,7 +3043,7 @@ const EMBEDDED_METHODS = [
|
|
|
3043
3043
|
},
|
|
3044
3044
|
cli: {
|
|
3045
3045
|
method: 'documents list',
|
|
3046
|
-
example: "
|
|
3046
|
+
example: "llp pipelines:documents list \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
3047
3047
|
},
|
|
3048
3048
|
},
|
|
3049
3049
|
},
|
|
@@ -3080,7 +3080,7 @@ const EMBEDDED_METHODS = [
|
|
|
3080
3080
|
},
|
|
3081
3081
|
cli: {
|
|
3082
3082
|
method: 'documents get',
|
|
3083
|
-
example: "
|
|
3083
|
+
example: "llp pipelines:documents get \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --document-id document_id",
|
|
3084
3084
|
},
|
|
3085
3085
|
},
|
|
3086
3086
|
},
|
|
@@ -3116,7 +3116,7 @@ const EMBEDDED_METHODS = [
|
|
|
3116
3116
|
},
|
|
3117
3117
|
cli: {
|
|
3118
3118
|
method: 'documents delete',
|
|
3119
|
-
example: "
|
|
3119
|
+
example: "llp pipelines:documents delete \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --document-id document_id",
|
|
3120
3120
|
},
|
|
3121
3121
|
},
|
|
3122
3122
|
},
|
|
@@ -3153,7 +3153,7 @@ const EMBEDDED_METHODS = [
|
|
|
3153
3153
|
},
|
|
3154
3154
|
cli: {
|
|
3155
3155
|
method: 'documents get_status',
|
|
3156
|
-
example: "
|
|
3156
|
+
example: "llp pipelines:documents get-status \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --document-id document_id",
|
|
3157
3157
|
},
|
|
3158
3158
|
},
|
|
3159
3159
|
},
|
|
@@ -3190,7 +3190,7 @@ const EMBEDDED_METHODS = [
|
|
|
3190
3190
|
},
|
|
3191
3191
|
cli: {
|
|
3192
3192
|
method: 'documents sync',
|
|
3193
|
-
example: "
|
|
3193
|
+
example: "llp pipelines:documents sync \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --document-id document_id",
|
|
3194
3194
|
},
|
|
3195
3195
|
},
|
|
3196
3196
|
},
|
|
@@ -3227,7 +3227,7 @@ const EMBEDDED_METHODS = [
|
|
|
3227
3227
|
},
|
|
3228
3228
|
cli: {
|
|
3229
3229
|
method: 'documents get_chunks',
|
|
3230
|
-
example: "
|
|
3230
|
+
example: "llp pipelines:documents get-chunks \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --document-id document_id",
|
|
3231
3231
|
},
|
|
3232
3232
|
},
|
|
3233
3233
|
},
|
|
@@ -3267,7 +3267,7 @@ const EMBEDDED_METHODS = [
|
|
|
3267
3267
|
},
|
|
3268
3268
|
cli: {
|
|
3269
3269
|
method: 'documents upsert',
|
|
3270
|
-
example: "
|
|
3270
|
+
example: "llp pipelines:documents upsert \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --body '{metadata: {foo: bar}, text: text}'",
|
|
3271
3271
|
},
|
|
3272
3272
|
},
|
|
3273
3273
|
},
|
|
@@ -3309,7 +3309,7 @@ const EMBEDDED_METHODS = [
|
|
|
3309
3309
|
},
|
|
3310
3310
|
cli: {
|
|
3311
3311
|
method: 'retrievers create',
|
|
3312
|
-
example: "
|
|
3312
|
+
example: "llp retrievers create \\\n --api-key 'My API Key' \\\n --name x",
|
|
3313
3313
|
},
|
|
3314
3314
|
},
|
|
3315
3315
|
},
|
|
@@ -3351,7 +3351,7 @@ const EMBEDDED_METHODS = [
|
|
|
3351
3351
|
},
|
|
3352
3352
|
cli: {
|
|
3353
3353
|
method: 'retrievers upsert',
|
|
3354
|
-
example: "
|
|
3354
|
+
example: "llp retrievers upsert \\\n --api-key 'My API Key' \\\n --name x",
|
|
3355
3355
|
},
|
|
3356
3356
|
},
|
|
3357
3357
|
},
|
|
@@ -3388,7 +3388,7 @@ const EMBEDDED_METHODS = [
|
|
|
3388
3388
|
},
|
|
3389
3389
|
cli: {
|
|
3390
3390
|
method: 'retrievers list',
|
|
3391
|
-
example: "
|
|
3391
|
+
example: "llp retrievers list \\\n --api-key 'My API Key'",
|
|
3392
3392
|
},
|
|
3393
3393
|
},
|
|
3394
3394
|
},
|
|
@@ -3425,7 +3425,7 @@ const EMBEDDED_METHODS = [
|
|
|
3425
3425
|
},
|
|
3426
3426
|
cli: {
|
|
3427
3427
|
method: 'retrievers get',
|
|
3428
|
-
example: "
|
|
3428
|
+
example: "llp retrievers get \\\n --api-key 'My API Key' \\\n --retriever-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
3429
3429
|
},
|
|
3430
3430
|
},
|
|
3431
3431
|
},
|
|
@@ -3468,7 +3468,7 @@ const EMBEDDED_METHODS = [
|
|
|
3468
3468
|
},
|
|
3469
3469
|
cli: {
|
|
3470
3470
|
method: 'retrievers update',
|
|
3471
|
-
example: "
|
|
3471
|
+
example: "llp retrievers update \\\n --api-key 'My API Key' \\\n --retriever-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --pipeline '{description: description, name: x, pipeline_id: 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e}'",
|
|
3472
3472
|
},
|
|
3473
3473
|
},
|
|
3474
3474
|
},
|
|
@@ -3504,7 +3504,7 @@ const EMBEDDED_METHODS = [
|
|
|
3504
3504
|
},
|
|
3505
3505
|
cli: {
|
|
3506
3506
|
method: 'retrievers delete',
|
|
3507
|
-
example: "
|
|
3507
|
+
example: "llp retrievers delete \\\n --api-key 'My API Key' \\\n --retriever-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
3508
3508
|
},
|
|
3509
3509
|
},
|
|
3510
3510
|
},
|
|
@@ -3549,7 +3549,7 @@ const EMBEDDED_METHODS = [
|
|
|
3549
3549
|
},
|
|
3550
3550
|
cli: {
|
|
3551
3551
|
method: 'retrievers search',
|
|
3552
|
-
example: "
|
|
3552
|
+
example: "llp retrievers search \\\n --api-key 'My API Key' \\\n --query x",
|
|
3553
3553
|
},
|
|
3554
3554
|
},
|
|
3555
3555
|
},
|
|
@@ -3590,7 +3590,7 @@ const EMBEDDED_METHODS = [
|
|
|
3590
3590
|
},
|
|
3591
3591
|
cli: {
|
|
3592
3592
|
method: 'retriever search',
|
|
3593
|
-
example: "
|
|
3593
|
+
example: "llp retrievers:retriever search \\\n --api-key 'My API Key' \\\n --retriever-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --query x",
|
|
3594
3594
|
},
|
|
3595
3595
|
},
|
|
3596
3596
|
},
|
|
@@ -3627,7 +3627,7 @@ const EMBEDDED_METHODS = [
|
|
|
3627
3627
|
},
|
|
3628
3628
|
cli: {
|
|
3629
3629
|
method: 'indexes get',
|
|
3630
|
-
example: "
|
|
3630
|
+
example: "llp beta:indexes get \\\n --api-key 'My API Key' \\\n --index-id index_id",
|
|
3631
3631
|
},
|
|
3632
3632
|
},
|
|
3633
3633
|
},
|
|
@@ -3663,7 +3663,7 @@ const EMBEDDED_METHODS = [
|
|
|
3663
3663
|
},
|
|
3664
3664
|
cli: {
|
|
3665
3665
|
method: 'indexes delete',
|
|
3666
|
-
example: "
|
|
3666
|
+
example: "llp beta:indexes delete \\\n --api-key 'My API Key' \\\n --index-id index_id",
|
|
3667
3667
|
},
|
|
3668
3668
|
},
|
|
3669
3669
|
},
|
|
@@ -3710,7 +3710,7 @@ const EMBEDDED_METHODS = [
|
|
|
3710
3710
|
},
|
|
3711
3711
|
cli: {
|
|
3712
3712
|
method: 'indexes create',
|
|
3713
|
-
example: "
|
|
3713
|
+
example: "llp beta:indexes create \\\n --api-key 'My API Key' \\\n --source-directory-id dir-abc123",
|
|
3714
3714
|
},
|
|
3715
3715
|
},
|
|
3716
3716
|
},
|
|
@@ -3747,7 +3747,7 @@ const EMBEDDED_METHODS = [
|
|
|
3747
3747
|
},
|
|
3748
3748
|
cli: {
|
|
3749
3749
|
method: 'indexes sync',
|
|
3750
|
-
example: "
|
|
3750
|
+
example: "llp beta:indexes sync \\\n --api-key 'My API Key' \\\n --index-id index_id",
|
|
3751
3751
|
},
|
|
3752
3752
|
},
|
|
3753
3753
|
},
|
|
@@ -3790,7 +3790,7 @@ const EMBEDDED_METHODS = [
|
|
|
3790
3790
|
},
|
|
3791
3791
|
cli: {
|
|
3792
3792
|
method: 'indexes list',
|
|
3793
|
-
example: "
|
|
3793
|
+
example: "llp beta:indexes list \\\n --api-key 'My API Key'",
|
|
3794
3794
|
},
|
|
3795
3795
|
},
|
|
3796
3796
|
},
|
|
@@ -3840,7 +3840,7 @@ const EMBEDDED_METHODS = [
|
|
|
3840
3840
|
},
|
|
3841
3841
|
cli: {
|
|
3842
3842
|
method: 'retrieval retrieve',
|
|
3843
|
-
example: "
|
|
3843
|
+
example: "llp beta:retrieval retrieve \\\n --api-key 'My API Key' \\\n --index-id idx-abc123 \\\n --query 'What are the key findings?'",
|
|
3844
3844
|
},
|
|
3845
3845
|
},
|
|
3846
3846
|
},
|
|
@@ -3885,7 +3885,7 @@ const EMBEDDED_METHODS = [
|
|
|
3885
3885
|
},
|
|
3886
3886
|
cli: {
|
|
3887
3887
|
method: 'retrieval find',
|
|
3888
|
-
example: "
|
|
3888
|
+
example: "llp beta:retrieval find \\\n --api-key 'My API Key' \\\n --index-id idx-abc123",
|
|
3889
3889
|
},
|
|
3890
3890
|
},
|
|
3891
3891
|
},
|
|
@@ -3931,7 +3931,7 @@ const EMBEDDED_METHODS = [
|
|
|
3931
3931
|
},
|
|
3932
3932
|
cli: {
|
|
3933
3933
|
method: 'retrieval grep',
|
|
3934
|
-
example: "
|
|
3934
|
+
example: "llp beta:retrieval grep \\\n --api-key 'My API Key' \\\n --file-id file_id \\\n --index-id idx-abc123 \\\n --pattern 'revenue|profit'",
|
|
3935
3935
|
},
|
|
3936
3936
|
},
|
|
3937
3937
|
},
|
|
@@ -3975,7 +3975,7 @@ const EMBEDDED_METHODS = [
|
|
|
3975
3975
|
},
|
|
3976
3976
|
cli: {
|
|
3977
3977
|
method: 'retrieval read',
|
|
3978
|
-
example: "
|
|
3978
|
+
example: "llp beta:retrieval read \\\n --api-key 'My API Key' \\\n --file-id file_id \\\n --index-id idx-abc123",
|
|
3979
3979
|
},
|
|
3980
3980
|
},
|
|
3981
3981
|
},
|
|
@@ -4017,7 +4017,7 @@ const EMBEDDED_METHODS = [
|
|
|
4017
4017
|
},
|
|
4018
4018
|
cli: {
|
|
4019
4019
|
method: 'chat list',
|
|
4020
|
-
example: "
|
|
4020
|
+
example: "llp beta:chat list \\\n --api-key 'My API Key'",
|
|
4021
4021
|
},
|
|
4022
4022
|
},
|
|
4023
4023
|
},
|
|
@@ -4054,7 +4054,7 @@ const EMBEDDED_METHODS = [
|
|
|
4054
4054
|
},
|
|
4055
4055
|
cli: {
|
|
4056
4056
|
method: 'chat create',
|
|
4057
|
-
example: "
|
|
4057
|
+
example: "llp beta:chat create \\\n --api-key 'My API Key'",
|
|
4058
4058
|
},
|
|
4059
4059
|
},
|
|
4060
4060
|
},
|
|
@@ -4091,7 +4091,7 @@ const EMBEDDED_METHODS = [
|
|
|
4091
4091
|
},
|
|
4092
4092
|
cli: {
|
|
4093
4093
|
method: 'chat retrieve',
|
|
4094
|
-
example: "
|
|
4094
|
+
example: "llp beta:chat retrieve \\\n --api-key 'My API Key' \\\n --session-id session_id",
|
|
4095
4095
|
},
|
|
4096
4096
|
},
|
|
4097
4097
|
},
|
|
@@ -4127,7 +4127,7 @@ const EMBEDDED_METHODS = [
|
|
|
4127
4127
|
},
|
|
4128
4128
|
cli: {
|
|
4129
4129
|
method: 'chat delete',
|
|
4130
|
-
example: "
|
|
4130
|
+
example: "llp beta:chat delete \\\n --api-key 'My API Key' \\\n --session-id session_id",
|
|
4131
4131
|
},
|
|
4132
4132
|
},
|
|
4133
4133
|
},
|
|
@@ -4164,7 +4164,7 @@ const EMBEDDED_METHODS = [
|
|
|
4164
4164
|
},
|
|
4165
4165
|
cli: {
|
|
4166
4166
|
method: 'chat get_summary',
|
|
4167
|
-
example: "
|
|
4167
|
+
example: "llp beta:chat get-summary \\\n --api-key 'My API Key' \\\n --session-id session_id",
|
|
4168
4168
|
},
|
|
4169
4169
|
},
|
|
4170
4170
|
},
|
|
@@ -4207,7 +4207,7 @@ const EMBEDDED_METHODS = [
|
|
|
4207
4207
|
},
|
|
4208
4208
|
cli: {
|
|
4209
4209
|
method: 'chat stream',
|
|
4210
|
-
example: "
|
|
4210
|
+
example: "llp beta:chat stream \\\n --api-key 'My API Key' \\\n --session-id session_id \\\n --index-id idx-abc123 \\\n --index-id idx-def456 \\\n --prompt 'What were the main findings in Q3?'",
|
|
4211
4211
|
},
|
|
4212
4212
|
},
|
|
4213
4213
|
},
|
|
@@ -4244,7 +4244,7 @@ const EMBEDDED_METHODS = [
|
|
|
4244
4244
|
},
|
|
4245
4245
|
cli: {
|
|
4246
4246
|
method: 'agent_data get',
|
|
4247
|
-
example: "
|
|
4247
|
+
example: "llp beta:agent-data get \\\n --api-key 'My API Key' \\\n --item-id item_id",
|
|
4248
4248
|
},
|
|
4249
4249
|
},
|
|
4250
4250
|
},
|
|
@@ -4281,7 +4281,7 @@ const EMBEDDED_METHODS = [
|
|
|
4281
4281
|
},
|
|
4282
4282
|
cli: {
|
|
4283
4283
|
method: 'agent_data update',
|
|
4284
|
-
example: "
|
|
4284
|
+
example: "llp beta:agent-data update \\\n --api-key 'My API Key' \\\n --item-id item_id \\\n --data '{foo: bar}'",
|
|
4285
4285
|
},
|
|
4286
4286
|
},
|
|
4287
4287
|
},
|
|
@@ -4318,7 +4318,7 @@ const EMBEDDED_METHODS = [
|
|
|
4318
4318
|
},
|
|
4319
4319
|
cli: {
|
|
4320
4320
|
method: 'agent_data delete',
|
|
4321
|
-
example: "
|
|
4321
|
+
example: "llp beta:agent-data delete \\\n --api-key 'My API Key' \\\n --item-id item_id",
|
|
4322
4322
|
},
|
|
4323
4323
|
},
|
|
4324
4324
|
},
|
|
@@ -4361,7 +4361,7 @@ const EMBEDDED_METHODS = [
|
|
|
4361
4361
|
},
|
|
4362
4362
|
cli: {
|
|
4363
4363
|
method: 'agent_data create',
|
|
4364
|
-
example: "
|
|
4364
|
+
example: "llp beta:agent-data create \\\n --api-key 'My API Key' \\\n --data '{foo: bar}' \\\n --deployment-name deployment_name",
|
|
4365
4365
|
},
|
|
4366
4366
|
},
|
|
4367
4367
|
},
|
|
@@ -4409,7 +4409,7 @@ const EMBEDDED_METHODS = [
|
|
|
4409
4409
|
},
|
|
4410
4410
|
cli: {
|
|
4411
4411
|
method: 'agent_data search',
|
|
4412
|
-
example: "
|
|
4412
|
+
example: "llp beta:agent-data search \\\n --api-key 'My API Key' \\\n --deployment-name deployment_name",
|
|
4413
4413
|
},
|
|
4414
4414
|
},
|
|
4415
4415
|
},
|
|
@@ -4459,7 +4459,7 @@ const EMBEDDED_METHODS = [
|
|
|
4459
4459
|
},
|
|
4460
4460
|
cli: {
|
|
4461
4461
|
method: 'agent_data aggregate',
|
|
4462
|
-
example: "
|
|
4462
|
+
example: "llp beta:agent-data aggregate \\\n --api-key 'My API Key' \\\n --deployment-name deployment_name",
|
|
4463
4463
|
},
|
|
4464
4464
|
},
|
|
4465
4465
|
},
|
|
@@ -4502,7 +4502,7 @@ const EMBEDDED_METHODS = [
|
|
|
4502
4502
|
},
|
|
4503
4503
|
cli: {
|
|
4504
4504
|
method: 'agent_data delete_by_query',
|
|
4505
|
-
example: "
|
|
4505
|
+
example: "llp beta:agent-data delete-by-query \\\n --api-key 'My API Key' \\\n --deployment-name deployment_name",
|
|
4506
4506
|
},
|
|
4507
4507
|
},
|
|
4508
4508
|
},
|
|
@@ -4547,7 +4547,7 @@ const EMBEDDED_METHODS = [
|
|
|
4547
4547
|
},
|
|
4548
4548
|
cli: {
|
|
4549
4549
|
method: 'sheets create',
|
|
4550
|
-
example: "
|
|
4550
|
+
example: "llp beta:sheets create \\\n --api-key 'My API Key' \\\n --file-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
4551
4551
|
},
|
|
4552
4552
|
},
|
|
4553
4553
|
},
|
|
@@ -4595,7 +4595,7 @@ const EMBEDDED_METHODS = [
|
|
|
4595
4595
|
},
|
|
4596
4596
|
cli: {
|
|
4597
4597
|
method: 'sheets list',
|
|
4598
|
-
example: "
|
|
4598
|
+
example: "llp beta:sheets list \\\n --api-key 'My API Key'",
|
|
4599
4599
|
},
|
|
4600
4600
|
},
|
|
4601
4601
|
},
|
|
@@ -4638,7 +4638,7 @@ const EMBEDDED_METHODS = [
|
|
|
4638
4638
|
},
|
|
4639
4639
|
cli: {
|
|
4640
4640
|
method: 'sheets get',
|
|
4641
|
-
example: "
|
|
4641
|
+
example: "llp beta:sheets get \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id",
|
|
4642
4642
|
},
|
|
4643
4643
|
},
|
|
4644
4644
|
},
|
|
@@ -4682,7 +4682,7 @@ const EMBEDDED_METHODS = [
|
|
|
4682
4682
|
},
|
|
4683
4683
|
cli: {
|
|
4684
4684
|
method: 'sheets get_result_table',
|
|
4685
|
-
example: "
|
|
4685
|
+
example: "llp beta:sheets get-result-table \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id \\\n --region-id region_id \\\n --region-type cell_metadata",
|
|
4686
4686
|
},
|
|
4687
4687
|
},
|
|
4688
4688
|
},
|
|
@@ -4719,7 +4719,7 @@ const EMBEDDED_METHODS = [
|
|
|
4719
4719
|
},
|
|
4720
4720
|
cli: {
|
|
4721
4721
|
method: 'sheets delete_job',
|
|
4722
|
-
example: "
|
|
4722
|
+
example: "llp beta:sheets delete-job \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id",
|
|
4723
4723
|
},
|
|
4724
4724
|
},
|
|
4725
4725
|
},
|
|
@@ -4739,8 +4739,8 @@ const EMBEDDED_METHODS = [
|
|
|
4739
4739
|
'system_metadata?: object;',
|
|
4740
4740
|
"type?: 'ephemeral' | 'user';",
|
|
4741
4741
|
],
|
|
4742
|
-
response: "{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | '
|
|
4743
|
-
markdown: "## create\n\n`client.beta.directories.create(name: string, organization_id?: string, project_id?: string, description?: string, system_metadata?: object, type?: 'ephemeral' | 'user'): { id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | '
|
|
4742
|
+
response: "{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | 'user'; updated_at?: string; }",
|
|
4743
|
+
markdown: "## create\n\n`client.beta.directories.create(name: string, organization_id?: string, project_id?: string, description?: string, system_metadata?: object, type?: 'ephemeral' | 'user'): { id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | 'user'; updated_at?: string; }`\n\n**post** `/api/v1/beta/directories`\n\nCreate a new directory within the specified project.\n\n### Parameters\n\n- `name: string`\n Human-readable name for the directory.\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `description?: string`\n Optional description shown to users.\n\n- `system_metadata?: object`\n Reserved system-managed metadata.\n\n- `type?: 'ephemeral' | 'user'`\n Directory type. Use 'ephemeral' for batch processing with automatic cleanup.\n\n### Returns\n\n- `{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | 'user'; updated_at?: string; }`\n API response schema for a directory.\n\n - `id: string`\n - `name: string`\n - `project_id: string`\n - `created_at?: string`\n - `deleted_at?: string`\n - `description?: string`\n - `expires_at?: string`\n - `system_metadata?: object`\n - `type?: 'ephemeral' | 'index' | 'user'`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst directory = await client.beta.directories.create({ name: 'x' });\n\nconsole.log(directory);\n```",
|
|
4744
4744
|
perLanguage: {
|
|
4745
4745
|
go: {
|
|
4746
4746
|
method: 'client.Beta.Directories.New',
|
|
@@ -4763,7 +4763,7 @@ const EMBEDDED_METHODS = [
|
|
|
4763
4763
|
},
|
|
4764
4764
|
cli: {
|
|
4765
4765
|
method: 'directories create',
|
|
4766
|
-
example: "
|
|
4766
|
+
example: "llp beta:directories create \\\n --api-key 'My API Key' \\\n --name x",
|
|
4767
4767
|
},
|
|
4768
4768
|
},
|
|
4769
4769
|
},
|
|
@@ -4785,8 +4785,8 @@ const EMBEDDED_METHODS = [
|
|
|
4785
4785
|
"type?: 'ephemeral' | 'index' | 'user';",
|
|
4786
4786
|
"types?: 'ephemeral' | 'index' | 'user'[];",
|
|
4787
4787
|
],
|
|
4788
|
-
response: "{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | '
|
|
4789
|
-
markdown: "## list\n\n`client.beta.directories.list(include_deleted?: boolean, name?: string, organization_id?: string, page_size?: number, page_token?: string, project_id?: string, type?: 'ephemeral' | 'index' | 'user', types?: 'ephemeral' | 'index' | 'user'[]): { id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | '
|
|
4788
|
+
response: "{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | 'user'; updated_at?: string; }",
|
|
4789
|
+
markdown: "## list\n\n`client.beta.directories.list(include_deleted?: boolean, name?: string, organization_id?: string, page_size?: number, page_token?: string, project_id?: string, type?: 'ephemeral' | 'index' | 'user', types?: 'ephemeral' | 'index' | 'user'[]): { id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | 'user'; updated_at?: string; }`\n\n**get** `/api/v1/beta/directories`\n\nList Directories\n\n### Parameters\n\n- `include_deleted?: boolean`\n Include deleted directories.\n\n- `name?: string`\n Directory name to match.\n\n- `organization_id?: string`\n\n- `page_size?: number`\n\n- `page_token?: string`\n\n- `project_id?: string`\n\n- `type?: 'ephemeral' | 'index' | 'user'`\n Directory type to include.\n\n- `types?: 'ephemeral' | 'index' | 'user'[]`\n Filter by one or more directory types. Repeat the parameter for multiple values.\n\n### Returns\n\n- `{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | 'user'; updated_at?: string; }`\n API response schema for a directory.\n\n - `id: string`\n - `name: string`\n - `project_id: string`\n - `created_at?: string`\n - `deleted_at?: string`\n - `description?: string`\n - `expires_at?: string`\n - `system_metadata?: object`\n - `type?: 'ephemeral' | 'index' | 'user'`\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 directoryListResponse of client.beta.directories.list()) {\n console.log(directoryListResponse);\n}\n```",
|
|
4790
4790
|
perLanguage: {
|
|
4791
4791
|
go: {
|
|
4792
4792
|
method: 'client.Beta.Directories.List',
|
|
@@ -4809,7 +4809,7 @@ const EMBEDDED_METHODS = [
|
|
|
4809
4809
|
},
|
|
4810
4810
|
cli: {
|
|
4811
4811
|
method: 'directories list',
|
|
4812
|
-
example: "
|
|
4812
|
+
example: "llp beta:directories list \\\n --api-key 'My API Key'",
|
|
4813
4813
|
},
|
|
4814
4814
|
},
|
|
4815
4815
|
},
|
|
@@ -4822,8 +4822,8 @@ const EMBEDDED_METHODS = [
|
|
|
4822
4822
|
stainlessPath: '(resource) beta.directories > (method) get',
|
|
4823
4823
|
qualified: 'client.beta.directories.get',
|
|
4824
4824
|
params: ['directory_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
4825
|
-
response: "{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | '
|
|
4826
|
-
markdown: "## get\n\n`client.beta.directories.get(directory_id: string, organization_id?: string, project_id?: string): { id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | '
|
|
4825
|
+
response: "{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | 'user'; updated_at?: string; }",
|
|
4826
|
+
markdown: "## get\n\n`client.beta.directories.get(directory_id: string, organization_id?: string, project_id?: string): { id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | 'user'; updated_at?: string; }`\n\n**get** `/api/v1/beta/directories/{directory_id}`\n\nRetrieve a directory by its identifier.\n\n### Parameters\n\n- `directory_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n### Returns\n\n- `{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | 'user'; updated_at?: string; }`\n API response schema for a directory.\n\n - `id: string`\n - `name: string`\n - `project_id: string`\n - `created_at?: string`\n - `deleted_at?: string`\n - `description?: string`\n - `expires_at?: string`\n - `system_metadata?: object`\n - `type?: 'ephemeral' | 'index' | 'user'`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst directory = await client.beta.directories.get('directory_id');\n\nconsole.log(directory);\n```",
|
|
4827
4827
|
perLanguage: {
|
|
4828
4828
|
go: {
|
|
4829
4829
|
method: 'client.Beta.Directories.Get',
|
|
@@ -4846,7 +4846,7 @@ const EMBEDDED_METHODS = [
|
|
|
4846
4846
|
},
|
|
4847
4847
|
cli: {
|
|
4848
4848
|
method: 'directories get',
|
|
4849
|
-
example: "
|
|
4849
|
+
example: "llp beta:directories get \\\n --api-key 'My API Key' \\\n --directory-id directory_id",
|
|
4850
4850
|
},
|
|
4851
4851
|
},
|
|
4852
4852
|
},
|
|
@@ -4865,8 +4865,8 @@ const EMBEDDED_METHODS = [
|
|
|
4865
4865
|
'description?: string;',
|
|
4866
4866
|
'name?: string;',
|
|
4867
4867
|
],
|
|
4868
|
-
response: "{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | '
|
|
4869
|
-
markdown: "## update\n\n`client.beta.directories.update(directory_id: string, organization_id?: string, project_id?: string, description?: string, name?: string): { id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | '
|
|
4868
|
+
response: "{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | 'user'; updated_at?: string; }",
|
|
4869
|
+
markdown: "## update\n\n`client.beta.directories.update(directory_id: string, organization_id?: string, project_id?: string, description?: string, name?: string): { id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | 'user'; updated_at?: string; }`\n\n**patch** `/api/v1/beta/directories/{directory_id}`\n\nUpdate directory metadata.\n\n### Parameters\n\n- `directory_id: string`\n\n- `organization_id?: string`\n\n- `project_id?: string`\n\n- `description?: string`\n Updated description for the directory.\n\n- `name?: string`\n Updated name for the directory.\n\n### Returns\n\n- `{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | 'user'; updated_at?: string; }`\n API response schema for a directory.\n\n - `id: string`\n - `name: string`\n - `project_id: string`\n - `created_at?: string`\n - `deleted_at?: string`\n - `description?: string`\n - `expires_at?: string`\n - `system_metadata?: object`\n - `type?: 'ephemeral' | 'index' | 'user'`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport LlamaCloud from '@llamaindex/llama-cloud';\n\nconst client = new LlamaCloud();\n\nconst directory = await client.beta.directories.update('directory_id');\n\nconsole.log(directory);\n```",
|
|
4870
4870
|
perLanguage: {
|
|
4871
4871
|
go: {
|
|
4872
4872
|
method: 'client.Beta.Directories.Update',
|
|
@@ -4889,7 +4889,7 @@ const EMBEDDED_METHODS = [
|
|
|
4889
4889
|
},
|
|
4890
4890
|
cli: {
|
|
4891
4891
|
method: 'directories update',
|
|
4892
|
-
example: "
|
|
4892
|
+
example: "llp beta:directories update \\\n --api-key 'My API Key' \\\n --directory-id directory_id",
|
|
4893
4893
|
},
|
|
4894
4894
|
},
|
|
4895
4895
|
},
|
|
@@ -4925,7 +4925,7 @@ const EMBEDDED_METHODS = [
|
|
|
4925
4925
|
},
|
|
4926
4926
|
cli: {
|
|
4927
4927
|
method: 'directories delete',
|
|
4928
|
-
example: "
|
|
4928
|
+
example: "llp beta:directories delete \\\n --api-key 'My API Key' \\\n --directory-id directory_id",
|
|
4929
4929
|
},
|
|
4930
4930
|
},
|
|
4931
4931
|
},
|
|
@@ -4970,7 +4970,7 @@ const EMBEDDED_METHODS = [
|
|
|
4970
4970
|
},
|
|
4971
4971
|
cli: {
|
|
4972
4972
|
method: 'files add',
|
|
4973
|
-
example: "
|
|
4973
|
+
example: "llp beta:directories:files add \\\n --api-key 'My API Key' \\\n --directory-id directory_id \\\n --file-id file_id",
|
|
4974
4974
|
},
|
|
4975
4975
|
},
|
|
4976
4976
|
},
|
|
@@ -5021,7 +5021,7 @@ const EMBEDDED_METHODS = [
|
|
|
5021
5021
|
},
|
|
5022
5022
|
cli: {
|
|
5023
5023
|
method: 'files list',
|
|
5024
|
-
example: "
|
|
5024
|
+
example: "llp beta:directories:files list \\\n --api-key 'My API Key' \\\n --directory-id directory_id",
|
|
5025
5025
|
},
|
|
5026
5026
|
},
|
|
5027
5027
|
},
|
|
@@ -5064,7 +5064,7 @@ const EMBEDDED_METHODS = [
|
|
|
5064
5064
|
},
|
|
5065
5065
|
cli: {
|
|
5066
5066
|
method: 'files get',
|
|
5067
|
-
example: "
|
|
5067
|
+
example: "llp beta:directories:files get \\\n --api-key 'My API Key' \\\n --directory-id directory_id \\\n --directory-file-id directory_file_id",
|
|
5068
5068
|
},
|
|
5069
5069
|
},
|
|
5070
5070
|
},
|
|
@@ -5110,7 +5110,7 @@ const EMBEDDED_METHODS = [
|
|
|
5110
5110
|
},
|
|
5111
5111
|
cli: {
|
|
5112
5112
|
method: 'files update',
|
|
5113
|
-
example: "
|
|
5113
|
+
example: "llp beta:directories:files update \\\n --api-key 'My API Key' \\\n --directory-id directory_id \\\n --directory-file-id directory_file_id",
|
|
5114
5114
|
},
|
|
5115
5115
|
},
|
|
5116
5116
|
},
|
|
@@ -5151,7 +5151,7 @@ const EMBEDDED_METHODS = [
|
|
|
5151
5151
|
},
|
|
5152
5152
|
cli: {
|
|
5153
5153
|
method: 'files delete',
|
|
5154
|
-
example: "
|
|
5154
|
+
example: "llp beta:directories:files delete \\\n --api-key 'My API Key' \\\n --directory-id directory_id \\\n --directory-file-id directory_file_id",
|
|
5155
5155
|
},
|
|
5156
5156
|
},
|
|
5157
5157
|
},
|
|
@@ -5197,7 +5197,7 @@ const EMBEDDED_METHODS = [
|
|
|
5197
5197
|
},
|
|
5198
5198
|
cli: {
|
|
5199
5199
|
method: 'files upload',
|
|
5200
|
-
example: "
|
|
5200
|
+
example: "llp beta:directories:files upload \\\n --api-key 'My API Key' \\\n --directory-id directory_id \\\n --upload-file 'Example data'",
|
|
5201
5201
|
},
|
|
5202
5202
|
},
|
|
5203
5203
|
},
|
|
@@ -5243,7 +5243,7 @@ const EMBEDDED_METHODS = [
|
|
|
5243
5243
|
},
|
|
5244
5244
|
cli: {
|
|
5245
5245
|
method: 'batch create',
|
|
5246
|
-
example: "
|
|
5246
|
+
example: "llp beta:batch create \\\n --api-key 'My API Key' \\\n --job-config '{}'",
|
|
5247
5247
|
},
|
|
5248
5248
|
},
|
|
5249
5249
|
},
|
|
@@ -5288,7 +5288,7 @@ const EMBEDDED_METHODS = [
|
|
|
5288
5288
|
},
|
|
5289
5289
|
cli: {
|
|
5290
5290
|
method: 'batch list',
|
|
5291
|
-
example: "
|
|
5291
|
+
example: "llp beta:batch list \\\n --api-key 'My API Key'",
|
|
5292
5292
|
},
|
|
5293
5293
|
},
|
|
5294
5294
|
},
|
|
@@ -5325,7 +5325,7 @@ const EMBEDDED_METHODS = [
|
|
|
5325
5325
|
},
|
|
5326
5326
|
cli: {
|
|
5327
5327
|
method: 'batch get_status',
|
|
5328
|
-
example: "
|
|
5328
|
+
example: "llp beta:batch get-status \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
5329
5329
|
},
|
|
5330
5330
|
},
|
|
5331
5331
|
},
|
|
@@ -5368,7 +5368,7 @@ const EMBEDDED_METHODS = [
|
|
|
5368
5368
|
},
|
|
5369
5369
|
cli: {
|
|
5370
5370
|
method: 'batch cancel',
|
|
5371
|
-
example: "
|
|
5371
|
+
example: "llp beta:batch cancel \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
5372
5372
|
},
|
|
5373
5373
|
},
|
|
5374
5374
|
},
|
|
@@ -5412,7 +5412,7 @@ const EMBEDDED_METHODS = [
|
|
|
5412
5412
|
},
|
|
5413
5413
|
cli: {
|
|
5414
5414
|
method: 'job_items list',
|
|
5415
|
-
example: "
|
|
5415
|
+
example: "llp beta:batch:job-items list \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
5416
5416
|
},
|
|
5417
5417
|
},
|
|
5418
5418
|
},
|
|
@@ -5454,7 +5454,7 @@ const EMBEDDED_METHODS = [
|
|
|
5454
5454
|
},
|
|
5455
5455
|
cli: {
|
|
5456
5456
|
method: 'job_items get_processing_results',
|
|
5457
|
-
example: "
|
|
5457
|
+
example: "llp beta:batch:job-items get-processing-results \\\n --api-key 'My API Key' \\\n --item-id item_id",
|
|
5458
5458
|
},
|
|
5459
5459
|
},
|
|
5460
5460
|
},
|
|
@@ -5497,7 +5497,7 @@ const EMBEDDED_METHODS = [
|
|
|
5497
5497
|
},
|
|
5498
5498
|
cli: {
|
|
5499
5499
|
method: 'split create',
|
|
5500
|
-
example: "
|
|
5500
|
+
example: "llp beta:split create \\\n --api-key 'My API Key' \\\n --document-input '{type: type, value: value}'",
|
|
5501
5501
|
},
|
|
5502
5502
|
},
|
|
5503
5503
|
},
|
|
@@ -5543,7 +5543,7 @@ const EMBEDDED_METHODS = [
|
|
|
5543
5543
|
},
|
|
5544
5544
|
cli: {
|
|
5545
5545
|
method: 'split list',
|
|
5546
|
-
example: "
|
|
5546
|
+
example: "llp beta:split list \\\n --api-key 'My API Key'",
|
|
5547
5547
|
},
|
|
5548
5548
|
},
|
|
5549
5549
|
},
|
|
@@ -5580,7 +5580,7 @@ const EMBEDDED_METHODS = [
|
|
|
5580
5580
|
},
|
|
5581
5581
|
cli: {
|
|
5582
5582
|
method: 'split get',
|
|
5583
|
-
example: "
|
|
5583
|
+
example: "llp beta:split get \\\n --api-key 'My API Key' \\\n --split-job-id split_job_id",
|
|
5584
5584
|
},
|
|
5585
5585
|
},
|
|
5586
5586
|
},
|
|
@@ -5667,7 +5667,7 @@ const EMBEDDED_READMES = [
|
|
|
5667
5667
|
},
|
|
5668
5668
|
{
|
|
5669
5669
|
language: 'cli',
|
|
5670
|
-
content: "# Llama Cloud CLI\n\nThe official CLI for the [Llama Cloud REST API](https://developers.llamaindex.ai/).\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n<!-- x-release-please-start-version -->\n\n## Installation\n\n### Installing with Go\n\nTo test or install the CLI locally, you need [Go](https://go.dev/doc/install) version 1.22 or later installed.\n\n~~~sh\ngo install 'github.com/run-llama/llama-parse-cli/cmd/
|
|
5670
|
+
content: "# Llama Cloud CLI\n\nThe official CLI for the [Llama Cloud REST API](https://developers.llamaindex.ai/).\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n<!-- x-release-please-start-version -->\n\n## Installation\n\n### Installing with Go\n\nTo test or install the CLI locally, you need [Go](https://go.dev/doc/install) version 1.22 or later installed.\n\n~~~sh\ngo install 'github.com/run-llama/llama-parse-cli/cmd/llp@latest'\n~~~\n\nOnce you have run `go install`, the binary is placed in your Go bin directory:\n\n- **Default location**: `$HOME/go/bin` (or `$GOPATH/bin` if GOPATH is set)\n- **Check your path**: Run `go env GOPATH` to see the base directory\n\nIf commands aren't found after installation, add the Go bin directory to your PATH:\n\n~~~sh\n# Add to your shell profile (.zshrc, .bashrc, etc.)\nexport PATH=\"$PATH:$(go env GOPATH)/bin\"\n~~~\n\n<!-- x-release-please-end -->\n\n### Running Locally\n\nAfter cloning the git repository for this project, you can use the\n`scripts/run` script to run the tool locally:\n\n~~~sh\n./scripts/run args...\n~~~\n\n## Usage\n\nThe CLI follows a resource-based command structure:\n\n~~~sh\nllp [resource] <command> [flags...]\n~~~\n\n~~~sh\nllp parsing create \\\n --api-key 'My API Key' \\\n --tier agentic \\\n --version latest \\\n --file-id abc1234\n~~~\n\nFor details about specific commands, use the `--help` flag.\n\n### Environment variables\n\n| Environment variable | Required |\n| --------------------- | -------- |\n| `LLAMA_CLOUD_API_KEY` | yes |\n\n### Global flags\n\n- `--api-key` (can also be set with `LLAMA_CLOUD_API_KEY` env var)\n- `--help` - Show command line usage\n- `--debug` - Enable debug logging (includes HTTP request/response details)\n- `--version`, `-v` - Show the CLI version\n- `--base-url` - Use a custom API backend URL\n- `--format` - Change the output format (`auto`, `explore`, `json`, `jsonl`, `pretty`, `raw`, `yaml`)\n- `--format-error` - Change the output format for errors (`auto`, `explore`, `json`, `jsonl`, `pretty`, `raw`, `yaml`)\n- `--transform` - Transform the data output using [GJSON syntax](https://github.com/tidwall/gjson/blob/master/SYNTAX.md)\n- `--transform-error` - Transform the error output using [GJSON syntax](https://github.com/tidwall/gjson/blob/master/SYNTAX.md)\n\n### Passing files as arguments\n\nTo pass files to your API, you can use the `@myfile.ext` syntax:\n\n~~~bash\nllp <command> --arg @abe.jpg\n~~~\n\nFiles can also be passed inside JSON or YAML blobs:\n\n~~~bash\nllp <command> --arg '{image: \"@abe.jpg\"}'\n# Equivalent:\nllp <command> <<YAML\narg:\n image: \"@abe.jpg\"\nYAML\n~~~\n\nIf you need to pass a string literal that begins with an `@` sign, you can\nescape the `@` sign to avoid accidentally passing a file.\n\n~~~bash\nllp <command> --username '\\@abe'\n~~~\n\n#### Explicit encoding\n\nFor JSON endpoints, the CLI tool does filetype sniffing to determine whether the\nfile contents should be sent as a string literal (for plain text files) or as a\nbase64-encoded string literal (for binary files). If you need to explicitly send\nthe file as either plain text or base64-encoded data, you can use\n`@file://myfile.txt` (for string encoding) or `@data://myfile.dat` (for\nbase64-encoding). Note that absolute paths will begin with `@file://` or\n`@data://`, followed by a third `/` (for example, `@file:///tmp/file.txt`).\n\n~~~bash\nllp <command> --arg @data://file.txt\n~~~\n\n## Linking different Go SDK versions\n\nYou can link the CLI against a different version of the Llama Cloud Go SDK\nfor development purposes using the `./scripts/link` script.\n\nTo link to a specific version from a repository (version can be a branch,\ngit tag, or commit hash):\n\n~~~bash\n./scripts/link github.com/org/repo@version\n~~~\n\nTo link to a local copy of the SDK:\n\n~~~bash\n./scripts/link ../path/to/llamacloudprod-go\n~~~\n\nIf you run the link script without any arguments, it will default to `../llamacloudprod-go`.\n",
|
|
5671
5671
|
},
|
|
5672
5672
|
];
|
|
5673
5673
|
const INDEX_OPTIONS = {
|