Class: LlamaParseReader
Represents a reader for parsing files using the LlamaParse API. See https://github.com/run-llama/llama_parse
Extends
Constructors
new LlamaParseReader()
new LlamaParseReader(
params
):LlamaParseReader
Parameters
• params: Partial
<LlamaParseReader
> = {}
Returns
Overrides
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:150
Properties
apiKey
apiKey:
string
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:105
baseUrl
baseUrl:
string
="https://api.cloud.llamaindex.ai/api/parsing"
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:107
boundingBox?
optional
boundingBox:string
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:137
checkInterval
checkInterval:
number
=1
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:111
doNotCache?
optional
doNotCache:boolean
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:125
doNotUnrollColumns?
optional
doNotUnrollColumns:boolean
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:129
fastMode?
optional
fastMode:boolean
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:127
gpt4oApiKey?
optional
gpt4oApiKey:string
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:135
gpt4oMode
gpt4oMode:
boolean
=false
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:133
ignoreErrors
ignoreErrors:
boolean
=true
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:141
invalidateCache?
optional
invalidateCache:boolean
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:123
language
language:
Language
="en"
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:117
maxTimeout
maxTimeout:
number
=2000
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:113
pageSeparator?
optional
pageSeparator:string
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:131
parsingInstruction?
optional
parsingInstruction:string
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:119
resultType
resultType:
ResultType
="text"
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:109
skipDiagonalText?
optional
skipDiagonalText:boolean
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:121
targetPages?
optional
targetPages:string
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:139
useVendorMultimodalModel
useVendorMultimodalModel:
boolean
=false
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:143
vendorMultimodalApiKey?
optional
vendorMultimodalApiKey:string
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:147
vendorMultimodalModelName?
optional
vendorMultimodalModelName:string
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:145
verbose
verbose:
boolean
=true
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:115
Methods
getImages()
getImages(
jsonResult
,downloadPath
):Promise
<Record
<string
,any
>[]>
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 to save the downloaded images.
Returns
Promise
<Record
<string
, any
>[]>
A Promise that resolves to an array of image objects.
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:369
loadData()
Parameters
• filePath: string
Returns
Inherited from
Defined in
packages/llamaindex/src/readers/type.ts:20
loadDataAsContent()
loadDataAsContent(
fileContent
,fileName
?):Promise
<Document
<Metadata
>[]>
Loads data from a file and returns an array of Document objects. To be used with resultType = "text" and "markdown"
Parameters
• fileContent: Uint8Array
The content of the file to be loaded.
• fileName?: string
The optional name of the file to be loaded.
Returns
A Promise object that resolves to an array of Document objects.
Overrides
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:301
loadJson()
loadJson(
file
):Promise
<Record
<string
,any
>[]>
Loads data from a file and returns an array of JSON objects. To be used with resultType = "json"
Parameters
• file: string
The path to the file to be loaded.
Returns
Promise
<Record
<string
, any
>[]>
A Promise that resolves to an array of JSON objects.
Defined in
packages/llamaindex/src/readers/LlamaParseReader.ts:336
addMetaData()
static
addMetaData(filePath
): (doc
,index
) =>void
Parameters
• filePath: string
Returns
Function
Parameters
• index: number
Returns
void
Inherited from
Defined in
packages/llamaindex/src/readers/type.ts:29
getMimeType()
static
getMimeType(data
):Promise
<object
>
Parameters
• data: Uint8Array
Returns
Promise
<object
>
extension
extension:
string
mime
mime:
string