Class LLMonitorHandler

Interface for the input parameters of the BaseCallbackHandler class. It allows to specify which types of events should be ignored by the callback handler.

Hierarchy

BaseCallbackHandler
- LLMonitorHandler

Implements

LLMonitorHandlerFields

Constructors

constructor

new LLMonitorHandler(fields?): LLMonitorHandler
Parameters
- fields: LLMonitorHandlerFields = {}
Returns LLMonitorHandler
Overrides BaseCallbackHandler.constructor
- Defined in docs/api_refs/langchain/src/callbacks/handlers/llmonitor.ts:165

Properties

awaitHandlers

awaitHandlers: boolean = ...

ignoreAgent

ignoreAgent: boolean = false

ignoreChain

ignoreChain: boolean = false

ignoreLLM

ignoreLLM: boolean = false

ignoreRetriever

ignoreRetriever: boolean = false

monitor

monitor: LLMonitor

name

name: string = "llmonitor_handler"

Methods

copy

copy(): BaseCallbackHandler
Returns BaseCallbackHandler
Inherited from BaseCallbackHandler.copy
- Defined in docs/api_refs/langchain/src/callbacks/base.ts:358

handleChainEnd

handleChainEnd(outputs, runId): Promise<void>
Called at the end of a Chain run, with the outputs and the run ID.
Parameters
- outputs: ChainValues
- runId: string
Returns Promise<void>
Overrides BaseCallbackHandler.handleChainEnd
- Defined in docs/api_refs/langchain/src/callbacks/handlers/llmonitor.ts:289

handleChainError

handleChainError(error, runId): Promise<void>
Called if a Chain run encounters an error
Parameters
- error: Error
- runId: string
Returns Promise<void>
Overrides BaseCallbackHandler.handleChainError
- Defined in docs/api_refs/langchain/src/callbacks/handlers/llmonitor.ts:296

handleChainStart

handleChainStart(chain, inputs, runId, parentRunId?, tags?, metadata?): Promise<void>
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
- Optional parentRunId: string
- Optional tags: string[]
- Optional metadata: KVMap
Returns Promise<void>
Overrides BaseCallbackHandler.handleChainStart
- Defined in docs/api_refs/langchain/src/callbacks/handlers/llmonitor.ts:257

handleChatModelStart

handleChatModelStart(llm, messages, runId, parentRunId?, extraParams?, tags?, metadata?): Promise<void>
Called at the start of a Chat Model run, with the prompt(s) and the run ID.
Parameters
- llm: Serialized
- messages: BaseMessage[][]
- runId: string
- Optional parentRunId: string
- Optional extraParams: KVMap
- Optional tags: string[]
- Optional metadata: KVMap
Returns Promise<void>
Overrides BaseCallbackHandler.handleChatModelStart
- Defined in docs/api_refs/langchain/src/callbacks/handlers/llmonitor.ts:209

handleLLMEnd

handleLLMEnd(output, runId): Promise<void>
Called at the end of an LLM/ChatModel run, with the output and the run ID.
Parameters
- output: LLMResult
- runId: string
Returns Promise<void>
Overrides BaseCallbackHandler.handleLLMEnd
- Defined in docs/api_refs/langchain/src/callbacks/handlers/llmonitor.ts:237

handleLLMError

handleLLMError(error, runId): Promise<void>
Called if an LLM/ChatModel run encounters an error
Parameters
- error: Error
- runId: string
Returns Promise<void>
Overrides BaseCallbackHandler.handleLLMError
- Defined in docs/api_refs/langchain/src/callbacks/handlers/llmonitor.ts:250

handleLLMStart

handleLLMStart(llm, prompts, runId, parentRunId?, extraParams?, tags?, metadata?): Promise<void>
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: string
- Optional parentRunId: string
- Optional extraParams: KVMap
- Optional tags: string[]
- Optional metadata: KVMap
Returns Promise<void>
Overrides BaseCallbackHandler.handleLLMStart
- Defined in docs/api_refs/langchain/src/callbacks/handlers/llmonitor.ts:181

handleToolEnd

handleToolEnd(output, runId): Promise<void>
Called at the end of a Tool run, with the tool output and the run ID.
Parameters
- output: string
- runId: string
Returns Promise<void>
Overrides BaseCallbackHandler.handleToolEnd
- Defined in docs/api_refs/langchain/src/callbacks/handlers/llmonitor.ts:327

handleToolError

handleToolError(error, runId): Promise<void>
Called if a Tool run encounters an error
Parameters
- error: Error
- runId: string
Returns Promise<void>
Overrides BaseCallbackHandler.handleToolError
- Defined in docs/api_refs/langchain/src/callbacks/handlers/llmonitor.ts:334

handleToolStart

handleToolStart(tool, input, runId, parentRunId?, tags?, metadata?): Promise<void>
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
- Optional parentRunId: string
- Optional tags: string[]
- Optional metadata: KVMap
Returns Promise<void>
Overrides BaseCallbackHandler.handleToolStart
- Defined in docs/api_refs/langchain/src/callbacks/handlers/llmonitor.ts:303

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from BaseCallbackHandler.toJSON
- Defined in docs/api_refs/langchain/src/callbacks/base.ts:364

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from BaseCallbackHandler.toJSONNotImplemented
- Defined in docs/api_refs/langchain/src/callbacks/base.ts:368

`Optional` handleAgentAction

handleAgentAction(action, runId, parentRunId?, tags?): void | Promise<void>
Called when an agent is about to execute an action, with the action and the run ID.
Parameters
- action: AgentAction
- runId: string
- Optional parentRunId: string
- Optional tags: string[]
Returns void | Promise<void>
Inherited from BaseCallbackHandler.handleAgentAction
- Defined in docs/api_refs/langchain/src/callbacks/base.ts:216

`Optional` handleAgentEnd

handleAgentEnd(action, runId, parentRunId?, tags?): void | Promise<void>
Called when an agent finishes execution, before it exits. with the final output and the run ID.
Parameters
- action: AgentFinish
- runId: string
- Optional parentRunId: string
- Optional tags: string[]
Returns void | Promise<void>
Inherited from BaseCallbackHandler.handleAgentEnd
- Defined in docs/api_refs/langchain/src/callbacks/base.ts:227

`Optional` handleLLMNewToken

handleLLMNewToken(token, idx, runId, parentRunId?, tags?, fields?): any
Called when an LLM/ChatModel in streaming mode produces a new token
Parameters
- token: string
- idx: NewTokenIndices
  
  idx.prompt is the index of the prompt that produced the token (if there are multiple prompts) idx.completion is the index of the completion that produced the token (if multiple completions per prompt are requested)
- runId: string
- Optional parentRunId: string
- Optional tags: string[]
- Optional fields: HandleLLMNewTokenCallbackFields
Returns any
Inherited from BaseCallbackHandler.handleLLMNewToken
- Defined in docs/api_refs/langchain/src/callbacks/base.ts:74

`Optional` handleRetrieverEnd

handleRetrieverEnd(documents, runId, parentRunId?, tags?): any
Parameters
- documents: Document<Record<string, any>>[]
- runId: string
- Optional parentRunId: string
- Optional tags: string[]
Returns any
Inherited from BaseCallbackHandler.handleRetrieverEnd
- Defined in docs/api_refs/langchain/src/callbacks/base.ts:245

`Optional` handleRetrieverError

handleRetrieverError(err, runId, parentRunId?, tags?): any
Parameters
- err: any
- runId: string
- Optional parentRunId: string
- Optional tags: string[]
Returns any
Inherited from BaseCallbackHandler.handleRetrieverError
- Defined in docs/api_refs/langchain/src/callbacks/base.ts:253

`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
Inherited from BaseCallbackHandler.handleRetrieverStart
- Defined in docs/api_refs/langchain/src/callbacks/base.ts:234

`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>
Inherited from BaseCallbackHandler.handleText
- Defined in docs/api_refs/langchain/src/callbacks/base.ts:205

`Static` fromMethods

fromMethods(methods): Handler
Parameters
- methods: BaseCallbackHandlerMethodsClass
Returns Handler
Inherited from BaseCallbackHandler.fromMethods
- Defined in docs/api_refs/langchain/src/callbacks/base.ts:372

Class LLMonitorHandler

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

fields: LLMonitorHandlerFields = {}

Returns LLMonitorHandler

Properties

awaitHandlers

ignoreAgent

ignoreChain

ignoreLLM

ignoreRetriever

monitor

name

Methods

copy

Returns BaseCallbackHandler

handleChainEnd

Parameters

outputs: ChainValues

runId: string

Returns Promise<void>

handleChainError

Parameters

error: Error

runId: string

Returns Promise<void>

handleChainStart

Parameters

chain: Serialized

inputs: ChainValues

runId: string

Optional parentRunId: string

Optional tags: string[]

Optional metadata: KVMap

Returns Promise<void>

handleChatModelStart

Parameters

llm: Serialized

messages: BaseMessage[][]

runId: string

Optional parentRunId: string

Optional extraParams: KVMap

Optional tags: string[]

Optional metadata: KVMap

Returns Promise<void>

handleLLMEnd

Parameters

output: LLMResult

runId: string

Returns Promise<void>

handleLLMError

Parameters

error: Error

runId: string

Returns Promise<void>

handleLLMStart

Parameters

llm: Serialized

prompts: string[]

runId: string

Optional parentRunId: string

Optional extraParams: KVMap

Optional tags: string[]

Optional metadata: KVMap

Returns Promise<void>

handleToolEnd

Parameters

output: string

runId: string

Returns Promise<void>

handleToolError

Parameters

error: Error

`Optional` parentRunId: string

`Optional` tags: string[]

`Optional` metadata: KVMap

`Optional` parentRunId: string

`Optional` extraParams: KVMap

`Optional` tags: string[]

`Optional` metadata: KVMap

`Optional` parentRunId: string

`Optional` extraParams: KVMap

`Optional` tags: string[]

`Optional` metadata: KVMap

`Optional` parentRunId: string

`Optional` tags: string[]

`Optional` metadata: KVMap

`Optional` handleAgentAction

`Optional` parentRunId: string

`Optional` tags: string[]

`Optional` handleAgentEnd

`Optional` parentRunId: string

`Optional` tags: string[]

`Optional` handleLLMNewToken

`Optional` parentRunId: string

`Optional` tags: string[]

`Optional` fields: HandleLLMNewTokenCallbackFields

`Optional` handleRetrieverEnd

`Optional` parentRunId: string

`Optional` tags: string[]

`Optional` handleRetrieverError

`Optional` parentRunId: string

`Optional` tags: string[]

`Optional` handleRetrieverStart

`Optional` parentRunId: string

`Optional` tags: string[]

`Optional` metadata: Record<string, unknown>

`Optional` name: string

`Optional` handleText

`Optional` parentRunId: string

`Optional` tags: string[]

`Static` fromMethods