Merge pull request tjardoo#27 from tjardoo/assistant

Assistants API

Author: tjardoo

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "openai_dive"
-version = "0.3.0"
+version = "0.3.1"
 edition = "2021"
 license = "MIT"
 description = "OpenAI Dive is an unofficial async Rust library that allows you to interact with the OpenAI API."

Cargo.toml

@@ -49,6 +49,8 @@ More information: [set API key](#set-api-key), [add proxy](#add-proxy), [use mod
  - [List fine tuning events](#list-fine-tuning-events)
 - Moderation
  - [Create moderation](#create-moderation)
+- Assistants
+ - [Assistants (beta)](#assistants-beta)
 
 ## Models
 
@@ -602,9 +604,9 @@ async fn main() {
 
  let client = Client::new(api_key);
 
- let file_name = env::var("FILE_NAME").expect("FILE_NAME is not set in the .env file.");
+ let file_id = env::var("FILE_ID").expect("FILE_ID is not set in the .env file.");
 
- let result = client.files().delete(&file_name).await.unwrap();
+ let result = client.files().delete(&file_id).await.unwrap();
 
  println!("{:?}", result);
 }
@@ -629,9 +631,9 @@ async fn main() {
 
  let client = Client::new(api_key);
 
- let file_name = env::var("FILE_NAME").expect("FILE_NAME is not set in the .env file.");
+ let file_id = env::var("FILE_ID").expect("FILE_ID is not set in the .env file.");
 
- let result = client.files().retrieve(&file_name).await.unwrap();
+ let result = client.files().retrieve(&file_id).await.unwrap();
 
  println!("{:?}", result);
 }
@@ -656,9 +658,9 @@ async fn main() {
 
  let client = Client::new(api_key);
 
- let file_name = env::var("FILE_NAME").expect("FILE_NAME is not set in the .env file.");
+ let file_id = env::var("FILE_ID").expect("FILE_ID is not set in the .env file.");
 
- let result = client.files().retrieve_content(&file_name).await.unwrap();
+ let result = client.files().retrieve_content(&file_id).await.unwrap();
 
  println!("{:?}", result);
 }
@@ -687,11 +689,11 @@ async fn main() {
 
  let client = Client::new(api_key);
 
- let file_name = env::var("FILE_NAME").expect("FILE_NAME is not set in the .env file.");
+ let file_id = env::var("FILE_ID").expect("FILE_ID is not set in the .env file.");
 
  let parameters = CreateFineTuningJobParameters {
  model: "gpt-3.5-turbo-1106".to_string(),
- training_file: file_name,
+ training_file: file_id,
  hyperparameters: None,
  suffix: None,
  validation_file: None,
@@ -865,6 +867,24 @@ async fn main() {
 
 More information [Create moderation](https://platform.openai.com/docs/api-reference/moderations/create)
 
+## Assistants (beta)
+
+Build assistants that can call models and use tools to perform tasks.
+
+For more information see the examples in the [examples/assistants](https://github.com/tjardoo/openai-client/tree/master/examples/assistants) directory.
+
+- Create assistant
+- Retrieve assistant
+- Modify assistant
+- Delete assistant
+- List assistants
+- Create assistant file
+- Retrieve assistant file
+- Delete assistant file
+- List assistant files
+
+More information [Assistants](https://platform.openai.com/docs/api-reference/assistants)
+
 ## General
 
 ### Set API key

README.md

@@ -8,6 +8,7 @@
 /images/target
 /files/target
 /fine_tuning/target
+/assistants/target
 /models/Cargo.lock
 /chat/Cargo.lock
 /audio/Cargo.lock
@@ -16,3 +17,4 @@
 /images/Cargo.lock
 /files/Cargo.lock
 /fine_tuning/Cargo.lock
+/assistants/Cargo.lock

examples/.gitignore

@@ -25,4 +25,10 @@ members = [
  "models/list_models",
  "models/retrieve_model",
  "moderations/create_moderation",
+ "assistants/create_assistant",
+ "assistants/retrieve_assistant",
+ "assistants/modify_assistant",
+ "assistants/delete_assistant",
+ "assistants/list_assistants",
+ "assistants/assistant_files",
 ]

examples/Cargo.toml

@@ -0,0 +1,9 @@
+[workspace]
+members = [
+ "create_assistant",
+ "retrieve_assistant",
+ "modify_assistant",
+ "delete_assistant",
+ "list_assistants",
+ "assistant_files",
+]

examples/assistants/Cargo.toml

@@ -0,0 +1,2 @@
+ASSISTANT_ID=asst_XXX
+FILE_ID=file-XXX

examples/assistants/assistant_files/.env.example

@@ -0,0 +1,10 @@
+[package]
+name = "assistant_files"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[dependencies]
+openai_dive = { path = "./../../../../openai-client" }
+tokio = { version = "1.0", features = ["full"] }
+dotenv = "0.15.0"

examples/assistants/assistant_files/Cargo.toml

@@ -0,0 +1,76 @@
+use dotenv::dotenv;
+use openai_dive::v1::{api::Client, resources::assistant::CreateAssistantFileParameters};
+use std::env;
+
+#[tokio::main]
+async fn main() {
+ dotenv().ok();
+
+ let api_key = env::var("OPENAI_API_KEY").expect("$OPENAI_API_KEY is not set");
+
+ let client = Client::new(api_key);
+
+ create_assistant_file(&client).await;
+
+ retrieve_assistant_file(&client).await;
+
+ list_assistant_files(&client).await;
+
+ delete_assistant_file(&client).await;
+}
+
+pub async fn create_assistant_file(client: &Client) {
+ let assistant_id = env::var("ASSISTANT_ID").expect("ASSISTANT_ID is not set in the .env file.");
+
+ let parameters = CreateAssistantFileParameters {
+ file_id: env::var("FILE_ID").expect("FILE_ID is not set in the .env file."),
+ };
+
+ let result = client
+ .assistants()
+ .create_file(&assistant_id, parameters)
+ .await
+ .unwrap();
+
+ println!("{:?}", result);
+}
+
+pub async fn retrieve_assistant_file(client: &Client) {
+ let assistant_id = env::var("ASSISTANT_ID").expect("ASSISTANT_ID is not set in the .env file.");
+
+ let file_id = env::var("FILE_ID").expect("FILE_ID is not set in the .env file.");
+
+ let result = client
+ .assistants()
+ .retrieve_file(&assistant_id, &file_id)
+ .await
+ .unwrap();
+
+ println!("{:?}", result);
+}
+
+pub async fn list_assistant_files(client: &Client) {
+ let assistant_id = env::var("ASSISTANT_ID").expect("ASSISTANT_ID is not set in the .env file.");
+
+ let result = client
+ .assistants()
+ .list_files(&assistant_id, None)
+ .await
+ .unwrap();
+
+ println!("{:?}", result);
+}
+
+pub async fn delete_assistant_file(client: &Client) {
+ let assistant_id = env::var("ASSISTANT_ID").expect("ASSISTANT_ID is not set in the .env file.");
+
+ let file_id = env::var("FILE_ID").expect("FILE_ID is not set in the .env file.");
+
+ let result = client
+ .assistants()
+ .delete_file(&assistant_id, &file_id)
+ .await
+ .unwrap();
+
+ println!("{:?}", result);
+}

examples/assistants/assistant_files/src/main.rs

@@ -0,0 +1,9 @@
+[package]
+name = "create_assistant"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[dependencies]
+openai_dive = { path = "./../../../../openai-client" }
+tokio = { version = "1.0", features = ["full"] }