Struct ResponseTextParam 

pub struct ResponseTextParam {
    pub format: TextResponseFormatConfiguration,
    pub verbosity: Option<Verbosity>,
}

Configuration for text response format.

Fields

format: TextResponseFormatConfiguration

An object specifying the format that the model must output.

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

The default format is { "type": "text" } with no additional options.

Not recommended for gpt-4o and newer models:

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.

verbosity: Option<Verbosity>

Constrains the verbosity of the model’s response. Lower values will result in more concise responses, while higher values will result in more verbose responses.

Currently supported values are low, medium, and high.

Trait Implementations

impl Clone for ResponseTextParam

fn clone(&self) -> ResponseTextParam

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseTextParam

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseTextParam

fn deserialize<__D>( __deserializer: __D, ) -> Result<ResponseTextParam, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ResponseFormatJsonSchema> for ResponseTextParam

fn from(schema: ResponseFormatJsonSchema) -> ResponseTextParam

Converts to this type from the input type.

impl From<TextResponseFormatConfiguration> for ResponseTextParam

fn from(format: TextResponseFormatConfiguration) -> ResponseTextParam

Converts to this type from the input type.

impl PartialEq for ResponseTextParam

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ResponseTextParam

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ResponseTextParam