Merge remote-tracking branch 'origin/main' into spiceai

Author: Jeadie

async-openai/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "async-openai"
-version = "0.24.1"
+version = "0.26.0"
 authors = ["Himanshu Neema"]
 categories = ["api-bindings", "web-programming", "asynchronous"]
 keywords = ["openai", "async", "openapi", "ai"]
@@ -22,6 +22,7 @@ rustls-webpki-roots = ["reqwest/rustls-tls-webpki-roots"]
 native-tls = ["reqwest/native-tls"]
 # Remove dependency on OpenSSL
 native-tls-vendored = ["reqwest/native-tls-vendored"]
+realtime = ["dep:tokio-tungstenite"]
 
 [dependencies]
 backoff = { version = "0.4.0", features = ["tokio"] }
@@ -46,6 +47,11 @@ async-convert = "1.0.0"
 secrecy = { version = "0.8.0", features = ["serde"] }
 bytes = "1.6.0"
 eventsource-stream = "0.2.3"
+tokio-tungstenite = { version = "0.24.0", optional = true, default-features = false }
 
 [dev-dependencies]
 tokio-test = "0.4.4"
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

async-openai/README.md

@@ -34,8 +34,9 @@
   - [x] Images
   - [x] Models
   - [x] Moderations
-  - [ ] Organizations | Administration
-  - [ ] Uploads
+  - [x] Organizations | Administration
+  - [x] Realtime API types (Beta)
+  - [x] Uploads
 - SSE streaming on available APIs
 - Requests (except SSE streaming) including form submissions are retried with exponential backoff when [rate limited](https://platform.openai.com/docs/guides/rate-limits).
 - Ergonomic builder pattern for all request objects.
@@ -58,6 +59,11 @@ $Env:OPENAI_API_KEY='sk-...'
 - Visit [examples](https://github.com/64bit/async-openai/tree/main/examples) directory on how to use `async-openai`.
 - Visit [docs.rs/async-openai](https://docs.rs/async-openai) for docs.
 
+## Realtime API
+
+Only types for Realtime API are implemented, and can be enabled with feature flag `realtime`.
+These types may change if/when OpenAI releases official specs for them.
+
 ## Image Generation Example
 
 ```rust

async-openai/src/audit_logs.rs

@@ -0,0 +1,26 @@
+use serde::Serialize;
+
+use crate::{config::Config, error::OpenAIError, types::ListAuditLogsResponse, Client};
+
+/// Logs of user actions and configuration changes within this organization.
+/// To log events, you must activate logging in the [Organization Settings](https://platform.openai.com/settings/organization/general).
+/// Once activated, for security reasons, logging cannot be deactivated.
+pub struct AuditLogs<'c, C: Config> {
+    client: &'c Client<C>,
+}
+
+impl<'c, C: Config> AuditLogs<'c, C> {
+    pub fn new(client: &'c Client<C>) -> Self {
+        Self { client }
+    }
+
+    /// List user actions and configuration changes within this organization.
+    pub async fn get<Q>(&self, query: &Q) -> Result<ListAuditLogsResponse, OpenAIError>
+    where
+        Q: Serialize + ?Sized,
+    {
+        self.client
+            .get_with_query("/organization/audit_logs", query)
+            .await
+    }
+}

async-openai/src/client.rs

@@ -11,8 +11,8 @@ use crate::{
     file::Files,
     image::Images,
     moderation::Moderations,
-    Assistants, Audio, Batches, Chat, Completions, Embeddings, FineTuning, Models, Threads,
-    VectorStores,
+    Assistants, Audio, AuditLogs, Batches, Chat, Completions, Embeddings, FineTuning, Invites,
+    Models, Projects, Threads, Users, VectorStores,
 };
 
 #[derive(Debug, Clone, Default)]
@@ -135,6 +135,26 @@ impl<C: Config> Client<C> {
         Batches::new(self)
     }
 
+    /// To call [AuditLogs] group related APIs using this client.
+    pub fn audit_logs(&self) -> AuditLogs<C> {
+        AuditLogs::new(self)
+    }
+
+    /// To call [Invites] group related APIs using this client.
+    pub fn invites(&self) -> Invites<C> {
+        Invites::new(self)
+    }
+
+    /// To call [Users] group related APIs using this client.
+    pub fn users(&self) -> Users<C> {
+        Users::new(self)
+    }
+
+    /// To call [Projects] group related APIs using this client.
+    pub fn projects(&self) -> Projects<C> {
+        Projects::new(self)
+    }
+
     pub fn config(&self) -> &C {
         &self.config
     }

async-openai/src/invites.rs

@@ -0,0 +1,48 @@
+use serde::Serialize;
+
+use crate::{
+    config::Config,
+    error::OpenAIError,
+    types::{Invite, InviteDeleteResponse, InviteListResponse, InviteRequest},
+    Client,
+};
+
+/// Invite and manage invitations for an organization. Invited users are automatically added to the Default project.
+pub struct Invites<'c, C: Config> {
+    client: &'c Client<C>,
+}
+
+impl<'c, C: Config> Invites<'c, C> {
+    pub fn new(client: &'c Client<C>) -> Self {
+        Self { client }
+    }
+
+    /// Returns a list of invites in the organization.
+    pub async fn list<Q>(&self, query: &Q) -> Result<InviteListResponse, OpenAIError>
+    where
+        Q: Serialize + ?Sized,
+    {
+        self.client
+            .get_with_query("/organization/invites", query)
+            .await
+    }
+
+    /// Retrieves an invite.
+    pub async fn retrieve(&self, invite_id: &str) -> Result<Invite, OpenAIError> {
+        self.client
+            .get(format!("/organization/invites/{invite_id}").as_str())
+            .await
+    }
+
+    /// Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.
+    pub async fn create(&self, request: InviteRequest) -> Result<Invite, OpenAIError> {
+        self.client.post("/organization/invites", request).await
+    }
+
+    /// Delete an invite. If the invite has already been accepted, it cannot be deleted.
+    pub async fn delete(&self, invite_id: &str) -> Result<InviteDeleteResponse, OpenAIError> {
+        self.client
+            .delete(format!("/organization/invites/{invite_id}").as_str())
+            .await
+    }
+}

async-openai/src/lib.rs

@@ -76,9 +76,11 @@
 //! ## Examples
 //! For full working examples for all supported features see [examples](https://github.com/64bit/async-openai/tree/main/examples) directory in the repository.
 //!
+#![cfg_attr(docsrs, feature(doc_cfg))]
 mod assistant_files;
 mod assistants;
 mod audio;
+mod audit_logs;
 mod batches;
 mod chat;
 mod client;
@@ -90,14 +92,21 @@ pub mod error;
 mod file;
 mod fine_tuning;
 mod image;
+mod invites;
 mod message_files;
 mod messages;
 mod model;
 mod moderation;
+mod project_api_keys;
+mod project_service_accounts;
+mod project_users;
+mod projects;
 mod runs;
 mod steps;
 mod threads;
 pub mod types;
+mod uploads;
+mod users;
 mod util;
 mod vector_store_file_batches;
 mod vector_store_files;
@@ -106,6 +115,7 @@ mod vector_stores;
 pub use assistant_files::AssistantFiles;
 pub use assistants::Assistants;
 pub use audio::Audio;
+pub use audit_logs::AuditLogs;
 pub use batches::Batches;
 pub use chat::Chat;
 pub use client::Client;
@@ -114,13 +124,20 @@ pub use embedding::Embeddings;
 pub use file::Files;
 pub use fine_tuning::FineTuning;
 pub use image::Images;
+pub use invites::Invites;
 pub use message_files::MessageFiles;
 pub use messages::Messages;
 pub use model::Models;
 pub use moderation::Moderations;
+pub use project_api_keys::ProjectAPIKeys;
+pub use project_service_accounts::ProjectServiceAccounts;
+pub use project_users::ProjectUsers;
+pub use projects::Projects;
 pub use runs::Runs;
 pub use steps::Steps;
 pub use threads::Threads;
+pub use uploads::Uploads;
+pub use users::Users;
 pub use vector_store_file_batches::VectorStoreFileBatches;
 pub use vector_store_files::VectorStoreFiles;
 pub use vector_stores::VectorStores;

async-openai/src/moderation.rs

@@ -5,7 +5,7 @@ use crate::{
     Client,
 };
 
-/// Given some input text, outputs if the model classifies it as potentially harmful across several categories.
+/// Given text and/or image inputs, classifies if those inputs are potentially harmful across several categories.
 ///
 /// Related guide: [Moderations](https://platform.openai.com/docs/guides/moderation)
 pub struct Moderations<'c, C: Config> {
@@ -17,7 +17,8 @@ impl<'c, C: Config> Moderations<'c, C> {
         Self { client }
     }
 
-    /// Classifies if text is potentially harmful.
+    /// Classifies if text and/or image inputs are potentially harmful. Learn
+    /// more in the [moderation guide](https://platform.openai.com/docs/guides/moderation).
     pub async fn create(
         &self,
         request: CreateModerationRequest,

async-openai/src/project_api_keys.rs

@@ -0,0 +1,63 @@
+use serde::Serialize;
+
+use crate::{
+    config::Config,
+    error::OpenAIError,
+    types::{ProjectApiKey, ProjectApiKeyDeleteResponse, ProjectApiKeyListResponse},
+    Client,
+};
+
+/// Manage API keys for a given project. Supports listing and deleting keys for users.
+/// This API does not allow issuing keys for users, as users need to authorize themselves to generate keys.
+pub struct ProjectAPIKeys<'c, C: Config> {
+    client: &'c Client<C>,
+    pub project_id: String,
+}
+
+impl<'c, C: Config> ProjectAPIKeys<'c, C> {
+    pub fn new(client: &'c Client<C>, project_id: &str) -> Self {
+        Self {
+            client,
+            project_id: project_id.into(),
+        }
+    }
+
+    /// Returns a list of API keys in the project.
+    pub async fn list<Q>(&self, query: &Q) -> Result<ProjectApiKeyListResponse, OpenAIError>
+    where
+        Q: Serialize + ?Sized,
+    {
+        self.client
+            .get_with_query(
+                format!("/organization/projects/{}/api_keys", self.project_id).as_str(),
+                query,
+            )
+            .await
+    }
+
+    /// Retrieves an API key in the project.
+    pub async fn retrieve(&self, api_key: &str) -> Result<ProjectApiKey, OpenAIError> {
+        self.client
+            .get(
+                format!(
+                    "/organization/projects/{}/api_keys/{api_key}",
+                    self.project_id
+                )
+                .as_str(),
+            )
+            .await
+    }
+
+    /// Deletes an API key from the project.
+    pub async fn delete(&self, api_key: &str) -> Result<ProjectApiKeyDeleteResponse, OpenAIError> {
+        self.client
+            .delete(
+                format!(
+                    "/organization/projects/{}/api_keys/{api_key}",
+                    self.project_id
+                )
+                .as_str(),
+            )
+            .await
+    }
+}