symbolicai 0.21.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

symai/backend/engines/text_vision/engine_clip.py

@@ -1,39 +1,38 @@
 import logging
-import requests
+from io import BytesIO
 
+import requests
 import torch
-from typing import Optional
 from PIL import Image
-from io import BytesIO
 from transformers import CLIPModel, CLIPProcessor
 
+from ....utils import UserMessage
 from ...base import Engine
 from ...settings import SYMAI_CONFIG
 
-
 # supress warnings
 logging.getLogger("PIL").setLevel(logging.WARNING)
 
 
 class CLIPEngine(Engine):
-    def __init__(self, model: Optional[str] = None):
+    def __init__(self, model: str | None = None):
         super().__init__()
-        self.model =  None # lazy loading
-        self.preprocessor = None # lazy loading
+        self.model = None  # lazy loading
+        self.preprocessor = None  # lazy loading
         self.config = SYMAI_CONFIG
-        self.model_id = self.config['VISION_ENGINE_MODEL'] if model is None else model
-        self.old_model_id = self.config['VISION_ENGINE_MODEL'] if model is None else model
+        self.model_id = self.config["VISION_ENGINE_MODEL"] if model is None else model
+        self.old_model_id = self.config["VISION_ENGINE_MODEL"] if model is None else model
         self.name = self.__class__.__name__
 
     def id(self) -> str:
-        if self.config['VISION_ENGINE_MODEL']:
-            return 'text_vision'
-        return super().id() # default to unregistered
+        if self.config["VISION_ENGINE_MODEL"]:
+            return "text_vision"
+        return super().id()  # default to unregistered
 
     def command(self, *args, **kwargs):
         super().command(*args, **kwargs)
-        if 'VISION_ENGINE_MODEL' in kwargs:
-            self.model_id     = kwargs['VISION_ENGINE_MODEL']
+        if "VISION_ENGINE_MODEL" in kwargs:
+            self.model_id = kwargs["VISION_ENGINE_MODEL"]
 
     def load_images(self, image):
         images = []
@@ -44,38 +43,41 @@ class CLIPEngine(Engine):
             if isinstance(img, bytes):
                 images.append(Image.open(BytesIO(img)))
             elif isinstance(img, str):
-                if img.startswith('http'):
-                    image_ = requests.get(img, stream=True).raw
-                else:
-                    image_ = img
-                image = Image.open(image_)
+                image_source = requests.get(img, stream=True).raw if img.startswith("http") else img
+                image = Image.open(image_source)
                 images.append(image)
         return images
 
     def forward(self, argument):
-        image_url, text       = argument.prop.prepared_input
+        image_url, text = argument.prop.prepared_input
 
         if self.model is None or self.model_id != self.old_model_id:
-            self.device       = torch.device("cuda" if torch.cuda.is_available() else "cpu")
-            self.model        = CLIPModel.from_pretrained(self.model_id).to(self.device)
-            self.processor    = CLIPProcessor.from_pretrained(self.model_id)
+            self.device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
+            self.model = CLIPModel.from_pretrained(self.model_id).to(self.device)
+            self.processor = CLIPProcessor.from_pretrained(self.model_id)
             self.old_model_id = self.model_id
 
         if text is None and image_url is not None:
-            image             = self.load_images(image_url)
-            inputs            = self.processor(images=image, return_tensors="pt").to(self.device)
-            rsp               = self.model.get_image_features(**inputs)
+            image = self.load_images(image_url)
+            inputs = self.processor(images=image, return_tensors="pt").to(self.device)
+            rsp = self.model.get_image_features(**inputs)
         elif image_url is None and text is not None:
-            inputs            = self.processor(text=text, return_tensors="pt").to(self.device)
-            rsp               = self.model.get_text_features(**inputs)
+            inputs = self.processor(text=text, return_tensors="pt").to(self.device)
+            rsp = self.model.get_text_features(**inputs)
         elif image_url is not None and text is not None:
-            image             = self.load_images(image_url)
-            inputs            = self.processor(text=text, images=image, return_tensors="pt", padding=True).to(self.device)
-            outputs           = self.model(**inputs)
-            logits_per_image  = outputs.logits_per_image  # this is the image-text similarity score
-            rsp               = logits_per_image.softmax(dim=1)  # we can take the softmax to get the label probabilities
+            image = self.load_images(image_url)
+            inputs = self.processor(text=text, images=image, return_tensors="pt", padding=True).to(
+                self.device
+            )
+            outputs = self.model(**inputs)
+            logits_per_image = outputs.logits_per_image  # this is the image-text similarity score
+            rsp = logits_per_image.softmax(
+                dim=1
+            )  # we can take the softmax to get the label probabilities
         else:
-            raise NotImplementedError("CLIPEngine requires either image or text input.")
+            UserMessage(
+                "CLIPEngine requires either image or text input.", raise_with=NotImplementedError
+            )
 
         rsp = rsp.squeeze().detach().cpu().numpy()
 
@@ -85,7 +87,7 @@ class CLIPEngine(Engine):
 
     def prepare(self, argument):
         assert not argument.prop.processed_input, "CLIPEngine does not support processed_input."
-        kwargs     = argument.kwargs
-        image_url  = argument.kwargs['image'] if 'image' in kwargs else None
-        text       = argument.kwargs['text']  if 'text'  in kwargs else None
+        kwargs = argument.kwargs
+        image_url = argument.kwargs["image"] if "image" in kwargs else None
+        text = argument.kwargs["text"] if "text" in kwargs else None
         argument.prop.prepared_input = (image_url, text)

symai/backend/engines/userinput/engine_console.py

@@ -1,5 +1,4 @@
-from typing import List
-
+from ....utils import UserMessage
 from ...base import Engine
 
 
@@ -9,15 +8,15 @@ class UserInputEngine(Engine):
         self.name = self.__class__.__name__
 
     def id(self) -> str:
-        return 'userinput'
+        return "userinput"
 
     def forward(self, argument):
         msg = argument.prop.prepared_input
         kwargs = argument.kwargs
 
-        mock = kwargs['mock'] if 'mock' in kwargs else False
-        if mock: # mock user input
-            print(msg, end='') # print prompt
+        mock = kwargs.get("mock", False)
+        if mock:  # mock user input
+            UserMessage(msg)
             rsp = mock
         else:
             rsp = input(msg)

symai/backend/mixin/__init__.py

@@ -8,3 +8,16 @@ from .groq import SUPPORTED_CHAT_MODELS as GROQ_CHAT_MODELS
 from .groq import SUPPORTED_REASONING_MODELS as GROQ_REASONING_MODELS
 from .openai import SUPPORTED_CHAT_MODELS as OPENAI_CHAT_MODELS
 from .openai import SUPPORTED_REASONING_MODELS as OPENAI_REASONING_MODELS
+
+__all__ = [
+    "ANTHROPIC_CHAT_MODELS",
+    "ANTHROPIC_REASONING_MODELS",
+    "DEEPSEEK_CHAT_MODELS",
+    "DEEPSEEK_REASONING_MODELS",
+    "GOOGLE_CHAT_MODELS",
+    "GOOGLE_REASONING_MODELS",
+    "GROQ_CHAT_MODELS",
+    "GROQ_REASONING_MODELS",
+    "OPENAI_CHAT_MODELS",
+    "OPENAI_REASONING_MODELS",
+]

symai/backend/mixin/anthropic.py

@@ -1,56 +1,66 @@
 # https://docs.anthropic.com/en/docs/about-claude/models
 SUPPORTED_CHAT_MODELS = [
-    'claude-3-5-sonnet-latest',
-    'claude-3-5-haiku-latest',
-    'claude-3-5-sonnet-20241022',
-    'claude-3-5-sonnet-20240620',
-    'claude-3-opus-latest',
-    'claude-3-opus-20240229',
-    'claude-3-sonnet-20240229',
-    'claude-3-haiku-20240307',
+    "claude-3-5-sonnet-latest",
+    "claude-3-5-haiku-latest",
+    "claude-3-5-sonnet-20241022",
+    "claude-3-5-sonnet-20240620",
+    "claude-3-opus-latest",
+    "claude-3-opus-20240229",
+    "claude-3-sonnet-20240229",
+    "claude-3-haiku-20240307",
 ]
 SUPPORTED_REASONING_MODELS = [
     "claude-opus-4-1",
     "claude-opus-4-0",
     "claude-sonnet-4-0",
-    'claude-3-7-sonnet-latest',
-    'claude-haiku-4-5',
-    'claude-sonnet-4-5',
+    "claude-3-7-sonnet-latest",
+    "claude-haiku-4-5",
+    "claude-sonnet-4-5",
 ]
 
+
 class AnthropicMixin:
     def api_max_context_tokens(self):
-        if self.model == 'claude-opus-4-1' or \
-           self.model == 'claude-opus-4-0' or \
-           self.model == 'claude-sonnet-4-0' or \
-           self.model == 'claude-3-7-sonnet-latest' or \
-           self.model == 'claude-haiku-4-5' or \
-           self.model == 'claude-sonnet-4-5' or \
-           self.model == 'claude-3-5-sonnet-latest' or \
-           self.model == 'claude-3-5-sonnet-20241022' or \
-           self.model == 'claude-3-5-sonnet-20240620' or \
-           self.model == 'claude-3-opus-latest' or \
-           self.model == 'claude-3-opus-20240229' or \
-           self.model == 'claude-3-sonnet-20240229' or \
-           self.model == 'claude-3-haiku-20240307':
+        if (
+            self.model == "claude-opus-4-1"
+            or self.model == "claude-opus-4-0"
+            or self.model == "claude-sonnet-4-0"
+            or self.model == "claude-3-7-sonnet-latest"
+            or self.model == "claude-haiku-4-5"
+            or self.model == "claude-sonnet-4-5"
+            or self.model == "claude-3-5-sonnet-latest"
+            or self.model == "claude-3-5-sonnet-20241022"
+            or self.model == "claude-3-5-sonnet-20240620"
+            or self.model == "claude-3-opus-latest"
+            or self.model == "claude-3-opus-20240229"
+            or self.model == "claude-3-sonnet-20240229"
+            or self.model == "claude-3-haiku-20240307"
+        ):
             return 200_000
+        return None
 
     def api_max_response_tokens(self):
-        if self.model == 'claude-sonnet-4-0' or \
-           self.model == 'claude-3-7-sonnet-latest' or \
-           self.model == 'claude-haiku-4-5' or \
-           self.model == 'claude-sonnet-4-5':
+        if (
+            self.model == "claude-sonnet-4-0"
+            or self.model == "claude-3-7-sonnet-latest"
+            or self.model == "claude-haiku-4-5"
+            or self.model == "claude-sonnet-4-5"
+        ):
             return 64_000
-        if self.model == 'claude-opus-4-1' or \
-           self.model == 'claude-opus-4-0':
+        if self.model == "claude-opus-4-1" or self.model == "claude-opus-4-0":
             return 32_000
-        if self.model == 'claude-3-5-sonnet-latest' or \
-           self.model == 'claude-3-5-sonnet-20241022' or \
-           self.model == 'claude-3-5-haiku-latest':
+        if (
+            self.model == "claude-3-5-sonnet-latest"
+            or self.model == "claude-3-5-sonnet-20241022"
+            or self.model == "claude-3-5-haiku-latest"
+        ):
             return 8_192
-        if self.model == 'claude-3-5-sonnet-20240620' or \
-           self.model == 'claude-3-opus-latest' or \
-           self.model == 'clade-3-opus-20240229' or \
-           self.model == 'claude-3-sonnet-20240229' or \
-           self.model == 'claude-3-haiku-20240307':
+        if (
+            self.model == "claude-3-5-sonnet-20240620"
+            or self.model == "claude-3-opus-latest"
+            or self.model == "clade-3-opus-20240229"
+            or self.model == "claude-3-sonnet-20240229"
+            or self.model == "claude-3-haiku-20240307"
+        ):
             return 4_096
+        return None

symai/backend/mixin/deepseek.py

@@ -1,14 +1,15 @@
 # https://api-docs.deepseek.com/quick_start/pricing
 SUPPORTED_CHAT_MODELS = []
-SUPPORTED_REASONING_MODELS = [
-    'deepseek-reasoner'
-]
+SUPPORTED_REASONING_MODELS = ["deepseek-reasoner"]
+
 
 class DeepSeekMixin:
     def api_max_context_tokens(self):
-        if self.model == 'deepseek-reasoner':
+        if self.model == "deepseek-reasoner":
             return 64_000
+        return None
 
     def api_max_response_tokens(self):
-        if self.model == 'deepseek-reasoner':
+        if self.model == "deepseek-reasoner":
             return 8_000
+        return None

symai/backend/mixin/google.py

@@ -2,15 +2,18 @@
 SUPPORTED_CHAT_MODELS = []
 SUPPORTED_REASONING_MODELS = [
     # Check the latest snapshots; ie. *-06-05, etc
-    'gemini-2.5-pro',
-    'gemini-2.5-flash',
+    "gemini-2.5-pro",
+    "gemini-2.5-flash",
 ]
 
+
 class GoogleMixin:
     def api_max_context_tokens(self):
-        if self.model.startswith('gemini-2.5-'):
+        if self.model.startswith("gemini-2.5-"):
             return 1_048_576
+        return None
 
     def api_max_response_tokens(self):
-        if self.model == 'gemini-2.5-':
+        if self.model == "gemini-2.5-":
             return 65_536
+        return None

symai/backend/mixin/groq.py

@@ -1,10 +1,8 @@
-SUPPORTED_CHAT_MODELS = [
-    "groq:moonshotai/kimi-k2-instruct"
-]
+SUPPORTED_CHAT_MODELS = ["groq:moonshotai/kimi-k2-instruct"]
 
 SUPPORTED_REASONING_MODELS = [
     "groq:openai/gpt-oss-120b",
     "groq:openai/gpt-oss-20b",
     "groq:qwen/qwen3-32b",
-    "groq:deepseek-r1-distill-llama-70b"
+    "groq:deepseek-r1-distill-llama-70b",
 ]

symai/backend/mixin/openai.py

@@ -1,134 +1,164 @@
+from ...utils import UserMessage
+
 SUPPORTED_COMPLETION_MODELS = [
-    'davinci-002',
+    "davinci-002",
 ]
 SUPPORTED_CHAT_MODELS = [
-    'gpt-3.5-turbo',
-    'gpt-3.5-turbo-16k',
-    'gpt-3.5-turbo-1106',
-    'gpt-3.5-turbo-0613',
-    'gpt-4',
-    'gpt-4-0613',
-    'gpt-4-1106-preview', # @NOTE: probabily obsolete; same price as 'gpt-4-turbo-2024-04-09' but no vision
-    'gpt-4-turbo',
-    'gpt-4-turbo-2024-04-09',
-    'gpt-4o',
-    'gpt-4o-2024-11-20',
-    'gpt-4o-mini',
-    'chatgpt-4o-latest',
-    'gpt-4.1',
-    'gpt-4.1-mini',
-    'gpt-4.1-nano',
-    'gpt-5-chat-latest',
+    "gpt-3.5-turbo",
+    "gpt-3.5-turbo-16k",
+    "gpt-3.5-turbo-1106",
+    "gpt-3.5-turbo-0613",
+    "gpt-4",
+    "gpt-4-0613",
+    "gpt-4-1106-preview",  # @NOTE: probabily obsolete; same price as 'gpt-4-turbo-2024-04-09' but no vision
+    "gpt-4-turbo",
+    "gpt-4-turbo-2024-04-09",
+    "gpt-4o",
+    "gpt-4o-2024-11-20",
+    "gpt-4o-mini",
+    "chatgpt-4o-latest",
+    "gpt-4.1",
+    "gpt-4.1-mini",
+    "gpt-4.1-nano",
+    "gpt-5-chat-latest",
+    "gpt-5.1-chat-latest",
 ]
 SUPPORTED_REASONING_MODELS = [
-    'o3-mini',
-    'o4-mini',
-    'o1',
-    'o3',
-    'gpt-5',
-    'gpt-5-mini',
-    'gpt-5-nano',
+    "o3-mini",
+    "o4-mini",
+    "o1",
+    "o3",
+    "gpt-5",
+    "gpt-5.1",
+    "gpt-5-mini",
+    "gpt-5-nano",
 ]
 SUPPORTED_EMBEDDING_MODELS = [
-    'text-embedding-ada-002',
-    'text-embedding-3-small',
-    'text-embedding-3-large'
+    "text-embedding-ada-002",
+    "text-embedding-3-small",
+    "text-embedding-3-large",
 ]
 
 
 class OpenAIMixin:
     def api_max_context_tokens(self):
-        if self.model == 'text-curie-001' or \
-           self.model == 'text-babbage-001' or \
-           self.model == 'text-ada-001' or \
-           self.model == 'davinci' or \
-           self.model == 'curie' or \
-           self.model == 'babbage' or \
-           self.model == 'ada':
-               return 2_049
-        if self.model == 'gpt-3.5-turbo' or \
-           self.model == 'gpt-3.5-turbo-0613' or \
-           self.model == 'gpt-3.5-turbo-1106':
-               return 4_096
-        if self.model == 'gpt-4' or \
-           self.model == 'gpt-4-0613' or \
-           self.model == 'text-embedding-ada-002' or \
-           self.model == 'text-embedding-3-small' or \
-           self.model == 'text-embedding-3-large':
-               return 8_192
-        if self.model == 'gpt-3.5-turbo-16k' or \
-           self.model == 'gpt-3.5-turbo-16k-0613' or \
-           self.model == 'davinci-002':
-               return 16_384
-        if self.model == 'gpt-4-32k' or \
-           self.model == 'gpt-4-32k-0613':
-               return 32_768
-        if self.model == 'gpt-4-1106-preview' or \
-           self.model == 'gpt-4-turbo-2024-04-09' or \
-           self.model == 'gpt-4-turbo' or \
-           self.model == 'gpt-4-1106' or \
-           self.model == 'gpt-4o' or \
-           self.model == 'gpt-4o-2024-11-20' or \
-           self.model == 'gpt-4o-mini' or \
-           self.model == 'chatgpt-4o-latest':
-               return 128_000
-        if self.model == 'o1' or \
-           self.model == 'o3' or \
-           self.model == 'o3-mini' or \
-           self.model == 'o4-mini':
-               return 200_000
-        if self.model == 'gpt-5' or \
-           self.model == 'gpt-5-mini' or \
-           self.model == 'gpt-5-nano' or \
-           self.model == 'gpt-5-chat-latest':
+        if (
+            self.model == "text-curie-001"
+            or self.model == "text-babbage-001"
+            or self.model == "text-ada-001"
+            or self.model == "davinci"
+            or self.model == "curie"
+            or self.model == "babbage"
+            or self.model == "ada"
+        ):
+            return 2_049
+        if (
+            self.model == "gpt-3.5-turbo"
+            or self.model == "gpt-3.5-turbo-0613"
+            or self.model == "gpt-3.5-turbo-1106"
+        ):
+            return 4_096
+        if (
+            self.model == "gpt-4"
+            or self.model == "gpt-4-0613"
+            or self.model == "text-embedding-ada-002"
+            or self.model == "text-embedding-3-small"
+            or self.model == "text-embedding-3-large"
+        ):
+            return 8_192
+        if (
+            self.model == "gpt-3.5-turbo-16k"
+            or self.model == "gpt-3.5-turbo-16k-0613"
+            or self.model == "davinci-002"
+        ):
+            return 16_384
+        if self.model == "gpt-4-32k" or self.model == "gpt-4-32k-0613":
+            return 32_768
+        if (
+            self.model == "gpt-4-1106-preview"
+            or self.model == "gpt-4-turbo-2024-04-09"
+            or self.model == "gpt-4-turbo"
+            or self.model == "gpt-4-1106"
+            or self.model == "gpt-4o"
+            or self.model == "gpt-4o-2024-11-20"
+            or self.model == "gpt-4o-mini"
+            or self.model == "chatgpt-4o-latest"
+        ):
+            return 128_000
+        if (
+            self.model == "o1"
+            or self.model == "o3"
+            or self.model == "o3-mini"
+            or self.model == "o4-mini"
+            or self.model == "gpt-5-chat-latest"
+            or self.model == "gpt-5.1-chat-latest"
+        ):
+            return 200_000
+        if (
+            self.model == "gpt-5"
+            or self.model == "gpt-5.1"
+            or self.model == "gpt-5-mini"
+            or self.model == "gpt-5-nano"
+        ):
             return 400_000
-        if self.model == 'gpt-4.1' or \
-           self.model == 'gpt-4.1-mini' or \
-           self.model == 'gpt-4.1-nano':
+        if self.model == "gpt-4.1" or self.model == "gpt-4.1-mini" or self.model == "gpt-4.1-nano":
             return 1_047_576
-        raise ValueError(f'Unsupported model: {self.model}')
+        msg = f"Unsupported model: {self.model}"
+        UserMessage(msg)
+        raise ValueError(msg)
 
     def api_max_response_tokens(self):
-        if self.model == 'davinci-002':
+        if self.model == "davinci-002":
             return 2_048
-        if self.model == 'gpt-4-turbo' or \
-           self.model == 'gpt-4-turbo-2024-04-09' or \
-           self.model == 'gpt-4-1106-preview' or \
-           self.model == 'gpt-3.5-turbo-1106' or \
-           self.model == 'gpt-3.5-turbo-0613' or \
-           self.model == 'gpt-3.5-turbo':
-               return 4_096
-        if self.model == 'gpt-4-0613' or \
-           self.model == 'gpt-4':
-               return 8_192
-        if self.model == 'gpt-3.5-turbo-16k-0613' or \
-           self.model == 'gpt-3.5-turbo-16k' or \
-           self.model == 'gpt-4o-mini' or \
-           self.model == 'gpt-4o' or \
-           self.model == 'gpt-4o-2024-11-20' or \
-           self.model == 'chatgpt-4o-latest':
-               return 16_384
-        if self.model == 'gpt-4.1' or \
-           self.model == 'gpt-4.1-mini' or \
-           self.model == 'gpt-4.1-nano':
+        if (
+            self.model == "gpt-4-turbo"
+            or self.model == "gpt-4-turbo-2024-04-09"
+            or self.model == "gpt-4-1106-preview"
+            or self.model == "gpt-3.5-turbo-1106"
+            or self.model == "gpt-3.5-turbo-0613"
+            or self.model == "gpt-3.5-turbo"
+        ):
+            return 4_096
+        if self.model == "gpt-4-0613" or self.model == "gpt-4":
+            return 8_192
+        if (
+            self.model == "gpt-3.5-turbo-16k-0613"
+            or self.model == "gpt-3.5-turbo-16k"
+            or self.model == "gpt-4o-mini"
+            or self.model == "gpt-4o"
+            or self.model == "gpt-4o-2024-11-20"
+            or self.model == "chatgpt-4o-latest"
+            or self.model == "gpt-5-chat-latest"
+            or self.model == "gpt-5.1-chat-latest"
+        ):
+            return 16_384
+        if self.model == "gpt-4.1" or self.model == "gpt-4.1-mini" or self.model == "gpt-4.1-nano":
             return 32_768
-        if self.model == 'o1' or \
-           self.model == 'o3' or \
-           self.model == 'o3-mini' or \
-           self.model == 'o4-mini':
-               return 100_000
-        if self.model == 'gpt-5' or \
-           self.model == 'gpt-5-mini' or \
-           self.model == 'gpt-5-nano' or \
-           self.model == 'gpt-5-chat-latest':
+        if (
+            self.model == "o1"
+            or self.model == "o3"
+            or self.model == "o3-mini"
+            or self.model == "o4-mini"
+        ):
+            return 100_000
+        if (
+            self.model == "gpt-5"
+            or self.model == "gpt-5.1"
+            or self.model == "gpt-5-mini"
+            or self.model == "gpt-5-nano"
+        ):
             return 128_000
-        raise ValueError(f'Unsupported model: {self.model}')
+        msg = f"Unsupported model: {self.model}"
+        UserMessage(msg)
+        raise ValueError(msg)
 
     def api_embedding_dims(self):
-        if self.model == 'text-embedding-ada-002':
+        if self.model == "text-embedding-ada-002":
             return 1_536
-        if self.model == 'text-embedding-3-small':
+        if self.model == "text-embedding-3-small":
             return 1_536
-        if self.model == 'text-embedding-3-large':
+        if self.model == "text-embedding-3-large":
             return 3_072
-        raise ValueError(f'Unsupported model: {self.model}')
+        msg = f"Unsupported model: {self.model}"
+        UserMessage(msg)
+        raise ValueError(msg)