Enum ResponseFormat 

#[non_exhaustive]
pub enum ResponseFormat {
    Text,
    Json,
    Schema(Schema),
}

The shape of the answer’s text.

Each wire API maps it explicitly: Chat Completions sends response_format. Text is every server’s default and is not sent. The answer is not checked against it when it arrives; Completion::parse reads it into a type.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Text

Text of any shape. The default.

Json

A JSON object of any shape. Most APIs also want the prompt to ask for JSON.

Schema(Schema)

JSON that matches a schema.

Trait Implementations

impl Clone for ResponseFormat

fn clone(&self) -> Self

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 Default for ResponseFormat

fn default() -> Self

Returns the “default value” for a type.

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 From<Schema> for ResponseFormat

fn from(schema: Schema) -> Self

Converts to this type from the input type.

impl PartialEq for ResponseFormat

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

Equality operator ==.

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

Inequality operator !=.

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.

impl StructuralPartialEq for ResponseFormat