Skip to content
LlamaIndex TypeScript API Reference
Search
Ctrl
K
Cancel
Twitter
LinkedIn
Bluesky
GitHub
Select theme
Dark
Light
Auto
LlamaIndex TypeScript API Reference
classes
AgentRunner
AgentWorker
AgentWorkflow
AmazonKnowledgeBaseRetriever
AmazonKnowledgeBaseRetriever-1
Anthropic
AnthropicAgent
AnthropicAgentWorker
AnthropicSession
AstraDBVectorStore
AudioSubtitlesReader
AudioTranscriptParagraphsReader
AudioTranscriptReader
AudioTranscriptSentencesReader
AzureAISearchVectorStore
AzureCosmosDBMongoDBVectorStore
AzureCosmosDBNoSqlVectorStore
AzureCosmosNoSqlChatStore
AzureCosmosNoSqlDocumentStore
AzureCosmosNoSqlIndexStore
AzureCosmosNoSqlKVStore
AzureCosmosVCoreChatStore
AzureCosmosVCoreDocumentStore
AzureCosmosVCoreIndexStore
AzureCosmosVCoreKVStore
AzureDynamicSessionTool
AzureOpenAI
AzureOpenAIEmbedding
AzureOpenAIResponses
AzureQueryResultSearchBase
AzureQueryResultSearchDefault
AzureQueryResultSearchHybrid
AzureQueryResultSearchSemanticHybrid
AzureQueryResultSearchSparse
BaseChatEngine
BaseChatStore
BaseDocumentStore
BaseEmbedding
BaseExtractor
BaseIndex
BaseIndexStore
BaseInMemoryKVStore
BaseKVStore
BaseLLM
BaseMemory
BaseMemoryBlock
BaseNode
BaseObjectNodeMapping
BasePromptTemplate
BaseQueryEngine
BaseRetriever
BaseSelector
BaseSynthesizer
BaseVectorStore
Bedrock
Bedrock-1
Bm25Retriever
CallbackManager
ChatMemoryBuffer
ChatMessageAdapter
ChatSummaryMemoryBuffer
ChromaVectorStore
ClipEmbedding
CodeSplitter
CohereRerank
CompactAndRefine
CondenseQuestionChatEngine
ContextChatEngine
CorrectnessEvaluator
CSVReader
DeepInfra
DeepInfraEmbedding
DeepSeekLLM
DefaultContextGenerator
DiscordReader
Document
DocxReader
DuplicatesStrategy
ElasticSearchVectorStore
EngineResponse
EventCaller
ExcelReader
FactExtractionMemoryBlock
FaithfulnessEvaluator
FileReader
FirestoreVectorStore
FireworksEmbedding
FireworksLLM
FunctionAgent
FunctionTool
Gemini
GeminiEmbedding
GeminiLive
GeminiLiveSession
GoogleStudio
Groq
HTMLNodeParser
HTMLReader
HuggingFaceEmbedding
HuggingFaceInferenceAPI
HuggingFaceInferenceAPIEmbedding
HuggingFaceLLM
ImageDocument
ImageNode
ImageReader
IndexDict
IndexList
IndexNode
IndexStruct
IngestionCache
IngestionPipeline
JinaAIEmbedding
JinaAIReranker
JSONParseError
JSONReader
JSONReaderError
JSONStringifyError
KeywordExtractor
KeywordTable
KeywordTableIndex
KeywordTableLLMRetriever
KeywordTableRAKERetriever
KeywordTableSimpleRetriever
KVDocumentStore
KVIndexStore
LiveLLM
LiveLLMSession
LLMAgent
LLMAgentWorker
LLMMultiSelector
LLMQuestionGenerator
LLMSingleSelector
MarkdownNodeParser
MarkdownReader
Memory
MetadataAwareTextSplitter
MetadataReplacementPostProcessor
MilvusVectorStore
MistralAI
MistralAIEmbedding
MistralAISession
MixedbreadAIEmbeddings
MixedbreadAIReranker
MongoDBAtlasVectorSearch
MongoDocumentStore
MongoKVStore
MultiModal
MultiModalEmbedding
NodeParser
NotionReader
NotSupportCurrentRuntimeClass
ObjectIndex
ObjectRetriever
ObsidianReader
Ollama
OllamaAgent
OllamaAgentWorker
OllamaEmbedding
OpenAI
OpenAIAgent
OpenAIAgentWorker
OpenAIEmbedding
OpenAIResponses
OpenAPIActionTool
PDFReader
Perplexity
PGVectorStore
PineconeVectorStore
Portkey
PortkeySession
PostgresDocumentStore
PostgresIndexStore
PostgresKVStore
PromptHelper
PromptMixin
PromptTemplate
QdrantVectorStore
QueryEngineTool
QuestionsAnsweredExtractor
ReActAgent
ReACTAgentWorker
Refine
RelevancyEvaluator
ReplicateLLM
ReplicateSession
RetrieverQueryEngine
RollbackableTransformComponent
RouterQueryEngine
SentenceSplitter
SentenceWindowNodeParser
SimilarityPostprocessor
SimpleChatEngine
SimpleChatStore
SimpleCosmosDBReader
SimpleDirectoryReader
SimpleDocumentStore
SimpleIndexStore
SimpleKVStore
SimpleMongoReader
SimplePostgresReader
SimpleToolNodeMapping
SimpleVectorStore
StaticMemoryBlock
SubQuestionOutputParser
SubQuestionQueryEngine
SummaryExtractor
SummaryIndex
SummaryIndexLLMRetriever
SummaryIndexRetriever
SupabaseVectorStore
TextFileReader
TextNode
TextSplitter
TitleExtractor
TogetherEmbedding
TogetherLLM
TokenTextSplitter
ToolCallLLM
TransformComponent
TreeSummarize
UpsertsAndDeleteStrategy
UpsertsStrategy
UpstashVectorStore
VectorIndexRetriever
VectorMemoryBlock
VectorStoreIndex
VercelLLM
VercelMessageAdapter
VLLM
VoyageAIEmbedding
WeaviateVectorStore
XAILLM
XMLReader
enumerations
ClipEmbeddingModelType
DocStoreStrategy
FilterCondition
FilterOperator
GEMINI_EMBEDDING_MODEL
GEMINI_MESSAGE_ROLE
GEMINI_MODEL
HuggingFaceEmbeddingModelType
IndexManagement
KeywordTableRetrieverMode
LiveLLMCapability
MetadataIndexFieldType
MetadataMode
MistralAIEmbeddingModelType
ModalityType
NodeRelationship
ObjectType
ReplicateChatStrategy
SimilarityType
SummaryRetrieverMode
VectorStoreQueryMode
functions
addContentPart
addNodesToVectorStores
agent
agentHandler
anthropic
assertIsJSONValue
base64ToBlob
base64ToUint8Array
batchEmbeddings
blobToDataUrl
buildNodeFromSplits
callSingleTool
callTool
callTools
chatWithTools
classify
codeArtifactGenerator
codeGenerator
consumeAsyncIterable
createDocStoreStrategy
createMemory
createMessageContent
createReadableStream
createSHA256
deepinfra
deepseek
defaultEvaluationParser
docToJson
documentArtifactGenerator
documentGenerator
duckduckgo
escapeLikeString
exists
expandTokensWithSubtokens
extractDataUrlComponents
extractImage
extractKeywordsGivenResponse
extractMissingCells
extractSingleText
extractText
factExtractionBlock
fileURLToPath
fillMissingCells
fireworks
gemini
getBiggestPrompt
getEnv
getEventCaller
getGoogleStudioInlineData
getMimeTypeFromDataUrl
getOpenAPIActionTools
getPortkeySession
getResponseSynthesizer
getSelectorFromContext
getToolCallsFromResponse
getTopKEmbeddings
getTopKMMREmbeddings
getTransformationHash
groq
huggingface
imageGenerator
imageToDataUrl
interpreter
isAsyncIterable
isIterable
isPromise
isValidDocJson
isZodSchema
isZodV3Schema
isZodV4Schema
jsonToDoc
jsonToIndexStruct
jsonToNode
lazyInitHash
llamaindex
loadMemory
mapBaseToolToGeminiFunctionDeclaration
mapBaseToolToGeminiLiveFunctionDeclaration
mapResponseModalityToGeminiLiveResponseModality
mcp
mergeNeighboringSameRoleMessages
messageContentDetailToGeminiPart
messagesToHistory
metadataDictToNode
mistral
multiAgent
nodeToMetadata
objectEntries
ollama
openai
openaiResponses
parseArrayValue
parseJsonMarkdown
parseNumberValue
parsePrimitiveValue
parseSchema
perplexity
portkey
prettifyError
rakeExtractKeywords
runTransformations
safeParseSchema
sanitizeMetadata
setEnvs
similarity
simpleExtractKeywords
splitByChar
splitByPhraseRegex
splitByRegex
splitBySentenceTokenizer
splitBySep
splitNodesByType
staticBlock
stepTools
stepToolsStreaming
storageContextFromDefaults
streamCallbacks
streamConverter
streamReducer
stringifyJSONToMessageContent
together
toToolDescriptions
truncateMaxTokens
truncateText
uint8ArrayToBase64
uint8ArrayToBase64-1
validateAgentParams
validateIsFlat
vectorBlock
vercel
vllm
walk
weather
wiki
withEventCaller
withLlamaIndex
wrapEventCaller
wrapLLMEvent
xai
zodToJsonSchema
interfaces
AadTokenOptions
AccountAndKeyOptions
AudioConfig
AzureAISearchOptions
AzureCosmosChatContainerProperties
AzureCosmosChatDatabaseProperties
AzureCosmosDBMongoDBQueryOptions
AzureCosmosDBNoSQLConfig
AzureCosmosDBNoSQLInitOptions
AzureCosmosNoSqlChatStoreConfig
AzureCosmosNoSqlDocumentStoreArgs
AzureCosmosNoSqlIndexStoreArgs
AzureCosmosNoSqlKVStoreConfig
AzureCosmosQueryOptions
AzureCosmosVCoreChatStoreConfig
AzureCosmosVCoreDocumentStoreArgs
AzureCosmosVCoreIndexStoreArgs
AzureCosmosVCoreKVStoreConfig
BaseChatEngineParams
BaseIndexInit
BaseNodePostprocessor
BaseOutputParser
BaseReader
BaseTool
BaseWorkflowAgent
ChatResponse
CompletionResponse
ConnectionStringOptions
CosmosContainerProperties
CosmosDatabaseProperties
DeepInfraEmbeddingResponse
GeminiLiveConfig
HFLLMConfig
InferenceStatus
IsomorphicDB
JSONReaderOptions
KeywordIndexOptions
LiveConnectConfig
LlamaIndexEventMaps
LLM
LLMChat
LLMChatParamsBase
LLMChatParamsNonStreaming
LLMChatParamsStreaming
LLMCompletionParamsBase
LLMCompletionParamsNonStreaming
LLMCompletionParamsStreaming
MessageAdapter
MessageSender
MetadataFilter
MetadataFilters
MetadataInfo
MixedbreadAIEmbeddingsParams
MixedbreadAIRerankerParams
NodeWithScore
NonStreamingChatEngineParams
RefDocInfo
RelatedNodeInfo
RemoteFileMetadata
Serializer
SingleSelection
StorageContext
StreamingChatEngineParams
StructuredOutput
SummaryIndexOptions
SupabaseVectorStoreInit
VcoreConnectionStringOptions
VectorIndexConstructorProps
VectorIndexOptions
VectorStoreInfo
VectorStoreQuery
VectorStoreQueryResult
type-aliases
AgentEndEvent
AgentInput
AgentInputData
AgentOutput
AgentParamsBase
AgentResultData
AgentSetup
AgentStartEvent
AgentStep
AgentToolCall
AgentToolCallResult
AgentWorkflowParams
AgentWorkflowState
AnthropicAdditionalChatOptions
AnthropicAgentParams
AnthropicToolCallLLMMessageOptions
AssemblyAIOptions
AzureCosmosDBMongoDBIndexOptions
AzureCosmosDBMongoDBSimilarityType
AzureCosmosDBNoSqlCreateContainerOptions
AzureCosmosDBNoSqlCreateDatabaseOptions
AzureDynamicSessionToolParams
BaseEmbeddingOptions
BaseNodeParams
BasePromptTemplateOptions
BaseSynthesizerOptions
BaseToolWithCall
BEDROCK_MODELS
BEDROCK_MODELS-1
BedrockChatNonStreamResponse
BedrockChatNonStreamResponse-1
BedrockChatParamsNonStreaming
BedrockChatParamsNonStreaming-1
BedrockChatParamsStreaming
BedrockChatParamsStreaming-1
BedrockModelParams
BedrockModelParams-1
BedrockParams
BedrockParams-1
Bm25RetrieverOptions
ChatMessage
ChatResponseChunk
ChoiceSelectParseResult
ChoiceSelectParserFunction
ChoiceSelectPrompt
CodeArtifact
CodeArtifactGeneratorToolOutput
CodeGeneratorToolOutput
CodeSplitterParam
CondenseQuestionPrompt
ContextChatEngineOptions
ContextSystemPrompt
CorrectnessSystemPrompt
DataType
DataType-1
DocumentArtifactGeneratorToolOutput
DocumentGeneratorParams
DuckDuckGoToolOutput
EmbeddingInfo
EmitEvent
FaithfulnessRefinePrompt
FaithfulnessTextQAPrompt
FillMissingCellsParams
FillMissingCellsToolOutput
FilterableMetadataFieldKeysType
FunctionAgentParams
GeminiConfig
GeminiEmbeddingOptions
GeminiVoiceName
GoogleAdditionalChatOptions
GoogleChatNonStreamResponse
GoogleChatParamsNonStreaming
GoogleChatParamsStreaming
GoogleChatStreamResponse
GoogleModelParams
GoogleParams
HFConfig
HTMLNodeParserParam
HuggingFaceEmbeddingParams
ImageNodeParams
ImageType
ImgGeneratorToolOutput
ImgGeneratorToolParams
IndexNodeParams
IndexStructType
INFERENCE_BEDROCK_MODELS
INFERENCE_BEDROCK_MODELS-1
Info
InfoString
InterpreterExtraResult
InterpreterExtraType
InterpreterParameter
InterpreterToolOutput
InterpreterToolOutput-1
InterpreterToolOutputImage
InterpreterToolParams
JinaEmbeddingRequest
JinaEmbeddingResponse
JSONArray
JSONObject
JSONValue
KeywordExtractPrompt
KeywordTableIndexChatEngineOptions
ListIndex
ListIndexLLMRetriever
ListIndexRetriever
ListRetrieverMode
LiveEvent
LLMAgentParams
LLMEndEvent
LLMInstance
LLMMetadata
LLMStartEvent
LLMStreamEvent
LLMToolCallEvent
LLMToolResultEvent
Logger
MCPClientOptions
MemoryMessage
MemoryMessageExtension
MemorySnapshot
MessageContent
MessageContentAudioDetail
MessageContentDetail
MessageContentFileDetail
MessageContentImageDataDetail
MessageContentImageDetail
MessageContentTextDetail
MessageContentVideoDetail
MessageType
Metadata
MetadataFilterValue
MissingCell
ModuleRecord
NodeFormatterFunction
OllamaAgentParams
OllamaParams
OpenAIAgentParams
OpenAIResponsesMessageOptions
PartialToolCall
PGVectorStoreConfig
PostgresDocumentStoreConfig
PostgresIndexStoreConfig
PostgresKVStoreBaseConfig
PostgresKVStoreClientConfig
PostgresKVStoreConfig
PostgresReaderClientConfig
PostgresReaderConfig
PromptHelperOptions
PromptsRecord
PromptTemplateOptions
QueryBundle
QueryEndEvent
QueryEngineParam
QueryEngineToolParams
QueryKeywordExtractPrompt
QueryStartEvent
QueryToolParams
QueryType
QuestionExtractPrompt
R
ReACTAgentParams
RefinePrompt
RelatedNodeType
RelevancyEvalPrompt
RelevancyRefinePrompt
ResponseMode
RetrieveEndEvent
RetrieveParams
RetrieveStartEvent
SelectorResult
SentenceSplitterParams
SentenceWindowNodeParserParams
SimpleCosmosDBReaderLoaderConfig
SingleAgentParams
SplitterParams
StepHandlerParams
StoredValue
StringTemplate
SubQuestionPrompt
SummaryIndexChatEngineOptions
SummaryPrompt
SupabaseFilter
SynthesizeEndEvent
SynthesizeQuery
SynthesizeStartEvent
TaskHandler
TaskStep
TextChatMessage
TextNodeParams
TextQAPrompt
TextSplitterFn
TitleCombinePrompt
TitleExtractorPrompt
TokenTextSplitterParams
ToolCall
ToolCallLLMMessageOptions
ToolCallOptions
ToolCalls
ToolMetadata
ToolMetadataOnlyDescription
ToolOutput
ToolResult
ToolResultOptions
ToolResults
TreeSummarizePrompt
UserPrompt
UUID
UUID-1
VectorIndexChatEngineOptions
VectorIndexRetrieverOptions
VectorStoreBaseParams
VectorStoreByType
VercelAdditionalChatOptions
VercelMessage
VLLMParams
WeatherToolOutput
WikiToolOutput
ZodEvent
ZodInfer
ZodSchema
variables
agentInputEvent
agentOutputEvent
agentParamsSchema
agentSetupEvent
agentStepEvent
agentStreamEvent
agentToolCallEvent
agentToolCallResultEvent
ALL_AVAILABLE_ANTHROPIC_LEGACY_MODELS
ALL_AVAILABLE_ANTHROPIC_MODELS
ALL_AVAILABLE_MISTRAL_MODELS
ALL_AVAILABLE_REPLICATE_MODELS
ALL_AVAILABLE_V3_5_MODELS
ALL_AVAILABLE_V3_7_MODELS
ALL_AVAILABLE_V3_MODELS
ALL_AVAILABLE_V4_MODELS
ALL_OPENAI_EMBEDDING_MODELS
anthropicSummaryPrompt
anthropicTextQaPrompt
anyFunctionSchema
AzureAISearchVectorStoreConfig
AzureCosmosDBMongoDBSimilarityType
baseToolSchema
baseToolWithCallSchema
BEDROCK_MODEL_MAX_TOKENS
BEDROCK_MODEL_MAX_TOKENS-1
BEDROCK_MODELS
BEDROCK_MODELS-1
consoleLogger
CustomEvent
DEEPSEEK_MODELS
DEFAULT_BASE_URL
DEFAULT_CHUNK_OVERLAP
DEFAULT_CHUNK_OVERLAP_RATIO
DEFAULT_CHUNK_SIZE
DEFAULT_COLLECTION
DEFAULT_CONTEXT_WINDOW
DEFAULT_DIMENSIONS
DEFAULT_DOC_STORE_PERSIST_FILENAME
DEFAULT_EMBED_BATCH_SIZE
DEFAULT_EU_BASE_URL
DEFAULT_GEMINI_PARAMS
DEFAULT_GRAPH_STORE_PERSIST_FILENAME
DEFAULT_INDEX_STORE_PERSIST_FILENAME
DEFAULT_MAX_CHARS
DEFAULT_NAMESPACE
DEFAULT_NUM_OUTPUTS
DEFAULT_PADDING
DEFAULT_PERSIST_DIR
DEFAULT_PERSIST_PATH
DEFAULT_PROJECT_NAME
DEFAULT_SAFETY_SETTINGS
DEFAULT_SIMILARITY_TOP_K
DEFAULT_VECTOR_STORE_PERSIST_FILENAME
defaultChoiceSelectPrompt
defaultCondenseQuestionPrompt
defaultContextSystemPrompt
defaultCorrectnessSystemPrompt
defaultFaithfulnessRefinePrompt
defaultFaithfulnessTextQaPrompt
defaultFormatNodeBatchFn
defaultKeywordExtractPrompt
defaultNodeTextTemplate
defaultParseChoiceSelectAnswerFn
defaultQueryKeywordExtractPrompt
defaultQuestionExtractPrompt
defaultRefinePrompt
defaultRelevancyEvalPrompt
defaultRelevancyRefinePrompt
defaultSubQuestionPrompt
defaultSummaryPrompt
defaultTextQAPrompt
defaultTitleCombinePromptTemplate
defaultTitleExtractorPromptTemplate
defaultTreeSummarizePrompt
defaultUserPrompt
DeuceChatStrategy
emptyLogger
FILE_EXT_TO_READER
GEMINI_MODEL_INFO_MAP
IndexStructType
INFERENCE_BEDROCK_MODELS
INFERENCE_BEDROCK_MODELS-1
INFERENCE_TO_BEDROCK_MAP
INFERENCE_TO_BEDROCK_MAP-1
INTERNAL_ENV
jsonSerializer
liveEvents
LlamaDeuce
noneSerializer
PERPLEXITY_MODELS
PGVECTOR_SCHEMA
PGVECTOR_TABLE
process
PROVIDERS
PROVIDERS-1
responseModeSchema
ROLES_FROM_GEMINI
ROLES_TO_GEMINI
sentenceSplitterSchema
sentenceWindowNodeParserSchema
Settings
Settings-1
SimpleNodeParser
startAgentEvent
stopAgentEvent
store
STREAMING_MODELS
STREAMING_MODELS-1
SUPPORT_TOOL_CALL_MODELS
tokenTextSplitterSchema
tool
TOOL_CALL_MISTRAL_MODELS
TOOL_CALL_MODELS
TOOL_CALL_MODELS-1
toolCallsEvent
toolMetadataAtom
toolMetadataSchema
toolResultsEvent
toolsAtom
Twitter
LinkedIn
Bluesky
GitHub
Select theme
Dark
Light
Auto
createSHA256
createSHA256
():
SHA256
Defined in:
.build/typescript/packages/env/src/index.ts:25
Returns
Section titled “Returns”
SHA256