unique_sdk 0.9.38__py3-none-any.whl → 0.9.39__py3-none-any.whl

unique_sdk/__init__.py

@@ -86,6 +86,7 @@ from unique_sdk.api_resources._acronyms import Acronyms as Acronyms
 from unique_sdk.api_resources._message_assessment import (
     MessageAssessment as MessageAssessment,
 )
+from unique_sdk.api_resources._space import Space as Space
 
 # Unique QL
 from unique_sdk._unique_ql import UQLOperator as UQLOperator

unique_sdk/api_resources/_space.py

@@ -0,0 +1,144 @@
+from typing import Any, ClassVar, Dict, List, Literal, Optional, TypedDict, Unpack, cast
+
+from unique_sdk._api_resource import APIResource
+from unique_sdk._request_options import RequestOptions
+
+
+class Space(APIResource["Space"]):
+    OBJECT_NAME: ClassVar[Literal["space"]] = "space"
+
+    class CreateMessageParams(RequestOptions):
+        """
+        Parameters for querying the assistant for a message.
+        """
+
+        chatId: str | None = None
+        assistantId: str
+        text: str | None = None
+        toolChoices: List[str] = None
+        scopeRules: dict | None = None
+
+    class Reference(TypedDict):
+        """
+        Reference information for a message.
+        """
+
+        name: str
+        url: str | None
+        sequenceNumber: int
+        originalIndex: List[int] | None
+        sourceId: str
+        source: str
+
+    class Assessment(TypedDict):
+        """
+        Assessment information for a message.
+        """
+
+        id: str
+        createdAt: str
+        updatedAt: str
+        messageId: str
+        status: str
+        explanation: str | None
+        label: str | None
+        type: str | None
+        title: str | None
+        companyId: str
+        userId: str
+        isVisible: bool
+        createdBy: str | None
+
+    class Message(TypedDict):
+        """
+        Represents a message in the space.
+        """
+
+        id: str
+        chatId: str
+        text: str | None = None
+        originalText: str | None = None
+        role: Literal["system", "user", "assistant"]
+        debugInfo: Optional[Dict[str, Any]] = None
+        completedAt: str | None
+        createdAt: str | None
+        updatedAt: str | None
+        stoppedStreamingAt: str | None
+        assessment: Optional[List["Space.Reference"]]
+        messageAssessment: Optional[List["Space.Assessment"]]
+
+    @classmethod
+    def create_message(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Space.CreateMessageParams"],
+    ) -> "Space.Message":
+        """
+        Send a message in a space.
+        """
+        return cast(
+            "Space.Message",
+            cls._static_request(
+                "post",
+                "/space/message",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    async def create_message_async(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Space.CreateMessageParams"],
+    ) -> "Space.Message":
+        """
+        Async send a message in a space.
+        """
+        return cast(
+            "Space.Message",
+            await cls._static_request_async(
+                "post",
+                "/space/message",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    def get_latest_message(
+        cls, user_id: str, company_id: str, chat_id: str
+    ) -> "Space.Message":
+        """
+        Get the latest message in a space.
+        """
+        return cast(
+            "Space.Message",
+            cls._static_request(
+                "get",
+                f"/space/{chat_id}/messages/latest",
+                user_id,
+                company_id,
+            ),
+        )
+
+    @classmethod
+    async def get_latest_message_async(
+        cls, user_id: str, company_id: str, chat_id: str
+    ) -> "Space.Message":
+        """
+        Async get the latest message in a space.
+        """
+        return cast(
+            "Space.Message",
+            await cls._static_request_async(
+                "get",
+                f"/space/{chat_id}/messages/latest",
+                user_id,
+                company_id,
+            ),
+        )

unique_sdk/utils/chat_in_space.py

@@ -0,0 +1,53 @@
+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.")

{unique_sdk-0.9.38.dist-info → unique_sdk-0.9.39.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.9.38
+Version: 0.9.39
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -28,7 +28,6 @@ The Unique Python SDK provides access to the public API of Unique FinanceGPT. It
 4. [Webhook Triggers](#webhook-triggers)
 5. [Available API Resources](#available-api-resources)
    - [Content](#content)
-   - [Folder](#folder)
    - [Message](#message)
    - [Chat Completion](#chat-completion)
    - [Embeddings](#embeddings)
@@ -46,6 +45,7 @@ The Unique Python SDK provides access to the public API of Unique FinanceGPT. It
    - [File Io](#file-io)
    - [Sources](#sources)
    - [token](#token)
+   - [Chat In Space](#chat-in-space)
 8. [Error Handling](#error-handling)
 9. [Examples](#examples)
 
@@ -244,8 +244,12 @@ unique_sdk.Message.modify(
 - [Content](#content)
 - [Message](#message)
 - [Chat Completion](#chat-completion)
+- [Embeddings](#embeddings)
+- [Acronyms](#acronyms)
 - [Search](#search)
 - [Search String](#search-string)
+- [Short Term Memory](#short-term-memory)
+- [Message Assessment](#message-assessment)
 - [Folder](#folder)
 
 Most of the API services provide an asynchronous version of the method. The async methods are suffixed with `_async`.
@@ -469,175 +473,6 @@ Allows you to ingest a magic table sheet, each row is processed and converted in
     unique_sdk.Content.ingest_magic_table_sheets(**params)
 ```
 
-### Folder
-
-#### `unique_sdk.Folder.get`
-
-Get a folder by scope id or by path.
-
-By scope id:
-
-```python
-unique_sdk.Folder.get_info(
-   user_id=user_id,
-   company_id=company_id,
-   scopeId="scope_w78wfn114va9o22s13r03yq",
-)
-```
-
-By path:
-
-```python
-unique_sdk.Folder.get_info(
-   user_id=user_id,
-   company_id=company_id,
-   folderPath="/Company/Atlas/Due Dilligence/Arch,
-)
-```
-
-#### `unique_sdk.Folder.create_paths`
-
-Create each folder in the provided list of paths if it does not already exist.
-
-```python
-unique_sdk.Folder.create_paths(
-   user_id=user_id,
-   company_id=company_id,
-   paths=["/unique/path1", "/unique/path2"],
-)
-```
-
-#### `unique_sdk.Folder.update_ingestion_config`
-
-Allows you to update the ingestion config of a folder and choose whether to apply to the subscopes or not: `
-
-- `ingestionConfig`
-- `applyToSubScopes`
-
-The update can be done by referencing the folder by id or by path. If none of them are provided. the API will return an error. If both of them are provided, the scope id will take precedence.
-
-Example of updating the ingestion config of a folder and its subfolders using the id.
-
-```python
-unique_sdk.Folder.update_ingestion_config(
-    user_id=user_id,
-    company_id=company_id,
-    scopeId="scope_qbnkde820dbmuw2900,
-    ingestionConfig={
-        "chunkStrategy": "default",
-        "uniqueIngestionMode": "standard",
-    },
-    applyToSubScopes=True
-)
-```
-
-Example of updating the ingestion config of a folder and its subfolders using the path.
-
-```python
-unique_sdk.Folder.update_ingestion_config(
-    user_id=user_id,
-    company_id=company_id,
-    folderPath="/Company/folder1/folder2",
-    ingestionConfig={
-        "chunkStrategy": "default",
-        "uniqueIngestionMode": "standard",
-    },
-    applyToSubScopes=True
-)
-```
-
-#### `unique_sdk.Folder.add_access`
-
-Allows you to add access to a folder and apply to the subfolders or not: `
-
-- `scopeAccesses`
-- `applyToSubScopes`
-
-The update can be done by referencing the folder by id or by path. If none of them are provided. the API will return an error. If both of them are provided, the scope id will take precedence.
-
-Example of adding access to a folder and its subfolders using the id.
-
-```python
-unique_sdk.Folder.add_access(
-    user_id=user_id,
-    company_id=company_id,
-    scopeId="scope_231e4kjn4foffww34",
-    scopeAccesses=[
-        {
-            "entityId": "group_id",
-            "type": "WRITE",
-            "entityType": "GROUP",
-        }
-    ],
-    applyToSubScopes=True,
-)
-```
-
-Example of adding access to a folder and its subfolders using the folder path.
-
-```python
-unique_sdk.Folder.add_access(
-    user_id=user_id,
-    company_id=company_id,
-    folderPath="/Company/folder1/folder2"
-    scopeAccesses=[
-        {
-            "entityId": "group_id",
-            "type": "WRITE",
-            "entityType": "GROUP",
-        }
-    ],
-    applyToSubScopes=True,
-)
-```
-
-#### `unique_sdk.Folder.remove_access`
-
-Allows you to delete access from a folder and apply to the subfolders or not: `
-
-- `scopeAccesses`
-- `applyToSubScopes`
-
-The update can be done by referencing the folder by id or by path. If none of them are provided. the API will return an error. If both of them are provided, the scope id will take precedence.
-
-
-Example of deleting the access from a folder and its subfolders using the id.
-
-```python
-unique_sdk.Folder.remove_access(
-    user_id=user_id,
-    company_id=company_id,
-    scopeId="scope_dwekjnf3330woioppm,
-    scopeAccesses=[
-        {
-            "entityId": "group_id",
-            "type": "WRITE",
-            "entityType": "GROUP",
-        }
-    ],
-    applyToSubScopes=True,
-)
-```
-
-
-Example of deleting the access from a folder and its subfolders using the path.
-
-```python
-unique_sdk.Folder.remove_access(
-    user_id=user_id,
-    company_id=company_id,
-    folderPath="/Company/folder1/folder2"
-    scopeAccesses=[
-        {
-            "entityId": "group_id",
-            "type": "WRITE",
-            "entityType": "GROUP",
-        }
-    ],
-    applyToSubScopes=True,
-)
-```
-
 ### Message
 
 #### `unique_sdk.Message.list`
@@ -946,6 +781,175 @@ assessment = unique_sdk.MessageAssessment.modify(
 )
 ```
 
+### Folder
+
+#### `unique_sdk.Folder.get`
+
+Get a folder by scope id or by path.
+
+By scope id:
+
+```python
+unique_sdk.Folder.get_info(
+   user_id=user_id,
+   company_id=company_id,
+   scopeId="scope_w78wfn114va9o22s13r03yq",
+)
+```
+
+By path:
+
+```python
+unique_sdk.Folder.get_info(
+   user_id=user_id,
+   company_id=company_id,
+   folderPath="/Company/Atlas/Due Dilligence/Arch,
+)
+```
+
+#### `unique_sdk.Folder.create_paths`
+
+Create each folder in the provided list of paths if it does not already exist.
+
+```python
+unique_sdk.Folder.create_paths(
+   user_id=user_id,
+   company_id=company_id,
+   paths=["/unique/path1", "/unique/path2"],
+)
+```
+
+#### `unique_sdk.Folder.update_ingestion_config`
+
+Allows you to update the ingestion config of a folder and choose whether to apply to the subscopes or not: `
+
+- `ingestionConfig`
+- `applyToSubScopes`
+
+The update can be done by referencing the folder by id or by path. If none of them are provided. the API will return an error. If both of them are provided, the scope id will take precedence.
+
+Example of updating the ingestion config of a folder and its subfolders using the id.
+
+```python
+unique_sdk.Folder.update_ingestion_config(
+    user_id=user_id,
+    company_id=company_id,
+    scopeId="scope_qbnkde820dbmuw2900,
+    ingestionConfig={
+        "chunkStrategy": "default",
+        "uniqueIngestionMode": "standard",
+    },
+    applyToSubScopes=True
+)
+```
+
+Example of updating the ingestion config of a folder and its subfolders using the path.
+
+```python
+unique_sdk.Folder.update_ingestion_config(
+    user_id=user_id,
+    company_id=company_id,
+    folderPath="/Company/folder1/folder2",
+    ingestionConfig={
+        "chunkStrategy": "default",
+        "uniqueIngestionMode": "standard",
+    },
+    applyToSubScopes=True
+)
+```
+
+#### `unique_sdk.Folder.add_access`
+
+Allows you to add access to a folder and apply to the subfolders or not: `
+
+- `scopeAccesses`
+- `applyToSubScopes`
+
+The update can be done by referencing the folder by id or by path. If none of them are provided. the API will return an error. If both of them are provided, the scope id will take precedence.
+
+Example of adding access to a folder and its subfolders using the id.
+
+```python
+unique_sdk.Folder.add_access(
+    user_id=user_id,
+    company_id=company_id,
+    scopeId="scope_231e4kjn4foffww34",
+    scopeAccesses=[
+        {
+            "entityId": "group_id",
+            "type": "WRITE",
+            "entityType": "GROUP",
+        }
+    ],
+    applyToSubScopes=True,
+)
+```
+
+Example of adding access to a folder and its subfolders using the folder path.
+
+```python
+unique_sdk.Folder.add_access(
+    user_id=user_id,
+    company_id=company_id,
+    folderPath="/Company/folder1/folder2"
+    scopeAccesses=[
+        {
+            "entityId": "group_id",
+            "type": "WRITE",
+            "entityType": "GROUP",
+        }
+    ],
+    applyToSubScopes=True,
+)
+```
+
+#### `unique_sdk.Folder.remove_access`
+
+Allows you to delete access from a folder and apply to the subfolders or not: `
+
+- `scopeAccesses`
+- `applyToSubScopes`
+
+The update can be done by referencing the folder by id or by path. If none of them are provided. the API will return an error. If both of them are provided, the scope id will take precedence.
+
+
+Example of deleting the access from a folder and its subfolders using the id.
+
+```python
+unique_sdk.Folder.remove_access(
+    user_id=user_id,
+    company_id=company_id,
+    scopeId="scope_dwekjnf3330woioppm,
+    scopeAccesses=[
+        {
+            "entityId": "group_id",
+            "type": "WRITE",
+            "entityType": "GROUP",
+        }
+    ],
+    applyToSubScopes=True,
+)
+```
+
+
+Example of deleting the access from a folder and its subfolders using the path.
+
+```python
+unique_sdk.Folder.remove_access(
+    user_id=user_id,
+    company_id=company_id,
+    folderPath="/Company/folder1/folder2"
+    scopeAccesses=[
+        {
+            "entityId": "group_id",
+            "type": "WRITE",
+            "entityType": "GROUP",
+        }
+    ],
+    applyToSubScopes=True,
+)
+```
+
 ## UniqueQL
 
 [UniqueQL](https://unique-ch.atlassian.net/wiki/x/coAXHQ) is an advanced query language designed to enhance search capabilities within various search modes such as Vector, Full-Text Search (FTS), and Combined. This query language enables users to perform detailed searches by filtering through metadata attributes like filenames, URLs, dates, and more. UniqueQL is versatile and can be translated into different query formats for various database systems, including PostgreSQL and Qdrant.
@@ -1051,7 +1055,7 @@ pdfFile = download_content(
     content_id="cont_12412",
     filename="hello.pdf",
     chat_id=None # If specified, it downloads it from the chat
-}
+)
 ```
 
 #### `unique_sdk.utils.file_io.upload_file`
@@ -1214,6 +1218,47 @@ hello = "hello you!"
 searchContext = unique_sdk.utils.token.count_tokens(hello)
 ```
 
+### Chat In Space
+
+#### `unique_sdk.utils.chat_in_space.send_message_and_wait_for_completion`
+
+The following script enables you to chat within a space using an assistant. You must provide an `assistantId` (e.g., `assistant_hjcdga64bkcjnhu4`) and the message `text` to initiate the conversation. You can send the message in an existing chat by specifying a `chat_id`, or omit the `chat_id` to automatically create a new chat session. Check the optional parameteres list for more configs.
+
+The script sends a prompt asynchronously and continuously polls for completion, which is determined when the `stoppedStreamingAt` field of the message becomes non-null.
+
+**Optional parameters:**
+- `tool_choices`: A list of tool names to be used for the message (e.g., `["WebSearch"]`). If not provided, no tools will be used.
+- `scope_rules`: A dictionary specifying scope rules for the message, allowing you to restrict the context or data sources available to the assistant.
+- `chat_id`: The ID of the chat where the message should be sent. If omitted, a new chat will be created.
+- `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).
+
+The script ensures you can flexibly interact with spaces in new or ongoing chats, with fine-grained control over tools, context, and polling behavior.
+
+```python
+latest_message = unique_sdk.utils.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"
+                    ]
+                }
+            ]
+        },
+    )
+```
+
 ## Error Handling
 
 ## Examples
@@ -1231,6 +1276,9 @@ 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.9.39] - 2025-07-18
+- Add script to chat in a space.
+
 ## [0.9.38] - 2025-07-18
 - [Experimental] Add support for Unique OpenAI proxy. You can now use the OpenAI SDK directly through Unique. Checkout how to do this and a few examples here: `tutorials/unique_basics/sdk_examples/openai_scripts.py`.
 

{unique_sdk-0.9.38.dist-info → unique_sdk-0.9.39.dist-info}/RECORD

@@ -1,4 +1,4 @@
-unique_sdk/__init__.py,sha256=-iaWPCqxhrGmXvI9LtaHOtsxMnyeXryk9hTzxHDH2V4,3238
+unique_sdk/__init__.py,sha256=myJ5su7qQEGDqSDi1Mv37bbWvP7JnJ0E30tVwYMlbLM,3297
 unique_sdk/_api_requestor.py,sha256=i4gCpzx8zP95sv-AhJfpQxKvWR0U-I6lclHyV55RPtg,14397
 unique_sdk/_api_resource.py,sha256=ytjomI-IVJwsbvdPyuZCfF-bl-Abgf66bu1D34YxCu8,6244
 unique_sdk/_api_version.py,sha256=Ku4JPdeyJtnX5eJJvRCEc1_u44UObdVrvrL1T-WwWCs,46
@@ -26,11 +26,13 @@ unique_sdk/api_resources/_message_assessment.py,sha256=SSfx6eW7zb_GKe8cFJzCqW-t-
 unique_sdk/api_resources/_search.py,sha256=pAVMXL2AdJNP5JG-7LlaU2Uw1152iUaMZ2YO7fHnNWc,1906
 unique_sdk/api_resources/_search_string.py,sha256=4Idw6exgZdA8qksz9WkiA68k1hTU-7yFkgT_OLU_GkE,1662
 unique_sdk/api_resources/_short_term_memory.py,sha256=vPRN-Y0WPx74E6y-A3LocGc0TxJdzT-xGL66WzZwKRg,2820
+unique_sdk/api_resources/_space.py,sha256=LAK-ZbHemIIfX51anthml4ojxhPUPDOu_EbQs64rOFA,3726
 unique_sdk/utils/chat_history.py,sha256=5UqL9hF1O9pV7skbNOlEibF5rHdYsmG3m5-YEPUowOs,3037
+unique_sdk/utils/chat_in_space.py,sha256=kQA43P9XZ6Kdf05JZiLhVJ5ejVtrgzZSb8osyNHSZmc,1580
 unique_sdk/utils/file_io.py,sha256=YY8B7VJcTLOPmCXByiOfNerXGlAtjCC5EVNmAbQJ3dQ,4306
 unique_sdk/utils/sources.py,sha256=wfboE-neMKa0Wuq9QzfAEFMkNLrIrmm0v-QF33sLo6k,4952
 unique_sdk/utils/token.py,sha256=AzKuAA1AwBtnvSFxGcsHLpxXr_wWE5Mj4jYBbOz2ljA,1740
-unique_sdk-0.9.38.dist-info/LICENSE,sha256=EJCWoHgrXVBUb47PnjeV4MFIEOR71MAdCOIgv61J-4k,1065
-unique_sdk-0.9.38.dist-info/METADATA,sha256=99Ldpbz3ZjUJg4KZnvsmHCD02YjS6uMcpT7P2706NNE,39755
-unique_sdk-0.9.38.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-unique_sdk-0.9.38.dist-info/RECORD,,
+unique_sdk-0.9.39.dist-info/LICENSE,sha256=EJCWoHgrXVBUb47PnjeV4MFIEOR71MAdCOIgv61J-4k,1065
+unique_sdk-0.9.39.dist-info/METADATA,sha256=THF3YM9qYZJtgBJkgXI9s5ujnLFoaEYI5zCtPGSSL70,42083
+unique_sdk-0.9.39.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+unique_sdk-0.9.39.dist-info/RECORD,,