unique_sdk 0.9.26__py3-none-any.whl → 0.9.31__py3-none-any.whl

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/api_resources/_content.py

@@ -65,6 +65,16 @@ class Content(APIResource["Content"]):
         where: "Content.ContentWhereInput"
         chatId: NotRequired[str]
 
+    class ContentInfoParams(TypedDict):
+        """
+        Parameters for the content info endpoint.
+        This is used to retrieve information about content based on various filters.
+        """
+
+        metadataFilter: dict
+        skip: int | None
+        take: int | None
+
     class CustomApiOptions(TypedDict):
         apiIdentifier: str
         apiPayload: Optional[str]
@@ -96,6 +106,7 @@ class Content(APIResource["Content"]):
         ownerId: str
         byteSize: Optional[int]
         ingestionConfig: "Content.IngestionConfig"
+        metadata: dict[str, any] | None = None
 
     class UpsertParams(RequestOptions):
         input: "Content.Input"
@@ -112,6 +123,30 @@ class Content(APIResource["Content"]):
         endPage: Optional[int]
         order: Optional[int]
 
+    class ContentInfo(TypedDict):
+        """
+        Partial representation of the content containing only the base information.
+        This is used for the content info endpoint.
+        """
+
+        id: str
+        key: str
+        url: str | None
+        title: str | None
+        metadata: Dict[str, Any] | None
+        mimeType: str
+        byteSize: int
+        ownerId: str
+        createdAt: str
+        updatedAt: str
+        expiresAt: str | None
+        deletedAt: str | None
+        expiredAt: str | None
+
+    class PaginatedContentInfo(TypedDict):
+        contentInfo: List["Content.ContentInfo"]
+        totalCount: int
+
     id: str
     key: str
     url: Optional[str]
@@ -156,6 +191,42 @@ class Content(APIResource["Content"]):
             ),
         )
 
+    @classmethod
+    def get_info(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Content.ContentInfoParams"],
+    ) -> PaginatedContentInfo:
+        return cast(
+            Content.PaginatedContentInfo,
+            cls._static_request(
+                "post",
+                "/content/info",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    async def get_info_async(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Content.ContentInfoParams"],
+    ) -> PaginatedContentInfo:
+        return cast(
+            Content.PaginatedContentInfo,
+            await cls._static_request_async(
+                "post",
+                "/content/info",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )
+
     @classmethod
     def upsert(
         cls,

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,
+            ),
+        )

unique_sdk/utils/file_io.py

@@ -41,6 +41,7 @@ def upload_file(
     scope_or_unique_path=None,
     chat_id=None,
     ingestion_config: Optional[Content.IngestionConfig] = None,
+    metadata: dict[str, any] | None = None,
 ):
     # check that chatid or scope_or_unique_path is provided
     if not chat_id and not scope_or_unique_path:
@@ -54,7 +55,8 @@ def upload_file(
             "key": displayed_filename,
             "title": displayed_filename,
             "mimeType": mime_type,
-            "ingestionConfig": ingestion_config,  # Pass ingestionConfig here
+            "ingestionConfig": ingestion_config,
+            "metadata": metadata,
         },
         scopeId=scope_or_unique_path,
         chatId=chat_id,
@@ -83,6 +85,7 @@ def upload_file(
                 "mimeType": mime_type,
                 "byteSize": size,
                 "ingestionConfig": ingestion_config,
+                "metadata": metadata,
             },
             fileUrl=createdContent.readUrl,
             chatId=chat_id,
@@ -97,6 +100,7 @@ def upload_file(
                 "mimeType": mime_type,
                 "byteSize": size,
                 "ingestionConfig": ingestion_config,
+                "metadata": metadata,
             },
             fileUrl=createdContent.readUrl,
             scopeId=scope_or_unique_path,

{unique_sdk-0.9.26.dist-info → unique_sdk-0.9.31.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.9.26
+Version: 0.9.31
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -10,6 +10,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: requests (>=2.32.3,<3.0.0)
 Requires-Dist: typing-extensions (>=4.9.0,<5.0.0)
 Description-Content-Type: text/markdown
 
@@ -27,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)
@@ -35,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)
@@ -243,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`.
 
@@ -282,6 +286,73 @@ 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:
+
+```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 `tile` metadata.
+
+```python
+content_info_result = unique_sdk.Content.get_info(
+    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,
+)
+```
+
 #### `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.
@@ -302,6 +373,9 @@ createdContent = upload_file(
         "chunkStrategy": "default",
         "uniqueIngestionMode": "standard",
     },
+    metadata={
+        "folderIdPath": "uniquepathid://scope_id"
+    }
 )
 
 def upload_file(
@@ -312,6 +386,7 @@ def upload_file(
     mimeType,
     scope_or_unique_path,
     ingestion_config=None,
+    metadata=None,
 ):
     size = os.path.getsize(path_to_file)
     createdContent = unique_sdk.Content.upsert(
@@ -322,6 +397,7 @@ def upload_file(
             "title": displayed_filename,
             "mimeType": mimeType,
             "ingestionConfig": ingestionConfig,
+            "metadata": metadata,
         },
         scopeId=scope_or_unique_path,
     )
@@ -348,6 +424,7 @@ def upload_file(
             "mimeType": mimeType,
             "byteSize": size,
             "ingestionConfig": ingestionConfig,
+            "metadata": metadata,
         },
         scopeId=scope_or_unique_path,
         readUrl=createdContent.readUrl,
@@ -357,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`
@@ -949,6 +1112,21 @@ 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.
+
+## [0.9.27] - 2025-05-14
+- Add the possibility to specify metadata when creating or updating a Content.
+
 ## [0.9.26] - 2025-05-13
 - Add the possibility to specify ingestionConfig when creating or updating a Content.
 

{unique_sdk-0.9.26.dist-info → unique_sdk-0.9.31.dist-info}/RECORD

@@ -1,4 +1,4 @@
-unique_sdk/__init__.py,sha256=_bFNx6aDyXx_P8VO3RQISQH0PNIqpY3Zev3tsVNUeps,3177
+unique_sdk/__init__.py,sha256=-iaWPCqxhrGmXvI9LtaHOtsxMnyeXryk9hTzxHDH2V4,3238
 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
@@ -16,9 +16,10 @@ unique_sdk/_webhook.py,sha256=GYxbUibQN_W4XlNTHaMIksT9FQJk4LJmlKcxOu3jqiU,2855
 unique_sdk/api_resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 unique_sdk/api_resources/_acronyms.py,sha256=GIU1XH1flGWQYcpsFqTYwg4ioIGxVmb15tux84nmhEg,891
 unique_sdk/api_resources/_chat_completion.py,sha256=hAPPHxoljcoHeTboxoJkcXgpqA2hNBu6a6vamdxag58,2000
-unique_sdk/api_resources/_content.py,sha256=y8LU7H7GNh6R5uowRHP6u1Yq-bQZF-5tNdsz_GLRcIA,5713
+unique_sdk/api_resources/_content.py,sha256=GWCiJMjbiNQFvo8RZ9cnCnTbWMo4NiUxLx-WgTzssc4,7589
 unique_sdk/api_resources/_embedding.py,sha256=C6qak7cCUBMBINfPhgH8taCJZ9n6w1MUElqDJJ8dG10,1281
 unique_sdk/api_resources/_event.py,sha256=bpWF9vstdoAWbUzr-iiGP713ceP0zPk77GJXiImf9zg,374
+unique_sdk/api_resources/_folder.py,sha256=E-v4JAixhtYsOZXbEOTO8gyykPzPr62MraoPPy01vn8,6900
 unique_sdk/api_resources/_integrated.py,sha256=l1vS8kJiSLie61mqDO3KI2MNmYwFydmCIoJpP_tPhSI,2956
 unique_sdk/api_resources/_message.py,sha256=gEDIzg3METZU2k7m69meAuf0IWmZxnYOjbBKPRMwPYE,7688
 unique_sdk/api_resources/_message_assessment.py,sha256=SSfx6eW7zb_GKe8cFJzCqW-t-_eWEXxKP5cnIb0DhIc,2276
@@ -26,10 +27,10 @@ unique_sdk/api_resources/_search.py,sha256=pAVMXL2AdJNP5JG-7LlaU2Uw1152iUaMZ2YO7
 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/utils/chat_history.py,sha256=5UqL9hF1O9pV7skbNOlEibF5rHdYsmG3m5-YEPUowOs,3037
-unique_sdk/utils/file_io.py,sha256=28Edm3g1xvW7FWAvAmmG0K63o6XbTY2aCZkIviTQOI4,4176
+unique_sdk/utils/file_io.py,sha256=jR1sj1SxOvqmCoLfYkevgTktcTZId0ORoqYjmwVoyJw,4301
 unique_sdk/utils/sources.py,sha256=wfboE-neMKa0Wuq9QzfAEFMkNLrIrmm0v-QF33sLo6k,4952
 unique_sdk/utils/token.py,sha256=AzKuAA1AwBtnvSFxGcsHLpxXr_wWE5Mj4jYBbOz2ljA,1740
-unique_sdk-0.9.26.dist-info/LICENSE,sha256=EJCWoHgrXVBUb47PnjeV4MFIEOR71MAdCOIgv61J-4k,1065
-unique_sdk-0.9.26.dist-info/METADATA,sha256=qm0wVfwhtgQICr-3iOYgpwE0OaJSYQ39ZEXcXqGmru8,30967
-unique_sdk-0.9.26.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-unique_sdk-0.9.26.dist-info/RECORD,,
+unique_sdk-0.9.31.dist-info/LICENSE,sha256=EJCWoHgrXVBUb47PnjeV4MFIEOR71MAdCOIgv61J-4k,1065
+unique_sdk-0.9.31.dist-info/METADATA,sha256=v0jkEyJg5EwdcPDFfkyjKuAKBDEpiaMDJ6jkmrQ2j2g,35598
+unique_sdk-0.9.31.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+unique_sdk-0.9.31.dist-info/RECORD,,