Struct ChatCompletionRequest 

pub struct ChatCompletionRequest {

    pub model: String,
    pub messages: Vec<ChatCompletionRequestMessage>,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub max_tokens: Option<i32>,
    pub n: Option<i32>,
    pub stop: Option<Vec<String>>,
    pub stream: Option<bool>,
    pub system_prompt: Option<String>,
    pub user: Option<String>,
    pub tools: Option<Vec<ChatCompletionTool>>,
    pub tool_choice: Option<ToolChoiceOption>,
    pub response_format: Option<ChatCompletionResponseFormat>,
    pub seed: Option<i64>,
    pub logit_bias: Option<Value>,
    pub logprobs: Option<bool>,
    pub top_logprobs: Option<i32>,
}

Represents a chat completion request.

Used By

• api::responses::Responses::create

Fields

model: String

ID of the model to use.

messages: Vec<ChatCompletionRequestMessage>

A list of messages comprising the conversation so far.

temperature: Option<f32>

What sampling temperature to use, between 0 and 2.

top_p: Option<f32>

An alternative to sampling with temperature, called nucleus sampling.

max_tokens: Option<i32>

The maximum number of tokens to generate in the chat completion.

n: Option<i32>

Number of chat completion choices to generate for each input message.

stop: Option<Vec<String>>

Up to 4 sequences where the API will stop generating further tokens.

stream: Option<bool>

Whether to stream back partial progress.

system_prompt: Option<String>

The system prompt that helps guide the behavior of the model.

user: Option<String>

A unique identifier representing your end-user.

tools: Option<Vec<ChatCompletionTool>>

A list of tools the model may call.

tool_choice: Option<ToolChoiceOption>

Controls which (if any) tool the model calls.

response_format: Option<ChatCompletionResponseFormat>

An object specifying the format that the model must output.

seed: Option<i64>

This feature is in Beta.

logit_bias: Option<Value>

Adjusts the likelihood of specified tokens appearing in the completion.

logprobs: Option<bool>

Log probability of the most likely tokens.

top_logprobs: Option<i32>

The number of most likely tokens to return at each token position.

Implementations

impl ChatCompletionRequest

pub fn former() -> ChatCompletionRequestFormer<ChatCompletionRequestFormerDefinition<(), ChatCompletionRequest, ReturnPreformed>>

Provides a mechanism to initiate the formation process with a default completion behavior.

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<__Context, __Formed, __End> EntityToDefinition<__Context, __Formed, __End> for ChatCompletionRequest

where __End: FormingEnd<ChatCompletionRequestFormerDefinitionTypes<__Context, __Formed>>,

type Definition = ChatCompletionRequestFormerDefinition<__Context, __Formed, __End>

The specific FormerDefinition associated with this entity.

type Types = ChatCompletionRequestFormerDefinitionTypes<__Context, __Formed>

The specific FormerDefinitionTypes associated with this entity.

impl<__Context, __Formed> EntityToDefinitionTypes<__Context, __Formed> for ChatCompletionRequest

type Types = ChatCompletionRequestFormerDefinitionTypes<__Context, __Formed>

Specifies the FormerDefinitionTypes that define the storage, formed entity, and context types used during formation.

impl<Definition> EntityToFormer<Definition> for ChatCompletionRequest

where Definition: FormerDefinition<Storage = ChatCompletionRequestFormerStorage>,

type Former = ChatCompletionRequestFormer<Definition>

The type of the former (builder) used for constructing the entity.

fn __f(_: &Definition)

A placeholder function to reference the definition without operational logic.

impl EntityToStorage for ChatCompletionRequest

type Storage = ChatCompletionRequestFormerStorage

The storage type used for forming the entity.

impl PartialEq for ChatCompletionRequest

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for ChatCompletionRequest

Implement Validate for ChatCompletionRequest

fn validate(&self) -> Result<(), Vec<ValidationError>>

Validate the request parameters

impl StructuralPartialEq for ChatCompletionRequest