Enum ResponseFormat 

pub enum ResponseFormat {
    Text,
    JsonObject,
    JsonSchema {
        schema: IndexMap<String, Value>,
    },
    Grammar {
        grammar: String,
    },
    Python,
    ToolCall {
        name: String,
        description: String,
        schema: IndexMap<String, Value>,
        required: Option<bool>,
    },
}

The format of the model’s response.

Variants

Text

Plain text response (default).

JsonObject

Response must be valid JSON.

JsonSchema

Response must conform to a JSON schema.

Fields

schema: IndexMap<String, Value>

The JSON Schema definition.

Grammar

Response must conform to a grammar.

Fields

grammar: String

Python

Response must be valid Python code.

ToolCall

The final assistant message will contain this tool call

Fields

name: String

The name of the tool.

description: String

A description of the tool.

schema: IndexMap<String, Value>

The JSON Schema definition.

required: Option<bool>

Whether the tool MUST be called.

Implementations

impl ResponseFormat

pub fn tool_key(&self) -> String

Trait Implementations

impl Clone for ResponseFormat

fn clone(&self) -> ResponseFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ResponseFormat

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for ResponseFormat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.