From 27f91b15541e0a27fc3b5307dd10117195686b9f Mon Sep 17 00:00:00 2001 From: Jeremy Chone Date: Sat, 1 Jun 2024 11:39:51 -0700 Subject: [PATCH] . initial --- .gitignore | 60 +++++++++ Cargo.toml | 37 ++++++ LICENSE-APACHE | 201 +++++++++++++++++++++++++++++++ LICENSE-MIT | 21 ++++ README.md | 17 +++ examples/c01-openai.rs | 12 ++ src/client/mod.rs | 24 ++++ src/client/openai/mod.rs | 59 +++++++++ src/client/openai/openai_impl.rs | 68 +++++++++++ src/error.rs | 22 ++++ src/lib.rs | 11 ++ src/types/chat.rs | 55 +++++++++ src/types/gen.rs | 65 ++++++++++ src/types/mod.rs | 18 +++ src/types/tool.rs | 8 ++ 15 files changed, 678 insertions(+) create mode 100644 .gitignore create mode 100644 Cargo.toml create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT create mode 100644 README.md create mode 100644 examples/c01-openai.rs create mode 100644 src/client/mod.rs create mode 100644 src/client/openai/mod.rs create mode 100644 src/client/openai/openai_impl.rs create mode 100644 src/error.rs create mode 100644 src/lib.rs create mode 100644 src/types/chat.rs create mode 100644 src/types/gen.rs create mode 100644 src/types/mod.rs create mode 100644 src/types/tool.rs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4612e5c --- /dev/null +++ b/.gitignore @@ -0,0 +1,60 @@ +# -- Base +.* +!.gitignore + +*.lock +*.lockb +*.log + +# -- Rust +target/ +# !Cargo.lock # commented by default +!.cargo/ + +# -- Safety net +dist/ +out/ + +# Data Files +*.parquet +*.map +*.zip +*.gz +*.tar +*.tgz +*.vsix + +# Videos +*.mov +*.mp4 +*.webm +*.ogg +*.avi + +# Images +*.icns +*.ico +*.jpeg +*.jpg +*.png +*.bmp + +# -- Nodejs +node_modules/ +!.mocharc.yaml +report.*.json + +# -- Python +__pycache__/ + + +# -- others +_* +# '_' in src dir, ok. +!**/src/**/_* + +# Allows .env (make sure only dev info) +# !.env # Commented by default + +# Allow vscode +# !.vscode # Commented by default diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..98eb3fd --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,37 @@ +[package] +name = "genai" +version = "0.0.1" +edition = "2021" +rust-version = "1.78" +license = "MIT OR Apache-2.0" +description = "Multiprovider generative AI client" +keywords = [ + "generative-ai", + "library", + "openai", + "llama", + "ollama" +] +homepage = "https://github.com/jeremychone/rust-genai" +repository = "https://github.com/jeremychone/rust-genai" + + +[lints.rust] +unsafe_code = "forbid" +unused = { level = "allow", priority = -1 } # For exploratory dev. + +[dependencies] +# -- Async +tokio = { version = "1", features = ["full"] } +futures = "0.3" +async-trait = "0.1" +tokio-stream = "0.1" +# -- Json +serde = { version = "1", features = ["derive"] } +serde_json = "1" +serde_with = { version = "3", features = ["macros"] } +# -- AI +async-openai = "0.21" +# -- Others +derive_more = {version = "1.0.0-beta", features = ["from"] } + diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..27c3e9c --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 Jeremy Chone + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..8b38435 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2024 Jeremy Chone + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..db51211 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# genai - multi-ai provider gen-ai client + +The goal of this library is to provide a common and ergonomic single API to many generative AI providers, such as OpenAI and Ollama. + +**IMPORTANT 1** This is in development, `0.0.x` are not intended to work. Do not use at this point. Wait for `0.1.x` see below. + +**IMPORTANT 2** This is not intended to be a replacement for [async-openai](https://crates.io/search?q=async-openai) and [ollama-rs](https://crates.io/crates/ollama-rs), but rather to tackle the simpler lowest common denominator of chat generation in a single API. + +Scope for now: + +- Focuses on OpenAI and Ollama, using [async-openai](https://crates.io/search?q=async-openai) and [ollama-rs](https://crates.io/crates/ollama-rs) + +- For the `0.0.x` version, it is just code that might not even work. Don't waste your time. + +- The `0.1.x` version will start to work, but the APIs will change in the patch version, not following semver strictly. + +- Version `0.2.x` will follow semver more strictly. \ No newline at end of file diff --git a/examples/c01-openai.rs b/examples/c01-openai.rs new file mode 100644 index 0000000..93f0d9b --- /dev/null +++ b/examples/c01-openai.rs @@ -0,0 +1,12 @@ +use genai::OpenAIClient; + +#[tokio::main] +async fn main() -> Result<(), Box> { + // create new client + let api_key = std::env::var("OPENAI_API_KEY")?; + let oa_client = OpenAIClient::from_api_key(api_key); + + // + + Ok(()) +} diff --git a/src/client/mod.rs b/src/client/mod.rs new file mode 100644 index 0000000..908e249 --- /dev/null +++ b/src/client/mod.rs @@ -0,0 +1,24 @@ +// region: --- Modules + +mod openai; + +pub use openai::*; + +// endregion: --- Modules + +use crate::{ChatReq, ChatRes, ChatResStream, GenReq, GenRes, GenResStream, Result}; +use async_trait::async_trait; + +pub enum ClientKind { + Ollama, + Openai, +} + +#[async_trait] +pub trait Client { + async fn list_models(&self) -> Result>; + + async fn exec_chat(&self, req: ChatReq) -> Result; + + async fn exec_chat_stream(&self, req: ChatReq) -> Result; +} diff --git a/src/client/openai/mod.rs b/src/client/openai/mod.rs new file mode 100644 index 0000000..23c15ae --- /dev/null +++ b/src/client/openai/mod.rs @@ -0,0 +1,59 @@ +// region: --- Modules + +mod openai_impl; + +use crate::Result; +use async_openai::config::OpenAIConfig as AsyncOpenAIConfig; +use async_openai::Client as AsyncOpenAIClient; +use std::sync::{Arc, Mutex}; + +// endregion: --- Modules + +// region: --- Client + +pub type AsyncOaClient = AsyncOpenAIClient; + +#[derive(Clone)] +pub struct OpenAIClient { + conn: Arc>, +} + +// constructors +impl OpenAIClient { + pub fn new(config: OpenAIConfig) -> Result { + let config = AsyncOpenAIConfig::new().with_api_key(config.api_key); + let conn = Arc::new(Mutex::new(AsyncOpenAIClient::with_config(config))); + Ok(Self { conn }) + } + + pub fn from_api_key(api_key: String) -> Result { + let config = OpenAIConfig { api_key }; + Self::new(config) + } + + pub fn from_async_openai_client(async_client: AsyncOaClient) -> Self { + let conn = Arc::new(Mutex::new(async_client)); + Self { conn } + } + + // from config + pub fn from_async_openai_config(config: AsyncOpenAIConfig) -> Self { + let conn = Arc::new(Mutex::new(AsyncOpenAIClient::with_config(config))); + Self { conn } + } +} + +// endregion: --- Client + +// region: --- OpenAIConfig + +pub struct OpenAIConfig { + api_key: String, +} +impl std::fmt::Debug for OpenAIConfig { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("OpenaiClientConfig").field("api_key", &"REDACTED").finish() + } +} + +// endregion: --- OpenAIConfig diff --git a/src/client/openai/openai_impl.rs b/src/client/openai/openai_impl.rs new file mode 100644 index 0000000..c6e7b96 --- /dev/null +++ b/src/client/openai/openai_impl.rs @@ -0,0 +1,68 @@ +use crate::client::openai::OpenAIClient; +use crate::ChatMsg; +use crate::ChatReq; +use crate::ChatRes; +use crate::ChatResStream; +use crate::ChatRole; +use crate::Client; +use crate::Result; +use crate::{GenReq, GenRes, GenResStream}; +use async_openai::config::OpenAIConfig; +use async_openai::types::ChatCompletionRequestMessage; +use async_openai::types::ChatCompletionRequestUserMessage; +use async_openai::types::Role; +use async_trait::async_trait; +use std::sync::{Arc, Mutex}; + +#[async_trait] +impl Client for OpenAIClient { + async fn list_models(&self) -> Result> { + Ok(vec![]) + } + async fn exec_chat(&self, req: ChatReq) -> Result { + let raw_client = self.conn.lock().unwrap(); + let chat_client = raw_client.chat(); + + let model = req.model; + let raw_messages = req.messages.into_iter().map(ChatCompletionRequestMessage::from); + + todo!() + } + + async fn exec_chat_stream(&self, req: ChatReq) -> Result { + todo!() + } +} + +// region: --- Types From + +impl From for Role { + fn from(chat_role: ChatRole) -> Self { + match chat_role { + ChatRole::System => Role::System, + ChatRole::User => Role::User, + ChatRole::Assistant => Role::Assistant, + ChatRole::Tool => Role::Tool, + // TODO: need to decide what to do with function + } + } +} + +impl From for ChatCompletionRequestMessage { + fn from(chat_msg: ChatMsg) -> Self { + let role = chat_msg.role.into(); + let content = chat_msg.content; + + match chat_msg.extra { + None => ChatCompletionRequestUserMessage { + content: content.into(), + role, + name: None, + } + .into(), + _ => todo!("chat_msg other not supported yet"), + } + } +} + +// endregion: --- Types From diff --git a/src/error.rs b/src/error.rs new file mode 100644 index 0000000..6eb7615 --- /dev/null +++ b/src/error.rs @@ -0,0 +1,22 @@ +use derive_more::From; + +pub type Result = core::result::Result; + +#[derive(Debug, From)] +pub enum Error { + // -- Externals + #[from] + Io(std::io::Error), // as example +} + +// region: --- Error Boilerplate + +impl core::fmt::Display for Error { + fn fmt(&self, fmt: &mut core::fmt::Formatter) -> core::result::Result<(), core::fmt::Error> { + write!(fmt, "{self:?}") + } +} + +impl std::error::Error for Error {} + +// endregion: --- Error Boilerplate diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..29268ce --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,11 @@ +// region: --- Modules + +mod client; +mod error; +mod types; + +pub use client::*; +pub use error::{Error, Result}; +pub use types::*; + +// endregion: --- Modules diff --git a/src/types/chat.rs b/src/types/chat.rs new file mode 100644 index 0000000..a3aa74f --- /dev/null +++ b/src/types/chat.rs @@ -0,0 +1,55 @@ +use crate::Result; +use futures::Stream; +use std::pin::Pin; + +// region: --- Chat Request Types + +#[derive(Debug)] +pub enum ChatRole { + System, + User, + Assistant, + Tool, +} + +pub struct ChatReq { + pub model: String, + pub messages: Vec, +} + +pub struct ChatMsg { + pub role: ChatRole, + pub content: String, + pub extra: Option, +} + +pub enum ChatMsgExtra { + Tool(ToolExtra), +} + +pub struct ToolExtra { + tool_id: String, +} + +// endregion: --- Chat Request Types + +// region: --- ChatRes + +#[derive(Debug, Clone)] +pub struct ChatRes { + pub response: String, +} + +// endregion: --- ChatRes + +// region: --- ChatResStream + +pub type ChatResStream = Pin>>>; + +pub type ChatResChunks = Vec; + +pub struct ChatResChunk { + pub response: String, +} + +// endregion: --- ChatResStream diff --git a/src/types/gen.rs b/src/types/gen.rs new file mode 100644 index 0000000..a0cafa4 --- /dev/null +++ b/src/types/gen.rs @@ -0,0 +1,65 @@ +use crate::{OutFormat, Result}; +use futures::Stream; +use std::pin::Pin; + +// region: --- GenReq + +#[derive(Debug)] +pub struct GenReq { + pub prompt: String, + pub inst: Option, + pub out_format: Option, +} + +impl From<&str> for GenReq { + fn from(val: &str) -> Self { + Self { + prompt: val.to_string(), + inst: None, + out_format: None, + } + } +} + +impl From for GenReq { + fn from(val: String) -> Self { + Self { + prompt: val, + inst: None, + out_format: None, + } + } +} + +impl From<&String> for GenReq { + fn from(val: &String) -> Self { + Self { + prompt: val.to_string(), + inst: None, + out_format: None, + } + } +} + +// endregion: --- GenReq + +// region: --- GenRes + +#[derive(Debug, Clone)] +pub struct GenRes { + pub response: String, +} + +// endregion: --- GenRes + +// region: --- GenResStream + +pub type GenResStream = Pin>>>; + +pub type GenResChunks = Vec; + +pub struct GenResChunk { + pub response: String, +} + +// endregion: --- GenResStream diff --git a/src/types/mod.rs b/src/types/mod.rs new file mode 100644 index 0000000..de6c04a --- /dev/null +++ b/src/types/mod.rs @@ -0,0 +1,18 @@ +// region: --- Modules + +mod chat; +mod gen; +mod tool; + +// -- Flatten +pub use chat::*; +pub use gen::*; +pub use tool::*; + +// endregion: --- Modules + +#[derive(Debug)] +pub enum OutFormat { + Text, + Json, +} diff --git a/src/types/tool.rs b/src/types/tool.rs new file mode 100644 index 0000000..fe889af --- /dev/null +++ b/src/types/tool.rs @@ -0,0 +1,8 @@ +use serde_json::Value; + +#[allow(unused)] // For early development. +pub struct Tool { + fn_name: String, + fn_description: String, + params: Value, +}