Skip to main content

CompletionCreateParamsBase

Struct CompletionCreateParamsBase 

Source
pub struct CompletionCreateParamsBase {
Show 17 fields pub model: Option<String>, pub prompt: Value, pub best_of: Option<i64>, pub echo: Option<bool>, pub frequency_penalty: Option<f64>, pub logit_bias: Option<HashMap<String, i64>>, pub logprobs: Option<i64>, pub max_tokens: Option<i64>, pub n: Option<i64>, pub presence_penalty: Option<f64>, pub seed: Option<i64>, pub stop: Option<Value>, pub stream_options: Option<Value>, pub suffix: Option<String>, pub temperature: Option<f64>, pub top_p: Option<f64>, pub user: Option<String>,
}

Fields§

§model: Option<String>

ID of the model to use.

§prompt: Value

The prompt(s) to generate completions for, encoded as a string, array of

§best_of: Option<i64>

Generates best_of completions server-side and returns the “best” (the one with

§echo: Option<bool>

Echo back the prompt in addition to the completion

§frequency_penalty: Option<f64>

Number between -2.0 and 2.0.

§logit_bias: Option<HashMap<String, i64>>

Modify the likelihood of specified tokens appearing in the completion.

§logprobs: Option<i64>

Include the log probabilities on the logprobs most likely output tokens, as

§max_tokens: Option<i64>

The maximum number of tokens that can be generated in the

§n: Option<i64>

How many completions to generate for each prompt.

§presence_penalty: Option<f64>

Number between -2.0 and 2.0.

§seed: Option<i64>

If specified, our system will make a best effort to sample deterministically,

§stop: Option<Value>

Not supported with latest reasoning models o3 and o4-mini.

§stream_options: Option<Value>

Options for streaming response. Only set this when you set stream: true.

§suffix: Option<String>

The suffix that comes after a completion of inserted text.

§temperature: Option<f64>

What sampling temperature to use, between 0 and 2.

§top_p: Option<f64>

An alternative to sampling with temperature, called nucleus sampling, where the

§user: Option<String>

A unique identifier representing your end-user, which can help OpenAI to monitor

Trait Implementations§

Source§

impl Clone for CompletionCreateParamsBase

Source§

fn clone(&self) -> CompletionCreateParamsBase

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CompletionCreateParamsBase

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for CompletionCreateParamsBase

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for CompletionCreateParamsBase

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.