unique_sdk 0.10.31__tar.gz → 0.10.33__tar.gz

{unique_sdk-0.10.31 → unique_sdk-0.10.33}/CHANGELOG.md

@@ -5,6 +5,12 @@ 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.10.33] - 2025-10-27
+- Improve messagelog and message execution types.
+
+## [0.10.32] - 2025-10-14
+- Add function to stream to chat frontend.
+
 ## [0.10.31] - 2025-10-13
 - Add readme for message log and execution.
 

{unique_sdk-0.10.31 → unique_sdk-0.10.33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.10.31
+Version: 0.10.33
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -700,6 +700,26 @@ message = unique_sdk.Message.create(
 )
 ```
 
+#### `unique_sdk.Message.create_event`
+
+Create a new message event in a chat. Updating the text of a message in the chat UI is possible by creating a message update event. This function can be used for custom streaming to the chat. (Compatible with release >.42)
+
+The event only changes the text in the UI, it *does not* update the database.
+
+```python
+message = unique_sdk.Message.create_event(
+    user_id=user_id,
+    company_id=company_id,
+    messageId="msg_l4ushn85yqbewpf6tllh2cl7",
+    chatId="chat_kc8p3kgkn7393qhgmv5js5nt",
+    text="Hello.",                  #optional
+    originalText="Hello.",          #optional
+    references=[],                  #optional
+    gptRequest={}                   #optional
+    debugInfo={  "hello": "test" }, #optional
+)
+```
+
 #### `unique_sdk.Message.modify`
 
 Modify an existing chat message.
@@ -825,7 +845,7 @@ unique_sdk.Integrated.responses_stream(
 
 #### `unique_sdk.MessageLog.create`
 
-Create a message log for a provided `messageId`.
+Function to update the steps section of a message in the chat UI. This is possible by creating a message log record during a message execution.
 
 ```python
 msg_log = unique_sdk.MessageLog.create(
@@ -834,10 +854,10 @@ msg_log = unique_sdk.MessageLog.create(
     messageId="msg_a0jgnt1jrqv1d3uzr450waxw",
     text="Create message log text",
     order=1,
-    status="RUNNING",                               # one of "RUNNING", "COMPLETED", "FAILED"
-    details=None,                                   # optional, details dictionary
-    uncitedReferences=None,                         # optional, references dictionary
-    references=None,                                # optional, list of references
+    status="RUNNING",                             # one of "RUNNING", "COMPLETED", "FAILED"
+    details={},                                   # optional, details dictionary
+    uncitedReferences={},                         # optional, references dictionary
+    references=[],                                # optional, list of references
 )
 ```
 
@@ -850,12 +870,12 @@ msg_log = unique_sdk.MessageLog.update(
     user_id=user_id,
     company_id=company_id,
     message_log_id="message_log_fd7z7gjljo1z2wu5g6l9q7r9",
-    text="Update a message log text",               # optional
-    order=1,                                        # optional
-    status="RUNNING",                               # one of "RUNNING", "COMPLETED", "FAILED"
-    details=None,                                   # optional, details dictionary
-    uncitedReferences=None,                         # optional, references dictionary
-    references=None,                              
+    text="Update a message log text",             # optional
+    order=1,                                      # optional
+    status="RUNNING",                             # one of "RUNNING", "COMPLETED", "FAILED"
+    details={},                                   # optional, details dictionary
+    uncitedReferences={},                         # optional, references dictionary
+    references=[],                                # optional, list of references
 )
 ```
 
@@ -870,10 +890,7 @@ msg_execution = unique_sdk.MessageExecution.create(
     user_id=user_id,
     company_id=company_id,
     messageId="msg_a0jgnt1jrqv143uzr750waxw",
-    chatId="chat_nx21havszl1skchd7544oykh",
-    type="DEEP_RESEARCH"
-    secondsRemaining=None                       # optional, number defining the seconds remaining
-    percentageCompleted=None                    # optional, number defining the percentage completed
+    type="DEEP_RESEARCH",
 )
 ```
 
@@ -898,9 +915,9 @@ msg_execution = unique_sdk.MessageExecution.update(
     user_id=user_id,
     company_id=company_id,
     messageId="msg_a0jgnt1jrqv143uzr750waxw",
-    status="COMPLETED",                       # one of: COMPLETED, FAILED
-    secondsRemaining=55                       # optional, number defining the seconds remaining
-    percentageCompleted=10                    # optional, number defining the percentage completed
+    status="COMPLETED",                        # optional, one of: COMPLETED, FAILED - not specifying the status will have no effect over the status
+    secondsRemaining=55,                       # optional, number defining the seconds remaining
+    percentageCompleted=10,                    # optional, number defining the percentage completed
 )
 ```
 
@@ -1749,6 +1766,12 @@ 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.10.33] - 2025-10-27
+- Improve messagelog and message execution types.
+
+## [0.10.32] - 2025-10-14
+- Add function to stream to chat frontend.
+
 ## [0.10.31] - 2025-10-13
 - Add readme for message log and execution.
 

{unique_sdk-0.10.31 → unique_sdk-0.10.33}/README.md

@@ -682,6 +682,26 @@ message = unique_sdk.Message.create(
 )
 ```
 
+#### `unique_sdk.Message.create_event`
+
+Create a new message event in a chat. Updating the text of a message in the chat UI is possible by creating a message update event. This function can be used for custom streaming to the chat. (Compatible with release >.42)
+
+The event only changes the text in the UI, it *does not* update the database.
+
+```python
+message = unique_sdk.Message.create_event(
+    user_id=user_id,
+    company_id=company_id,
+    messageId="msg_l4ushn85yqbewpf6tllh2cl7",
+    chatId="chat_kc8p3kgkn7393qhgmv5js5nt",
+    text="Hello.",                  #optional
+    originalText="Hello.",          #optional
+    references=[],                  #optional
+    gptRequest={}                   #optional
+    debugInfo={  "hello": "test" }, #optional
+)
+```
+
 #### `unique_sdk.Message.modify`
 
 Modify an existing chat message.
@@ -807,7 +827,7 @@ unique_sdk.Integrated.responses_stream(
 
 #### `unique_sdk.MessageLog.create`
 
-Create a message log for a provided `messageId`.
+Function to update the steps section of a message in the chat UI. This is possible by creating a message log record during a message execution.
 
 ```python
 msg_log = unique_sdk.MessageLog.create(
@@ -816,10 +836,10 @@ msg_log = unique_sdk.MessageLog.create(
     messageId="msg_a0jgnt1jrqv1d3uzr450waxw",
     text="Create message log text",
     order=1,
-    status="RUNNING",                               # one of "RUNNING", "COMPLETED", "FAILED"
-    details=None,                                   # optional, details dictionary
-    uncitedReferences=None,                         # optional, references dictionary
-    references=None,                                # optional, list of references
+    status="RUNNING",                             # one of "RUNNING", "COMPLETED", "FAILED"
+    details={},                                   # optional, details dictionary
+    uncitedReferences={},                         # optional, references dictionary
+    references=[],                                # optional, list of references
 )
 ```
 
@@ -832,12 +852,12 @@ msg_log = unique_sdk.MessageLog.update(
     user_id=user_id,
     company_id=company_id,
     message_log_id="message_log_fd7z7gjljo1z2wu5g6l9q7r9",
-    text="Update a message log text",               # optional
-    order=1,                                        # optional
-    status="RUNNING",                               # one of "RUNNING", "COMPLETED", "FAILED"
-    details=None,                                   # optional, details dictionary
-    uncitedReferences=None,                         # optional, references dictionary
-    references=None,                              
+    text="Update a message log text",             # optional
+    order=1,                                      # optional
+    status="RUNNING",                             # one of "RUNNING", "COMPLETED", "FAILED"
+    details={},                                   # optional, details dictionary
+    uncitedReferences={},                         # optional, references dictionary
+    references=[],                                # optional, list of references
 )
 ```
 
@@ -852,10 +872,7 @@ msg_execution = unique_sdk.MessageExecution.create(
     user_id=user_id,
     company_id=company_id,
     messageId="msg_a0jgnt1jrqv143uzr750waxw",
-    chatId="chat_nx21havszl1skchd7544oykh",
-    type="DEEP_RESEARCH"
-    secondsRemaining=None                       # optional, number defining the seconds remaining
-    percentageCompleted=None                    # optional, number defining the percentage completed
+    type="DEEP_RESEARCH",
 )
 ```
 
@@ -880,9 +897,9 @@ msg_execution = unique_sdk.MessageExecution.update(
     user_id=user_id,
     company_id=company_id,
     messageId="msg_a0jgnt1jrqv143uzr750waxw",
-    status="COMPLETED",                       # one of: COMPLETED, FAILED
-    secondsRemaining=55                       # optional, number defining the seconds remaining
-    percentageCompleted=10                    # optional, number defining the percentage completed
+    status="COMPLETED",                        # optional, one of: COMPLETED, FAILED - not specifying the status will have no effect over the status
+    secondsRemaining=55,                       # optional, number defining the seconds remaining
+    percentageCompleted=10,                    # optional, number defining the percentage completed
 )
 ```
 

{unique_sdk-0.10.31 → unique_sdk-0.10.33}/pyproject.toml

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

{unique_sdk-0.10.31 → unique_sdk-0.10.33}/unique_sdk/api_resources/_message.py

@@ -59,6 +59,16 @@ class Message(APIResource["Message"]):
     class RetrieveParams(RequestOptions):
         chatId: str
 
+    class CreateEventParams(RequestOptions):
+        messageId: str
+        chatId: str
+        originalText: NotRequired[str | None]
+        text: NotRequired[str | None]
+        references: NotRequired[List["Message.Reference"] | None]
+        gptRequest: NotRequired[Dict[str, Any] | None]
+        debugInfo: NotRequired[Dict[str, Any] | None]
+        completedAt: NotRequired[datetime | None]
+
     chatId: str
     text: Optional[str]
     role: Literal["SYSTEM", "USER", "ASSISTANT"]
@@ -303,3 +313,49 @@ class Message(APIResource["Message"]):
             company_id,
             params=params,
         )
+
+    @classmethod
+    def create_event(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Message.CreateEventParams"],
+    ) -> "Message":
+        """
+        Creates a new message event object.
+        """
+        message_id = params.get("messageId")
+        params.pop("messageId", None)
+        return cast(
+            "Message",
+            cls._static_request(
+                "post",
+                f"{cls.class_url()}/{message_id}/event",
+                user_id,
+                company_id,
+                params,
+            ),
+        )
+
+    @classmethod
+    async def create_event_async(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Message.CreateEventParams"],
+    ) -> "Message":
+        """
+        Creates a new message event object.
+        """
+        message_id = params.get("messageId")
+        params.pop("messageId", None)
+        return cast(
+            "Message",
+            await cls._static_request_async(
+                "post",
+                f"{cls.class_url()}/{message_id}/event",
+                user_id,
+                company_id,
+                params,
+            ),
+        )

{unique_sdk-0.10.31 → unique_sdk-0.10.33}/unique_sdk/api_resources/_message_execution.py

@@ -8,16 +8,18 @@ class MessageExecution(APIResource["MessageExecution"]):
     OBJECT_NAME: ClassVar[Literal["message_execution"]] = "message_execution"
     RESOURCE_URL = "/message-execution"
 
+    TypeLiteral = Literal["DEEP_RESEARCH"]
+    StatusLiteral = Literal["PENDING", "RUNNING", "COMPLETED", "FAILED"]
+    # Only COMPLETED and FAILED statuses are allowed for update
+    UpdateStatusLiteral = Literal["COMPLETED", "FAILED"]
+
     class CreateMessageExecutionParams(RequestOptions):
         """
         Parameters for creating a message execution.
         """
 
         messageId: str
-        chatId: str
-        type: Literal["DEEP_RESEARCH"]
-        secondsRemaining: NotRequired[int | None]
-        percentageCompleted: NotRequired[int | None]
+        type: "MessageExecution.TypeLiteral"
 
     class GetMessageExecutionParams(RequestOptions):
         """
@@ -32,18 +34,18 @@ class MessageExecution(APIResource["MessageExecution"]):
         """
 
         messageId: str
-        status: Literal["COMPLETED", "FAILED"]
+        status: NotRequired["MessageExecution.UpdateStatusLiteral | None"]
         secondsRemaining: NotRequired[int | None]
         percentageCompleted: NotRequired[int | None]
 
-    messageExecutionId: str | None
-    messageId: str | None
-    status: Literal["PENDING", "RUNNING", "COMPLETED", "FAILED"]
-    type: Literal["DEEP_RESEARCH"] = "DEEP_RESEARCH"
+    messageId: str
+    status: "MessageExecution.StatusLiteral"
+    type: "MessageExecution.TypeLiteral"
     secondsRemaining: int | None
     percentageCompleted: int | None
+    positionInQueue: int | None
     createdAt: str
-    updatedAt: str | None
+    updatedAt: str
 
     @classmethod
     def create(

{unique_sdk-0.10.31 → unique_sdk-0.10.33}/unique_sdk/api_resources/_message_log.py

@@ -8,6 +8,8 @@ class MessageLog(APIResource["MessageLog"]):
     OBJECT_NAME: ClassVar[Literal["message_log"]] = "message_log"
     RESOURCE_URL = "/message-log"
 
+    StatusLiteral = Literal["RUNNING", "COMPLETED", "FAILED"]
+
     class Reference(TypedDict):
         name: str
         url: str | None
@@ -23,7 +25,7 @@ class MessageLog(APIResource["MessageLog"]):
 
         messageId: str
         text: str
-        status: Literal["RUNNING", "COMPLETED", "FAILED"]
+        status: "MessageLog.StatusLiteral"
         order: int
         details: NotRequired[dict | None]
         uncitedReferences: NotRequired[dict | None]
@@ -35,21 +37,21 @@ class MessageLog(APIResource["MessageLog"]):
         """
 
         text: NotRequired[str | None]
-        status: NotRequired[Literal["RUNNING", "COMPLETED", "FAILED"] | None]
+        status: NotRequired["MessageLog.StatusLiteral | None"]
         order: NotRequired[int | None]
         details: NotRequired[dict | None]
         uncitedReferences: NotRequired[dict | None]
         references: NotRequired[list["MessageLog.Reference"] | None]
 
-    messageLogId: str | None
-    messageId: str | None
-    status: Literal["RUNNING", "COMPLETED", "FAILED"]
-    text: str | None
+    id: str
+    messageId: str
+    status: "MessageLog.StatusLiteral"
+    text: str
     details: dict
     uncitedReferences: dict
     order: int
     createdAt: str
-    updatedAt: str | None
+    updatedAt: str
 
     @classmethod
     def create(