A string describing a bounding box to use to parse the document. Contain 4 value between 0 to 1 representing in clock wise order the margin top, right, bottom, left of the selection bounding box in ratio of the document.

bboxTop?

optional bboxTop: number | null

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

The top side of the bounding box.

bboxRight?

optional bboxRight: number | null

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

The right side of the bounding box.

bboxBottom?

optional bboxBottom: number | null

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

The bottom side of the bounding box.

bboxLeft?

optional bboxLeft: number | null

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

The left side of the bounding box.

disableReconstruction?

optional disableReconstruction: boolean | null

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

Whether to disable markdown reconstruction.

targetPages?

optional targetPages: string | null

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

A string containing a list of comma separated containing the page number to extract. If not specified all pages are extracted from the document. The first page is the page 0.

multimodalPipeline?

optional multimodalPipeline: boolean | null

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

True if parsing happen in multimodal mode.

multimodalModel?

optional multimodalModel: string | null

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

The multimodal model to use.

model?

optional model: string | null

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

The model to use.

vendorAPIKey?

optional vendorAPIKey: string | null

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

The multimodal vendor API key.

pagePrefix?

optional pagePrefix: string | null

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

A page prefix to add before each page.

pageSuffix?

optional pageSuffix: string | null

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

A page suffix to add after each page.

webhookUrl?

optional webhookUrl: string | null

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

The URL that needs to be called at the end of the parsing job.

preset?

optional preset: string | null

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

The preset of options to be used.

takeScreenshot?

optional takeScreenshot: boolean

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

Force to capture an image of each pages

isFormattingInstruction?

optional isFormattingInstruction: boolean

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

Allow the parsing instruction to also format the output.

premiumMode?

optional premiumMode: boolean

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

Whether to use premiumMode pipeline.

continuousMode?

optional continuousMode: boolean

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

Whether to use continuousMode pipeline.

disableOcr?

optional disableOcr: boolean

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

Disable the OCR on the document. LlamaParse will only extract the copyable text from the document

disableImageExtraction?

optional disableImageExtraction: boolean

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

Disable the image extraction from the document. LlamaParse will not extract any image from the document.

annotateLinks?

optional annotateLinks: boolean

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

Annotate links in markdown. LlamaParse will try to add links from document into the markdown.

adaptiveLongTable?

optional adaptiveLongTable: boolean

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

Adaptive long table. LlamaParse will try to detect long table and adapt the output.

compactMarkdownTable?

optional compactMarkdownTable: boolean

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

Compact markdown table. LlamaParse will compact the markdown table to not include too many spaces.

inputS3Path?

optional inputS3Path: string | null

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

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

inputS3Region?

optional inputS3Region: string | null

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

The region for the input S3 bucket.

outputS3PathPrefix?

optional outputS3PathPrefix: string | null

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

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

outputS3Region?

optional outputS3Region: string | null

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

The region for the output S3 bucket.

projectId?

optional projectId: string | null

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

The project ID.

azureOpenAiDeploymentName?

optional azureOpenAiDeploymentName: string | null

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

Custom azure deployment name.

azureOpenAiEndpoint?

optional azureOpenAiEndpoint: string | null

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

Custom azure endpoint.

azureOpenAiApiVersion?

optional azureOpenAiApiVersion: string | null

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

Custom azure API version.

azureOpenAiKey?

optional azureOpenAiKey: string | null

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

Custom azure API key.

autoMode?

optional autoMode: boolean

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

Whether to use auto mode.

autoModeTriggerOnTableInPage?

optional autoModeTriggerOnTableInPage: boolean

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

Whether to trigger on table in page.

autoModeTriggerOnImageInPage?

optional autoModeTriggerOnImageInPage: boolean

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

Whether to trigger on image in page.

autoModeTriggerOnRegexpInPage?

optional autoModeTriggerOnRegexpInPage: string | null

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

The regexp to trigger on.

autoModeTriggerOnTextInPage?

optional autoModeTriggerOnTextInPage: string | null

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

The text to trigger on.

autoModeConfigurationJSON?

optional autoModeConfigurationJSON: string | null

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

The auto mode configuration JSON. This is a JSON string that contains the configuration for the auto mode.

structuredOutput?

optional structuredOutput: boolean

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

Whether to use structured output.

structuredOutputJSONSchema?

optional structuredOutputJSONSchema: string | null

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

The structured output JSON schema.

structuredOutputJSONSchemaName?

optional structuredOutputJSONSchemaName: string | null

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

The structured output JSON schema name.

maxPages?

optional maxPages: number | null

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

The maximum number of pages to parse.

extractCharts?

optional extractCharts: boolean

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

Extract charts from the document.

formattingInstruction?

optional formattingInstruction: string | null

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

A natural language instruction on how to format the result. Override LlamaParse default instruction.

complementalFormattingInstruction?

optional complementalFormattingInstruction: string | null

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

A natural language instruction on how to format the result that complement LlamaParse default instruction.

contentGuidelineInstruction?

optional contentGuidelineInstruction: string | null

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

A natural language instruction on how to transform the content of the result (not the format).

jobTimeoutInSeconds?

optional jobTimeoutInSeconds: number | null

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

Manually set a timeout in second for a job. Minimum is 120

jobTimeoutExtraTimePerPageInSeconds?

optional jobTimeoutExtraTimePerPageInSeconds: number | null

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

Manually set additional time per page for timeout in second for a job.

strictModeImageExtraction?

optional strictModeImageExtraction: boolean

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

If true, the job will fail when we are not able to extract an image from a document.

strictModeImageOCR?

optional strictModeImageOCR: boolean

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

If true, the job will fail when we are not able to OCR an image from a document.

strictModeReconstruction?

optional strictModeReconstruction: boolean

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

If true, the job will fail when we are not able to transform a page to Markdown in a document.

strictModeBuggyFont?

optional strictModeBuggyFont: boolean

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

If true, the job will fail when we are not able to extract a glyph from the document due to buggy font.

ignoreDocumentElementsForLayoutDetection?

optional ignoreDocumentElementsForLayoutDetection: boolean

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

If true, the job will ignore document element for layout detection, and instead just rely on a visual model, only apply to layout detection.

outputTablesAsHTML?

optional outputTablesAsHTML: boolean

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

If true, the job will output tables as HTML in the markdown output, useful for merged cells.

parseMode?

optional parseMode: string | null

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

The parsing mode.

systemPrompt?

optional systemPrompt: string | null

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

The system prompt.

systemPromptAppend?

optional systemPromptAppend: string | null

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

The append to system prompt.

userPrompt?

optional userPrompt: string | null

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

The user prompt.

pageHeaderPrefix?

optional pageHeaderPrefix: string | null

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

The page header prefix.

pageHeaderSuffix?

optional pageHeaderSuffix: string | null

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

The page header suffix.

pageFooterPrefix?

optional pageFooterPrefix: string | null

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

The page footer prefix.

pageFooterSuffix?

optional pageFooterSuffix: string | null

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

The page footer suffix.

hideHeaders?

optional hideHeaders: boolean

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

Whether to hide headers in the output.

hideFooters?

optional hideFooters: boolean

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

Whether to hide footers in the output.

Edit on GitHub

KeywordTableIndexChatEngineOptions

ListBatchesApiV1BetaBatchesGetData

Properties custom_metadata?resource_info?type?userId fileName originalFileName fileKey inputUrl?httpProxy?fastMode?lang template?pipelineId?outputBucket?fileId?fullFilePath?fromLLamaCloud?skipDiagonalText?preserveLayoutAlignmentAcrossPages?invalidateCache outputPDFOfDocument?outlinedTableExtraction?mergeTablesAcrossPagesInMarkdown?saveImages?gpt4o?openAIAPIKey doNotUnrollColumns?spreadSheetExtractSubTables?extractLayout?highResOcr?htmlMakeAllElementsVisible?htmlRemoveFixedElements?htmlRemoveNavigationElements?guessXLSXSheetName?doNotCache?pageSeparator?boundingBox?bboxTop?bboxRight?bboxBottom?bboxLeft?disableReconstruction?targetPages?multimodalPipeline?multimodalModel?model?vendorAPIKey?pagePrefix?pageSuffix?webhookUrl?preset?takeScreenshot?isFormattingInstruction?premiumMode?continuousMode?disableOcr?disableImageExtraction?annotateLinks?adaptiveLongTable?compactMarkdownTable?inputS3Path?inputS3Region?outputS3PathPrefix?outputS3Region?projectId?azureOpenAiDeploymentName?azureOpenAiEndpoint?azureOpenAiApiVersion?azureOpenAiKey?autoMode?autoModeTriggerOnTableInPage?autoModeTriggerOnImageInPage?autoModeTriggerOnRegexpInPage?autoModeTriggerOnTextInPage?autoModeConfigurationJSON?structuredOutput?structuredOutputJSONSchema?structuredOutputJSONSchemaName?maxPages?extractCharts?formattingInstruction?complementalFormattingInstruction?contentGuidelineInstruction?jobTimeoutInSeconds?jobTimeoutExtraTimePerPageInSeconds?strictModeImageExtraction?strictModeImageOCR?strictModeReconstruction?strictModeBuggyFont?ignoreDocumentElementsForLayoutDetection?outputTablesAsHTML?parseMode?systemPrompt?systemPromptAppend?userPrompt?pageHeaderPrefix?pageHeaderSuffix?pageFooterPrefix?pageFooterSuffix?hideHeaders?hideFooters?

LegacyParseJobConfig

On this page