feat: ergonomics, consistency and contained types

async-openai/Cargo.toml

@@ -62,7 +62,7 @@ tokio-test = "0.4.4"
 serde_json = "1.0"
 
 [[test]]
-name = "bring-your-own-type"
+name = "bring_your_own_type"
 required-features = ["byot"]
 
 [package.metadata.docs.rs]

async-openai/src/admin.rs → async-openai/src/admin/admin_.rs

@@ -1,7 +1,6 @@
 use crate::{
-    admin_api_keys::AdminAPIKeys, audit_logs::AuditLogs, certificates::Certificates,
-    config::Config, groups::Groups, invites::Invites, projects::Projects, roles::Roles,
-    users::Users, Client,
+    config::Config, AdminAPIKeys, AuditLogs, Certificates, Client, Groups, Invites, Projects,
+    Roles, Usage, Users,
 };
 
 /// Admin group for all administration APIs.
@@ -54,4 +53,9 @@ impl<'c, C: Config> Admin<'c, C> {
     pub fn groups(&self) -> Groups<'_, C> {
         Groups::new(self.client)
     }
+
+    /// To call [Usage] group related APIs using this client.
+    pub fn usage(&self) -> Usage<'_, C> {
+        Usage::new(self.client)
+    }
 }

async-openai/src/groups.rs → async-openai/src/admin/groups.rs

@@ -1,13 +1,11 @@
 use crate::{
     config::Config,
     error::OpenAIError,
-    group_roles::GroupRoles,
-    group_users::GroupUsers,
     types::admin::groups::{
         CreateGroupBody, GroupDeletedResource, GroupListResource, GroupResourceWithSuccess,
         GroupResponse,
     },
-    Client, RequestOptions,
+    Client, GroupRoles, GroupUsers, RequestOptions,
 };
 
 /// Manage reusable collections of users for organization-wide access control and maintain their membership.

async-openai/src/admin/mod.rs

@@ -0,0 +1,45 @@
+mod admin_;
+mod admin_api_keys;
+mod audit_logs;
+mod certificates;
+mod group_roles;
+mod group_users;
+mod groups;
+mod invites;
+mod project_api_keys;
+mod project_certificates;
+mod project_group_roles;
+mod project_groups;
+mod project_rate_limits;
+mod project_roles;
+mod project_service_accounts;
+mod project_user_roles;
+mod project_users;
+mod projects;
+mod roles;
+mod usage;
+mod user_roles;
+mod users;
+
+pub use admin_::*;
+pub use admin_api_keys::*;
+pub use audit_logs::*;
+pub use certificates::*;
+pub use group_roles::*;
+pub use group_users::*;
+pub use groups::*;
+pub use invites::*;
+pub use project_api_keys::*;
+pub use project_certificates::*;
+pub use project_group_roles::*;
+pub use project_groups::*;
+pub use project_rate_limits::*;
+pub use project_roles::*;
+pub use project_service_accounts::*;
+pub use project_user_roles::*;
+pub use project_users::*;
+pub use projects::*;
+pub use roles::*;
+pub use usage::*;
+pub use user_roles::*;
+pub use users::*;

async-openai/src/projects.rs → async-openai/src/admin/projects.rs

@@ -1,17 +1,12 @@
 use crate::{
     config::Config,
     error::OpenAIError,
-    project_api_keys::ProjectAPIKeys,
-    project_certificates::ProjectCertificates,
-    project_group_roles::ProjectGroupRoles,
-    project_groups::ProjectGroups,
-    project_rate_limits::ProjectRateLimits,
-    project_roles::ProjectRoles,
-    project_user_roles::ProjectUserRoles,
     types::admin::projects::{
         Project, ProjectCreateRequest, ProjectListResponse, ProjectUpdateRequest,
     },
-    Client, ProjectServiceAccounts, ProjectUsers, RequestOptions,
+    Client, ProjectAPIKeys, ProjectCertificates, ProjectGroupRoles, ProjectGroups,
+    ProjectRateLimits, ProjectRoles, ProjectServiceAccounts, ProjectUserRoles, ProjectUsers,
+    RequestOptions,
 };
 
 /// Manage the projects within an organization includes creation, updating, and archiving or projects.

async-openai/src/users.rs → async-openai/src/admin/users.rs

@@ -2,8 +2,7 @@ use crate::{
     config::Config,
     error::OpenAIError,
     types::admin::users::{User, UserDeleteResponse, UserListResponse, UserRoleUpdateRequest},
-    user_roles::UserRoles,
-    Client, RequestOptions,
+    Client, RequestOptions, UserRoles,
 };
 
 /// Manage users and their role in an organization. Users will be automatically added to the Default project.

async-openai/src/assistants/mod.rs

@@ -0,0 +1,11 @@
+mod assistants_;
+mod messages;
+mod runs;
+mod steps;
+mod threads;
+
+pub use assistants_::*;
+pub use messages::*;
+pub use runs::*;
+pub use steps::*;
+pub use threads::*;

async-openai/src/runs.rs → async-openai/src/assistants/runs.rs

@@ -1,7 +1,7 @@
 use crate::{
+    assistants::Steps,
     config::Config,
     error::OpenAIError,
-    steps::Steps,
     types::assistants::{
         AssistantEventStream, CreateRunRequest, ListRunsResponse, ModifyRunRequest, RunObject,
         SubmitToolOutputsRunRequest,

async-openai/src/audio/mod.rs

@@ -0,0 +1,9 @@
+mod audio_;
+mod speech;
+mod transcriptions;
+mod translations;
+
+pub use audio_::*;
+pub use speech::*;
+pub use transcriptions::*;
+pub use translations::*;

async-openai/src/client.rs

@@ -16,7 +16,7 @@ use crate::{
     moderation::Moderations,
     traits::AsyncTryFrom,
     Assistants, Audio, Batches, Chat, Completions, Containers, Conversations, Embeddings, Evals,
-    FineTuning, Models, RequestOptions, Responses, Threads, Uploads, Usage, VectorStores, Videos,
+    FineTuning, Models, RequestOptions, Responses, Threads, Uploads, VectorStores, Videos,
 };
 
 #[cfg(feature = "realtime")]
@@ -158,11 +158,6 @@ impl<C: Config> Client<C> {
         Admin::new(self)
     }
 
-    /// To call [Usage] group related APIs using this client.
-    pub fn usage(&self) -> Usage<'_, C> {
-        Usage::new(self)
-    }
-
     /// To call [Responses] group related APIs using this client.
     pub fn responses(&self) -> Responses<'_, C> {
         Responses::new(self)

async-openai/src/completion.rs

@@ -2,7 +2,9 @@ use crate::{
     client::Client,
     config::Config,
     error::OpenAIError,
-    types::{CompletionResponseStream, CreateCompletionRequest, CreateCompletionResponse},
+    types::completions::{
+        CompletionResponseStream, CreateCompletionRequest, CreateCompletionResponse,
+    },
     RequestOptions,
 };
 

async-openai/src/containers.rs → async-openai/src/containers/containers_.rs

@@ -1,11 +1,10 @@
 use crate::{
     config::Config,
-    container_files::ContainerFiles,
     error::OpenAIError,
     types::containers::{
         ContainerListResource, ContainerResource, CreateContainerRequest, DeleteContainerResponse,
     },
-    Client, RequestOptions,
+    Client, ContainerFiles, RequestOptions,
 };
 
 pub struct Containers<'c, C: Config> {

async-openai/src/containers/mod.rs

@@ -0,0 +1,5 @@
+mod container_files;
+mod containers_;
+
+pub use container_files::*;
+pub use containers_::*;

async-openai/src/eval_runs.rs → async-openai/src/evals/eval_runs.rs

@@ -1,9 +1,8 @@
 use crate::{
     config::Config,
     error::OpenAIError,
-    eval_run_output_items::EvalRunOutputItems,
     types::evals::{CreateEvalRunRequest, DeleteEvalRunResponse, EvalRun, EvalRunList},
-    Client, RequestOptions,
+    Client, EvalRunOutputItems, RequestOptions,
 };
 
 pub struct EvalRuns<'c, C: Config> {

async-openai/src/evals.rs → async-openai/src/evals/evals_.rs

@@ -1,9 +1,8 @@
 use crate::{
     config::Config,
     error::OpenAIError,
-    eval_runs::EvalRuns,
     types::evals::{CreateEvalRequest, DeleteEvalResponse, Eval, EvalList, UpdateEvalRequest},
-    Client, RequestOptions,
+    Client, EvalRuns, RequestOptions,
 };
 
 /// Create, manage, and run evals in the OpenAI platform. Related guide:

async-openai/src/evals/mod.rs

@@ -0,0 +1,7 @@
+mod eval_run_output_items;
+mod eval_runs;
+mod evals_;
+
+pub use eval_run_output_items::*;
+pub use eval_runs::*;
+pub use evals_::*;

async-openai/src/impls.rs

@@ -1,56 +1,56 @@
 use crate::{
-    admin_api_keys::AdminAPIKeys,
+    admin::AdminAPIKeys,
+    admin::AuditLogs,
+    admin::Certificates,
+    admin::GroupRoles,
+    admin::GroupUsers,
+    admin::Groups,
+    admin::Invites,
+    admin::ProjectAPIKeys,
+    admin::ProjectCertificates,
+    admin::ProjectGroupRoles,
+    admin::ProjectGroups,
+    admin::ProjectRateLimits,
+    admin::ProjectRoles,
+    admin::ProjectServiceAccounts,
+    admin::ProjectUserRoles,
+    admin::ProjectUsers,
+    admin::Projects,
+    admin::Roles,
+    admin::Usage,
+    admin::UserRoles,
+    admin::Users,
     assistants::Assistants,
+    assistants::Messages,
+    assistants::Runs,
+    assistants::Steps,
+    assistants::Threads,
     audio::Audio,
-    audit_logs::AuditLogs,
+    audio::Speech,
+    audio::Transcriptions,
+    audio::Translations,
     batches::Batches,
-    certificates::Certificates,
     chat::Chat,
     chatkit::{Chatkit, ChatkitSessions, ChatkitThreads},
     completion::Completions,
-    container_files::ContainerFiles,
+    containers::ContainerFiles,
     containers::Containers,
-    conversation_items::ConversationItems,
-    conversations::Conversations,
     embedding::Embeddings,
-    eval_run_output_items::EvalRunOutputItems,
-    eval_runs::EvalRuns,
+    evals::EvalRunOutputItems,
+    evals::EvalRuns,
     evals::Evals,
     file::Files,
     fine_tuning::FineTuning,
-    group_roles::GroupRoles,
-    group_users::GroupUsers,
-    groups::Groups,
     image::Images,
-    invites::Invites,
-    messages::Messages,
     model::Models,
     moderation::Moderations,
-    project_api_keys::ProjectAPIKeys,
-    project_certificates::ProjectCertificates,
-    project_group_roles::ProjectGroupRoles,
-    project_groups::ProjectGroups,
-    project_rate_limits::ProjectRateLimits,
-    project_roles::ProjectRoles,
-    project_service_accounts::ProjectServiceAccounts,
-    project_user_roles::ProjectUserRoles,
-    project_users::ProjectUsers,
-    projects::Projects,
+    responses::ConversationItems,
+    responses::Conversations,
     responses::Responses,
-    roles::Roles,
-    runs::Runs,
-    speech::Speech,
-    steps::Steps,
-    threads::Threads,
-    transcriptions::Transcriptions,
-    translations::Translations,
     uploads::Uploads,
-    usage::Usage,
-    user_roles::UserRoles,
-    users::Users,
-    vector_store_file_batches::VectorStoreFileBatches,
-    vector_store_files::VectorStoreFiles,
-    vector_stores::VectorStores,
+    vectorstores::VectorStoreFileBatches,
+    vectorstores::VectorStoreFiles,
+    vectorstores::VectorStores,
     video::Videos,
 };