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

Constructors

Properties

awaitHandlers: boolean = ...
ignoreAgent: boolean = false
ignoreChain: boolean = false
ignoreLLM: boolean = false
ignoreRetriever: boolean = false
name: string
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[]
    • Optional kwargs: {
          inputs?: Record<string, unknown>;
      }
      • Optional inputs?: 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[]
    • Optional kwargs: {
          inputs?: Record<string, unknown>;
      }
      • Optional inputs?: Record<string, unknown>

    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

    • run: Run
    • token: string
    • Optional kwargs: {
          chunk: any;
      }
      • chunk: any

    Returns void | Promise<void>

Generated using TypeDoc