unique_sdk 0.10.29__tar.gz → 0.10.31__tar.gz

{unique_sdk-0.10.29 → unique_sdk-0.10.31}/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.31] - 2025-10-13
+- Add readme for message log and execution.
+
+## [0.10.30] - 2025-10-07
+- Improve types for content get infos.
+
 ## [0.10.29] - 2025-10-06
 - Switch default model used from `GPT-3.5-turbo (0125)` to `GPT-4o (1120)`
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.10.29
+Version: 0.10.31
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -18,9 +18,9 @@ Description-Content-Type: text/markdown
 
 # Unique Python SDK
 
-Unique Unique AI is a tailored solution for the financial industry, designed to increase productivity by automating manual workloads through AI and ChatGPT solutions.
+Unique AI is a tailored solution for the financial industry, designed to increase productivity by automating manual workloads through AI and ChatGPT solutions.
 
-The Unique Python SDK provides access to the public API of Unique Unique AI. It also enables verification of Webhook signatures to ensure the authenticity of incoming Webhook requests.
+The Unique Python SDK provides access to the public API of Unique AI. It also enables verification of Webhook signatures to ensure the authenticity of incoming Webhook requests.
 
 ## Table of Contents
 
@@ -31,6 +31,8 @@ The Unique Python SDK provides access to the public API of Unique Unique AI. It
 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)
@@ -226,7 +228,7 @@ This trigger can be used in combination with assistants marked as `external`. Th
 }
 ```
 
-This Webhook is triggered when the Unique Unique AI AI selects an external module as the best response to a user message. The module must be marked as `external` and available for the assistant used in the chat to be selected by the AI.
+This Webhook is triggered when the Unique AI selects an external module as the best response to a user message. The module must be marked as `external` and available for the assistant used in the chat to be selected by the AI.
 
 Unique's UI will create an empty `assistantMessage` below the user message and update this message with status updates.
 
@@ -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)
@@ -573,7 +577,7 @@ Move the file to a different folder. This can be done by specifying either the `
 - `parentFolderPath` optional, allows moving the file to a different folder. Represents the path new folder for the file.
 
 Metadata update:
-- `metadata` optional, allows updating the metadata of the file. Default metadata can not be ovrriden. (Available with release >.40)
+- `metadata` optional, allows updating the metadata of the file. Default metadata can not be overridden. (Available with release >.40)
 
 Example of updating the title of a file specified by its path.
 
@@ -817,11 +821,94 @@ 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`
+
+Create a message log for a provided `messageId`.
+
+```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=None,                                   # optional, details dictionary
+    uncitedReferences=None,                         # optional, references dictionary
+    references=None,                                # 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=None,                                   # optional, details dictionary
+    uncitedReferences=None,                         # optional, references dictionary
+    references=None,                              
+)
+```
+
+### 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`
 
-Send a prompt to an AI model supported by Unique Unique AI and receive a result. The `messages` attribute must follow the [OpenAI API format](https://platform.openai.com/docs/api-reference/chat).
+Send a prompt to an AI model supported by Unique AI and receive a result. The `messages` attribute must follow the [OpenAI API format](https://platform.openai.com/docs/api-reference/chat).
 
 ```python
 chat_completion = unique_sdk.ChatCompletion.create(
@@ -871,7 +958,7 @@ print(result)
 
 #### `unique_sdk.Search.create`
 
-Search the Unique Unique AI Knowledge database for RAG (Retrieval-Augmented Generation). The API supports vector search and a `searchType` that combines vector and full-text search, enhancing the precision of search results.
+Search the Unique AI Knowledge database for RAG (Retrieval-Augmented Generation). The API supports vector search and a `searchType` that combines vector and full-text search, enhancing the precision of search results.
 
 These are the options are available for `searchType`:
 
@@ -1662,6 +1749,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.31] - 2025-10-13
+- Add readme for message log and execution.
+
+## [0.10.30] - 2025-10-07
+- Improve types for content get infos.
+
 ## [0.10.29] - 2025-10-06
 - Switch default model used from `GPT-3.5-turbo (0125)` to `GPT-4o (1120)`
 

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

@@ -1,8 +1,8 @@
 # Unique Python SDK
 
-Unique Unique AI is a tailored solution for the financial industry, designed to increase productivity by automating manual workloads through AI and ChatGPT solutions.
+Unique AI is a tailored solution for the financial industry, designed to increase productivity by automating manual workloads through AI and ChatGPT solutions.
 
-The Unique Python SDK provides access to the public API of Unique Unique AI. It also enables verification of Webhook signatures to ensure the authenticity of incoming Webhook requests.
+The Unique Python SDK provides access to the public API of Unique AI. It also enables verification of Webhook signatures to ensure the authenticity of incoming Webhook requests.
 
 ## Table of Contents
 
@@ -13,6 +13,8 @@ The Unique Python SDK provides access to the public API of Unique Unique AI. It
 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)
@@ -208,7 +210,7 @@ This trigger can be used in combination with assistants marked as `external`. Th
 }
 ```
 
-This Webhook is triggered when the Unique Unique AI AI selects an external module as the best response to a user message. The module must be marked as `external` and available for the assistant used in the chat to be selected by the AI.
+This Webhook is triggered when the Unique AI selects an external module as the best response to a user message. The module must be marked as `external` and available for the assistant used in the chat to be selected by the AI.
 
 Unique's UI will create an empty `assistantMessage` below the user message and update this message with status updates.
 
@@ -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)
@@ -555,7 +559,7 @@ Move the file to a different folder. This can be done by specifying either the `
 - `parentFolderPath` optional, allows moving the file to a different folder. Represents the path new folder for the file.
 
 Metadata update:
-- `metadata` optional, allows updating the metadata of the file. Default metadata can not be ovrriden. (Available with release >.40)
+- `metadata` optional, allows updating the metadata of the file. Default metadata can not be overridden. (Available with release >.40)
 
 Example of updating the title of a file specified by its path.
 
@@ -799,11 +803,94 @@ 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`
+
+Create a message log for a provided `messageId`.
+
+```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=None,                                   # optional, details dictionary
+    uncitedReferences=None,                         # optional, references dictionary
+    references=None,                                # 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=None,                                   # optional, details dictionary
+    uncitedReferences=None,                         # optional, references dictionary
+    references=None,                              
+)
+```
+
+### 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`
 
-Send a prompt to an AI model supported by Unique Unique AI and receive a result. The `messages` attribute must follow the [OpenAI API format](https://platform.openai.com/docs/api-reference/chat).
+Send a prompt to an AI model supported by Unique AI and receive a result. The `messages` attribute must follow the [OpenAI API format](https://platform.openai.com/docs/api-reference/chat).
 
 ```python
 chat_completion = unique_sdk.ChatCompletion.create(
@@ -853,7 +940,7 @@ print(result)
 
 #### `unique_sdk.Search.create`
 
-Search the Unique Unique AI Knowledge database for RAG (Retrieval-Augmented Generation). The API supports vector search and a `searchType` that combines vector and full-text search, enhancing the precision of search results.
+Search the Unique AI Knowledge database for RAG (Retrieval-Augmented Generation). The API supports vector search and a `searchType` that combines vector and full-text search, enhancing the precision of search results.
 
 These are the options are available for `searchType`:
 

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

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

{unique_sdk-0.10.29 → unique_sdk-0.10.31}/unique_sdk/api_resources/_content.py

@@ -86,6 +86,19 @@ class Content(APIResource["Content"]):
         skip: NotRequired[int | None]
         take: NotRequired[int | None]
         filePath: NotRequired[str | None]
+        contentId: NotRequired[str | None]
+        chatId: NotRequired[str | None]
+
+    class ContentInfosParams(TypedDict):
+        """
+        Parameters for the content infos endpoint.
+        This is used to retrieve information about contents based on various filters.
+        """
+
+        metadataFilter: NotRequired[dict[str, Any] | None]
+        skip: NotRequired[int | None]
+        take: NotRequired[int | None]
+        parentId: NotRequired[str | None]
 
     class CustomApiOptions(TypedDict):
         apiIdentifier: str
@@ -293,7 +306,7 @@ class Content(APIResource["Content"]):
         cls,
         user_id: str,
         company_id: str,
-        **params: Unpack["Content.ContentInfoParams"],
+        **params: Unpack["Content.ContentInfosParams"],
     ) -> "Content.PaginatedContentInfos":
         return cast(
             Content.PaginatedContentInfos,
@@ -311,7 +324,7 @@ class Content(APIResource["Content"]):
         cls,
         user_id: str,
         company_id: str,
-        **params: Unpack["Content.ContentInfoParams"],
+        **params: Unpack["Content.ContentInfosParams"],
     ) -> "Content.PaginatedContentInfos":
         return cast(
             Content.PaginatedContentInfos,

{unique_sdk-0.10.29 → unique_sdk-0.10.31}/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]