unique_toolkit 0.5.19__tar.gz → 0.5.21__tar.gz

{unique_toolkit-0.5.19 → unique_toolkit-0.5.21}/CHANGELOG.md

@@ -5,8 +5,14 @@ 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.21] - 2024-09-16
+- Add `tool` as new role `ChatMessage`, as well as `tool_calls` and `tool_call_id` as additional parameters
+
+## [0.5.20] - 2024-09-16
+- `LanguageModelService` now supports complete_util_async that can be called without instantiating the class, currently being used in the Hallucination service and evaluation API
+
 ## [0.5.19] - 2024-09-11
-- `LanguageModelMessage` now supports content as a list of dictionnary. Useful when adding image_url content along user message. 
+- `LanguageModelMessage` now supports content as a list of dictionary. Useful when adding image_url content along user message. 
 
 ## [0.5.18] - 2024-09-03
 - Adds option to use `metadata_filter` with search.

{unique_toolkit-0.5.19 → unique_toolkit-0.5.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 0.5.19
+Version: 0.5.21
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -100,8 +100,14 @@ 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.21] - 2024-09-16
+- Add `tool` as new role `ChatMessage`, as well as `tool_calls` and `tool_call_id` as additional parameters
+
+## [0.5.20] - 2024-09-16
+- `LanguageModelService` now supports complete_util_async that can be called without instantiating the class, currently being used in the Hallucination service and evaluation API
+
 ## [0.5.19] - 2024-09-11
-- `LanguageModelMessage` now supports content as a list of dictionnary. Useful when adding image_url content along user message. 
+- `LanguageModelMessage` now supports content as a list of dictionary. Useful when adding image_url content along user message. 
 
 ## [0.5.18] - 2024-09-03
 - Adds option to use `metadata_filter` with search.

{unique_toolkit-0.5.19 → unique_toolkit-0.5.21}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "unique_toolkit"
-version = "0.5.19"
+version = "0.5.21"
 description = ""
 authors = [
     "Martin Fadler <martin.fadler@unique.ch>",

unique_toolkit-0.5.21/unique_toolkit/chat/schemas.py

@@ -0,0 +1,62 @@
+from enum import StrEnum
+from typing import Optional
+
+from humps import camelize
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    field_validator,
+    model_validator,
+)
+
+# set config to convert camelCase to snake_case
+model_config = ConfigDict(
+    alias_generator=camelize, populate_by_name=True, arbitrary_types_allowed=True
+)
+
+
+class ChatMessageRole(StrEnum):
+    USER = "user"
+    ASSISTANT = "assistant"
+    TOOL = "tool"
+
+
+class Function(BaseModel):
+    model_config = model_config
+
+    name: str
+    arguments: str
+
+
+class ToolCall(BaseModel):
+    model_config = model_config
+
+    id: str
+    type: str
+    function: Function
+
+
+class ChatMessage(BaseModel):
+    model_config = model_config
+
+    id: str | None = None
+    object: str | None = None
+    content: str = Field(alias="text")
+    role: ChatMessageRole
+    tool_calls: Optional[list[ToolCall]] = None
+    tool_call_id: Optional[str] = None
+    debug_info: dict | None = {}
+
+    # TODO make sdk return role consistently in lowercase
+    # Currently needed as sdk returns role in uppercase
+    @field_validator("role", mode="before")
+    def set_role(cls, value: str):
+        return value.lower()
+
+    # Ensure tool_call_ids is required if role is 'tool'
+    @model_validator(mode="after")
+    def check_tool_call_ids_for_tool_role(self):
+        if self.role == ChatMessageRole.TOOL and not self.tool_call_id:
+            raise ValueError("tool_call_ids is required when role is 'tool'")
+        return self

{unique_toolkit-0.5.19 → unique_toolkit-0.5.21}/unique_toolkit/language_model/service.py

@@ -75,37 +75,47 @@ class LanguageModelService(BaseService):
             self.logger.error(f"Error completing: {e}")
             raise e
 
-    async def complete_async(
-        self,
+    @classmethod
+    async def complete_async_util(
+        cls,
+        company_id: str,
         messages: LanguageModelMessages,
         model_name: LanguageModelName | str,
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
         tools: Optional[list[LanguageModelTool]] = None,
-    ):
+        logger: Optional[logging.Logger] = logging.getLogger(__name__),
+    ) -> LanguageModelResponse:
         """
         Calls the completion endpoint asynchronously without streaming the response.
 
+        This method sends a request to the completion endpoint using the provided messages, model name,
+        temperature, timeout, and optional tools. It returns a `LanguageModelResponse` object containing
+        the completed result.
+
         Args:
+            company_id (str): The company ID associated with the request.
             messages (LanguageModelMessages): The messages to complete.
-            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.
+            model_name (LanguageModelName | str): The model name to use for the completion.
+            temperature (float): The temperature setting for the completion. Defaults to 0.
+            timeout (int): The timeout value in milliseconds for the request. Defaults to 240_000.
+            tools (Optional[list[LanguageModelTool]]): Optional list of tools to include in the request.
+            logger (Optional[logging.Logger], optional): The logger used to log errors. Defaults to the logger for the current module.
 
         Returns:
-            str: The completed message content.
+            LanguageModelResponse: The response object containing the completed result.
+
+        Raises:
+            Exception: If an error occurs during the request, an exception is raised and logged.
         """
-        options = self._add_tools_to_options({}, tools)
+        options = cls._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
+                company_id=company_id,
                 model=model,
                 messages=cast(
                     list[unique_sdk.Integrated.ChatCompletionRequestMessage],
@@ -117,9 +127,47 @@ class LanguageModelService(BaseService):
             )
             return LanguageModelResponse(**response)
         except Exception as e:
-            self.logger.error(f"Error completing: {e}")
+            logger.error(f"Error completing: {e}")
             raise e
 
+    async def complete_async(
+        self,
+        messages: LanguageModelMessages,
+        model_name: LanguageModelName | str,
+        temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
+        timeout: int = DEFAULT_COMPLETE_TIMEOUT,
+        tools: Optional[list[LanguageModelTool]] = None,
+    ) -> LanguageModelResponse:
+        """
+        Calls the completion endpoint asynchronously without streaming the response.
+
+        This method utilizes the class method `complete_async_util` to perform the asynchronous completion
+        request using the provided messages, model name, temperature, timeout, and optional tools. It
+        returns a `LanguageModelResponse` object containing the result of the completion.
+
+        Args:
+            messages (LanguageModelMessages): The messages to complete.
+            model_name (LanguageModelName | str): The model name to use for the completion.
+            temperature (float): The temperature setting for the completion. Defaults to 0.0.
+            timeout (int): The timeout value in milliseconds for the request. Defaults to 240,000.
+            tools (Optional[list[LanguageModelTool]]): Optional list of tools to include in the request.
+
+        Returns:
+            LanguageModelResponse: The response object containing the completed result.
+
+        Raises:
+            Exception: If an error occurs during the completion request.
+        """
+        return await self.complete_async_util(
+            company_id=self.event.company_id,
+            messages=messages,
+            model_name=model_name,
+            temperature=temperature,
+            timeout=timeout,
+            tools=tools,
+            logger=self.logger,
+        )
+
     def stream_complete(
         self,
         messages: LanguageModelMessages,

unique_toolkit-0.5.19/unique_toolkit/chat/schemas.py

@@ -1,30 +0,0 @@
-from enum import StrEnum
-
-from humps import camelize
-from pydantic import BaseModel, ConfigDict, Field, field_validator
-
-# set config to convert camelCase to snake_case
-model_config = ConfigDict(
-    alias_generator=camelize, populate_by_name=True, arbitrary_types_allowed=True
-)
-
-
-class ChatMessageRole(StrEnum):
-    USER = "user"
-    ASSISTANT = "assistant"
-
-
-class ChatMessage(BaseModel):
-    model_config = model_config
-
-    id: str | None = None
-    object: str | None = None
-    content: str = Field(alias="text")
-    role: ChatMessageRole
-    debug_info: dict | None = {}
-
-    # TODO make sdk return role consistently in lowercase
-    # Currently needed as sdk returns role in uppercase
-    @field_validator("role", mode="before")
-    def set_role(cls, value: str):
-        return value.lower()