Struct ChatCompletionResponseFormat

pub struct ChatCompletionResponseFormat {
    pub type_name: String,
    pub json_schema: Schema,
}

Specifies the format that the model must output for chat completions.

This structure is used to configure structured outputs, particularly for JSON schema-based responses that ensure the model returns data in a specific format.

Fields

• type_name - The type of response format (e.g., “json_schema”)
• json_schema - The JSON schema definition for structured output

Example

use openai_tools::chat::ChatCompletionResponseFormat;
use openai_tools::structured_output::Schema;

let mut schema = Schema::chat_json_schema("person".to_string());
schema.add_property("name".to_string(), "string".to_string(), Some("Person's name".to_string()));
schema.add_property("age".to_string(), "integer".to_string(), Some("Person's age".to_string()));

let format = ChatCompletionResponseFormat::new("json_schema".to_string(), schema);

Fields

type_name: String

json_schema: Schema

Implementations

impl ChatCompletionResponseFormat

pub fn new(type_name: String, json_schema: Schema) -> Self

Creates a new ChatCompletionResponseFormat instance.

Arguments

• type_name - The type of response format (typically “json_schema”)
• json_schema - The JSON schema definition for structured output

Returns

A new ChatCompletionResponseFormat instance configured with the specified parameters.

Example

use openai_tools::chat::ChatCompletionResponseFormat;
use openai_tools::structured_output::Schema;

let schema = Schema::chat_json_schema("example".to_string());
let format = ChatCompletionResponseFormat::new("json_schema".to_string(), schema);

Trait Implementations

impl Clone for ChatCompletionResponseFormat

fn clone(&self) -> ChatCompletionResponseFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatCompletionResponseFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatCompletionResponseFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ChatCompletionResponseFormat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.