@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/src/local-docs-search.ts
CHANGED
|
@@ -98,7 +98,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
98
98
|
cli: {
|
|
99
99
|
method: 'files create',
|
|
100
100
|
example:
|
|
101
|
-
"
|
|
101
|
+
"llp files create \\\n --api-key 'My API Key' \\\n --file 'Example data' \\\n --purpose purpose",
|
|
102
102
|
},
|
|
103
103
|
},
|
|
104
104
|
},
|
|
@@ -149,7 +149,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
149
149
|
},
|
|
150
150
|
cli: {
|
|
151
151
|
method: 'files query',
|
|
152
|
-
example: "
|
|
152
|
+
example: "llp files query \\\n --api-key 'My API Key'",
|
|
153
153
|
},
|
|
154
154
|
},
|
|
155
155
|
},
|
|
@@ -204,7 +204,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
204
204
|
},
|
|
205
205
|
cli: {
|
|
206
206
|
method: 'files list',
|
|
207
|
-
example: "
|
|
207
|
+
example: "llp files list \\\n --api-key 'My API Key'",
|
|
208
208
|
},
|
|
209
209
|
},
|
|
210
210
|
},
|
|
@@ -247,7 +247,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
247
247
|
cli: {
|
|
248
248
|
method: 'files delete',
|
|
249
249
|
example:
|
|
250
|
-
"
|
|
250
|
+
"llp files delete \\\n --api-key 'My API Key' \\\n --file-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
251
251
|
},
|
|
252
252
|
},
|
|
253
253
|
},
|
|
@@ -296,7 +296,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
296
296
|
cli: {
|
|
297
297
|
method: 'files get',
|
|
298
298
|
example:
|
|
299
|
-
"
|
|
299
|
+
"llp files get \\\n --api-key 'My API Key' \\\n --file-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
300
300
|
},
|
|
301
301
|
},
|
|
302
302
|
},
|
|
@@ -350,7 +350,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
350
350
|
cli: {
|
|
351
351
|
method: 'sheets create',
|
|
352
352
|
example:
|
|
353
|
-
"
|
|
353
|
+
"llp sheets create \\\n --api-key 'My API Key' \\\n --file-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
354
354
|
},
|
|
355
355
|
},
|
|
356
356
|
},
|
|
@@ -405,7 +405,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
405
405
|
},
|
|
406
406
|
cli: {
|
|
407
407
|
method: 'sheets list',
|
|
408
|
-
example: "
|
|
408
|
+
example: "llp sheets list \\\n --api-key 'My API Key'",
|
|
409
409
|
},
|
|
410
410
|
},
|
|
411
411
|
},
|
|
@@ -456,8 +456,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
456
456
|
},
|
|
457
457
|
cli: {
|
|
458
458
|
method: 'sheets get',
|
|
459
|
-
example:
|
|
460
|
-
"llamacloud-prod sheets get \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id",
|
|
459
|
+
example: "llp sheets get \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id",
|
|
461
460
|
},
|
|
462
461
|
},
|
|
463
462
|
},
|
|
@@ -508,7 +507,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
508
507
|
cli: {
|
|
509
508
|
method: 'sheets get_result_table',
|
|
510
509
|
example:
|
|
511
|
-
"
|
|
510
|
+
"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",
|
|
512
511
|
},
|
|
513
512
|
},
|
|
514
513
|
},
|
|
@@ -552,7 +551,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
552
551
|
cli: {
|
|
553
552
|
method: 'sheets delete_job',
|
|
554
553
|
example:
|
|
555
|
-
"
|
|
554
|
+
"llp sheets delete-job \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id",
|
|
556
555
|
},
|
|
557
556
|
},
|
|
558
557
|
},
|
|
@@ -567,7 +566,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
567
566
|
qualified: 'client.parsing.create',
|
|
568
567
|
params: [
|
|
569
568
|
"tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus' | string;",
|
|
570
|
-
"version: 'latest' | '2026-06-26' | '2026-06-18' | '
|
|
569
|
+
"version: 'latest' | '2026-07-08' | '2026-06-26' | '2026-06-18' | '2026-06-15' | string;",
|
|
571
570
|
'organization_id?: string;',
|
|
572
571
|
'project_id?: string;',
|
|
573
572
|
'agentic_options?: { custom_prompt?: string; };',
|
|
@@ -582,7 +581,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
582
581
|
"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; }; };",
|
|
583
582
|
'page_ranges?: { max_pages?: number; target_pages?: string; };',
|
|
584
583
|
'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; }; };',
|
|
585
|
-
"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' | '
|
|
584
|
+
"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'; };",
|
|
586
585
|
'source_url?: string;',
|
|
587
586
|
'user_metadata?: object;',
|
|
588
587
|
'webhook_configuration_ids?: string[];',
|
|
@@ -591,7 +590,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
591
590
|
response:
|
|
592
591
|
"{ 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; }",
|
|
593
592
|
markdown:
|
|
594
|
-
"## 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```",
|
|
593
|
+
"## 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```",
|
|
595
594
|
perLanguage: {
|
|
596
595
|
go: {
|
|
597
596
|
method: 'client.Parsing.New',
|
|
@@ -619,8 +618,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
619
618
|
},
|
|
620
619
|
cli: {
|
|
621
620
|
method: 'parsing create',
|
|
622
|
-
example:
|
|
623
|
-
"llamacloud-prod parsing create \\\n --api-key 'My API Key' \\\n --tier fast \\\n --version latest",
|
|
621
|
+
example: "llp parsing create \\\n --api-key 'My API Key' \\\n --tier fast \\\n --version latest",
|
|
624
622
|
},
|
|
625
623
|
},
|
|
626
624
|
},
|
|
@@ -671,7 +669,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
671
669
|
},
|
|
672
670
|
cli: {
|
|
673
671
|
method: 'parsing get',
|
|
674
|
-
example: "
|
|
672
|
+
example: "llp parsing get \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
675
673
|
},
|
|
676
674
|
},
|
|
677
675
|
},
|
|
@@ -725,7 +723,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
725
723
|
},
|
|
726
724
|
cli: {
|
|
727
725
|
method: 'parsing list',
|
|
728
|
-
example: "
|
|
726
|
+
example: "llp parsing list \\\n --api-key 'My API Key'",
|
|
729
727
|
},
|
|
730
728
|
},
|
|
731
729
|
},
|
|
@@ -778,7 +776,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
778
776
|
cli: {
|
|
779
777
|
method: 'extract create',
|
|
780
778
|
example:
|
|
781
|
-
"
|
|
779
|
+
"llp extract create \\\n --api-key 'My API Key' \\\n --file-input dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
|
|
782
780
|
},
|
|
783
781
|
},
|
|
784
782
|
},
|
|
@@ -837,7 +835,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
837
835
|
},
|
|
838
836
|
cli: {
|
|
839
837
|
method: 'extract list',
|
|
840
|
-
example: "
|
|
838
|
+
example: "llp extract list \\\n --api-key 'My API Key'",
|
|
841
839
|
},
|
|
842
840
|
},
|
|
843
841
|
},
|
|
@@ -882,7 +880,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
882
880
|
},
|
|
883
881
|
cli: {
|
|
884
882
|
method: 'extract get',
|
|
885
|
-
example: "
|
|
883
|
+
example: "llp extract get \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
886
884
|
},
|
|
887
885
|
},
|
|
888
886
|
},
|
|
@@ -925,7 +923,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
925
923
|
},
|
|
926
924
|
cli: {
|
|
927
925
|
method: 'extract delete',
|
|
928
|
-
example: "
|
|
926
|
+
example: "llp extract delete \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
929
927
|
},
|
|
930
928
|
},
|
|
931
929
|
},
|
|
@@ -969,7 +967,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
969
967
|
cli: {
|
|
970
968
|
method: 'extract validate_schema',
|
|
971
969
|
example:
|
|
972
|
-
"
|
|
970
|
+
"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}'",
|
|
973
971
|
},
|
|
974
972
|
},
|
|
975
973
|
},
|
|
@@ -992,7 +990,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
992
990
|
response:
|
|
993
991
|
"{ 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; }",
|
|
994
992
|
markdown:
|
|
995
|
-
"## 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' | '
|
|
993
|
+
"## 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```",
|
|
996
994
|
perLanguage: {
|
|
997
995
|
go: {
|
|
998
996
|
method: 'client.Extract.GenerateSchema',
|
|
@@ -1020,7 +1018,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1020
1018
|
},
|
|
1021
1019
|
cli: {
|
|
1022
1020
|
method: 'extract generate_schema',
|
|
1023
|
-
example: "
|
|
1021
|
+
example: "llp extract generate-schema \\\n --api-key 'My API Key'",
|
|
1024
1022
|
},
|
|
1025
1023
|
},
|
|
1026
1024
|
},
|
|
@@ -1073,7 +1071,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1073
1071
|
cli: {
|
|
1074
1072
|
method: 'jobs create',
|
|
1075
1073
|
example:
|
|
1076
|
-
"
|
|
1074
|
+
"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}\"",
|
|
1077
1075
|
},
|
|
1078
1076
|
},
|
|
1079
1077
|
},
|
|
@@ -1122,7 +1120,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1122
1120
|
},
|
|
1123
1121
|
cli: {
|
|
1124
1122
|
method: 'jobs list',
|
|
1125
|
-
example: "
|
|
1123
|
+
example: "llp classifier:jobs list \\\n --api-key 'My API Key'",
|
|
1126
1124
|
},
|
|
1127
1125
|
},
|
|
1128
1126
|
},
|
|
@@ -1167,7 +1165,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1167
1165
|
cli: {
|
|
1168
1166
|
method: 'jobs get',
|
|
1169
1167
|
example:
|
|
1170
|
-
"
|
|
1168
|
+
"llp classifier:jobs get \\\n --api-key 'My API Key' \\\n --classify-job-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
1171
1169
|
},
|
|
1172
1170
|
},
|
|
1173
1171
|
},
|
|
@@ -1213,7 +1211,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1213
1211
|
cli: {
|
|
1214
1212
|
method: 'jobs get_results',
|
|
1215
1213
|
example:
|
|
1216
|
-
"
|
|
1214
|
+
"llp classifier:jobs get-results \\\n --api-key 'My API Key' \\\n --classify-job-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
1217
1215
|
},
|
|
1218
1216
|
},
|
|
1219
1217
|
},
|
|
@@ -1263,7 +1261,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1263
1261
|
cli: {
|
|
1264
1262
|
method: 'batches create',
|
|
1265
1263
|
example:
|
|
1266
|
-
"
|
|
1264
|
+
"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",
|
|
1267
1265
|
},
|
|
1268
1266
|
},
|
|
1269
1267
|
},
|
|
@@ -1316,7 +1314,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1316
1314
|
},
|
|
1317
1315
|
cli: {
|
|
1318
1316
|
method: 'batches list',
|
|
1319
|
-
example: "
|
|
1317
|
+
example: "llp batches list \\\n --api-key 'My API Key'",
|
|
1320
1318
|
},
|
|
1321
1319
|
},
|
|
1322
1320
|
},
|
|
@@ -1360,7 +1358,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1360
1358
|
},
|
|
1361
1359
|
cli: {
|
|
1362
1360
|
method: 'batches get',
|
|
1363
|
-
example: "
|
|
1361
|
+
example: "llp batches get \\\n --api-key 'My API Key' \\\n --batch-id batch_id",
|
|
1364
1362
|
},
|
|
1365
1363
|
},
|
|
1366
1364
|
},
|
|
@@ -1415,7 +1413,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1415
1413
|
},
|
|
1416
1414
|
cli: {
|
|
1417
1415
|
method: 'classify create',
|
|
1418
|
-
example: "
|
|
1416
|
+
example: "llp classify create \\\n --api-key 'My API Key'",
|
|
1419
1417
|
},
|
|
1420
1418
|
},
|
|
1421
1419
|
},
|
|
@@ -1470,7 +1468,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1470
1468
|
},
|
|
1471
1469
|
cli: {
|
|
1472
1470
|
method: 'classify list',
|
|
1473
|
-
example: "
|
|
1471
|
+
example: "llp classify list \\\n --api-key 'My API Key'",
|
|
1474
1472
|
},
|
|
1475
1473
|
},
|
|
1476
1474
|
},
|
|
@@ -1515,7 +1513,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1515
1513
|
},
|
|
1516
1514
|
cli: {
|
|
1517
1515
|
method: 'classify get',
|
|
1518
|
-
example: "
|
|
1516
|
+
example: "llp classify get \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
1519
1517
|
},
|
|
1520
1518
|
},
|
|
1521
1519
|
},
|
|
@@ -1530,14 +1528,14 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1530
1528
|
qualified: 'client.configurations.create',
|
|
1531
1529
|
params: [
|
|
1532
1530
|
'name: string;',
|
|
1533
|
-
"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' | '
|
|
1531
|
+
"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'; };",
|
|
1534
1532
|
'organization_id?: string;',
|
|
1535
1533
|
'project_id?: string;',
|
|
1536
1534
|
],
|
|
1537
1535
|
response:
|
|
1538
1536
|
"{ 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; }",
|
|
1539
1537
|
markdown:
|
|
1540
|
-
"## 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```",
|
|
1538
|
+
"## 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```",
|
|
1541
1539
|
perLanguage: {
|
|
1542
1540
|
go: {
|
|
1543
1541
|
method: 'client.Configurations.New',
|
|
@@ -1566,7 +1564,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1566
1564
|
cli: {
|
|
1567
1565
|
method: 'configurations create',
|
|
1568
1566
|
example:
|
|
1569
|
-
"
|
|
1567
|
+
"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}]}\"",
|
|
1570
1568
|
},
|
|
1571
1569
|
},
|
|
1572
1570
|
},
|
|
@@ -1590,7 +1588,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1590
1588
|
response:
|
|
1591
1589
|
"{ 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; }",
|
|
1592
1590
|
markdown:
|
|
1593
|
-
"## 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' | '
|
|
1591
|
+
"## 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```",
|
|
1594
1592
|
perLanguage: {
|
|
1595
1593
|
go: {
|
|
1596
1594
|
method: 'client.Configurations.List',
|
|
@@ -1618,7 +1616,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1618
1616
|
},
|
|
1619
1617
|
cli: {
|
|
1620
1618
|
method: 'configurations list',
|
|
1621
|
-
example: "
|
|
1619
|
+
example: "llp configurations list \\\n --api-key 'My API Key'",
|
|
1622
1620
|
},
|
|
1623
1621
|
},
|
|
1624
1622
|
},
|
|
@@ -1634,7 +1632,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1634
1632
|
response:
|
|
1635
1633
|
"{ 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; }",
|
|
1636
1634
|
markdown:
|
|
1637
|
-
"## 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' | '
|
|
1635
|
+
"## 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```",
|
|
1638
1636
|
perLanguage: {
|
|
1639
1637
|
go: {
|
|
1640
1638
|
method: 'client.Configurations.Get',
|
|
@@ -1662,8 +1660,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1662
1660
|
},
|
|
1663
1661
|
cli: {
|
|
1664
1662
|
method: 'configurations retrieve',
|
|
1665
|
-
example:
|
|
1666
|
-
"llamacloud-prod configurations retrieve \\\n --api-key 'My API Key' \\\n --config-id config_id",
|
|
1663
|
+
example: "llp configurations retrieve \\\n --api-key 'My API Key' \\\n --config-id config_id",
|
|
1667
1664
|
},
|
|
1668
1665
|
},
|
|
1669
1666
|
},
|
|
@@ -1680,12 +1677,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1680
1677
|
'organization_id?: string;',
|
|
1681
1678
|
'project_id?: string;',
|
|
1682
1679
|
'name?: string;',
|
|
1683
|
-
"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' | '
|
|
1680
|
+
"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'; };",
|
|
1684
1681
|
],
|
|
1685
1682
|
response:
|
|
1686
1683
|
"{ 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; }",
|
|
1687
1684
|
markdown:
|
|
1688
|
-
"## 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```",
|
|
1685
|
+
"## 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```",
|
|
1689
1686
|
perLanguage: {
|
|
1690
1687
|
go: {
|
|
1691
1688
|
method: 'client.Configurations.Update',
|
|
@@ -1713,8 +1710,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1713
1710
|
},
|
|
1714
1711
|
cli: {
|
|
1715
1712
|
method: 'configurations update',
|
|
1716
|
-
example:
|
|
1717
|
-
"llamacloud-prod configurations update \\\n --api-key 'My API Key' \\\n --config-id config_id",
|
|
1713
|
+
example: "llp configurations update \\\n --api-key 'My API Key' \\\n --config-id config_id",
|
|
1718
1714
|
},
|
|
1719
1715
|
},
|
|
1720
1716
|
},
|
|
@@ -1756,8 +1752,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1756
1752
|
},
|
|
1757
1753
|
cli: {
|
|
1758
1754
|
method: 'configurations delete',
|
|
1759
|
-
example:
|
|
1760
|
-
"llamacloud-prod configurations delete \\\n --api-key 'My API Key' \\\n --config-id config_id",
|
|
1755
|
+
example: "llp configurations delete \\\n --api-key 'My API Key' \\\n --config-id config_id",
|
|
1761
1756
|
},
|
|
1762
1757
|
},
|
|
1763
1758
|
},
|
|
@@ -1801,7 +1796,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1801
1796
|
},
|
|
1802
1797
|
cli: {
|
|
1803
1798
|
method: 'projects list',
|
|
1804
|
-
example: "
|
|
1799
|
+
example: "llp projects list \\\n --api-key 'My API Key'",
|
|
1805
1800
|
},
|
|
1806
1801
|
},
|
|
1807
1802
|
},
|
|
@@ -1846,7 +1841,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1846
1841
|
cli: {
|
|
1847
1842
|
method: 'projects get',
|
|
1848
1843
|
example:
|
|
1849
|
-
"
|
|
1844
|
+
"llp projects get \\\n --api-key 'My API Key' \\\n --project-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
1850
1845
|
},
|
|
1851
1846
|
},
|
|
1852
1847
|
},
|
|
@@ -1890,7 +1885,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1890
1885
|
},
|
|
1891
1886
|
cli: {
|
|
1892
1887
|
method: 'data_sinks list',
|
|
1893
|
-
example: "
|
|
1888
|
+
example: "llp data-sinks list \\\n --api-key 'My API Key'",
|
|
1894
1889
|
},
|
|
1895
1890
|
},
|
|
1896
1891
|
},
|
|
@@ -1941,7 +1936,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1941
1936
|
cli: {
|
|
1942
1937
|
method: 'data_sinks create',
|
|
1943
1938
|
example:
|
|
1944
|
-
"
|
|
1939
|
+
"llp data-sinks create \\\n --api-key 'My API Key' \\\n --component '{foo: bar}' \\\n --name name \\\n --sink-type ASTRA_DB",
|
|
1945
1940
|
},
|
|
1946
1941
|
},
|
|
1947
1942
|
},
|
|
@@ -1986,7 +1981,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1986
1981
|
cli: {
|
|
1987
1982
|
method: 'data_sinks get',
|
|
1988
1983
|
example:
|
|
1989
|
-
"
|
|
1984
|
+
"llp data-sinks get \\\n --api-key 'My API Key' \\\n --data-sink-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
1990
1985
|
},
|
|
1991
1986
|
},
|
|
1992
1987
|
},
|
|
@@ -2036,7 +2031,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2036
2031
|
cli: {
|
|
2037
2032
|
method: 'data_sinks update',
|
|
2038
2033
|
example:
|
|
2039
|
-
"
|
|
2034
|
+
"llp data-sinks update \\\n --api-key 'My API Key' \\\n --data-sink-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --sink-type ASTRA_DB",
|
|
2040
2035
|
},
|
|
2041
2036
|
},
|
|
2042
2037
|
},
|
|
@@ -2079,7 +2074,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2079
2074
|
cli: {
|
|
2080
2075
|
method: 'data_sinks delete',
|
|
2081
2076
|
example:
|
|
2082
|
-
"
|
|
2077
|
+
"llp data-sinks delete \\\n --api-key 'My API Key' \\\n --data-sink-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2083
2078
|
},
|
|
2084
2079
|
},
|
|
2085
2080
|
},
|
|
@@ -2124,7 +2119,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2124
2119
|
},
|
|
2125
2120
|
cli: {
|
|
2126
2121
|
method: 'data_sources list',
|
|
2127
|
-
example: "
|
|
2122
|
+
example: "llp data-sources list \\\n --api-key 'My API Key'",
|
|
2128
2123
|
},
|
|
2129
2124
|
},
|
|
2130
2125
|
},
|
|
@@ -2137,7 +2132,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2137
2132
|
stainlessPath: '(resource) data_sources > (method) create',
|
|
2138
2133
|
qualified: 'client.dataSources.create',
|
|
2139
2134
|
params: [
|
|
2140
|
-
"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; };",
|
|
2135
|
+
"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; };",
|
|
2141
2136
|
'name: string;',
|
|
2142
2137
|
'source_type: string;',
|
|
2143
2138
|
'organization_id?: string;',
|
|
@@ -2147,7 +2142,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2147
2142
|
response:
|
|
2148
2143
|
'{ 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; }',
|
|
2149
2144
|
markdown:
|
|
2150
|
-
"## 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```",
|
|
2145
|
+
"## 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```",
|
|
2151
2146
|
perLanguage: {
|
|
2152
2147
|
go: {
|
|
2153
2148
|
method: 'client.DataSources.New',
|
|
@@ -2176,7 +2171,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2176
2171
|
cli: {
|
|
2177
2172
|
method: 'data_sources create',
|
|
2178
2173
|
example:
|
|
2179
|
-
"
|
|
2174
|
+
"llp data-sources create \\\n --api-key 'My API Key' \\\n --component '{foo: bar}' \\\n --name name \\\n --source-type AZURE_STORAGE_BLOB",
|
|
2180
2175
|
},
|
|
2181
2176
|
},
|
|
2182
2177
|
},
|
|
@@ -2192,7 +2187,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2192
2187
|
response:
|
|
2193
2188
|
'{ 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; }',
|
|
2194
2189
|
markdown:
|
|
2195
|
-
"## 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```",
|
|
2190
|
+
"## 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```",
|
|
2196
2191
|
perLanguage: {
|
|
2197
2192
|
go: {
|
|
2198
2193
|
method: 'client.DataSources.Get',
|
|
@@ -2221,7 +2216,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2221
2216
|
cli: {
|
|
2222
2217
|
method: 'data_sources get',
|
|
2223
2218
|
example:
|
|
2224
|
-
"
|
|
2219
|
+
"llp data-sources get \\\n --api-key 'My API Key' \\\n --data-source-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2225
2220
|
},
|
|
2226
2221
|
},
|
|
2227
2222
|
},
|
|
@@ -2236,14 +2231,14 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2236
2231
|
params: [
|
|
2237
2232
|
'data_source_id: string;',
|
|
2238
2233
|
'source_type: string;',
|
|
2239
|
-
"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; };",
|
|
2234
|
+
"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; };",
|
|
2240
2235
|
'custom_metadata?: object;',
|
|
2241
2236
|
'name?: string;',
|
|
2242
2237
|
],
|
|
2243
2238
|
response:
|
|
2244
2239
|
'{ 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; }',
|
|
2245
2240
|
markdown:
|
|
2246
|
-
"## 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```",
|
|
2241
|
+
"## 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```",
|
|
2247
2242
|
perLanguage: {
|
|
2248
2243
|
go: {
|
|
2249
2244
|
method: 'client.DataSources.Update',
|
|
@@ -2272,7 +2267,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2272
2267
|
cli: {
|
|
2273
2268
|
method: 'data_sources update',
|
|
2274
2269
|
example:
|
|
2275
|
-
"
|
|
2270
|
+
"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",
|
|
2276
2271
|
},
|
|
2277
2272
|
},
|
|
2278
2273
|
},
|
|
@@ -2315,7 +2310,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2315
2310
|
cli: {
|
|
2316
2311
|
method: 'data_sources delete',
|
|
2317
2312
|
example:
|
|
2318
|
-
"
|
|
2313
|
+
"llp data-sources delete \\\n --api-key 'My API Key' \\\n --data-source-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2319
2314
|
},
|
|
2320
2315
|
},
|
|
2321
2316
|
},
|
|
@@ -2365,7 +2360,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2365
2360
|
},
|
|
2366
2361
|
cli: {
|
|
2367
2362
|
method: 'pipelines list',
|
|
2368
|
-
example: "
|
|
2363
|
+
example: "llp pipelines list \\\n --api-key 'My API Key'",
|
|
2369
2364
|
},
|
|
2370
2365
|
},
|
|
2371
2366
|
},
|
|
@@ -2426,7 +2421,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2426
2421
|
},
|
|
2427
2422
|
cli: {
|
|
2428
2423
|
method: 'pipelines create',
|
|
2429
|
-
example: "
|
|
2424
|
+
example: "llp pipelines create \\\n --api-key 'My API Key' \\\n --name x",
|
|
2430
2425
|
},
|
|
2431
2426
|
},
|
|
2432
2427
|
},
|
|
@@ -2471,7 +2466,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2471
2466
|
cli: {
|
|
2472
2467
|
method: 'pipelines get',
|
|
2473
2468
|
example:
|
|
2474
|
-
"
|
|
2469
|
+
"llp pipelines get \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2475
2470
|
},
|
|
2476
2471
|
},
|
|
2477
2472
|
},
|
|
@@ -2530,7 +2525,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2530
2525
|
cli: {
|
|
2531
2526
|
method: 'pipelines update',
|
|
2532
2527
|
example:
|
|
2533
|
-
"
|
|
2528
|
+
"llp pipelines update \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2534
2529
|
},
|
|
2535
2530
|
},
|
|
2536
2531
|
},
|
|
@@ -2574,7 +2569,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2574
2569
|
cli: {
|
|
2575
2570
|
method: 'pipelines delete',
|
|
2576
2571
|
example:
|
|
2577
|
-
"
|
|
2572
|
+
"llp pipelines delete \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2578
2573
|
},
|
|
2579
2574
|
},
|
|
2580
2575
|
},
|
|
@@ -2620,7 +2615,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2620
2615
|
cli: {
|
|
2621
2616
|
method: 'pipelines get_status',
|
|
2622
2617
|
example:
|
|
2623
|
-
"
|
|
2618
|
+
"llp pipelines get-status \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2624
2619
|
},
|
|
2625
2620
|
},
|
|
2626
2621
|
},
|
|
@@ -2681,7 +2676,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2681
2676
|
},
|
|
2682
2677
|
cli: {
|
|
2683
2678
|
method: 'pipelines upsert',
|
|
2684
|
-
example: "
|
|
2679
|
+
example: "llp pipelines upsert \\\n --api-key 'My API Key' \\\n --name x",
|
|
2685
2680
|
},
|
|
2686
2681
|
},
|
|
2687
2682
|
},
|
|
@@ -2703,7 +2698,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2703
2698
|
cli: {
|
|
2704
2699
|
method: 'pipelines run_search',
|
|
2705
2700
|
example:
|
|
2706
|
-
"
|
|
2701
|
+
"llp pipelines run-search \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --query x",
|
|
2707
2702
|
},
|
|
2708
2703
|
},
|
|
2709
2704
|
},
|
|
@@ -2749,7 +2744,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2749
2744
|
cli: {
|
|
2750
2745
|
method: 'sync create',
|
|
2751
2746
|
example:
|
|
2752
|
-
"
|
|
2747
|
+
"llp pipelines:sync create \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2753
2748
|
},
|
|
2754
2749
|
},
|
|
2755
2750
|
},
|
|
@@ -2794,7 +2789,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2794
2789
|
cli: {
|
|
2795
2790
|
method: 'sync cancel',
|
|
2796
2791
|
example:
|
|
2797
|
-
"
|
|
2792
|
+
"llp pipelines:sync cancel \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2798
2793
|
},
|
|
2799
2794
|
},
|
|
2800
2795
|
},
|
|
@@ -2839,7 +2834,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2839
2834
|
cli: {
|
|
2840
2835
|
method: 'data_sources get_data_sources',
|
|
2841
2836
|
example:
|
|
2842
|
-
"
|
|
2837
|
+
"llp pipelines:data-sources get-data-sources \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
2843
2838
|
},
|
|
2844
2839
|
},
|
|
2845
2840
|
},
|
|
@@ -2884,7 +2879,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2884
2879
|
cli: {
|
|
2885
2880
|
method: 'data_sources update_data_sources',
|
|
2886
2881
|
example:
|
|
2887
|
-
"
|
|
2882
|
+
"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}'",
|
|
2888
2883
|
},
|
|
2889
2884
|
},
|
|
2890
2885
|
},
|
|
@@ -2900,7 +2895,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2900
2895
|
response:
|
|
2901
2896
|
"{ 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; }",
|
|
2902
2897
|
markdown:
|
|
2903
|
-
"## 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```",
|
|
2898
|
+
"## 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```",
|
|
2904
2899
|
perLanguage: {
|
|
2905
2900
|
go: {
|
|
2906
2901
|
method: 'client.Pipelines.DataSources.Update',
|
|
@@ -2929,7 +2924,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2929
2924
|
cli: {
|
|
2930
2925
|
method: 'data_sources update',
|
|
2931
2926
|
example:
|
|
2932
|
-
"
|
|
2927
|
+
"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",
|
|
2933
2928
|
},
|
|
2934
2929
|
},
|
|
2935
2930
|
},
|
|
@@ -2974,7 +2969,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2974
2969
|
cli: {
|
|
2975
2970
|
method: 'data_sources get_status',
|
|
2976
2971
|
example:
|
|
2977
|
-
"
|
|
2972
|
+
"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",
|
|
2978
2973
|
},
|
|
2979
2974
|
},
|
|
2980
2975
|
},
|
|
@@ -3019,7 +3014,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3019
3014
|
cli: {
|
|
3020
3015
|
method: 'data_sources sync',
|
|
3021
3016
|
example:
|
|
3022
|
-
"
|
|
3017
|
+
"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",
|
|
3023
3018
|
},
|
|
3024
3019
|
},
|
|
3025
3020
|
},
|
|
@@ -3063,7 +3058,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3063
3058
|
cli: {
|
|
3064
3059
|
method: 'images list_page_screenshots',
|
|
3065
3060
|
example:
|
|
3066
|
-
"
|
|
3061
|
+
"llp pipelines:images list-page-screenshots \\\n --api-key 'My API Key' \\\n --id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
3067
3062
|
},
|
|
3068
3063
|
},
|
|
3069
3064
|
},
|
|
@@ -3107,7 +3102,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3107
3102
|
cli: {
|
|
3108
3103
|
method: 'images get_page_screenshot',
|
|
3109
3104
|
example:
|
|
3110
|
-
"
|
|
3105
|
+
"llp pipelines:images get-page-screenshot \\\n --api-key 'My API Key' \\\n --id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --page-index 0",
|
|
3111
3106
|
},
|
|
3112
3107
|
},
|
|
3113
3108
|
},
|
|
@@ -3157,7 +3152,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3157
3152
|
cli: {
|
|
3158
3153
|
method: 'images get_page_figure',
|
|
3159
3154
|
example:
|
|
3160
|
-
"
|
|
3155
|
+
"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",
|
|
3161
3156
|
},
|
|
3162
3157
|
},
|
|
3163
3158
|
},
|
|
@@ -3202,7 +3197,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3202
3197
|
cli: {
|
|
3203
3198
|
method: 'images list_page_figures',
|
|
3204
3199
|
example:
|
|
3205
|
-
"
|
|
3200
|
+
"llp pipelines:images list-page-figures \\\n --api-key 'My API Key' \\\n --id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
3206
3201
|
},
|
|
3207
3202
|
},
|
|
3208
3203
|
},
|
|
@@ -3247,7 +3242,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3247
3242
|
cli: {
|
|
3248
3243
|
method: 'files get_status_counts',
|
|
3249
3244
|
example:
|
|
3250
|
-
"
|
|
3245
|
+
"llp pipelines:files get-status-counts \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
3251
3246
|
},
|
|
3252
3247
|
},
|
|
3253
3248
|
},
|
|
@@ -3292,7 +3287,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3292
3287
|
cli: {
|
|
3293
3288
|
method: 'files get_status',
|
|
3294
3289
|
example:
|
|
3295
|
-
"
|
|
3290
|
+
"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",
|
|
3296
3291
|
},
|
|
3297
3292
|
},
|
|
3298
3293
|
},
|
|
@@ -3337,7 +3332,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3337
3332
|
cli: {
|
|
3338
3333
|
method: 'files create',
|
|
3339
3334
|
example:
|
|
3340
|
-
"
|
|
3335
|
+
"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}'",
|
|
3341
3336
|
},
|
|
3342
3337
|
},
|
|
3343
3338
|
},
|
|
@@ -3382,7 +3377,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3382
3377
|
cli: {
|
|
3383
3378
|
method: 'files update',
|
|
3384
3379
|
example:
|
|
3385
|
-
"
|
|
3380
|
+
"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",
|
|
3386
3381
|
},
|
|
3387
3382
|
},
|
|
3388
3383
|
},
|
|
@@ -3425,7 +3420,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3425
3420
|
cli: {
|
|
3426
3421
|
method: 'files delete',
|
|
3427
3422
|
example:
|
|
3428
|
-
"
|
|
3423
|
+
"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",
|
|
3429
3424
|
},
|
|
3430
3425
|
},
|
|
3431
3426
|
},
|
|
@@ -3479,7 +3474,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3479
3474
|
cli: {
|
|
3480
3475
|
method: 'files list',
|
|
3481
3476
|
example:
|
|
3482
|
-
"
|
|
3477
|
+
"llp pipelines:files list \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
3483
3478
|
},
|
|
3484
3479
|
},
|
|
3485
3480
|
},
|
|
@@ -3523,7 +3518,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3523
3518
|
cli: {
|
|
3524
3519
|
method: 'metadata create',
|
|
3525
3520
|
example:
|
|
3526
|
-
"
|
|
3521
|
+
"llp pipelines:metadata create \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --upload-file 'Example data'",
|
|
3527
3522
|
},
|
|
3528
3523
|
},
|
|
3529
3524
|
},
|
|
@@ -3566,7 +3561,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3566
3561
|
cli: {
|
|
3567
3562
|
method: 'metadata delete_all',
|
|
3568
3563
|
example:
|
|
3569
|
-
"
|
|
3564
|
+
"llp pipelines:metadata delete-all \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
3570
3565
|
},
|
|
3571
3566
|
},
|
|
3572
3567
|
},
|
|
@@ -3614,7 +3609,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3614
3609
|
cli: {
|
|
3615
3610
|
method: 'documents create',
|
|
3616
3611
|
example:
|
|
3617
|
-
"
|
|
3612
|
+
"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}'",
|
|
3618
3613
|
},
|
|
3619
3614
|
},
|
|
3620
3615
|
},
|
|
@@ -3667,7 +3662,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3667
3662
|
cli: {
|
|
3668
3663
|
method: 'documents list',
|
|
3669
3664
|
example:
|
|
3670
|
-
"
|
|
3665
|
+
"llp pipelines:documents list \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
3671
3666
|
},
|
|
3672
3667
|
},
|
|
3673
3668
|
},
|
|
@@ -3712,7 +3707,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3712
3707
|
cli: {
|
|
3713
3708
|
method: 'documents get',
|
|
3714
3709
|
example:
|
|
3715
|
-
"
|
|
3710
|
+
"llp pipelines:documents get \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --document-id document_id",
|
|
3716
3711
|
},
|
|
3717
3712
|
},
|
|
3718
3713
|
},
|
|
@@ -3755,7 +3750,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3755
3750
|
cli: {
|
|
3756
3751
|
method: 'documents delete',
|
|
3757
3752
|
example:
|
|
3758
|
-
"
|
|
3753
|
+
"llp pipelines:documents delete \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --document-id document_id",
|
|
3759
3754
|
},
|
|
3760
3755
|
},
|
|
3761
3756
|
},
|
|
@@ -3800,7 +3795,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3800
3795
|
cli: {
|
|
3801
3796
|
method: 'documents get_status',
|
|
3802
3797
|
example:
|
|
3803
|
-
"
|
|
3798
|
+
"llp pipelines:documents get-status \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --document-id document_id",
|
|
3804
3799
|
},
|
|
3805
3800
|
},
|
|
3806
3801
|
},
|
|
@@ -3844,7 +3839,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3844
3839
|
cli: {
|
|
3845
3840
|
method: 'documents sync',
|
|
3846
3841
|
example:
|
|
3847
|
-
"
|
|
3842
|
+
"llp pipelines:documents sync \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --document-id document_id",
|
|
3848
3843
|
},
|
|
3849
3844
|
},
|
|
3850
3845
|
},
|
|
@@ -3889,7 +3884,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3889
3884
|
cli: {
|
|
3890
3885
|
method: 'documents get_chunks',
|
|
3891
3886
|
example:
|
|
3892
|
-
"
|
|
3887
|
+
"llp pipelines:documents get-chunks \\\n --api-key 'My API Key' \\\n --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --document-id document_id",
|
|
3893
3888
|
},
|
|
3894
3889
|
},
|
|
3895
3890
|
},
|
|
@@ -3937,7 +3932,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3937
3932
|
cli: {
|
|
3938
3933
|
method: 'documents upsert',
|
|
3939
3934
|
example:
|
|
3940
|
-
"
|
|
3935
|
+
"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}'",
|
|
3941
3936
|
},
|
|
3942
3937
|
},
|
|
3943
3938
|
},
|
|
@@ -3986,7 +3981,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3986
3981
|
},
|
|
3987
3982
|
cli: {
|
|
3988
3983
|
method: 'retrievers create',
|
|
3989
|
-
example: "
|
|
3984
|
+
example: "llp retrievers create \\\n --api-key 'My API Key' \\\n --name x",
|
|
3990
3985
|
},
|
|
3991
3986
|
},
|
|
3992
3987
|
},
|
|
@@ -4035,7 +4030,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4035
4030
|
},
|
|
4036
4031
|
cli: {
|
|
4037
4032
|
method: 'retrievers upsert',
|
|
4038
|
-
example: "
|
|
4033
|
+
example: "llp retrievers upsert \\\n --api-key 'My API Key' \\\n --name x",
|
|
4039
4034
|
},
|
|
4040
4035
|
},
|
|
4041
4036
|
},
|
|
@@ -4079,7 +4074,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4079
4074
|
},
|
|
4080
4075
|
cli: {
|
|
4081
4076
|
method: 'retrievers list',
|
|
4082
|
-
example: "
|
|
4077
|
+
example: "llp retrievers list \\\n --api-key 'My API Key'",
|
|
4083
4078
|
},
|
|
4084
4079
|
},
|
|
4085
4080
|
},
|
|
@@ -4124,7 +4119,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4124
4119
|
cli: {
|
|
4125
4120
|
method: 'retrievers get',
|
|
4126
4121
|
example:
|
|
4127
|
-
"
|
|
4122
|
+
"llp retrievers get \\\n --api-key 'My API Key' \\\n --retriever-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
4128
4123
|
},
|
|
4129
4124
|
},
|
|
4130
4125
|
},
|
|
@@ -4175,7 +4170,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4175
4170
|
cli: {
|
|
4176
4171
|
method: 'retrievers update',
|
|
4177
4172
|
example:
|
|
4178
|
-
"
|
|
4173
|
+
"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}'",
|
|
4179
4174
|
},
|
|
4180
4175
|
},
|
|
4181
4176
|
},
|
|
@@ -4218,7 +4213,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4218
4213
|
cli: {
|
|
4219
4214
|
method: 'retrievers delete',
|
|
4220
4215
|
example:
|
|
4221
|
-
"
|
|
4216
|
+
"llp retrievers delete \\\n --api-key 'My API Key' \\\n --retriever-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
4222
4217
|
},
|
|
4223
4218
|
},
|
|
4224
4219
|
},
|
|
@@ -4270,7 +4265,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4270
4265
|
},
|
|
4271
4266
|
cli: {
|
|
4272
4267
|
method: 'retrievers search',
|
|
4273
|
-
example: "
|
|
4268
|
+
example: "llp retrievers search \\\n --api-key 'My API Key' \\\n --query x",
|
|
4274
4269
|
},
|
|
4275
4270
|
},
|
|
4276
4271
|
},
|
|
@@ -4318,7 +4313,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4318
4313
|
cli: {
|
|
4319
4314
|
method: 'retriever search',
|
|
4320
4315
|
example:
|
|
4321
|
-
"
|
|
4316
|
+
"llp retrievers:retriever search \\\n --api-key 'My API Key' \\\n --retriever-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \\\n --query x",
|
|
4322
4317
|
},
|
|
4323
4318
|
},
|
|
4324
4319
|
},
|
|
@@ -4362,7 +4357,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4362
4357
|
},
|
|
4363
4358
|
cli: {
|
|
4364
4359
|
method: 'indexes get',
|
|
4365
|
-
example: "
|
|
4360
|
+
example: "llp beta:indexes get \\\n --api-key 'My API Key' \\\n --index-id index_id",
|
|
4366
4361
|
},
|
|
4367
4362
|
},
|
|
4368
4363
|
},
|
|
@@ -4404,7 +4399,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4404
4399
|
},
|
|
4405
4400
|
cli: {
|
|
4406
4401
|
method: 'indexes delete',
|
|
4407
|
-
example: "
|
|
4402
|
+
example: "llp beta:indexes delete \\\n --api-key 'My API Key' \\\n --index-id index_id",
|
|
4408
4403
|
},
|
|
4409
4404
|
},
|
|
4410
4405
|
},
|
|
@@ -4459,7 +4454,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4459
4454
|
cli: {
|
|
4460
4455
|
method: 'indexes create',
|
|
4461
4456
|
example:
|
|
4462
|
-
"
|
|
4457
|
+
"llp beta:indexes create \\\n --api-key 'My API Key' \\\n --source-directory-id dir-abc123",
|
|
4463
4458
|
},
|
|
4464
4459
|
},
|
|
4465
4460
|
},
|
|
@@ -4503,7 +4498,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4503
4498
|
},
|
|
4504
4499
|
cli: {
|
|
4505
4500
|
method: 'indexes sync',
|
|
4506
|
-
example: "
|
|
4501
|
+
example: "llp beta:indexes sync \\\n --api-key 'My API Key' \\\n --index-id index_id",
|
|
4507
4502
|
},
|
|
4508
4503
|
},
|
|
4509
4504
|
},
|
|
@@ -4553,7 +4548,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4553
4548
|
},
|
|
4554
4549
|
cli: {
|
|
4555
4550
|
method: 'indexes list',
|
|
4556
|
-
example: "
|
|
4551
|
+
example: "llp beta:indexes list \\\n --api-key 'My API Key'",
|
|
4557
4552
|
},
|
|
4558
4553
|
},
|
|
4559
4554
|
},
|
|
@@ -4612,7 +4607,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4612
4607
|
cli: {
|
|
4613
4608
|
method: 'retrieval retrieve',
|
|
4614
4609
|
example:
|
|
4615
|
-
"
|
|
4610
|
+
"llp beta:retrieval retrieve \\\n --api-key 'My API Key' \\\n --index-id idx-abc123 \\\n --query 'What are the key findings?'",
|
|
4616
4611
|
},
|
|
4617
4612
|
},
|
|
4618
4613
|
},
|
|
@@ -4663,8 +4658,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4663
4658
|
},
|
|
4664
4659
|
cli: {
|
|
4665
4660
|
method: 'retrieval find',
|
|
4666
|
-
example:
|
|
4667
|
-
"llamacloud-prod beta:retrieval find \\\n --api-key 'My API Key' \\\n --index-id idx-abc123",
|
|
4661
|
+
example: "llp beta:retrieval find \\\n --api-key 'My API Key' \\\n --index-id idx-abc123",
|
|
4668
4662
|
},
|
|
4669
4663
|
},
|
|
4670
4664
|
},
|
|
@@ -4717,7 +4711,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4717
4711
|
cli: {
|
|
4718
4712
|
method: 'retrieval grep',
|
|
4719
4713
|
example:
|
|
4720
|
-
"
|
|
4714
|
+
"llp beta:retrieval grep \\\n --api-key 'My API Key' \\\n --file-id file_id \\\n --index-id idx-abc123 \\\n --pattern 'revenue|profit'",
|
|
4721
4715
|
},
|
|
4722
4716
|
},
|
|
4723
4717
|
},
|
|
@@ -4768,7 +4762,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4768
4762
|
cli: {
|
|
4769
4763
|
method: 'retrieval read',
|
|
4770
4764
|
example:
|
|
4771
|
-
"
|
|
4765
|
+
"llp beta:retrieval read \\\n --api-key 'My API Key' \\\n --file-id file_id \\\n --index-id idx-abc123",
|
|
4772
4766
|
},
|
|
4773
4767
|
},
|
|
4774
4768
|
},
|
|
@@ -4817,7 +4811,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4817
4811
|
},
|
|
4818
4812
|
cli: {
|
|
4819
4813
|
method: 'chat list',
|
|
4820
|
-
example: "
|
|
4814
|
+
example: "llp beta:chat list \\\n --api-key 'My API Key'",
|
|
4821
4815
|
},
|
|
4822
4816
|
},
|
|
4823
4817
|
},
|
|
@@ -4861,7 +4855,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4861
4855
|
},
|
|
4862
4856
|
cli: {
|
|
4863
4857
|
method: 'chat create',
|
|
4864
|
-
example: "
|
|
4858
|
+
example: "llp beta:chat create \\\n --api-key 'My API Key'",
|
|
4865
4859
|
},
|
|
4866
4860
|
},
|
|
4867
4861
|
},
|
|
@@ -4905,8 +4899,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4905
4899
|
},
|
|
4906
4900
|
cli: {
|
|
4907
4901
|
method: 'chat retrieve',
|
|
4908
|
-
example:
|
|
4909
|
-
"llamacloud-prod beta:chat retrieve \\\n --api-key 'My API Key' \\\n --session-id session_id",
|
|
4902
|
+
example: "llp beta:chat retrieve \\\n --api-key 'My API Key' \\\n --session-id session_id",
|
|
4910
4903
|
},
|
|
4911
4904
|
},
|
|
4912
4905
|
},
|
|
@@ -4948,8 +4941,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4948
4941
|
},
|
|
4949
4942
|
cli: {
|
|
4950
4943
|
method: 'chat delete',
|
|
4951
|
-
example:
|
|
4952
|
-
"llamacloud-prod beta:chat delete \\\n --api-key 'My API Key' \\\n --session-id session_id",
|
|
4944
|
+
example: "llp beta:chat delete \\\n --api-key 'My API Key' \\\n --session-id session_id",
|
|
4953
4945
|
},
|
|
4954
4946
|
},
|
|
4955
4947
|
},
|
|
@@ -4993,8 +4985,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4993
4985
|
},
|
|
4994
4986
|
cli: {
|
|
4995
4987
|
method: 'chat get_summary',
|
|
4996
|
-
example:
|
|
4997
|
-
"llamacloud-prod beta:chat get-summary \\\n --api-key 'My API Key' \\\n --session-id session_id",
|
|
4988
|
+
example: "llp beta:chat get-summary \\\n --api-key 'My API Key' \\\n --session-id session_id",
|
|
4998
4989
|
},
|
|
4999
4990
|
},
|
|
5000
4991
|
},
|
|
@@ -5044,7 +5035,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5044
5035
|
cli: {
|
|
5045
5036
|
method: 'chat stream',
|
|
5046
5037
|
example:
|
|
5047
|
-
"
|
|
5038
|
+
"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?'",
|
|
5048
5039
|
},
|
|
5049
5040
|
},
|
|
5050
5041
|
},
|
|
@@ -5088,7 +5079,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5088
5079
|
},
|
|
5089
5080
|
cli: {
|
|
5090
5081
|
method: 'agent_data get',
|
|
5091
|
-
example: "
|
|
5082
|
+
example: "llp beta:agent-data get \\\n --api-key 'My API Key' \\\n --item-id item_id",
|
|
5092
5083
|
},
|
|
5093
5084
|
},
|
|
5094
5085
|
},
|
|
@@ -5133,7 +5124,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5133
5124
|
cli: {
|
|
5134
5125
|
method: 'agent_data update',
|
|
5135
5126
|
example:
|
|
5136
|
-
"
|
|
5127
|
+
"llp beta:agent-data update \\\n --api-key 'My API Key' \\\n --item-id item_id \\\n --data '{foo: bar}'",
|
|
5137
5128
|
},
|
|
5138
5129
|
},
|
|
5139
5130
|
},
|
|
@@ -5176,8 +5167,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5176
5167
|
},
|
|
5177
5168
|
cli: {
|
|
5178
5169
|
method: 'agent_data delete',
|
|
5179
|
-
example:
|
|
5180
|
-
"llamacloud-prod beta:agent-data delete \\\n --api-key 'My API Key' \\\n --item-id item_id",
|
|
5170
|
+
example: "llp beta:agent-data delete \\\n --api-key 'My API Key' \\\n --item-id item_id",
|
|
5181
5171
|
},
|
|
5182
5172
|
},
|
|
5183
5173
|
},
|
|
@@ -5228,7 +5218,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5228
5218
|
cli: {
|
|
5229
5219
|
method: 'agent_data create',
|
|
5230
5220
|
example:
|
|
5231
|
-
"
|
|
5221
|
+
"llp beta:agent-data create \\\n --api-key 'My API Key' \\\n --data '{foo: bar}' \\\n --deployment-name deployment_name",
|
|
5232
5222
|
},
|
|
5233
5223
|
},
|
|
5234
5224
|
},
|
|
@@ -5284,7 +5274,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5284
5274
|
cli: {
|
|
5285
5275
|
method: 'agent_data search',
|
|
5286
5276
|
example:
|
|
5287
|
-
"
|
|
5277
|
+
"llp beta:agent-data search \\\n --api-key 'My API Key' \\\n --deployment-name deployment_name",
|
|
5288
5278
|
},
|
|
5289
5279
|
},
|
|
5290
5280
|
},
|
|
@@ -5341,7 +5331,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5341
5331
|
cli: {
|
|
5342
5332
|
method: 'agent_data aggregate',
|
|
5343
5333
|
example:
|
|
5344
|
-
"
|
|
5334
|
+
"llp beta:agent-data aggregate \\\n --api-key 'My API Key' \\\n --deployment-name deployment_name",
|
|
5345
5335
|
},
|
|
5346
5336
|
},
|
|
5347
5337
|
},
|
|
@@ -5391,7 +5381,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5391
5381
|
cli: {
|
|
5392
5382
|
method: 'agent_data delete_by_query',
|
|
5393
5383
|
example:
|
|
5394
|
-
"
|
|
5384
|
+
"llp beta:agent-data delete-by-query \\\n --api-key 'My API Key' \\\n --deployment-name deployment_name",
|
|
5395
5385
|
},
|
|
5396
5386
|
},
|
|
5397
5387
|
},
|
|
@@ -5445,7 +5435,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5445
5435
|
cli: {
|
|
5446
5436
|
method: 'sheets create',
|
|
5447
5437
|
example:
|
|
5448
|
-
"
|
|
5438
|
+
"llp beta:sheets create \\\n --api-key 'My API Key' \\\n --file-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
|
|
5449
5439
|
},
|
|
5450
5440
|
},
|
|
5451
5441
|
},
|
|
@@ -5500,7 +5490,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5500
5490
|
},
|
|
5501
5491
|
cli: {
|
|
5502
5492
|
method: 'sheets list',
|
|
5503
|
-
example: "
|
|
5493
|
+
example: "llp beta:sheets list \\\n --api-key 'My API Key'",
|
|
5504
5494
|
},
|
|
5505
5495
|
},
|
|
5506
5496
|
},
|
|
@@ -5552,7 +5542,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5552
5542
|
cli: {
|
|
5553
5543
|
method: 'sheets get',
|
|
5554
5544
|
example:
|
|
5555
|
-
"
|
|
5545
|
+
"llp beta:sheets get \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id",
|
|
5556
5546
|
},
|
|
5557
5547
|
},
|
|
5558
5548
|
},
|
|
@@ -5603,7 +5593,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5603
5593
|
cli: {
|
|
5604
5594
|
method: 'sheets get_result_table',
|
|
5605
5595
|
example:
|
|
5606
|
-
"
|
|
5596
|
+
"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",
|
|
5607
5597
|
},
|
|
5608
5598
|
},
|
|
5609
5599
|
},
|
|
@@ -5647,7 +5637,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5647
5637
|
cli: {
|
|
5648
5638
|
method: 'sheets delete_job',
|
|
5649
5639
|
example:
|
|
5650
|
-
"
|
|
5640
|
+
"llp beta:sheets delete-job \\\n --api-key 'My API Key' \\\n --spreadsheet-job-id spreadsheet_job_id",
|
|
5651
5641
|
},
|
|
5652
5642
|
},
|
|
5653
5643
|
},
|
|
@@ -5668,9 +5658,9 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5668
5658
|
"type?: 'ephemeral' | 'user';",
|
|
5669
5659
|
],
|
|
5670
5660
|
response:
|
|
5671
|
-
"{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | '
|
|
5661
|
+
"{ 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; }",
|
|
5672
5662
|
markdown:
|
|
5673
|
-
"## 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' | '
|
|
5663
|
+
"## 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```",
|
|
5674
5664
|
perLanguage: {
|
|
5675
5665
|
go: {
|
|
5676
5666
|
method: 'client.Beta.Directories.New',
|
|
@@ -5698,7 +5688,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5698
5688
|
},
|
|
5699
5689
|
cli: {
|
|
5700
5690
|
method: 'directories create',
|
|
5701
|
-
example: "
|
|
5691
|
+
example: "llp beta:directories create \\\n --api-key 'My API Key' \\\n --name x",
|
|
5702
5692
|
},
|
|
5703
5693
|
},
|
|
5704
5694
|
},
|
|
@@ -5721,9 +5711,9 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5721
5711
|
"types?: 'ephemeral' | 'index' | 'user'[];",
|
|
5722
5712
|
],
|
|
5723
5713
|
response:
|
|
5724
|
-
"{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | '
|
|
5714
|
+
"{ 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; }",
|
|
5725
5715
|
markdown:
|
|
5726
|
-
"## 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' | '
|
|
5716
|
+
"## 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```",
|
|
5727
5717
|
perLanguage: {
|
|
5728
5718
|
go: {
|
|
5729
5719
|
method: 'client.Beta.Directories.List',
|
|
@@ -5751,7 +5741,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5751
5741
|
},
|
|
5752
5742
|
cli: {
|
|
5753
5743
|
method: 'directories list',
|
|
5754
|
-
example: "
|
|
5744
|
+
example: "llp beta:directories list \\\n --api-key 'My API Key'",
|
|
5755
5745
|
},
|
|
5756
5746
|
},
|
|
5757
5747
|
},
|
|
@@ -5765,9 +5755,9 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5765
5755
|
qualified: 'client.beta.directories.get',
|
|
5766
5756
|
params: ['directory_id: string;', 'organization_id?: string;', 'project_id?: string;'],
|
|
5767
5757
|
response:
|
|
5768
|
-
"{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | '
|
|
5758
|
+
"{ 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; }",
|
|
5769
5759
|
markdown:
|
|
5770
|
-
"## 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' | '
|
|
5760
|
+
"## 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```",
|
|
5771
5761
|
perLanguage: {
|
|
5772
5762
|
go: {
|
|
5773
5763
|
method: 'client.Beta.Directories.Get',
|
|
@@ -5795,8 +5785,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5795
5785
|
},
|
|
5796
5786
|
cli: {
|
|
5797
5787
|
method: 'directories get',
|
|
5798
|
-
example:
|
|
5799
|
-
"llamacloud-prod beta:directories get \\\n --api-key 'My API Key' \\\n --directory-id directory_id",
|
|
5788
|
+
example: "llp beta:directories get \\\n --api-key 'My API Key' \\\n --directory-id directory_id",
|
|
5800
5789
|
},
|
|
5801
5790
|
},
|
|
5802
5791
|
},
|
|
@@ -5816,9 +5805,9 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5816
5805
|
'name?: string;',
|
|
5817
5806
|
],
|
|
5818
5807
|
response:
|
|
5819
|
-
"{ id: string; name: string; project_id: string; created_at?: string; deleted_at?: string; description?: string; expires_at?: string; system_metadata?: object; type?: 'ephemeral' | 'index' | '
|
|
5808
|
+
"{ 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; }",
|
|
5820
5809
|
markdown:
|
|
5821
|
-
"## 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' | '
|
|
5810
|
+
"## 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```",
|
|
5822
5811
|
perLanguage: {
|
|
5823
5812
|
go: {
|
|
5824
5813
|
method: 'client.Beta.Directories.Update',
|
|
@@ -5846,8 +5835,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5846
5835
|
},
|
|
5847
5836
|
cli: {
|
|
5848
5837
|
method: 'directories update',
|
|
5849
|
-
example:
|
|
5850
|
-
"llamacloud-prod beta:directories update \\\n --api-key 'My API Key' \\\n --directory-id directory_id",
|
|
5838
|
+
example: "llp beta:directories update \\\n --api-key 'My API Key' \\\n --directory-id directory_id",
|
|
5851
5839
|
},
|
|
5852
5840
|
},
|
|
5853
5841
|
},
|
|
@@ -5889,8 +5877,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5889
5877
|
},
|
|
5890
5878
|
cli: {
|
|
5891
5879
|
method: 'directories delete',
|
|
5892
|
-
example:
|
|
5893
|
-
"llamacloud-prod beta:directories delete \\\n --api-key 'My API Key' \\\n --directory-id directory_id",
|
|
5880
|
+
example: "llp beta:directories delete \\\n --api-key 'My API Key' \\\n --directory-id directory_id",
|
|
5894
5881
|
},
|
|
5895
5882
|
},
|
|
5896
5883
|
},
|
|
@@ -5944,7 +5931,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5944
5931
|
cli: {
|
|
5945
5932
|
method: 'files add',
|
|
5946
5933
|
example:
|
|
5947
|
-
"
|
|
5934
|
+
"llp beta:directories:files add \\\n --api-key 'My API Key' \\\n --directory-id directory_id \\\n --file-id file_id",
|
|
5948
5935
|
},
|
|
5949
5936
|
},
|
|
5950
5937
|
},
|
|
@@ -6003,7 +5990,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
6003
5990
|
cli: {
|
|
6004
5991
|
method: 'files list',
|
|
6005
5992
|
example:
|
|
6006
|
-
"
|
|
5993
|
+
"llp beta:directories:files list \\\n --api-key 'My API Key' \\\n --directory-id directory_id",
|
|
6007
5994
|
},
|
|
6008
5995
|
},
|
|
6009
5996
|
},
|
|
@@ -6055,7 +6042,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
6055
6042
|
cli: {
|
|
6056
6043
|
method: 'files get',
|
|
6057
6044
|
example:
|
|
6058
|
-
"
|
|
6045
|
+
"llp beta:directories:files get \\\n --api-key 'My API Key' \\\n --directory-id directory_id \\\n --directory-file-id directory_file_id",
|
|
6059
6046
|
},
|
|
6060
6047
|
},
|
|
6061
6048
|
},
|
|
@@ -6110,7 +6097,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
6110
6097
|
cli: {
|
|
6111
6098
|
method: 'files update',
|
|
6112
6099
|
example:
|
|
6113
|
-
"
|
|
6100
|
+
"llp beta:directories:files update \\\n --api-key 'My API Key' \\\n --directory-id directory_id \\\n --directory-file-id directory_file_id",
|
|
6114
6101
|
},
|
|
6115
6102
|
},
|
|
6116
6103
|
},
|
|
@@ -6159,7 +6146,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
6159
6146
|
cli: {
|
|
6160
6147
|
method: 'files delete',
|
|
6161
6148
|
example:
|
|
6162
|
-
"
|
|
6149
|
+
"llp beta:directories:files delete \\\n --api-key 'My API Key' \\\n --directory-id directory_id \\\n --directory-file-id directory_file_id",
|
|
6163
6150
|
},
|
|
6164
6151
|
},
|
|
6165
6152
|
},
|
|
@@ -6214,7 +6201,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
6214
6201
|
cli: {
|
|
6215
6202
|
method: 'files upload',
|
|
6216
6203
|
example:
|
|
6217
|
-
"
|
|
6204
|
+
"llp beta:directories:files upload \\\n --api-key 'My API Key' \\\n --directory-id directory_id \\\n --upload-file 'Example data'",
|
|
6218
6205
|
},
|
|
6219
6206
|
},
|
|
6220
6207
|
},
|
|
@@ -6268,7 +6255,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
6268
6255
|
},
|
|
6269
6256
|
cli: {
|
|
6270
6257
|
method: 'batch create',
|
|
6271
|
-
example: "
|
|
6258
|
+
example: "llp beta:batch create \\\n --api-key 'My API Key' \\\n --job-config '{}'",
|
|
6272
6259
|
},
|
|
6273
6260
|
},
|
|
6274
6261
|
},
|
|
@@ -6321,7 +6308,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
6321
6308
|
},
|
|
6322
6309
|
cli: {
|
|
6323
6310
|
method: 'batch list',
|
|
6324
|
-
example: "
|
|
6311
|
+
example: "llp beta:batch list \\\n --api-key 'My API Key'",
|
|
6325
6312
|
},
|
|
6326
6313
|
},
|
|
6327
6314
|
},
|
|
@@ -6366,7 +6353,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
6366
6353
|
},
|
|
6367
6354
|
cli: {
|
|
6368
6355
|
method: 'batch get_status',
|
|
6369
|
-
example: "
|
|
6356
|
+
example: "llp beta:batch get-status \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
6370
6357
|
},
|
|
6371
6358
|
},
|
|
6372
6359
|
},
|
|
@@ -6417,7 +6404,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
6417
6404
|
},
|
|
6418
6405
|
cli: {
|
|
6419
6406
|
method: 'batch cancel',
|
|
6420
|
-
example: "
|
|
6407
|
+
example: "llp beta:batch cancel \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
6421
6408
|
},
|
|
6422
6409
|
},
|
|
6423
6410
|
},
|
|
@@ -6469,8 +6456,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
6469
6456
|
},
|
|
6470
6457
|
cli: {
|
|
6471
6458
|
method: 'job_items list',
|
|
6472
|
-
example:
|
|
6473
|
-
"llamacloud-prod beta:batch:job-items list \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
6459
|
+
example: "llp beta:batch:job-items list \\\n --api-key 'My API Key' \\\n --job-id job_id",
|
|
6474
6460
|
},
|
|
6475
6461
|
},
|
|
6476
6462
|
},
|
|
@@ -6521,7 +6507,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
6521
6507
|
cli: {
|
|
6522
6508
|
method: 'job_items get_processing_results',
|
|
6523
6509
|
example:
|
|
6524
|
-
"
|
|
6510
|
+
"llp beta:batch:job-items get-processing-results \\\n --api-key 'My API Key' \\\n --item-id item_id",
|
|
6525
6511
|
},
|
|
6526
6512
|
},
|
|
6527
6513
|
},
|
|
@@ -6572,7 +6558,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
6572
6558
|
cli: {
|
|
6573
6559
|
method: 'split create',
|
|
6574
6560
|
example:
|
|
6575
|
-
"
|
|
6561
|
+
"llp beta:split create \\\n --api-key 'My API Key' \\\n --document-input '{type: type, value: value}'",
|
|
6576
6562
|
},
|
|
6577
6563
|
},
|
|
6578
6564
|
},
|
|
@@ -6625,7 +6611,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
6625
6611
|
},
|
|
6626
6612
|
cli: {
|
|
6627
6613
|
method: 'split list',
|
|
6628
|
-
example: "
|
|
6614
|
+
example: "llp beta:split list \\\n --api-key 'My API Key'",
|
|
6629
6615
|
},
|
|
6630
6616
|
},
|
|
6631
6617
|
},
|
|
@@ -6669,8 +6655,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
6669
6655
|
},
|
|
6670
6656
|
cli: {
|
|
6671
6657
|
method: 'split get',
|
|
6672
|
-
example:
|
|
6673
|
-
"llamacloud-prod beta:split get \\\n --api-key 'My API Key' \\\n --split-job-id split_job_id",
|
|
6658
|
+
example: "llp beta:split get \\\n --api-key 'My API Key' \\\n --split-job-id split_job_id",
|
|
6674
6659
|
},
|
|
6675
6660
|
},
|
|
6676
6661
|
},
|
|
@@ -6771,7 +6756,7 @@ const EMBEDDED_READMES: { language: string; content: string }[] = [
|
|
|
6771
6756
|
{
|
|
6772
6757
|
language: 'cli',
|
|
6773
6758
|
content:
|
|
6774
|
-
"# 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/
|
|
6759
|
+
"# 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",
|
|
6775
6760
|
},
|
|
6776
6761
|
];
|
|
6777
6762
|
|