Struct ResponseFormat 

pub struct ResponseFormat {
    pub format_type: ResponseFormatType,
    pub json_schema: Option<JsonSchema>,
}

Response format specification.

Fields

format_type: ResponseFormatType

The type of response format.

json_schema: Option<JsonSchema>

JSON schema for structured output.

Implementations

impl ResponseFormat

pub fn text() -> Self

Create a text response format.

pub fn json_object() -> Self

Create a JSON object response format.

pub fn json_schema(name: impl Into<String>, schema: Value) -> Self

Create a JSON schema response format.

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 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.