Class RunCollectorCallbackHandler

A callback handler that collects traced runs and makes it easy to fetch the traced run object from calls through any langchain object. For instance, it makes it easy to fetch the run ID and then do things with that, such as log feedback.

Hierarchy

Constructors

constructor

Properties

awaitHandlers ignoreAgent ignoreChain ignoreLLM ignoreRetriever name tracedRuns exampleId? runMap

Methods

copy handleAgentAction handleAgentEnd handleChainEnd handleChainError handleChainStart handleChatModelStart handleLLMEnd handleLLMError handleLLMNewToken handleLLMStart handleRetrieverEnd handleRetrieverError handleRetrieverStart handleText handleToolEnd handleToolError handleToolStart toJSON toJSONNotImplemented onAgentAction? onAgentEnd? onChainEnd? onChainError? onChainStart? onLLMEnd? onLLMError? onLLMNewToken? onLLMStart? onRetrieverEnd? onRetrieverError? onRetrieverStart? onRunCreate? onRunUpdate? onText? onToolEnd? onToolError? onToolStart? fromMethods persistRun

Constructors

constructor

  • Creates a new instance of the RunCollectorCallbackHandler class.

    Parameters

    • Optional exampleId: {
          exampleId?: string;
      }

      The ID of the example.

      • Optional exampleId?: string

    Returns RunCollectorCallbackHandler

Properties

awaitHandlers

awaitHandlers: boolean

ignoreAgent

ignoreAgent: boolean

ignoreChain

ignoreChain: boolean

ignoreLLM

ignoreLLM: boolean

ignoreRetriever

ignoreRetriever: boolean

name

name: string

The name of the callback handler.

tracedRuns

tracedRuns: Run[]

An array of traced runs.

Optional exampleId

exampleId?: string

The ID of the example.

Protected runMap

runMap: Map<string, Run>

Methods

copy

handleAgentAction

  • Called when an agent is about to execute an action, with the action and the run ID.

    Parameters

    Returns Promise<void>

handleAgentEnd

  • Called when an agent finishes execution, before it exits. with the final output and the run ID.

    Parameters

    Returns Promise<void>

handleChainEnd

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

handleChainError

  • Called if a Chain run encounters an error

    Parameters

    • error: Error
    • runId: string
    • Optional _parentRunId: string
    • Optional _tags: string[]
    • Optional kwargs: {
          inputs?: Record<string, unknown>;
      }
      • Optional inputs?: Record<string, unknown>

    Returns Promise<Run>

handleChainStart

  • 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
    • Optional runType: string
    • Optional name: string

    Returns Promise<Run>

handleChatModelStart

  • 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
    • Optional name: string

    Returns Promise<Run>

handleLLMEnd

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

    Parameters

    Returns Promise<Run>

handleLLMError

  • Called if an LLM/ChatModel run encounters an error

    Parameters

    • error: Error
    • runId: string

    Returns Promise<Run>

handleLLMNewToken

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

handleLLMStart

  • 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
    • Optional name: string

    Returns Promise<Run>

handleRetrieverEnd

  • Parameters

    • documents: Document<Record<string, unknown>>[]
    • runId: string

    Returns Promise<Run>

handleRetrieverError

  • Parameters

    • error: Error
    • runId: string

    Returns Promise<Run>

handleRetrieverStart

  • Parameters

    • retriever: Serialized
    • query: string
    • runId: string
    • Optional parentRunId: string
    • Optional tags: string[]
    • Optional metadata: KVMap
    • Optional name: string

    Returns Promise<Run>

handleText

  • Parameters

    • text: string
    • runId: string

    Returns Promise<void>

handleToolEnd

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

    Parameters

    • output: string
    • runId: string

    Returns Promise<Run>

handleToolError

  • Called if a Tool run encounters an error

    Parameters

    • error: Error
    • runId: string

    Returns Promise<Run>

handleToolStart

  • 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
    • Optional name: string

    Returns Promise<Run>

toJSON

toJSONNotImplemented

Optional onAgentAction

  • Parameters

    Returns void | Promise<void>

Optional onAgentEnd

  • Parameters

    Returns void | Promise<void>

Optional onChainEnd

  • Parameters

    Returns void | Promise<void>

Optional onChainError

  • Parameters

    Returns void | Promise<void>

Optional onChainStart

  • Parameters

    Returns void | Promise<void>

Optional onLLMEnd

  • Parameters

    Returns void | Promise<void>

Optional onLLMError

  • Parameters

    Returns void | Promise<void>

Optional onLLMNewToken

  • Parameters

    • run: Run
    • token: string

    Returns void | Promise<void>

Optional onLLMStart

  • Parameters

    Returns void | Promise<void>

Optional onRetrieverEnd

  • Parameters

    Returns void | Promise<void>

Optional onRetrieverError

  • Parameters

    Returns void | Promise<void>

Optional onRetrieverStart

  • Parameters

    Returns void | Promise<void>

Optional onRunCreate

  • Parameters

    Returns void | Promise<void>

Optional onRunUpdate

  • Parameters

    Returns void | Promise<void>

Optional onText

  • Parameters

    Returns void | Promise<void>

Optional onToolEnd

  • Parameters

    Returns void | Promise<void>

Optional onToolError

  • Parameters

    Returns void | Promise<void>

Optional onToolStart

  • Parameters

    Returns void | Promise<void>

Static fromMethods

  • 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", "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", "callbacks", string]
    • Readonly lc_secrets: undefined | {
          [key: string]: string;
      }
    • lc_serializable: boolean
    • name: string
    • copy:function
    • toJSON:function
    • toJSONNotImplemented:function
    • 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

Protected persistRun

  • Persists the given run object.

    Parameters

    • run: BaseRun

      The run object to persist.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc