Class CallbackManagerForRetrieverRun

Manages callbacks for retriever runs.

Hierarchy (View Summary)

BaseRunManager
- CallbackManagerForRetrieverRun

Implements

BaseCallbackManagerMethods

Index

Constructors

Properties

_parentRunId? handlers inheritableHandlers inheritableMetadata inheritableTags metadata runId tags

Accessors

Methods

getChild handleCustomEvent handleRetrieverEnd handleRetrieverError handleText

Constructors

constructor

new CallbackManagerForRetrieverRun(
    runId: string,
    handlers: BaseCallbackHandler[],
    inheritableHandlers: BaseCallbackHandler[],
    tags: string[],
    inheritableTags: string[],
    metadata: Record<string, unknown>,
    inheritableMetadata: Record<string, unknown>,
    _parentRunId?: string,
): 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 remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/callbacks/manager.ts:104

Properties

`Protected` `Optional` `Readonly`_parentRunId

_parentRunId?: string

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

`Readonly`runId

runId: string

`Protected` `Readonly`tags

tags: string[]

Accessors

parentRunId

get parentRunId(): undefined | string
Returns undefined | string
Inherited from BaseRunManager.parentRunId
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/callbacks/manager.ts:115

Methods

getChild

getChild(tag?: string): CallbackManager
Parameters
- Optionaltag: string
Returns CallbackManager
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/callbacks/manager.ts:190

handleCustomEvent

handleCustomEvent(
    eventName: string,
    data: any,
    _runId?: string,
    _tags?: string[],
    _metadata?: Record<string, any>,
): Promise<void>
Parameters
- eventName: string
- data: any
- Optional_runId: string
- Optional_tags: string[]
- Optional_metadata: Record<string, any>
Returns Promise<void>
Implementation of CallbackHandlerMethods.handleCustomEvent
Inherited from BaseRunManager.handleCustomEvent
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/callbacks/manager.ts:146

handleRetrieverEnd

handleRetrieverEnd(
documents: DocumentInterface<Record<string, any>>[],
): Promise<void>
Parameters
- documents: DocumentInterface<Record<string, any>>[]
Returns Promise<void>
Implementation of CallbackHandlerMethods.handleRetrieverEnd
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/callbacks/manager.ts:202

handleRetrieverError

handleRetrieverError(err: unknown): Promise<void>
Parameters
- err: unknown
Returns Promise<void>
Implementation of CallbackHandlerMethods.handleRetrieverError
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/callbacks/manager.ts:231

handleText

handleText(text: string): Promise<void>
Parameters
- text: string
Returns Promise<void>
Implementation of CallbackHandlerMethods.handleText
Inherited from BaseRunManager.handleText
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/callbacks/manager.ts:119