Class LLMonitorHandler

awaitHandlers

ignoreAgent

ignoreChain

ignoreLLM

ignoreRetriever

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): {
      awaitHandlers: boolean;
      ignoreAgent: boolean;
      ignoreChain: boolean;
      ignoreLLM: boolean;
      ignoreRetriever: boolean;
      lc_aliases: undefined | {
          [key: string]: string;
      };
      lc_attributes: undefined | {
          [key: string]: string;
      };
      lc_id: string[];
      lc_kwargs: SerializedFields;
      lc_namespace: ["langchain_core", "callbacks", string];
      lc_secrets: undefined | {
          [key: string]: string;
      };
      lc_serializable: boolean;
      name: string;
      copy() => BaseCallbackHandler;
      toJSON() => Serialized;
      toJSONNotImplemented() => SerializedNotImplemented;
      handleAgentAction?(action, runId, parentRunId?, tags?) => void | Promise<void>;
      handleAgentEnd?(action, runId, parentRunId?, tags?) => void | Promise<void>;
      handleChainEnd?(outputs, runId, parentRunId?, tags?, kwargs?) => any;
      handleChainError?(err, runId, parentRunId?, tags?, kwargs?) => any;
      handleChainStart?(chain, inputs, runId, parentRunId?, tags?, metadata?, runType?, name?) => any;
      handleChatModelStart?(llm, messages, runId, parentRunId?, extraParams?, tags?, metadata?, name?) => any;
      handleLLMEnd?(output, runId, parentRunId?, tags?) => any;
      handleLLMError?(err, runId, parentRunId?, tags?) => any;
      handleLLMNewToken?(token, idx, runId, parentRunId?, tags?, fields?) => any;
      handleLLMStart?(llm, prompts, runId, parentRunId?, extraParams?, tags?, metadata?, name?) => any;
      handleRetrieverEnd?(documents, runId, parentRunId?, tags?) => any;
      handleRetrieverError?(err, runId, parentRunId?, tags?) => any;
      handleRetrieverStart?(retriever, query, runId, parentRunId?, tags?, metadata?, name?) => any;
      handleText?(text, runId, parentRunId?, tags?) => void | Promise<void>;
      handleToolEnd?(output, runId, parentRunId?, tags?) => any;
      handleToolError?(err, runId, parentRunId?, tags?) => any;
      handleToolStart?(tool, input, runId, parentRunId?, tags?, metadata?, name?) => any;
  }

• Parameters

  • methods: BaseCallbackHandlerMethodsClass

  Returns {
      awaitHandlers: boolean;
      ignoreAgent: boolean;
      ignoreChain: boolean;
      ignoreLLM: boolean;
      ignoreRetriever: boolean;
      lc_aliases: undefined | {
          [key: string]: string;
      };
      lc_attributes: undefined | {
          [key: string]: string;
      };
      lc_id: string[];
      lc_kwargs: SerializedFields;
      lc_namespace: ["langchain_core", "callbacks", string];
      lc_secrets: undefined | {
          [key: string]: string;
      };
      lc_serializable: boolean;
      name: string;
      copy() => BaseCallbackHandler;
      toJSON() => Serialized;
      toJSONNotImplemented() => SerializedNotImplemented;
      handleAgentAction?(action, runId, parentRunId?, tags?) => void | Promise<void>;
      handleAgentEnd?(action, runId, parentRunId?, tags?) => void | Promise<void>;
      handleChainEnd?(outputs, runId, parentRunId?, tags?, kwargs?) => any;
      handleChainError?(err, runId, parentRunId?, tags?, kwargs?) => any;
      handleChainStart?(chain, inputs, runId, parentRunId?, tags?, metadata?, runType?, name?) => any;
      handleChatModelStart?(llm, messages, runId, parentRunId?, extraParams?, tags?, metadata?, name?) => any;
      handleLLMEnd?(output, runId, parentRunId?, tags?) => any;
      handleLLMError?(err, runId, parentRunId?, tags?) => any;
      handleLLMNewToken?(token, idx, runId, parentRunId?, tags?, fields?) => any;
      handleLLMStart?(llm, prompts, runId, parentRunId?, extraParams?, tags?, metadata?, name?) => any;
      handleRetrieverEnd?(documents, runId, parentRunId?, tags?) => any;
      handleRetrieverError?(err, runId, parentRunId?, tags?) => any;
      handleRetrieverStart?(retriever, query, runId, parentRunId?, tags?, metadata?, name?) => any;
      handleText?(text, runId, parentRunId?, tags?) => void | Promise<void>;
      handleToolEnd?(output, runId, parentRunId?, tags?) => any;
      handleToolError?(err, runId, parentRunId?, tags?) => any;
      handleToolStart?(tool, input, runId, parentRunId?, tags?, metadata?, name?) => any;
  }

  • awaitHandlers: boolean

  • ignoreAgent: boolean

  • ignoreChain: boolean

  • ignoreLLM: boolean

  • ignoreRetriever: boolean

  • Readonly lc_aliases: undefined | {
        [key: string]: string;
    }

  • Readonly lc_attributes: undefined | {
        [key: string]: string;
    }

  • Readonly lc_id: string[]

    The final serialized identifier for the module.

  • lc_kwargs: SerializedFields

  • Readonly lc_namespace: ["langchain_core", "callbacks", string]

  • Readonly lc_secrets: undefined | {
        [key: string]: string;
    }

  • lc_serializable: boolean

  • name: string

  • copy:function

    • copy(): BaseCallbackHandler

    • Returns BaseCallbackHandler

  • toJSON:function

    • toJSON(): Serialized

    • Returns Serialized

  • toJSONNotImplemented:function

    • toJSONNotImplemented(): SerializedNotImplemented

    • Returns SerializedNotImplemented

  • handleAgentAction?:function

    • 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>

  • handleAgentEnd?:function

    • 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>

  • handleChainEnd?:function

    • handleChainEnd(outputs, runId, parentRunId?, tags?, kwargs?): any

    • Called at the end of a Chain run, with the outputs and the run ID.

      Parameters

      • outputs: ChainValues

      • runId: string

      • Optional parentRunId: string

      • Optional tags: string[]

      • Optional kwargs: {
            inputs?: Record<string, unknown>;
        }

        • Optional inputs?: Record<string, unknown>

      Returns any

  • handleChainError?:function

    • handleChainError(err, runId, parentRunId?, tags?, kwargs?): any

    • Called if a Chain run encounters an error

      Parameters

      • err: any

      • runId: string

      • Optional parentRunId: string

      • Optional tags: string[]

      • Optional kwargs: {
            inputs?: Record<string, unknown>;
        }

        • Optional inputs?: Record<string, unknown>

      Returns any

  • handleChainStart?:function

    • handleChainStart(chain, inputs, runId, parentRunId?, tags?, metadata?, runType?, name?): any

    • 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: Record<string, unknown>

      • Optional runType: string

      • Optional name: string

      Returns any

  • handleChatModelStart?:function

    • handleChatModelStart(llm, messages, runId, parentRunId?, extraParams?, tags?, metadata?, name?): any

    • 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: Record<string, unknown>

      • Optional tags: string[]

      • Optional metadata: Record<string, unknown>

      • Optional name: string

      Returns any

  • handleLLMEnd?:function

    • handleLLMEnd(output, runId, parentRunId?, tags?): any

    • Called at the end of an LLM/ChatModel run, with the output and the run ID.

      Parameters

      • output: LLMResult

      • runId: string

      • Optional parentRunId: string

      • Optional tags: string[]

      Returns any

  • handleLLMError?:function

    • handleLLMError(err, runId, parentRunId?, tags?): any

    • Called if an LLM/ChatModel run encounters an error

      Parameters

      • err: any

      • runId: string

      • Optional parentRunId: string

      • Optional tags: string[]

      Returns any

  • handleLLMNewToken?:function

    • 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

      • runId: string

      • Optional parentRunId: string

      • Optional tags: string[]

      • Optional fields: HandleLLMNewTokenCallbackFields

      Returns any

  • handleLLMStart?:function

    • handleLLMStart(llm, prompts, runId, parentRunId?, extraParams?, tags?, metadata?, name?): any

    • 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: Record<string, unknown>

      • Optional tags: string[]

      • Optional metadata: Record<string, unknown>

      • Optional name: string

      Returns any

  • handleRetrieverEnd?:function

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

    • Parameters

      • documents: Document<Record<string, any>>[]

      • runId: string

      • Optional parentRunId: string

      • Optional tags: string[]

      Returns any

  • handleRetrieverError?:function

    • handleRetrieverError(err, runId, parentRunId?, tags?): any

    • Parameters

      • err: any

      • runId: string

      • Optional parentRunId: string

      • Optional tags: string[]

      Returns any

  • handleRetrieverStart?:function

    • 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

  • handleText?:function

    • handleText(text, runId, parentRunId?, tags?): void | Promise<void>

    • Parameters

      • text: string

      • runId: string

      • Optional parentRunId: string

      • Optional tags: string[]

      Returns void | Promise<void>

  • handleToolEnd?:function

    • handleToolEnd(output, runId, parentRunId?, tags?): any

    • Called at the end of a Tool run, with the tool output and the run ID.

      Parameters

      • output: string

      • runId: string

      • Optional parentRunId: string

      • Optional tags: string[]

      Returns any

  • handleToolError?:function

    • handleToolError(err, runId, parentRunId?, tags?): any

    • Called if a Tool run encounters an error

      Parameters

      • err: any

      • runId: string

      • Optional parentRunId: string

      • Optional tags: string[]

      Returns any

  • handleToolStart?:function

    • handleToolStart(tool, input, runId, parentRunId?, tags?, metadata?, name?): any

    • 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: Record<string, unknown>

      • Optional name: string

      Returns any