3 releases

0.1.2 Mar 30, 2023
0.1.1 Mar 30, 2023
0.1.0 Mar 30, 2023

#46 in #openai-api

Download history 106/week @ 2024-02-19 36/week @ 2024-02-26 5/week @ 2024-03-04 10/week @ 2024-03-11 61/week @ 2024-04-01

72 downloads per month

MIT license

32KB
775 lines

ChatGPT API Rust Library

Crates.io GitHub

Overview

This Rust library provides a simple and efficient way to interact with the ChatGPT API, which is a state-of-the-art NLP platform that can generate human-like responses to text queries. The library provides a convenient interface for sending requests and receiving responses from the ChatGPT API, allowing developers to easily integrate the API into their Rust-based projects.

Features

  • Easy-to-use API for sending requests and receiving responses.

  • Provides responses in multiple formats, including text and JSON.

  • Supports multiple endpoints and response languages.

    API Support
    Models ✔️
    Completions ✔️
    Chat ✔️
    Edits ✔️
    Images ✔️
    Embeddings ✔️
    Audio ✔️

Getting Started

To get started, you will need an API key from OpenAI. You can obtain an API key by visiting the OpenAI API page and following the instructions there.

Once you have an API key, you can install the library using Cargo:

Installation

To use this library, add the following to your Cargo.toml file:

[dependencies]
openai_chatgpt_api = "0.1"

Then, add the following to your Rust code:

use openai_chatgpt_api::ChatGPT;
let chatgpt = ChatGpt::new("YOUR_API_KEY_HERE");
let request = ChatGptRequestChatCompletions::new(
    "gpt-3.5-turbo",
    vec![
        ChatGptChatFormat::new_system("Rust OSS開発者"),
        ChatGptChatFormat::new_user("ChatGPT API のRustライブラリを作ったのでエンジニアが好みそうなReadmeを作って欲しい。"),
    ]
);

let res = chatgpt.chat_completions(&request).await.unwrap();
println!("{:?}", response);

You can replace "YOUR_API_KEY_HERE" with your actual API key, which can be obtained from the ChatGPT API website.

Usage

Creating a New ChatGPT Object

To use the ChatGPT API Rust library, you first need to create a new ChatGPT object. You can do this using the following code:

use openai_chatgpt_api::ChatGPT;
let chatgpt = ChatGpt::new("YOUR_API_KEY_HERE");

Replace "YOUR_API_KEY_HERE" with your actual API key.

Models List

Here is an example of how to use the models_list method to retrieve a list of all available models:

let models = chatgpt.models_list().await.unwrap();
let value = models.to_value();

Models Retrieve

let model = .models_retrieve("text-davinci-003").await;
let value = model.to_value();

Chatting

Here is an example of how to use the library to chat with the ChatGPT API:

let request = ChatGptRequestChatCompletions::new(
    "gpt-3.5-turbo",
    vec![
        ChatGptChatFormat::new_system("Rust OSS開発者"),
        ChatGptChatFormat::new_user("ChatGPT API のRustライブラリを作ったのでエンジニアが好みそうなReadmeを作って欲しい。"),
    ]
);

let res = chatgpt.chat_completions(&request).await.unwrap();
println!("{:?}", response.to_value());

Contributing

Pull requests are welcome! If you have any questions or issues, please open an issue on the GitHub repository.

License

This library is licensed under the MIT License. See the LICENSE file for details.

Dependencies

~4–19MB
~261K SLoC