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({ 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 full)

BaseCallbackManager
- CallbackManager

Implements

BaseCallbackManagerMethods

Constructors

constructor

new CallbackManager(parentRunId?, options?): CallbackManager
Parameters
- OptionalparentRunId: string
- Optionaloptions: {
      handlers?: BaseCallbackHandler[];
      inheritableHandlers?: BaseCallbackHandler[];
      inheritableMetadata?: Record<string, unknown>;
      inheritableTags?: string[];
      metadata?: Record<string, unknown>;
      tags?: string[];
  }
  - Optionalhandlers?: BaseCallbackHandler[]
  - OptionalinheritableHandlers?: BaseCallbackHandler[]
  - OptionalinheritableMetadata?: Record<string, unknown>
  - OptionalinheritableTags?: string[]
  - Optionalmetadata?: Record<string, unknown>
  - Optionaltags?: string[]
Returns CallbackManager
Overrides BaseCallbackManager.constructor
- Defined in langchain-core/src/callbacks/manager.ts:563

Properties

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, inherit?): void
Parameters
- handler: BaseCallbackHandler
- inherit: boolean = true
Returns void
Overrides BaseCallbackManager.addHandler
- Defined in langchain-core/src/callbacks/manager.ts:979

addMetadata

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

addTags

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

copy

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

getParentRunId

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

Returns undefined | string
The parent run ID.
- Defined in langchain-core/src/callbacks/manager.ts:591

handleChainStart

handleChainStart(chain, inputs, runId?, runType?, _tags?, _metadata?, runName?): 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 BaseCallbackManagerMethods.handleChainStart
- Defined in langchain-core/src/callbacks/manager.ts:755

handleChatModelStart

handleChatModelStart(llm, messages, runId?, _parentRunId?, extraParams?, _tags?, _metadata?, runName?): Promise<CallbackManagerForLLMRun[]>
Called at the start of a Chat Model run, with the prompt(s) and the run ID.
Parameters
- llm: Serialized
- messages: BaseMessage[][]
- 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 BaseCallbackManagerMethods.handleChatModelStart
- Defined in langchain-core/src/callbacks/manager.ts:668

handleLLMStart

handleLLMStart(llm, prompts, runId?, _parentRunId?, extraParams?, _tags?, _metadata?, runName?): 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 BaseCallbackManagerMethods.handleLLMStart
- Defined in langchain-core/src/callbacks/manager.ts:595

handleRetrieverStart

handleRetrieverStart(retriever, query, runId?, _parentRunId?, _tags?, _metadata?, runName?): 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 BaseCallbackManagerMethods.handleRetrieverStart
- Defined in langchain-core/src/callbacks/manager.ts:881

handleToolStart

handleToolStart(tool, input, runId?, _parentRunId?, _tags?, _metadata?, runName?): 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 BaseCallbackManagerMethods.handleToolStart
- Defined in langchain-core/src/callbacks/manager.ts:819

removeHandler

removeHandler(handler): void
Parameters
- handler: BaseCallbackHandler
Returns void
Overrides BaseCallbackManager.removeHandler
- Defined in langchain-core/src/callbacks/manager.ts:986

removeMetadata

removeMetadata(metadata): void
Parameters
- metadata: Record<string, unknown>
Returns void
- Defined in langchain-core/src/callbacks/manager.ts:1023

removeTags

removeTags(tags): void
Parameters
- tags: string[]
Returns void
- Defined in langchain-core/src/callbacks/manager.ts:1009

setHandler

setHandler(handler): void
Parameters
- handler: BaseCallbackHandler
Returns void
Inherited from BaseCallbackManager.setHandler
- Defined in langchain-core/src/callbacks/manager.ts:107

setHandlers

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

`Optional`handleCustomEvent

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

`Static`configure

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

`Static`fromHandlers

fromHandlers(handlers): CallbackManager
Parameters
- handlers: BaseCallbackHandlerMethodsClass
Returns CallbackManager
- Defined in langchain-core/src/callbacks/manager.ts:1061

Class CallbackManager

Example

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optionalhandlers?: BaseCallbackHandler[]

OptionalinheritableHandlers?: BaseCallbackHandler[]

OptionalinheritableMetadata?: Record<string, unknown>

OptionalinheritableTags?: string[]

Optionalmetadata?: Record<string, unknown>

Optionaltags?: string[]

Returns CallbackManager

Properties

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[]>

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

OptionalhandleCustomEvent

Parameters

Returns Promise<any>

Staticconfigure

Parameters

Returns Promise<undefined | CallbackManager>

StaticfromHandlers

Parameters

Returns CallbackManager

`Optional`handlers?: BaseCallbackHandler[]

`Optional`inheritableHandlers?: BaseCallbackHandler[]

`Optional`inheritableMetadata?: Record<string, unknown>

`Optional`inheritableTags?: string[]

`Optional`metadata?: Record<string, unknown>

`Optional`tags?: string[]

`Optional`handleCustomEvent

`Static`configure

`Static`fromHandlers