unique_sdk 0.9.28__tar.gz → 0.9.31__tar.gz

{unique_sdk-0.9.28 → unique_sdk-0.9.31}/CHANGELOG.md

@@ -5,6 +5,15 @@ 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.31] - 2025-05-21
+- Add function to update folder access (add or remove).
+
+## [0.9.30] - 2025-05-21
+- Add function to update folder ingestion config.
+
+## [0.9.29] - 2025-05-20
+- Add function to create folder paths if they do not exist.
+
 ## [0.9.28] - 2025-05-20
 - Add function to search content info. This also allows filtering content info by metadata info.
 

{unique_sdk-0.9.28 → unique_sdk-0.9.31}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.9.28
+Version: 0.9.31
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -28,6 +28,7 @@ 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)
@@ -36,6 +37,7 @@ The Unique Python SDK provides access to the public API of Unique FinanceGPT. It
    - [Search String](#search-string)
    - [Short Term Memory](#short-term-memory)
    - [Message Assessment](#message-assessment)
+   - [Folder](#folder)
 6. [UniqueQL](#uniqueql)
    - [Query Structure](#uniqueql-query-structure)
    - [Metadata Filtering](#metadata-filtering)
@@ -244,6 +246,7 @@ unique_sdk.Message.modify(
 - [Chat Completion](#chat-completion)
 - [Search](#search)
 - [Search String](#search-string)
+- [Folder](#folder)
 
 Most of the API services provide an asynchronous version of the method. The async methods are suffixed with `_async`.
 
@@ -431,6 +434,92 @@ def upload_file(
 
 ```
 
+### Folder
+
+#### `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 whether to apply to the subscopes or not: `
+
+- `ingestionConfig`
+- `applyToSubScopes`
+
+Example of updating the ingestion config of a folder and its subfolders.
+
+```python
+unique_sdk.Folder.update_ingestion_config(
+    user_id=user_id,
+    company_id=company_id,
+    scope_id=scope_id,
+    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`
+
+Example of adding access to a folder and its subfolders.
+
+```python
+unique_sdk.Folder.add_access(
+    user_id=user_id,
+    company_id=company_id,
+    scope_id=scope_id,
+    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`
+
+Example of deleting the access from a folder and its subfolders.
+
+```python
+unique_sdk.Folder.remove_access(
+    user_id=user_id,
+    company_id=company_id,
+    scope_id=scope_id,
+    scopeAccesses=[
+        {
+            "entityId": "group_id",
+            "type": "WRITE",
+            "entityType": "GROUP",
+        }
+    ],
+    applyToSubScopes=True,
+)
+```
+
 ### Message
 
 #### `unique_sdk.Message.list`
@@ -1023,6 +1112,15 @@ 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.31] - 2025-05-21
+- Add function to update folder access (add or remove).
+
+## [0.9.30] - 2025-05-21
+- Add function to update folder ingestion config.
+
+## [0.9.29] - 2025-05-20
+- Add function to create folder paths if they do not exist.
+
 ## [0.9.28] - 2025-05-20
 - Add function to search content info. This also allows filtering content info by metadata info.
 

{unique_sdk-0.9.28 → unique_sdk-0.9.31}/README.md

@@ -12,6 +12,7 @@ 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)
@@ -20,6 +21,7 @@ The Unique Python SDK provides access to the public API of Unique FinanceGPT. It
    - [Search String](#search-string)
    - [Short Term Memory](#short-term-memory)
    - [Message Assessment](#message-assessment)
+   - [Folder](#folder)
 6. [UniqueQL](#uniqueql)
    - [Query Structure](#uniqueql-query-structure)
    - [Metadata Filtering](#metadata-filtering)
@@ -228,6 +230,7 @@ unique_sdk.Message.modify(
 - [Chat Completion](#chat-completion)
 - [Search](#search)
 - [Search String](#search-string)
+- [Folder](#folder)
 
 Most of the API services provide an asynchronous version of the method. The async methods are suffixed with `_async`.
 
@@ -415,6 +418,92 @@ def upload_file(
 
 ```
 
+### Folder
+
+#### `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 whether to apply to the subscopes or not: `
+
+- `ingestionConfig`
+- `applyToSubScopes`
+
+Example of updating the ingestion config of a folder and its subfolders.
+
+```python
+unique_sdk.Folder.update_ingestion_config(
+    user_id=user_id,
+    company_id=company_id,
+    scope_id=scope_id,
+    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`
+
+Example of adding access to a folder and its subfolders.
+
+```python
+unique_sdk.Folder.add_access(
+    user_id=user_id,
+    company_id=company_id,
+    scope_id=scope_id,
+    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`
+
+Example of deleting the access from a folder and its subfolders.
+
+```python
+unique_sdk.Folder.remove_access(
+    user_id=user_id,
+    company_id=company_id,
+    scope_id=scope_id,
+    scopeAccesses=[
+        {
+            "entityId": "group_id",
+            "type": "WRITE",
+            "entityType": "GROUP",
+        }
+    ],
+    applyToSubScopes=True,
+)
+```
+
 ### Message
 
 #### `unique_sdk.Message.list`

{unique_sdk-0.9.28 → unique_sdk-0.9.31}/pyproject.toml

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

{unique_sdk-0.9.28 → unique_sdk-0.9.31}/unique_sdk/__init__.py

@@ -80,6 +80,7 @@ from unique_sdk.api_resources._search_string import SearchString as SearchString
 from unique_sdk.api_resources._short_term_memory import (
     ShortTermMemory as ShortTermMemory,
 )
+from unique_sdk.api_resources._folder import Folder as Folder
 from unique_sdk.api_resources._embedding import Embeddings as Embeddings
 from unique_sdk.api_resources._acronyms import Acronyms as Acronyms
 from unique_sdk.api_resources._message_assessment import (
@@ -87,6 +88,5 @@ from unique_sdk.api_resources._message_assessment import (
 )
 
 # Unique QL
-
 from unique_sdk._unique_ql import UQLOperator as UQLOperator
 from unique_sdk._unique_ql import UQLCombinator as UQLCombinator

unique_sdk-0.9.31/unique_sdk/api_resources/_folder.py

@@ -0,0 +1,270 @@
+from enum import Enum
+from typing import ClassVar, List, Literal, Optional, TypedDict, Unpack, cast
+
+from unique_sdk._api_resource import APIResource
+from unique_sdk._request_options import RequestOptions
+
+
+class Folder(APIResource["Folder"]):
+    OBJECT_NAME: ClassVar[Literal["folder"]] = "folder"
+    RESOURCE_URL = "/folder"
+
+    class ScopeAccess(TypedDict):
+        """
+        Represents the access level of a scope.
+        """
+
+        class ScopeAccessType(Enum):
+            """
+            Enum for scope access levels.
+            """
+
+            READ = "READ"
+            WRITE = "WRITE"
+
+        class ScopeAccessEntityType(Enum):
+            """
+            Enum for scope access entity types.
+            """
+
+            USER = "USER"
+            GROUP = "GROUP"
+
+        entityId: str
+        type: ScopeAccessType
+        entityType: ScopeAccessEntityType
+        createdAt: str | None = None
+
+    class Children(TypedDict):
+        """
+        Represents the children of a folder.
+        """
+
+        id: str
+        name: str
+
+    class CustomApiOptions(TypedDict):
+        apiIdentifier: str
+        apiPayload: str | None
+        customisationType: str
+
+    class VttConfig(TypedDict):
+        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
+        uniqueIngestionMode: str
+        vttConfig: Optional["Folder.VttConfig"]
+        wordReadMode: str | None
+
+    class CreatedFolder(TypedDict):
+        id: str
+        object: str
+        name: str
+        parentId: Optional[str]
+
+    class CreateFolderStructureResponse(TypedDict):
+        createdFolders: List["Folder.CreatedFolder"]
+
+    class CreateParams(RequestOptions):
+        paths: List[str]
+
+    id: str
+    name: str
+    scopeAccess: List[ScopeAccess]
+    children: List[Children]
+
+    class UpdateIngestionConfigParams(TypedDict):
+        """
+        Parameters for updating folder ingestion config.
+        """
+
+        ingestionConfig: "Folder.IngestionConfig"
+        applyToSubScopes: bool
+
+    class AddAccessParams(TypedDict):
+        """
+        Parameters for adding access to a folder.
+        """
+
+        scopeAccesses: List["Folder.ScopeAccess"]
+        applyToSubScopes: bool
+
+    class RemoveAccessParams(TypedDict):
+        """
+        Parameters for removing access from a folder.
+        """
+
+        scopeAccesses: List["Folder.ScopeAccess"]
+        applyToSubScopes: bool
+
+    @classmethod
+    def create_paths(
+        cls, user_id: str, company_id: str, **params: Unpack["Folder.CreateParams"]
+    ) -> "Folder.CreateFolderStructureResponse":
+        return cast(
+            "Folder",
+            cls._static_request(
+                "post",
+                cls.RESOURCE_URL,
+                user_id,
+                company_id=company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    async def create_paths_async(
+        cls, user_id: str, company_id: str, **params: Unpack["Folder.CreateParams"]
+    ) -> "Folder.CreateFolderStructureResponse":
+        return cast(
+            "Folder",
+            await cls._static_request_async(
+                "post",
+                cls.RESOURCE_URL,
+                user_id,
+                company_id=company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    def update_ingestion_config(
+        cls,
+        user_id: str,
+        company_id: str,
+        scope_id: str,
+        **params: Unpack["Folder.UpdateIngestionConfigParams"],
+    ) -> "Folder":
+        """
+        Update the ingestion config of a folder.
+        """
+        return cast(
+            "Folder",
+            cls._static_request(
+                "patch",
+                f"/folder/{scope_id}/ingestion-config",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    async def update_ingestion_config_async(
+        cls,
+        user_id: str,
+        company_id: str,
+        scope_id: str,
+        **params: Unpack["Folder.UpdateIngestionConfigParams"],
+    ) -> "Folder":
+        """
+        Async update the ingestion config of a folder.
+        """
+        return cast(
+            "Folder",
+            await cls._static_request_async(
+                "patch",
+                f"/folder/{scope_id}/ingestion-config",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    def add_access(
+        cls,
+        user_id: str,
+        company_id: str,
+        scope_id: str,
+        **params: Unpack["Folder.AddAccessParams"],
+    ) -> "Folder":
+        """
+        Add access to a folder.
+        """
+        return cast(
+            "Folder",
+            cls._static_request(
+                "patch",
+                f"/folder/{scope_id}/access",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    async def add_access_async(
+        cls,
+        user_id: str,
+        company_id: str,
+        scope_id: str,
+        **params: Unpack["Folder.AddAccessParams"],
+    ) -> "Folder":
+        """
+        Async add access to a folder.
+        """
+        return cast(
+            "Folder",
+            await cls._static_request_async(
+                "patch",
+                f"/folder/{scope_id}/access",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    def remove_access(
+        cls,
+        user_id: str,
+        company_id: str,
+        scope_id: str,
+        **params: Unpack["Folder.RemoveAccessParams"],
+    ) -> dict:
+        """
+        Remove access from a folder.
+        """
+        return cast(
+            dict,
+            cls._static_request(
+                "patch",
+                f"/folder/{scope_id}/remove-access",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    async def remove_access_async(
+        cls,
+        user_id: str,
+        company_id: str,
+        scope_id: str,
+        **params: Unpack["Folder.RemoveAccessParams"],
+    ) -> "Folder":
+        """
+        Async remove access from a folder.
+        """
+        return cast(
+            "Folder",
+            await cls._static_request_async(
+                "patch",
+                f"/folder/{scope_id}/remove-access",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )