Struct Function 

pub struct Function {
    pub name: String,
    pub description: String,
    pub parameters: Option<Value>,
}

Definition of a caller-provided function that the model may invoke.

Validation

• name - Must be 1 to 64 ASCII letters, digits, underscores, or hyphens
• parameters - Must be a valid JSON schema

Fields

name: String

The name of the function. Must match [A-Za-z0-9_-]{1,64}.

description: String

A description of what the function does.

parameters: Option<Value>

JSON Schema object describing the function parameters.

Implementations

impl Function

pub fn new( name: impl Into<String>, description: impl Into<String>, parameters: Value, ) -> Self

Create a function definition with a JSON Schema parameter object.

Examples

use zai_rs::model::tools::Function;

let func = Function::new(
    "get_weather",
    "Get current weather for a location",
    serde_json::json!({
        "type": "object",
        "properties": { "location": { "type": "string" } }
    })
);

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl From<Function> for Tools

fn from(function: Function) -> Self

Converts to this type from the input type.

impl Serialize for Function

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for Function

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for Function

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>