Struct RealtimeTool 

pub struct RealtimeTool {
    pub type_name: String,
    pub name: String,
    pub description: Option<String>,
    pub parameters: Option<Parameters>,
}

Tool definition for the Realtime API.

The Realtime API uses a flattened tool format, unlike the Chat Completions API which nests the function details under a function key.

Example

use openai_tools::realtime::RealtimeTool;
use openai_tools::common::parameters::ParameterProperty;

let tool = RealtimeTool::function(
    "get_weather",
    "Get the current weather for a location",
    vec![("location", ParameterProperty::from_string("The city name"))],
);

Fields

type_name: String

The type of tool (always “function” for function calling).

name: String

The name of the function.

description: Option<String>

A description of what the function does.

parameters: Option<Parameters>

The parameters the function accepts.

Implementations

impl RealtimeTool

pub fn function<T, U, V>( name: T, description: U, parameters: Vec<(V, ParameterProperty)>, ) -> Self

where T: Into<String>, U: Into<String>, V: AsRef<str>,

Create a new function tool.

Trait Implementations

impl Clone for RealtimeTool

fn clone(&self) -> RealtimeTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeTool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RealtimeTool

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Tool> for RealtimeTool

fn from(tool: Tool) -> Self

Convert a Chat API tool to a Realtime API tool.

impl Serialize for RealtimeTool

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

where __S: Serializer,

Serialize this value into the given Serde serializer.