Class CallbackManagerForChainRun

Base class for run manager in LangChain.

Hierarchy (view full)

BaseRunManager
- CallbackManagerForChainRun

Implements

BaseCallbackManagerMethods

Index

Constructors

Properties

handlers runId inheritableHandlers inheritableMetadata inheritableTags metadata tags

Accessors

Methods

getChild handleAgentAction handleAgentEnd handleChainEnd handleChainError handleText

Constructors

constructor

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

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:127

Methods

getChild

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

handleAgentAction

handleAgentAction(action): Promise<void>
Called when an agent is about to execute an action, with the action and the run ID.
Parameters
- action: AgentAction
Returns Promise<void>
Implementation of BaseCallbackManagerMethods.handleAgentAction
- Defined in langchain-core/src/callbacks/manager.ts:402

handleAgentEnd

handleAgentEnd(action): Promise<void>
Called when an agent finishes execution, before it exits. with the final output and the run ID.
Parameters
- action: AgentFinish
Returns Promise<void>
Implementation of BaseCallbackManagerMethods.handleAgentEnd
- Defined in langchain-core/src/callbacks/manager.ts:428

handleChainEnd

handleChainEnd(output, _runId?, _parentRunId?, _tags?, kwargs?): Promise<void>
Called at the end of a Chain run, with the outputs and the run ID.
Parameters
- output: ChainValues
- Optional_runId: string
- Optional_parentRunId: string
- Optional_tags: string[]
- Optionalkwargs: {
  inputs?: Record<string, unknown>;
  }
  - Optionalinputs?: Record<string, unknown>
Returns Promise<void>
Implementation of BaseCallbackManagerMethods.handleChainEnd
- Defined in langchain-core/src/callbacks/manager.ts:369

handleChainError

handleChainError(err, _runId?, _parentRunId?, _tags?, kwargs?): Promise<void>
Called if a Chain run encounters an error
Parameters
- err: unknown
- Optional_runId: string
- Optional_parentRunId: string
- Optional_tags: string[]
- Optionalkwargs: {
  inputs?: Record<string, unknown>;
  }
  - Optionalinputs?: Record<string, unknown>
Returns Promise<void>
Implementation of BaseCallbackManagerMethods.handleChainError
- Defined in langchain-core/src/callbacks/manager.ts:336

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:131