Class FakeTracer

awaitHandlers

ignoreAgent

ignoreChain

ignoreCustomEvent

ignoreLLM

ignoreRetriever

raiseError

copy

• copy(): this

• Returns this

handleAgentAction

• handleAgentAction(action, runId): Promise<void>

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

  Parameters

  • action: AgentAction
  • runId: string

  Returns Promise<void>

handleAgentEnd

• handleAgentEnd(action, runId): Promise<void>

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

  Parameters

  • action: AgentFinish
  • runId: string

  Returns Promise<void>

handleChainEnd

• handleChainEnd(outputs, runId, _parentRunId?, _tags?, kwargs?): Promise<Run>

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

handleChainError

• handleChainError(error, runId, _parentRunId?, _tags?, kwargs?): 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>

handleChainStart

• handleChainStart(chain, inputs, runId, parentRunId?, tags?, metadata?, runType?, name?): 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>

handleChatModelStart

• handleChatModelStart(llm, messages, runId, parentRunId?, extraParams?, tags?, metadata?, name?): 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>

OptionalhandleCustomEvent

• handleCustomEvent(eventName, data, runId, tags?, metadata?): any

• Parameters

  • eventName: string
  • data: any
  • runId: string
  • Optionaltags: string[]
  • Optionalmetadata: Record<string, any>

  Returns any

handleLLMEnd

• handleLLMEnd(output, runId): Promise<Run>

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

  Parameters

  • output: LLMResult
  • runId: string

  Returns Promise<Run>

handleLLMError

• handleLLMError(error, runId): Promise<Run>

• Called if an LLM/ChatModel run encounters an error

  Parameters

  • error: unknown
  • runId: string

  Returns Promise<Run>

handleLLMNewToken

• handleLLMNewToken(token, idx, runId, _parentRunId?, _tags?, fields?): Promise<Run>

• 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[]
  • Optionalfields: HandleLLMNewTokenCallbackFields

  Returns Promise<Run>

handleLLMStart

• handleLLMStart(llm, prompts, runId, parentRunId?, extraParams?, tags?, metadata?, name?): 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>

handleRetrieverEnd

• handleRetrieverEnd(documents, runId): Promise<Run>

• Parameters

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

  Returns Promise<Run>

handleRetrieverError

• handleRetrieverError(error, runId): Promise<Run>

• Parameters

  • error: unknown
  • runId: string

  Returns Promise<Run>

handleRetrieverStart

• handleRetrieverStart(retriever, query, runId, parentRunId?, tags?, metadata?, name?): Promise<Run>

• Parameters

  • retriever: Serialized
  • query: string
  • runId: string
  • OptionalparentRunId: string
  • Optionaltags: string[]
  • Optionalmetadata: KVMap
  • Optionalname: string

  Returns Promise<Run>

handleText

• handleText(text, runId): Promise<void>

• Parameters

  • text: string
  • runId: string

  Returns Promise<void>

handleToolEnd

• handleToolEnd(output, runId): Promise<Run>

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

  Parameters

  • output: any
  • runId: string

  Returns Promise<Run>

handleToolError

• handleToolError(error, runId): Promise<Run>

• Called if a Tool run encounters an error

  Parameters

  • error: unknown
  • runId: string

  Returns Promise<Run>

handleToolStart

• handleToolStart(tool, input, runId, parentRunId?, tags?, metadata?, name?): 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>

OptionalonAgentAction

• onAgentAction(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonAgentEnd

• onAgentEnd(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonChainEnd

• onChainEnd(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonChainError

• onChainError(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonChainStart

• onChainStart(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonLLMEnd

• onLLMEnd(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonLLMError

• onLLMError(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonLLMNewToken

• onLLMNewToken(run, token, kwargs?): void | Promise<void>

• Parameters

  • run: Run
  • token: string
  • Optionalkwargs: {
        chunk: any;
    }

    • chunk: any

  Returns void | Promise<void>

OptionalonLLMStart

• onLLMStart(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonRetrieverEnd

• onRetrieverEnd(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonRetrieverError

• onRetrieverError(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonRetrieverStart

• onRetrieverStart(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonRunCreate

• onRunCreate(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonRunUpdate

• onRunUpdate(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonText

• onText(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonToolEnd

• onToolEnd(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonToolError

• onToolError(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

OptionalonToolStart

• onToolStart(run): void | Promise<void>

• Parameters

  • run: Run

  Returns void | Promise<void>

toJSON

• toJSON(): Serialized

• Returns Serialized

toJSONNotImplemented

• toJSONNotImplemented(): SerializedNotImplemented

• Returns SerializedNotImplemented

StaticfromMethods

• fromMethods(methods): {
      awaitHandlers: boolean;
      ignoreAgent: boolean;
      ignoreChain: boolean;
      ignoreCustomEvent: boolean;
      ignoreLLM: boolean;
      ignoreRetriever: boolean;
      name: string;
      raiseError: boolean;
      copy(): BaseCallbackHandler;
      handleAgentAction?(action: AgentAction, runId: string, parentRunId?: string, tags?: string[]): void | Promise<void>;
      handleAgentEnd?(action: AgentFinish, runId: string, parentRunId?: string, tags?: string[]): void | Promise<void>;
      handleChainEnd?(outputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], kwargs?: {
          inputs?: Record<string, unknown>;
      }): any;
      handleChainError?(err: any, runId: string, parentRunId?: string, tags?: string[], kwargs?: {
          inputs?: Record<string, unknown>;
      }): any;
      handleChainStart?(chain: Serialized, inputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runType?: string, runName?: string): any;
      handleChatModelStart?(llm: Serialized, messages: BaseMessage[][], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): any;
      handleCustomEvent?(eventName: string, data: any, runId: string, tags?: string[], metadata?: Record<string, any>): any;
      handleLLMEnd?(output: LLMResult, runId: string, parentRunId?: string, tags?: string[]): any;
      handleLLMError?(err: any, runId: string, parentRunId?: string, tags?: string[]): any;
      handleLLMNewToken?(token: string, idx: NewTokenIndices, runId: string, parentRunId?: string, tags?: string[], fields?: HandleLLMNewTokenCallbackFields): any;
      handleLLMStart?(llm: Serialized, prompts: string[], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): any;
      handleRetrieverEnd?(documents: DocumentInterface<Record<string, any>>[], runId: string, parentRunId?: string, tags?: string[]): any;
      handleRetrieverError?(err: any, runId: string, parentRunId?: string, tags?: string[]): any;
      handleRetrieverStart?(retriever: Serialized, query: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, name?: string): any;
      handleText?(text: string, runId: string, parentRunId?: string, tags?: string[]): void | Promise<void>;
      handleToolEnd?(output: any, runId: string, parentRunId?: string, tags?: string[]): any;
      handleToolError?(err: any, runId: string, parentRunId?: string, tags?: string[]): any;
      handleToolStart?(tool: Serialized, input: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runName?: string): any;
      toJSON(): Serialized;
      toJSONNotImplemented(): SerializedNotImplemented;
  }

• Parameters

  • methods: BaseCallbackHandlerMethodsClass

  Returns {
      awaitHandlers: boolean;
      ignoreAgent: boolean;
      ignoreChain: boolean;
      ignoreCustomEvent: boolean;
      ignoreLLM: boolean;
      ignoreRetriever: boolean;
      name: string;
      raiseError: boolean;
      copy(): BaseCallbackHandler;
      handleAgentAction?(action: AgentAction, runId: string, parentRunId?: string, tags?: string[]): void | Promise<void>;
      handleAgentEnd?(action: AgentFinish, runId: string, parentRunId?: string, tags?: string[]): void | Promise<void>;
      handleChainEnd?(outputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], kwargs?: {
          inputs?: Record<string, unknown>;
      }): any;
      handleChainError?(err: any, runId: string, parentRunId?: string, tags?: string[], kwargs?: {
          inputs?: Record<string, unknown>;
      }): any;
      handleChainStart?(chain: Serialized, inputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runType?: string, runName?: string): any;
      handleChatModelStart?(llm: Serialized, messages: BaseMessage[][], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): any;
      handleCustomEvent?(eventName: string, data: any, runId: string, tags?: string[], metadata?: Record<string, any>): any;
      handleLLMEnd?(output: LLMResult, runId: string, parentRunId?: string, tags?: string[]): any;
      handleLLMError?(err: any, runId: string, parentRunId?: string, tags?: string[]): any;
      handleLLMNewToken?(token: string, idx: NewTokenIndices, runId: string, parentRunId?: string, tags?: string[], fields?: HandleLLMNewTokenCallbackFields): any;
      handleLLMStart?(llm: Serialized, prompts: string[], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): any;
      handleRetrieverEnd?(documents: DocumentInterface<Record<string, any>>[], runId: string, parentRunId?: string, tags?: string[]): any;
      handleRetrieverError?(err: any, runId: string, parentRunId?: string, tags?: string[]): any;
      handleRetrieverStart?(retriever: Serialized, query: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, name?: string): any;
      handleText?(text: string, runId: string, parentRunId?: string, tags?: string[]): void | Promise<void>;
      handleToolEnd?(output: any, runId: string, parentRunId?: string, tags?: string[]): any;
      handleToolError?(err: any, runId: string, parentRunId?: string, tags?: string[]): any;
      handleToolStart?(tool: Serialized, input: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runName?: string): any;
      toJSON(): Serialized;
      toJSONNotImplemented(): SerializedNotImplemented;
  }

  • awaitHandlers: boolean

  • ignoreAgent: boolean

  • ignoreChain: boolean

  • ignoreCustomEvent: boolean

  • ignoreLLM: boolean

  • ignoreRetriever: boolean

  • name: string

  • raiseError: boolean

  • copy:function

    • copy(): BaseCallbackHandler

    • Returns BaseCallbackHandler

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

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

        • Optionalinputs?: Record<string, unknown>

      Returns any

  • handleChainStart?:function

    • handleChainStart(chain, inputs, runId, parentRunId?, tags?, metadata?, runType?, runName?): 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
      • OptionalparentRunId: string
      • Optionaltags: string[]
      • Optionalmetadata: Record<string, unknown>
      • OptionalrunType: string
      • OptionalrunName: string

      Returns any

  • handleChatModelStart?:function

    • handleChatModelStart(llm, messages, runId, parentRunId?, extraParams?, tags?, metadata?, runName?): 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
      • OptionalparentRunId: string
      • OptionalextraParams: Record<string, unknown>
      • Optionaltags: string[]
      • Optionalmetadata: Record<string, unknown>
      • OptionalrunName: string

      Returns any

  • handleCustomEvent?:function

    • handleCustomEvent(eventName, data, runId, tags?, metadata?): any

    • Parameters

      • eventName: string
      • data: any
      • runId: string
      • Optionaltags: string[]
      • Optionalmetadata: Record<string, any>

      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
      • OptionalparentRunId: string
      • Optionaltags: 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
      • OptionalparentRunId: string
      • Optionaltags: 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
      • OptionalparentRunId: string
      • Optionaltags: string[]
      • Optionalfields: HandleLLMNewTokenCallbackFields

      Returns any

  • handleLLMStart?:function

    • handleLLMStart(llm, prompts, runId, parentRunId?, extraParams?, tags?, metadata?, runName?): 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
      • OptionalparentRunId: string
      • OptionalextraParams: Record<string, unknown>
      • Optionaltags: string[]
      • Optionalmetadata: Record<string, unknown>
      • OptionalrunName: string

      Returns any

  • handleRetrieverEnd?:function

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

    • Parameters

      • documents: DocumentInterface<Record<string, any>>[]
      • runId: string
      • OptionalparentRunId: string
      • Optionaltags: string[]

      Returns any

  • handleRetrieverError?:function

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

    • Parameters

      • err: any
      • runId: string
      • OptionalparentRunId: string
      • Optionaltags: string[]

      Returns any

  • handleRetrieverStart?:function

    • handleRetrieverStart(retriever, query, runId, parentRunId?, tags?, metadata?, name?): any

    • Parameters

      • retriever: Serialized
      • query: string
      • runId: string
      • OptionalparentRunId: string
      • Optionaltags: string[]
      • Optionalmetadata: Record<string, unknown>
      • Optionalname: string

      Returns any

  • handleText?:function

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

    • Parameters

      • text: string
      • runId: string
      • OptionalparentRunId: string
      • Optionaltags: 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: any
      • runId: string
      • OptionalparentRunId: string
      • Optionaltags: string[]

      Returns any

  • handleToolError?:function

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

    • Called if a Tool run encounters an error

      Parameters

      • err: any
      • runId: string
      • OptionalparentRunId: string
      • Optionaltags: string[]

      Returns any

  • handleToolStart?:function

    • handleToolStart(tool, input, runId, parentRunId?, tags?, metadata?, runName?): 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
      • OptionalparentRunId: string
      • Optionaltags: string[]
      • Optionalmetadata: Record<string, unknown>
      • OptionalrunName: string

      Returns any

  • toJSON:function

    • toJSON(): Serialized

    • Returns Serialized

  • toJSONNotImplemented:function

    • toJSONNotImplemented(): SerializedNotImplemented

    • Returns SerializedNotImplemented