Class SingleRunExtractor

awaitHandlers

ignoreAgent

ignoreChain

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>

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>

toJSON

• toJSON(): Serialized

• Returns Serialized

toJSONNotImplemented

• toJSONNotImplemented(): SerializedNotImplemented

• Returns SerializedNotImplemented

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>

StaticfromMethods

• fromMethods(methods): Handler

• Parameters

  • methods: BaseCallbackHandlerMethodsClass

  Returns Handler