Struct CallbackManager 

pub struct CallbackManager {
    pub handlers: Vec<Arc<dyn BaseCallbackHandler>>,
    pub inheritable_handlers: Vec<Arc<dyn BaseCallbackHandler>>,
    pub parent_run_id: Option<Uuid>,
    pub tags: Vec<String>,
    pub inheritable_tags: Vec<String>,
    pub metadata: HashMap<String, Value>,
    pub inheritable_metadata: HashMap<String, Value>,
}

Callback manager for LangChain.

Fields

handlers: Vec<Arc<dyn BaseCallbackHandler>>

The handlers.

inheritable_handlers: Vec<Arc<dyn BaseCallbackHandler>>

The inheritable handlers.

parent_run_id: Option<Uuid>

The parent run ID.

tags: Vec<String>

The tags.

inheritable_tags: Vec<String>

The inheritable tags.

metadata: HashMap<String, Value>

The metadata.

inheritable_metadata: HashMap<String, Value>

The inheritable metadata.

Implementations

impl CallbackManager

pub fn new() -> Self

Create a new callback manager.

pub fn from_base(base: BaseCallbackManager) -> Self

Create a callback manager from a base callback manager.

pub fn set_handlers( &mut self, handlers: Vec<Arc<dyn BaseCallbackHandler>>, inherit: bool, )

Set handlers.

pub fn add_handler( &mut self, handler: Arc<dyn BaseCallbackHandler>, inherit: bool, )

Add handler.

pub fn add_tags(&mut self, tags: Vec<String>, inherit: bool)

Add tags.

pub fn add_metadata(&mut self, metadata: HashMap<String, Value>, inherit: bool)

Add metadata.

pub fn on_llm_start( &self, serialized: &HashMap<String, Value>, prompts: &[String], run_id: Option<Uuid>, ) -> Vec<CallbackManagerForLLMRun>

Run when LLM starts running.

pub fn on_chat_model_start( &self, serialized: &HashMap<String, Value>, messages: &[Vec<BaseMessage>], run_id: Option<Uuid>, ) -> Vec<CallbackManagerForLLMRun>

Run when chat model starts running.

pub fn on_chain_start( &self, serialized: &HashMap<String, Value>, inputs: &HashMap<String, Value>, run_id: Option<Uuid>, ) -> CallbackManagerForChainRun

Run when chain starts running.

pub fn on_tool_start( &self, serialized: &HashMap<String, Value>, input_str: &str, run_id: Option<Uuid>, inputs: Option<&HashMap<String, Value>>, ) -> CallbackManagerForToolRun

Run when tool starts running.

pub fn on_retriever_start( &self, serialized: &HashMap<String, Value>, query: &str, run_id: Option<Uuid>, ) -> CallbackManagerForRetrieverRun

Run when retriever starts running.

pub fn on_custom_event(&self, name: &str, data: &Value, run_id: Option<Uuid>)

Dispatch a custom event.

pub fn configure( inheritable_callbacks: Option<Callbacks>, local_callbacks: Option<Callbacks>, inheritable_tags: Option<Vec<String>>, local_tags: Option<Vec<String>>, inheritable_metadata: Option<HashMap<String, Value>>, local_metadata: Option<HashMap<String, Value>>, _verbose: bool, ) -> Self

Configure the callback manager.

Trait Implementations

impl Clone for CallbackManager

fn clone(&self) -> CallbackManager

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CallbackManager

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CallbackManager

fn default() -> CallbackManager

Returns the “default value” for a type.