Struct async_openai::types::CreateEditRequestArgs

pub struct CreateEditRequestArgs { /* private fields */ }

Builder for CreateEditRequest.

Implementations

impl CreateEditRequestArgs

pub fn model<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

pub fn input<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

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

pub fn instruction<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

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

pub fn n<VALUE: Into<u8>>(&mut self, value: VALUE) -> &mut Self

How many edits to generate for the input and instruction.

pub fn temperature<VALUE: Into<f32>>(&mut self, value: VALUE) -> &mut Self

What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer.

We generally recommend altering this or top_p but not both.

pub fn top_p<VALUE: Into<f32>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn build(&self) -> Result<CreateEditRequest, OpenAIError>

Builds a new CreateEditRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for CreateEditRequestArgs

fn clone(&self) -> CreateEditRequestArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateEditRequestArgs

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

Formats the value using the given formatter.

impl Default for CreateEditRequestArgs

fn default() -> Self

Returns the “default value” for a type.