unique_sdk 0.10.30__tar.gz → 0.10.32__tar.gz

{unique_sdk-0.10.30 → unique_sdk-0.10.32}/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.32] - 2025-10-14
+- Add function to stream to chat frontend.
+
+## [0.10.31] - 2025-10-13
+- Add readme for message log and execution.
+
 ## [0.10.30] - 2025-10-07
 - Improve types for content get infos.
 

{unique_sdk-0.10.30 → unique_sdk-0.10.32}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.10.30
+Version: 0.10.32
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -31,6 +31,8 @@ The Unique Python SDK provides access to the public API of Unique AI. It also en
 5. [Available API Resources](#available-api-resources)
    - [Content](#content)
    - [Message](#message)
+   - [Message Log](#message-log)
+   - [Message Execution](#message-execution)
    - [Chat Completion](#chat-completion)
    - [Embeddings](#embeddings)
    - [Acronyms](#acronyms)
@@ -246,6 +248,8 @@ unique_sdk.Message.modify(
 
 - [Content](#content)
 - [Message](#message)
+- [Message Log](#message-log)
+- [Message Execution](#message-execution)
 - [Chat Completion](#chat-completion)
 - [Embeddings](#embeddings)
 - [Acronyms](#acronyms)
@@ -696,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.
@@ -817,6 +841,89 @@ unique_sdk.Integrated.responses_stream(
 
 **Warning:** Currently, the deletion of a chat message does not automatically sync with the user UI. Users must refresh the chat page to view the updated state. This issue will be addressed in a future update of our API.
 
+### Message Log
+
+#### `unique_sdk.MessageLog.create`
+
+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(
+    user_id=user_id,
+    company_id=company_id,
+    messageId="msg_a0jgnt1jrqv1d3uzr450waxw",
+    text="Create message log text",
+    order=1,
+    status="RUNNING",                             # one of "RUNNING", "COMPLETED", "FAILED"
+    details={},                                   # optional, details dictionary
+    uncitedReferences={},                         # optional, references dictionary
+    references=[],                                # optional, list of references
+)
+```
+
+#### `unique_sdk.MessageLog.update`
+
+Update a message log for a provided `messageId`.
+
+```python
+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={},                                   # optional, details dictionary
+    uncitedReferences={},                         # optional, references dictionary
+    references=[],                                # optional, list of references
+)
+```
+
+### Message Execution
+
+#### `unique_sdk.MessageExecution.create`
+
+Create a message execution for a provided `messageId` and `chatId`.
+
+```python
+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
+)
+```
+
+#### `unique_sdk.MessageExecution.get`
+
+Get a message execution for a provided `messageId`.
+
+```python
+msg_execution = unique_sdk.MessageExecution.get(
+    user_id=user_id,
+    company_id=company_id,
+    messageId="msg_a0jgnt1jrqv143uzr750waxw",
+)
+```
+
+#### `unique_sdk.MessageExecution.update`
+
+Update a message execution for a provided `messageId`.
+
+```python
+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
+)
+```
+
 ### Chat Completion
 
 #### `unique_sdk.ChatCompletion.create`
@@ -1662,6 +1769,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.32] - 2025-10-14
+- Add function to stream to chat frontend.
+
+## [0.10.31] - 2025-10-13
+- Add readme for message log and execution.
+
 ## [0.10.30] - 2025-10-07
 - Improve types for content get infos.
 

{unique_sdk-0.10.30 → unique_sdk-0.10.32}/README.md

@@ -13,6 +13,8 @@ The Unique Python SDK provides access to the public API of Unique AI. It also en
 5. [Available API Resources](#available-api-resources)
    - [Content](#content)
    - [Message](#message)
+   - [Message Log](#message-log)
+   - [Message Execution](#message-execution)
    - [Chat Completion](#chat-completion)
    - [Embeddings](#embeddings)
    - [Acronyms](#acronyms)
@@ -228,6 +230,8 @@ unique_sdk.Message.modify(
 
 - [Content](#content)
 - [Message](#message)
+- [Message Log](#message-log)
+- [Message Execution](#message-execution)
 - [Chat Completion](#chat-completion)
 - [Embeddings](#embeddings)
 - [Acronyms](#acronyms)
@@ -678,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.
@@ -799,6 +823,89 @@ unique_sdk.Integrated.responses_stream(
 
 **Warning:** Currently, the deletion of a chat message does not automatically sync with the user UI. Users must refresh the chat page to view the updated state. This issue will be addressed in a future update of our API.
 
+### Message Log
+
+#### `unique_sdk.MessageLog.create`
+
+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(
+    user_id=user_id,
+    company_id=company_id,
+    messageId="msg_a0jgnt1jrqv1d3uzr450waxw",
+    text="Create message log text",
+    order=1,
+    status="RUNNING",                             # one of "RUNNING", "COMPLETED", "FAILED"
+    details={},                                   # optional, details dictionary
+    uncitedReferences={},                         # optional, references dictionary
+    references=[],                                # optional, list of references
+)
+```
+
+#### `unique_sdk.MessageLog.update`
+
+Update a message log for a provided `messageId`.
+
+```python
+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={},                                   # optional, details dictionary
+    uncitedReferences={},                         # optional, references dictionary
+    references=[],                                # optional, list of references
+)
+```
+
+### Message Execution
+
+#### `unique_sdk.MessageExecution.create`
+
+Create a message execution for a provided `messageId` and `chatId`.
+
+```python
+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
+)
+```
+
+#### `unique_sdk.MessageExecution.get`
+
+Get a message execution for a provided `messageId`.
+
+```python
+msg_execution = unique_sdk.MessageExecution.get(
+    user_id=user_id,
+    company_id=company_id,
+    messageId="msg_a0jgnt1jrqv143uzr750waxw",
+)
+```
+
+#### `unique_sdk.MessageExecution.update`
+
+Update a message execution for a provided `messageId`.
+
+```python
+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
+)
+```
+
 ### Chat Completion
 
 #### `unique_sdk.ChatCompletion.create`

{unique_sdk-0.10.30 → unique_sdk-0.10.32}/pyproject.toml

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

{unique_sdk-0.10.30 → unique_sdk-0.10.32}/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.30 → unique_sdk-0.10.32}/unique_sdk/api_resources/_message_log.py

@@ -36,7 +36,7 @@ class MessageLog(APIResource["MessageLog"]):
 
         text: NotRequired[str | None]
         status: NotRequired[Literal["RUNNING", "COMPLETED", "FAILED"] | None]
-        order: int
+        order: NotRequired[int | None]
         details: NotRequired[dict | None]
         uncitedReferences: NotRequired[dict | None]
         references: NotRequired[list["MessageLog.Reference"] | None]