fieri

Note: fieri's master branch might contain breaking changes. For the most recently released code, look to the latest tag.

Overview

Unofficial Rust client for the OpenAI's API.

fieri provides an asynchronous Rust interface for interacting with the OpenAI API, allowing you to easily use OpenAI's state-of-the-art machine learning models in your Rust projects.

Features

models - [x] [list](https://docs.rs/fieri/latest/fieri/model/fn.list.html) - [x] [retrieve](https://docs.rs/fieri/latest/fieri/model/fn.retrieve.html)

completions - [x] [create](https://docs.rs/fieri/latest/fieri/completion/fn.create.html) - [ ] create with stream

edits - [x] [create](https://docs.rs/fieri/latest/fieri/edit/fn.create.html)

images - [x] [create image](https://docs.rs/fieri/latest/fieri/image/fn.generate.html) - [x] [create image edit](https://docs.rs/fieri/latest/fieri/image/fn.edit.html) - [x] [create image variation](https://docs.rs/fieri/latest/fieri/image/fn.variate.html)

embeddings - [x] [create](https://docs.rs/fieri/latest/fieri/embedding/fn.create.html)

files - [x] [list](https://docs.rs/fieri/latest/fieri/file/fn.list.html) - [x] [upload](https://docs.rs/fieri/latest/fieri/file/fn.upload.html) - [x] [delete](https://docs.rs/fieri/latest/fieri/file/fn.delete.html) - [x] [retrieve](https://docs.rs/fieri/latest/fieri/file/fn.retrieve.html) - [ ] retrieve content

fine-tunes - [x] [create](https://docs.rs/fieri/latest/fieri/finetune/fn.create.html) - [x] [list](https://docs.rs/fieri/latest/fieri/finetune/fn.list.html) - [x] [retrieve](https://docs.rs/fieri/latest/fieri/finetune/fn.retrieve.html) - [x] [cancel](https://docs.rs/fieri/latest/fieri/finetune/fn.cancel.html) - [x] [list events](https://docs.rs/fieri/latest/fieri/finetune/fn.listevents.html) - [ ] list events with stream - [x] [delete](https://docs.rs/fieri/latest/fieri/fine_tune/fn.delete.html)

moderations - [x] [create](https://docs.rs/fieri/latest/fieri/moderation/fn.create.html)

/engines - DEPRECATED

Prerequisites

Before you can use the Rust Client for OpenAI, you'll need to sign up for an API key at the OpenAI Developer Portal. Once you've signed up, you'll be able to find your API key in the API Keys section of the developer portal.

Installation

To use the client in your project, add the following to your Cargo.toml file: toml [dependencies] fieri = "0.3"

Basic Usage

Generate an image based on a prompt and save it locally.

```rust use std::env; use fieri::{ Client, Error, image::{ImageSize, GenerateImageParamBuilder, generate}, };

[tokio::main]

async fn main() -> Result<(), Error> { let client = Client::new(env::var("OPENAIAPIKEY")?);

let param = GenerateImageParamBuilder::new("A bunch of cats dancing tango on the top of the highest mountain on Mars.")
    .size(ImageSize::S1024x1024)
    .n(1)
    .build()?;

generate(&client, &param)
    .await?
    .save("/tmp/")
    .await?;

Ok(())

} } ```

Generate text based on a prompt

```rust use std::env; use fieri::{ Client, Error, completion::{CompletionParamBuilder, create} };

[tokio::main]

async fn main() -> std::result::Result<(), Error> { let client = Client::new(env::var("OPENAIAPIKEY")?);

let param = CompletionParamBuilder::new("ada")
    .prompt("Generate a plot for an absurd interstellar parody.")
    .max_tokens(500)
    .temperature(0.9)
    .top_p(1.0)
    .frequency_penalty(0.0)
    .presence_penalty(0.0)
    .build()?;

let resp = create(&client, &param).await?;
println!("Generated text: {:#?}", resp);

Ok(())

} ```

Examples for each implemented endpoint can be found in the docs.

Documentation

fieri Documentation

The official OpenAI documentation

Limitations

Note that the Rust Client for OpenAI is provided as-is, and is not officially supported by OpenAI. While we will do our best to keep the library up-to-date and bug-free, we cannot guarantee that it will always work as expected.

Additionally, the API has usage limits that may affect your ability to use the models. You can view your current usage and limits in the Usage section of your account.

License

fieri is provided under the MIT license. See LICENSE.