async_openai/lib.rs
1//! Rust library for OpenAI
2//!
3//! ## Creating client
4//!
5//! ```
6//! use async_openai::{Client, config::OpenAIConfig};
7//!
8//! // Create a OpenAI client with api key from env var OPENAI_API_KEY and default base url.
9//! let client = Client::new();
10//!
11//! // Above is shortcut for
12//! let config = OpenAIConfig::default();
13//! let client = Client::with_config(config);
14//!
15//! // OR use API key from different source and a non default organization
16//! let api_key = "sk-..."; // This secret could be from a file, or environment variable.
17//! let config = OpenAIConfig::new()
18//! .with_api_key(api_key)
19//! .with_org_id("the-continental");
20//!
21//! let client = Client::with_config(config);
22//!
23//! // Use custom reqwest client
24//! let http_client = reqwest::ClientBuilder::new().user_agent("async-openai").build().unwrap();
25//! let client = Client::new().with_http_client(http_client);
26//! ```
27//!
28//!
29//! ## Making requests
30//!
31//!```
32//!# tokio_test::block_on(async {
33//!
34//! use async_openai::{Client, types::{CreateCompletionRequestArgs}};
35//!
36//! // Create client
37//! let client = Client::new();
38//!
39//! // Create request using builder pattern
40//! // Every request struct has companion builder struct with same name + Args suffix
41//! let request = CreateCompletionRequestArgs::default()
42//! .model("gpt-3.5-turbo-instruct")
43//! .prompt("Tell me the recipe of alfredo pasta")
44//! .max_tokens(40_u32)
45//! .build()
46//! .unwrap();
47//!
48//! // Call API
49//! let response = client
50//! .completions() // Get the API "group" (completions, images, etc.) from the client
51//! .create(request) // Make the API call in that "group"
52//! .await
53//! .unwrap();
54//!
55//! println!("{}", response.choices.first().unwrap().text);
56//! # });
57//!```
58//!
59//! ## Bring Your Own Types
60//!
61//! To use custom types for inputs and outputs, enable `byot` feature which provides additional generic methods with same name and `_byot` suffix.
62//! This feature is available on methods whose return type is not `Bytes`
63//!
64//!```
65//!# #[cfg(feature = "byot")]
66//!# tokio_test::block_on(async {
67//! use async_openai::Client;
68//! use serde_json::{Value, json};
69//!
70//! let client = Client::new();
71//!
72//! let response: Value = client
73//! .chat()
74//! .create_byot(json!({
75//! "messages": [
76//! {
77//! "role": "developer",
78//! "content": "You are a helpful assistant"
79//! },
80//! {
81//! "role": "user",
82//! "content": "What do you think about life?"
83//! }
84//! ],
85//! "model": "gpt-4o",
86//! "store": false
87//! }))
88//! .await
89//! .unwrap();
90//!
91//! if let Some(content) = response["choices"][0]["message"]["content"].as_str() {
92//! println!("{}", content);
93//! }
94//! # });
95//!```
96//!
97//! ## Dynamic Dispatch for OpenAI-compatible Providers
98//!
99//! For any struct that implements `Config` trait, wrap it in a smart pointer and cast the pointer to `dyn Config`
100//! trait object, then create a client with `Box` or `Arc` wrapped configuration.
101//!
102//! For example:
103//! ```
104//! use async_openai::{Client, config::{Config, OpenAIConfig}};
105//!
106//! // Use `Box` or `std::sync::Arc` to wrap the config
107//! let config = Box::new(OpenAIConfig::default()) as Box<dyn Config>;
108//! // A function can now accept a `&Client<Box<dyn Config>>` parameter
109//! // which can invoke any openai compatible api
110//! let client: Client<Box<dyn Config>> = Client::with_config(config);
111//! ```
112//!
113//! ## Microsoft Azure
114//!
115//! ```
116//! use async_openai::{Client, config::AzureConfig};
117//!
118//! let config = AzureConfig::new()
119//! .with_api_base("https://my-resource-name.openai.azure.com")
120//! .with_api_version("2023-03-15-preview")
121//! .with_deployment_id("deployment-id")
122//! .with_api_key("...");
123//!
124//! let client = Client::with_config(config);
125//!
126//! // Note that `async-openai` only implements OpenAI spec
127//! // and doesn't maintain parity with the spec of Azure OpenAI service.
128//!
129//! ```
130//!
131//!
132//! ## Examples
133//! For full working examples for all supported features see [examples](https://github.com/64bit/async-openai/tree/main/examples) directory in the repository.
134//!
135#![cfg_attr(docsrs, feature(doc_cfg))]
136
137#[cfg(feature = "byot")]
138pub(crate) use async_openai_macros::byot;
139
140#[cfg(not(feature = "byot"))]
141pub(crate) use async_openai_macros::byot_passthrough as byot;
142
143mod admin;
144mod admin_api_keys;
145mod assistants;
146mod audio;
147mod audit_logs;
148mod batches;
149mod certificates;
150mod chat;
151mod chatkit;
152mod client;
153mod completion;
154pub mod config;
155mod container_files;
156mod containers;
157mod conversation_items;
158mod conversations;
159mod download;
160mod embedding;
161pub mod error;
162mod eval_run_output_items;
163mod eval_runs;
164mod evals;
165mod file;
166mod fine_tuning;
167mod group_roles;
168mod group_users;
169mod groups;
170mod image;
171mod impls;
172mod invites;
173mod messages;
174mod model;
175mod moderation;
176mod project_api_keys;
177mod project_certificates;
178mod project_group_roles;
179mod project_groups;
180mod project_rate_limits;
181mod project_roles;
182mod project_service_accounts;
183mod project_user_roles;
184mod project_users;
185mod projects;
186#[cfg(feature = "realtime")]
187mod realtime;
188mod request_options;
189mod responses;
190mod roles;
191mod runs;
192mod speech;
193mod steps;
194mod threads;
195pub mod traits;
196mod transcriptions;
197mod translations;
198pub mod types;
199mod uploads;
200mod usage;
201mod user_roles;
202mod users;
203mod util;
204mod vector_store_file_batches;
205mod vector_store_files;
206mod vector_stores;
207mod video;
208#[cfg(feature = "webhook")]
209pub mod webhooks;
210
211pub use admin::Admin;
212pub use admin_api_keys::AdminAPIKeys;
213pub use assistants::Assistants;
214pub use audio::Audio;
215pub use audit_logs::AuditLogs;
216pub use batches::Batches;
217pub use certificates::Certificates;
218pub use chat::Chat;
219pub use chatkit::Chatkit;
220pub use client::Client;
221pub use completion::Completions;
222pub use container_files::ContainerFiles;
223pub use containers::Containers;
224pub use conversation_items::ConversationItems;
225pub use conversations::Conversations;
226pub use embedding::Embeddings;
227pub use eval_run_output_items::EvalRunOutputItems;
228pub use eval_runs::EvalRuns;
229pub use evals::Evals;
230pub use file::Files;
231pub use fine_tuning::FineTuning;
232pub use group_roles::GroupRoles;
233pub use group_users::GroupUsers;
234pub use groups::Groups;
235pub use image::Images;
236pub use invites::Invites;
237pub use messages::Messages;
238pub use model::Models;
239pub use moderation::Moderations;
240pub use project_api_keys::ProjectAPIKeys;
241pub use project_certificates::ProjectCertificates;
242pub use project_group_roles::ProjectGroupRoles;
243pub use project_groups::ProjectGroups;
244pub use project_rate_limits::ProjectRateLimits;
245pub use project_roles::ProjectRoles;
246pub use project_service_accounts::ProjectServiceAccounts;
247pub use project_user_roles::ProjectUserRoles;
248pub use project_users::ProjectUsers;
249pub use projects::Projects;
250#[cfg(feature = "realtime")]
251pub use realtime::Realtime;
252pub use request_options::RequestOptions;
253pub use responses::Responses;
254pub use roles::Roles;
255pub use runs::Runs;
256pub use speech::Speech;
257pub use steps::Steps;
258pub use threads::Threads;
259pub use transcriptions::Transcriptions;
260pub use translations::Translations;
261pub use uploads::Uploads;
262pub use usage::Usage;
263pub use user_roles::UserRoles;
264pub use users::Users;
265pub use vector_store_file_batches::VectorStoreFileBatches;
266pub use vector_store_files::VectorStoreFiles;
267pub use vector_stores::VectorStores;
268pub use video::Videos;