API Reference
Enumerations
Section titled “Enumerations”- IndexManagement
- MetadataIndexFieldType
- SimilarityType
- DocStoreStrategy
- NodeRelationship
- ObjectType
- MetadataMode
- ModalityType
- FilterOperator
- FilterCondition
Classes
Section titled “Classes”- AudioTranscriptReader
- AudioTranscriptParagraphsReader
- AudioTranscriptSentencesReader
- AudioSubtitlesReader
- AstraDBVectorStore
- AzureCosmosVCoreKVStore
- AzureCosmosNoSqlKVStore
- SimpleCosmosDBReader
- AzureAISearchVectorStore
- AzureCosmosDBMongoDBVectorStore
- AzureCosmosDBNoSqlVectorStore
- AzureQueryResultSearchBase
- AzureQueryResultSearchDefault
- AzureQueryResultSearchSparse
- AzureQueryResultSearchHybrid
- AzureQueryResultSearchSemanticHybrid
- ChromaVectorStore
- CohereRerank
- BaseEmbedding
- MultiModalEmbedding
- CallbackManager
- EventCaller
- BaseIndex
- VectorStoreIndex
- VectorIndexRetriever
- IngestionCache
- IngestionPipeline
- DuplicatesStrategy
- UpsertsStrategy
- RollbackableTransformComponent
- NodeParser
- TextSplitter
- MetadataAwareTextSplitter
- MarkdownNodeParser
- SentenceSplitter
- SentenceWindowNodeParser
- TokenTextSplitter
- BaseObjectNodeMapping
- ObjectRetriever
- MetadataReplacementPostProcessor
- SimilarityPostprocessor
- BaseRetriever
- BaseNode
- TextNode
- IndexNode
- Document
- ImageNode
- ImageDocument
- TransformComponent
- FileReader
- BaseKVStore
- BaseInMemoryKVStore
- SimpleKVStore
- SimpleVectorStore
- BM25
- BaseVectorStore
- DiscordReader
- ElasticSearchVectorStore
- NotSupportCurrentRuntimeClass
- ExcelReader
- FirestoreVectorStore
- MilvusVectorStore
- MongoDBAtlasVectorSearch
- MongoKVStore
- SimpleMongoReader
- CodeSplitter
- HTMLNodeParser
- NotionReader
- PineconeVectorStore
- PGVectorStore
- PostgresKVStore
- SimplePostgresReader
- QdrantVectorStore
- CSVReader
- SimpleDirectoryReader
- DocxReader
- HTMLReader
- ImageReader
- JSONReaderError
- JSONParseError
- JSONStringifyError
- JSONReader
- MarkdownReader
- ObsidianReader
- PDFReader
- TextFileReader
- XMLReader
- SupabaseVectorStore
- UpstashVectorStore
- WeaviateVectorStore
Interfaces
Section titled “Interfaces”- VcoreConnectionStringOptions
- AzureCosmosVCoreKVStoreConfig
- CosmosDatabaseProperties
- CosmosContainerProperties
- ConnectionStringOptions
- AccountAndKeyOptions
- AadTokenOptions
- AzureCosmosNoSqlKVStoreConfig
- AzureAISearchOptions
- AzureCosmosDBMongoDBQueryOptions
- AzureCosmosDBNoSQLInitOptions
- AzureCosmosDBNoSQLConfig
- AzureCosmosQueryOptions
- VectorstoresEventMaps
- BaseIndexInit
- VectorIndexOptions
- VectorIndexConstructorProps
- BaseNodePostprocessor
- RelatedNodeInfo
- NodeWithScore
- BaseReader
- BaseOutputParser
- CreateVectorStoresOptions
- IsomorphicDB
- VectorStoreQueryResult
- MetadataFilter
- MetadataFilters
- MetadataInfo
- VectorStoreInfo
- VectorStoreQuery
- JSONReaderOptions
- SupabaseVectorStoreInit
Type Aliases
Section titled “Type Aliases”- AssemblyAIOptions
- SimpleCosmosDBReaderLoaderConfig
- FilterableMetadataFieldKeysType
- R
- AzureCosmosDBMongoDBSimilarityType
- AzureCosmosDBMongoDBIndexOptions
- AzureCosmosDBNoSqlCreateDatabaseOptions
- AzureCosmosDBNoSqlCreateContainerOptions
- TextEmbedFunc
- UUID
- JSONValue
- JSONObject
- JSONArray
- VectorIndexChatEngineOptions
- VectorIndexRetrieverOptions
- MessageContentTextDetail
- MessageContentImageDetail
- MessageContentAudioDetail
- MessageContentVideoDetail
- MessageContentImageDataDetail
- MessageContentFileDetail
- MessageContentDetail
- MessageContent
- SplitterParams
- TextSplitterFn
- QueryBundle
- QueryType
- RetrieveParams
- RetrieveStartEvent
- RetrieveEndEvent
- Metadata
- RelatedNodeType
- BaseNodeParams
- TextNodeParams
- IndexNodeParams
- ImageType
- ImageNodeParams
- SentenceSplitterParams
- SentenceSplitterInput
- SentenceWindowNodeParserParams
- SentenceWindowNodeParserInput
- TokenTextSplitterParams
- TokenTextSplitterInput
- StoredValue
- DataType
- VectorStoreQueryMode
- MetadataFilterValue
- VectorStoreByType
- VectorStoreBaseParams
- Logger
- CodeSplitterParam
- HTMLNodeParserParam
- PGVectorStoreConfig
- DataType
- PostgresKVStoreBaseConfig
- PostgresKVStoreClientConfig
- PostgresKVStoreConfig
- PostgresReaderConfig
- PostgresReaderClientConfig
- SupabaseFilter
Variables
Section titled “Variables”- AzureAISearchVectorStoreConfig
- AzureCosmosDBMongoDBSimilarityType
- 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
- Settings
SimpleNodeParser- VectorStoreQueryMode
- DEFAULT_HYBRID_PREFETCH_MULTIPLIER
- RRF_K
- process
- emptyLogger
- consoleLogger
- INTERNAL_ENV
- CustomEvent
- DEFAULT_MAX_CHARS
- PGVECTOR_SCHEMA
- PGVECTOR_TABLE
- DEFAULT_DIMENSIONS
- FILE_EXT_TO_READER
Functions
Section titled “Functions”- wrapEventCaller
- lazyInitHash
- batchEmbeddings
- similarity
- getTopKEmbeddings
- getTopKMMREmbeddings
- getEventCaller
- withEventCaller
- getTransformationHash
- runTransformations
- addNodesToVectorStores
- createDocStoreStrategy
- truncateText
- splitBySep
- splitByChar
- splitBySentenceTokenizer
- splitByRegex
- splitByPhraseRegex
- jsonToNode
- splitNodesByType
- buildNodeFromSplits
- parseSentenceSplitterParams
- parseSentenceWindowNodeParserParams
- parseTokenTextSplitterParams
- exists
- walk
- createVectorStores
- isPromise
- isAsyncIterable
- isIterable
- streamCallbacks
- streamReducer
- prettifyError
- stringifyJSONToMessageContent
- assertIsJSONValue
- formatLLM
- extractText
- extractSingleText
- extractImage
- extractDataUrlComponents
- objectEntries
- streamConverter
- parsePrimitiveValue
- parseArrayValue
- parseNumberValue
- rrfScore
- combineResults
- validateIsFlat
- nodeToMetadata
- metadataDictToNode
- escapeLikeString
- createSHA256
- fileURLToPath
- uint8ArrayToBase64
- setEnvs
- getEnv
- sanitizeMetadata