Struct ModelResponseProperties

pub struct ModelResponseProperties {
    pub metadata: Option<Metadata>,
    pub top_logprobs: Option<i64>,
    pub temperature: Option<Number>,
    pub top_p: Option<Number>,
    pub user: 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>

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.

service_tier: Option<ServiceTier>

Implementations

impl ModelResponseProperties

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

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

Trait Implementations

impl Clone for ModelResponseProperties

fn clone(&self) -> ModelResponseProperties

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelResponseProperties

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

Formats the value using the given formatter.

impl Default for ModelResponseProperties

fn default() -> ModelResponseProperties

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModelResponseProperties

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ModelResponseProperties

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

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

const 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 ModelResponseProperties

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 ModelResponseProperties