Struct CompletionRequest

pub struct CompletionRequest {

    pub model: Model,
    pub prompt: String,
    pub suffix: Option<String>,
    pub max_tokens: Option<i32>,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub n: Option<i32>,
    pub stream: Option<bool>,
    pub logprobs: Option<i32>,
    pub echo: Option<bool>,
    pub stop: Option<Vec<String>>,
    pub presence_penalty: Option<f32>,
    pub frequency_penalty: Option<f32>,
    pub best_of: Option<i32>,
    pub logit_bias: Option<HashMap<String, i32>>,
    pub user: Option<String>,
}

Represents a request to generate text completions.

Fields

model: Model

Model to be used for generating completions.

prompt: String

Prompt for generating the completions.

suffix: Option<String>

Optional suffix that comes after the generated text.

max_tokens: Option<i32>

Optional maximum number of tokens to generate.

temperature: Option<f32>

Optional temperature setting for sampling.

top_p: Option<f32>

Optional top-p setting for nucleus sampling.

n: Option<i32>

Optional number of completions to generate.

stream: Option<bool>

Optional flag to stream the completions.

logprobs: Option<i32>

Optional number of log probabilities to return.

echo: Option<bool>

Optional flag to echo the prompt in the response.

stop: Option<Vec<String>>

Optional sequences where the generation will stop.

presence_penalty: Option<f32>

Optional penalty for presence of tokens.

frequency_penalty: Option<f32>

Optional penalty for frequency of tokens.

best_of: Option<i32>

Optional number of best completions to return.

logit_bias: Option<HashMap<String, i32>>

Optional bias for log probabilities of specific tokens.

user: Option<String>

Optional user identifier.

Implementations

impl CompletionRequest

pub fn new(model: Model, prompt: String) -> Self

Creates a new CompletionRequest with the specified model and prompt.

Examples found in repository

examples/completion.rs (lines 11-14)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::from_env().unwrap();

    let req = CompletionRequest::new(
        Model::GPT3(GPT3::GPT35Turbo),
        String::from("What is Bitcoin?"),
    )
    .max_tokens(3000)
    .temperature(0.9)
    .top_p(1.0)
    .stop(vec![String::from(" Human:"), String::from(" AI:")])
    .presence_penalty(0.6)
    .frequency_penalty(0.0);

    let result = client.completion(req).await?;
    println!("{:}", result.choices[0].text);

    Ok(())
}

impl CompletionRequest

pub fn suffix(self, suffix: String) -> Self

Sets the value of the specified field.

pub fn max_tokens(self, max_tokens: i32) -> Self

Sets the value of the specified field.

Examples found in repository

examples/completion.rs (line 15)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::from_env().unwrap();

    let req = CompletionRequest::new(
        Model::GPT3(GPT3::GPT35Turbo),
        String::from("What is Bitcoin?"),
    )
    .max_tokens(3000)
    .temperature(0.9)
    .top_p(1.0)
    .stop(vec![String::from(" Human:"), String::from(" AI:")])
    .presence_penalty(0.6)
    .frequency_penalty(0.0);

    let result = client.completion(req).await?;
    println!("{:}", result.choices[0].text);

    Ok(())
}

pub fn temperature(self, temperature: f32) -> Self

Sets the value of the specified field.

Examples found in repository

examples/completion.rs (line 16)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::from_env().unwrap();

    let req = CompletionRequest::new(
        Model::GPT3(GPT3::GPT35Turbo),
        String::from("What is Bitcoin?"),
    )
    .max_tokens(3000)
    .temperature(0.9)
    .top_p(1.0)
    .stop(vec![String::from(" Human:"), String::from(" AI:")])
    .presence_penalty(0.6)
    .frequency_penalty(0.0);

    let result = client.completion(req).await?;
    println!("{:}", result.choices[0].text);

    Ok(())
}

pub fn top_p(self, top_p: f32) -> Self

Sets the value of the specified field.

Examples found in repository

examples/completion.rs (line 17)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::from_env().unwrap();

    let req = CompletionRequest::new(
        Model::GPT3(GPT3::GPT35Turbo),
        String::from("What is Bitcoin?"),
    )
    .max_tokens(3000)
    .temperature(0.9)
    .top_p(1.0)
    .stop(vec![String::from(" Human:"), String::from(" AI:")])
    .presence_penalty(0.6)
    .frequency_penalty(0.0);

    let result = client.completion(req).await?;
    println!("{:}", result.choices[0].text);

    Ok(())
}

pub fn n(self, n: i32) -> Self

Sets the value of the specified field.

pub fn stream(self, stream: bool) -> Self

Sets the value of the specified field.

pub fn logprobs(self, logprobs: i32) -> Self

Sets the value of the specified field.

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

Sets the value of the specified field.

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

Sets the value of the specified field.

Examples found in repository

examples/completion.rs (line 18)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::from_env().unwrap();

    let req = CompletionRequest::new(
        Model::GPT3(GPT3::GPT35Turbo),
        String::from("What is Bitcoin?"),
    )
    .max_tokens(3000)
    .temperature(0.9)
    .top_p(1.0)
    .stop(vec![String::from(" Human:"), String::from(" AI:")])
    .presence_penalty(0.6)
    .frequency_penalty(0.0);

    let result = client.completion(req).await?;
    println!("{:}", result.choices[0].text);

    Ok(())
}

pub fn presence_penalty(self, presence_penalty: f32) -> Self

Sets the value of the specified field.

Examples found in repository

examples/completion.rs (line 19)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::from_env().unwrap();

    let req = CompletionRequest::new(
        Model::GPT3(GPT3::GPT35Turbo),
        String::from("What is Bitcoin?"),
    )
    .max_tokens(3000)
    .temperature(0.9)
    .top_p(1.0)
    .stop(vec![String::from(" Human:"), String::from(" AI:")])
    .presence_penalty(0.6)
    .frequency_penalty(0.0);

    let result = client.completion(req).await?;
    println!("{:}", result.choices[0].text);

    Ok(())
}

pub fn frequency_penalty(self, frequency_penalty: f32) -> Self

Sets the value of the specified field.

Examples found in repository

examples/completion.rs (line 20)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::from_env().unwrap();

    let req = CompletionRequest::new(
        Model::GPT3(GPT3::GPT35Turbo),
        String::from("What is Bitcoin?"),
    )
    .max_tokens(3000)
    .temperature(0.9)
    .top_p(1.0)
    .stop(vec![String::from(" Human:"), String::from(" AI:")])
    .presence_penalty(0.6)
    .frequency_penalty(0.0);

    let result = client.completion(req).await?;
    println!("{:}", result.choices[0].text);

    Ok(())
}

pub fn best_of(self, best_of: i32) -> Self

Sets the value of the specified field.

pub fn logit_bias(self, logit_bias: HashMap<String, i32>) -> Self

Sets the value of the specified field.

pub fn user(self, user: String) -> Self

Sets the value of the specified field.

Trait Implementations

impl Clone for CompletionRequest

fn clone(&self) -> CompletionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompletionRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CompletionRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.