Class CallbackManagerForRetrieverRun

Manages callbacks for retriever runs.

Hierarchy

BaseRunManager
- CallbackManagerForRetrieverRun

Implements

BaseCallbackManagerMethods

Index

Constructors

Properties

runId handlers inheritableHandlers inheritableMetadata inheritableTags metadata tags _parentRunId?

Methods

getChild handleRetrieverEnd handleRetrieverError handleText

Constructors

constructor

new CallbackManagerForRetrieverRun(runId, handlers, inheritableHandlers, tags, inheritableTags, metadata, inheritableMetadata, _parentRunId?): CallbackManagerForRetrieverRun
Parameters
- runId: string
- handlers: BaseCallbackHandler[]
- inheritableHandlers: BaseCallbackHandler[]
- tags: string[]
- inheritableTags: string[]
- metadata: Record<string, unknown>
- inheritableMetadata: Record<string, unknown>
- Optional _parentRunId: string
Returns CallbackManagerForRetrieverRun
Inherited from BaseRunManager.constructor
- Defined in docs/api_refs/langchain/src/callbacks/manager.ts:101

Properties

`Readonly` runId

runId: string

`Protected` `Readonly` handlers

handlers: BaseCallbackHandler[]

`Protected` `Readonly` inheritableHandlers

inheritableHandlers: BaseCallbackHandler[]

`Protected` `Readonly` inheritableMetadata

inheritableMetadata: Record<string, unknown>

`Protected` `Readonly` inheritableTags

inheritableTags: string[]

`Protected` `Readonly` metadata

metadata: Record<string, unknown>

`Protected` `Readonly` tags

tags: string[]

`Protected` `Optional` `Readonly` _parentRunId

_parentRunId?: string

Methods

getChild

getChild(tag?): CallbackManager
Parameters
- Optional tag: string
Returns CallbackManager
- Defined in docs/api_refs/langchain/src/callbacks/manager.ts:141

handleRetrieverEnd

handleRetrieverEnd(documents): Promise<void>
Parameters
- documents: Document<Record<string, any>>[]
Returns Promise<void>
Implementation of BaseCallbackManagerMethods.handleRetrieverEnd
- Defined in docs/api_refs/langchain/src/callbacks/manager.ts:153

handleRetrieverError

handleRetrieverError(err): Promise<void>
Parameters
- err: unknown
Returns Promise<void>
Implementation of BaseCallbackManagerMethods.handleRetrieverError
- Defined in docs/api_refs/langchain/src/callbacks/manager.ts:176

handleText

handleText(text): Promise<void>
Parameters
- text: string
Returns Promise<void>
Implementation of BaseCallbackManagerMethods.handleText

Inherited from BaseRunManager.handleText
- Defined in docs/api_refs/langchain/src/callbacks/manager.ts:112

Generated using TypeDoc