跳到主要内容

llamaindex

Enumerations

Classes

Interfaces

Type Aliases

AnthropicStreamToken

Ƭ AnthropicStreamToken: Object

Type declaration

NameType
completionstring
log_id?string
modelstring
stop?boolean
stop_reasonstring | undefined

Defined in

packages/core/src/callbacks/CallbackManager.ts:42


ChoiceSelectPrompt

Ƭ ChoiceSelectPrompt: typeof defaultChoiceSelectPrompt

Defined in

packages/core/src/Prompt.ts:165


CompleteFileSystem

Ƭ CompleteFileSystem: GenericFileSystem & WalkableFileSystem

Defined in

packages/core/src/storage/FileSystem.ts:49


CompletionResponse

Ƭ CompletionResponse: ChatResponse

Defined in

packages/core/src/llm/LLM.ts:51


CondenseQuestionPrompt

Ƭ CondenseQuestionPrompt: typeof defaultCondenseQuestionPrompt

Defined in

packages/core/src/Prompt.ts:346


ContextSystemPrompt

Ƭ ContextSystemPrompt: typeof defaultContextSystemPrompt

Defined in

packages/core/src/Prompt.ts:367


EventTag

Ƭ EventTag: "intermediate" | "final"

Defined in

packages/core/src/callbacks/CallbackManager.ts:10


EventType

Ƭ EventType: "retrieve" | "llmPredict" | "wrapper"

Defined in

packages/core/src/callbacks/CallbackManager.ts:11


ImageNodeConstructorProps

Ƭ ImageNodeConstructorProps<T>: Pick<ImageNode<T>, "image" | "id_"> & Partial<ImageNode<T>>

Type parameters

NameType
Textends Metadata

Defined in

packages/core/src/Node.ts:290


ImageType

Ƭ ImageType: string | Blob | URL

Defined in

packages/core/src/Node.ts:288


KeywordExtractPrompt

Ƭ KeywordExtractPrompt: typeof defaultKeywordExtractPrompt

Defined in

packages/core/src/Prompt.ts:382


ListIndex

Ƭ ListIndex: SummaryIndex

Defined in

packages/core/src/indices/summary/SummaryIndex.ts:264


ListIndexLLMRetriever

Ƭ ListIndexLLMRetriever: SummaryIndexLLMRetriever

Defined in

packages/core/src/indices/summary/SummaryIndexRetriever.ts:134


ListIndexRetriever

Ƭ ListIndexRetriever: SummaryIndexRetriever

Defined in

packages/core/src/indices/summary/SummaryIndexRetriever.ts:133


ListRetrieverMode

Ƭ ListRetrieverMode: SummaryRetrieverMode

Defined in

packages/core/src/indices/summary/SummaryIndex.ts:265


MessageContent

Ƭ MessageContent: string | MessageContentDetail[]

Extended type for the content of a message that allows for multi-modal messages.

Defined in

packages/core/src/ChatEngine.ts:350


MessageType

Ƭ MessageType: "user" | "assistant" | "system" | "generic" | "function" | "memory"

Defined in

packages/core/src/llm/LLM.ts:31


Metadata

Ƭ Metadata: Record<string, any>

Defined in

packages/core/src/Node.ts:27


OpenAIStreamToken

Ƭ OpenAIStreamToken: DefaultStreamToken

Defined in

packages/core/src/callbacks/CallbackManager.ts:41


QueryKeywordExtractPrompt

Ƭ QueryKeywordExtractPrompt: typeof defaultQueryKeywordExtractPrompt

Defined in

packages/core/src/Prompt.ts:398


RefinePrompt

Ƭ RefinePrompt: typeof defaultRefinePrompt

Defined in

packages/core/src/Prompt.ts:106


RelatedNodeType

Ƭ RelatedNodeType<T>: RelatedNodeInfo<T> | RelatedNodeInfo<T>[]

Type parameters

NameType
Textends Metadata = Metadata

Defined in

packages/core/src/Node.ts:36


SimpleDirectoryReaderLoadDataProps

Ƭ SimpleDirectoryReaderLoadDataProps: Object

Type declaration

NameType
defaultReader?BaseReader | null
directoryPathstring
fileExtToReader?Record<string, BaseReader>
fs?CompleteFileSystem

Defined in

packages/core/src/readers/SimpleDirectoryReader.ts:52


SimplePrompt

Ƭ SimplePrompt: (input: Record<string, string | undefined>) => string

Type declaration

▸ (input): string

A SimplePrompt is a function that takes a dictionary of inputs and returns a string. NOTE this is a different interface compared to LlamaIndex Python NOTE 2: we default to empty string to make it easy to calculate prompt sizes

Parameters
NameType
inputRecord<string, string | undefined>
Returns

string

Defined in

packages/core/src/Prompt.ts:10


SubQuestionPrompt

Ƭ SubQuestionPrompt: typeof defaultSubQuestionPrompt

Defined in

packages/core/src/Prompt.ts:314


SummaryPrompt

Ƭ SummaryPrompt: typeof defaultSummaryPrompt

Defined in

packages/core/src/Prompt.ts:73


TextQaPrompt

Ƭ TextQaPrompt: typeof defaultTextQaPrompt

Defined in

packages/core/src/Prompt.ts:37


TreeSummarizePrompt

Ƭ TreeSummarizePrompt: typeof defaultTreeSummarizePrompt

Defined in

packages/core/src/Prompt.ts:131

Variables

ALL_AVAILABLE_ANTHROPIC_MODELS

Const ALL_AVAILABLE_ANTHROPIC_MODELS: Object

Type declaration

NameType
claude-2{ contextWindow: number = 200000 }
claude-2.contextWindownumber
claude-instant-1{ contextWindow: number = 100000 }
claude-instant-1.contextWindownumber

Defined in

packages/core/src/llm/LLM.ts:640


ALL_AVAILABLE_LLAMADEUCE_MODELS

Const ALL_AVAILABLE_LLAMADEUCE_MODELS: Object

Type declaration

NameType
Llama-2-13b-chat-4bit{ contextWindow: number = 4096; replicateApi: string = "meta/llama-2-13b-chat:f4e2de70d66816a838a89eeeb621910adffb0dd0baba3976c96980970978018d" }
Llama-2-13b-chat-4bit.contextWindownumber
Llama-2-13b-chat-4bit.replicateApistring
Llama-2-13b-chat-old{ contextWindow: number = 4096; replicateApi: string = "a16z-infra/llama13b-v2-chat:df7690f1994d94e96ad9d568eac121aecf50684a0b0963b25a41cc40061269e5" }
Llama-2-13b-chat-old.contextWindownumber
Llama-2-13b-chat-old.replicateApistring
Llama-2-70b-chat-4bit{ contextWindow: number = 4096; replicateApi: string = "meta/llama-2-70b-chat:02e509c789964a7ea8736978a43525956ef40397be9033abf9fd2badfe68c9e3" }
Llama-2-70b-chat-4bit.contextWindownumber
Llama-2-70b-chat-4bit.replicateApistring
Llama-2-70b-chat-old{ contextWindow: number = 4096; replicateApi: string = "replicate/llama70b-v2-chat:e951f18578850b652510200860fc4ea62b3b16fac280f83ff32282f87bbd2e48" }
Llama-2-70b-chat-old.contextWindownumber
Llama-2-70b-chat-old.replicateApistring
Llama-2-7b-chat-4bit{ contextWindow: number = 4096; replicateApi: string = "meta/llama-2-7b-chat:13c3cdee13ee059ab779f0291d29054dab00a47dad8261375654de5540165fb0" }
Llama-2-7b-chat-4bit.contextWindownumber
Llama-2-7b-chat-4bit.replicateApistring
Llama-2-7b-chat-old{ contextWindow: number = 4096; replicateApi: string = "a16z-infra/llama7b-v2-chat:4f0a4744c7295c024a1de15e1a63c880d3da035fa1f49bfd344fe076074c8eea" }
Llama-2-7b-chat-old.contextWindownumber
Llama-2-7b-chat-old.replicateApistring

Defined in

packages/core/src/llm/LLM.ts:370


ALL_AVAILABLE_OPENAI_MODELS

Const ALL_AVAILABLE_OPENAI_MODELS: Object

We currently support GPT-3.5 and GPT-4 models

Type declaration

NameType
gpt-3.5-turbo{ contextWindow: number = 4096 }
gpt-3.5-turbo.contextWindownumber
gpt-3.5-turbo-1106{ contextWindow: number = 16384 }
gpt-3.5-turbo-1106.contextWindownumber
gpt-3.5-turbo-16k{ contextWindow: number = 16384 }
gpt-3.5-turbo-16k.contextWindownumber
gpt-4{ contextWindow: number = 8192 }
gpt-4.contextWindownumber
gpt-4-1106-preview{ contextWindow: number = 128000 }
gpt-4-1106-preview.contextWindownumber
gpt-4-32k{ contextWindow: number = 32768 }
gpt-4-32k.contextWindownumber
gpt-4-vision-preview{ contextWindow: number = 8192 }
gpt-4-vision-preview.contextWindownumber

Defined in

packages/core/src/llm/LLM.ts:119


DEFAULT_CHUNK_OVERLAP

Const DEFAULT_CHUNK_OVERLAP: 20

Defined in

packages/core/src/constants.ts:5


DEFAULT_CHUNK_OVERLAP_RATIO

Const DEFAULT_CHUNK_OVERLAP_RATIO: 0.1

Defined in

packages/core/src/constants.ts:6


DEFAULT_CHUNK_SIZE

Const DEFAULT_CHUNK_SIZE: 1024

Defined in

packages/core/src/constants.ts:4


DEFAULT_COLLECTION

Const DEFAULT_COLLECTION: "data"

Defined in

packages/core/src/storage/constants.ts:1


DEFAULT_CONTEXT_WINDOW

Const DEFAULT_CONTEXT_WINDOW: 3900

Defined in

packages/core/src/constants.ts:1


DEFAULT_DOC_STORE_PERSIST_FILENAME

Const DEFAULT_DOC_STORE_PERSIST_FILENAME: "doc_store.json"

Defined in

packages/core/src/storage/constants.ts:4


DEFAULT_EMBEDDING_DIM

Const DEFAULT_EMBEDDING_DIM: 1536

Defined in

packages/core/src/constants.ts:10


DEFAULT_FS

Const DEFAULT_FS: GenericFileSystem | CompleteFileSystem

Defined in

packages/core/src/storage/FileSystem.ts:62


DEFAULT_GRAPH_STORE_PERSIST_FILENAME

Const DEFAULT_GRAPH_STORE_PERSIST_FILENAME: "graph_store.json"

Defined in

packages/core/src/storage/constants.ts:6


DEFAULT_INDEX_STORE_PERSIST_FILENAME

Const DEFAULT_INDEX_STORE_PERSIST_FILENAME: "index_store.json"

Defined in

packages/core/src/storage/constants.ts:3


DEFAULT_NAMESPACE

Const DEFAULT_NAMESPACE: "docstore"

Defined in

packages/core/src/storage/constants.ts:7


DEFAULT_NUM_OUTPUTS

Const DEFAULT_NUM_OUTPUTS: 256

Defined in

packages/core/src/constants.ts:2


DEFAULT_PADDING

Const DEFAULT_PADDING: 5

Defined in

packages/core/src/constants.ts:11


DEFAULT_PERSIST_DIR

Const DEFAULT_PERSIST_DIR: "./storage"

Defined in

packages/core/src/storage/constants.ts:2


DEFAULT_SIMILARITY_TOP_K

Const DEFAULT_SIMILARITY_TOP_K: 2

Defined in

packages/core/src/constants.ts:7


DEFAULT_VECTOR_STORE_PERSIST_FILENAME

Const DEFAULT_VECTOR_STORE_PERSIST_FILENAME: "vector_store.json"

Defined in

packages/core/src/storage/constants.ts:5


FILE_EXT_TO_READER

Const FILE_EXT_TO_READER: Record<string, BaseReader>

Defined in

packages/core/src/readers/SimpleDirectoryReader.ts:38


GPT35_MODELS

Const GPT35_MODELS: Object

Type declaration

NameType
gpt-3.5-turbo{ contextWindow: number = 4096 }
gpt-3.5-turbo.contextWindownumber
gpt-3.5-turbo-1106{ contextWindow: number = 16384 }
gpt-3.5-turbo-1106.contextWindownumber
gpt-3.5-turbo-16k{ contextWindow: number = 16384 }
gpt-3.5-turbo-16k.contextWindownumber

Defined in

packages/core/src/llm/LLM.ts:110


GPT4_MODELS

Const GPT4_MODELS: Object

Type declaration

NameType
gpt-4{ contextWindow: number = 8192 }
gpt-4.contextWindownumber
gpt-4-1106-preview{ contextWindow: number = 128000 }
gpt-4-1106-preview.contextWindownumber
gpt-4-32k{ contextWindow: number = 32768 }
gpt-4-32k.contextWindownumber
gpt-4-vision-preview{ contextWindow: number = 8192 }
gpt-4-vision-preview.contextWindownumber

Defined in

packages/core/src/llm/LLM.ts:103


globalsHelper

Const globalsHelper: GlobalsHelper

Defined in

packages/core/src/GlobalsHelper.ts:76


unixLineSeparator

Const unixLineSeparator: "\n"

Defined in

packages/core/src/TextSplitter.ts:44


unixParagraphSeparator

Const unixParagraphSeparator: string

Defined in

packages/core/src/TextSplitter.ts:46


windowsLineSeparator

Const windowsLineSeparator: "\r\n"

Defined in

packages/core/src/TextSplitter.ts:45


windowsParagraphSeparator

Const windowsParagraphSeparator: string

Defined in

packages/core/src/TextSplitter.ts:47

Functions

anthropicTextQaPrompt

anthropicTextQaPrompt(«destructured»): string

Parameters

NameType
«destructured»Object

Returns

string

Defined in

packages/core/src/Prompt.ts:39


buildToolsText

buildToolsText(tools): string

Parameters

NameType
toolsToolMetadata[]

Returns

string

Defined in

packages/core/src/Prompt.ts:243


cjkSentenceTokenizer

cjkSentenceTokenizer(text): null | RegExpMatchArray

Tokenizes sentences. Suitable for Chinese, Japanese, and Korean.

Parameters

NameType
textstring

Returns

null | RegExpMatchArray

Defined in

packages/core/src/TextSplitter.ts:36


defaultChoiceSelectPrompt

defaultChoiceSelectPrompt(«destructured»): string

Parameters

NameType
«destructured»Object

Returns

string

Defined in

packages/core/src/Prompt.ts:133


defaultCondenseQuestionPrompt

defaultCondenseQuestionPrompt(«destructured»): string

Parameters

NameType
«destructured»Object

Returns

string

Defined in

packages/core/src/Prompt.ts:330


defaultContextSystemPrompt

defaultContextSystemPrompt(«destructured»): string

Parameters

NameType
«destructured»Object

Returns

string

Defined in

packages/core/src/Prompt.ts:360


defaultKeywordExtractPrompt

defaultKeywordExtractPrompt(«destructured»): string

Parameters

NameType
«destructured»Object

Returns

string

Defined in

packages/core/src/Prompt.ts:369


defaultQueryKeywordExtractPrompt

defaultQueryKeywordExtractPrompt(«destructured»): string

Parameters

NameType
«destructured»Object

Returns

string

Defined in

packages/core/src/Prompt.ts:384


defaultRefinePrompt

defaultRefinePrompt(«destructured»): string

Parameters

NameType
«destructured»Object

Returns

string

Defined in

packages/core/src/Prompt.ts:91


defaultSubQuestionPrompt

defaultSubQuestionPrompt(«destructured»): string

Parameters

NameType
«destructured»Object

Returns

string

Defined in

packages/core/src/Prompt.ts:284


defaultSummaryPrompt

defaultSummaryPrompt(«destructured»): string

Parameters

NameType
«destructured»Object

Returns

string

Defined in

packages/core/src/Prompt.ts:62


defaultTextQaPrompt

defaultTextQaPrompt(«destructured»): string

Parameters

NameType
«destructured»Object

Returns

string

Defined in

packages/core/src/Prompt.ts:27


defaultTreeSummarizePrompt

defaultTreeSummarizePrompt(«destructured»): string

Parameters

NameType
«destructured»Object

Returns

string

Defined in

packages/core/src/Prompt.ts:121


englishSentenceTokenizer

englishSentenceTokenizer(text): null | RegExpMatchArray

Tokenizes sentences. Suitable for English and most European languages.

Parameters

NameType
textstring

Returns

null | RegExpMatchArray

Defined in

packages/core/src/TextSplitter.ts:26


exists

exists(fs, path): Promise<boolean>

Checks if a file exists. Analogous to the os.path.exists function from Python.

Parameters

NameTypeDescription
fsGenericFileSystemThe filesystem to use.
pathstringThe path to the file to check.

Returns

Promise<boolean>

A promise that resolves to true if the file exists, false otherwise.

Defined in

packages/core/src/storage/FileSystem.ts:74


getBiggestPrompt

getBiggestPrompt(prompts): SimplePrompt

Get biggest empty prompt size from a list of prompts. Used to calculate the maximum size of inputs to the LLM.

Parameters

NameType
promptsSimplePrompt[]

Returns

SimplePrompt

Defined in

packages/core/src/PromptHelper.ts:21


getEmptyPromptTxt

getEmptyPromptTxt(prompt): string

Parameters

NameType
promptSimplePrompt

Returns

string

Defined in

packages/core/src/PromptHelper.ts:11


getNodeFS

getNodeFS(): CompleteFileSystem

Returns

CompleteFileSystem

Defined in

packages/core/src/storage/FileSystem.ts:51


getNodesFromDocument

getNodesFromDocument(doc, textSplitter, includeMetadata?, includePrevNextRel?): ImageDocument<any>[] | TextNode<Metadata>[]

Generates an array of nodes from a document.

Parameters

NameTypeDefault valueDescription
docBaseNode<Metadata>undefined-
textSplitterSentenceSplitterundefinedThe text splitter to use.
includeMetadatabooleantrueWhether to include metadata in the nodes.
includePrevNextRelbooleantrueWhether to include previous and next relationships in the nodes.

Returns

ImageDocument<any>[] | TextNode<Metadata>[]

An array of nodes.

Defined in

packages/core/src/NodeParser.ts:35


getResponseBuilder

getResponseBuilder(serviceContext, responseMode?): BaseResponseBuilder

Parameters

NameType
serviceContextServiceContext
responseMode?ResponseMode

Returns

BaseResponseBuilder

Defined in

packages/core/src/ResponseSynthesizer.ts:271


getTextSplitsFromDocument

getTextSplitsFromDocument(document, textSplitter): string[]

Splits the text of a document into smaller parts.

Parameters

NameTypeDescription
documentDocument<Metadata>The document to split.
textSplitterSentenceSplitterThe text splitter to use.

Returns

string[]

An array of text splits.

Defined in

packages/core/src/NodeParser.ts:17


getTopKEmbeddings

getTopKEmbeddings(queryEmbedding, embeddings, similarityTopK?, embeddingIds?, similarityCutoff?): [number[], any[]]

Get the top K embeddings from a list of embeddings ordered by similarity to the query.

Parameters

NameTypeDefault valueDescription
queryEmbeddingnumber[]undefined
embeddingsnumber[][]undefinedlist of embeddings to consider
similarityTopKnumberDEFAULT_SIMILARITY_TOP_Kmax number of embeddings to return, default 2
embeddingIdsnull | any[]nullids of embeddings in the embeddings list
similarityCutoffnull | numbernullminimum similarity score

Returns

[number[], any[]]

Defined in

packages/core/src/embeddings/utils.ts:69


getTopKEmbeddingsLearner

getTopKEmbeddingsLearner(queryEmbedding, embeddings, similarityTopK?, embeddingsIds?, queryMode?): [number[], any[]]

Parameters

NameTypeDefault value
queryEmbeddingnumber[]undefined
embeddingsnumber[][]undefined
similarityTopK?numberundefined
embeddingsIds?any[]undefined
queryModeVectorStoreQueryModeVectorStoreQueryMode.SVM

Returns

[number[], any[]]

Defined in

packages/core/src/embeddings/utils.ts:111


getTopKMMREmbeddings

getTopKMMREmbeddings(queryEmbedding, embeddings, similarityFn?, similarityTopK?, embeddingIds?, _similarityCutoff?, mmrThreshold?): [number[], any[]]

Parameters

NameTypeDefault value
queryEmbeddingnumber[]undefined
embeddingsnumber[][]undefined
similarityFnnull | (...args: any[]) => numbernull
similarityTopKnull | numbernull
embeddingIdsnull | any[]null
_similarityCutoffnull | numbernull
mmrThresholdnull | numbernull

Returns

[number[], any[]]

Defined in

packages/core/src/embeddings/utils.ts:123


jsonToIndexStruct

jsonToIndexStruct(json): IndexStruct

Parameters

NameType
jsonany

Returns

IndexStruct

Defined in

packages/core/src/indices/BaseIndex.ts:74


jsonToNode

jsonToNode(json, type?): TextNode<Metadata>

Parameters

NameType
jsonany
type?ObjectType

Returns

TextNode<Metadata>

Defined in

packages/core/src/Node.ts:268


messagesToHistoryStr

messagesToHistoryStr(messages): string

Parameters

NameType
messagesChatMessage[]

Returns

string

Defined in

packages/core/src/Prompt.ts:348


parseJsonMarkdown

parseJsonMarkdown(text): any

Parameters

NameTypeDescription
textstringA markdown block with JSON

Returns

any

parsed JSON object

Defined in

packages/core/src/OutputParser.ts:56


readImage

readImage(input): Promise<RawImage>

Parameters

NameType
inputImageType

Returns

Promise<RawImage>

Defined in

packages/core/src/embeddings/utils.ts:188


serviceContextFromDefaults

serviceContextFromDefaults(options?): ServiceContext

Parameters

NameType
options?ServiceContextOptions

Returns

ServiceContext

Defined in

packages/core/src/ServiceContext.ts:30


serviceContextFromServiceContext

serviceContextFromServiceContext(serviceContext, options): Object

Parameters

NameType
serviceContextServiceContext
optionsServiceContextOptions

Returns

Object

NameType
callbackManagerCallbackManager
embedModelBaseEmbedding
llmLLM
nodeParserNodeParser
promptHelperPromptHelper

Defined in

packages/core/src/ServiceContext.ts:48


similarity

similarity(embedding1, embedding2, mode?): number

The similarity between two embeddings.

Parameters

NameTypeDefault value
embedding1number[]undefined
embedding2number[]undefined
modeSimilarityTypeSimilarityType.DEFAULT

Returns

number

similarity score with higher numbers meaning the two embeddings are more similar

Defined in

packages/core/src/embeddings/utils.ts:15


storageContextFromDefaults

storageContextFromDefaults(«destructured»): Promise<StorageContext>

Parameters

NameType
«destructured»BuilderParams

Returns

Promise<StorageContext>

Defined in

packages/core/src/storage/StorageContext.ts:24


walk

walk(fs, dirPath): AsyncIterable<string>

Recursively traverses a directory and yields all the paths to the files in it.

Parameters

NameTypeDescription
fsWalkableFileSystemThe filesystem to use.
dirPathstringThe path to the directory to traverse.

Returns

AsyncIterable<string>

Defined in

packages/core/src/storage/FileSystem.ts:91