Struct CompletionArgsBuilder

pub struct CompletionArgsBuilder { /* private fields */ }

Builder for CompletionArgs.

Implementations

impl CompletionArgsBuilder

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

The id of the engine to use for this request

Example

CompletionArgs::builder().engine("davinci");

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

The prompt to complete from.

Defaults to "<|endoftext|>" which is a special token seen during training.

Example

CompletionArgs::builder().prompt("Once upon a time...");

pub fn max_tokens(&self, value: u64) -> Self

Maximum number of tokens to complete.

Defaults to 16

Example

CompletionArgs::builder().max_tokens(64);

pub fn temperature(&self, value: f64) -> Self

What sampling temperature to use.

Default is 1.0

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.

OpenAI recommends altering this or top_p but not both.

Example

let builder = CompletionArgs::builder().temperature(0.7);
let args: CompletionArgs = builder.try_into()?;

pub fn top_p(&self, value: f64) -> Self

pub fn n(&self, value: u64) -> Self

pub fn logprobs(&self, value: u64) -> Self

pub fn echo(&self, value: bool) -> Self

pub fn stop(&self, value: Vec<String>) -> Self

pub fn presence_penalty(&self, value: f64) -> Self

pub fn frequency_penalty(&self, value: f64) -> Self

pub fn logit_bias(&self, value: HashMap<String, f64>) -> Self

pub fn build(&self) -> Result<CompletionArgs, CompletionArgsBuilderError>

Builds a new CompletionArgs.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for CompletionArgsBuilder

fn clone(&self) -> CompletionArgsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for CompletionArgsBuilder

fn default() -> Self

Returns the “default value” for a type.

impl TryFrom<CompletionArgsBuilder> for CompletionArgs

type Error = CompletionArgsBuilderError

The type returned in the event of a conversion error.

fn try_from(builder: CompletionArgsBuilder) -> Result<Self, Self::Error>

Performs the conversion.