Struct CreateCompletionRequestArgs

pub struct CreateCompletionRequestArgs { /* private fields */ }

Builder for CreateCompletionRequest.

Implementations

impl CreateCompletionRequestArgs

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 prompt<VALUE: Into<Prompt>>(&mut self, value: VALUE) -> &mut Self

The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.

Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.

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

The suffix that comes after a completion of inserted text.

This parameter is only supported for gpt-3.5-turbo-instruct.

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

The maximum number of tokens that can be generated in the completion.

The token count of your prompt plus max_tokens cannot exceed the model’s context length. Example Python code for counting tokens.

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

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.

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 n<VALUE: Into<u8>>(&mut self, value: VALUE) -> &mut Self

How many completions to generate for each prompt. Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop.

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

Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message.

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

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

Include the log probabilities on the logprobs most likely output tokens, as well the chosen tokens. For example, if logprobs is 5, the API will return a list of the 5 most likely tokens. The API will always return the logprob of the sampled token, so there may be up to logprobs+1 elements in the response.

The maximum value for logprobs is 5.

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

Echo back the prompt in addition to the completion

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

Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.

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

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.

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

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.

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

Generates best_of completions server-side and returns the “best” (the one with the highest log probability per token). Results cannot be streamed.

When used with n, best_of controls the number of candidate completions and n specifies how many to return – best_of must be greater than n.

Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop.

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

Modify the likelihood of specified tokens appearing in the completion.

Accepts a json object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this tokenizer tool (which works for both GPT-2 and GPT-3) to convert text to token IDs. 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.

As an example, you can pass {"50256": -100} to prevent the <|endoftext|> token from being generated.

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

A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse. Learn more.

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

If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.

Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.

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

Builds a new CreateCompletionRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for CreateCompletionRequestArgs

fn clone(&self) -> CreateCompletionRequestArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCompletionRequestArgs

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

Formats the value using the given formatter.

impl Default for CreateCompletionRequestArgs

fn default() -> Self

Returns the “default value” for a type.