unique_sdk 0.10.25__tar.gz → 0.10.27__tar.gz

{unique_sdk-0.10.25 → unique_sdk-0.10.27}/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.27] - 2025-09-24
+- Improve readme to use Unique AI.
+
+## [0.10.26] - 2025-09-22
+- Improve typing.
+
 ## [0.10.25] - 2025-09-18
 - Add support for udpate and delete files by file or folder path.
 

{unique_sdk-0.10.25 → unique_sdk-0.10.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.10.25
+Version: 0.10.27
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -18,9 +18,9 @@ Description-Content-Type: text/markdown
 
 # Unique Python SDK
 
-Unique FinanceGPT is a tailored solution for the financial industry, designed to increase productivity by automating manual workloads through AI and ChatGPT solutions.
+Unique 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 FinanceGPT. 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 Unique AI. It also enables verification of Webhook signatures to ensure the authenticity of incoming Webhook requests.
 
 ## Table of Contents
 
@@ -112,7 +112,7 @@ print(messages.data[0].text)
 
 ## Webhook Triggers
 
-A core functionality of FinanceGPT is the ability for users to engage in an interactive chat feature. SDK developers can hook into this chat to provide new functionalities.
+A core functionality of Unique AI is the ability for users to engage in an interactive chat feature. SDK developers can hook into this chat to provide new functionalities.
 
 Your App (refer to `app-id` in [Requirements](#requirements)) must be subscribed to each individual Unique event in order to receive a webhook.
 
@@ -226,7 +226,7 @@ This trigger can be used in combination with assistants marked as `external`. Th
 }
 ```
 
-This Webhook is triggered when the Unique FinanceGPT 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 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.
 
 Unique's UI will create an empty `assistantMessage` below the user message and update this message with status updates.
 
@@ -821,7 +821,7 @@ unique_sdk.Integrated.responses_stream(
 
 #### `unique_sdk.ChatCompletion.create`
 
-Send a prompt to an AI model supported by Unique FinanceGPT 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 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 +871,7 @@ print(result)
 
 #### `unique_sdk.Search.create`
 
-Search the Unique FinanceGPT 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 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 +1662,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.27] - 2025-09-24
+- Improve readme to use Unique AI.
+
+## [0.10.26] - 2025-09-22
+- Improve typing.
+
 ## [0.10.25] - 2025-09-18
 - Add support for udpate and delete files by file or folder path.
 

{unique_sdk-0.10.25 → unique_sdk-0.10.27}/README.md

@@ -1,8 +1,8 @@
 # Unique Python SDK
 
-Unique FinanceGPT is a tailored solution for the financial industry, designed to increase productivity by automating manual workloads through AI and ChatGPT solutions.
+Unique 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 FinanceGPT. 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 Unique AI. It also enables verification of Webhook signatures to ensure the authenticity of incoming Webhook requests.
 
 ## Table of Contents
 
@@ -94,7 +94,7 @@ print(messages.data[0].text)
 
 ## Webhook Triggers
 
-A core functionality of FinanceGPT is the ability for users to engage in an interactive chat feature. SDK developers can hook into this chat to provide new functionalities.
+A core functionality of Unique AI is the ability for users to engage in an interactive chat feature. SDK developers can hook into this chat to provide new functionalities.
 
 Your App (refer to `app-id` in [Requirements](#requirements)) must be subscribed to each individual Unique event in order to receive a webhook.
 
@@ -208,7 +208,7 @@ This trigger can be used in combination with assistants marked as `external`. Th
 }
 ```
 
-This Webhook is triggered when the Unique FinanceGPT 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 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.
 
 Unique's UI will create an empty `assistantMessage` below the user message and update this message with status updates.
 
@@ -803,7 +803,7 @@ unique_sdk.Integrated.responses_stream(
 
 #### `unique_sdk.ChatCompletion.create`
 
-Send a prompt to an AI model supported by Unique FinanceGPT 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 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 +853,7 @@ print(result)
 
 #### `unique_sdk.Search.create`
 
-Search the Unique FinanceGPT 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 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.25 → unique_sdk-0.10.27}/pyproject.toml

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

{unique_sdk-0.10.25 → unique_sdk-0.10.27}/unique_sdk/api_resources/_content.py

@@ -73,7 +73,7 @@ class Content(APIResource["Content"]):
 
     class SearchParams(RequestOptions):
         where: "Content.ContentWhereInput"
-        chatId: NotRequired[str]
+        chatId: NotRequired[str | None]
         includeFailedContent: NotRequired[bool]
 
     class ContentInfoParams(TypedDict):
@@ -82,10 +82,10 @@ class Content(APIResource["Content"]):
         This is used to retrieve information about content based on various filters.
         """
 
-        metadataFilter: NotRequired[dict]
-        skip: NotRequired[int]
-        take: NotRequired[int]
-        filePath: NotRequired[str]
+        metadataFilter: NotRequired[dict[str, Any] | None]
+        skip: NotRequired[int | None]
+        take: NotRequired[int | None]
+        filePath: NotRequired[str | None]
 
     class CustomApiOptions(TypedDict):
         apiIdentifier: str
@@ -114,19 +114,19 @@ class Content(APIResource["Content"]):
         key: str
         title: Optional[str]
         mimeType: str
-        ownerType: str
-        ownerId: str
-        byteSize: Optional[int]
-        ingestionConfig: "Content.IngestionConfig"
-        metadata: NotRequired[dict[str, str | None]]
+        ownerType: NotRequired[str | None]
+        ownerId: NotRequired[str | None]
+        byteSize: NotRequired[int | None]
+        ingestionConfig: NotRequired["Content.IngestionConfig | None"]
+        metadata: NotRequired[dict[str, Any] | None]
 
     class UpsertParams(RequestOptions):
         input: "Content.Input"
-        scopeId: Optional[str]
-        chatId: Optional[str]
-        sourceOwnerType: str
-        storeInternally: bool
-        fileUrl: Optional[str]
+        scopeId: NotRequired[str | None]
+        chatId: NotRequired[str | None]
+        sourceOwnerType: NotRequired[str | None]
+        storeInternally: NotRequired[bool | None]
+        fileUrl: NotRequired[str | None]
 
     class UpdateParams(RequestOptions):
         contentId: NotRequired[str]
@@ -186,6 +186,8 @@ class Content(APIResource["Content"]):
     updatedAt: str
     chunks: List[Chunk]
     metadata: Optional[Dict[str, Any]]
+    writeUrl: str
+    readUrl: str
 
     class MagicTableSheetTableColumn(TypedDict):
         columnId: str
@@ -547,6 +549,10 @@ class Content(APIResource["Content"]):
         """
         Returns the contentId to use: if content_id is provided, returns it;
         if not, but file_path is provided, resolves and returns the id for that file path.
+
+        Returns:
+            str: The resolved content ID.
+            None: Failed to resolve a content ID (e.g., file_path not found or not provided).
         """
         if content_id:
             return content_id

{unique_sdk-0.10.25 → unique_sdk-0.10.27}/unique_sdk/api_resources/_folder.py

@@ -44,19 +44,19 @@ class Folder(APIResource["Folder"]):
         languageModel: str | None
 
     class IngestionConfig(TypedDict):
-        chunkMaxTokens: int | None
-        chunkMaxTokensOnePager: int | None
-        chunkMinTokens: int | None
-        chunkStrategy: str | None
-        customApiOptions: List["Folder.CustomApiOptions"] | None
-        documentMinTokens: int | None
-        excelReadMode: str | None
-        jpgReadMode: str | None
-        pdfReadMode: str | None
-        pptReadMode: str | None
+        chunkMaxTokens: NotRequired[int | None]
+        chunkMaxTokensOnePager: NotRequired[int | None]
+        chunkMinTokens: NotRequired[int | None]
+        chunkStrategy: NotRequired[str | None]
+        customApiOptions: NotRequired[List["Folder.CustomApiOptions"] | None]
+        documentMinTokens: NotRequired[int | None]
+        excelReadMode: NotRequired[str | None]
+        jpgReadMode: NotRequired[str | None]
+        pdfReadMode: NotRequired[str | None]
+        pptReadMode: NotRequired[str | None]
         uniqueIngestionMode: str
-        vttConfig: Optional["Folder.VttConfig"]
-        wordReadMode: str | None
+        vttConfig: NotRequired["Folder.VttConfig | None"]
+        wordReadMode: NotRequired[str | None]
 
     class CreatedFolder(TypedDict):
         id: str
@@ -93,8 +93,8 @@ class Folder(APIResource["Folder"]):
         Parameters for updating folder ingestion config.
         """
 
-        scopeId: str | None
-        folderPath: str | None
+        scopeId: NotRequired[str | None]
+        folderPath: NotRequired[str | None]
         ingestionConfig: "Folder.IngestionConfig"
         applyToSubScopes: bool
 
@@ -103,8 +103,8 @@ class Folder(APIResource["Folder"]):
         Parameters for adding access to a folder.
         """
 
-        scopeId: str | None
-        folderPath: str | None
+        scopeId: NotRequired[str | None]
+        folderPath: NotRequired[str | None]
         scopeAccesses: List["Folder.ScopeAccess"]
         applyToSubScopes: bool
 
@@ -113,8 +113,8 @@ class Folder(APIResource["Folder"]):
         Parameters for removing access from a folder.
         """
 
-        scopeId: str | None
-        folderPath: str | None
+        scopeId: NotRequired[str | None]
+        folderPath: NotRequired[str | None]
         scopeAccesses: List["Folder.ScopeAccess"]
         applyToSubScopes: bool
 
@@ -250,7 +250,7 @@ class Folder(APIResource["Folder"]):
         cls, user_id: str, company_id: str, **params: Unpack["Folder.CreateParams"]
     ) -> "Folder.CreateFolderStructureResponse":
         return cast(
-            "Folder",
+            "Folder.CreateFolderStructureResponse",
             cls._static_request(
                 "post",
                 cls.RESOURCE_URL,
@@ -265,7 +265,7 @@ class Folder(APIResource["Folder"]):
         cls, user_id: str, company_id: str, **params: Unpack["Folder.CreateParams"]
     ) -> "Folder.CreateFolderStructureResponse":
         return cast(
-            "Folder",
+            "Folder.CreateFolderStructureResponse",
             await cls._static_request_async(
                 "post",
                 cls.RESOURCE_URL,
@@ -545,6 +545,10 @@ class Folder(APIResource["Folder"]):
         """
         Returns the scopeId to use: if scope_id is provided, returns it;
         if not, but folder_path is provided, resolves and returns the id for that folder path.
+
+        Returns:
+            str: The resolved folder ID.
+            None: Failed to resolve a folder ID (e.g., folder_path not found or not provided).
         """
         if scope_id:
             return scope_id

{unique_sdk-0.10.25 → unique_sdk-0.10.27}/unique_sdk/api_resources/_message_execution.py

@@ -1,4 +1,4 @@
-from typing import ClassVar, Literal, Unpack, cast
+from typing import ClassVar, Literal, NotRequired, Unpack, cast
 
 from unique_sdk._api_resource import APIResource
 from unique_sdk._request_options import RequestOptions
@@ -15,9 +15,9 @@ class MessageExecution(APIResource["MessageExecution"]):
 
         messageId: str
         chatId: str
-        type: Literal["DEEP_RESEARCH"] = "DEEP_RESEARCH"
-        secondsRemaining: int | None = None
-        percentageCompleted: int | None = None
+        type: Literal["DEEP_RESEARCH"]
+        secondsRemaining: NotRequired[int | None]
+        percentageCompleted: NotRequired[int | None]
 
     class GetMessageExecutionParams(RequestOptions):
         """
@@ -33,8 +33,8 @@ class MessageExecution(APIResource["MessageExecution"]):
 
         messageId: str
         status: Literal["COMPLETED", "FAILED"]
-        secondsRemaining: int | None = None
-        percentageCompleted: int | None = None
+        secondsRemaining: NotRequired[int | None]
+        percentageCompleted: NotRequired[int | None]
 
     messageExecutionId: str | None
     messageId: str | None

{unique_sdk-0.10.25 → unique_sdk-0.10.27}/unique_sdk/api_resources/_message_log.py

@@ -1,4 +1,4 @@
-from typing import ClassVar, Literal, TypedDict, Unpack, cast
+from typing import ClassVar, Literal, NotRequired, TypedDict, Unpack, cast
 
 from unique_sdk._api_resource import APIResource
 from unique_sdk._request_options import RequestOptions
@@ -25,21 +25,21 @@ class MessageLog(APIResource["MessageLog"]):
         text: str
         status: Literal["RUNNING", "COMPLETED", "FAILED"]
         order: int
-        details: dict | None = None
-        uncitedReferences: dict | None = None
-        references: list["MessageLog.Reference"] | None = None
+        details: NotRequired[dict | None]
+        uncitedReferences: NotRequired[dict | None]
+        references: NotRequired[list["MessageLog.Reference"] | None]
 
     class UpdateMessageLogParams(RequestOptions):
         """
         Parameters for updating a message log.
         """
 
-        text: str | None
-        status: Literal["RUNNING", "COMPLETED", "FAILED"] | None
+        text: NotRequired[str | None]
+        status: NotRequired[Literal["RUNNING", "COMPLETED", "FAILED"] | None]
         order: int
-        details: dict | None = None
-        uncitedReferences: dict | None = None
-        references: list["MessageLog.Reference"] | None = None
+        details: NotRequired[dict | None]
+        uncitedReferences: NotRequired[dict | None]
+        references: NotRequired[list["MessageLog.Reference"] | None]
 
     messageLogId: str | None
     messageId: str | None

{unique_sdk-0.10.25 → unique_sdk-0.10.27}/unique_sdk/api_resources/_space.py

@@ -1,4 +1,15 @@
-from typing import Any, ClassVar, Dict, List, Literal, Optional, TypedDict, Unpack, cast
+from typing import (
+    Any,
+    ClassVar,
+    Dict,
+    List,
+    Literal,
+    NotRequired,
+    Optional,
+    TypedDict,
+    Unpack,
+    cast,
+)
 
 from unique_sdk._api_resource import APIResource
 from unique_sdk._request_options import RequestOptions
@@ -12,11 +23,11 @@ class Space(APIResource["Space"]):
         Parameters for querying the assistant for a message.
         """
 
-        chatId: str | None = None
+        chatId: NotRequired[str | None]
         assistantId: str
-        text: str | None = None
-        toolChoices: List[str] = None
-        scopeRules: dict | None = None
+        text: NotRequired[str | None]
+        toolChoices: NotRequired[List[str] | None]
+        scopeRules: NotRequired[dict | None]
 
     class Reference(TypedDict):
         """

{unique_sdk-0.10.25 → unique_sdk-0.10.27}/unique_sdk/utils/chat_in_space.py

@@ -12,9 +12,9 @@ async def send_message_and_wait_for_completion(
     company_id: str,
     assistant_id: str,
     text: str,
-    tool_choices: List[str] = None,
+    tool_choices: List[str] | None = None,
     scope_rules: dict | None = None,
-    chat_id: str = None,
+    chat_id: str | None = None,
     poll_interval: float = 1.0,
     max_wait: float = 60.0,
     stop_condition: Literal["stoppedStreamingAt", "completedAt"] = "stoppedStreamingAt",
@@ -152,7 +152,7 @@ async def wait_for_ingestion_completion(
     user_id: str,
     company_id: str,
     content_id: str,
-    chat_id: str = None,
+    chat_id: str | None = None,
     poll_interval: float = 1.0,
     max_wait: float = 60.0,
 ):

{unique_sdk-0.10.25 → unique_sdk-0.10.27}/unique_sdk/utils/file_io.py

@@ -110,7 +110,11 @@ def upload_file(
 
 
 def download_content(
-    companyId: str, userId: str, content_id: str, filename: str, chat_id: str = None
+    companyId: str,
+    userId: str,
+    content_id: str,
+    filename: str,
+    chat_id: str | None = None,
 ):
     # Ensure the URL is a valid string
     if not isinstance(content_id, str):