Class LangChainTracer

Interface for the input parameters of the BaseCallbackHandler class. It allows to specify which types of events should be ignored by the callback handler.

Hierarchy (view full)

BaseTracer
- LangChainTracer

Implements

LangChainTracerFields

Constructors

constructor

new LangChainTracer(fields?): LangChainTracer
Parameters
- fields: LangChainTracerFields = {}
Returns LangChainTracer
Overrides BaseTracer.constructor
- Defined in langchain-core/src/tracers/tracer_langchain.ts:50

Properties

awaitHandlers

awaitHandlers: boolean = ...

client

client: Client

ignoreAgent

ignoreAgent: boolean = false

ignoreChain

ignoreChain: boolean = false

ignoreLLM

ignoreLLM: boolean = false

ignoreRetriever

ignoreRetriever: boolean = false

name

name: string = "langchain_tracer"

`Optional` exampleId

exampleId?: string

`Optional` projectName

projectName?: string

`Protected` runMap

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

Methods

copy

copy(): this
Returns this
Inherited from BaseTracer.copy
- Defined in langchain-core/src/tracers/base.ts:70

getRun

getRun(id): undefined | Run
Parameters
- id: string
Returns undefined | Run
- Defined in langchain-core/src/tracers/tracer_langchain.ts:102

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>
Inherited from BaseTracer.handleAgentAction
- Defined in langchain-core/src/tracers/base.ts:427

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>
Inherited from BaseTracer.handleAgentEnd
- Defined in langchain-core/src/tracers/base.ts:443

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>
Inherited from BaseTracer.handleChainEnd
- Defined in langchain-core/src/tracers/base.ts:308

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[]
- Optional kwargs: {
  inputs?: Record<string, unknown>;
  }
  - Optional inputs?: Record<string, unknown>
Returns Promise<Run>
Inherited from BaseTracer.handleChainError
- Defined in langchain-core/src/tracers/base.ts:333

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>
Inherited from BaseTracer.handleChainStart
- Defined in langchain-core/src/tracers/base.ts:271

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>
Inherited from BaseTracer.handleChatModelStart
- Defined in langchain-core/src/tracers/base.ts:198

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>
Inherited from BaseTracer.handleLLMEnd
- Defined in langchain-core/src/tracers/base.ts:239

handleLLMError

handleLLMError(error, runId): Promise<Run>
Called if an LLM/ChatModel run encounters an error
Parameters
- error: unknown
- runId: string
Returns Promise<Run>
Inherited from BaseTracer.handleLLMError
- Defined in langchain-core/src/tracers/base.ts:255

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>
Inherited from BaseTracer.handleLLMNewToken
- Defined in langchain-core/src/tracers/base.ts:541

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>
Inherited from BaseTracer.handleLLMStart
- Defined in langchain-core/src/tracers/base.ts:157

handleRetrieverEnd

handleRetrieverEnd(documents, runId): Promise<Run>
Parameters
- documents: Document<Record<string, unknown>>[]
- runId: string
Returns Promise<Run>
Inherited from BaseTracer.handleRetrieverEnd
- Defined in langchain-core/src/tracers/base.ts:493

handleRetrieverError

handleRetrieverError(error, runId): Promise<Run>
Parameters
- error: unknown
- runId: string
Returns Promise<Run>
Inherited from BaseTracer.handleRetrieverError
- Defined in langchain-core/src/tracers/base.ts:512

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>
Inherited from BaseTracer.handleRetrieverStart
- Defined in langchain-core/src/tracers/base.ts:456

handleText

handleText(text, runId): Promise<void>
Parameters
- text: string
- runId: string
Returns Promise<void>
Inherited from BaseTracer.handleText
- Defined in langchain-core/src/tracers/base.ts:528

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>
Inherited from BaseTracer.handleToolEnd
- Defined in langchain-core/src/tracers/base.ts:395

handleToolError

handleToolError(error, runId): Promise<Run>
Called if a Tool run encounters an error
Parameters
- error: unknown
- runId: string
Returns Promise<Run>
Inherited from BaseTracer.handleToolError
- Defined in langchain-core/src/tracers/base.ts:411

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>
Inherited from BaseTracer.handleToolStart
- Defined in langchain-core/src/tracers/base.ts:358

onRunCreate

onRunCreate(run): Promise<void>
Parameters
- run: Run
Returns Promise<void>
Overrides BaseTracer.onRunCreate
- Defined in langchain-core/src/tracers/tracer_langchain.ts:80

onRunUpdate

onRunUpdate(run): Promise<void>
Parameters
- run: Run
Returns Promise<void>
Overrides BaseTracer.onRunUpdate
- Defined in langchain-core/src/tracers/tracer_langchain.ts:88

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from BaseTracer.toJSON
- Defined in langchain-core/src/callbacks/base.ts:355

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from BaseTracer.toJSONNotImplemented
- Defined in langchain-core/src/callbacks/base.ts:359

`Optional` onAgentAction

onAgentAction(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onAgentAction
- Defined in langchain-core/src/tracers/base.ts:588

`Optional` onAgentEnd

onAgentEnd(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onAgentEnd
- Defined in langchain-core/src/tracers/base.ts:590

`Optional` onChainEnd

onChainEnd(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onChainEnd
- Defined in langchain-core/src/tracers/base.ts:578

`Optional` onChainError

onChainError(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onChainError
- Defined in langchain-core/src/tracers/base.ts:580

`Optional` onChainStart

onChainStart(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onChainStart
- Defined in langchain-core/src/tracers/base.ts:576

`Optional` onLLMEnd

onLLMEnd(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onLLMEnd
- Defined in langchain-core/src/tracers/base.ts:572

`Optional` onLLMError

onLLMError(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onLLMError
- Defined in langchain-core/src/tracers/base.ts:574

`Optional` onLLMNewToken

onLLMNewToken(run, token, kwargs?): void | Promise<void>
Parameters
- run: Run
- token: string
- Optional kwargs: {
  chunk: any;
  }
  - chunk: any
Returns void | Promise<void>
Inherited from BaseTracer.onLLMNewToken
- Defined in langchain-core/src/tracers/base.ts:600

`Optional` onLLMStart

onLLMStart(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onLLMStart
- Defined in langchain-core/src/tracers/base.ts:570

`Optional` onRetrieverEnd

onRetrieverEnd(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onRetrieverEnd
- Defined in langchain-core/src/tracers/base.ts:594

`Optional` onRetrieverError

onRetrieverError(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onRetrieverError
- Defined in langchain-core/src/tracers/base.ts:596

`Optional` onRetrieverStart

onRetrieverStart(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onRetrieverStart
- Defined in langchain-core/src/tracers/base.ts:592

`Optional` onText

onText(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onText
- Defined in langchain-core/src/tracers/base.ts:598

`Optional` onToolEnd

onToolEnd(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onToolEnd
- Defined in langchain-core/src/tracers/base.ts:584

`Optional` onToolError

onToolError(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onToolError
- Defined in langchain-core/src/tracers/base.ts:586

`Optional` onToolStart

onToolStart(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onToolStart
- Defined in langchain-core/src/tracers/base.ts:582

`Static` fromMethods

fromMethods(methods): Handler
Parameters
- methods: BaseCallbackHandlerMethodsClass
Returns Handler
Inherited from BaseTracer.fromMethods
- Defined in langchain-core/src/callbacks/base.ts:363

`Protected` persistRun

persistRun(_run): Promise<void>
Parameters
- _run: Run
Returns Promise<void>
Overrides BaseTracer.persistRun
- Defined in langchain-core/src/tracers/tracer_langchain.ts:78

`Protected` stringifyError

stringifyError(error): string
Parameters
- error: unknown
Returns string
Inherited from BaseTracer.stringifyError
- Defined in langchain-core/src/tracers/base.ts:74

Class LangChainTracer

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

fields: LangChainTracerFields = {}

Returns LangChainTracer

Properties

awaitHandlers

client

ignoreAgent

ignoreChain

ignoreLLM

ignoreRetriever

name

Optional exampleId

Optional projectName

Protected runMap

Methods

copy

Returns this

getRun

Parameters

id: string

Returns undefined | Run

handleAgentAction

Parameters

action: AgentAction

runId: string

Returns Promise<void>

handleAgentEnd

Parameters

action: AgentFinish

runId: string

Returns Promise<void>

handleChainEnd

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

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>

handleChainStart

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

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>

`Optional` exampleId

`Optional` projectName

`Protected` runMap

`Optional` _parentRunId: string

`Optional` _tags: string[]

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

`Optional` inputs?: Record<string, unknown>

`Optional` _parentRunId: string

`Optional` _tags: string[]

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

`Optional` inputs?: Record<string, unknown>

`Optional` parentRunId: string

`Optional` tags: string[]

`Optional` metadata: KVMap

`Optional` runType: string

`Optional` name: string

`Optional` parentRunId: string

`Optional` extraParams: KVMap

`Optional` tags: string[]

`Optional` metadata: KVMap

`Optional` name: string

`Optional` _parentRunId: string

`Optional` _tags: string[]

`Optional` fields: HandleLLMNewTokenCallbackFields

`Optional` parentRunId: string

`Optional` extraParams: KVMap

`Optional` tags: string[]

`Optional` metadata: KVMap

`Optional` name: string

`Optional` parentRunId: string

`Optional` tags: string[]

`Optional` metadata: KVMap

`Optional` name: string