Class LangChainTracerV1

Abstract base class for creating callback handlers in the LangChain framework. It provides a set of optional methods that can be overridden in derived classes to handle various events during the execution of a LangChain application.

Hierarchy

Constructors

Properties

awaitHandlers: boolean = ...
ignoreAgent: boolean = false
ignoreChain: boolean = false
ignoreLLM: boolean = false
ignoreRetriever: boolean = false
name: string = "langchain_tracer"
endpoint: string = ...
headers: Record<string, string> = ...
runMap: Map<string, Run> = ...
session: TracerSessionV1

Methods

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

    Parameters

    Returns Promise<void>

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

    Parameters

    Returns Promise<void>

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

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

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

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

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

    Parameters

    Returns Promise<Run>

  • Called if an LLM/ChatModel run encounters an error

    Parameters

    • error: Error
    • runId: string

    Returns Promise<Run>

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

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

  • Parameters

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

    Returns Promise<Run>

  • Parameters

    • error: Error
    • runId: string

    Returns Promise<Run>

  • Parameters

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

    Returns Promise<Run>

  • Parameters

    • text: string
    • runId: string

    Returns 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<Run>

  • Called if a Tool run encounters an error

    Parameters

    • error: Error
    • runId: 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
    • Optional parentRunId: string
    • Optional tags: string[]
    • Optional metadata: KVMap
    • Optional name: string

    Returns Promise<Run>

  • Returns Promise<TracerSessionV1>

  • Parameters

    • sessionName: string

    Returns Promise<TracerSessionV1>

  • Parameters

    • Optional sessionName: string

    Returns Promise<TracerSessionV1>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    • run: Run
    • token: string

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    Returns void | Promise<void>

  • Parameters

    • methods: BaseCallbackHandlerMethodsClass

    Returns Handler

  • Parameters

    Returns Promise<LLMRun | ChainRun | ToolRun>

  • Parameters

    • run: Run | LLMRun | ChainRun | ToolRun

    Returns Promise<void>

  • Parameters

    • sessionCreate: BaseTracerSession

    Returns Promise<TracerSessionV1>

Generated using TypeDoc