Class CallbackManagerForChainRun

Base class for run manager in LangChain.

Hierarchy (view full)

Implements

  • BaseCallbackManagerMethods

Constructors

constructor

Properties

handlers inheritableHandlers inheritableMetadata inheritableTags metadata runId tags

Accessors

parentRunId

Methods

getChild handleAgentAction handleAgentEnd handleChainEnd handleChainError handleCustomEvent handleText

Constructors

constructor

Properties

Readonlyhandlers

handlers: BaseCallbackHandler[]

Protected ReadonlyinheritableHandlers

inheritableHandlers: BaseCallbackHandler[]

Protected ReadonlyinheritableMetadata

inheritableMetadata: Record<string, unknown>

Protected ReadonlyinheritableTags

inheritableTags: string[]

Protected Readonlymetadata

metadata: Record<string, unknown>

ReadonlyrunId

runId: string

Protected Readonlytags

tags: string[]

Accessors

parentRunId

Methods

getChild

handleAgentAction

  • handleAgentAction(action): Promise<void>

  • Called when an agent is about to execute an action, with the action and the run ID.

    Parameters

    Returns Promise<void>

handleAgentEnd

  • handleAgentEnd(action): Promise<void>

  • Called when an agent finishes execution, before it exits. with the final output and the run ID.

    Parameters

    Returns Promise<void>

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>

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>

handleCustomEvent

  • handleCustomEvent(eventName, data, _runId?, _tags?, _metadata?): Promise<void>

  • Parameters

    • eventName: string
    • data: any
    • Optional_runId: string
    • Optional_tags: string[]
    • Optional_metadata: Record<string, any>

    Returns Promise<void>

handleText

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods