https://github.com/openai-rs/openai-api

A simple Rust library for OpenAI API, free from complex async operations and redundant dependencies.
https://github.com/openai-rs/openai-api

chatgpt chatgpt-api openai openai-api rust

Last synced: 5 days ago
JSON representation

A simple Rust library for OpenAI API, free from complex async operations and redundant dependencies.

• Host: GitHub
• URL: https://github.com/openai-rs/openai-api
• Owner: openai-rs
• License: mit
• Created: 2023-03-21T14:33:27.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-25T08:16:52.000Z (6 months ago)
• Last Synced: 2024-12-11T04:39:59.394Z (12 days ago)
• Topics: chatgpt, chatgpt-api, openai, openai-api, rust
• Language: Rust
• Homepage:
• Size: 558 KB
• Stars: 108
• Watchers: 2
• Forks: 14
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OpenAI API for Rust

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/openai-rs/openai-api/rust.yml?style=flat-square)](https://github.com/openai-rs/openai-api/actions)

[![Crates.io](https://img.shields.io/crates/v/openai_api_rust?style=flat-square)](https://crates.io/crates/openai_api_rust/versions)

[![Crates.io](https://img.shields.io/crates/d/openai_api_rust?style=flat-square)](https://crates.io/crates/openai_api_rust)

[![GitHub](https://img.shields.io/github/license/openai-rs/openai-api?style=flat-square)](https://github.com/openai-rs/openai-api/blob/main/LICENSE)

A community-maintained library provides a simple and convenient way to interact with the OpenAI API.

No complex async and redundant dependencies.

## API

check [official API reference](https://platform.openai.com/docs/api-reference)

|API|Support|

|---|---|

|Models|✔️|

|Completions|✔️|

|Chat|✔️|

|Images|✔️|

|Embeddings|✔️|

|Audio|✔️|

|Files|❌|

|Fine-tunes|❌|

|Moderations|❌|

|Engines|❌|

___

## Usage

Add the following to your Cargo.toml file:

```toml

openai_api_rust = "0.1.9"

```

Export your API key into the environment variables

```bash

export OPENAI_API_KEY=

```

Then use the crate in your Rust code:

```rust

use openai_api_rust::*;

use openai_api_rust::chat::*;

use openai_api_rust::completions::*;

fn main() {

    // Load API key from environment OPENAI_API_KEY.

    // You can also hadcode through `Auth::new()`, but it is not recommended.

    let auth = Auth::from_env().unwrap();

    let openai = OpenAI::new(auth, "https://api.openai.com/v1/");

    let body = ChatBody {

        model: "gpt-3.5-turbo".to_string(),

        max_tokens: Some(7),

        temperature: Some(0_f32),

        top_p: Some(0_f32),

        n: Some(2),

        stream: Some(false),

        stop: None,

        presence_penalty: None,

        frequency_penalty: None,

        logit_bias: None,

        user: None,

        messages: vec![Message { role: Role::User, content: "Hello!".to_string() }],

    };

    let rs = openai.chat_completion_create(&body);

    let choice = rs.unwrap().choices;

    let message = &choice[0].message.as_ref().unwrap();

    assert!(message.content.contains("Hello"));

}

```

### Use proxy

Load proxy from env

```rust

let openai = OpenAI::new(auth, "https://api.openai.com/v1/")

        .use_env_proxy();

```

Set the proxy manually

```rust

let openai = OpenAI::new(auth, "https://api.openai.com/v1/")

        .set_proxy("http://127.0.0.1:1080");

```

## License

This library is distributed under the terms of the MIT license. See [LICENSE](LICENSE) for details.