Interface BaseRetrieverInterface

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

Should not change on patch releases.

Hierarchy

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

Implemented by

BaseRetriever

Index

Methods

batch getRelevantDocuments invoke stream transform

Methods

batch

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

getRelevantDocuments

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

invoke

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

stream

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

transform

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

Interface BaseRetrieverInterface

Hierarchy

Implemented by

Index

Methods

Methods

batch

Parameters

inputs: string[]

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

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

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

Parameters

inputs: string[]

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

Optional batchOptions: RunnableBatchOptions & { returnExceptions: true; }

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

Parameters

inputs: string[]

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

Optional batchOptions: RunnableBatchOptions

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

Parameters

inputs: string[]

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

Optional batchOptions: RunnableBatchOptions

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

getRelevantDocuments

Parameters

query: string

Optional config: BaseCallbackConfig | Callbacks

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

invoke

Parameters

input: string

Optional options: Partial<BaseCallbackConfig>

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

stream

Parameters

input: string

Optional options: Partial<BaseCallbackConfig>

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

transform

Parameters

generator: AsyncGenerator<string, any, unknown>

options: Partial<BaseCallbackConfig>

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

Settings

Member Visibility

Theme

On This Page

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

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

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

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

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

`Optional` batchOptions: RunnableBatchOptions

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

`Optional` batchOptions: RunnableBatchOptions

`Optional` config: BaseCallbackConfig | Callbacks

`Optional` options: Partial<BaseCallbackConfig>

`Optional` options: Partial<BaseCallbackConfig>