Class CallbackManagerForRetrieverRun

Manages callbacks for retriever runs.

Hierarchy (view full)

BaseRunManager
- CallbackManagerForRetrieverRun

Implements

BaseCallbackManagerMethods

Index

Constructors

Properties

handlers runId inheritableHandlers inheritableMetadata inheritableTags metadata tags

Accessors

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 langchain-core/src/callbacks/manager.ts:115

Properties

`Readonly`handlers

handlers: BaseCallbackHandler[]

`Readonly`runId

runId: string

`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[]

Accessors

parentRunId

get parentRunId(): undefined | string
Returns undefined | string
Inherited from BaseRunManager.parentRunId
- Defined in langchain-core/src/callbacks/manager.ts:126

Methods

getChild

getChild(tag?): CallbackManager
Parameters
- Optionaltag: string
Returns CallbackManager
- Defined in langchain-core/src/callbacks/manager.ts:162

handleRetrieverEnd

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

handleRetrieverError

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

handleText

handleText(text): Promise<void>
Parameters
- text: string
Returns Promise<void>
Implementation of BaseCallbackManagerMethods.handleText
Inherited from BaseRunManager.handleText
- Defined in langchain-core/src/callbacks/manager.ts:130