Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/uiuifree/rust-openai-chatgpt-api

"rust-openai-chatgpt-api" is a Rust library for accessing the ChatGPT API, a powerful NLP platform by OpenAI. The library provides a simple and efficient interface for sending requests and receiving responses, including chat. It uses reqwest and serde for HTTP requests and JSON serialization.
https://github.com/uiuifree/rust-openai-chatgpt-api

Last synced: 16 days ago
JSON representation

"rust-openai-chatgpt-api" is a Rust library for accessing the ChatGPT API, a powerful NLP platform by OpenAI. The library provides a simple and efficient interface for sending requests and receiving responses, including chat. It uses reqwest and serde for HTTP requests and JSON serialization.

Awesome Lists containing this project

README 

        
# ChatGPT API Rust Library



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

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



## 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](https://platform.openai.com/docs/api-reference/authentication) 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:



```toml

[dependencies]

openai_chatgpt_api = "0.1"

```



Then, add the following to your Rust code:



```rust

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:



```rust

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:



```rust

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

let value = models.to_value();

```



### Models Retrieve



```rust

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:



```rust

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](https://github.com/uiuifree/rust-openai-chatgpt-api).



## License

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