unique_toolkit 0.5.16__py3-none-any.whl → 0.5.17__py3-none-any.whl

unique_toolkit/language_model/infos.py

@@ -22,17 +22,18 @@ class LanguageModelName(StrEnum):
 
 class LanguageModelProvider(StrEnum):
     AZURE = "AZURE"
+    CUSTOM = "CUSTOM"
 
 
 class LanguageModelInfo(BaseModel):
-    name: LanguageModelName
+    name: LanguageModelName | str
     version: str
     provider: LanguageModelProvider
 
-    token_limits: LanguageModelTokenLimits
+    token_limits: Optional[LanguageModelTokenLimits] = None
 
-    info_cutoff_at: date
-    published_at: date
+    info_cutoff_at: Optional[date] = None
+    published_at: Optional[date] = None
     retirement_at: Optional[date] = None
 
     deprecated_at: Optional[date] = None
@@ -42,7 +43,7 @@ class LanguageModelInfo(BaseModel):
 class LanguageModel:
     _info: ClassVar[LanguageModelInfo]
 
-    def __init__(self, model_name: LanguageModelName):
+    def __init__(self, model_name: LanguageModelName | str):
         self._model_info = self.get_model_info(model_name)
 
     @property
@@ -62,9 +63,9 @@ class LanguageModel:
         return self._model_info
 
     @property
-    def name(self) -> LanguageModelName:
+    def name(self) -> LanguageModelName | str:
         """
-        Returns the LanguageModelName of the model.
+        Returns the LanguageModelName of the model or the name string when it is a custom / not defined model.
         """
         return self._model_info.name
 
@@ -73,10 +74,13 @@ class LanguageModel:
         """
         Returns the name of the model as a string.
         """
-        return self._model_info.name.name
+        if isinstance(self._model_info.name, LanguageModelName):
+            return self._model_info.name.name
+        else:
+            return self._model_info.name
 
     @property
-    def version(self) -> str:
+    def version(self) -> Optional[str]:
         """
         Returns the version of the model.
         """
@@ -87,31 +91,34 @@ class LanguageModel:
         """
         Returns the maximum number of tokens for the model.
         """
-        return self._model_info.token_limits.token_limit
+        if self._model_info.token_limits:
+            return self._model_info.token_limits.token_limit
 
     @property
     def token_limit_input(self) -> Optional[int]:
         """
         Returns the maximum number of input tokens for the model.
         """
-        return self._model_info.token_limits.token_limit_input
+        if self._model_info.token_limits:
+            return self._model_info.token_limits.token_limit_input
 
     @property
     def token_limit_output(self) -> Optional[int]:
         """
         Returns the maximum number of output tokens for the model.
         """
-        return self._model_info.token_limits.token_limit_output
+        if self._model_info.token_limits:
+            return self._model_info.token_limits.token_limit_output
 
     @property
-    def info_cutoff_at(self) -> date:
+    def info_cutoff_at(self) -> Optional[date]:
         """
         Returns the date the model was last updated.
         """
         return self._model_info.info_cutoff_at
 
     @property
-    def published_at(self) -> date:
+    def published_at(self) -> Optional[date]:
         """
         Returns the date the model was published.
         """
@@ -146,7 +153,10 @@ class LanguageModel:
         return self._model_info.provider
 
     @classmethod
-    def get_model_info(cls, model_name: LanguageModelName) -> LanguageModelInfo:
+    def get_model_info(cls, model_name: LanguageModelName | str) -> LanguageModelInfo:
+        if not model_name:
+            raise ValueError("Model name must be provided to get the model info.")
+
         for subclass in cls.__subclasses__():
             if hasattr(subclass, "info") and subclass._info.name == model_name:
                 # TODO find alternative solution for warning
@@ -155,7 +165,12 @@ class LanguageModel:
                 #     print(warning_text)
                 #     warnings.warn(warning_text, DeprecationWarning, stacklevel=2)
                 return subclass._info
-        raise ValueError(f"Model {model_name} not found.")
+
+        return LanguageModelInfo(
+            name=model_name,
+            version="custom",
+            provider=LanguageModelProvider.CUSTOM,
+        )
 
     @classmethod
     def list_models(cls) -> list[LanguageModelInfo]:

unique_toolkit/language_model/service.py

@@ -33,7 +33,7 @@ class LanguageModelService(BaseService):
     def complete(
         self,
         messages: LanguageModelMessages,
-        model_name: LanguageModelName,
+        model_name: LanguageModelName | str,
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
         tools: Optional[list[LanguageModelTool]] = None,
@@ -43,7 +43,7 @@ class LanguageModelService(BaseService):
 
         Args:
             messages (LanguageModelMessages): The LanguageModelMessages obj to complete.
-            model_name (LanguageModelName): The model name.
+            model_name (LanguageModelName | str): The model name.
             temperature (float): The temperature value. Defaults to 0.
             timeout (int): The timeout value in milliseconds. Defaults to 240_000.
             tools (Optional[list[LanguageModelTool]]): The tools to use. Defaults to None.
@@ -53,11 +53,15 @@ class LanguageModelService(BaseService):
         """
         options = self._add_tools_to_options({}, tools)
         messages = messages.model_dump(exclude_none=True)
+        model = (
+            model_name.name if isinstance(model_name, LanguageModelName) else model_name
+        )
+
         try:
             response = unique_sdk.ChatCompletion.create(
                 company_id=self.event.company_id,
                 # TODO change or extend types in unique_sdk
-                model=model_name.name,
+                model=model,
                 messages=cast(
                     list[unique_sdk.Integrated.ChatCompletionRequestMessage],
                     messages,
@@ -74,7 +78,7 @@ class LanguageModelService(BaseService):
     async def complete_async(
         self,
         messages: LanguageModelMessages,
-        model_name: LanguageModelName,
+        model_name: LanguageModelName | str,
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
         tools: Optional[list[LanguageModelTool]] = None,
@@ -84,7 +88,7 @@ class LanguageModelService(BaseService):
 
         Args:
             messages (LanguageModelMessages): The messages to complete.
-            model_name (LanguageModelName): The model name.
+            model_name (LanguageModelName | str): The model name.
             temperature (float): The temperature value. Defaults to 0.
             timeout (int): The timeout value in milliseconds. Defaults to 240_000.
             tools (Optional[list[LanguageModelTool]]): The tools to use. Defaults to None.
@@ -94,11 +98,15 @@ class LanguageModelService(BaseService):
         """
         options = self._add_tools_to_options({}, tools)
         messages = messages.model_dump(exclude_none=True, exclude={"tool_calls"})
+        model = (
+            model_name.name if isinstance(model_name, LanguageModelName) else model_name
+        )
+
         try:
             response = await unique_sdk.ChatCompletion.create_async(
                 company_id=self.event.company_id,
                 # TODO change or extend types in unique_sdk
-                model=model_name.name,
+                model=model,
                 messages=cast(
                     list[unique_sdk.Integrated.ChatCompletionRequestMessage],
                     messages,
@@ -115,7 +123,7 @@ class LanguageModelService(BaseService):
     def stream_complete(
         self,
         messages: LanguageModelMessages,
-        model_name: LanguageModelName,
+        model_name: LanguageModelName | str,
         content_chunks: list[ContentChunk] = [],
         debug_info: dict = {},
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
@@ -129,7 +137,7 @@ class LanguageModelService(BaseService):
         Args:
             messages (LanguageModelMessages): The LanguageModelMessages object to stream.
             content_chunks (list[ContentChunk]): The ContentChunks objects.
-            model_name (LanguageModelName): The language model to use for the completion.
+            model_name (LanguageModelName | str): The language model to use for the completion.
             debug_info (dict): The debug information. Defaults to {}.
             temperature (float): The temperature value. Defaults to 0.25.
             timeout (int): The timeout value in milliseconds. Defaults to 240_000.
@@ -142,6 +150,9 @@ class LanguageModelService(BaseService):
         options = self._add_tools_to_options({}, tools)
         search_context = self._to_search_context(content_chunks)
         messages = messages.model_dump(exclude_none=True)
+        model = (
+            model_name.name if isinstance(model_name, LanguageModelName) else model_name
+        )
 
         try:
             response = unique_sdk.Integrated.chat_stream_completion(
@@ -156,7 +167,7 @@ class LanguageModelService(BaseService):
                 chatId=self.event.payload.chat_id,
                 searchContext=search_context,
                 # TODO change or extend types in unique_sdk
-                model=model_name.name,
+                model=model,
                 timeout=timeout,
                 temperature=temperature,
                 assistantId=self.event.payload.assistant_id,
@@ -172,7 +183,7 @@ class LanguageModelService(BaseService):
     async def stream_complete_async(
         self,
         messages: LanguageModelMessages,
-        model_name: LanguageModelName,
+        model_name: LanguageModelName | str,
         content_chunks: list[ContentChunk] = [],
         debug_info: dict = {},
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
@@ -186,7 +197,7 @@ class LanguageModelService(BaseService):
         Args:
             messages (LanguageModelMessages): The LanguageModelMessages object to stream.
             content_chunks (list[ContentChunk]): The content chunks.
-            model_name (LanguageModelName): The language model to use for the completion.
+            model_name (LanguageModelName | str): The language model to use for the completion.
             debug_info (dict): The debug information. Defaults to {}.
             temperature (float): The temperature value. Defaults to 0.25.
             timeout (int): The timeout value in milliseconds. Defaults to 240_000.
@@ -200,6 +211,9 @@ class LanguageModelService(BaseService):
         options = self._add_tools_to_options({}, tools)
         search_context = self._to_search_context(content_chunks)
         messages = messages.model_dump(exclude_none=True, exclude=["tool_calls"])
+        model = (
+            model_name.name if isinstance(model_name, LanguageModelName) else model_name
+        )
 
         try:
             response = await unique_sdk.Integrated.chat_stream_completion_async(
@@ -213,7 +227,7 @@ class LanguageModelService(BaseService):
                 ),
                 chatId=self.event.payload.chat_id,
                 searchContext=search_context,
-                model=model_name.name,
+                model=model,
                 timeout=timeout,
                 temperature=temperature,
                 assistantId=self.event.payload.assistant_id,

{unique_toolkit-0.5.16.dist-info → unique_toolkit-0.5.17.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 0.5.16
+Version: 0.5.17
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -101,7 +101,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.5.16] - 2024-08-27
+## [0.5.17] - 2024-08-30
+- Add option to initiate `LanguageModel` with a string
+- Add option to call `LanguageModelService` functions also with a string instead of `LanguageModelName` enum for parameter `model_name`.
+
+## [0.5.16] - 2024-08-29
 - Fix `ContentService.upload_content` function.
 
 ## [0.5.15] - 2024-08-27

{unique_toolkit-0.5.16.dist-info → unique_toolkit-0.5.17.dist-info}/RECORD

@@ -22,11 +22,11 @@ unique_toolkit/embedding/schemas.py,sha256=1GvKCaSk4jixzVQ2PKq8yDqwGEVY_hWclYtoA
 unique_toolkit/embedding/service.py,sha256=Iiw-sbdkjuWlWMfLM9qyC4GNTJOotQAaVjkYvh5Su4Y,2370
 unique_toolkit/embedding/utils.py,sha256=v86lo__bCJbxZBQ3OcLu5SuwT6NbFfWlcq8iyk6BuzQ,279
 unique_toolkit/language_model/__init__.py,sha256=QgU_uwpVh1URQyVs6l-6Am4UwmEEhuGXNic3dUZ0FCc,1701
-unique_toolkit/language_model/infos.py,sha256=JkugUAFFlrhTHXeM3A_R5QLkNSR9Ro85xWQFcdc2oM0,9307
+unique_toolkit/language_model/infos.py,sha256=ETAUV0YTs6BjwuiTdhKz247CtL0W8Jwo3-c0ZQ2HdXs,9962
 unique_toolkit/language_model/schemas.py,sha256=h5zjZNk7O-wLKtRuiNtMCIbp5hEVXrAOviKonQcjFuI,4594
-unique_toolkit/language_model/service.py,sha256=JjsOOcGDcR7db3yF3_oDXclEGfxqmwWpL5jor7Q42cU,10470
+unique_toolkit/language_model/service.py,sha256=8s2tiGLE5ryKQDOtEbNaFkc73NngANxvFNr-hD-dgps,10948
 unique_toolkit/language_model/utils.py,sha256=WBPj1XKkDgxy_-T8HCZvsfkkSzj_1w4UZzNmyvdbBLY,1081
-unique_toolkit-0.5.16.dist-info/LICENSE,sha256=bIeCWCYuoUU_MzNdg48-ubJSVm7qxakaRbzTiJ5uxrs,1065
-unique_toolkit-0.5.16.dist-info/METADATA,sha256=h7bIucz9PpU2PCc6BLMlAkDQO4s9aBZB_sGsc69oMlc,10301
-unique_toolkit-0.5.16.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-unique_toolkit-0.5.16.dist-info/RECORD,,
+unique_toolkit-0.5.17.dist-info/LICENSE,sha256=bIeCWCYuoUU_MzNdg48-ubJSVm7qxakaRbzTiJ5uxrs,1065
+unique_toolkit-0.5.17.dist-info/METADATA,sha256=EQ-ycT-rGgOHG8Qu2Gr4OvMUl_i8Tdh2CT-M2e--gLM,10519
+unique_toolkit-0.5.17.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+unique_toolkit-0.5.17.dist-info/RECORD,,