Interface VectorStoreRetrieverInterface<V>

Base interface implemented by all runnables. Used for cross-compatibility between different versions of LangChain core.

Should not change on patch releases.

interface VectorStoreRetrieverInterface<V> {
    vectorStore: V;
    addDocuments(documents, options?): Promise<void | string[]>;
    batch(inputs, options?, batchOptions?): Promise<DocumentInterface<Record<string, any>>[][]>;
    batch(inputs, options?, batchOptions?): Promise<(Error | DocumentInterface<Record<string, any>>[])[]>;
    batch(inputs, options?, batchOptions?): Promise<(Error | DocumentInterface<Record<string, any>>[])[]>;
    getName(suffix?): string;
    getRelevantDocuments(query, config?): Promise<DocumentInterface<Record<string, any>>[]>;
    invoke(input, options?): Promise<DocumentInterface<Record<string, any>>[]>;
    stream(input, options?): Promise<IterableReadableStreamInterface<DocumentInterface<Record<string, any>>[]>>;
    transform(generator, options): AsyncGenerator<DocumentInterface<Record<string, any>>[], any, unknown>;
}

Type Parameters

V extends VectorStoreInterface = VectorStoreInterface

Hierarchy (view full)

BaseRetrieverInterface
- VectorStoreRetrieverInterface

Implemented by

VectorStoreRetriever

Index

Properties

vectorStore

Methods

addDocuments batch getName getRelevantDocuments invoke stream transform

Properties

vectorStore

vectorStore: V

Methods

addDocuments

addDocuments(documents, options?): Promise<void | string[]>
Parameters
- documents: DocumentInterface<Record<string, any>>[]
- Optional options: AddDocumentOptions
Returns Promise<void | string[]>
- Defined in langchain-core/src/vectorstores.ts:65

batch

batch(inputs, options?, batchOptions?): Promise<DocumentInterface<Record<string, any>>[][]>
Parameters
- inputs: string[]
- Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions?: false;
  }
Returns Promise<DocumentInterface<Record<string, any>>[][]>
Inherited from BaseRetrieverInterface.batch
- Defined in langchain-core/src/runnables/types.ts:34
batch(inputs, options?, batchOptions?): Promise<(Error | DocumentInterface<Record<string, any>>[])[]>
Parameters
- inputs: string[]
- Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions: true;
  }
Returns Promise<(Error | DocumentInterface<Record<string, any>>[])[]>
Inherited from BaseRetrieverInterface.batch
- Defined in langchain-core/src/runnables/types.ts:40
batch(inputs, options?, batchOptions?): Promise<(Error | DocumentInterface<Record<string, any>>[])[]>
Parameters
- inputs: string[]
- Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
- Optional batchOptions: RunnableBatchOptions
Returns Promise<(Error | DocumentInterface<Record<string, any>>[])[]>
Inherited from BaseRetrieverInterface.batch
- Defined in langchain-core/src/runnables/types.ts:46

getName

getName(suffix?): string
Parameters
- Optional suffix: string
Returns string
Inherited from BaseRetrieverInterface.getName
- Defined in langchain-core/src/runnables/types.ts:62

getRelevantDocuments

getRelevantDocuments(query, config?): Promise<DocumentInterface<Record<string, any>>[]>
Parameters
- query: string
- Optional config: CallbackManager | (BaseCallbackHandlerMethodsClass | BaseCallbackHandler)[] | BaseCallbackConfig
Returns Promise<DocumentInterface<Record<string, any>>[]>
Inherited from BaseRetrieverInterface.getRelevantDocuments
- Defined in langchain-core/src/retrievers/index.ts:26

invoke

invoke(input, options?): Promise<DocumentInterface<Record<string, any>>[]>
Parameters
- input: string
- Optional options: Partial<RunnableConfig>
Returns Promise<DocumentInterface<Record<string, any>>[]>
Inherited from BaseRetrieverInterface.invoke
- Defined in langchain-core/src/runnables/types.ts:32

stream

stream(input, options?): Promise<IterableReadableStreamInterface<DocumentInterface<Record<string, any>>[]>>
Parameters
- input: string
- Optional options: Partial<RunnableConfig>
Returns Promise<IterableReadableStreamInterface<DocumentInterface<Record<string, any>>[]>>
Inherited from BaseRetrieverInterface.stream
- Defined in langchain-core/src/runnables/types.ts:52

transform

transform(generator, options): AsyncGenerator<DocumentInterface<Record<string, any>>[], any, unknown>
Parameters
- generator: AsyncGenerator<string, any, unknown>
- options: Partial<RunnableConfig>
Returns AsyncGenerator<DocumentInterface<Record<string, any>>[], any, unknown>
Inherited from BaseRetrieverInterface.transform
- Defined in langchain-core/src/runnables/types.ts:57

Interface VectorStoreRetrieverInterface<V>

Type Parameters

V extends VectorStoreInterface = VectorStoreInterface

Hierarchy (view full)

Implemented by

Index

Properties

Methods

Properties

vectorStore

Methods

addDocuments

Parameters

documents: DocumentInterface<Record<string, any>>[]

Optional options: AddDocumentOptions

Returns Promise<void | string[]>

batch

Parameters

inputs: string[]

Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions?: false; }

Returns Promise<DocumentInterface<Record<string, any>>[][]>

Parameters

inputs: string[]

Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions: true; }

Returns Promise<(Error | DocumentInterface<Record<string, any>>[])[]>

Parameters

inputs: string[]

Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

Optional batchOptions: RunnableBatchOptions

Returns Promise<(Error | DocumentInterface<Record<string, any>>[])[]>

getName

Parameters

Optional suffix: string

Returns string

getRelevantDocuments

Parameters

query: string

Optional config: CallbackManager | (BaseCallbackHandlerMethodsClass | BaseCallbackHandler)[] | BaseCallbackConfig

Returns Promise<DocumentInterface<Record<string, any>>[]>

invoke

Parameters

input: string

Optional options: Partial<RunnableConfig>

Returns Promise<DocumentInterface<Record<string, any>>[]>

stream

Parameters

input: string

Optional options: Partial<RunnableConfig>

Returns Promise<IterableReadableStreamInterface<DocumentInterface<Record<string, any>>[]>>

transform

Parameters

generator: AsyncGenerator<string, any, unknown>

options: Partial<RunnableConfig>

Returns AsyncGenerator<DocumentInterface<Record<string, any>>[], any, unknown>

Settings

Member Visibility

Theme

On This Page

`Optional` options: AddDocumentOptions

`Optional` options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions?: false;
}

`Optional` options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions: true;
}

`Optional` options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

`Optional` batchOptions: RunnableBatchOptions

`Optional` suffix: string

`Optional` config: CallbackManager | (BaseCallbackHandlerMethodsClass | BaseCallbackHandler)[] | BaseCallbackConfig

`Optional` options: Partial<RunnableConfig>

`Optional` options: Partial<RunnableConfig>