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 (view full)

Constructors

Properties

awaitHandlers: boolean = ...
ignoreAgent: boolean = false
ignoreChain: boolean = false
ignoreCustomEvent: boolean = false
ignoreLLM: boolean = false
ignoreRetriever: boolean = false
name: string = "run_collector"

The name of the callback handler.

raiseError: boolean = false
tracedRuns: Run[]

An array of traced runs.

exampleId?: string

The ID of the example.

runMap: Map<string, Run> = ...

Methods

  • 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[]
    • Optionalkwargs: {
          inputs?: Record<string, unknown>;
      }
      • Optionalinputs?: Record<string, unknown>

    Returns Promise<Run>

  • Called if a Chain run encounters an error

    Parameters

    • error: unknown
    • runId: string
    • Optional_parentRunId: string
    • Optional_tags: string[]
    • Optionalkwargs: {
          inputs?: Record<string, unknown>;
      }
      • Optionalinputs?: Record<string, unknown>

    Returns Promise<Run>

  • 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
    • OptionalparentRunId: string
    • Optionaltags: string[]
    • Optionalmetadata: KVMap
    • OptionalrunType: string
    • Optionalname: string

    Returns Promise<Run>

  • Called at the start of a Chat Model run, with the prompt(s) and the run ID.

    Parameters

    • llm: Serialized
    • messages: BaseMessage[][]
    • runId: string
    • OptionalparentRunId: string
    • OptionalextraParams: KVMap
    • Optionaltags: string[]
    • Optionalmetadata: KVMap
    • Optionalname: string

    Returns Promise<Run>

  • 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
    • OptionalparentRunId: string
    • OptionalextraParams: KVMap
    • Optionaltags: string[]
    • Optionalmetadata: KVMap
    • Optionalname: string

    Returns Promise<Run>

  • 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
    • OptionalparentRunId: string
    • Optionaltags: string[]
    • Optionalmetadata: KVMap
    • Optionalname: string

    Returns Promise<Run>