aisuite4cn 0.1.0__tar.gz

aisuite4cn-0.1.0/LICENSE

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2024 Huwei
+
+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.

aisuite4cn-0.1.0/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.1
+Name: aisuite4cn
+Version: 0.1.0
+Summary: 
+Author: 胡伟
+Author-email: 3314672@qq.com
+Requires-Python: >=3.10,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: moonshot
+Provides-Extra: qwen
+Provides-Extra: volcengine
+Requires-Dist: httpx (>=0.27.0,<0.28.0)
+Requires-Dist: openai (>=1.35.8,<2.0.0) ; extra == "moonshot" or extra == "volcengine" or extra == "qwen"
+Requires-Dist: pydantic (>=2.10.3,<3.0.0)
+Description-Content-Type: text/markdown
+
+# aisuite4cn
+
+简单、统一的接口，可连接多个生成式人工智能提供商。
+
+`aisuite4cn` 针对于中国的各类大模型厂商提供通用的支持。学习了`aisuite`方案，并开发了该库。
+
+`aisuite4cn` 使得开发者能够通过标准化的接口轻松使用多个大型语言模型（LLM）。使用类似于OpenAI的接口，`aisuite4cn` 使得与最受欢迎的LLM互动并比较结果变得简单。它是Python客户端库的轻量级包装器，允许创造者在不改变代码的情况下无缝切换并测试来自不同LLM提供商的响应。我们将在不久的将来扩展它以覆盖更多的用例。
+
+当前支持的提供商包括：
+moonshot（月之暗面）、Doubao（火山引擎）、Qwen（阿里云千问大模型）。
+
+
+## Integrated Open source project
+Special thanks to all contributors
+
+### aisuite
+https://github.com/andrewyng/aisuite
+
+### openai-python
+https://github.com/openai/openai-python

aisuite4cn-0.1.0/README.md

@@ -0,0 +1,20 @@
+# aisuite4cn
+
+简单、统一的接口，可连接多个生成式人工智能提供商。
+
+`aisuite4cn` 针对于中国的各类大模型厂商提供通用的支持。学习了`aisuite`方案，并开发了该库。
+
+`aisuite4cn` 使得开发者能够通过标准化的接口轻松使用多个大型语言模型（LLM）。使用类似于OpenAI的接口，`aisuite4cn` 使得与最受欢迎的LLM互动并比较结果变得简单。它是Python客户端库的轻量级包装器，允许创造者在不改变代码的情况下无缝切换并测试来自不同LLM提供商的响应。我们将在不久的将来扩展它以覆盖更多的用例。
+
+当前支持的提供商包括：
+moonshot（月之暗面）、Doubao（火山引擎）、Qwen（阿里云千问大模型）。
+
+
+## Integrated Open source project
+Special thanks to all contributors
+
+### aisuite
+https://github.com/andrewyng/aisuite
+
+### openai-python
+https://github.com/openai/openai-python

aisuite4cn-0.1.0/aisuite4cn/__init__.py

@@ -0,0 +1 @@
+from .client import Client

aisuite4cn-0.1.0/aisuite4cn/client.py

@@ -0,0 +1,117 @@
+from .provider import ProviderFactory
+
+
+class Client:
+    def __init__(self, provider_configs: dict = {}):
+        """
+        Initialize the client with provider configurations.
+        Use the ProviderFactory to create provider instances.
+
+        Args:
+            provider_configs (dict): A dictionary containing provider configurations.
+                Each key should be a provider string (e.g., "google" or "aws-bedrock"),
+                and the value should be a dictionary of configuration options for that provider.
+                For example:
+                {
+                    "openai": {"api_key": "your_openai_api_key"},
+                    "aws-bedrock": {
+                        "aws_access_key": "your_aws_access_key",
+                        "aws_secret_key": "your_aws_secret_key",
+                        "aws_region": "us-west-2"
+                    }
+                }
+        """
+        self.providers = {}
+        self.provider_configs = provider_configs
+        self._chat = None
+        self._initialize_providers()
+
+    def _initialize_providers(self):
+        """Helper method to initialize or update providers."""
+        for provider_key, config in self.provider_configs.items():
+            provider_key = self._validate_provider_key(provider_key)
+            self.providers[provider_key] = ProviderFactory.create_provider(
+                provider_key, config
+            )
+
+    def _validate_provider_key(self, provider_key):
+        """
+        Validate if the provider key corresponds to a supported provider.
+        """
+        supported_providers = ProviderFactory.get_supported_providers()
+
+        if provider_key not in supported_providers:
+            raise ValueError(
+                f"Invalid provider key '{provider_key}'. Supported providers: {supported_providers}. "
+                "Make sure the model string is formatted correctly as 'provider:model'."
+            )
+
+        return provider_key
+
+    def configure(self, provider_configs: dict = None):
+        """
+        Configure the client with provider configurations.
+        """
+        if provider_configs is None:
+            return
+
+        self.provider_configs.update(provider_configs)
+        self._initialize_providers()  # NOTE: This will override existing provider instances.
+
+    @property
+    def chat(self):
+        """Return the chat API interface."""
+        if not self._chat:
+            self._chat = Chat(self)
+        return self._chat
+
+
+class Chat:
+    def __init__(self, client: "Client"):
+        self.client = client
+        self._completions = Completions(self.client)
+
+    @property
+    def completions(self):
+        """Return the completions interface."""
+        return self._completions
+
+
+class Completions:
+    def __init__(self, client: "Client"):
+        self.client = client
+
+    def create(self, model: str, messages: list, **kwargs):
+        """
+        Create chat completion based on the model, messages, and any extra arguments.
+        """
+        # Check that correct format is used
+        if ":" not in model:
+            raise ValueError(
+                f"Invalid model format. Expected 'provider:model', got '{model}'"
+            )
+
+        # Extract the provider key from the model identifier, e.g., "google:gemini-xx"
+        provider_key, model_name = model.split(":", 1)
+
+        # Validate if the provider is supported
+        supported_providers = ProviderFactory.get_supported_providers()
+        if provider_key not in supported_providers:
+            raise ValueError(
+                f"Invalid provider key '{provider_key}'. Supported providers: {supported_providers}. "
+                "Make sure the model string is formatted correctly as 'provider:model'."
+            )
+
+        # Initialize provider if not already initialized
+        if provider_key not in self.client.providers:
+            config = self.client.provider_configs.get(provider_key, {})
+            self.client.providers[provider_key] = ProviderFactory.create_provider(
+                provider_key, config
+            )
+
+        provider = self.client.providers.get(provider_key)
+        if not provider:
+            raise ValueError(f"Could not load provider for '{provider_key}'.")
+
+        # Delegate the chat completion to the correct provider's implementation
+        return provider.chat_completions_create(model_name, messages, **kwargs)

aisuite4cn-0.1.0/aisuite4cn/framework/__init__.py

@@ -0,0 +1,2 @@
+from .provider_interface import ProviderInterface
+from .chat_completion_response import ChatCompletionResponse

aisuite4cn-0.1.0/aisuite4cn/framework/chat_completion_response.py

@@ -0,0 +1,8 @@
+from .choice import Choice
+
+
+class ChatCompletionResponse:
+    """Used to conform to the response model of OpenAI"""
+
+    def __init__(self):
+        self.choices = [Choice()]  # Adjust the range as needed for more choices

aisuite4cn-0.1.0/aisuite4cn/framework/choice.py

@@ -0,0 +1,6 @@
+from .message import Message
+
+
+class Choice:
+    def __init__(self):
+        self.message = Message()

aisuite4cn-0.1.0/aisuite4cn/framework/message.py

@@ -0,0 +1,6 @@
+"""Interface to hold contents of api responses when they do not confirm to the OpenAI style response"""
+
+
+class Message:
+    def __init__(self):
+        self.content = None

aisuite4cn-0.1.0/aisuite4cn/framework/provider_interface.py

@@ -0,0 +1,25 @@
+"""The shared interface for model providers."""
+
+
+class ProviderInterface:
+    """Defines the expected behavior for provider-specific interfaces."""
+
+    def chat_completion_create(self, messages=None, model=None, temperature=0) -> None:
+        """Create a chat completion using the specified messages, model, and temperature.
+
+        This method must be implemented by subclasses to perform completions.
+
+        Args:
+        ----
+            messages (list): The chat history.
+            model (str): The identifier of the model to be used in the completion.
+            temperature (float): The temperature to use in the completion.
+
+        Raises:
+        ------
+            NotImplementedError: If this method has not been implemented by a subclass.
+
+        """
+        raise NotImplementedError(
+            "Provider Interface has not implemented chat_completion_create()"
+        )

aisuite4cn-0.1.0/aisuite4cn/provider.py

@@ -0,0 +1,53 @@
+from abc import ABC, abstractmethod
+from pathlib import Path
+import importlib
+import os
+import functools
+
+
+class LLMError(Exception):
+    """Custom exception for LLM errors."""
+
+    def __init__(self, message):
+        super().__init__(message)
+
+
+class Provider(ABC):
+    @abstractmethod
+    def chat_completions_create(self, model, messages):
+        """Abstract method for chat completion calls, to be implemented by each provider."""
+        pass
+
+
+class ProviderFactory:
+    """Factory to dynamically load provider instances based on naming conventions."""
+
+    PROVIDERS_DIR = Path(__file__).parent / "providers"
+
+    @classmethod
+    def create_provider(cls, provider_key, config):
+        """Dynamically load and create an instance of a provider based on the naming convention."""
+        # Convert provider_key to the expected module and class names
+        provider_class_name = f"{provider_key.capitalize()}Provider"
+        provider_module_name = f"{provider_key}_provider"
+
+        module_path = f"aisuite.providers.{provider_module_name}"
+
+        # Lazily load the module
+        try:
+            module = importlib.import_module(module_path)
+        except ImportError as e:
+            raise ImportError(
+                f"Could not import module {module_path}: {str(e)}. Please ensure the provider is supported by doing ProviderFactory.get_supported_providers()"
+            )
+
+        # Instantiate the provider class
+        provider_class = getattr(module, provider_class_name)
+        return provider_class(**config)
+
+    @classmethod
+    @functools.cache
+    def get_supported_providers(cls):
+        """List all supported provider names based on files present in the providers directory."""
+        provider_files = Path(cls.PROVIDERS_DIR).glob("*_provider.py")
+        return {file.stem.replace("_provider", "") for file in provider_files}

aisuite4cn-0.1.0/aisuite4cn/providers/moonshot_provider.py

@@ -0,0 +1,37 @@
+import openai
+import os
+from aisuite4cn.provider import Provider, LLMError
+
+
+class MoonshotProvider(Provider):
+    """
+    月之暗面提供者
+    """
+    def __init__(self, **config):
+        """
+        Initialize the Moonshot provider with the given configuration.
+        Pass the entire configuration dictionary to the Moonshot client constructor.
+        """
+        # Ensure API key is provided either in config or via environment variable
+        self.api_key = config.get("api_key") or os.getenv("MOONSHOT_API_KEY")
+        if not self.api_key:
+            raise ValueError(
+                "Moonshot API key is missing. Please provide it in the config or set the MOONSHOT_API_KEY environment variable."
+            )
+        kvargs = dict(config)
+        kvargs.pop("api_key")
+        # Pass the entire config to the Moonshot client constructor
+        self.client = openai.OpenAI(
+            api_key = self.api_key,
+            base_url = "https://api.moonshot.cn/v1",
+            **kvargs)
+
+    def chat_completions_create(self, model, messages, **kwargs):
+        # Any exception raised by Moonshot will be returned to the caller.
+        # Maybe we should catch them and raise a custom LLMError.
+        return self.client.chat.completions.create(
+            model=model,
+            messages=messages,
+            **kwargs  # Pass any additional arguments to the Moonshot API
+        )
+

aisuite4cn-0.1.0/aisuite4cn/providers/qwen_provider.py

@@ -0,0 +1,36 @@
+import openai
+import os
+from aisuite4cn.provider import Provider, LLMError
+
+
+class QwenProvider(Provider):
+    """
+    阿里云大模型服务平台针对于千问大模型的提供者，使用了千问大模型兼容OpenAI的接口
+    """
+    def __init__(self, **config):
+        """
+        Initialize the Qwen shot provider with the given configuration.
+        Pass the entire configuration dictionary to the Qwen client constructor.
+        """
+        # Ensure API key is provided either in config or via environment variable
+        self.api_key = config.get("api_key") or os.getenv("DASHSCOPE_API_KEY")
+        if not self.api_key:
+            raise ValueError(
+                "Dashscope API key is missing. Please provide it in the config or set the DASHSCOPE_API_KEY environment variable."
+            )
+        kvargs = dict(config)
+        kvargs.pop("api_key")
+        # Pass the entire config to the Qwen client constructor
+        self.client = openai.OpenAI(
+            api_key=self.api_key,
+            base_url='https://dashscope.aliyuncs.com/compatible-mode/v1',
+            **kvargs)
+
+    def chat_completions_create(self, model, messages, **kwargs):
+        # Any exception raised by Qwen will be returned to the caller.
+        # Maybe we should catch them and raise a custom LLMError.
+        return self.client.chat.completions.create(
+            model=model,
+            messages=messages,
+            **kwargs  # Pass any additional arguments to the Qwen API
+        )

aisuite4cn-0.1.0/aisuite4cn/providers/volcengine_provider.py

@@ -0,0 +1,46 @@
+from argparse import ArgumentError
+
+import openai
+import os
+from aisuite4cn.provider import Provider, LLMError
+
+
+class VolcengineProvider(Provider):
+    """
+    火山引擎方舟大模型服务平台提供者
+    """
+    def __init__(self, **config):
+        """
+        Initialize the Volcengine provider with the given configuration.
+        Pass the entire configuration dictionary to the Volcengine client constructor.
+        """
+        # Ensure API key is provided either in config or via environment variable
+        self.api_key = config.get("api_key") or os.getenv("ARK_API_KEY")
+
+        if not self.api_key:
+            raise ValueError(
+                "Ark API key is missing. Please provide it in the config or set the OPENAI_API_KEY environment variable."
+            )
+        self.config = config
+
+        kvargs = dict(config)
+        kvargs.pop("api_key")
+        # Pass the entire config to the Ark client constructor
+
+        self.client = openai.OpenAI(
+            api_key=self.api_key,
+            base_url="https://ark.cn-beijing.volces.com/api/v3",
+            **kvargs)
+
+    def chat_completions_create(self, model, messages, **kwargs):
+
+        # Any exception raised by Ark will be returned to the caller.
+        # Maybe we should catch them and raise a custom LLMError.
+
+        if not model.startswith("ep-"):
+            raise ValueError("The model name must be the endpoint ID of the model.")
+        return self.client.chat.completions.create(
+            model=model,
+            messages=messages,
+            **kwargs  # Pass any additional arguments to the Ark API
+        )

aisuite4cn-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[tool.poetry]
+name = "aisuite4cn"
+version = "0.1.0"
+description = ""
+authors = ["胡伟 <3314672@qq.com>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+pydantic = "^2.10.3"
+openai = { version = "^1.35.8", optional = true }
+
+# Optional dependencies for different providers
+httpx = "~0.27.0"
+
+[tool.poetry.extras]
+moonshot = ["openai"]
+volcengine = ["openai"]
+qwen = ["openai"]
+
+[tool.poetry.group.dev.dependencies]
+openai = "^1.35.8"
+
+[tool.poetry.group.test]
+optional = true
+
+[tool.poetry.group.test.dependencies]
+pytest = "^8.2.2"
+pytest-cov = "^6.0.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"