LlamaParseReader

Defined in: packages/cloud/src/reader.ts:38

Represents a reader for parsing files using the LlamaParse API. See https://github.com/run-llama/llama_parse

Extends

• FileReader

Constructors

Constructor

new LlamaParseReader(params): LlamaParseReader

Defined in: packages/cloud/src/reader.ts:166

Parameters

params

Partial<Omit<LlamaParseReader, "language" | "apiKey">> & object = {}

Returns

LlamaParseReader

Overrides

FileReader.constructor

Properties

project_id?

optional project_id: string

Defined in: packages/cloud/src/reader.ts:39

---

organization_id?

optional organization_id: string

Defined in: packages/cloud/src/reader.ts:40

---

apiKey

apiKey: string

Defined in: packages/cloud/src/reader.ts:42

---

baseUrl

baseUrl: string = "https://api.cloud.llamaindex.ai"

Defined in: packages/cloud/src/reader.ts:44

---

resultType

resultType: ResultType = "text"

Defined in: packages/cloud/src/reader.ts:46

---

checkInterval

checkInterval: number = 1

Defined in: packages/cloud/src/reader.ts:48

---

maxTimeout

maxTimeout: number = 2000

Defined in: packages/cloud/src/reader.ts:50

---

verbose

verbose: boolean = true

Defined in: packages/cloud/src/reader.ts:52

---

language

language: ParserLanguages[]

Defined in: packages/cloud/src/reader.ts:54

---

backoffPattern

backoffPattern: BackoffPattern = "linear"

Defined in: packages/cloud/src/reader.ts:58

---

maxCheckInterval

maxCheckInterval: number = 5

Defined in: packages/cloud/src/reader.ts:60

---

maxErrorCount

maxErrorCount: number = 4

Defined in: packages/cloud/src/reader.ts:62

---

parsingInstruction?

optional parsingInstruction: string

Defined in: packages/cloud/src/reader.ts:65

---

skipDiagonalText?

optional skipDiagonalText: boolean

Defined in: packages/cloud/src/reader.ts:67

---

invalidateCache?

optional invalidateCache: boolean

Defined in: packages/cloud/src/reader.ts:69

---

doNotCache?

optional doNotCache: boolean

Defined in: packages/cloud/src/reader.ts:71

---

fastMode?

optional fastMode: boolean

Defined in: packages/cloud/src/reader.ts:73

---

doNotUnrollColumns?

optional doNotUnrollColumns: boolean

Defined in: packages/cloud/src/reader.ts:75

---

pageSeparator?

optional pageSeparator: string

Defined in: packages/cloud/src/reader.ts:77

---

pagePrefix?

optional pagePrefix: string

Defined in: packages/cloud/src/reader.ts:79

---

pageSuffix?

optional pageSuffix: string

Defined in: packages/cloud/src/reader.ts:81

---

gpt4oMode

gpt4oMode: boolean = false

Defined in: packages/cloud/src/reader.ts:83

---

gpt4oApiKey?

optional gpt4oApiKey: string

Defined in: packages/cloud/src/reader.ts:85

---

boundingBox?

optional boundingBox: string

Defined in: packages/cloud/src/reader.ts:87

---

targetPages?

optional targetPages: string

Defined in: packages/cloud/src/reader.ts:89

---

ignoreErrors

ignoreErrors: boolean = true

Defined in: packages/cloud/src/reader.ts:91

---

splitByPage

splitByPage: boolean = true

Defined in: packages/cloud/src/reader.ts:93

---

useVendorMultimodalModel

useVendorMultimodalModel: boolean = false

Defined in: packages/cloud/src/reader.ts:95

---

vendorMultimodalModelName?

optional vendorMultimodalModelName: string

Defined in: packages/cloud/src/reader.ts:97

---

vendorMultimodalApiKey?

optional vendorMultimodalApiKey: string

Defined in: packages/cloud/src/reader.ts:99

---

webhookUrl?

optional webhookUrl: string

Defined in: packages/cloud/src/reader.ts:101

---

premiumMode?

optional premiumMode: boolean

Defined in: packages/cloud/src/reader.ts:102

---

takeScreenshot?

optional takeScreenshot: boolean

Defined in: packages/cloud/src/reader.ts:103

---

disableOcr?

optional disableOcr: boolean

Defined in: packages/cloud/src/reader.ts:104

---

disableReconstruction?

optional disableReconstruction: boolean

Defined in: packages/cloud/src/reader.ts:105

---

inputS3Path?

optional inputS3Path: string

Defined in: packages/cloud/src/reader.ts:106

---

outputS3PathPrefix?

optional outputS3PathPrefix: string

Defined in: packages/cloud/src/reader.ts:107

---

continuousMode?

optional continuousMode: boolean

Defined in: packages/cloud/src/reader.ts:108

---

isFormattingInstruction?

optional isFormattingInstruction: boolean

Defined in: packages/cloud/src/reader.ts:109

---

annotateLinks?

optional annotateLinks: boolean

Defined in: packages/cloud/src/reader.ts:110

---

azureOpenaiDeploymentName?

optional azureOpenaiDeploymentName: string

Defined in: packages/cloud/src/reader.ts:111

---

azureOpenaiEndpoint?

optional azureOpenaiEndpoint: string

Defined in: packages/cloud/src/reader.ts:112

---

azureOpenaiApiVersion?

optional azureOpenaiApiVersion: string

Defined in: packages/cloud/src/reader.ts:113

---

azureOpenaiKey?

optional azureOpenaiKey: string

Defined in: packages/cloud/src/reader.ts:114

---

auto_mode?

optional auto_mode: boolean

Defined in: packages/cloud/src/reader.ts:115

---

auto_mode_trigger_on_image_in_page?

optional auto_mode_trigger_on_image_in_page: boolean

Defined in: packages/cloud/src/reader.ts:116

---

auto_mode_trigger_on_table_in_page?

optional auto_mode_trigger_on_table_in_page: boolean

Defined in: packages/cloud/src/reader.ts:117

---

auto_mode_trigger_on_text_in_page?

optional auto_mode_trigger_on_text_in_page: string

Defined in: packages/cloud/src/reader.ts:118

---

auto_mode_trigger_on_regexp_in_page?

optional auto_mode_trigger_on_regexp_in_page: string

Defined in: packages/cloud/src/reader.ts:119

---

bbox_bottom?

optional bbox_bottom: number

Defined in: packages/cloud/src/reader.ts:120

---

bbox_left?

optional bbox_left: number

Defined in: packages/cloud/src/reader.ts:121

---

bbox_right?

optional bbox_right: number

Defined in: packages/cloud/src/reader.ts:122

---

bbox_top?

optional bbox_top: number

Defined in: packages/cloud/src/reader.ts:123

---

disable_image_extraction?

optional disable_image_extraction: boolean

Defined in: packages/cloud/src/reader.ts:124

---

extract_charts?

optional extract_charts: boolean

Defined in: packages/cloud/src/reader.ts:125

---

guess_xlsx_sheet_name?

optional guess_xlsx_sheet_name: boolean

Defined in: packages/cloud/src/reader.ts:126

---

html_make_all_elements_visible?

optional html_make_all_elements_visible: boolean

Defined in: packages/cloud/src/reader.ts:127

---

html_remove_fixed_elements?

optional html_remove_fixed_elements: boolean

Defined in: packages/cloud/src/reader.ts:128

---

html_remove_navigation_elements?

optional html_remove_navigation_elements: boolean

Defined in: packages/cloud/src/reader.ts:129

---

http_proxy?

optional http_proxy: string

Defined in: packages/cloud/src/reader.ts:130

---

input_url?

optional input_url: string

Defined in: packages/cloud/src/reader.ts:131

---

max_pages?

optional max_pages: number

Defined in: packages/cloud/src/reader.ts:132

---

output_pdf_of_document?

optional output_pdf_of_document: boolean

Defined in: packages/cloud/src/reader.ts:133

---

structured_output?

optional structured_output: boolean

Defined in: packages/cloud/src/reader.ts:134

---

structured_output_json_schema?

optional structured_output_json_schema: string

Defined in: packages/cloud/src/reader.ts:135

---

structured_output_json_schema_name?

optional structured_output_json_schema_name: string

Defined in: packages/cloud/src/reader.ts:136

---

extract_layout?

optional extract_layout: boolean

Defined in: packages/cloud/src/reader.ts:137

---

stdout?

optional stdout: WriteStream

Defined in: packages/cloud/src/reader.ts:140

---

output_tables_as_HTML

output_tables_as_HTML: boolean = false

Defined in: packages/cloud/src/reader.ts:144

---

input_s3_region?

optional input_s3_region: string

Defined in: packages/cloud/src/reader.ts:145

---

output_s3_region?

optional output_s3_region: string

Defined in: packages/cloud/src/reader.ts:146

---

preserve_layout_alignment_across_pages?

optional preserve_layout_alignment_across_pages: boolean

Defined in: packages/cloud/src/reader.ts:147

---

spreadsheet_extract_sub_tables?

optional spreadsheet_extract_sub_tables: boolean

Defined in: packages/cloud/src/reader.ts:148

---

formatting_instruction?

optional formatting_instruction: string

Defined in: packages/cloud/src/reader.ts:149

---

parse_mode?

optional parse_mode: ParsingMode

Defined in: packages/cloud/src/reader.ts:150

---

system_prompt?

optional system_prompt: string

Defined in: packages/cloud/src/reader.ts:151

---

system_prompt_append?

optional system_prompt_append: string

Defined in: packages/cloud/src/reader.ts:152

---

user_prompt?

optional user_prompt: string

Defined in: packages/cloud/src/reader.ts:153

---

job_timeout_in_seconds?

optional job_timeout_in_seconds: number

Defined in: packages/cloud/src/reader.ts:154

---

job_timeout_extra_time_per_page_in_seconds?

optional job_timeout_extra_time_per_page_in_seconds: number

Defined in: packages/cloud/src/reader.ts:155

---

strict_mode_image_extraction?

optional strict_mode_image_extraction: boolean

Defined in: packages/cloud/src/reader.ts:156

---

strict_mode_image_ocr?

optional strict_mode_image_ocr: boolean

Defined in: packages/cloud/src/reader.ts:157

---

strict_mode_reconstruction?

optional strict_mode_reconstruction: boolean

Defined in: packages/cloud/src/reader.ts:158

---

strict_mode_buggy_font?

optional strict_mode_buggy_font: boolean

Defined in: packages/cloud/src/reader.ts:159

---

ignore_document_elements_for_layout_detection?

optional ignore_document_elements_for_layout_detection: boolean

Defined in: packages/cloud/src/reader.ts:160

---

complemental_formatting_instruction?

optional complemental_formatting_instruction: string

Defined in: packages/cloud/src/reader.ts:161

---

content_guideline_instruction?

optional content_guideline_instruction: string

Defined in: packages/cloud/src/reader.ts:162

---

adaptive_long_table?

optional adaptive_long_table: boolean

Defined in: packages/cloud/src/reader.ts:163

---

model?

optional model: string

Defined in: packages/cloud/src/reader.ts:164

Methods

loadData()

loadData(filePath?): Promise<Document<Metadata>[]>

Defined in: packages/cloud/src/reader.ts:501

Parameters

filePath?

string

Returns

Promise<Document<Metadata>[]>

Overrides

FileReader.loadData

---

loadDataAsContent()

loadDataAsContent(fileContent, filename?): Promise<Document<Metadata>[]>

Defined in: packages/cloud/src/reader.ts:529

Loads data from a file and returns an array of Document objects. To be used with resultType "text" or "markdown".

Parameters

fileContent

The content of the file as a Uint8Array.

string | Uint8Array<ArrayBufferLike>

filename?

string

Optional filename for the file.

Returns

Promise<Document<Metadata>[]>

A Promise that resolves to an array of Document objects.

Overrides

FileReader.loadDataAsContent

---

loadJson()

loadJson(filePathOrContent): Promise<Record<string, any>[]>

Defined in: packages/cloud/src/reader.ts:569

Loads data from a file and returns an array of JSON objects. To be used with resultType "json".

Parameters

filePathOrContent

The file path or the file content as a Uint8Array.

string | Uint8Array<ArrayBufferLike>

Returns

Promise<Record<string, any>[]>

A Promise that resolves to an array of JSON objects.

---

getImages()

getImages(jsonResult, downloadPath): Promise<Record<string, any>[]>

Defined in: packages/cloud/src/reader.ts:610

Downloads and saves images from a given JSON result to a specified download path. Currently only supports resultType "json".

Parameters

jsonResult

Record<string, any>[]

The JSON result containing image information.

downloadPath

string

The path where the downloaded images will be saved.

Returns

Promise<Record<string, any>[]>

A Promise that resolves to an array of image objects.