Class LLMonitorHandler

awaitHandlers

ignoreAgent

ignoreChain

ignoreLLM

ignoreRetriever

lc_kwargs

lc_serializable

lc_aliases

• get lc_aliases(): undefined | {
      [key: string]: string;
  }

• A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

  Returns undefined | {
      [key: string]: string;
  }

lc_attributes

• get lc_attributes(): undefined | {
      [key: string]: string;
  }

• A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

  Returns undefined | {
      [key: string]: string;
  }

lc_id

• get lc_id(): string[]

• The final serialized identifier for the module.

  Returns string[]

lc_namespace

• get lc_namespace(): ["langchain", "callbacks", string]

• A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

  Returns ["langchain", "callbacks", string]

lc_secrets

• get lc_secrets(): undefined | {
      [key: string]: string;
  }

• A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

  Returns undefined | {
      [key: string]: string;
  }

copy

• copy(): BaseCallbackHandler

• Returns BaseCallbackHandler

toJSON

• toJSON(): Serialized

• Returns Serialized

toJSONNotImplemented

• toJSONNotImplemented(): SerializedNotImplemented

• Returns SerializedNotImplemented

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>

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>

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

Optional handleRetrieverEnd

• handleRetrieverEnd(documents, runId, parentRunId?, tags?): any

• Parameters

  • documents: Document<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>

Static fromMethods

• fromMethods(methods): Handler

• Parameters

  • methods: BaseCallbackHandlerMethodsClass

  Returns Handler

Static lc_name

• lc_name(): string

• The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

  Implemented as a static method to support loading logic.

  Returns string