Skip to main content

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<Omit<LlamaParseReader, "apiKey" | "language">> & object

Returns

LlamaParseReader

Overrides

FileReader.constructor

Defined in

packages/cloud/reader/dist/index.d.ts:48

Properties

apiKey

apiKey: string

Defined in

packages/cloud/reader/dist/index.d.ts:15


baseUrl

baseUrl: string

Defined in

packages/cloud/reader/dist/index.d.ts:16


boundingBox?

optional boundingBox: string

Defined in

packages/cloud/reader/dist/index.d.ts:33


checkInterval

checkInterval: number

Defined in

packages/cloud/reader/dist/index.d.ts:18


disableOcr?

optional disableOcr: boolean

Defined in

packages/cloud/reader/dist/index.d.ts:43


disableReconstruction?

optional disableReconstruction: boolean

Defined in

packages/cloud/reader/dist/index.d.ts:44


doNotCache?

optional doNotCache: boolean

Defined in

packages/cloud/reader/dist/index.d.ts:25


doNotUnrollColumns?

optional doNotUnrollColumns: boolean

Defined in

packages/cloud/reader/dist/index.d.ts:27


fastMode?

optional fastMode: boolean

Defined in

packages/cloud/reader/dist/index.d.ts:26


gpt4oApiKey?

optional gpt4oApiKey: string

Defined in

packages/cloud/reader/dist/index.d.ts:32


gpt4oMode

gpt4oMode: boolean

Defined in

packages/cloud/reader/dist/index.d.ts:31


ignoreErrors

ignoreErrors: boolean

Defined in

packages/cloud/reader/dist/index.d.ts:35


inputS3Path?

optional inputS3Path: string

Defined in

packages/cloud/reader/dist/index.d.ts:45


invalidateCache?

optional invalidateCache: boolean

Defined in

packages/cloud/reader/dist/index.d.ts:24


language

language: ParserLanguages[]

Defined in

packages/cloud/reader/dist/index.d.ts:21


maxTimeout

maxTimeout: number

Defined in

packages/cloud/reader/dist/index.d.ts:19


outputS3PathPrefix?

optional outputS3PathPrefix: string

Defined in

packages/cloud/reader/dist/index.d.ts:46


pagePrefix?

optional pagePrefix: string

Defined in

packages/cloud/reader/dist/index.d.ts:29


pageSeparator?

optional pageSeparator: string

Defined in

packages/cloud/reader/dist/index.d.ts:28


pageSuffix?

optional pageSuffix: string

Defined in

packages/cloud/reader/dist/index.d.ts:30


parsingInstruction?

optional parsingInstruction: string

Defined in

packages/cloud/reader/dist/index.d.ts:22


premiumMode?

optional premiumMode: boolean

Defined in

packages/cloud/reader/dist/index.d.ts:41


resultType

resultType: ResultType

Defined in

packages/cloud/reader/dist/index.d.ts:17


skipDiagonalText?

optional skipDiagonalText: boolean

Defined in

packages/cloud/reader/dist/index.d.ts:23


splitByPage

splitByPage: boolean

Defined in

packages/cloud/reader/dist/index.d.ts:36


stdout?

optional stdout: WriteStream

Defined in

packages/cloud/reader/dist/index.d.ts:47


takeScreenshot?

optional takeScreenshot: boolean

Defined in

packages/cloud/reader/dist/index.d.ts:42


targetPages?

optional targetPages: string

Defined in

packages/cloud/reader/dist/index.d.ts:34


useVendorMultimodalModel

useVendorMultimodalModel: boolean

Defined in

packages/cloud/reader/dist/index.d.ts:37


vendorMultimodalApiKey?

optional vendorMultimodalApiKey: string

Defined in

packages/cloud/reader/dist/index.d.ts:39


vendorMultimodalModelName?

optional vendorMultimodalModelName: string

Defined in

packages/cloud/reader/dist/index.d.ts:38


verbose

verbose: boolean

Defined in

packages/cloud/reader/dist/index.d.ts:20


webhookUrl?

optional webhookUrl: string

Defined in

packages/cloud/reader/dist/index.d.ts:40

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/cloud/reader/dist/index.d.ts:78


loadData()

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

Parameters

filePath: string

Returns

Promise<Document<Metadata>[]>

Inherited from

FileReader.loadData

Defined in

packages/core/schema/dist/index.d.ts:187


loadDataAsContent()

loadDataAsContent(fileContent): 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.

Returns

Promise<Document<Metadata>[]>

A Promise object that resolves to an array of Document objects.

Overrides

FileReader.loadDataAsContent

Defined in

packages/cloud/reader/dist/index.d.ts:61


loadJson()

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

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

Parameters

filePathOrContent: string | Uint8Array

The file path to the file or the content of the file as a Buffer

Returns

Promise<Record<string, any>[]>

A Promise that resolves to an array of JSON objects.

Defined in

packages/cloud/reader/dist/index.d.ts:69


addMetaData()

static addMetaData(filePath): (doc, index) => void

Parameters

filePath: string

Returns

Function

Parameters

doc: Document<Metadata>

index: number

Returns

void

Inherited from

FileReader.addMetaData

Defined in

packages/core/schema/dist/index.d.ts:188


getMimeType()

static getMimeType(data): Promise<object>

Parameters

data: Uint8Array

Returns

Promise<object>

extension

extension: string

mime

mime: string

Defined in

packages/cloud/reader/dist/index.d.ts:83