Interface BaseRetrieverInterface<Metadata>

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

Should not change on patch releases.

Type Parameters

Metadata extends Record<string, any> = Record<string, any>

Hierarchy

RunnableInterface<string, DocumentInterface<Metadata>[]>
- BaseRetrieverInterface
  - VectorStoreRetrieverInterface

Implemented by

BaseRetriever

Index

Methods

batch getRelevantDocuments invoke stream transform

Methods

batch

batch(inputs, options?, batchOptions?): Promise<DocumentInterface<Metadata>[][]>
Parameters
- inputs: string[]
- Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions?: false;
  }
Returns Promise<DocumentInterface<Metadata>[][]>
Inherited from RunnableInterface.batch
- Defined in langchain-core/dist/runnables/base.d.ts:16
batch(inputs, options?, batchOptions?): Promise<(Error | DocumentInterface<Metadata>[])[]>
Parameters
- inputs: string[]
- Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions: true;
  }
Returns Promise<(Error | DocumentInterface<Metadata>[])[]>
Inherited from RunnableInterface.batch
- Defined in langchain-core/dist/runnables/base.d.ts:19
batch(inputs, options?, batchOptions?): Promise<(Error | DocumentInterface<Metadata>[])[]>
Parameters
- inputs: string[]
- Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
- Optional batchOptions: RunnableBatchOptions
Returns Promise<(Error | DocumentInterface<Metadata>[])[]>
Inherited from RunnableInterface.batch
- Defined in langchain-core/dist/runnables/base.d.ts:22

getRelevantDocuments

getRelevantDocuments(query, config?): Promise<DocumentInterface<Metadata>[]>
Parameters
- query: string
- Optional config: BaseCallbackConfig | Callbacks
Returns Promise<DocumentInterface<Metadata>[]>
- Defined in langchain-core/dist/retrievers.d.ts:15

invoke

invoke(input, options?): Promise<DocumentInterface<Metadata>[]>
Parameters
- input: string
- Optional options: Partial<RunnableConfig>
Returns Promise<DocumentInterface<Metadata>[]>
Inherited from RunnableInterface.invoke
- Defined in langchain-core/dist/runnables/base.d.ts:15

stream

stream(input, options?): Promise<IterableReadableStreamInterface<DocumentInterface<Metadata>[]>>
Parameters
- input: string
- Optional options: Partial<RunnableConfig>
Returns Promise<IterableReadableStreamInterface<DocumentInterface<Metadata>[]>>
Inherited from RunnableInterface.stream
- Defined in langchain-core/dist/runnables/base.d.ts:23

transform

transform(generator, options): AsyncGenerator<DocumentInterface<Metadata>[], any, unknown>
Parameters
- generator: AsyncGenerator<string, any, unknown>
- options: Partial<RunnableConfig>
Returns AsyncGenerator<DocumentInterface<Metadata>[], any, unknown>
Inherited from RunnableInterface.transform
- Defined in langchain-core/dist/runnables/base.d.ts:24

Interface BaseRetrieverInterface<Metadata>

Type Parameters

Metadata extends Record<string, any> = Record<string, any>

Hierarchy

Implemented by

Index

Methods

Methods

batch

Parameters

inputs: string[]

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

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

Returns Promise<DocumentInterface<Metadata>[][]>

Parameters

inputs: string[]

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

Optional batchOptions: RunnableBatchOptions & { returnExceptions: true; }

Returns Promise<(Error | DocumentInterface<Metadata>[])[]>

Parameters

inputs: string[]

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

Optional batchOptions: RunnableBatchOptions

Returns Promise<(Error | DocumentInterface<Metadata>[])[]>

getRelevantDocuments

Parameters

query: string

Optional config: BaseCallbackConfig | Callbacks

Returns Promise<DocumentInterface<Metadata>[]>

invoke

Parameters

input: string

Optional options: Partial<RunnableConfig>

Returns Promise<DocumentInterface<Metadata>[]>

stream

Parameters

input: string

Optional options: Partial<RunnableConfig>

Returns Promise<IterableReadableStreamInterface<DocumentInterface<Metadata>[]>>

transform

Parameters

generator: AsyncGenerator<string, any, unknown>

options: Partial<RunnableConfig>

Returns AsyncGenerator<DocumentInterface<Metadata>[], any, unknown>

Settings

Member Visibility

Theme

On This Page

`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` config: BaseCallbackConfig | Callbacks

`Optional` options: Partial<RunnableConfig>

`Optional` options: Partial<RunnableConfig>