Class CallbackManagerForChainRun

Base class for run manager in LangChain.

Hierarchy (View Summary)

BaseRunManager
- CallbackManagerForChainRun

Implements

BaseCallbackManagerMethods

Index

Constructors

constructor

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

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

Methods

getChild

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

handleAgentAction

handleAgentAction(action: AgentAction): 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 CallbackHandlerMethods.handleAgentAction
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:467

handleAgentEnd

handleAgentEnd(action: AgentFinish): 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 CallbackHandlerMethods.handleAgentEnd
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:496

handleChainEnd

handleChainEnd(
    output: ChainValues,
    _runId?: string,
    _parentRunId?: string,
    _tags?: string[],
    kwargs?: { inputs?: Record<string, unknown> },
): 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> }
Returns Promise<void>
Implementation of CallbackHandlerMethods.handleChainEnd
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:431

handleChainError

handleChainError(
    err: unknown,
    _runId?: string,
    _parentRunId?: string,
    _tags?: string[],
    kwargs?: { inputs?: Record<string, unknown> },
): 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> }
Returns Promise<void>
Implementation of CallbackHandlerMethods.handleChainError
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:395

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

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

Class CallbackManagerForChainRun

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CallbackManagerForChainRun

Properties

Protected Optional Readonly_parentRunId

Readonlyhandlers

Protected ReadonlyinheritableHandlers

Protected ReadonlyinheritableMetadata

Protected ReadonlyinheritableTags

Protected Readonlymetadata

ReadonlyrunId

Protected Readonlytags

Accessors

parentRunId

Returns undefined | string

Methods

getChild

Parameters

Returns CallbackManager

handleAgentAction

Parameters

Returns Promise<void>

handleAgentEnd

Parameters

Returns Promise<void>

handleChainEnd

Parameters

Returns Promise<void>

handleChainError

Parameters

Returns Promise<void>

handleCustomEvent

Parameters

Returns Promise<void>

handleText

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Optional` `Readonly`_parentRunId

`Readonly`handlers

`Protected` `Readonly`inheritableHandlers

`Protected` `Readonly`inheritableMetadata

`Protected` `Readonly`inheritableTags

`Protected` `Readonly`metadata

`Readonly`runId

`Protected` `Readonly`tags