Struct OpenAiTool 

pub struct OpenAiTool { /* private fields */ }

A single OpenAI function tool bound to a SIM callable.

Holds the OpenAI-facing function name and JSON Schema parameters alongside the resolved SIM symbol, argument order, required capabilities, and optional argument/result shapes for translating between OpenAI tool descriptors and SIM calls.

Implementations

impl OpenAiTool

pub fn from_callable( cx: &mut Cx, openai_name: impl Into<String>, symbol: Symbol, description: impl Into<String>, parameters: Value, capabilities: Vec<CapabilityName>, ) -> Result<Self>

Builds a tool from a resolved SIM callable, capturing its argument and result shapes from the callable’s browse metadata.

pub fn from_openai_descriptor(value: &Value) -> Result<Self>

Parses an OpenAI tool descriptor JSON object into an OpenAiTool.

Requires the descriptor type to be function and derives the SIM symbol from the function name. Inbound request JSON cannot set trusted SIM symbols or required capabilities; those come from the server-owned runtime registry.

pub fn openai_name(&self) -> &str

Returns the OpenAI-facing tool name.

pub fn symbol(&self) -> &Symbol

Returns the SIM symbol this tool dispatches to.

pub fn capabilities(&self) -> &[CapabilityName]

Returns the capabilities required to invoke this tool.

pub fn validate_arguments(&self, arguments: &Value) -> Result<(), String>

Validates arguments against the tool’s JSON Schema parameters.

pub fn argument_values( &self, cx: &mut Cx, arguments: &Value, ) -> Result<Vec<Value>, String>

Validates and converts JSON arguments into ordered SIM values for the call.

pub fn descriptor_json(&self) -> Value

Renders this tool as an OpenAI tool descriptor JSON object, including the x-sim-* extension fields for symbol, shapes, and capabilities.

pub fn request_descriptor_json(&self) -> Value

Renders this tool as an OpenAI request descriptor without SIM authority extension fields.

Use this form when a descriptor may cross an untrusted request boundary: the gateway resolves the SIM symbol and required capabilities from its server-owned registry rather than from x-sim-* request fields.

pub fn to_expr(&self) -> Expr

Renders this tool as a SIM expression map.

Trait Implementations

impl Clone for OpenAiTool

fn clone(&self) -> OpenAiTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAiTool

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

Formats the value using the given formatter.

impl PartialEq for OpenAiTool

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OpenAiTool