unique_toolkit 0.5.20__tar.gz → 0.5.21__tar.gz

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

@@ -5,6 +5,9 @@ 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
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 0.5.20
+Version: 0.5.21
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -100,6 +100,9 @@ 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
 

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "unique_toolkit"
-version = "0.5.20"
+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.20/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()