Class RunCollectorCallbackHandler

A callback handler that collects traced runs and makes it easy to fetch the traced run object from calls through any langchain object. For instance, it makes it easy to fetch the run ID and then do things with that, such as log feedback.

Hierarchy

BaseTracer
- RunCollectorCallbackHandler

Constructors

constructor

new RunCollectorCallbackHandler(exampleId?): RunCollectorCallbackHandler
Creates a new instance of the RunCollectorCallbackHandler class.
Parameters
- exampleId: {
  exampleId?: string;
  } = {}
  
  The ID of the example.
  - Optional exampleId?: string
Returns RunCollectorCallbackHandler
Overrides BaseTracer.constructor
- Defined in docs/api_refs/langchain/src/callbacks/handlers/run_collector.ts:22

Properties

awaitHandlers

awaitHandlers: boolean = ...

ignoreAgent

ignoreAgent: boolean = false

ignoreChain

ignoreChain: boolean = false

ignoreLLM

ignoreLLM: boolean = false

ignoreRetriever

ignoreRetriever: boolean = false

name

name: string = "run_collector"

The name of the callback handler.

tracedRuns

tracedRuns: Run[]

An array of traced runs.

`Optional` exampleId

exampleId?: string

The ID of the example.

`Protected` runMap

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

Methods

copy

copy(): RunCollectorCallbackHandler
Returns RunCollectorCallbackHandler
Inherited from BaseTracer.copy
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:54

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 docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:378

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 docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:394

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 docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:259

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>
Inherited from BaseTracer.handleChainError
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:284

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 docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:222

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 docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:149

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 docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:190

handleLLMError

handleLLMError(error, runId): Promise<Run>
Called if an LLM/ChatModel run encounters an error
Parameters
- error: Error
- runId: string
Returns Promise<Run>
Inherited from BaseTracer.handleLLMError
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:206

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 docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:492

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 docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:108

handleRetrieverEnd

handleRetrieverEnd(documents, runId): Promise<Run>
Parameters
- documents: Document<Record<string, unknown>>[]
- runId: string
Returns Promise<Run>
Inherited from BaseTracer.handleRetrieverEnd
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:444

handleRetrieverError

handleRetrieverError(error, runId): Promise<Run>
Parameters
- error: Error
- runId: string
Returns Promise<Run>
Inherited from BaseTracer.handleRetrieverError
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:463

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 docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:407

handleText

handleText(text, runId): Promise<void>
Parameters
- text: string
- runId: string
Returns Promise<void>
Inherited from BaseTracer.handleText
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:479

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 docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:346

handleToolError

handleToolError(error, runId): Promise<Run>
Called if a Tool run encounters an error
Parameters
- error: Error
- runId: string
Returns Promise<Run>
Inherited from BaseTracer.handleToolError
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:362

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 docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:309

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from BaseTracer.toJSON
- Defined in docs/api_refs/langchain/src/callbacks/base.ts:364

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from BaseTracer.toJSONNotImplemented
- Defined in docs/api_refs/langchain/src/callbacks/base.ts:368

`Optional` onAgentAction

onAgentAction(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onAgentAction
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:539

`Optional` onAgentEnd

onAgentEnd(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onAgentEnd
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:541

`Optional` onChainEnd

onChainEnd(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onChainEnd
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:529

`Optional` onChainError

onChainError(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onChainError
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:531

`Optional` onChainStart

onChainStart(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onChainStart
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:527

`Optional` onLLMEnd

onLLMEnd(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onLLMEnd
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:523

`Optional` onLLMError

onLLMError(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onLLMError
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:525

`Optional` onLLMNewToken

onLLMNewToken(run, token): void | Promise<void>
Parameters
- run: Run
- token: string
Returns void | Promise<void>
Inherited from BaseTracer.onLLMNewToken
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:551

`Optional` onLLMStart

onLLMStart(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onLLMStart
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:521

`Optional` onRetrieverEnd

onRetrieverEnd(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onRetrieverEnd
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:545

`Optional` onRetrieverError

onRetrieverError(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onRetrieverError
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:547

`Optional` onRetrieverStart

onRetrieverStart(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onRetrieverStart
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:543

`Optional` onRunCreate

onRunCreate(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onRunCreate
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:517

`Optional` onRunUpdate

onRunUpdate(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onRunUpdate
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:519

`Optional` onText

onText(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onText
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:549

`Optional` onToolEnd

onToolEnd(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onToolEnd
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:535

`Optional` onToolError

onToolError(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onToolError
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:537

`Optional` onToolStart

onToolStart(run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onToolStart
- Defined in docs/api_refs/langchain/src/callbacks/handlers/tracer.ts:533

`Static` fromMethods

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

`Protected` persistRun

persistRun(run): Promise<void>
Persists the given run object.
Parameters
- run: BaseRun
  
  The run object to persist.
Returns Promise<void>
Overrides BaseTracer.persistRun
- Defined in docs/api_refs/langchain/src/callbacks/handlers/run_collector.ts:32

Class RunCollectorCallbackHandler

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

exampleId: { exampleId?: string; } = {}

Optional exampleId?: string

Returns RunCollectorCallbackHandler

Properties

awaitHandlers

ignoreAgent

ignoreChain

ignoreLLM

ignoreRetriever

name

tracedRuns

Optional exampleId

Protected runMap

Methods

copy

Returns RunCollectorCallbackHandler

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

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>

handleLLMEnd

Parameters

output: LLMResult

runId: string

Returns Promise<Run>

exampleId: {
exampleId?: string;
} = {}

`Optional` exampleId?: string

`Optional` exampleId

`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

`Optional` parentRunId: string

`Optional` tags: string[]

`Optional` metadata: KVMap

`Optional` name: string