Class CallbackManager

constructor

• new CallbackManager(parentRunId?): CallbackManager

• Parameters

  • Optional parentRunId: string

  Returns CallbackManager

handlers

inheritableHandlers

inheritableMetadata

inheritableTags

metadata

name

tags

addHandler

• addHandler(handler, inherit?): void

• Parameters

  • handler: BaseCallbackHandler

  • inherit: boolean = true

  Returns void

addMetadata

• addMetadata(metadata, inherit?): void

• Parameters

  • metadata: Record<string, unknown>

  • inherit: boolean = true

  Returns void

addTags

• addTags(tags, inherit?): void

• Parameters

  • tags: string[]

  • inherit: boolean = true

  Returns void

copy

• copy(additionalHandlers?, inherit?): CallbackManager

• Parameters

  • additionalHandlers: BaseCallbackHandler[] = []

  • inherit: boolean = true

  Returns CallbackManager

handleChainStart

• handleChainStart(chain, inputs, runId?, runType?, _tags?, _metadata?, runName?): Promise<CallbackManagerForChainRun>

• Parameters

  • chain: Serialized

  • inputs: ChainValues

  • runId: string = ...

  • runType: undefined | string = undefined

  • _tags: undefined | string[] = undefined

  • _metadata: undefined | Record<string, unknown> = undefined

  • runName: undefined | string = undefined

  Returns Promise<CallbackManagerForChainRun>

handleChatModelStart

• handleChatModelStart(llm, messages, _runId?, _parentRunId?, extraParams?, _tags?, _metadata?, runName?): Promise<CallbackManagerForLLMRun[]>

• Parameters

  • llm: Serialized

  • messages: BaseMessage[][]

  • _runId: undefined | string = undefined

  • _parentRunId: undefined | string = undefined

  • extraParams: undefined | Record<string, unknown> = undefined

  • _tags: undefined | string[] = undefined

  • _metadata: undefined | Record<string, unknown> = undefined

  • runName: undefined | string = undefined

  Returns Promise<CallbackManagerForLLMRun[]>

handleLLMStart

• handleLLMStart(llm, prompts, _runId?, _parentRunId?, extraParams?, _tags?, _metadata?, runName?): Promise<CallbackManagerForLLMRun[]>

• Parameters

  • llm: Serialized

  • prompts: string[]

  • _runId: undefined | string = undefined

  • _parentRunId: undefined | string = undefined

  • extraParams: undefined | Record<string, unknown> = undefined

  • _tags: undefined | string[] = undefined

  • _metadata: undefined | Record<string, unknown> = undefined

  • runName: undefined | string = undefined

  Returns Promise<CallbackManagerForLLMRun[]>

handleRetrieverStart

• handleRetrieverStart(retriever, query, runId?, _parentRunId?, _tags?, _metadata?, runName?): Promise<CallbackManagerForRetrieverRun>

• Parameters

  • retriever: Serialized

  • query: string

  • runId: string = ...

  • _parentRunId: undefined | string = undefined

  • _tags: undefined | string[] = undefined

  • _metadata: undefined | Record<string, unknown> = undefined

  • runName: undefined | string = undefined

  Returns Promise<CallbackManagerForRetrieverRun>

handleToolStart

• handleToolStart(tool, input, runId?, _parentRunId?, _tags?, _metadata?, runName?): Promise<CallbackManagerForToolRun>

• Parameters

  • tool: Serialized

  • input: string

  • runId: string = ...

  • _parentRunId: undefined | string = undefined

  • _tags: undefined | string[] = undefined

  • _metadata: undefined | Record<string, unknown> = undefined

  • runName: undefined | string = undefined

  Returns Promise<CallbackManagerForToolRun>

removeHandler

• removeHandler(handler): void

• Parameters

  • handler: BaseCallbackHandler

  Returns void

removeMetadata

• removeMetadata(metadata): void

• Parameters

  • metadata: Record<string, unknown>

  Returns void

removeTags

• removeTags(tags): void

• Parameters

  • tags: string[]

  Returns void

setHandlers

• setHandlers(handlers, inherit?): void

• Parameters

  • handlers: BaseCallbackHandler[]

  • inherit: boolean = true

  Returns void

Static configure

• configure(inheritableHandlers?, localHandlers?, inheritableTags?, localTags?, inheritableMetadata?, localMetadata?, options?): Promise<undefined | CallbackManager>

• Parameters

  • Optional inheritableHandlers: Callbacks

  • Optional localHandlers: Callbacks

  • Optional inheritableTags: string[]

  • Optional localTags: string[]

  • Optional inheritableMetadata: Record<string, unknown>

  • Optional localMetadata: Record<string, unknown>

  • Optional options: CallbackManagerOptions

  Returns Promise<undefined | CallbackManager>

Static fromHandlers

• fromHandlers(handlers): CallbackManager

• Parameters

  • handlers: BaseCallbackHandlerMethodsClass

  Returns CallbackManager