Interface CallbackHandlerMethods interface CallbackHandlerMethods { handleAgentAction ? ( action : AgentAction ,
runId : string ,
parentRunId ?: string ,
tags ?: string [] ) : void | Promise < void > ; handleAgentEnd ? ( action : AgentFinish ,
runId : string ,
parentRunId ?: string ,
tags ?: string [] ) : void | Promise < void > ; handleChainEnd ? ( outputs : ChainValues ,
runId : string ,
parentRunId ?: string ,
tags ?: string [] ,
kwargs ?: { inputs ?: Record < string , unknown > ; } ) : any ; handleChainError ? ( err : any ,
runId : string ,
parentRunId ?: string ,
tags ?: string [] ,
kwargs ?: { inputs ?: Record < string , unknown > ; } ) : any ; handleChainStart ? ( chain : Serialized ,
inputs : ChainValues ,
runId : string ,
parentRunId ?: string ,
tags ?: string [] ,
metadata ?: Record < string , unknown > ,
runType ?: string ,
runName ?: string ) : any ; handleChatModelStart ? ( llm : Serialized ,
messages : BaseMessage [] [] ,
runId : string ,
parentRunId ?: string ,
extraParams ?: Record < string , unknown > ,
tags ?: string [] ,
metadata ?: Record < string , unknown > ,
runName ?: string ) : any ; handleCustomEvent ? ( eventName : string ,
data : any ,
runId : string ,
tags ?: string [] ,
metadata ?: Record < string , any > ) : any ; handleLLMEnd ? ( output : LLMResult ,
runId : string ,
parentRunId ?: string ,
tags ?: string [] ) : any ; handleLLMError ? ( err : any ,
runId : string ,
parentRunId ?: string ,
tags ?: string [] ) : any ; handleLLMNewToken ? ( token : string ,
idx : NewTokenIndices ,
runId : string ,
parentRunId ?: string ,
tags ?: string [] ,
fields ?: HandleLLMNewTokenCallbackFields ) : any ; handleLLMStart ? ( llm : Serialized ,
prompts : string [] ,
runId : string ,
parentRunId ?: string ,
extraParams ?: Record < string , unknown > ,
tags ?: string [] ,
metadata ?: Record < string , unknown > ,
runName ?: string ) : any ; handleRetrieverEnd ? ( documents : DocumentInterface < Record < string , any > > [] ,
runId : string ,
parentRunId ?: string ,
tags ?: string [] ) : any ; handleRetrieverError ? ( err : any ,
runId : string ,
parentRunId ?: string ,
tags ?: string [] ) : any ; handleRetrieverStart ? ( retriever : Serialized ,
query : string ,
runId : string ,
parentRunId ?: string ,
tags ?: string [] ,
metadata ?: Record < string , unknown > ,
name ?: string ) : any ; handleText ? ( text : string ,
runId : string ,
parentRunId ?: string ,
tags ?: string [] ) : void | Promise < void > ; handleToolEnd ? ( output : any ,
runId : string ,
parentRunId ?: string ,
tags ?: string [] ) : any ; handleToolError ? ( err : any ,
runId : string ,
parentRunId ?: string ,
tags ?: string [] ) : any ; handleToolStart ? ( tool : Serialized ,
input : string ,
runId : string ,
parentRunId ?: string ,
tags ?: string [] ,
metadata ?: Record < string , unknown > ,
runName ?: string ) : any ; } MethodsOptional
handleAgentAction handleAgentAction ( action , runId , parentRunId ? , tags ? ) : void | Promise < void > Parameters action : AgentAction runId : string Optional
parentRunId : string Optional
tags : string [] Returns void | Promise < void > Optional
handleAgentEnd handleAgentEnd ( action , runId , parentRunId ? , tags ? ) : void | Promise < void > Parameters action : AgentFinish runId : string Optional
parentRunId : string Optional
tags : string [] Returns void | Promise < void > Optional
handleChainEnd handleChainEnd ( outputs , runId , parentRunId ? , tags ? , kwargs ? ) : any Parameters outputs : ChainValues runId : string Optional
parentRunId : string Optional
tags : string [] Optional
kwargs : { inputs ?: Record < string , unknown > ; } Optional
inputs ?: Record < string , unknown > Returns any Optional
handleChainError handleChainError ( err , runId , parentRunId ? , tags ? , kwargs ? ) : any Parameters err : any runId : string Optional
parentRunId : string Optional
tags : string [] Optional
kwargs : { inputs ?: Record < string , unknown > ; } Optional
inputs ?: Record < string , unknown > Returns any Optional
handleChainStart handleChainStart ( chain , inputs , runId , parentRunId ? , tags ? , metadata ? , runType ? , runName ? ) : any Parameters chain : Serialized inputs : ChainValues runId : string Optional
parentRunId : string Optional
tags : string [] Optional
metadata : Record < string , unknown > Optional
runType : string Optional
runName : string Returns any Optional
handleChatModelStart handleChatModelStart ( llm , messages , runId , parentRunId ? , extraParams ? , tags ? , metadata ? , runName ? ) : any Parameters llm : Serialized messages : BaseMessage [] [] runId : string Optional
parentRunId : string Optional
extraParams : Record < string , unknown > Optional
tags : string [] Optional
metadata : Record < string , unknown > Optional
runName : string Returns any Optional
handleCustomEvent handleCustomEvent ( eventName , data , runId , tags ? , metadata ? ) : any Parameters eventName : string data : any runId : string Optional
tags : string [] Optional
metadata : Record < string , any > Returns any Optional
handleLLMEnd handleLLMEnd ( output , runId , parentRunId ? , tags ? ) : any Parameters output : LLMResult runId : string Optional
parentRunId : string Optional
tags : string [] Returns any Optional
handleLLMError handleLLMError ( err , runId , parentRunId ? , tags ? ) : any Parameters err : any runId : string Optional
parentRunId : string Optional
tags : string [] Returns any Optional
handleLLMNewToken handleLLMNewToken ( token , idx , runId , parentRunId ? , tags ? , fields ? ) : any Returns any Optional
handleLLMStart handleLLMStart ( llm , prompts , runId , parentRunId ? , extraParams ? , tags ? , metadata ? , runName ? ) : any Parameters llm : Serialized prompts : string [] runId : string Optional
parentRunId : string Optional
extraParams : Record < string , unknown > Optional
tags : string [] Optional
metadata : Record < string , unknown > Optional
runName : string Returns any Optional
handleRetrieverEnd handleRetrieverEnd ( documents , runId , parentRunId ? , tags ? ) : any Parameters documents : DocumentInterface < Record < string , any > > [] runId : string Optional
parentRunId : string Optional
tags : string [] Returns any Optional
handleRetrieverError handleRetrieverError ( err , runId , parentRunId ? , tags ? ) : any Parameters err : any runId : string Optional
parentRunId : string Optional
tags : string [] Returns any Optional
handleRetrieverStart handleRetrieverStart ( retriever , query , runId , parentRunId ? , tags ? , metadata ? , name ? ) : any Parameters retriever : Serialized query : string runId : string Optional
parentRunId : string Optional
tags : string [] Optional
metadata : Record < string , unknown > Optional
name : string Returns any Optional
handleText handleText ( text , runId , parentRunId ? , tags ? ) : void | Promise < void > Parameters text : string runId : string Optional
parentRunId : string Optional
tags : string [] Returns void | Promise < void > Optional
handleToolEnd handleToolEnd ( output , runId , parentRunId ? , tags ? ) : any Parameters output : any runId : string Optional
parentRunId : string Optional
tags : string [] Returns any Optional
handleToolError handleToolError ( err , runId , parentRunId ? , tags ? ) : any Parameters err : any runId : string Optional
parentRunId : string Optional
tags : string [] Returns any Optional
handleToolStart handleToolStart ( tool , input , runId , parentRunId ? , tags ? , metadata ? , runName ? ) : any Parameters tool : Serialized input : string runId : string Optional
parentRunId : string Optional
tags : string [] Optional
metadata : Record < string , unknown > Optional
runName : string Returns any
" "
Base interface for callbacks. All methods are optional. If a method is not implemented, it will be ignored. If a method is implemented, it will be called at the appropriate time. All methods are called with the run ID of the LLM/ChatModel/Chain that is running, which is generated by the CallbackManager.