LegacyParseJobConfig

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:3981

The top side of the bounding box.

bboxRight?

optional bboxRight: number | null

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

The right side of the bounding box.

bboxBottom?

optional bboxBottom: number | null

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

The bottom side of the bounding box.

bboxLeft?

optional bboxLeft: number | null

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

The left side of the bounding box.

disableReconstruction?

optional disableReconstruction: boolean | null

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

Whether to disable markdown reconstruction.

targetPages?

optional targetPages: string | null

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

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:4005

True if parsing happen in multimodal mode.

multimodalModel?

optional multimodalModel: string | null

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

The multimodal model to use.

model?

optional model: string | null

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

The model to use.

vendorAPIKey?

optional vendorAPIKey: string | null

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

The multimodal vendor API key.

pagePrefix?

optional pagePrefix: string | null

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

A page prefix to add before each page.

pageSuffix?

optional pageSuffix: string | null

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

A page suffix to add after each page.

webhookUrl?

optional webhookUrl: string | null

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

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:4033

The preset of options to be used.

takeScreenshot?

optional takeScreenshot: boolean

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

Force to capture an image of each pages

isFormattingInstruction?

optional isFormattingInstruction: boolean

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

Allow the parsing instruction to also format the output.

premiumMode?

optional premiumMode: boolean

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

Whether to use premiumMode pipeline.

continuousMode?

optional continuousMode: boolean

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

Whether to use continuousMode pipeline.

disableOcr?

optional disableOcr: boolean

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

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:4057

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:4061

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:4065

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:4069

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:4073

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:4077

The region for the input S3 bucket.

outputS3PathPrefix?

optional outputS3PathPrefix: string | null

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

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:4085

The region for the output S3 bucket.

projectId?

optional projectId: string | null

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

The project ID.

azureOpenAiDeploymentName?

optional azureOpenAiDeploymentName: string | null

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

Custom azure deployment name.

azureOpenAiEndpoint?

optional azureOpenAiEndpoint: string | null

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

Custom azure endpoint.

azureOpenAiApiVersion?

optional azureOpenAiApiVersion: string | null

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

Custom azure API version.

azureOpenAiKey?

optional azureOpenAiKey: string | null

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

Custom azure API key.

autoMode?

optional autoMode: boolean

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

Whether to use auto mode.

autoModeTriggerOnTableInPage?

optional autoModeTriggerOnTableInPage: boolean

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

Whether to trigger on table in page.

autoModeTriggerOnImageInPage?

optional autoModeTriggerOnImageInPage: boolean

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

Whether to trigger on image in page.

autoModeTriggerOnRegexpInPage?

optional autoModeTriggerOnRegexpInPage: string | null

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

The regexp to trigger on.

autoModeTriggerOnTextInPage?

optional autoModeTriggerOnTextInPage: string | null

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

The text to trigger on.

autoModeConfigurationJSON?

optional autoModeConfigurationJSON: string | null

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

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:4133

Whether to use structured output.

structuredOutputJSONSchema?

optional structuredOutputJSONSchema: string | null

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

The structured output JSON schema.

structuredOutputJSONSchemaName?

optional structuredOutputJSONSchemaName: string | null

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

The structured output JSON schema name.

maxPages?

optional maxPages: number | null

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

The maximum number of pages to parse.

extractCharts?

optional extractCharts: boolean

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

Extract charts from the document.

formattingInstruction?

optional formattingInstruction: string | null

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

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:4157

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:4161

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:4165

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:4169

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:4173

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:4177

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:4181

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:4185

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:4189

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:4193

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:4197

The parsing mode.

systemPrompt?

optional systemPrompt: string | null

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

The system prompt.

systemPromptAppend?

optional systemPromptAppend: string | null

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

The append to system prompt.

userPrompt?

optional userPrompt: string | null

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

The user prompt.

LegacyParseJobConfig

On this page