unique_sdk 0.10.1__tar.gz → 0.10.3__tar.gz

{unique_sdk-0.10.1 → unique_sdk-0.10.3}/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.3] - 2025-08-05
+- Expose scoreThreshold param for search.
+
+## [0.10.2] - 2025-08-05
+- Add script to chat against file.
+
 ## [0.10.1] - 2025-08-05
 - Allow deletion of a space chat.
 

{unique_sdk-0.10.1 → unique_sdk-0.10.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.10.1
+Version: 0.10.3
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -672,6 +672,7 @@ These are the options are available for `searchType`:
 `language` Optional. The language specification for full text search.
 `reranker` Optional. The reranker service to be used for re-ranking the search results.
 `chatId` Optional, adds the documents uploaded in this chat to the scope of searched documents.
+`scoreThreshold` Optional, sets the minimum similarity score for search results to be considered. Using 0 is recommended.
 
 ```python
 search = unique_sdk.Search.create(
@@ -686,6 +687,7 @@ search = unique_sdk.Search.create(
     reranker={"deploymentName": "my_deployment"},
     limit=20,
     page=1
+    scoreThreshold=0
 )
 ```
 
@@ -1024,6 +1026,12 @@ A metadata filter such as the one designed above can be used in a `Search.create
 
 ## Utils
 
+- [Chat History](#chat-history)
+- [File Io](#file-io)
+- [Sources](#sources)
+- [token](#token)
+- [Chat In Space](#chat-in-space)
+
 ### Chat History
 
 #### `unique_sdk.utils.chat_history.load_history`
@@ -1253,33 +1261,64 @@ The script ensures you can flexibly interact with spaces in new or ongoing chats
 
 ```python
 latest_message = await unique_sdk.utils.chat_in_space.send_message_and_wait_for_completion(
-        user_id=user_id,
-        company_id=company_id,
-        assistant_id=assistant_id,
-        text="Tell me a short story.",
-        chat_id=chat_id,                # Optional - if no chat id is specified, a new chat will be created
-        tool_choices=["WebSearch"],
-        scope_rules={
-            "or": [
-                {
-                    "operator": "in",
-                    "path": [
-                        "contentId"
-                    ],
-                    "value": [
-                        "cont_u888z7cazxxm4lugfdjq7pks"
-                    ]
-                },
-                {
-                    "operator": "contains",
-                    "path": [
-                        "folderIdPath"
-                    ],
-                    "value": "uniquepathid://scope_btfo28b3eeelwh5obwgea71bl/scope_fn56ta67knd6w4medgq3028fx"
-                }
-            ]
-        },
-    )
+    user_id=user_id,
+    company_id=company_id,
+    assistant_id=assistant_id,
+    text="Tell me a short story.",
+    chat_id=chat_id,                # Optional - if no chat id is specified, a new chat will be created
+    tool_choices=["WebSearch"],
+    scope_rules={
+        "or": [
+            {
+                "operator": "in",
+                "path": [
+                    "contentId"
+                ],
+                "value": [
+                    "cont_u888z7cazxxm4lugfdjq7pks"
+                ]
+            },
+            {
+                "operator": "contains",
+                "path": [
+                    "folderIdPath"
+                ],
+                "value": "uniquepathid://scope_btfo28b3eeelwh5obwgea71bl/scope_fn56ta67knd6w4medgq3028fx"
+            }
+        ]
+    },
+)
+```
+
+#### `unique_sdk.utils.chat_in_space.chat_against_file`
+
+The following script enables you to chat against a file.
+
+You must provide the following parameters:
+- `assistantId`: The assistant to be used for the chat.
+- `path_to_file`: The local path of the file to be uploaded.
+- `displayed_filename`: The name of the file to be displayed.
+- `mime_type`: The mime type of the ifle to be uploaded.
+- `text`: The text to be sent to the chat for chatting against the file.
+
+The script creates a chat and uploads the file to it. It then keeps polling the `ingestionState` field of the message, waiting for it to reach `FINISHED`, signaling the upload is complete. Once the file uploads successfully, the script sends the text, continues polling for completion, and finally retrieves the response message.
+
+**Optional parameters:**
+- `poll_interval`: The number of seconds to wait between polling attempts (default: `1` second).
+- `max_wait`: The maximum number of seconds to wait for the message to complete (default: `60` seconds).
+
+Example of chatting against a PDF. (The usage can be extended to any supported file type)
+
+```python
+latest_message = await unique_sdk.utils.chat_in_space.chat_against_file(
+    user_id=user_id,
+    company_id=company_id,
+    assistant_id="assistant_hjcdga64bkcjnhu4",
+    path_to_file="/files/hello.pdf",
+    displayed_filename="hello.pdf"
+    mime_type="application/pdf"
+    text="Give me a bullet point summary of the file.",
+)
 ```
 
 ## Error Handling
@@ -1299,6 +1338,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.3] - 2025-08-05
+- Expose scoreThreshold param for search.
+
+## [0.10.2] - 2025-08-05
+- Add script to chat against file.
+
 ## [0.10.1] - 2025-08-05
 - Allow deletion of a space chat.
 

{unique_sdk-0.10.1 → unique_sdk-0.10.3}/README.md

@@ -656,6 +656,7 @@ These are the options are available for `searchType`:
 `language` Optional. The language specification for full text search.
 `reranker` Optional. The reranker service to be used for re-ranking the search results.
 `chatId` Optional, adds the documents uploaded in this chat to the scope of searched documents.
+`scoreThreshold` Optional, sets the minimum similarity score for search results to be considered. Using 0 is recommended.
 
 ```python
 search = unique_sdk.Search.create(
@@ -670,6 +671,7 @@ search = unique_sdk.Search.create(
     reranker={"deploymentName": "my_deployment"},
     limit=20,
     page=1
+    scoreThreshold=0
 )
 ```
 
@@ -1008,6 +1010,12 @@ A metadata filter such as the one designed above can be used in a `Search.create
 
 ## Utils
 
+- [Chat History](#chat-history)
+- [File Io](#file-io)
+- [Sources](#sources)
+- [token](#token)
+- [Chat In Space](#chat-in-space)
+
 ### Chat History
 
 #### `unique_sdk.utils.chat_history.load_history`
@@ -1237,33 +1245,64 @@ The script ensures you can flexibly interact with spaces in new or ongoing chats
 
 ```python
 latest_message = await unique_sdk.utils.chat_in_space.send_message_and_wait_for_completion(
-        user_id=user_id,
-        company_id=company_id,
-        assistant_id=assistant_id,
-        text="Tell me a short story.",
-        chat_id=chat_id,                # Optional - if no chat id is specified, a new chat will be created
-        tool_choices=["WebSearch"],
-        scope_rules={
-            "or": [
-                {
-                    "operator": "in",
-                    "path": [
-                        "contentId"
-                    ],
-                    "value": [
-                        "cont_u888z7cazxxm4lugfdjq7pks"
-                    ]
-                },
-                {
-                    "operator": "contains",
-                    "path": [
-                        "folderIdPath"
-                    ],
-                    "value": "uniquepathid://scope_btfo28b3eeelwh5obwgea71bl/scope_fn56ta67knd6w4medgq3028fx"
-                }
-            ]
-        },
-    )
+    user_id=user_id,
+    company_id=company_id,
+    assistant_id=assistant_id,
+    text="Tell me a short story.",
+    chat_id=chat_id,                # Optional - if no chat id is specified, a new chat will be created
+    tool_choices=["WebSearch"],
+    scope_rules={
+        "or": [
+            {
+                "operator": "in",
+                "path": [
+                    "contentId"
+                ],
+                "value": [
+                    "cont_u888z7cazxxm4lugfdjq7pks"
+                ]
+            },
+            {
+                "operator": "contains",
+                "path": [
+                    "folderIdPath"
+                ],
+                "value": "uniquepathid://scope_btfo28b3eeelwh5obwgea71bl/scope_fn56ta67knd6w4medgq3028fx"
+            }
+        ]
+    },
+)
+```
+
+#### `unique_sdk.utils.chat_in_space.chat_against_file`
+
+The following script enables you to chat against a file.
+
+You must provide the following parameters:
+- `assistantId`: The assistant to be used for the chat.
+- `path_to_file`: The local path of the file to be uploaded.
+- `displayed_filename`: The name of the file to be displayed.
+- `mime_type`: The mime type of the ifle to be uploaded.
+- `text`: The text to be sent to the chat for chatting against the file.
+
+The script creates a chat and uploads the file to it. It then keeps polling the `ingestionState` field of the message, waiting for it to reach `FINISHED`, signaling the upload is complete. Once the file uploads successfully, the script sends the text, continues polling for completion, and finally retrieves the response message.
+
+**Optional parameters:**
+- `poll_interval`: The number of seconds to wait between polling attempts (default: `1` second).
+- `max_wait`: The maximum number of seconds to wait for the message to complete (default: `60` seconds).
+
+Example of chatting against a PDF. (The usage can be extended to any supported file type)
+
+```python
+latest_message = await unique_sdk.utils.chat_in_space.chat_against_file(
+    user_id=user_id,
+    company_id=company_id,
+    assistant_id="assistant_hjcdga64bkcjnhu4",
+    path_to_file="/files/hello.pdf",
+    displayed_filename="hello.pdf"
+    mime_type="application/pdf"
+    text="Give me a bullet point summary of the file.",
+)
 ```
 
 ## Error Handling

{unique_sdk-0.10.1 → unique_sdk-0.10.3}/pyproject.toml

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

{unique_sdk-0.10.1 → unique_sdk-0.10.3}/unique_sdk/api_resources/_content.py

@@ -64,6 +64,7 @@ class Content(APIResource["Content"]):
     class SearchParams(RequestOptions):
         where: "Content.ContentWhereInput"
         chatId: NotRequired[str]
+        includeFailedContent: NotRequired[bool]
 
     class ContentInfoParams(TypedDict):
         """
@@ -163,11 +164,11 @@ class Content(APIResource["Content"]):
     class MagicTableSheetTable(TypedDict):
         rowId: str
         columns: List["Content.MagicTableSheetTableColumn"]
-    
+
     class MagicTableSheetIngestionConfiguration(TypedDict):
         columnIdsInMetadata: List[str]
         columnIdsInChunkText: List[str]
-    
+
     class MagicTableSheetIngestParams(TypedDict):
         data: List["Content.MagicTableSheetTable"]
         ingestionConfiguration: "Content.MagicTableSheetIngestionConfiguration"
@@ -298,10 +299,10 @@ class Content(APIResource["Content"]):
 
     @classmethod
     def ingest_magic_table_sheets(
-            cls, 
-            user_id: str, 
-            company_id: str, 
-            **params: Unpack["Content.MagicTableSheetIngestParams"]
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Content.MagicTableSheetIngestParams"],
     ) -> "Content.MagicTableSheetResponse":
         return cast(
             Content.MagicTableSheetResponse,
@@ -316,10 +317,10 @@ class Content(APIResource["Content"]):
 
     @classmethod
     async def ingest_magic_table_sheets_async(
-            cls, 
-            user_id: str, 
-            company_id: str, 
-            **params: Unpack["Content.MagicTableSheetIngestParams"]
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Content.MagicTableSheetIngestParams"],
     ) -> "Content.MagicTableSheetResponse":
         return cast(
             Content.MagicTableSheetResponse,

{unique_sdk-0.10.1 → unique_sdk-0.10.3}/unique_sdk/api_resources/_search.py

@@ -19,6 +19,7 @@ class Search(APIResource["Search"]):
         page: NotRequired[Optional[int]]
         metaDataFilter: NotRequired[Optional[dict[str, Any]]]
         contentIds: NotRequired[Optional[list[str]]]
+        scoreThreshold: NotRequired[Optional[float]]
 
     id: str
     chunkId: str

unique_sdk-0.10.3/unique_sdk/utils/chat_in_space.py

@@ -0,0 +1,167 @@
+import asyncio
+from typing import List
+
+from unique_sdk.api_resources._content import Content
+from unique_sdk.api_resources._space import Space
+from unique_sdk.utils.file_io import upload_file
+
+
+async def send_message_and_wait_for_completion(
+    user_id: str,
+    company_id: str,
+    assistant_id: str,
+    text: str,
+    tool_choices: List[str] = None,
+    scope_rules: dict | None = None,
+    chat_id: str = None,
+    poll_interval: float = 1.0,
+    max_wait: float = 60.0,
+) -> "Space.Message":
+    """
+    Sends a prompt asynchronously and polls for completion. (until stoppedStreamingAt is not None)
+
+    Args:
+        user_id: The user ID.
+        company_id: The company ID.
+        assistant_id: The assistant ID.
+        text: The prompt text.
+        poll_interval: Seconds between polls.
+        max_wait: Maximum seconds to wait for completion.
+        **kwargs: Additional parameters for the prompt.
+
+    Returns:
+        The completed Space.Message.
+    """
+    response = await Space.create_message_async(
+        user_id=user_id,
+        company_id=company_id,
+        assistantId=assistant_id,
+        chatId=chat_id,
+        text=text,
+        toolChoices=tool_choices,
+        scopeRules=scope_rules,
+    )
+    chat_id = response.get("chatId")
+
+    max_attempts = int(max_wait // poll_interval)
+    for _ in range(max_attempts):
+        answer = Space.get_latest_message(user_id, company_id, chat_id)
+        if answer.get("stoppedStreamingAt") is not None:
+            return answer
+        await asyncio.sleep(poll_interval)
+
+    raise TimeoutError("Timed out waiting for prompt completion.")
+
+
+async def chat_against_file(
+    user_id: str,
+    company_id: str,
+    assistant_id: str,
+    path_to_file: str,
+    displayed_filename: str,
+    mime_type: str,
+    text: str,
+    poll_interval: float = 1.0,
+    max_wait: float = 60.0,
+) -> "Space.Message":
+    """
+    Chat against a file by uploading it, sending a message and waiting for a reply.
+    Args:
+
+        user_id: The user ID.
+        company_id: The company ID.
+        assistant_id: The assistant ID.
+        path_to_file: Path to the PDF file to upload.
+        displayed_filename: Name to display for the uploaded file.
+        mime_type: MIME type of the file (e.g., "application/pdf").
+        text: Text to send after uploading the file and chat against.
+        poll_interval: Seconds between polls for file ingestion.
+        max_wait: Maximum seconds to wait for the final response.
+
+    Returns:
+        The final message response.
+    """
+    chat_id = None
+
+    try:
+        response = await send_message_and_wait_for_completion(
+            user_id=user_id,
+            company_id=company_id,
+            assistant_id=assistant_id,
+            text="I'm going to upload a file for analysis.",
+        )
+        chat_id = response.get("chatId")
+
+        upload_response = upload_file(
+            userId=user_id,
+            companyId=company_id,
+            path_to_file=path_to_file,
+            displayed_filename=displayed_filename,
+            mime_type=mime_type,
+            chat_id=chat_id,
+        )
+        content_id = upload_response.get("id")
+
+        await wait_for_ingestion_completion(
+            user_id=user_id,
+            company_id=company_id,
+            content_id=content_id,
+            chat_id=chat_id,
+            poll_interval=poll_interval,
+            max_wait=max_wait,
+        )
+
+        final_response = await send_message_and_wait_for_completion(
+            user_id=user_id,
+            company_id=company_id,
+            assistant_id=assistant_id,
+            text=text,
+            chat_id=chat_id,
+            poll_interval=poll_interval,
+            max_wait=max_wait,
+        )
+
+        return final_response
+
+    except Exception as err:
+        print(f"Error during chat against file: {err}")
+        raise
+    finally:
+        if chat_id:
+            Space.delete_chat(
+                user_id=user_id,
+                company_id=company_id,
+                chat_id=chat_id,
+            )
+
+
+async def wait_for_ingestion_completion(
+    user_id: str,
+    company_id: str,
+    content_id: str,
+    chat_id: str,
+    poll_interval: float = 1.0,
+    max_wait: float = 60.0,
+):
+    """
+    Waits until the content ingestionState is FINISHED or the maximum wait time is reached and throws if case of failed status.
+    """
+    max_attempts = int(max_wait // poll_interval)
+    for _ in range(max_attempts):
+        searched_content = Content.search(
+            user_id=user_id,
+            company_id=company_id,
+            where={"id": {"equals": content_id}},
+            chatId=chat_id,
+            includeFailedContent=True,
+        )
+        if searched_content:
+            ingestion_state = searched_content[0].get("ingestionState")
+            if ingestion_state == "FINISHED":
+                return
+            if isinstance(ingestion_state, str) and ingestion_state.startswith(
+                "FAILED"
+            ):
+                raise RuntimeError(f"Ingestion failed with state: {ingestion_state}")
+        await asyncio.sleep(poll_interval)
+    raise TimeoutError("Timed out waiting for file ingestion to finish.")

unique_sdk-0.10.1/unique_sdk/utils/chat_in_space.py

@@ -1,53 +0,0 @@
-import asyncio
-from typing import List
-
-from unique_sdk.api_resources._space import Space
-
-
-async def send_message_and_wait_for_completion(
-    user_id: str,
-    company_id: str,
-    assistant_id: str,
-    text: str,
-    tool_choices: List[str] = None,
-    scope_rules: dict | None = None,
-    chat_id: str = None,
-    poll_interval: float = 1.0,
-    max_wait: float = 60.0,
-) -> "Space.Message":
-    """
-    Sends a prompt asynchronously and polls for completion. (until stoppedStreamingAt is not None)
-
-    Args:
-        user_id: The user ID.
-        company_id: The company ID.
-        assistant_id: The assistant ID.
-        text: The prompt text.
-        poll_interval: Seconds between polls.
-        max_wait: Maximum seconds to wait for completion.
-        **kwargs: Additional parameters for the prompt.
-
-    Returns:
-        The completed Space.Message.
-    """
-    # Send the prompt asynchronously
-    response = await Space.create_message_async(
-        user_id=user_id,
-        company_id=company_id,
-        assistantId=assistant_id,
-        chatId=chat_id,
-        text=text,
-        toolChoices=tool_choices,
-        scopeRules=scope_rules,
-    )
-    chat_id = response.get("chatId")
-
-    max_attempts = int(max_wait // poll_interval)
-    for _ in range(max_attempts):
-        # Poll for the answer
-        answer = Space.get_latest_message(user_id, company_id, chat_id)
-        if answer.get("stoppedStreamingAt") is not None:
-            return answer
-        await asyncio.sleep(poll_interval)
-
-    raise TimeoutError("Timed out waiting for prompt completion.")