openai/models/
create_chat_completion_request.rs

1/*
2 * OpenAI API
3 *
4 * APIs for sampling from and fine-tuning language models
5 *
6 * The version of the OpenAPI document: 1.2.0
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11
12
13
14#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
15pub struct CreateChatCompletionRequest {
16    /// ID of the model to use. Currently, only `gpt-3.5-turbo` and `gpt-3.5-turbo-0301` are supported.
17    #[serde(rename = "model")]
18    pub model: String,
19    /// The messages to generate chat completions for, in the [chat format](/docs/guides/chat/introduction).
20    #[serde(rename = "messages")]
21    pub messages: Vec<crate::models::ChatCompletionRequestMessage>,
22    /// 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. 
23    #[serde(rename = "temperature", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
24    pub temperature: Option<Option<f32>>,
25    /// 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. 
26    #[serde(rename = "top_p", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
27    pub top_p: Option<Option<f32>>,
28    /// How many chat completion choices to generate for each input message.
29    #[serde(rename = "n", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
30    pub n: Option<Option<i32>>,
31    /// If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. 
32    #[serde(rename = "stream", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
33    pub stream: Option<Option<bool>>,
34    #[serde(rename = "stop", skip_serializing_if = "Option::is_none")]
35    pub stop: Option<Box<crate::models::CreateChatCompletionRequestStop>>,
36    /// The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens). 
37    #[serde(rename = "max_tokens", skip_serializing_if = "Option::is_none")]
38    pub max_tokens: Option<i32>,
39    /// Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.  [See more information about frequency and presence penalties.](/docs/api-reference/parameter-details) 
40    #[serde(rename = "presence_penalty", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
41    pub presence_penalty: Option<Option<f32>>,
42    /// Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.  [See more information about frequency and presence penalties.](/docs/api-reference/parameter-details) 
43    #[serde(rename = "frequency_penalty", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
44    pub frequency_penalty: Option<Option<f32>>,
45    /// Modify the likelihood of specified tokens appearing in the completion.  Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. 
46    #[serde(rename = "logit_bias", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
47    pub logit_bias: Option<Option<serde_json::Value>>,
48    /// A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids). 
49    #[serde(rename = "user", skip_serializing_if = "Option::is_none")]
50    pub user: Option<String>,
51}
52
53impl CreateChatCompletionRequest {
54    pub fn new(model: String, messages: Vec<crate::models::ChatCompletionRequestMessage>) -> CreateChatCompletionRequest {
55        CreateChatCompletionRequest {
56            model,
57            messages,
58            temperature: None,
59            top_p: None,
60            n: None,
61            stream: None,
62            stop: None,
63            max_tokens: None,
64            presence_penalty: None,
65            frequency_penalty: None,
66            logit_bias: None,
67            user: None,
68        }
69    }
70}
71
72
openai/models/create_chat_completion_request.rs

openai/models/
create_chat_completion_request.rs
