Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rusty-libraries/rusty-openai
An unofficial OpenAI wrapper that supports image inputs
https://github.com/rusty-libraries/rusty-openai
openai openai-wrapper rust
Last synced: 6 days ago
JSON representation
An unofficial OpenAI wrapper that supports image inputs
- Host: GitHub
- URL: https://github.com/rusty-libraries/rusty-openai
- Owner: rusty-libraries
- License: mit
- Created: 2024-08-07T08:45:40.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-16T14:10:12.000Z (about 1 month ago)
- Last Synced: 2025-01-09T04:30:31.396Z (14 days ago)
- Topics: openai, openai-wrapper, rust
- Language: Rust
- Homepage: https://rusty-libraries.github.io/rusty-openai/
- Size: 99.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# OpenAI Rust SDK
  
> [!NOTE]
> This is an unofficial OpenAI SDK for Rust, providing a convenient abstraction over OpenAI's API. It enables you to easily perform tasks such as generating completions, creating and editing images, moderating text, fine-tuning models, and more.
## Table of Contents
- [OpenAI Rust SDK](#openai-rust-sdk)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Initialize OpenAI Client](#initialize-openai-client)
- [Generate Chat Completions](#generate-chat-completions)
- [Features](#features)
- [Documentation](#documentation)
- [License](#license)
## Installation
> [!TIP]
> Make sure you have Rust and Cargo installed on your system before proceeding. Visit [rust-lang.org](https://www.rust-lang.org/tools/install) for installation instructions.
To use this SDK, add the following dependencies to your `Cargo.toml` file:
```toml
[dependencies]
rusty-openai = "0.1.11"
serde_json = "1.0"
tokio = { version = "1", features = ["full"] }
reqwest = { version = "0.12.5", features = ["json", "multipart"] }
```
## Getting Started
To get started with the OpenAI Rust SDK, follow these steps:
### Initialize OpenAI Client
> [!IMPORTANT]
> You'll need an OpenAI API key to use this SDK. Get your API key from the [OpenAI dashboard](https://platform.openai.com/api-keys).
First, create an instance of the `OpenAI` struct with your API key:
```rust
use rusty_openai::openai::OpenAI;
#[tokio::main]
async fn main() {
let openai = OpenAI::new("YOUR_API_KEY", "https://api.openai.com/v1");
}
```
### Generate Chat Completions
> [!NOTE]
> The SDK now supports structured outputs with JSON Schema validation, allowing for more controlled and predictable responses.
Here's an example of generating chat completions with structured output:
```rust
use rusty_openai::openai::OpenAI;
use rusty_openai::openai_api::completion::ChatCompletionRequest;
use serde_json::json;
use std::env;
#[tokio::main]
async fn main() {
let api_key = env::var("OPENAI_API_KEY").expect("API key not set");
let openai = OpenAI::new(&api_key, "https://api.openai.com/v1");
// Example with structured outputs using JSON Schema
let schema = json!({
"type": "object",
"properties": {
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"explanation": {"type": "string"},
"output": {"type": "string"}
},
"required": ["explanation", "output"]
}
},
"final_answer": {"type": "string"}
},
"required": ["steps", "final_answer"]
});
let messages = vec![
json!({
"role": "user",
"content": "Solve this equation: 2x + 5 = 13"
})
];
let request = ChatCompletionRequest::new_json_schema(
"gpt-4-0125-preview".to_string(),
messages,
"math_reasoning".to_string(),
schema
)
.temperature(0.7);
let chat_response = openai.completions().create(request).await;
match chat_response {
Ok(chat) => println!("{}", json!(chat).to_string()),
Err(err) => eprintln!("Error: {}", err),
}
}
```
## Features
> [!TIP]
> The SDK supports all major OpenAI API endpoints and features:
- 🤖 Chat Completions with GPT-4 and GPT-3.5
- 🎨 Image Generation and Editing (DALL·E)
- 📝 Text Moderation
- 🔄 Fine-tuning Models
- 🔍 Embeddings Generation
- 📊 Structured Outputs with JSON Schema
- 🌐 Custom Base URL Support
- ⚡ Async/Await Support
- 🔒 Type-safe API
## Documentation
> [!NOTE]
> For detailed information on all available endpoints and their respective methods, please refer to the [SDK Documentation](https://pleaseful.github.io/rusty-openai/).
## License
> [!IMPORTANT]
> This SDK is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.