Enum CreateChatCompletionRequestResponseFormat 

pub enum CreateChatCompletionRequestResponseFormat {
    ResponseFormatText(ResponseFormatText),
    ResponseFormatJsonSchema(ResponseFormatJsonSchema),
    ResponseFormatJsonObject(ResponseFormatJsonObject),
}

An object specifying the format that the model must output.

Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

Setting to { "type": "json_object" } enables the older JSON mode, which ensures the message the model generates is valid JSON. Using json_schema is preferred for models that support it.

Variants

ResponseFormatText(ResponseFormatText)

ResponseFormatJsonSchema(ResponseFormatJsonSchema)

ResponseFormatJsonObject(ResponseFormatJsonObject)

Trait Implementations

impl Clone for CreateChatCompletionRequestResponseFormat

fn clone(&self) -> CreateChatCompletionRequestResponseFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateChatCompletionRequestResponseFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateChatCompletionRequestResponseFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ResponseFormatJsonObject> for CreateChatCompletionRequestResponseFormat

fn from(value: ResponseFormatJsonObject) -> Self

Converts to this type from the input type.

impl From<ResponseFormatJsonSchema> for CreateChatCompletionRequestResponseFormat

fn from(value: ResponseFormatJsonSchema) -> Self

Converts to this type from the input type.

impl From<ResponseFormatText> for CreateChatCompletionRequestResponseFormat

fn from(value: ResponseFormatText) -> Self

Converts to this type from the input type.

impl PartialEq for CreateChatCompletionRequestResponseFormat

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CreateChatCompletionRequestResponseFormat

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 CreateChatCompletionRequestResponseFormat

impl TryFrom<CreateChatCompletionRequestResponseFormat> for ResponseFormatText

fn try_from( value: CreateChatCompletionRequestResponseFormat, ) -> Result<Self, Self::Error>

Errors

Returns the original enum value if it does not match the #variant_ident variant.

type Error = CreateChatCompletionRequestResponseFormat

The type returned in the event of a conversion error.

impl TryFrom<CreateChatCompletionRequestResponseFormat> for ResponseFormatJsonSchema

fn try_from( value: CreateChatCompletionRequestResponseFormat, ) -> Result<Self, Self::Error>

Errors

Returns the original enum value if it does not match the #variant_ident variant.

type Error = CreateChatCompletionRequestResponseFormat

The type returned in the event of a conversion error.

impl TryFrom<CreateChatCompletionRequestResponseFormat> for ResponseFormatJsonObject

fn try_from( value: CreateChatCompletionRequestResponseFormat, ) -> Result<Self, Self::Error>

Errors

Returns the original enum value if it does not match the #variant_ident variant.

type Error = CreateChatCompletionRequestResponseFormat

The type returned in the event of a conversion error.