Class LangChainTracer

awaitHandlers

ignoreAgent

ignoreChain

ignoreLLM

ignoreRetriever

copy

• copy(): LangChainTracer

• Returns LangChainTracer

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[]

  • Optional kwargs: {
        inputs?: Record<string, unknown>;
    }

    • Optional inputs?: 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: Error

  • runId: string

  • Optional _parentRunId: string

  • Optional _tags: string[]

  • Optional kwargs: {
        inputs?: Record<string, unknown>;
    }

    • Optional inputs?: 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

  • Optional parentRunId: string

  • Optional tags: string[]

  • Optional metadata: KVMap

  • Optional runType: string

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

  • Optional parentRunId: string

  • Optional extraParams: KVMap

  • Optional tags: string[]

  • Optional metadata: KVMap

  • Optional name: string

  Returns Promise<Run>

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: Error

  • 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

    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

• 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

  • Optional parentRunId: string

  • Optional extraParams: KVMap

  • Optional tags: string[]

  • Optional metadata: KVMap

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

  • runId: string

  Returns Promise<Run>

handleRetrieverStart

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

• Parameters

  • retriever: Serialized

  • query: string

  • runId: string

  • Optional parentRunId: string

  • Optional tags: string[]

  • Optional metadata: KVMap

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

  • runId: string

  Returns Promise<Run>

handleToolError

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

• Called if a Tool run encounters an error

  Parameters

  • error: Error

  • 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

  • Optional parentRunId: string

  • Optional tags: string[]

  • Optional metadata: KVMap

  • Optional name: string

  Returns Promise<Run>

toJSON

• toJSON(): Serialized

• Returns Serialized

toJSONNotImplemented

• toJSONNotImplemented(): SerializedNotImplemented

• Returns SerializedNotImplemented

Optional onAgentAction

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

• Parameters

  • run: Run

  Returns void | Promise<void>

Optional onAgentEnd

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

• Parameters

  • run: Run

  Returns void | Promise<void>

Optional onLLMNewToken

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

• Parameters

  • run: Run

  • token: string

  • Optional kwargs: {
        chunk: any;
    }

    • chunk: any

  Returns void | Promise<void>

Optional onRunCreate

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

• Parameters

  • run: Run

  Returns void | Promise<void>

Optional onRunUpdate

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

• Parameters

  • run: Run

  Returns void | Promise<void>

Optional onText

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

• Parameters

  • run: Run

  Returns void | Promise<void>

Static fromMethods

• fromMethods(methods): Handler

• Parameters

  • methods: BaseCallbackHandlerMethodsClass

  Returns Handler