Class CallbackManager

Example

const prompt = PromptTemplate.fromTemplate("What is the answer to {question}?");

// Example of using LLMChain with OpenAI and a simple prompt
const chain = new LLMChain({
  llm: new ChatOpenAI({ model: "gpt-4o-mini", temperature: 0.9 }),
  prompt,
});

// Running the chain with a single question
const result = await chain.call({
  question: "What is the airspeed velocity of an unladen swallow?",
});
console.log("The answer is:", result);

Hierarchy (View Summary)

BaseCallbackManager
- CallbackManager

Implements

BaseCallbackManagerMethods

Constructors

constructor

new CallbackManager(
    parentRunId?: string,
    options?: {
        handlers?: BaseCallbackHandler[];
        inheritableHandlers?: BaseCallbackHandler[];
        inheritableMetadata?: Record<string, unknown>;
        inheritableTags?: string[];
        metadata?: Record<string, unknown>;
        tags?: string[];
    },
): CallbackManager
Parameters
- OptionalparentRunId: string
- Optionaloptions: {
      handlers?: BaseCallbackHandler[];
      inheritableHandlers?: BaseCallbackHandler[];
      inheritableMetadata?: Record<string, unknown>;
      inheritableTags?: string[];
      metadata?: Record<string, unknown>;
      tags?: string[];
  }
Returns CallbackManager
Overrides BaseCallbackManager.constructor
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:640

Properties

`Optional`_parentRunId

_parentRunId?: string

handlers

handlers: BaseCallbackHandler[] = []

inheritableHandlers

inheritableHandlers: BaseCallbackHandler[] = []

inheritableMetadata

inheritableMetadata: Record<string, unknown> = {}

inheritableTags

inheritableTags: string[] = []

metadata

metadata: Record<string, unknown> = {}

name

name: string = "callback_manager"

Methods

addHandler

addHandler(handler: BaseCallbackHandler, inherit?: boolean): void
Parameters
- handler: BaseCallbackHandler
- inherit: boolean = true
Returns void
Overrides BaseCallbackManager.addHandler
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:1074

addMetadata

addMetadata(metadata: Record<string, unknown>, inherit?: boolean): void
Parameters
- metadata: Record<string, unknown>
- inherit: boolean = true
Returns void
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:1111

addTags

addTags(tags: string[], inherit?: boolean): void
Parameters
- tags: string[]
- inherit: boolean = true
Returns void
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:1096

copy

copy(
additionalHandlers?: BaseCallbackHandler[],
inherit?: boolean,
): CallbackManager
Parameters
- additionalHandlers: BaseCallbackHandler[] = []
- inherit: boolean = true
Returns CallbackManager
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:1125

getParentRunId

getParentRunId(): undefined | string
Gets the parent run ID, if any.

Returns undefined | string
The parent run ID.
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:668

handleChainStart

handleChainStart(
    chain: Serialized,
    inputs: ChainValues,
    runId?: string,
    runType?: undefined | string,
    _tags?: undefined | string[],
    _metadata?: undefined | Record<string, unknown>,
    runName?: undefined | string,
): Promise<CallbackManagerForChainRun>
Called at the start of a Chain run, with the chain name and inputs and the run ID.
Parameters
- chain: Serialized
- inputs: ChainValues
- runId: string = ...
- runType: undefined | string = undefined
- _tags: undefined | string[] = undefined
- _metadata: undefined | Record<string, unknown> = undefined
- runName: undefined | string = undefined
Returns Promise<CallbackManagerForChainRun>
Implementation of CallbackHandlerMethods.handleChainStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:838

handleChatModelStart

handleChatModelStart(
    llm: Serialized,
    messages: BaseMessage<MessageStructure, MessageType>[][],
    runId?: undefined | string,
    _parentRunId?: undefined | string,
    extraParams?: undefined | Record<string, unknown>,
    _tags?: undefined | string[],
    _metadata?: undefined | Record<string, unknown>,
    runName?: undefined | string,
): Promise<CallbackManagerForLLMRun[]>
Called at the start of a Chat Model run, with the prompt(s) and the run ID.
Parameters
- llm: Serialized
- messages: BaseMessage<MessageStructure, MessageType>[][]
- runId: undefined | string = undefined
- _parentRunId: undefined | string = undefined
- extraParams: undefined | Record<string, unknown> = undefined
- _tags: undefined | string[] = undefined
- _metadata: undefined | Record<string, unknown> = undefined
- runName: undefined | string = undefined
Returns Promise<CallbackManagerForLLMRun[]>
Implementation of CallbackHandlerMethods.handleChatModelStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:748

`Optional`handleCustomEvent

handleCustomEvent?(
    eventName: string,
    data: any,
    runId: string,
    _tags?: string[],
    _metadata?: Record<string, any>,
): Promise<any>
Parameters
- eventName: string
- data: any
- runId: string
- Optional_tags: string[]
- Optional_metadata: Record<string, any>
Returns Promise<any>
Implementation of CallbackHandlerMethods.handleCustomEvent
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:1035

handleLLMStart

handleLLMStart(
    llm: Serialized,
    prompts: string[],
    runId?: undefined | string,
    _parentRunId?: undefined | string,
    extraParams?: undefined | Record<string, unknown>,
    _tags?: undefined | string[],
    _metadata?: undefined | Record<string, unknown>,
    runName?: undefined | string,
): Promise<CallbackManagerForLLMRun[]>
Called at the start of an LLM or Chat Model run, with the prompt(s) and the run ID.
Parameters
- llm: Serialized
- prompts: string[]
- runId: undefined | string = undefined
- _parentRunId: undefined | string = undefined
- extraParams: undefined | Record<string, unknown> = undefined
- _tags: undefined | string[] = undefined
- _metadata: undefined | Record<string, unknown> = undefined
- runName: undefined | string = undefined
Returns Promise<CallbackManagerForLLMRun[]>
Implementation of CallbackHandlerMethods.handleLLMStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:672

handleRetrieverStart

handleRetrieverStart(
    retriever: Serialized,
    query: string,
    runId?: string,
    _parentRunId?: undefined | string,
    _tags?: undefined | string[],
    _metadata?: undefined | Record<string, unknown>,
    runName?: undefined | string,
): Promise<CallbackManagerForRetrieverRun>
Parameters
- retriever: Serialized
- query: string
- runId: string = ...
- _parentRunId: undefined | string = undefined
- _tags: undefined | string[] = undefined
- _metadata: undefined | Record<string, unknown> = undefined
- runName: undefined | string = undefined
Returns Promise<CallbackManagerForRetrieverRun>
Implementation of CallbackHandlerMethods.handleRetrieverStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:970

handleToolStart

handleToolStart(
    tool: Serialized,
    input: string,
    runId?: string,
    _parentRunId?: undefined | string,
    _tags?: undefined | string[],
    _metadata?: undefined | Record<string, unknown>,
    runName?: undefined | string,
): Promise<CallbackManagerForToolRun>
Called at the start of a Tool run, with the tool name and input and the run ID.
Parameters
- tool: Serialized
- input: string
- runId: string = ...
- _parentRunId: undefined | string = undefined
- _tags: undefined | string[] = undefined
- _metadata: undefined | Record<string, unknown> = undefined
- runName: undefined | string = undefined
Returns Promise<CallbackManagerForToolRun>
Implementation of CallbackHandlerMethods.handleToolStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:905

removeHandler

removeHandler(handler: BaseCallbackHandler): void
Parameters
- handler: BaseCallbackHandler
Returns void
Overrides BaseCallbackManager.removeHandler
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:1081

removeMetadata

removeMetadata(metadata: Record<string, unknown>): void
Parameters
- metadata: Record<string, unknown>
Returns void
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:1118

removeTags

removeTags(tags: string[]): void
Parameters
- tags: string[]
Returns void
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:1104

setHandler

setHandler(handler: BaseCallbackHandler): void
Parameters
- handler: BaseCallbackHandler
Returns void
Inherited from BaseCallbackManager.setHandler
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:98

setHandlers

setHandlers(handlers: BaseCallbackHandler[], inherit?: boolean): void
Parameters
- handlers: BaseCallbackHandler[]
- inherit: boolean = true
Returns void
Overrides BaseCallbackManager.setHandlers
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:1088

`Static`_configureSync

_configureSync(
    inheritableHandlers?: Callbacks,
    localHandlers?: Callbacks,
    inheritableTags?: string[],
    localTags?: string[],
    inheritableMetadata?: Record<string, unknown>,
    localMetadata?: Record<string, unknown>,
    options?: CallbackManagerOptions,
): undefined | CallbackManager
Parameters
- OptionalinheritableHandlers: Callbacks
- OptionallocalHandlers: Callbacks
- OptionalinheritableTags: string[]
- OptionallocalTags: string[]
- OptionalinheritableMetadata: Record<string, unknown>
- OptionallocalMetadata: Record<string, unknown>
- Optionaloptions: CallbackManagerOptions
Returns undefined | CallbackManager
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:1192

`Static`configure

configure(
    inheritableHandlers?: Callbacks,
    localHandlers?: Callbacks,
    inheritableTags?: string[],
    localTags?: string[],
    inheritableMetadata?: Record<string, unknown>,
    localMetadata?: Record<string, unknown>,
    options?: CallbackManagerOptions,
): undefined | CallbackManager
Parameters
- OptionalinheritableHandlers: Callbacks
- OptionallocalHandlers: Callbacks
- OptionalinheritableTags: string[]
- OptionallocalTags: string[]
- OptionalinheritableMetadata: Record<string, unknown>
- OptionallocalMetadata: Record<string, unknown>
- Optionaloptions: CallbackManagerOptions
Returns undefined | CallbackManager
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:1171

`Static`fromHandlers

fromHandlers(handlers: BaseCallbackHandlerMethodsClass): CallbackManager
Parameters
- handlers: BaseCallbackHandlerMethodsClass
Returns CallbackManager
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/manager.ts:1156

Class CallbackManager

Example

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CallbackManager

Properties

Optional_parentRunId

handlers

inheritableHandlers

inheritableMetadata

inheritableTags

metadata

name

tags

Methods

addHandler

Parameters

Returns void

addMetadata

Parameters

Returns void

addTags

Parameters

Returns void

copy

Parameters

Returns CallbackManager

getParentRunId

Returns undefined | string

handleChainStart

Parameters

Returns Promise<CallbackManagerForChainRun>

handleChatModelStart

Parameters

Returns Promise<CallbackManagerForLLMRun[]>

OptionalhandleCustomEvent

Parameters

Returns Promise<any>

handleLLMStart

Parameters

Returns Promise<CallbackManagerForLLMRun[]>

handleRetrieverStart

Parameters

Returns Promise<CallbackManagerForRetrieverRun>

handleToolStart

Parameters

Returns Promise<CallbackManagerForToolRun>

removeHandler

Parameters

Returns void

removeMetadata

Parameters

Returns void

removeTags

Parameters

Returns void

setHandler

Parameters

Returns void

setHandlers

Parameters

Returns void

Static_configureSync

Parameters

Returns undefined | CallbackManager

Staticconfigure

Parameters

Returns undefined | CallbackManager

StaticfromHandlers

Parameters

Returns CallbackManager

Settings

On This Page

`Optional`_parentRunId

`Optional`handleCustomEvent

`Static`_configureSync

`Static`configure

`Static`fromHandlers