5 releases
0.16.4 | Nov 23, 2023 |
---|---|
0.16.3 | Nov 16, 2023 |
0.16.2 | Nov 15, 2023 |
0.0.2 | Nov 13, 2023 |
0.0.1 | Nov 13, 2023 |
#1528 in Asynchronous
28 downloads per month
200KB
3.5K
SLoC
async-openai
Async Rust library for OpenAI
Logo created by this repo itself
Overview
async-openai
is an unofficial Rust library for OpenAI.
- It's based on OpenAI OpenAPI spec
- Current features:
- Assistants (Beta)
- Audio (Whisper/TTS)
- Chat
- Completions (Legacy)
- Edits (Deprecated)
- Embeddings
- Files
- Fine-Tuning
- Fine-Tunes (Deprecated)
- Images
- Microsoft Azure OpenAI Service
- Models
- Moderations
- Support SSE streaming on available APIs
- All requests including form submissions (except SSE streaming) are retried with exponential backoff when rate limited by the API server.
- Ergonomic builder pattern for all request objects.
Note on Azure OpenAI Service (AOS): async-openai
primarily implements OpenAI spec, and doesn't try to maintain parity with spec of AOS.
Usage
The library reads API key from the environment variable OPENAI_API_KEY
.
# On macOS/Linux
export OPENAI_API_KEY='sk-...'
# On Windows Powershell
$Env:OPENAI_API_KEY='sk-...'
- Visit examples directory on how to use
async-openai
. - Visit docs.rs/async-openai for docs.
Image Generation Example
use async_openai::{
types::{CreateImageRequestArgs, ImageSize, ResponseFormat},
Client,
};
use std::error::Error;
#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
// create client, reads OPENAI_API_KEY environment variable for API key.
let client = Client::new();
let request = CreateImageRequestArgs::default()
.prompt("cats on sofa and carpet in living room")
.n(2)
.response_format(ResponseFormat::Url)
.size(ImageSize::S256x256)
.user("async-openai")
.build()?;
let response = client.images().create(request).await?;
// Download and save images to ./data directory.
// Each url is downloaded and saved in dedicated Tokio task.
// Directory is created if it doesn't exist.
let paths = response.save("./data").await?;
paths
.iter()
.for_each(|path| println!("Image file path: {}", path.display()));
Ok(())
}
Scaled up for README, actual size 256x256
Contributing
Thank you for your time to contribute and improve the project, I'd be happy to have you!
A good starting point would be existing open issues.
License
This project is licensed under MIT license.
Dependencies
~12–25MB
~353K SLoC