unique_toolkit 1.11.3__tar.gz → 1.12.0__tar.gz

{unique_toolkit-1.11.3 → unique_toolkit-1.12.0}/CHANGELOG.md

@@ -4,7 +4,15 @@ 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).
-## [1.11.3] - 2026-10-06
+
+## [1.12.0] - 2026-10-07
+- Add the `OpenAIUserMessageBuilder` for complex user messages with images
+- More examples with documents/images on the chat
+
+## [1.11.4] - 2026-10-07
+- Make newer `MessageExecution` and `MessageLog` method keyword only
+
+## [1.11.3] - 2026-10-07
 - Move smart rules to content
 - Add to documentation
 

{unique_toolkit-1.11.3 → unique_toolkit-1.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 1.11.3
+Version: 1.12.0
 Summary: 
 License: Proprietary
 Author: Cedric Klinkert
@@ -117,7 +117,15 @@ 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).
-## [1.11.3] - 2026-10-06
+
+## [1.12.0] - 2026-10-07
+- Add the `OpenAIUserMessageBuilder` for complex user messages with images
+- More examples with documents/images on the chat
+
+## [1.11.4] - 2026-10-07
+- Make newer `MessageExecution` and `MessageLog` method keyword only
+
+## [1.11.3] - 2026-10-07
 - Move smart rules to content
 - Add to documentation
 

{unique_toolkit-1.11.3 → unique_toolkit-1.12.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "unique_toolkit"
-version = "1.11.3"
+version = "1.12.0"
 description = ""
 authors = [
     "Cedric Klinkert <cedric.klinkert@unique.ch>",

{unique_toolkit-1.11.3 → unique_toolkit-1.12.0}/unique_toolkit/chat/service.py

@@ -714,6 +714,7 @@ class ChatService(ChatServiceDeprecated):
 
     def create_message_log(
         self,
+        *,
         message_id: str,
         text: str,
         status: MessageLogStatus,
@@ -754,6 +755,7 @@ class ChatService(ChatServiceDeprecated):
 
     async def create_message_log_async(
         self,
+        *,
         message_id: str,
         text: str,
         status: MessageLogStatus,
@@ -794,6 +796,7 @@ class ChatService(ChatServiceDeprecated):
 
     def update_message_log(
         self,
+        *,
         message_log_id: str,
         order: int,
         text: str | None = None,
@@ -834,6 +837,7 @@ class ChatService(ChatServiceDeprecated):
 
     async def update_message_log_async(
         self,
+        *,
         message_log_id: str,
         order: int,
         text: str | None = None,
@@ -874,6 +878,7 @@ class ChatService(ChatServiceDeprecated):
 
     def create_assistant_message_log(
         self,
+        *,
         text: str,
         status: MessageLogStatus,
         order: int,
@@ -912,6 +917,7 @@ class ChatService(ChatServiceDeprecated):
 
     async def create_assistant_message_log_async(
         self,
+        *,
         text: str,
         status: MessageLogStatus,
         order: int,
@@ -953,6 +959,7 @@ class ChatService(ChatServiceDeprecated):
 
     def create_message_execution(
         self,
+        *,
         message_id: str,
         type: MessageExecutionType = MessageExecutionType.DEEP_RESEARCH,
         seconds_remaining: int | None = None,
@@ -985,6 +992,7 @@ class ChatService(ChatServiceDeprecated):
 
     async def create_message_execution_async(
         self,
+        *,
         message_id: str,
         type: MessageExecutionType = MessageExecutionType.DEEP_RESEARCH,
         seconds_remaining: int | None = None,
@@ -1017,6 +1025,7 @@ class ChatService(ChatServiceDeprecated):
 
     def get_message_execution(
         self,
+        *,
         message_id: str,
     ) -> MessageExecution:
         """Gets a message execution by message ID synchronously.
@@ -1039,6 +1048,7 @@ class ChatService(ChatServiceDeprecated):
 
     async def get_message_execution_async(
         self,
+        *,
         message_id: str,
     ) -> MessageExecution:
         """Gets a message execution by message ID asynchronously.
@@ -1061,6 +1071,7 @@ class ChatService(ChatServiceDeprecated):
 
     def update_message_execution(
         self,
+        *,
         message_id: str,
         status: MessageExecutionUpdateStatus,
         seconds_remaining: int | None = None,
@@ -1092,6 +1103,7 @@ class ChatService(ChatServiceDeprecated):
 
     async def update_message_execution_async(
         self,
+        *,
         message_id: str,
         status: MessageExecutionUpdateStatus,
         seconds_remaining: int | None = None,
@@ -1123,6 +1135,7 @@ class ChatService(ChatServiceDeprecated):
 
     def create_assistant_message_execution(
         self,
+        *,
         type: MessageExecutionType = MessageExecutionType.DEEP_RESEARCH,
         seconds_remaining: int | None = None,
         percentage_completed: int | None = None,
@@ -1152,6 +1165,7 @@ class ChatService(ChatServiceDeprecated):
 
     async def create_assistant_message_execution_async(
         self,
+        *,
         type: MessageExecutionType = MessageExecutionType.DEEP_RESEARCH,
         seconds_remaining: int | None = None,
         percentage_completed: int | None = None,
@@ -1211,6 +1225,7 @@ class ChatService(ChatServiceDeprecated):
 
     def update_assistant_message_execution(
         self,
+        *,
         status: MessageExecutionUpdateStatus,
         seconds_remaining: int | None = None,
         percentage_completed: int | None = None,
@@ -1240,6 +1255,7 @@ class ChatService(ChatServiceDeprecated):
 
     async def update_assistant_message_execution_async(
         self,
+        *,
         status: MessageExecutionUpdateStatus,
         seconds_remaining: int | None = None,
         percentage_completed: int | None = None,

{unique_toolkit-1.11.3 → unique_toolkit-1.12.0}/unique_toolkit/framework_utilities/openai/message_builder.py

@@ -1,5 +1,8 @@
+import base64
+import mimetypes
 from collections.abc import Iterable
-from typing import Self
+from pathlib import Path
+from typing import Self, overload
 
 from openai.types.chat.chat_completion_assistant_message_param import (
     Audio,
@@ -7,6 +10,10 @@ from openai.types.chat.chat_completion_assistant_message_param import (
     ContentArrayOfContentPart,
     FunctionCall,
 )
+from openai.types.chat.chat_completion_content_part_image_param import (
+    ChatCompletionContentPartImageParam,
+    ImageURL,
+)
 from openai.types.chat.chat_completion_content_part_param import (
     ChatCompletionContentPartParam,
 )
@@ -32,6 +39,83 @@ from openai.types.chat.chat_completion_tool_message_param import (
 from openai.types.chat.chat_completion_user_message_param import (
     ChatCompletionUserMessageParam,
 )
+from typing_extensions import Literal
+
+
+class OpenAIUserMessageBuilder:
+    def __init__(
+        self,
+    ) -> None:
+        self._messages: list[ChatCompletionContentPartParam] = []
+
+    def append_text(self, content: str) -> Self:
+        part = ChatCompletionContentPartTextParam(
+            type="text",
+            text=content,
+        )
+        self._messages.append(part)
+        return self
+
+    @overload
+    def append_image(
+        self, *, url: str, detail: Literal["auto", "low", "high"] = "auto"
+    ) -> Self: ...
+
+    @overload
+    def append_image(
+        self, *, path: Path, detail: Literal["auto", "low", "high"] = "auto"
+    ) -> Self: ...
+
+    @overload
+    def append_image(
+        self,
+        *,
+        content: bytes,
+        mime_type: str,
+        detail: Literal["auto", "low", "high"] = "auto",
+    ) -> Self: ...
+
+    def append_image(
+        self,
+        *,
+        url: str | None = None,
+        path: Path | None = None,
+        content: bytes | None = None,
+        mime_type: str | None = None,
+        detail: Literal["auto", "low", "high"] = "auto",
+    ) -> Self:
+        if url is None and path is None and (content is None or mime_type is None):
+            raise ValueError("Either url or path must be provided")
+
+        if path is not None:
+            # Read image file and encode as base64 data URI
+            image_data = path.read_bytes()
+            base64_image = base64.b64encode(image_data).decode("utf-8")
+            mime_type = mimetypes.guess_type(str(path))[0] or "image/jpeg"
+            url = f"data:{mime_type};base64,{base64_image}"
+
+        if content is not None and mime_type is not None:
+            base64_image = base64.b64encode(content).decode("utf-8")
+            url = f"data:{mime_type};base64,{base64_image}"
+
+        image_url = ImageURL(url=url or "", detail=detail)
+        part = ChatCompletionContentPartImageParam(
+            type="image_url",
+            image_url=image_url,
+        )
+        self._messages.append(part)
+        return self
+
+    @property
+    def user_message(self) -> ChatCompletionUserMessageParam:
+        return ChatCompletionUserMessageParam(
+            content=self._messages,
+            role="user",
+        )
+
+    @property
+    def iterable_content(self) -> Iterable[ChatCompletionContentPartParam]:
+        return self._messages
 
 
 class OpenAIMessageBuilder: