Class LogStreamCallbackHandler

Class that extends the BaseTracer class from the langchain.callbacks.tracers.base module. It represents a callback handler that logs the execution of runs and emits RunLog instances to a RunLogStream.

Hierarchy (view full)

BaseTracer
- LogStreamCallbackHandler

Index

Constructors

constructor

Properties

awaitHandlers ignoreAgent ignoreChain ignoreLLM ignoreRetriever name raiseError receiveStream writer autoClose runMap transformStream excludeNames? excludeTags? excludeTypes? includeNames? includeTags? includeTypes? rootId?

Constructors

constructor

new LogStreamCallbackHandler(fields?): LogStreamCallbackHandler
Parameters
- Optionalfields: LogStreamCallbackHandlerInput
Returns LogStreamCallbackHandler
Overrides BaseTracer.constructor
- Defined in langchain-core/src/tracers/log_stream.ts:244

Properties

awaitHandlers

awaitHandlers: boolean = ...

ignoreAgent

ignoreAgent: boolean = false

ignoreChain

ignoreChain: boolean = false

ignoreLLM

ignoreLLM: boolean = false

ignoreRetriever

ignoreRetriever: boolean = false

name

name: string = "log_stream_tracer"

raiseError

raiseError: boolean = false

receiveStream

receiveStream: IterableReadableStream<RunLogPatch>

writer

writer: WritableStreamDefaultWriter<any>

`Protected`autoClose

autoClose: boolean = true

`Protected`runMap

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

`Protected`transformStream

transformStream: TransformStream<any, any>

`Protected` `Optional`excludeNames

excludeNames?: string[]

`Protected` `Optional`excludeTags

excludeTags?: string[]

`Protected` `Optional`excludeTypes

excludeTypes?: string[]

`Protected` `Optional`includeNames

includeNames?: string[]

`Protected` `Optional`includeTags

includeTags?: string[]

`Protected` `Optional`includeTypes

includeTypes?: string[]

`Protected` `Optional`rootId

rootId?: string

Methods

[asyncIterator]

[asyncIterator](): IterableReadableStream<RunLogPatch>
Returns IterableReadableStream<RunLogPatch>
- Defined in langchain-core/src/tracers/log_stream.ts:261

copy

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

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

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

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>
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[]
- Optionalkwargs: {
  inputs?: Record<string, unknown>;
  }
  - Optionalinputs?: 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
- OptionalparentRunId: string
- Optionaltags: string[]
- Optionalmetadata: KVMap
- OptionalrunType: string
- Optionalname: 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
- OptionalparentRunId: string
- OptionalextraParams: KVMap
- Optionaltags: string[]
- Optionalmetadata: KVMap
- Optionalname: 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
- runId: string
- Optional_parentRunId: string
- Optional_tags: string[]
- Optionalfields: HandleLLMNewTokenCallbackFields
Returns Promise<Run>
Inherited from BaseTracer.handleLLMNewToken
- Defined in langchain-core/src/tracers/base.ts:542

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

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

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

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

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

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

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

onLLMNewToken

onLLMNewToken(run, token, kwargs?): Promise<void>
Parameters
- run: Run
- token: string
- Optionalkwargs: HandleLLMNewTokenCallbackFields
Returns Promise<void>
Overrides BaseTracer.onLLMNewToken
- Defined in langchain-core/src/tracers/log_stream.ts:444

onRunCreate

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

onRunUpdate

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

tapOutputIterable

tapOutputIterable<T>(runId, output): AsyncGenerator<T, any, unknown>
Type Parameters
- T
Parameters
- runId: string
- output: AsyncGenerator<T, any, unknown>
Returns AsyncGenerator<T, any, unknown>
- Defined in langchain-core/src/tracers/log_stream.ts:303

toJSON

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

toJSONNotImplemented

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

`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:589

`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:591

`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:579

`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:581

`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:577

`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:573

`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:575

`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:571

`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:595

`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:597

`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:593

`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:599

`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:585

`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:587

`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:583

`Static`fromMethods

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

`Protected`persistRun

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

`Protected`stringifyError

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

Class LogStreamCallbackHandler

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LogStreamCallbackHandler

Properties

awaitHandlers

ignoreAgent

ignoreChain

ignoreLLM

ignoreRetriever

name

raiseError

receiveStream

writer

ProtectedautoClose

ProtectedrunMap

ProtectedtransformStream

Protected OptionalexcludeNames

Protected OptionalexcludeTags

Protected OptionalexcludeTypes

Protected OptionalincludeNames

Protected OptionalincludeTags

Protected OptionalincludeTypes

Protected OptionalrootId

Methods

[asyncIterator]

Returns IterableReadableStream<RunLogPatch>

copy

Returns this

handleAgentAction

Parameters

Returns Promise<void>

handleAgentEnd

Parameters

Returns Promise<void>

handleChainEnd

Parameters

Optionalinputs?: Record<string, unknown>

Returns Promise<Run>

handleChainError

Parameters

Optionalinputs?: Record<string, unknown>

Returns Promise<Run>

handleChainStart

Parameters

Returns Promise<Run>

handleChatModelStart

Parameters

Returns Promise<Run>

handleLLMEnd

Parameters

Returns Promise<Run>

handleLLMError

Parameters

Returns Promise<Run>

handleLLMNewToken

Parameters

Returns Promise<Run>

handleLLMStart

Parameters

Returns Promise<Run>

handleRetrieverEnd

Parameters

Returns Promise<Run>

handleRetrieverError

Parameters

Returns Promise<Run>

handleRetrieverStart

Parameters

Returns Promise<Run>

handleText

Parameters

Returns Promise<void>

handleToolEnd

`Protected`autoClose

`Protected`runMap

`Protected`transformStream

`Protected` `Optional`excludeNames

`Protected` `Optional`excludeTags

`Protected` `Optional`excludeTypes

`Protected` `Optional`includeNames

`Protected` `Optional`includeTags

`Protected` `Optional`includeTypes

`Protected` `Optional`rootId

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

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

`Optional`onAgentAction

`Optional`onAgentEnd

`Optional`onChainEnd

`Optional`onChainError

`Optional`onChainStart

`Optional`onLLMEnd

`Optional`onLLMError

`Optional`onLLMStart

`Optional`onRetrieverEnd

`Optional`onRetrieverError

`Optional`onRetrieverStart

`Optional`onText

`Optional`onToolEnd

`Optional`onToolError

`Optional`onToolStart