Class CallbackManagerForLLMRun

Base class for run manager in LangChain.

Hierarchy (View Summary)

BaseRunManager
- CallbackManagerForLLMRun

Implements

BaseCallbackManagerMethods

Index

Constructors

constructor

new CallbackManagerForLLMRun(
    runId: string,
    handlers: BaseCallbackHandler[],
    inheritableHandlers: BaseCallbackHandler[],
    tags: string[],
    inheritableTags: string[],
    metadata: Record<string, unknown>,
    inheritableMetadata: Record<string, unknown>,
    _parentRunId?: string,
): CallbackManagerForLLMRun
Parameters
- runId: string
- handlers: BaseCallbackHandler[]
- inheritableHandlers: BaseCallbackHandler[]
- tags: string[]
- inheritableTags: string[]
- metadata: Record<string, unknown>
- inheritableMetadata: Record<string, unknown>
- Optional_parentRunId: string
Returns CallbackManagerForLLMRun
Inherited from BaseRunManager.constructor
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/callbacks/manager.ts:104

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

Methods

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

handleLLMEnd

handleLLMEnd(
    output: LLMResult,
    _runId?: string,
    _parentRunId?: string,
    _tags?: string[],
    extraParams?: Record<string, unknown>,
): Promise<void>
Called at the end of an LLM/ChatModel run, with the output and the run ID.
Parameters
- output: LLMResult
- Optional_runId: string
- Optional_parentRunId: string
- Optional_tags: string[]
- OptionalextraParams: Record<string, unknown>
Returns Promise<void>
Implementation of CallbackHandlerMethods.handleLLMEnd
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/callbacks/manager.ts:339

handleLLMError

handleLLMError(
    err: unknown,
    _runId?: string,
    _parentRunId?: string,
    _tags?: string[],
    extraParams?: Record<string, unknown>,
): Promise<void>
Called if an LLM/ChatModel run encounters an error
Parameters
- err: unknown
- Optional_runId: string
- Optional_parentRunId: string
- Optional_tags: string[]
- OptionalextraParams: Record<string, unknown>
Returns Promise<void>
Implementation of CallbackHandlerMethods.handleLLMError
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/callbacks/manager.ts:303

handleLLMNewToken

handleLLMNewToken(
    token: string,
    idx?: NewTokenIndices,
    _runId?: string,
    _parentRunId?: string,
    _tags?: string[],
    fields?: HandleLLMNewTokenCallbackFields,
): Promise<void>
Called when an LLM/ChatModel in streaming mode produces a new token
Parameters
- token: string
- Optionalidx: NewTokenIndices
- Optional_runId: string
- Optional_parentRunId: string
- Optional_tags: string[]
- Optionalfields: HandleLLMNewTokenCallbackFields
Returns Promise<void>
Implementation of CallbackHandlerMethods.handleLLMNewToken
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-core/src/callbacks/manager.ts:265

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

Class CallbackManagerForLLMRun

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CallbackManagerForLLMRun

Properties

Protected Optional Readonly_parentRunId

Readonlyhandlers

Protected ReadonlyinheritableHandlers

Protected ReadonlyinheritableMetadata

Protected ReadonlyinheritableTags

Protected Readonlymetadata

ReadonlyrunId

Protected Readonlytags

Accessors

parentRunId

Returns undefined | string

Methods

handleCustomEvent

Parameters

Returns Promise<void>

handleLLMEnd

Parameters

Returns Promise<void>

handleLLMError

Parameters

Returns Promise<void>

handleLLMNewToken

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