Struct ChatCompletionRequest 

#[non_exhaustive]
pub struct ChatCompletionRequest {

    pub messages: Vec<ChatCompletionMessageParam>,
    pub model: OpenAiModelId,
    pub audio: Option<ChatAudioParam>,
    pub frequency_penalty: Option<f64>,
    pub function_call: Option<LegacyFunctionCallChoice>,
    pub functions: Option<Vec<LegacyFunctionDefinition>>,
    pub logit_bias: Option<LogitBias>,
    pub logprobs: Option<bool>,
    pub max_completion_tokens: Option<u32>,
    pub max_tokens: Option<u32>,
    pub metadata: Option<Metadata>,
    pub modalities: Option<Vec<TextOrAudioModality>>,
    pub moderation: Option<ModerationConfig>,
    pub n: Option<u32>,
    pub parallel_tool_calls: Option<bool>,
    pub prediction: Option<PredictionContent>,
    pub presence_penalty: Option<f64>,
    pub prompt_cache_key: Option<String>,
    pub prompt_cache_options: Option<PromptCacheOptions>,
    pub prompt_cache_retention: Option<PromptCacheRetention>,
    pub reasoning_effort: Option<ReasoningEffort>,
    pub response_format: Option<ChatResponseFormat>,
    pub safety_identifier: Option<String>,
    pub seed: Option<i64>,
    pub service_tier: Option<ServiceTier>,
    pub stop: Option<StringOrList>,
    pub store: Option<bool>,
    pub stream: Option<bool>,
    pub stream_options: Option<StreamOptions>,
    pub temperature: Option<f64>,
    pub tool_choice: Option<ChatToolChoice>,
    pub tools: Option<Vec<ChatTool>>,
    pub top_logprobs: Option<u32>,
    pub top_p: Option<f64>,
    pub user: Option<String>,
    pub verbosity: Option<Verbosity>,
    pub web_search_options: Option<ChatWebSearchOptions>,
    pub extra: Extra,
}

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.

messages: Vec<ChatCompletionMessageParam>

model: OpenAiModelId

audio: Option<ChatAudioParam>

frequency_penalty: Option<f64>

function_call: Option<LegacyFunctionCallChoice>

functions: Option<Vec<LegacyFunctionDefinition>>

logit_bias: Option<LogitBias>

logprobs: Option<bool>

max_completion_tokens: Option<u32>

max_tokens: Option<u32>

metadata: Option<Metadata>

modalities: Option<Vec<TextOrAudioModality>>

moderation: Option<ModerationConfig>

n: Option<u32>

parallel_tool_calls: Option<bool>

prediction: Option<PredictionContent>

presence_penalty: Option<f64>

prompt_cache_key: Option<String>

prompt_cache_options: Option<PromptCacheOptions>

prompt_cache_retention: Option<PromptCacheRetention>

reasoning_effort: Option<ReasoningEffort>

response_format: Option<ChatResponseFormat>

safety_identifier: Option<String>

seed: Option<i64>

service_tier: Option<ServiceTier>

stop: Option<StringOrList>

store: Option<bool>

stream: Option<bool>

stream_options: Option<StreamOptions>

temperature: Option<f64>

tool_choice: Option<ChatToolChoice>

tools: Option<Vec<ChatTool>>

top_logprobs: Option<u32>

top_p: Option<f64>

user: Option<String>

verbosity: Option<Verbosity>

web_search_options: Option<ChatWebSearchOptions>

extra: Extra

Implementations

impl ChatCompletionRequest

pub fn builder() -> WireChatCompletionRequestBuilder

Trait Implementations

impl Clone for ChatCompletionRequest

fn clone(&self) -> ChatCompletionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatCompletionRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatCompletionRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChatCompletionRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ChatCompletionRequest

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 ChatCompletionRequest