LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangChain
  • Browser
  • Universal
  • Hub
  • Node
  • Load
  • Serializable
  • Encoder Backed
  • File System
  • In Memory
  • Tools
LangChain Core
  • Agents
  • Caches
  • Base
  • Dispatch
  • Web
  • Manager
  • Promises
  • Chat History
  • Context
  • Base
  • Langsmith
  • Documents
  • Embeddings
  • Errors
  • Example Selectors
  • Indexing
  • Base
  • Chat Models
  • Compat
  • Event
  • Llms
  • Openai Completions Stream
  • Profile
  • Stream
  • Structured Output
  • Load
  • Serializable
  • Memory
  • Messages
  • Tool
  • Output Parsers
  • Openai Functions
  • Openai Tools
  • Outputs
  • Prompt Values
  • Prompts
  • Retrievers
  • Document Compressors
  • Runnables
  • Graph
  • Singletons
  • Stores
  • Structured Query
  • Testing
  • Tools
  • Base
  • Console
  • Log Stream
  • Run Collector
  • Tracer Langchain
  • Stream
  • Async Caller
  • Chunk Array
  • Context
  • Env
  • Event Source Parse
  • Format
  • Function Calling
  • Gateway
  • Hash
  • Json Patch
  • Json Schema
  • Math
  • Ssrf
  • Standard Schema
  • Stream
  • Testing
  • Tiktoken
  • Types
  • Uuid
  • Vectorstores
Text Splitters
MCP Adapters
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

LangChain
BrowserUniversalHubNodeLoadSerializableEncoder BackedFile SystemIn MemoryTools
LangChain Core
AgentsCachesBaseDispatchWebManagerPromisesChat HistoryContextBaseLangsmithDocumentsEmbeddingsErrorsExample SelectorsIndexingBaseChat ModelsCompatEventLlmsOpenai Completions StreamProfileStreamStructured OutputLoadSerializableMemoryMessagesToolOutput ParsersOpenai FunctionsOpenai ToolsOutputsPrompt ValuesPromptsRetrieversDocument CompressorsRunnablesGraphSingletonsStoresStructured QueryTestingToolsBaseConsoleLog StreamRun CollectorTracer LangchainStreamAsync CallerChunk ArrayContextEnvEvent Source ParseFormatFunction CallingGatewayHashJson PatchJson SchemaMathSsrfStandard SchemaStreamTestingTiktokenTypesUuidVectorstores
Text Splitters
MCP Adapters
Language
Theme
JavaScript@langchain/corevectorstoresVectorStoreRetrieverInterface
Interfaceā—Since v0.3

VectorStoreRetrieverInterface

Interface for a retriever that uses a vector store to store and retrieve document embeddings. This retriever interface allows for adding documents to the underlying vector store and conducting retrieval operations.

VectorStoreRetrieverInterface extends BaseRetrieverInterface to provide document retrieval capabilities based on vector similarity.

VectorStoreRetrieverInterface

Copy
interface VectorStoreRetrieverInterface

Bases

BaseRetrieverInterface

Properties

property
lc_serializable: boolean
property
vectorStore: V
property
lc_id: string[]

Methods

method
addDocuments→ Promise<void | string[]>

Adds an array of documents to the vector store.

This method embeds the provided documents and stores them within the vector store. Additional options can be specified for custom behavior during the addition process.

method
batch→ Promise<DocumentInterface<Record<string, any>>[][]>
method
getName→ string
method
invoke→ Promise<DocumentInterface<Record<string, any>>[]>
method
stream→ Promise<IterableReadableStreamInterface<DocumentInterface<Record<string, any>>[]>>
method
transform→ AsyncGenerator<DocumentInterface<Record<string, any>>[]>

Inherited fromBaseRetrieverInterface

Properties

Plc_serializable: booleanPlc_id: string[]

Methods

Mbatch→ Promise<DocumentInterface<Metadata>[][]>MgetName→ stringMinvoke→ Promise<DocumentInterface<Metadata>[]>Mstream→ Promise<IterableReadableStreamInterface<DocumentInterface<Metadata>[]>>Mtransform→ AsyncGenerator<DocumentInterface<Metadata>[]>

Inherited fromRunnableInterface

Properties

Plc_serializable: booleanPlc_id: string[]

Methods

Mbatch→ Promise<RunOutput[]>MgetName→ stringMinvoke→ Promise<RunOutput>Mstream→ Promise<IterableReadableStreamInterface<RunOutput>>Mtransform→ AsyncGenerator<RunOutput>

Inherited fromSerializableInterface

Properties

Plc_id: string[]
View source on GitHub