Struct ChatOptions 

#[non_exhaustive]
pub struct ChatOptions {
    pub logit_bias: BTreeMap<String, i32>,
    pub prediction: Option<Prediction>,
    pub logprobs: Option<bool>,
    pub top_logprobs: Option<u8>,
    pub frequency_penalty: Option<f64>,
    pub presence_penalty: Option<f64>,
    pub modalities: Vec<Modality>,
    pub audio: Option<AudioOutput>,
    pub web_search_options: Option<WebSearchOptions>,
}

The fields only Chat Completions takes (https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

logit_bias: BTreeMap<String, i32>

Bias per token id, from -100 to 100.

prediction: Option<Prediction>

Predicted output, which speeds up a regeneration that mostly repeats it.

logprobs: Option<bool>

Whether the reply carries each output token’s log probability.

top_logprobs: Option<u8>

How many of the most likely tokens to report per position, 0 to 20.

frequency_penalty: Option<f64>

Penalizes tokens by how often they already appear, -2.0 to 2.0.

presence_penalty: Option<f64>

Penalizes tokens that already appear, -2.0 to 2.0.

modalities: Vec<Modality>

The output modalities, for models that also speak.

audio: Option<AudioOutput>

The spoken output, when modalities holds audio.

web_search_options: Option<WebSearchOptions>

Web search, for the search models.

Implementations

impl ChatOptions

pub fn new() -> Self

No option set.

pub fn logit_bias(self, token: u32, bias: i32) -> Self

Bias token id token by bias.

pub fn prediction(self, content: impl Into<String>) -> Self

Predict the output as content.

pub fn logprobs(self, logprobs: bool) -> Self

Whether the reply carries log probabilities.

pub fn top_logprobs(self, count: u8) -> Self

Report the count most likely tokens per position.

pub fn frequency_penalty(self, penalty: f64) -> Self

Set the frequency penalty.

pub fn presence_penalty(self, penalty: f64) -> Self

Set the presence penalty.

pub fn modalities(self, modalities: impl IntoIterator<Item = Modality>) -> Self

Answer in modalities.

pub fn audio(self, voice: impl Into<String>, format: AudioFormat) -> Self

Speak with voice in format.

pub fn web_search_options(self, options: WebSearchOptions) -> Self

Search the web with options.

Trait Implementations

impl Clone for ChatOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatOptions

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

Formats the value using the given formatter.

impl Default for ChatOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ChatOptions

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ChatOptions

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 ChatOptions