unique_sdk 0.10.3__tar.gz → 0.10.5__tar.gz

{unique_sdk-0.10.3 → unique_sdk-0.10.5}/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.5] - 2025-08-06
+- Get paginated files and folders info.
+
+## [0.10.4] - 2025-08-05
+- Add support for reasoning API with streaming within a chat.
+
 ## [0.10.3] - 2025-08-05
 - Expose scoreThreshold param for search.
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.10.3
+Version: 0.10.5
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -294,7 +294,7 @@ unique_sdk.Content.search(
 
 #### `unique_sdk.Content.get_info`
 
-Allows you to get content info. To filter the results you can define a metadata filter in UniqueQL language. Find out more about it in the UniqueQL section. An example of a metadata filter defined with UniqueQL is the following:
+[Deprecated, use `unique_sdk.Content.get_infos` instead.] Allows you to get content info. To filter the results you can define a metadata filter in UniqueQL language. Find out more about it in the UniqueQL section. An example of a metadata filter defined with UniqueQL is the following:
 
 ```python
     metadataFilter: {
@@ -326,7 +326,7 @@ Pagination is also enabled for this functionality, and the default number of ret
 - `skip`
 - `take`
 
-Here is an example of retrieving the first 3 content infos that contain the value `uniquepathid://scope_abcdibgznc4bkdcx120zm5d` in the `folderIdPath` metadata and the value `ai` for the `tile` metadata.
+Here is an example of retrieving the first 3 content infos that contain the value `uniquepathid://scope_abcdibgznc4bkdcx120zm5d` in the `folderIdPath` metadata and the value `ai` for the `title` metadata.
 
 ```python
 content_info_result = unique_sdk.Content.get_info(
@@ -359,6 +359,85 @@ content_info_result = unique_sdk.Content.get_info(
 )
 ```
 
+#### `unique_sdk.Content.get_infos`
+
+Allows you to get content infos. To filter the results you can define a either metadata filter in UniqueQL language or specify a parentId. If both are defined, the function will throw an error.
+
+I f you want to learn more about UniqueQL, you can find out more about it in the [UniqueQL](#uniqueql) section. An example of a metadata filter defined with UniqueQL is the following:
+
+```python
+    metadataFilter: {
+        "or": [
+            {
+                "and": [
+                    {
+                        "operator": "contains",
+                        "path": [
+                            "folderIdPath"
+                        ],
+                        "value": "uniquepathid://test_id"
+                    },
+                    {
+                        "operator": "contains",
+                        "path": [
+                            "title"
+                        ],
+                        "value": "ai"
+                    }
+                ]
+            }
+        ]
+    },
+```
+
+Pagination is also enabled for this functionality, and the default number of returned results is 50 with no entries skipped. Use the following paramteres to get the desired page:`
+
+- `skip`
+- `take`
+
+Here is an example of retrieving the first 3 content infos that contain the value `uniquepathid://scope_abcdibgznc4bkdcx120zm5d` in the `folderIdPath` metadata and the value `ai` for the `title` metadata.
+
+```python
+content_info_result = unique_sdk.Content.get_infos(
+    user_id=user_id,
+    company_id=company_id,
+    metadataFilter={
+        "or": [
+            {
+                "and": [
+                    {
+                        "operator": "contains",
+                        "path": [
+                            "folderIdPath"
+                        ],
+                        "value": "uniquepathid://scope_abcdibgznc4bkdcx120zm5d"
+                    },
+                    {
+                        "operator": "contains",
+                        "path": [
+                            "title"
+                        ],
+                        "value": "ai"
+                    }
+                ]
+            }
+        ]
+    },
+    skip=0,
+    take=3,
+)
+```
+
+Here is an example of retrieving the contents based on a parentId.
+
+```python
+content_info_result = unique_sdk.Content.get_infos(
+    user_id=user_id,
+    company_id=company_id,
+    parentId="scope_ahefgj389srjbfejkkk98u"
+)
+```
+
 #### `unique_sdk.Content.upsert`
 
 Enables upload of a new Content into the Knowledge base of unique into a specific scope with `scopeId` or a specific `chatId`. One of the two must be set.
@@ -605,6 +684,39 @@ unique_sdk.Integrated.chat_stream_completion(
 
 **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.
 
+
+#### `unique_sdk.Integrated.responses_stream`
+
+Streams the answer to the chat frontend using the Responses API. Given the messages.
+
+if the stream creates [source0] it is referenced with the references from the search context.
+
+E.g.
+
+```
+Hello this information is from [source1]
+```
+
+adds the reference at index 1 and then changes the text to:
+
+```
+Hello this information is from <sub>0</sub>
+```
+
+```python
+unique_sdk.Integrated.responses_stream(
+    user_id=userId,
+    company_id=companyId,
+    model="AZURE_o3_2025_0416",
+    assistantMessageId=assistantMessageId,
+    userMessageId=userMessageId,
+    input="Tell me about the curious case of neural text degeneration",
+    chatId=chatId,
+)
+```
+
+**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.
+
 ### Chat Completion
 
 #### `unique_sdk.ChatCompletion.create`
@@ -787,7 +899,7 @@ assessment = unique_sdk.MessageAssessment.modify(
 
 ### Folder
 
-#### `unique_sdk.Folder.get`
+#### `unique_sdk.Folder.get_info`
 
 Get a folder by scope id or by path.
 
@@ -811,6 +923,20 @@ unique_sdk.Folder.get_info(
 )
 ```
 
+#### `unique_sdl.Folder.get_infos`
+
+Get paginated folders info based on parentId. If the parentId is not defined, the root folders will be returned.
+
+```python
+unique_sdk.Folder.get_infos(
+    user_id=user_id,
+    company_id=company_id,
+    take=10,                                    #optional
+    skip=5,                                     #optional
+    parentId="scope_s18seqpnltf35niydg77xgyp"   #optional
+)
+```
+
 #### `unique_sdk.Folder.create_paths`
 
 Create each folder in the provided list of paths if it does not already exist.
@@ -1338,6 +1464,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.5] - 2025-08-06
+- Get paginated files and folders info.
+
+## [0.10.4] - 2025-08-05
+- Add support for reasoning API with streaming within a chat.
+
 ## [0.10.3] - 2025-08-05
 - Expose scoreThreshold param for search.
 

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

@@ -278,7 +278,7 @@ unique_sdk.Content.search(
 
 #### `unique_sdk.Content.get_info`
 
-Allows you to get content info. To filter the results you can define a metadata filter in UniqueQL language. Find out more about it in the UniqueQL section. An example of a metadata filter defined with UniqueQL is the following:
+[Deprecated, use `unique_sdk.Content.get_infos` instead.] Allows you to get content info. To filter the results you can define a metadata filter in UniqueQL language. Find out more about it in the UniqueQL section. An example of a metadata filter defined with UniqueQL is the following:
 
 ```python
     metadataFilter: {
@@ -310,7 +310,7 @@ Pagination is also enabled for this functionality, and the default number of ret
 - `skip`
 - `take`
 
-Here is an example of retrieving the first 3 content infos that contain the value `uniquepathid://scope_abcdibgznc4bkdcx120zm5d` in the `folderIdPath` metadata and the value `ai` for the `tile` metadata.
+Here is an example of retrieving the first 3 content infos that contain the value `uniquepathid://scope_abcdibgznc4bkdcx120zm5d` in the `folderIdPath` metadata and the value `ai` for the `title` metadata.
 
 ```python
 content_info_result = unique_sdk.Content.get_info(
@@ -343,6 +343,85 @@ content_info_result = unique_sdk.Content.get_info(
 )
 ```
 
+#### `unique_sdk.Content.get_infos`
+
+Allows you to get content infos. To filter the results you can define a either metadata filter in UniqueQL language or specify a parentId. If both are defined, the function will throw an error.
+
+I f you want to learn more about UniqueQL, you can find out more about it in the [UniqueQL](#uniqueql) section. An example of a metadata filter defined with UniqueQL is the following:
+
+```python
+    metadataFilter: {
+        "or": [
+            {
+                "and": [
+                    {
+                        "operator": "contains",
+                        "path": [
+                            "folderIdPath"
+                        ],
+                        "value": "uniquepathid://test_id"
+                    },
+                    {
+                        "operator": "contains",
+                        "path": [
+                            "title"
+                        ],
+                        "value": "ai"
+                    }
+                ]
+            }
+        ]
+    },
+```
+
+Pagination is also enabled for this functionality, and the default number of returned results is 50 with no entries skipped. Use the following paramteres to get the desired page:`
+
+- `skip`
+- `take`
+
+Here is an example of retrieving the first 3 content infos that contain the value `uniquepathid://scope_abcdibgznc4bkdcx120zm5d` in the `folderIdPath` metadata and the value `ai` for the `title` metadata.
+
+```python
+content_info_result = unique_sdk.Content.get_infos(
+    user_id=user_id,
+    company_id=company_id,
+    metadataFilter={
+        "or": [
+            {
+                "and": [
+                    {
+                        "operator": "contains",
+                        "path": [
+                            "folderIdPath"
+                        ],
+                        "value": "uniquepathid://scope_abcdibgznc4bkdcx120zm5d"
+                    },
+                    {
+                        "operator": "contains",
+                        "path": [
+                            "title"
+                        ],
+                        "value": "ai"
+                    }
+                ]
+            }
+        ]
+    },
+    skip=0,
+    take=3,
+)
+```
+
+Here is an example of retrieving the contents based on a parentId.
+
+```python
+content_info_result = unique_sdk.Content.get_infos(
+    user_id=user_id,
+    company_id=company_id,
+    parentId="scope_ahefgj389srjbfejkkk98u"
+)
+```
+
 #### `unique_sdk.Content.upsert`
 
 Enables upload of a new Content into the Knowledge base of unique into a specific scope with `scopeId` or a specific `chatId`. One of the two must be set.
@@ -589,6 +668,39 @@ unique_sdk.Integrated.chat_stream_completion(
 
 **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.
 
+
+#### `unique_sdk.Integrated.responses_stream`
+
+Streams the answer to the chat frontend using the Responses API. Given the messages.
+
+if the stream creates [source0] it is referenced with the references from the search context.
+
+E.g.
+
+```
+Hello this information is from [source1]
+```
+
+adds the reference at index 1 and then changes the text to:
+
+```
+Hello this information is from <sub>0</sub>
+```
+
+```python
+unique_sdk.Integrated.responses_stream(
+    user_id=userId,
+    company_id=companyId,
+    model="AZURE_o3_2025_0416",
+    assistantMessageId=assistantMessageId,
+    userMessageId=userMessageId,
+    input="Tell me about the curious case of neural text degeneration",
+    chatId=chatId,
+)
+```
+
+**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.
+
 ### Chat Completion
 
 #### `unique_sdk.ChatCompletion.create`
@@ -771,7 +883,7 @@ assessment = unique_sdk.MessageAssessment.modify(
 
 ### Folder
 
-#### `unique_sdk.Folder.get`
+#### `unique_sdk.Folder.get_info`
 
 Get a folder by scope id or by path.
 
@@ -795,6 +907,20 @@ unique_sdk.Folder.get_info(
 )
 ```
 
+#### `unique_sdl.Folder.get_infos`
+
+Get paginated folders info based on parentId. If the parentId is not defined, the root folders will be returned.
+
+```python
+unique_sdk.Folder.get_infos(
+    user_id=user_id,
+    company_id=company_id,
+    take=10,                                    #optional
+    skip=5,                                     #optional
+    parentId="scope_s18seqpnltf35niydg77xgyp"   #optional
+)
+```
+
 #### `unique_sdk.Folder.create_paths`
 
 Create each folder in the provided list of paths if it does not already exist.

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

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

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

@@ -73,8 +73,8 @@ class Content(APIResource["Content"]):
         """
 
         metadataFilter: dict
-        skip: int | None
-        take: int | None
+        skip: NotRequired[int]
+        take: NotRequired[int]
 
     class CustomApiOptions(TypedDict):
         apiIdentifier: str
@@ -145,7 +145,7 @@ class Content(APIResource["Content"]):
         expiredAt: str | None
 
     class PaginatedContentInfo(TypedDict):
-        contentInfo: List["Content.ContentInfo"]
+        contentInfos: List["Content.ContentInfo"]
         totalCount: int
 
     id: str
@@ -230,7 +230,7 @@ class Content(APIResource["Content"]):
             Content.PaginatedContentInfo,
             cls._static_request(
                 "post",
-                "/content/info",
+                "/content/infos",
                 user_id,
                 company_id,
                 params=params,
@@ -248,7 +248,43 @@ class Content(APIResource["Content"]):
             Content.PaginatedContentInfo,
             await cls._static_request_async(
                 "post",
-                "/content/info",
+                "/content/infos",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    def get_infos(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Content.ContentInfoParams"],
+    ) -> "Content.PaginatedContentInfo":
+        return cast(
+            Content.PaginatedContentInfo,
+            cls._static_request(
+                "post",
+                "/content/infos",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    async def get_infos_async(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Content.ContentInfoParams"],
+    ) -> "Content.PaginatedContentInfo":
+        return cast(
+            Content.PaginatedContentInfo,
+            await cls._static_request_async(
+                "post",
+                "/content/infos",
                 user_id,
                 company_id,
                 params=params,

{unique_sdk-0.10.3 → unique_sdk-0.10.5}/unique_sdk/api_resources/_folder.py

@@ -1,5 +1,14 @@
 from enum import Enum
-from typing import ClassVar, List, Literal, Optional, TypedDict, Unpack, cast
+from typing import (
+    ClassVar,
+    List,
+    Literal,
+    NotRequired,
+    Optional,
+    TypedDict,
+    Unpack,
+    cast,
+)
 
 from unique_sdk._api_resource import APIResource
 from unique_sdk._request_options import RequestOptions
@@ -128,12 +137,21 @@ class Folder(APIResource["Folder"]):
 
     class GetParams(RequestOptions):
         """
-        Parameters for getting a folder by its ID or path.
+        Parameters for getting a folder by its Id or path.
         """
 
         scopeId: str | None = None
         folderPath: str | None = None
 
+    class GetInfosParams(RequestOptions):
+        """
+        Parameters for getting multiple paginated folders by their parent Id.
+        """
+
+        parentId: NotRequired[str]
+        take: NotRequired[int]
+        skip: NotRequired[int]
+
     @classmethod
     def get_info(
         cls, user_id: str, company_id: str, **params: Unpack["Folder.GetParams"]
@@ -170,6 +188,42 @@ class Folder(APIResource["Folder"]):
             ),
         )
 
+    @classmethod
+    def get_infos(
+        cls, user_id: str, company_id: str, **params: Unpack["Folder.GetInfosParams"]
+    ) -> "List[Folder.FolderInfo]":
+        """
+        Get paginated folders based on parentId. If the parentId is not defined, the root folders will be returned.
+        """
+        return cast(
+            "List[Folder.FolderInfo]",
+            cls._static_request(
+                "get",
+                "/folder/infos",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    async def get_infos_async(
+        cls, user_id: str, company_id: str, **params: Unpack["Folder.GetInfosParams"]
+    ) -> "List[Folder.FolderInfo]":
+        """
+        Async get paginated folders based on parentId. If the parentId is not defined, the root folders will be returned.
+        """
+        return cast(
+            "List[Folder.FolderInfo]",
+            await cls._static_request_async(
+                "get",
+                "/folder/infos",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )
+
     @classmethod
     def create_paths(
         cls, user_id: str, company_id: str, **params: Unpack["Folder.CreateParams"]

{unique_sdk-0.10.3 → unique_sdk-0.10.5}/unique_sdk/api_resources/_integrated.py

@@ -52,6 +52,47 @@ class Integrated(APIResource["Integrated"]):
         startText: NotRequired["str"]
         debugInfo: NotRequired[Dict[str, Any]]
 
+    # For further details about the responses parameters, see the OpenAI API documentation.
+    class CreateStreamResponseParams(TypedDict):
+        debugInfo: Optional[Dict[str, Any]] = None
+        input: Any
+        model: str
+        searchContext: Optional[List["Integrated.SearchResult"]] = None
+        chatId: str
+        assistantMessageId: str
+        userMessageId: str
+        startText: str | None = None
+        include: Optional[
+            list[
+                Literal[
+                    "computer_call_output.output.image_url",
+                    "file_search_call.results",
+                    "message.input_image.image_url",
+                    "reasoning.encrypted_content",
+                ]
+            ]
+        ] = None
+        instructions: str | None = None
+        max_output_tokens: int | None = None
+        metadata: Optional[Dict[str, str]] = None
+        parallel_tool_calls: float | None = None
+        temperature: float | None = None
+        text: Any
+        tool_choice: Any
+        tools: Any
+        top_p: float | None = None
+        reasoning: Any
+
+    class ToolCall(TypedDict):
+        id: str
+        name: str | None = None
+        arguments: str | None = None
+
+    class ResponsesStreamResult(TypedDict):
+        id: str
+        message: Message
+        toolCalls: List["Integrated.ToolCall"]
+
     @classmethod
     def chat_stream_completion(
         cls,
@@ -99,3 +140,49 @@ class Integrated(APIResource["Integrated"]):
                 params,
             ),
         )
+
+    @classmethod
+    def responses_stream(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Integrated.CreateStreamResponseParams"],
+    ) -> "Integrated.ResponsesStreamResult":
+        """
+        Executes a call to the language model and streams to the chat in real-time.
+        It automatically inserts references that are mentioned by the model.
+        In the form of [sourceX]. The reference documents must be given as a list in searchContext.
+        """
+        return cast(
+            "Integrated.Responses",
+            cls._static_request(
+                "post",
+                "/integrated/chat/stream-responses",
+                user_id,
+                company_id,
+                params,
+            ),
+        )
+
+    @classmethod
+    async def responses_stream_async(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Integrated.CreateStreamResponseParams"],
+    ) -> "Integrated.ResponsesStreamResult":
+        """
+        Executes a call to the language model and streams to the chat in real-time.
+        It automatically inserts references that are mentioned by the model.
+        In the form of [sourceX]. The reference documents must be given as a list in searchContext.
+        """
+        return cast(
+            "Integrated.Responses",
+            cls._static_request(
+                "post",
+                "/integrated/chat/stream-responses",
+                user_id,
+                company_id,
+                params,
+            ),
+        )