Logo
Type aliases

ParseJobConfig

ParseJobConfig = object

Defined in: packages/cloud/src/client/types.gen.ts:5420

Configuration for llamaparse job

Properties

priority?

optional priority: "low" | "medium" | "high" | "critical" | null

Defined in: packages/cloud/src/client/types.gen.ts:5424

The priority for the request. This field may be ignored or overwritten depending on the organization tier.

custom_metadata?

optional custom_metadata: {[key: string]: unknown; } | null

Defined in: packages/cloud/src/client/types.gen.ts:5428

The custom metadata to attach to the documents.

resource_info?

optional resource_info: {[key: string]: unknown; } | null

Defined in: packages/cloud/src/client/types.gen.ts:5434

The resource info about the file

languages?

optional languages: ParserLanguages[]

Defined in: packages/cloud/src/client/types.gen.ts:5437

parsing_instruction?

optional parsing_instruction: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5438

disable_ocr?

optional disable_ocr: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5439

optional annotate_links: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5440

adaptive_long_table?

optional adaptive_long_table: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5441

compact_markdown_table?

optional compact_markdown_table: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5442

disable_reconstruction?

optional disable_reconstruction: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5443

disable_image_extraction?

optional disable_image_extraction: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5444

invalidate_cache?

optional invalidate_cache: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5445

outlined_table_extraction?

optional outlined_table_extraction: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5446

merge_tables_across_pages_in_markdown?

optional merge_tables_across_pages_in_markdown: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5447

output_pdf_of_document?

optional output_pdf_of_document: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5448

do_not_cache?

optional do_not_cache: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5449

fast_mode?

optional fast_mode: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5450

skip_diagonal_text?

optional skip_diagonal_text: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5451

preserve_layout_alignment_across_pages?

optional preserve_layout_alignment_across_pages: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5452

gpt4o_mode?

optional gpt4o_mode: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5453

gpt4o_api_key?

optional gpt4o_api_key: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5454

do_not_unroll_columns?

optional do_not_unroll_columns: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5455

extract_layout?

optional extract_layout: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5456

high_res_ocr?

optional high_res_ocr: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5457

html_make_all_elements_visible?

optional html_make_all_elements_visible: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5458

html_remove_navigation_elements?

optional html_remove_navigation_elements: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5459

html_remove_fixed_elements?

optional html_remove_fixed_elements: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5460

guess_xlsx_sheet_name?

optional guess_xlsx_sheet_name: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5461

page_separator?

optional page_separator: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5462

bounding_box?

optional bounding_box: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5463

bbox_top?

optional bbox_top: number | null

Defined in: packages/cloud/src/client/types.gen.ts:5464

bbox_right?

optional bbox_right: number | null

Defined in: packages/cloud/src/client/types.gen.ts:5465

bbox_bottom?

optional bbox_bottom: number | null

Defined in: packages/cloud/src/client/types.gen.ts:5466

bbox_left?

optional bbox_left: number | null

Defined in: packages/cloud/src/client/types.gen.ts:5467

target_pages?

optional target_pages: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5468

use_vendor_multimodal_model?

optional use_vendor_multimodal_model: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5469

vendor_multimodal_model_name?

optional vendor_multimodal_model_name: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5470

model?

optional model: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5471

vendor_multimodal_api_key?

optional vendor_multimodal_api_key: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5472

page_prefix?

optional page_prefix: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5473

page_suffix?

optional page_suffix: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5474

webhook_url?

optional webhook_url: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5475

preset?

optional preset: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5476

take_screenshot?

optional take_screenshot: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5477

is_formatting_instruction?

optional is_formatting_instruction: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5478

premium_mode?

optional premium_mode: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5479

continuous_mode?

optional continuous_mode: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5480

input_s3_path?

optional input_s3_path: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5484

If specified, llamaParse will take the specified file. should be a valid s3:// url

input_s3_region?

optional input_s3_region: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5488

The region for the input S3 bucket.

output_s3_path_prefix?

optional output_s3_path_prefix: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5492

If specified, llamaParse will save the output to the specified path. All output file will use this 'prefix' should be a valid s3:// url

output_s3_region?

optional output_s3_region: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5496

The region for the output S3 bucket.

project_id?

optional project_id: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5497

azure_openai_deployment_name?

optional azure_openai_deployment_name: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5498

azure_openai_endpoint?

optional azure_openai_endpoint: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5499

azure_openai_api_version?

optional azure_openai_api_version: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5500

azure_openai_key?

optional azure_openai_key: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5501

input_url?

optional input_url: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5502

http_proxy?

optional http_proxy: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5503

auto_mode?

optional auto_mode: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5504

auto_mode_trigger_on_regexp_in_page?

optional auto_mode_trigger_on_regexp_in_page: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5505

auto_mode_trigger_on_text_in_page?

optional auto_mode_trigger_on_text_in_page: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5506

auto_mode_trigger_on_table_in_page?

optional auto_mode_trigger_on_table_in_page: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5507

auto_mode_trigger_on_image_in_page?

optional auto_mode_trigger_on_image_in_page: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5508

auto_mode_configuration_json?

optional auto_mode_configuration_json: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5509

structured_output?

optional structured_output: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5510

structured_output_json_schema?

optional structured_output_json_schema: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5511

structured_output_json_schema_name?

optional structured_output_json_schema_name: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5512

max_pages?

optional max_pages: number | null

Defined in: packages/cloud/src/client/types.gen.ts:5513

max_pages_enforced?

optional max_pages_enforced: number | null

Defined in: packages/cloud/src/client/types.gen.ts:5514

extract_charts?

optional extract_charts: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5515

formatting_instruction?

optional formatting_instruction: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5516

complemental_formatting_instruction?

optional complemental_formatting_instruction: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5517

content_guideline_instruction?

optional content_guideline_instruction: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5518

spreadsheet_extract_sub_tables?

optional spreadsheet_extract_sub_tables: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5519

job_timeout_in_seconds?

optional job_timeout_in_seconds: number | null

Defined in: packages/cloud/src/client/types.gen.ts:5520

job_timeout_extra_time_per_page_in_seconds?

optional job_timeout_extra_time_per_page_in_seconds: number | null

Defined in: packages/cloud/src/client/types.gen.ts:5521

strict_mode_image_extraction?

optional strict_mode_image_extraction: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5522

strict_mode_image_ocr?

optional strict_mode_image_ocr: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5523

strict_mode_reconstruction?

optional strict_mode_reconstruction: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5524

strict_mode_buggy_font?

optional strict_mode_buggy_font: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5525

save_images?

optional save_images: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5526

hide_headers?

optional hide_headers: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5527

hide_footers?

optional hide_footers: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5528

page_header_prefix?

optional page_header_prefix: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5529

page_header_suffix?

optional page_header_suffix: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5530

page_footer_prefix?

optional page_footer_prefix: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5531

page_footer_suffix?

optional page_footer_suffix: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5532

ignore_document_elements_for_layout_detection?

optional ignore_document_elements_for_layout_detection: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5533

output_tables_as_HTML?

optional output_tables_as_HTML: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5534

internal_is_screenshot_job?

optional internal_is_screenshot_job: boolean | null

Defined in: packages/cloud/src/client/types.gen.ts:5535

parse_mode?

optional parse_mode: ParsingMode | null

Defined in: packages/cloud/src/client/types.gen.ts:5536

system_prompt?

optional system_prompt: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5537

system_prompt_append?

optional system_prompt_append: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5538

user_prompt?

optional user_prompt: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5539

page_error_tolerance?

optional page_error_tolerance: number | null

Defined in: packages/cloud/src/client/types.gen.ts:5540

replace_failed_page_mode?

optional replace_failed_page_mode: FailPageMode | null

Defined in: packages/cloud/src/client/types.gen.ts:5541

replace_failed_page_with_error_message_prefix?

optional replace_failed_page_with_error_message_prefix: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5542

replace_failed_page_with_error_message_suffix?

optional replace_failed_page_with_error_message_suffix: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5543

markdown_table_multiline_header_separator?

optional markdown_table_multiline_header_separator: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5544

type?

optional type: "parse"

Defined in: packages/cloud/src/client/types.gen.ts:5545

file_name

file_name: string

Defined in: packages/cloud/src/client/types.gen.ts:5549

The file name.

original_file_name

original_file_name: string

Defined in: packages/cloud/src/client/types.gen.ts:5553

The original file name.

file_key

file_key: string

Defined in: packages/cloud/src/client/types.gen.ts:5557

The file key.

lang

lang: string

Defined in: packages/cloud/src/client/types.gen.ts:5561

The language.

outputBucket?

optional outputBucket: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5565

The output bucket.

file_id?

optional file_id: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5569

The file ID.

pipeline_id?

optional pipeline_id: string | null

Defined in: packages/cloud/src/client/types.gen.ts:5573

The pipeline ID.

Edit on GitHub

PaginatedResponseAggregateGroup

Previous Page

ParsePlanLevel

Next Page

On this page

Propertiespriority?custom_metadata?resource_info?languages?parsing_instruction?disable_ocr?annotate_links?adaptive_long_table?compact_markdown_table?disable_reconstruction?disable_image_extraction?invalidate_cache?outlined_table_extraction?merge_tables_across_pages_in_markdown?output_pdf_of_document?do_not_cache?fast_mode?skip_diagonal_text?preserve_layout_alignment_across_pages?gpt4o_mode?gpt4o_api_key?do_not_unroll_columns?extract_layout?high_res_ocr?html_make_all_elements_visible?html_remove_navigation_elements?html_remove_fixed_elements?guess_xlsx_sheet_name?page_separator?bounding_box?bbox_top?bbox_right?bbox_bottom?bbox_left?target_pages?use_vendor_multimodal_model?vendor_multimodal_model_name?model?vendor_multimodal_api_key?page_prefix?page_suffix?webhook_url?preset?take_screenshot?is_formatting_instruction?premium_mode?continuous_mode?input_s3_path?input_s3_region?output_s3_path_prefix?output_s3_region?project_id?azure_openai_deployment_name?azure_openai_endpoint?azure_openai_api_version?azure_openai_key?input_url?http_proxy?auto_mode?auto_mode_trigger_on_regexp_in_page?auto_mode_trigger_on_text_in_page?auto_mode_trigger_on_table_in_page?auto_mode_trigger_on_image_in_page?auto_mode_configuration_json?structured_output?structured_output_json_schema?structured_output_json_schema_name?max_pages?max_pages_enforced?extract_charts?formatting_instruction?complemental_formatting_instruction?content_guideline_instruction?spreadsheet_extract_sub_tables?job_timeout_in_seconds?job_timeout_extra_time_per_page_in_seconds?strict_mode_image_extraction?strict_mode_image_ocr?strict_mode_reconstruction?strict_mode_buggy_font?save_images?hide_headers?hide_footers?page_header_prefix?page_header_suffix?page_footer_prefix?page_footer_suffix?ignore_document_elements_for_layout_detection?output_tables_as_HTML?internal_is_screenshot_job?parse_mode?system_prompt?system_prompt_append?user_prompt?page_error_tolerance?replace_failed_page_mode?replace_failed_page_with_error_message_prefix?replace_failed_page_with_error_message_suffix?markdown_table_multiline_header_separator?type?file_nameoriginal_file_namefile_keylangoutputBucket?file_id?pipeline_id?