Struct ProviderFunctionTool 

pub struct ProviderFunctionTool { /* private fields */ }

Validated client-executed function declaration shown to a model.

This declares a caller-executed function. providers-kit never executes the callback; the caller supplies correlated FunctionResult values after returned calls.

Examples

use providers_kit::generation::{ProviderFunctionTool, JsonSchema};
let tool = ProviderFunctionTool::new("lookup", Some("Find a record".into()), JsonSchema::new(serde_json::json!({"type":"object"}))?)?;
assert_eq!(tool.name(), "lookup");
assert_eq!(tool.description(), Some("Find a record"));
assert_eq!(tool.input_schema().schema()["type"], "object");

Implementations

impl ProviderFunctionTool

pub fn new( name: impl Into<String>, description: Option<String>, input_schema: JsonSchema, ) -> Result<Self, KitError>

Creates a function declaration with a stable non-empty name.

Errors

Returns an input error for an invalid function name or blank description. The input schema has already been validated by JsonSchema::new.

Examples

use providers_kit::generation::{ProviderFunctionTool, JsonSchema};
let tool = ProviderFunctionTool::new("lookup", Some("Find a record".into()), JsonSchema::new(serde_json::json!({"type":"object"}))?)?;
assert_eq!(tool.name(), "lookup");
assert_eq!(tool.description(), Some("Find a record"));
assert_eq!(tool.input_schema().schema()["type"], "object");

pub fn name(&self) -> &str

Returns the provider-visible function name.

Examples

use providers_kit::generation::{ProviderFunctionTool, JsonSchema};
let tool = ProviderFunctionTool::new("lookup", Some("Find a record".into()), JsonSchema::new(serde_json::json!({"type":"object"}))?)?;
assert_eq!(tool.name(), "lookup");
assert_eq!(tool.description(), Some("Find a record"));
assert_eq!(tool.input_schema().schema()["type"], "object");

pub fn description(&self) -> Option<&str>

Returns the optional model-visible description.

Examples

use providers_kit::generation::{ProviderFunctionTool, JsonSchema};
let tool = ProviderFunctionTool::new("lookup", Some("Find a record".into()), JsonSchema::new(serde_json::json!({"type":"object"}))?)?;
assert_eq!(tool.name(), "lookup");
assert_eq!(tool.description(), Some("Find a record"));
assert_eq!(tool.input_schema().schema()["type"], "object");

pub const fn input_schema(&self) -> &JsonSchema

Returns the strict argument schema.

Examples

use providers_kit::generation::{ProviderFunctionTool, JsonSchema};
let tool = ProviderFunctionTool::new("lookup", Some("Find a record".into()), JsonSchema::new(serde_json::json!({"type":"object"}))?)?;
assert_eq!(tool.name(), "lookup");
assert_eq!(tool.description(), Some("Find a record"));
assert_eq!(tool.input_schema().schema()["type"], "object");

pub fn into_parts(self) -> (String, Option<String>, JsonSchema)

Consumes the declaration into its validated parts.

Examples

use providers_kit::generation::{ProviderFunctionTool, JsonSchema};
let tool = ProviderFunctionTool::new("lookup", Some("Find a record".into()), JsonSchema::new(serde_json::json!({"type":"object"}))?)?;
let (name, description, schema) = tool.into_parts();
assert_eq!(name, "lookup");
assert_eq!(description.as_deref(), Some("Find a record"));
assert_eq!(schema.schema()["type"], "object");

Trait Implementations

impl Clone for ProviderFunctionTool

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 ProviderFunctionTool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProviderFunctionTool

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProviderFunctionTool

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProviderFunctionTool

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 ProviderFunctionTool