Skip to main content

FunctionDefinition

Struct FunctionDefinition 

Source
pub struct FunctionDefinition {
    pub name: String,
    pub description: String,
    pub parameters: Value,
}
Expand description

JSON-Schema-based description of a tool the LLM may call.

Pass a slice of FunctionDefinitions to Llm::generate_with_tools to enable native function calling instead of text-based ReAct parsing.

§Example

use rune_chain_core::FunctionDefinition;
use serde_json::json;

let def = FunctionDefinition::new(
    "get_weather",
    "Return the current weather for a city.",
    json!({
        "type": "object",
        "properties": {
            "city": { "type": "string", "description": "City name" }
        },
        "required": ["city"]
    }),
);

Fields§

§name: String

Unique tool name (no spaces; matches Tool::name).

§description: String

One-sentence description the LLM uses to decide when to call this tool.

§parameters: Value

JSON Schema object describing the tool’s parameter object.

Implementations§

Source§

impl FunctionDefinition

Source

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

Create a new function definition.

Source

pub fn single_input( name: impl Into<String>, description: impl Into<String>, ) -> Self

Build a definition with the standard single-string "input" parameter.

Use this as a quick wrapper for tools that accept a plain string.

§Example
use rune_chain_core::FunctionDefinition;

let def = FunctionDefinition::single_input(
    "upper_case",
    "Convert a string to upper case.",
);

Trait Implementations§

Source§

impl Clone for FunctionDefinition

Source§

fn clone(&self) -> FunctionDefinition

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FunctionDefinition

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for FunctionDefinition

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for FunctionDefinition

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.