llamaindex
Enumerations
- ChatResponseMode
- ClipEmbeddingModelType
- DeuceChatStrategy
- HuggingFaceEmbeddingModelType
- IndexStructType
- KeywordTableRetrieverMode
- MetadataMode
- MistralAIEmbeddingModelType
- NodeRelationship
- ObjectType
- SimilarityType
- SummaryRetrieverMode
- Tokenizers
- VectorStoreQueryMode
Classes
- AgentChatResponse
- Anthropic
- AstraDBVectorStore
- AudioSubtitlesReader
- AudioTranscriptParagraphsReader
- AudioTranscriptReader
- AudioTranscriptSentencesReader
- AzureOpenAI
- BaseAgent
- BaseDocumentStore
- BaseEmbedding
- BaseExtractor
- BaseInMemoryKVStore
- BaseIndex
- BaseIndexStore
- BaseKVStore
- BaseNode
- BaseObjectNodeMapping
- BaseSelector
- CallbackManager
- ChatHistory
- ChromaVectorStore
- ClipEmbedding
- CohereRerank
- CompactAndRefine
- CondenseQuestionChatEngine
- ContextChatEngine
- Document
- DocxReader
- FireworksEmbedding
- FireworksLLM
- FunctionTool
- HTMLReader
- HuggingFaceEmbedding
- ImageDocument
- ImageNode
- ImageReader
- InMemoryFileSystem
- IndexDict
- IndexList
- IndexNode
- IndexStruct
- IngestionPipeline
- KeywordExtractor
- KeywordTable
- KeywordTableIndex
- KeywordTableLLMRetriever
- KeywordTableRAKERetriever
- KeywordTableSimpleRetriever
- LLMMultiSelector
- LLMQuestionGenerator
- LLMSingleSelector
- LlamaCloudIndex
- LlamaCloudRetriever
- LlamaDeuce
- LlamaParseReader
- MarkdownNodeParser
- MarkdownReader
- MetadataReplacementPostProcessor
- MistralAI
- MistralAIEmbedding
- MistralAISession
- MongoDBAtlasVectorSearch
- MultiModalEmbedding
- MultiModalResponseSynthesizer
- NotionReader
- ObjectIndex
- ObjectRetriever
- Ollama
- OllamaEmbedding
- OpenAI
- OpenAIAgent
- OpenAIAgentWorker
- OpenAIEmbedding
- OpenAISession
- PDFReader
- PGVectorStore
- PapaCSVReader
- PineconeVectorStore
- Portkey
- PromptHelper
- PromptMixin
- QdrantVectorStore
- QueryEngineTool
- QuestionsAnsweredExtractor
- ReActAgent
- ReActAgentWorker
- Refine
- Response
- ResponseSynthesizer
- RetrieverQueryEngine
- RouterQueryEngine
- SentenceSplitter
- SentenceWindowNodeParser
- SimilarityPostprocessor
- SimpleChatEngine
- SimpleChatHistory
- SimpleChatStore
- SimpleDirectoryReader
- SimpleDocumentStore
- SimpleIndexStore
- SimpleKVStore
- SimpleMongoReader
- SimpleNodeParser
- SimpleResponseBuilder
- SimpleToolNodeMapping
- SimpleVectorStore
- SubQuestionOutputParser
- SubQuestionQueryEngine
- SummaryChatHistory
- SummaryExtractor
- SummaryIndex
- SummaryIndexLLMRetriever
- SummaryIndexRetriever
- Task
- TaskStep
- TaskStepOutput
- TextFileReader
- TextNode
- TitleExtractor
- TogetherEmbedding
- TogetherLLM
- ToolOutput
- TreeSummarize
- VectorIndexRetriever
- VectorStoreIndex
Interfaces
- AgentWorker
- BaseChatStore
- BaseIndexInit
- BaseNodePostprocessor
- BaseReader
- BaseRetriever
- BaseSynthesizer
- ChatEngine
- ChatEngineAgentParams
- ChatEngineParamsBase
- ChatEngineParamsNonStreaming
- ChatEngineParamsStreaming
- ChatMessage
- ChatResponse
- ChatResponseChunk
- CompletionResponse
- Context
- ContextGenerator
- DefaultStreamToken
- Event
- ExactMatchFilter
- FileReader
- LLM
- LLMChatParamsBase
- LLMChatParamsNonStreaming
- LLMChatParamsStreaming
- LLMCompletionParamsBase
- LLMCompletionParamsNonStreaming
- LLMCompletionParamsStreaming
- LLMMetadata
- MessageContentDetail
- MetadataFilters
- MetadataInfo
- NodeParser
- NodeWithScore
- RefDocInfo
- RelatedNodeInfo
- ResponseBuilder
- ResponseBuilderParamsBase
- ResponseBuilderParamsNonStreaming
- ResponseBuilderParamsStreaming
- RetrievalCallbackResponse
- ServiceContext
- ServiceContextOptions
- SingleSelection
- StorageContext
- StreamCallbackResponse
- SynthesizeParamsBase
- SynthesizeParamsNonStreaming
- SynthesizeParamsStreaming
- TransformComponent
- VectorStore
- VectorStoreInfo
- VectorStoreQuery
- VectorStoreQueryResult
- VectorStoreQuerySpec
Other
AnthropicStreamToken
Ƭ AnthropicStreamToken: Anthropic.Completion
Defined in
packages/core/src/callbacks/CallbackManager.ts:43
AssemblyAIOptions
Ƭ AssemblyAIOptions: Partial
<BaseServiceParams
>
Defined in
packages/core/src/readers/AssemblyAIReader.ts:12
BuilderParams
Ƭ BuilderParams: Object
Type declaration
Name | Type |
---|---|
docStore | BaseDocumentStore |
fs | GenericFileSystem |
imageVectorStore | VectorStore |
indexStore | BaseIndexStore |
persistDir | string |
storeImages | boolean |
vectorStore | VectorStore |
Defined in
packages/core/src/storage/StorageContext.ts:18
ChoiceSelectPrompt
Ƭ ChoiceSelectPrompt: typeof defaultChoiceSelectPrompt
Defined in
packages/core/src/Prompt.ts:178
CompleteFileSystem
Ƭ CompleteFileSystem: GenericFileSystem
& WalkableFileSystem
Defined in
packages/core/src/storage/FileSystem.ts:34
CondenseQuestionPrompt
Ƭ CondenseQuestionPrompt: typeof defaultCondenseQuestionPrompt
Defined in
packages/core/src/Prompt.ts:359
ContextSystemPrompt
Ƭ ContextSystemPrompt: typeof defaultContextSystemPrompt
Defined in
packages/core/src/Prompt.ts:380
EventTag
Ƭ EventTag: "intermediate"
| "final"
Defined in
packages/core/src/callbacks/CallbackManager.ts:11
EventType
Ƭ EventType: "retrieve"
| "llmPredict"
| "wrapper"
Defined in
packages/core/src/callbacks/CallbackManager.ts:12
GenericFileSystem
Ƭ GenericFileSystem: Object
A filesystem interface that is meant to be compatible with the 'fs' module from Node.js. Allows for the use of similar inteface implementation on browsers.
Type declaration
Name | Type |
---|---|
access | (path : string ) => Promise <void > |
mkdir | (path : string , options : { recursive : boolean }) => Promise <undefined | string >(path : string ) => Promise <void > |
readFile | (path : string ) => Promise <string > |
readRawFile | (path : string ) => Promise <Buffer > |
writeFile | (path : string , content : string ) => Promise <void > |
Defined in
packages/core/src/storage/FileSystem.ts:9
ImageNodeConstructorProps
Ƭ ImageNodeConstructorProps<T
>: Pick
<ImageNode
<T
>, "image"
| "id_"
> & Partial
<ImageNode
<T
>>
Type parameters
Name | Type |
---|---|
T | extends Metadata |
Defined in
ImageType
Ƭ ImageType: string
| Blob
| URL
Defined in
KeywordExtractPrompt
Ƭ KeywordExtractPrompt: typeof defaultKeywordExtractPrompt
Defined in
packages/core/src/Prompt.ts:395
ListIndex
Ƭ ListIndex: SummaryIndex
Defined in
packages/core/src/indices/summary/SummaryIndex.ts:267
ListIndexLLMRetriever
Ƭ ListIndexLLMRetriever: SummaryIndexLLMRetriever
Defined in
packages/core/src/indices/summary/SummaryIndexRetriever.ts:137
ListIndexRetriever
Ƭ ListIndexRetriever: SummaryIndexRetriever
Defined in
packages/core/src/indices/summary/SummaryIndexRetriever.ts:136
ListRetrieverMode
Ƭ ListRetrieverMode: SummaryRetrieverMode
Defined in
packages/core/src/indices/summary/SummaryIndex.ts:268
MessageContent
Ƭ MessageContent: string
| MessageContentDetail
[]
Extended type for the content of a message that allows for multi-modal messages.
Defined in
packages/core/src/llm/types.ts:116
MessageType
Ƭ MessageType: "user"
| "assistant"
| "system"
| "generic"
| "function"
| "memory"
| "tool"
Defined in
packages/core/src/llm/types.ts:36
Metadata
Ƭ Metadata: Record
<string
, any
>
Defined in
OpenAIStreamToken
Ƭ OpenAIStreamToken: DefaultStreamToken
Defined in
packages/core/src/callbacks/CallbackManager.ts:42
QueryEngineToolParams
Ƭ QueryEngineToolParams: Object
Type declaration
Name | Type |
---|---|
metadata | ToolMetadata |
queryEngine | BaseQueryEngine |
Defined in
packages/core/src/tools/QueryEngineTool.ts:3
QueryKeywordExtractPrompt
Ƭ QueryKeywordExtractPrompt: typeof defaultQueryKeywordExtractPrompt
Defined in
packages/core/src/Prompt.ts:411
RefinePrompt
Ƭ RefinePrompt: typeof defaultRefinePrompt
Defined in
packages/core/src/Prompt.ts:119
RelatedNodeType
Ƭ RelatedNodeType<T
>: RelatedNodeInfo
<T
> | RelatedNodeInfo
<T
>[]
Type parameters
Name | Type |
---|---|
T | extends Metadata = Metadata |
Defined in
ResponseBuilderPrompts
Ƭ ResponseBuilderPrompts: TextQaPrompt
| TreeSummarizePrompt
| RefinePrompt
Defined in
packages/core/src/synthesizers/builders.ts:398
RetrieveParams
Ƭ RetrieveParams: Omit
<PlatformApi.RetrievalParams
, "query"
| "searchFilters"
| "pipelineId"
| "className"
> & { similarityTopK?
: number
}
Defined in
packages/core/src/cloud/LlamaCloudRetriever.ts:14
SelectorResult
Ƭ SelectorResult: Object
Type declaration
Name | Type |
---|---|
selections | SingleSelection [] |
Defined in
packages/core/src/selectors/base.ts:9
SimpleDirectoryReaderLoadDataParams
Ƭ SimpleDirectoryReaderLoadDataParams: Object
Type declaration
Name | Type |
---|---|
defaultReader? | BaseReader | null |
directoryPath | string |
fileExtToReader? | Record <string , BaseReader > |
fs? | CompleteFileSystem |
Defined in
packages/core/src/readers/SimpleDirectoryReader.ts:51
SimplePrompt
Ƭ SimplePrompt: (input
: Record
<string
, string
| undefined
>) => 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
Type declaration
▸ (input
): string
Parameters
Name | Type |
---|---|
input | Record <string , string | undefined > |
Returns
string
Defined in
packages/core/src/Prompt.ts:10
SubQuestionPrompt
Ƭ SubQuestionPrompt: typeof defaultSubQuestionPrompt
Defined in
packages/core/src/Prompt.ts:327
SubtitleFormat
Ƭ SubtitleFormat: "srt"
| "vtt"
Description
Format of the subtitles
Defined in
node_modules/.pnpm/assemblyai@4.2.2/node_modules/assemblyai/dist/types/openapi.generated.d.ts:1003
SummaryPrompt
Ƭ SummaryPrompt: typeof defaultSummaryPrompt
Defined in
packages/core/src/Prompt.ts:76
TextQaPrompt
Ƭ TextQaPrompt: typeof defaultTextQaPrompt
Defined in
packages/core/src/Prompt.ts:37
TranscribeParams
Ƭ TranscribeParams: { audio
: AudioToTranscribe
} & Omit
<TranscriptParams
, "audio_url"
>
The parameters to transcribe an audio file.
Defined in
node_modules/.pnpm/assemblyai@4.2.2/node_modules/assemblyai/dist/types/transcripts/index.d.ts:29
TreeSummarizePrompt
Ƭ TreeSummarizePrompt: typeof defaultTreeSummarizePrompt
Defined in
packages/core/src/Prompt.ts:144
WalkableFileSystem
Ƭ WalkableFileSystem: Object
Type declaration
Name | Type |
---|---|
readdir | (path : string ) => Promise <string []> |
stat | (path : string ) => Promise <any > |
Defined in
packages/core/src/storage/FileSystem.ts:29
ALL_AVAILABLE_ANTHROPIC_MODELS
• Const
ALL_AVAILABLE_ANTHROPIC_MODELS: Object
Type declaration
Name | Type |
---|---|
claude-2 | { contextWindow : number = 200000 } |
claude-2.contextWindow | number |
claude-instant-1 | { contextWindow : number = 100000 } |
claude-instant-1.contextWindow | number |
Defined in
packages/core/src/llm/LLM.ts:613
ALL_AVAILABLE_LLAMADEUCE_MODELS
• Const
ALL_AVAILABLE_LLAMADEUCE_MODELS: Object
Type declaration
Name | Type |
---|---|
Llama-2-13b-chat-4bit | { contextWindow : number = 4096; replicateApi : string = "meta/llama-2-13b-chat:f4e2de70d66816a838a89eeeb621910adffb0dd0baba3976c96980970978018d" } |
Llama-2-13b-chat-4bit.contextWindow | number |
Llama-2-13b-chat-4bit.replicateApi | string |
Llama-2-13b-chat-old | { contextWindow : number = 4096; replicateApi : string = "a16z-infra/llama13b-v2-chat:df7690f1994d94e96ad9d568eac121aecf50684a0b0963b25a41cc40061269e5" } |
Llama-2-13b-chat-old.contextWindow | number |
Llama-2-13b-chat-old.replicateApi | string |
Llama-2-70b-chat-4bit | { contextWindow : number = 4096; replicateApi : string = "meta/llama-2-70b-chat:02e509c789964a7ea8736978a43525956ef40397be9033abf9fd2badfe68c9e3" } |
Llama-2-70b-chat-4bit.contextWindow | number |
Llama-2-70b-chat-4bit.replicateApi | string |
Llama-2-70b-chat-old | { contextWindow : number = 4096; replicateApi : string = "replicate/llama70b-v2-chat:e951f18578850b652510200860fc4ea62b3b16fac280f83ff32282f87bbd2e48" } |
Llama-2-70b-chat-old.contextWindow | number |
Llama-2-70b-chat-old.replicateApi | string |
Llama-2-7b-chat-4bit | { contextWindow : number = 4096; replicateApi : string = "meta/llama-2-7b-chat:13c3cdee13ee059ab779f0291d29054dab00a47dad8261375654de5540165fb0" } |
Llama-2-7b-chat-4bit.contextWindow | number |
Llama-2-7b-chat-4bit.replicateApi | string |
Llama-2-7b-chat-old | { contextWindow : number = 4096; replicateApi : string = "a16z-infra/llama7b-v2-chat:4f0a4744c7295c024a1de15e1a63c880d3da035fa1f49bfd344fe076074c8eea" } |
Llama-2-7b-chat-old.contextWindow | number |
Llama-2-7b-chat-old.replicateApi | string |
Defined in
packages/core/src/llm/LLM.ts:344
ALL_AVAILABLE_MISTRAL_MODELS
• Const
ALL_AVAILABLE_MISTRAL_MODELS: Object
Type declaration
Name | Type |
---|---|
mistral-medium | { contextWindow : number = 32000 } |
mistral-medium.contextWindow | number |
mistral-small | { contextWindow : number = 32000 } |
mistral-small.contextWindow | number |
mistral-tiny | { contextWindow : number = 32000 } |
mistral-tiny.contextWindow | number |
Defined in
packages/core/src/llm/mistral.ts:16
ALL_AVAILABLE_OPENAI_MODELS
• Const
ALL_AVAILABLE_OPENAI_MODELS: Object
We currently support GPT-3.5 and GPT-4 models
Type declaration
Name | Type |
---|---|
gpt-3.5-turbo | { contextWindow : number = 4096 } |
gpt-3.5-turbo.contextWindow | number |
gpt-3.5-turbo-0125 | { contextWindow : number = 16384 } |
gpt-3.5-turbo-0125.contextWindow | number |
gpt-3.5-turbo-0613 | { contextWindow : number = 4096 } |
gpt-3.5-turbo-0613.contextWindow | number |
gpt-3.5-turbo-1106 | { contextWindow : number = 16384 } |
gpt-3.5-turbo-1106.contextWindow | number |
gpt-3.5-turbo-16k | { contextWindow : number = 16384 } |
gpt-3.5-turbo-16k.contextWindow | number |
gpt-3.5-turbo-16k-0613 | { contextWindow : number = 16384 } |
gpt-3.5-turbo-16k-0613.contextWindow | number |
gpt-4 | { contextWindow : number = 8192 } |
gpt-4.contextWindow | number |
gpt-4-0125-preview | { contextWindow : number = 128000 } |
gpt-4-0125-preview.contextWindow | number |
gpt-4-1106-preview | { contextWindow : number = 128000 } |
gpt-4-1106-preview.contextWindow | number |
gpt-4-32k | { contextWindow : number = 32768 } |
gpt-4-32k.contextWindow | number |
gpt-4-32k-0613 | { contextWindow : number = 32768 } |
gpt-4-32k-0613.contextWindow | number |
gpt-4-turbo-preview | { contextWindow : number = 128000 } |
gpt-4-turbo-preview.contextWindow | number |
gpt-4-vision-preview | { contextWindow : number = 128000 } |
gpt-4-vision-preview.contextWindow | number |
Defined in
packages/core/src/llm/LLM.ts:64
ALL_OPENAI_EMBEDDING_MODELS
• Const
ALL_OPENAI_EMBEDDING_MODELS: Object
Type declaration
Name | Type |
---|---|
text-embedding-3-large | { dimensionOptions : number [] ; dimensions : number = 3072; maxTokens : number = 8191 } |
text-embedding-3-large.dimensionOptions | number [] |
text-embedding-3-large.dimensions | number |
text-embedding-3-large.maxTokens | number |
text-embedding-3-small | { dimensionOptions : number [] ; dimensions : number = 1536; maxTokens : number = 8191 } |
text-embedding-3-small.dimensionOptions | number [] |
text-embedding-3-small.dimensions | number |
text-embedding-3-small.maxTokens | number |
text-embedding-ada-002 | { dimensions : number = 1536; maxTokens : number = 8191 } |
text-embedding-ada-002.dimensions | number |
text-embedding-ada-002.maxTokens | number |
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:12
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_GRAPH_STORE_PERSIST_FILENAME
• Const
DEFAULT_GRAPH_STORE_PERSIST_FILENAME: "graph_store.json"
Defined in
packages/core/src/storage/constants.ts:6
DEFAULT_IMAGE_VECTOR_NAMESPACE
• Const
DEFAULT_IMAGE_VECTOR_NAMESPACE: "images"
Defined in
packages/core/src/storage/constants.ts:8
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_OG_TEXT_METADATA_KEY
• Const
DEFAULT_OG_TEXT_METADATA_KEY: "original_text"
Defined in
packages/core/src/nodeParsers/SentenceWindowNodeParser.ts:8
DEFAULT_PADDING
• Const
DEFAULT_PADDING: 5
Defined in
packages/core/src/constants.ts:9
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
DEFAULT_WINDOW_METADATA_KEY
• Const
DEFAULT_WINDOW_METADATA_KEY: "window"
Defined in
packages/core/src/nodeParsers/SentenceWindowNodeParser.ts:7
DEFAULT_WINDOW_SIZE
• Const
DEFAULT_WINDOW_SIZE: 3
Defined in
packages/core/src/nodeParsers/SentenceWindowNodeParser.ts:6
FILE_EXT_TO_READER
• Const
FILE_EXT_TO_READER: Record
<string
, BaseReader
>
Defined in
packages/core/src/readers/SimpleDirectoryReader.ts:37
GPT35_MODELS
• Const
GPT35_MODELS: Object
Type declaration
Name | Type |
---|---|
gpt-3.5-turbo | { contextWindow : number = 4096 } |
gpt-3.5-turbo.contextWindow | number |
gpt-3.5-turbo-0125 | { contextWindow : number = 16384 } |
gpt-3.5-turbo-0125.contextWindow | number |
gpt-3.5-turbo-0613 | { contextWindow : number = 4096 } |
gpt-3.5-turbo-0613.contextWindow | number |
gpt-3.5-turbo-1106 | { contextWindow : number = 16384 } |
gpt-3.5-turbo-1106.contextWindow | number |
gpt-3.5-turbo-16k | { contextWindow : number = 16384 } |
gpt-3.5-turbo-16k.contextWindow | number |
gpt-3.5-turbo-16k-0613 | { contextWindow : number = 16384 } |
gpt-3.5-turbo-16k-0613.contextWindow | number |
Defined in
packages/core/src/llm/LLM.ts:52
GPT4_MODELS
• Const
GPT4_MODELS: Object
Type declaration
Name | Type |
---|---|
gpt-4 | { contextWindow : number = 8192 } |
gpt-4.contextWindow | number |
gpt-4-0125-preview | { contextWindow : number = 128000 } |
gpt-4-0125-preview.contextWindow | number |
gpt-4-1106-preview | { contextWindow : number = 128000 } |
gpt-4-1106-preview.contextWindow | number |
gpt-4-32k | { contextWindow : number = 32768 } |
gpt-4-32k.contextWindow | number |
gpt-4-32k-0613 | { contextWindow : number = 32768 } |
gpt-4-32k-0613.contextWindow | number |
gpt-4-turbo-preview | { contextWindow : number = 128000 } |
gpt-4-turbo-preview.contextWindow | number |
gpt-4-vision-preview | { contextWindow : number = 128000 } |
gpt-4-vision-preview.contextWindow | number |
Defined in
packages/core/src/llm/LLM.ts:41
defaultParagraphSeparator
• Const
defaultParagraphSeparator: string
Defined in
packages/core/src/TextSplitter.ts:58
globalsHelper
• Const
globalsHelper: GlobalsHelper
Defined in
packages/core/src/GlobalsHelper.ts:76
anthropicSummaryPrompt
▸ anthropicSummaryPrompt(«destructured»
): string
Parameters
Name | Type | Default value |
---|---|---|
«destructured» | Object | undefined |
› context | undefined | string | "" |
Returns
string
Defined in
packages/core/src/Prompt.ts:78
anthropicTextQaPrompt
▸ anthropicTextQaPrompt(«destructured»
): string
Parameters
Name | Type | Default value |
---|---|---|
«destructured» | Object | undefined |
› context | undefined | string | "" |
› query | undefined | string | "" |
Returns
string
Defined in
packages/core/src/Prompt.ts:39
buildToolsText
▸ buildToolsText(tools
): string
Parameters
Name | Type |
---|---|
tools | ToolMetadata [] |
Returns
string
Defined in
packages/core/src/Prompt.ts:256
callToolWithErrorHandling
▸ callToolWithErrorHandling(tool
, inputDict
, errorMessage?
, raiseError?
): Promise
<ToolOutput
>
Call tool with error handling.
Parameters
Name | Type | Default value |
---|---|---|
tool | BaseTool | undefined |
inputDict | Object | undefined |
errorMessage | null | string | null |
raiseError | boolean | false |
Returns
Promise
<ToolOutput
>
Defined in
packages/core/src/tools/utils.ts:12
cjkSentenceTokenizer
▸ cjkSentenceTokenizer(sentence
): string
[]
Tokenizes sentences. Suitable for Chinese, Japanese, and Korean. Use instead of defaultSentenceTokenizer
.
Parameters
Name | Type |
---|---|
sentence | string |
Returns
string
[]
string[]
Defined in
packages/core/src/TextSplitter.ts:42
defaultChoiceSelectPrompt
▸ defaultChoiceSelectPrompt(«destructured»
): string
Parameters
Name | Type | Default value |
---|---|---|
«destructured» | Object | undefined |
› context | undefined | string | "" |
› query | undefined | string | "" |
Returns
string
Defined in
packages/core/src/Prompt.ts:146
defaultCondenseQuestionPrompt
▸ defaultCondenseQuestionPrompt(«destructured»
): string
Parameters
Name | Type | Default value |
---|---|---|
«destructured» | Object | undefined |
› chatHistory | undefined | string | "" |
› question | undefined | string | "" |
Returns
string
Defined in
packages/core/src/Prompt.ts:343
defaultContextSystemPrompt
▸ defaultContextSystemPrompt(«destructured»
): string
Parameters
Name | Type | Default value |
---|---|---|
«destructured» | Object | undefined |
› context | undefined | string | "" |
Returns
string
Defined in
packages/core/src/Prompt.ts:373
defaultKeywordExtractPrompt
▸ defaultKeywordExtractPrompt(«destructured»
): string
Parameters
Name | Type | Default value |
---|---|---|
«destructured» | Object | undefined |
› context | undefined | string | "" |
› maxKeywords | undefined | number | 10 |
Returns
string
Defined in
packages/core/src/Prompt.ts:382
defaultQueryKeywordExtractPrompt
▸ defaultQueryKeywordExtractPrompt(«destructured»
): string
Parameters
Name | Type | Default value |
---|---|---|
«destructured» | Object | undefined |
› maxKeywords | undefined | number | 10 |
› question | undefined | string | "" |
Returns
string
Defined in
packages/core/src/Prompt.ts:397
defaultRefinePrompt
▸ defaultRefinePrompt(«destructured»
): string
Parameters
Name | Type | Default value |
---|---|---|
«destructured» | Object | undefined |
› context | undefined | string | "" |
› existingAnswer | undefined | string | "" |
› query | undefined | string | "" |
Returns
string
Defined in
packages/core/src/Prompt.ts:104
defaultSentenceTokenizer
▸ defaultSentenceTokenizer(text
): string
[]
Parameters
Name | Type |
---|---|
text | string |
Returns
string
[]
Defined in
packages/core/src/TextSplitter.ts:22
defaultSubQuestionPrompt
▸ defaultSubQuestionPrompt(«destructured»
): string
Parameters
Name | Type | Default value |
---|---|---|
«destructured» | Object | undefined |
› queryStr | undefined | string | "" |
› toolsStr | undefined | string | "" |
Returns
string
Defined in
packages/core/src/Prompt.ts:297
defaultSummaryPrompt
▸ defaultSummaryPrompt(«destructured»
): string
Parameters
Name | Type | Default value |
---|---|---|
«destructured» | Object | undefined |
› context | undefined | string | "" |
Returns
string
Defined in
packages/core/src/Prompt.ts:65
defaultTextQaPrompt
▸ defaultTextQaPrompt(«destructured»
): string
Parameters
Name | Type | Default value |
---|---|---|
«destructured» | Object | undefined |
› context | undefined | string | "" |
› query | undefined | string | "" |
Returns
string
Defined in
packages/core/src/Prompt.ts:27
defaultTreeSummarizePrompt
▸ defaultTreeSummarizePrompt(«destructured»
): string
Parameters
Name | Type | Default value |
---|---|---|
«destructured» | Object | undefined |
› context | undefined | string | "" |
› query | undefined | string | "" |
Returns
string
Defined in
packages/core/src/Prompt.ts:134
exists
▸ exists(fs
, path
): Promise
<boolean
>
Checks if a file exists. Analogous to the os.path.exists function from Python.
Parameters
Name | Type | Description |
---|---|---|
fs | GenericFileSystem | The filesystem to use. |
path | string | The 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:90
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
Name | Type |
---|---|
prompts | SimplePrompt [] |
Returns
Defined in
packages/core/src/PromptHelper.ts:21
getEmptyPromptTxt
▸ getEmptyPromptTxt(prompt
): string
Parameters
Name | Type |
---|---|
prompt | SimplePrompt |
Returns
string
Defined in
packages/core/src/PromptHelper.ts:11
getHistory
▸ getHistory(chatHistory?
): ChatHistory
Parameters
Name | Type |
---|---|
chatHistory? | ChatMessage [] | ChatHistory |
Returns
Defined in
packages/core/src/ChatHistory.ts:217
getOpenAISession
▸ getOpenAISession(options?
): OpenAISession
Get a session for the OpenAI API. If one already exists with the same options, it will be returned. Otherwise, a new session will be created.
Parameters
Name | Type |
---|---|
options | ClientOptions & { azure? : boolean } |
Returns
Defined in
packages/core/src/llm/open_ai.ts:47
getResponseBuilder
▸ getResponseBuilder(serviceContext
, responseMode?
): ResponseBuilder
Parameters
Name | Type |
---|---|
serviceContext | ServiceContext |
responseMode? | ResponseMode |
Returns
Defined in
packages/core/src/synthesizers/builders.ts:382
getSelectorFromContext
▸ getSelectorFromContext(serviceContext
, isMulti?
): BaseSelector
Parameters
Name | Type | Default value |
---|---|---|
serviceContext | ServiceContext | undefined |
isMulti | boolean | false |
Returns
Defined in
packages/core/src/selectors/utils.ts:5
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
Name | Type | Default value | Description |
---|---|---|---|
queryEmbedding | number [] | undefined | |
embeddings | number [][] | undefined | list of embeddings to consider |
similarityTopK | number | DEFAULT_SIMILARITY_TOP_K | max number of embeddings to return, default 2 |
embeddingIds | null | any [] | null | ids of embeddings in the embeddings list |
similarityCutoff | null | number | null | minimum similarity score |
Returns
[number
[], any
[]]
Defined in
packages/core/src/embeddings/utils.ts:80
getTopKEmbeddingsLearner
▸ getTopKEmbeddingsLearner(queryEmbedding
, embeddings
, similarityTopK?
, embeddingsIds?
, queryMode?
): [number
[], any
[]]
Parameters
Name | Type | Default value |
---|---|---|
queryEmbedding | number [] | undefined |
embeddings | number [][] | undefined |
similarityTopK? | number | undefined |
embeddingsIds? | any [] | undefined |
queryMode | VectorStoreQueryMode | VectorStoreQueryMode.SVM |
Returns
[number
[], any
[]]
Defined in
packages/core/src/embeddings/utils.ts:123
getTopKMMREmbeddings
▸ getTopKMMREmbeddings(queryEmbedding
, embeddings
, similarityFn?
, similarityTopK?
, embeddingIds?
, _similarityCutoff?
, mmrThreshold?
): [number
[], any
[]]
Parameters
Name | Type | Default value |
---|---|---|
queryEmbedding | number [] | undefined |
embeddings | number [][] | undefined |
similarityFn | null | (...args : any []) => number | null |
similarityTopK | null | number | null |
embeddingIds | null | any [] | null |
_similarityCutoff | null | number | null |
mmrThreshold | null | number | null |
Returns
[number
[], any
[]]
Defined in
packages/core/src/embeddings/utils.ts:136
imageToDataUrl
▸ imageToDataUrl(input
): Promise
<string
>
Parameters
Name | Type |
---|---|
input | ImageType |
Returns
Promise
<string
>
Defined in
packages/core/src/embeddings/utils.ts:250
imageToString
▸ imageToString(input
): Promise
<string
>
Parameters
Name | Type |
---|---|
input | ImageType |
Returns
Promise
<string
>
Defined in
packages/core/src/embeddings/utils.ts:222
isFunctionCallingModel
▸ isFunctionCallingModel(model
): boolean
Parameters
Name | Type |
---|---|
model | string |
Returns
boolean
Defined in
packages/core/src/llm/LLM.ts:69
jsonToIndexStruct
▸ jsonToIndexStruct(json
): IndexStruct
Parameters
Name | Type |
---|---|
json | any |
Returns
Defined in
packages/core/src/indices/BaseIndex.ts:75
jsonToNode
▸ jsonToNode(json
, type?
): TextNode
<Metadata
>
Parameters
Name | Type |
---|---|
json | any |
type? | ObjectType |
Returns
Defined in
messagesToHistoryStr
▸ messagesToHistoryStr(messages
): string
Parameters
Name | Type |
---|---|
messages | ChatMessage [] |
Returns
string
Defined in
packages/core/src/Prompt.ts:361
parseJsonMarkdown
▸ parseJsonMarkdown(text
): any
Parameters
Name | Type | Description |
---|---|---|
text | string | A markdown block with JSON |
Returns
any
parsed JSON object
Defined in
packages/core/src/OutputParser.ts:41
readImage
▸ readImage(input
): Promise
<RawImage
>
Parameters
Name | Type |
---|---|
input | ImageType |
Returns
Promise
<RawImage
>
Defined in
packages/core/src/embeddings/utils.ts:211
runTransformations
▸ runTransformations(nodesToRun
, transformations
, transformOptions?
, «destructured»?
): Promise
<BaseNode
[]>
Parameters
Name | Type |
---|---|
nodesToRun | BaseNode <Metadata >[] |
transformations | TransformComponent [] |
transformOptions | any |
«destructured» | TransformRunArgs |
Returns
Promise
<BaseNode
[]>
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:18
serviceContextFromDefaults
▸ serviceContextFromDefaults(options?
): ServiceContext
Parameters
Name | Type |
---|---|
options? | ServiceContextOptions |
Returns
Defined in
packages/core/src/ServiceContext.ts:30
serviceContextFromServiceContext
▸ serviceContextFromServiceContext(serviceContext
, options
): Object
Parameters
Name | Type |
---|---|
serviceContext | ServiceContext |
options | ServiceContextOptions |
Returns
Object
Name | Type |
---|---|
callbackManager | CallbackManager |
embedModel | BaseEmbedding |
llm | LLM |
nodeParser | NodeParser |
promptHelper | PromptHelper |
Defined in
packages/core/src/ServiceContext.ts:48
similarity
▸ similarity(embedding1
, embedding2
, mode?
): number
The similarity between two embeddings.
Parameters
Name | Type | Default value |
---|---|---|
embedding1 | number [] | undefined |
embedding2 | number [] | undefined |
mode | SimilarityType | SimilarityType.DEFAULT |
Returns
number
similarity score with higher numbers meaning the two embeddings are more similar
Defined in
packages/core/src/embeddings/utils.ts:25
splitNodesByType
▸ splitNodesByType(nodes
): Object
Parameters
Name | Type |
---|---|
nodes | BaseNode <Metadata >[] |
Returns
Object
Name | Type |
---|---|
imageNodes | ImageNode [] |
textNodes | TextNode [] |
Defined in
storageContextFromDefaults
▸ storageContextFromDefaults(«destructured»
): Promise
<StorageContext
>
Parameters
Name | Type |
---|---|
«destructured» | Partial <BuilderParams > |
Returns
Promise
<StorageContext
>
Defined in
packages/core/src/storage/StorageContext.ts:28
stringToImage
▸ stringToImage(input
): ImageType
Parameters
Name | Type |
---|---|
input | string |
Returns
Defined in
packages/core/src/embeddings/utils.ts:235
walk
▸ walk(fs
, dirPath
): AsyncIterable
<string
>
Recursively traverses a directory and yields all the paths to the files in it.
Parameters
Name | Type | Description |
---|---|---|
fs | WalkableFileSystem | The filesystem to use. |
dirPath | string | The path to the directory to traverse. |
Returns
AsyncIterable
<string
>