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 <LlamaParseReader>= {}

Returns

LlamaParseReader

Overrides

FileReader . constructor

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:143

Properties

apiKey

apiKey: string

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:110


baseUrl

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

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:112


checkInterval

checkInterval: number = 1

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:116


doNotCache?

optional doNotCache: boolean

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:130


doNotUnrollColumns?

optional doNotUnrollColumns: boolean

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:134


fastMode?

optional fastMode: boolean

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:132


gpt4oApiKey?

optional gpt4oApiKey: string

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:140


gpt4oMode

gpt4oMode: boolean = false

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:138


invalidateCache?

optional invalidateCache: boolean

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:128


language

language: Language = "en"

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:122


maxTimeout

maxTimeout: number = 2000

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:118


pageSeperator?

optional pageSeperator: string

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:136


parsingInstruction?

optional parsingInstruction: string

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:124


resultType

resultType: ResultType = "text"

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:114


skipDiagonalText?

optional skipDiagonalText: boolean

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:126


verbose

verbose: boolean = true

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:120

Methods

createJob()

private createJob(data, fileName?): Promise<string>

Parameters

data: Uint8Array

fileName?: string

Returns

Promise<string>

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:163


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.

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:330


getJobResult()

private getJobResult(jobId, resultType): Promise<any>

Parameters

jobId: string

resultType: string

Returns

Promise<any>

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:218


getMimeType()

private getMimeType(data): Promise<object>

Parameters

data: Uint8Array

Returns

Promise<object>

extension

extension: string

mimeType

mimeType: string

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:381


loadData()

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

Parameters

filePath: string

Returns

Promise <Document <Metadata>[]>

Inherited from

FileReader . loadData

Source

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

Promise <Document <Metadata>[]>

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

Overrides

FileReader . loadDataAsContent

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:282


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.

Source

packages/llamaindex/src/readers/LlamaParseReader.ts:307


addMetaData()

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

Parameters

filePath: string

Returns

Function

Parameters

doc: Document <Metadata>

index: number

Returns

void

Inherited from

FileReader . addMetaData

Source

packages/llamaindex/src/readers/type.ts:29