pycorex 1.0.4__py3-none-any.whl

pycorex/__init__.py

@@ -0,0 +1,7 @@
+
+__copyright__    = 'Copyright (C) 2025- unchainworks'
+__version__      = '1.0.1'
+__license__      = 'BSD-3-Clause'
+__author__       = 'unchainworks'
+__author_email__ = 'kajin0318@gmail.com'
+__url__          = 'https://github.com/kaioman/pycorex.git'

pycorex/configs/app_init.py

@@ -0,0 +1,21 @@
+from libcore_hng.utils.app_core import AppInitializer
+from pycorex.configs.pycorex import PyCorexConfig
+
+class PyCorexAppInitializer(AppInitializer[PyCorexConfig]):
+    """
+    AppInitializer拡張クラス
+    """
+    def __init__(self, base_file: str = __file__, *config_file: str):
+        # 基底コンストラクタに拡張Configクラスを渡す
+        super().__init__(PyCorexConfig, base_file, *config_file)
+
+core: PyCorexAppInitializer | None = None
+""" AppInitializer拡張クラスインスタンス """
+
+def init_app(base_file: str = __file__, *config_file: str) -> PyCorexAppInitializer:
+    """
+    アプリケーション初期化
+    """
+    global core
+    core = PyCorexAppInitializer(base_file, *config_file)
+    return core

pycorex/configs/pycorex.py

@@ -0,0 +1,18 @@
+from libcore_hng.core.base_config import BaseConfig
+from pycorex.models.gemini import GeminiModel
+from pycorex.models.vertexai import VertexaiModel
+from pycorex.models.prompt import PromptModel
+
+class PyCorexConfig(BaseConfig):
+    """
+    pycorex共通設定クラス
+    """
+    
+    gemini: GeminiModel = GeminiModel()
+    """ Gemini設定クラスモデル """
+    
+    vertexai: VertexaiModel = VertexaiModel()
+    """ Vertexai設定クラスモデル """
+    
+    prompt: PromptModel = PromptModel()
+    """ プロンプト系クラスモデル """

pycorex/core/base_ai_client.py

@@ -0,0 +1,298 @@
+import imghdr
+from abc import ABC, abstractmethod
+from enum import Enum
+
+class BaseAIClient(ABC):
+    """
+    BaseAIClient
+    """
+    
+    class AILang(Enum):
+        """
+        言語設定
+        """
+        
+        JP = 'ja'
+        """ 日本語 """
+
+        EN = 'en'
+        """ 英語 """
+    class AspectRatio(Enum):
+        """
+        画像生成時に指定可能なアスペクト比を表すEnumクラス
+
+        各メンバーは Vertex AI / Gen AI SDK の
+        `generate_images` メソッドにおける `aspect_ratio` パラメータに対応する
+        """
+
+        SQUARE = "1:1"
+        """ 正方形の画像(例：アイコンやサムネイル用途) """
+
+        WIDE = "16:9"
+        """ 横長の画像(例：プレゼン資料や動画用サムネイル) """
+        
+        TALL = "9:16"
+        """ 縦長の画像(例：スマホ画面やSNSストーリー用途) """
+        
+        PORTRAIT = "3:4"
+        """ 縦長の画像(例：ポートレート写真や印刷用途) """
+        
+        LANDSCAPE = "4:3"
+        """ 横長の画像(例：一般的な写真やディスプレイ用途) """
+        
+        def __str__(self) -> str:
+            """
+            Enumの値を文字列として返す
+
+            Returns
+            -------
+            str
+                aspect_ratio の指定値 (例: "16:9")
+            """
+            return self.value
+        
+    class PersonGeneration(Enum):
+        """
+        画像生成時に人物の生成を制御するためのEnumクラス
+
+        各メンバーは Vertex AI / Gen AI SDK の
+        `generate_images` メソッドにおける `person_generation` パラメータに対応する
+        """
+        
+        DONT_ALLOW = "dont_allow"
+        """ 人物の画像生成をブロックする """
+
+        ALLOW_ADULT = "allow_adult"
+        """ 大人の画像のみ生成を許可し、子供の画像は生成しない """
+
+        ALLOW_ALL = "allow_all"
+        """ 大人と子供の画像の生成を許可する """
+
+        def __str__(self):
+            """
+            Enumの値を文字列値として返す
+
+            Returns
+            -------
+            str
+                person_generation の指定値
+            """
+            return self.value
+    
+    class SafetyFilterLevel(Enum):
+        """
+        画像生成時に適用される安全フィルタリングレベルを表すEnumクラス
+
+        各メンバーは Vertex AI / Gen AI SDK の
+        `generate_images` メソッドにおける `safety_filter_level` パラメータに対応する
+        
+        Notes
+        -----
+        - BLOCK_NONE は allowlist 専用の設定であり、通常の環境では利用できない
+        未許可の環境で指定すると以下の例外が発生する
+
+            HTTP 400 Error:
+            "The block_none safetySetting is currently an allowlist-only feature.
+            Please check your current safetySetting value or contact your Google representative
+            to request allowlisting."
+
+        - 通常利用可能な値は以下の通り:
+            * BLOCK_LOW_AND_ABOVE
+            * BLOCK_MEDIUM_AND_ABOVE
+            * BLOCK_ONLY_HIGH
+        """
+        
+        BLOCK_LOW_AND_ABOVE = "block_low_and_above"
+        """
+        最も強力なフィルタリングレベル
+        最も厳格なブロックが実施される
+        非推奨の値: "block_most"
+        """
+
+        BLOCK_MEDIUM_AND_ABOVE = "block_medium_and_above"
+        """
+        中程度以上の問題のあるプロンプトやレスポンスをブロックする
+        非推奨の値: "block_some"
+        """
+
+        BLOCK_ONLY_HIGH = "block_only_high"
+        """
+        高レベルの問題があるプロンプトやレスポンスのみをブロックする
+        ブロック回数を削減する
+        非推奨の値: "block_few"
+        """
+
+        BLOCK_NONE = "block_none"
+        """
+        ごく少数の問題のあるプロンプトやレスポンスをブロックする
+        ほとんどフィルタリングを行わない
+        非推奨の値: "block_fewest"
+        """
+
+        def __str__(self) -> str:
+            """
+            Enumの値を文字列として返す
+
+            Returns
+            -------
+            str
+                safety_filter_level の指定値
+            """
+            return self.value
+
+    class HarmCategory(Enum):
+        """
+        Gemini API の安全フィルターカテゴリを表す Enum クラス。
+
+        この Enum は、Google Generative AI (Gemini) の `GenerateContentConfig.safety_settings`
+        に指定可能な「有害コンテンツカテゴリ」を定義する
+        各カテゴリはモデルが生成するコンテンツをフィルタリングする際に利用される
+
+        """
+
+        HARM_CATEGORY_HARASSMENT = "HARM_CATEGORY_HARASSMENT"
+        """ ハラスメントコンテンツ。嫌がらせや攻撃的な表現を含む可能性があるもの """
+
+        HARM_CATEGORY_HATE_SPEECH = "HARM_CATEGORY_HATE_SPEECH"
+        """ ヘイトスピーチコンテンツ。特定の人種、宗教、性別などに対する差別的表現 """
+
+        HARM_CATEGORY_SEXUALLY_EXPLICIT = "HARM_CATEGORY_SEXUALLY_EXPLICIT"
+        """ 性的描写が露骨なコンテンツ。成人向けの性的表現を含むもの """
+
+        HARM_CATEGORY_DANGEROUS_CONTENT = "HARM_CATEGORY_DANGEROUS_CONTENT"
+        """ 危険なコンテンツ。暴力、違法行為、危険な行動を助長する可能性があるもの """
+
+        HARM_CATEGORY_CIVIC_INTEGRITY = "HARM_CATEGORY_CIVIC_INTEGRITY"
+        """ 
+        市民の清廉性を損なう可能性があるコンテンツ 
+        非推奨
+        """
+        
+    def __init__(self):
+        """
+        コンストラクタ
+        """
+
+        # 生成モデル
+        self.model = None
+    
+    def set_model(self, model: Enum):
+        """
+        生成モデルをセットする
+        """
+
+        # 生成モデル
+        self.model = model
+    
+    @abstractmethod
+    def _configuration_client(self):
+        """
+        APIクライアントの初期化処理
+        
+        Notes
+        -----
+        内部的に `genai.configure(api_key=...)` を呼び出し、
+        `self.client` に設定する
+        """
+        pass
+    
+    def guess_mime_type(self, image_bytes: bytes) -> str:
+        """
+        バイト列から画像のMIME typeを推測する
+
+        Parameters
+        ----------
+        image_bytes : bytes
+            画像データ
+
+        Returns
+        -------
+        str
+            MIME type (例: "image/png", "image/jpeg")
+        """
+
+        # フォーマット判定
+        fmt = imghdr.what(None, h=image_bytes)
+        
+        if fmt == "png":
+            return "image/png"
+        elif fmt == "jpeg":
+            return "image/jpeg"
+        elif fmt == "gif":
+            return "image/gif"
+        elif fmt == "bmp":
+            return "image/bmp"
+        elif fmt == "webp":
+            return "image/webp"
+        else:
+            return "application/octet-stream"
+
+    #@abstractmethod
+    #def calc_tokens(self, prompt: str, response_text: str) -> dict:
+    #    """
+    #    プロンプトと応答テキストのトークン数を計算する
+    #    """
+    #    pass
+    
+    #@abstractmethod
+    #def generate_text(self, prompt: str, language: AILang = AILang.JP, include_row: bool = False) -> Dict[str, Any]:
+    #    pass
+
+    #@abstractmethod
+    #def generate_image(self, prompt: str, pspect_ratio:str, number_of_images:int = 1, include_row: bool = False) -> list[bytes]:
+    #    pass
+    
+    # def set_prompt(self, _jsonFileName):
+        
+    #     """
+    #     プロンプトをセットする
+        
+    #     Parameters
+    #     ----------
+    #     _jsonFileName : str
+    #         プロンプトのjsonファイル名
+    #     """
+
+    #     # ファイル名
+    #     jsonFilePath = os.path.join(
+    #         os.path.dirname(self.rootPath), 
+    #         self.jsonFilePath,
+    #         _jsonFileName)
+        
+    #     # jsonファイルチェック
+    #     if not os.path.exists(jsonFilePath):
+    #         Logger.logging.info('jsonfile is not found.')
+    #         return
+
+    #     # jsonファイルOpen
+    #     with open(jsonFilePath, encoding="utf-8") as f:
+    #         self.promptList = json.loads(f.read())
+        
+    # def request(self):
+        
+    #     """
+    #     APIから応答を取得する
+
+    #     Parameters
+    #     ----------
+    #     None
+    #     """
+
+    #     pass
+    
+    # def get_content(self, _targetContent):
+        
+    #     """
+    #     jsonファイルからContentsを取得する
+        
+    #     Parameters
+    #     ----------
+    #     _targetContent : str or list
+    #         対象のContent
+    #     """
+        
+    #     if isinstance(self.promptList[_targetContent], list):
+    #         return '\n'.join(self.promptList[_targetContent])
+    #     else:
+    #         return self.promptList[_targetContent]
+    

pycorex/exceptions/no_candidates_error.py

@@ -0,0 +1,20 @@
+from libcore_hng.core.base_app_exception import AppBaseException
+
+class NoCandidatesError(AppBaseException):
+    """
+    画像生成失敗例外クラス
+    
+    - 画像生成候補が返されなかった場合に発生する例外
+    """
+    
+    def __init__(self, exc: Exception = None):
+        """
+        コンストラクタ
+        
+        Parameters
+        ----------
+        exc : Exception, optional
+            捕捉した例外オブジェクト。指定しない場合は None
+            渡された例外の型・値・トレースバックを保持する
+        """
+        super().__init__(exc)