Enum ToolInputFormat 

pub enum ToolInputFormat {
    JsonSchema {
        parameters: Value,
    },
    Freeform {
        syntax: GrammarSyntax,
        definition: String,
    },
}

How a tool’s input is specified: a JSON-schema function tool, or a freeform tool whose raw-text input is constrained by a server-side grammar (OpenAI Responses custom tools — codex’s apply_patch). Exactly one of the two — an enum, not optional fields, so invalid states are unrepresentable.

Variants

JsonSchema

A JSON-schema function tool (every tool today).

Fields

parameters: Value

The derived JSON Schema for the tool’s arguments.

Freeform

A freeform tool: raw text constrained by a grammar. On wires without custom-tool support it degrades to a {"input": string} function tool; the raw text reaches the tool identically either way.

Fields

syntax: GrammarSyntax

The grammar language.

definition: String

The grammar source, verbatim.

Trait Implementations

impl Clone for ToolInputFormat

fn clone(&self) -> ToolInputFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolInputFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolInputFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolInputFormat

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolInputFormat

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 ToolInputFormat