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
- Optional parentRunId: string
- Optional options: {
      handlers?: BaseCallbackHandler[];
      inheritableHandlers?: BaseCallbackHandler[];
      inheritableMetadata?: Record<string, unknown>;
      inheritableTags?: string[];
      metadata?: Record<string, unknown>;
      tags?: string[];
  }
  - Optional handlers?: BaseCallbackHandler[]
  - Optional inheritableHandlers?: BaseCallbackHandler[]
  - Optional inheritableMetadata?: Record<string, unknown>
  - Optional inheritableTags?: string[]
  - Optional metadata?: Record<string, unknown>
  - Optional tags?: string[]
Returns CallbackManager
Overrides BaseCallbackManager.constructor
- Defined in langchain-core/src/callbacks/manager.ts:514

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

addMetadata

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

addTags

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

copy

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

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

handleChainStart

handleChainStart(chain, inputs, runId?, runType?, _tags?, _metadata?, runName?): Promise<CallbackManagerForChainRun>
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:666

handleChatModelStart

handleChatModelStart(llm, messages, _runId?, _parentRunId?, extraParams?, _tags?, _metadata?, runName?): Promise<CallbackManagerForLLMRun[]>
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:599

handleLLMStart

handleLLMStart(llm, prompts, _runId?, _parentRunId?, extraParams?, _tags?, _metadata?, runName?): Promise<CallbackManagerForLLMRun[]>
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:546

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

handleToolStart

handleToolStart(tool, input, runId?, _parentRunId?, _tags?, _metadata?, runName?): Promise<CallbackManagerForToolRun>
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:711

removeHandler

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

removeMetadata

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

removeTags

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

setHandler

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

setHandlers

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

`Static` configure

configure(inheritableHandlers?, localHandlers?, inheritableTags?, localTags?, inheritableMetadata?, localMetadata?, options?): Promise<undefined | CallbackManager>
Parameters
- Optional inheritableHandlers: CallbackManager | (BaseCallbackHandlerMethodsClass | BaseCallbackHandler)[]
- Optional localHandlers: CallbackManager | (BaseCallbackHandlerMethodsClass | BaseCallbackHandler)[]
- Optional inheritableTags: string[]
- Optional localTags: string[]
- Optional inheritableMetadata: Record<string, unknown>
- Optional localMetadata: Record<string, unknown>
- Optional options: CallbackManagerOptions
Returns Promise<undefined | CallbackManager>
- Defined in langchain-core/src/callbacks/manager.ts:896

`Static` fromHandlers

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

Class CallbackManager

Example

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional parentRunId: string

Optional options: { handlers?: BaseCallbackHandler[]; inheritableHandlers?: BaseCallbackHandler[]; inheritableMetadata?: Record<string, unknown>; inheritableTags?: string[]; metadata?: Record<string, unknown>; tags?: string[]; }

Optional handlers?: BaseCallbackHandler[]

Optional inheritableHandlers?: BaseCallbackHandler[]

Optional inheritableMetadata?: Record<string, unknown>

Optional inheritableTags?: string[]

Optional metadata?: Record<string, unknown>

Optional tags?: string[]

Returns CallbackManager

Properties

handlers

inheritableHandlers

inheritableMetadata

inheritableTags

metadata

name

tags

Methods

addHandler

Parameters

handler: BaseCallbackHandler

inherit: boolean = true

Returns void

addMetadata

Parameters

metadata: Record<string, unknown>

inherit: boolean = true

Returns void

addTags

Parameters

tags: string[]

inherit: boolean = true

Returns void

copy

Parameters

additionalHandlers: BaseCallbackHandler[] = []

inherit: boolean = true

Returns CallbackManager

getParentRunId

Returns undefined | string

handleChainStart

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>

handleChatModelStart

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

handleLLMStart

Parameters

llm: Serialized

prompts: string[]

_runId: undefined | string = undefined

_parentRunId: undefined | string = undefined

extraParams: undefined | Record<string, unknown> = undefined

_tags: undefined | string[] = undefined

`Optional` parentRunId: string

`Optional` options: {
handlers?: BaseCallbackHandler[];
inheritableHandlers?: BaseCallbackHandler[];
inheritableMetadata?: Record<string, unknown>;
inheritableTags?: string[];
metadata?: Record<string, unknown>;
tags?: string[];
}

`Optional` handlers?: BaseCallbackHandler[]

`Optional` inheritableHandlers?: BaseCallbackHandler[]

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

`Optional` inheritableTags?: string[]

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

`Optional` tags?: string[]

`Static` configure

`Optional` inheritableHandlers: CallbackManager | (BaseCallbackHandlerMethodsClass | BaseCallbackHandler)[]

`Optional` localHandlers: CallbackManager | (BaseCallbackHandlerMethodsClass | BaseCallbackHandler)[]

`Optional` inheritableTags: string[]

`Optional` localTags: string[]

`Optional` inheritableMetadata: Record<string, unknown>

`Optional` localMetadata: Record<string, unknown>

`Optional` options: CallbackManagerOptions

`Static` fromHandlers