Struct FunctionCallbackHandler 

pub struct FunctionCallbackHandler<F>
where
    F: Fn(&str) + Send + Sync,
{ /* private fields */ }

Tracer that calls a function with a single string parameter.

Implementations

impl<F> FunctionCallbackHandler<F>

where F: Fn(&str) + Send + Sync,

pub fn new(function: F) -> Self

Create a new FunctionCallbackHandler.

Arguments

• function - The callback function to call.

pub fn get_parents(&self, run: &Run) -> Vec<Run>

Get the parents of a run.

Arguments

• run - The run to get the parents of.

Returns

A list of parent runs.

pub fn get_breadcrumbs(&self, run: &Run) -> String

Get the breadcrumbs of a run.

Arguments

• run - The run to get the breadcrumbs of.

Returns

A string with the breadcrumbs of the run.

Trait Implementations

impl<F> BaseTracer for FunctionCallbackHandler<F>

where F: Fn(&str) + Send + Sync + Debug,

fn persist_run_impl(&mut self, _run: &Run)

Persist a run (required implementation).

fn start_trace_impl(&mut self, run: &mut Run)

Start a trace for a run.

fn end_trace_impl(&mut self, run: &Run)

End a trace for a run.

fn handle_chat_model_start( &mut self, serialized: HashMap<String, Value>, messages: &[Vec<BaseMessage>], run_id: Uuid, parent_run_id: Option<Uuid>, tags: Option<Vec<String>>, metadata: Option<HashMap<String, Value>>, name: Option<String>, extra: HashMap<String, Value>, ) -> Result<Run, TracerError>

Handle chat model start.

fn handle_llm_start( &mut self, serialized: HashMap<String, Value>, prompts: &[String], run_id: Uuid, parent_run_id: Option<Uuid>, tags: Option<Vec<String>>, metadata: Option<HashMap<String, Value>>, name: Option<String>, extra: HashMap<String, Value>, ) -> Run

Handle LLM start.

fn handle_llm_new_token( &mut self, token: &str, run_id: Uuid, chunk: Option<&dyn Any>, parent_run_id: Option<Uuid>, ) -> Result<Run, TracerError>

Handle new LLM token.

fn handle_retry( &mut self, retry_state: &HashMap<String, Value>, run_id: Uuid, ) -> Result<Run, TracerError>

Handle retry event.

fn handle_llm_end( &mut self, response: &LLMResult, run_id: Uuid, ) -> Result<Run, TracerError>

Handle LLM end.

fn handle_llm_error( &mut self, error: &dyn Error, run_id: Uuid, response: Option<&LLMResult>, ) -> Result<Run, TracerError>

Handle LLM error.

fn handle_chain_start( &mut self, serialized: HashMap<String, Value>, inputs: HashMap<String, Value>, run_id: Uuid, parent_run_id: Option<Uuid>, tags: Option<Vec<String>>, metadata: Option<HashMap<String, Value>>, run_type: Option<String>, name: Option<String>, extra: HashMap<String, Value>, ) -> Run

Handle chain start.

fn handle_chain_end( &mut self, outputs: HashMap<String, Value>, run_id: Uuid, inputs: Option<HashMap<String, Value>>, ) -> Result<Run, TracerError>

Handle chain end.

fn handle_chain_error( &mut self, error: &dyn Error, run_id: Uuid, inputs: Option<HashMap<String, Value>>, ) -> Result<Run, TracerError>

Handle chain error.

fn handle_tool_start( &mut self, serialized: HashMap<String, Value>, input_str: &str, run_id: Uuid, parent_run_id: Option<Uuid>, tags: Option<Vec<String>>, metadata: Option<HashMap<String, Value>>, name: Option<String>, inputs: Option<HashMap<String, Value>>, extra: HashMap<String, Value>, ) -> Run

Handle tool start.

fn handle_tool_end( &mut self, output: Value, run_id: Uuid, ) -> Result<Run, TracerError>

Handle tool end.

fn handle_tool_error( &mut self, error: &dyn Error, run_id: Uuid, ) -> Result<Run, TracerError>

Handle tool error.

fn handle_retriever_start( &mut self, serialized: HashMap<String, Value>, query: &str, run_id: Uuid, parent_run_id: Option<Uuid>, tags: Option<Vec<String>>, metadata: Option<HashMap<String, Value>>, name: Option<String>, extra: HashMap<String, Value>, ) -> Run

Handle retriever start.

fn handle_retriever_end( &mut self, documents: Vec<Value>, run_id: Uuid, ) -> Result<Run, TracerError>

Handle retriever end.

fn handle_retriever_error( &mut self, error: &dyn Error, run_id: Uuid, ) -> Result<Run, TracerError>

Handle retriever error.

impl<F> Debug for FunctionCallbackHandler<F>

where F: Fn(&str) + Send + Sync + Debug,

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

Formats the value using the given formatter.

impl<F> TracerCore for FunctionCallbackHandler<F>

where F: Fn(&str) + Send + Sync + Debug,

fn config(&self) -> &TracerCoreConfig

Get the configuration for this tracer.

fn config_mut(&mut self) -> &mut TracerCoreConfig

Get the mutable configuration for this tracer.

fn run_map(&self) -> &HashMap<String, Run>

Get the run map.

fn run_map_mut(&mut self) -> &mut HashMap<String, Run>

Get the mutable run map.

fn order_map(&self) -> &HashMap<Uuid, (Uuid, String)>

Get the order map (run_id -> (trace_id, dotted_order)).

fn order_map_mut(&mut self) -> &mut HashMap<Uuid, (Uuid, String)>

Get the mutable order map.

fn persist_run(&mut self, _run: &Run)

Persist a run.

fn on_chain_start(&mut self, run: &Run)

Called when a chain run starts.

fn on_chain_end(&mut self, run: &Run)

Called when a chain run ends.

fn on_chain_error(&mut self, run: &Run)

Called when a chain run errors.

fn on_llm_start(&mut self, run: &Run)

Called when an LLM run starts.

fn on_llm_end(&mut self, run: &Run)

Called when an LLM run ends.

fn on_llm_error(&mut self, run: &Run)

Called when an LLM run errors.

fn on_tool_start(&mut self, run: &Run)

Called when a tool run starts.

fn on_tool_end(&mut self, run: &Run)

Called when a tool run ends.

fn on_tool_error(&mut self, run: &Run)

Called when a tool run errors.

fn add_child_run(&mut self, parent_run: &mut Run, child_run: Run)

Add a child run to a parent run.

fn get_stacktrace(error: &dyn Error) -> String

Get the stacktrace of an error.

fn start_trace(&mut self, run: &mut Run)

Start a trace for a run.

fn end_trace(&mut self, run: &Run)

End a trace for a run.

fn get_run( &self, run_id: Uuid, run_type: Option<&[&str]>, ) -> Result<Run, TracerError>

Get a run by ID.

fn get_run_mut(&mut self, run_id: Uuid) -> Option<&mut Run>

Get a mutable run by ID.

fn create_chat_model_run( &self, serialized: HashMap<String, Value>, messages: &[Vec<BaseMessage>], run_id: Uuid, parent_run_id: Option<Uuid>, tags: Option<Vec<String>>, metadata: Option<HashMap<String, Value>>, name: Option<String>, extra: HashMap<String, Value>, ) -> Result<Run, TracerError>

Create a chat model run.

fn create_llm_run( &self, serialized: HashMap<String, Value>, prompts: &[String], run_id: Uuid, parent_run_id: Option<Uuid>, tags: Option<Vec<String>>, metadata: Option<HashMap<String, Value>>, name: Option<String>, extra: HashMap<String, Value>, ) -> Run

Create an LLM run.

fn llm_run_with_token_event( &mut self, token: &str, run_id: Uuid, chunk: Option<&dyn Any>, _parent_run_id: Option<Uuid>, ) -> Result<Run, TracerError>

Process an LLM run with a new token event.

fn llm_run_with_retry_event( &mut self, retry_state: &HashMap<String, Value>, run_id: Uuid, ) -> Result<Run, TracerError>

Process an LLM run with a retry event.

fn complete_llm_run( &mut self, response: &LLMResult, run_id: Uuid, ) -> Result<Run, TracerError>

Complete an LLM run.

fn errored_llm_run( &mut self, error: &dyn Error, run_id: Uuid, response: Option<&LLMResult>, ) -> Result<Run, TracerError>

Mark an LLM run as errored.

fn create_chain_run( &self, serialized: HashMap<String, Value>, inputs: HashMap<String, Value>, run_id: Uuid, parent_run_id: Option<Uuid>, tags: Option<Vec<String>>, metadata: Option<HashMap<String, Value>>, run_type: Option<String>, name: Option<String>, extra: HashMap<String, Value>, ) -> Run

Create a chain run.

fn get_chain_inputs( &self, inputs: HashMap<String, Value>, ) -> HashMap<String, Value>

Get chain inputs based on schema format.

fn get_chain_outputs( &self, outputs: HashMap<String, Value>, ) -> HashMap<String, Value>

Get chain outputs based on schema format.

fn complete_chain_run( &mut self, outputs: HashMap<String, Value>, run_id: Uuid, inputs: Option<HashMap<String, Value>>, ) -> Result<Run, TracerError>

Complete a chain run.

fn errored_chain_run( &mut self, error: &dyn Error, run_id: Uuid, inputs: Option<HashMap<String, Value>>, ) -> Result<Run, TracerError>

Mark a chain run as errored.

fn create_tool_run( &self, serialized: HashMap<String, Value>, input_str: &str, run_id: Uuid, parent_run_id: Option<Uuid>, tags: Option<Vec<String>>, metadata: Option<HashMap<String, Value>>, name: Option<String>, inputs: Option<HashMap<String, Value>>, extra: HashMap<String, Value>, ) -> Run

Create a tool run.

fn complete_tool_run( &mut self, output: Value, run_id: Uuid, ) -> Result<Run, TracerError>

Complete a tool run.

fn errored_tool_run( &mut self, error: &dyn Error, run_id: Uuid, ) -> Result<Run, TracerError>

Mark a tool run as errored.

fn create_retrieval_run( &self, serialized: HashMap<String, Value>, query: &str, run_id: Uuid, parent_run_id: Option<Uuid>, tags: Option<Vec<String>>, metadata: Option<HashMap<String, Value>>, name: Option<String>, extra: HashMap<String, Value>, ) -> Run

Create a retrieval run.

fn complete_retrieval_run( &mut self, documents: Vec<Value>, run_id: Uuid, ) -> Result<Run, TracerError>

Complete a retrieval run.

fn errored_retrieval_run( &mut self, error: &dyn Error, run_id: Uuid, ) -> Result<Run, TracerError>

Mark a retrieval run as errored.

fn on_run_create(&mut self, _run: &Run)

Called when a run is created.

fn on_run_update(&mut self, _run: &Run)

Called when a run is updated.

fn on_llm_new_token( &mut self, _run: &Run, _token: &str, _chunk: Option<&dyn Any>, )

Called when a new LLM token is received.

fn on_chat_model_start(&mut self, _run: &Run)

Called when a chat model run starts.

fn on_retriever_start(&mut self, _run: &Run)

Called when a retriever run starts.

fn on_retriever_end(&mut self, _run: &Run)

Called when a retriever run ends.

fn on_retriever_error(&mut self, _run: &Run)

Called when a retriever run errors.