Struct EditArguments

pub struct EditArguments {
    pub model: String,
    pub input: Option<String>,
    pub instruction: String,
    pub n: Option<u32>,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
}

👎Deprecated: Use the chat api instead

Request arguments for edits.

See https://platform.openai.com/docs/api-reference/edits/create.

openai_rust::edits::EditArguments::new(
    "text-davinci-edit-001",
    "The quick brown fox".to_owned(),
    "Complete this sentence.".to_owned()
);

Fields

model: String

👎Deprecated: Use the chat api instead

ID of the model to use. You can use the text-davinci-edit-001 or code-davinci-edit-001 model with this endpoint.

input: Option<String>

👎Deprecated: Use the chat api instead

The input text to use as a starting point for the edit.

instruction: String

👎Deprecated: Use the chat api instead

The instruction that tells the model how to edit the prompt.

n: Option<u32>

👎Deprecated: Use the chat api instead

temperature: Option<f32>

👎Deprecated: Use the chat api instead

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.

top_p: Option<f32>

👎Deprecated: Use the chat api instead

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.

Implementations

impl EditArguments

pub fn new( model: impl AsRef<str>, input: String, instruction: String, ) -> EditArguments

👎Deprecated: Use the chat api instead

Trait Implementations

impl Clone for EditArguments

fn clone(&self) -> EditArguments

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EditArguments

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

Formats the value using the given formatter.

impl Serialize for EditArguments

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

where __S: Serializer,

Serialize this value into the given Serde serializer.