Struct async_openai::types::ChatCompletionResponseFormat

pub struct ChatCompletionResponseFormat {
    pub type: ChatCompletionResponseFormatType,
}

Fields

type: ChatCompletionResponseFormatType

Setting to json_object enables JSON mode. This guarantees that the message the model generates is valid JSON.

Note that your system prompt must still instruct the model to produce JSON, and to help ensure you don’t forget, the API will throw an error if the string JSON does not appear in your system message. Also note that the message content may be partial (i.e. cut off) if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

Must be one of text or json_object.

Trait Implementations

impl Clone for ChatCompletionResponseFormat

fn clone(&self) -> ChatCompletionResponseFormat

Returns a copy of the value.

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 PartialEq for ChatCompletionResponseFormat

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

This method tests for self and other values to be equal, and is used by ==.

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

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

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.

impl StructuralPartialEq for ChatCompletionResponseFormat