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