Struct CreateModelResponseProperties 

pub struct CreateModelResponseProperties {
    pub metadata: Option<Metadata>,
    pub top_logprobs: Option<i64>,
    pub temperature: Option<Number>,
    pub top_p: Option<Number>,
    pub user: Option<String>,
    pub safety_identifier: Option<String>,
    pub prompt_cache_key: Option<String>,
    pub service_tier: Option<ServiceTier>,
}

Fields

metadata: Option<Metadata>

top_logprobs: Option<i64>

An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability.

temperature: Option<Number>

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.

top_p: Option<Number>

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

We generally recommend altering this or temperature but not both.

user: Option<String>

This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.

safety_identifier: Option<String>

A stable identifier used to help detect users of your application that may be violating OpenAI’s usage policies. The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.

prompt_cache_key: Option<String>

Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.

service_tier: Option<ServiceTier>

Implementations

impl CreateModelResponseProperties

pub fn builder() -> CreateModelResponsePropertiesBuilder<((), (), (), (), (), (), (), ())>

Create a builder for building CreateModelResponseProperties. On the builder, call .metadata(...)(optional), .top_logprobs(...)(optional), .temperature(...)(optional), .top_p(...)(optional), .user(...)(optional), .safety_identifier(...)(optional), .prompt_cache_key(...)(optional), .service_tier(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CreateModelResponseProperties.

Trait Implementations

impl Clone for CreateModelResponseProperties

fn clone(&self) -> CreateModelResponseProperties

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateModelResponseProperties

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

Formats the value using the given formatter.

impl Default for CreateModelResponseProperties

fn default() -> CreateModelResponseProperties

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateModelResponseProperties

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateModelResponseProperties

fn eq(&self, other: &CreateModelResponseProperties) -> 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 CreateModelResponseProperties

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 CreateModelResponseProperties