Adding `openai_api` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add openai-api

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

openai-api = "0.1.4"

The openai_api library will be automatically available globally. Read the openai_api library documentation.

Back to the crate overview.

Readme

openai-api-rust

A simple rust client for OpenAI API.

Has a few conveniences, but is mostly at the level of the API itself.

Installation

$ cargo add openai-api

Quickstart

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let api_token = std::env::var("OPENAI_SK")?;
    let client = openai_api::Client::new(&api_token);
    let prompt = String::from("Once upon a time,");
    println!(
        "{}{}",
        prompt,
        client.complete(prompt.as_str()).await?
    );
    Ok(())
}

Basic Usage

Creating a completion

For simple demos and debugging, you can do a completion and use the Display instance of a Completion object to convert it to a string:

let response = client.complete_prompt("Once upon a time").await?;
println!("{}", response);

To configure the prompt more explicitly, you can use the CompletionArgs builder:

let args = openai_api::api::CompletionArgs::builder()
        .prompt("Once upon a time,")
        .engine(Engine::Davinci)
        .max_tokens(20)
        .temperature(0.7)
        .top_p(0.9)
        .stop(vec!["\n".into()]);
let completion = client.complete_prompt(args).await?;
println!("Response: {}", response.choices[0].text);
println!("Model used: {}", response.model);

See examples/

Adding openai_api library as a dependency

Adding `openai_api` library as a dependency