Struct ToolFunction 

pub struct ToolFunction {
    pub name: ToolName,
    pub arguments: Map<String, Value>,
    pub invalid_arguments: Option<String>,
}

A tool function to call: its name and its arguments, always a JSON object.

Arguments the model sent that are not an object are kept as text in invalid_arguments, with arguments holding what could be read of them ({} when nothing could), so a malformed call never fails a reply and every wire receives an object.

use rig_core::message::{ToolFunction, ToolName};

let name = ToolName::new("search")?;
let call = ToolFunction::parse(name.clone(), r#"{"q": "ab"#);
assert_eq!(call.arguments["q"], "ab");
assert_eq!(call.invalid_arguments.as_deref(), Some(r#"{"q": "ab"#));

let call = ToolFunction::new(name, serde_json::json!("{\"q\":1}"));
assert_eq!(call.arguments["q"], 1);
assert!(call.invalid_arguments.is_none());

Fields

name: ToolName

Tool/function name to invoke.

arguments: Map<String, Value>

The arguments.

invalid_arguments: Option<String>

The arguments as the model sent them, when they were not a JSON object.

Implementations

impl ToolFunction

pub fn new(name: ToolName, arguments: Value) -> Self

A call to name with arguments. An object is kept; a string holding an object is unwrapped once; null is {}; anything else is {} with its JSON text in invalid_arguments.

pub fn parse(name: ToolName, text: &str) -> Self

A call to name with the argument JSON text. Blank text is {}. Text that is not an object keeps what a cut-off object still states, or {}, and is kept in invalid_arguments. A string holding an object is unwrapped once.

pub fn arguments_value(&self) -> Value

The arguments as a JSON value.

Trait Implementations

impl Clone for ToolFunction

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolFunction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolFunction

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Arguments stored in any JSON shape are read through ToolFunction::new, so a history saved before arguments were always objects still loads.

impl PartialEq for ToolFunction

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ToolFunction

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolFunction