Class CallbackManagerForLLMRun

Base class for run manager in LangChain.

Hierarchy (view full)

BaseRunManager
- CallbackManagerForLLMRun

Implements

BaseCallbackManagerMethods

Index

Constructors

Properties

handlers inheritableHandlers inheritableMetadata inheritableTags metadata runId tags

Accessors

Methods

handleCustomEvent handleLLMEnd handleLLMError handleLLMNewToken handleText

Constructors

constructor

new CallbackManagerForLLMRun(runId, handlers, inheritableHandlers, tags, inheritableTags, metadata, inheritableMetadata, _parentRunId?): 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 langchain-core/src/callbacks/manager.ts:107

Properties

`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 langchain-core/src/callbacks/manager.ts:118

Methods

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>
Implementation of BaseCallbackManagerMethods.handleCustomEvent
Inherited from BaseRunManager.handleCustomEvent
- Defined in langchain-core/src/callbacks/manager.ts:149

handleLLMEnd

handleLLMEnd(output, _runId?, _parentRunId?, _tags?, extraParams?): 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 BaseCallbackManagerMethods.handleLLMEnd
- Defined in langchain-core/src/callbacks/manager.ts:342

handleLLMError

handleLLMError(err, _runId?, _parentRunId?, _tags?, extraParams?): 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 BaseCallbackManagerMethods.handleLLMError
- Defined in langchain-core/src/callbacks/manager.ts:306

handleLLMNewToken

handleLLMNewToken(token, idx?, _runId?, _parentRunId?, _tags?, fields?): 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 BaseCallbackManagerMethods.handleLLMNewToken
- Defined in langchain-core/src/callbacks/manager.ts:268

handleText

handleText(text): Promise<void>
Parameters
- text: string
Returns Promise<void>
Implementation of BaseCallbackManagerMethods.handleText
Inherited from BaseRunManager.handleText
- Defined in langchain-core/src/callbacks/manager.ts:122