unique_sdk 0.9.26__tar.gz → 0.9.28__tar.gz

{unique_sdk-0.9.26 → unique_sdk-0.9.28}/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.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 → unique_sdk-0.9.28}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.9.26
+Version: 0.9.28
 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
 
@@ -282,6 +283,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 +370,9 @@ createdContent = upload_file(
         "chunkStrategy": "default",
         "uniqueIngestionMode": "standard",
     },
+    metadata={
+        "folderIdPath": "uniquepathid://scope_id"
+    }
 )
 
 def upload_file(
@@ -312,6 +383,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 +394,7 @@ def upload_file(
             "title": displayed_filename,
             "mimeType": mimeType,
             "ingestionConfig": ingestionConfig,
+            "metadata": metadata,
         },
         scopeId=scope_or_unique_path,
     )
@@ -348,6 +421,7 @@ def upload_file(
             "mimeType": mimeType,
             "byteSize": size,
             "ingestionConfig": ingestionConfig,
+            "metadata": metadata,
         },
         scopeId=scope_or_unique_path,
         readUrl=createdContent.readUrl,
@@ -949,6 +1023,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.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 → unique_sdk-0.9.28}/README.md

@@ -267,6 +267,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.
@@ -287,6 +354,9 @@ createdContent = upload_file(
         "chunkStrategy": "default",
         "uniqueIngestionMode": "standard",
     },
+    metadata={
+        "folderIdPath": "uniquepathid://scope_id"
+    }
 )
 
 def upload_file(
@@ -297,6 +367,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(
@@ -307,6 +378,7 @@ def upload_file(
             "title": displayed_filename,
             "mimeType": mimeType,
             "ingestionConfig": ingestionConfig,
+            "metadata": metadata,
         },
         scopeId=scope_or_unique_path,
     )
@@ -333,6 +405,7 @@ def upload_file(
             "mimeType": mimeType,
             "byteSize": size,
             "ingestionConfig": ingestionConfig,
+            "metadata": metadata,
         },
         scopeId=scope_or_unique_path,
         readUrl=createdContent.readUrl,

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "unique_sdk"
-version = "0.9.26"
+version = "0.9.28"
 description = ""
 authors = [
     "Martin Fadler <martin.fadler@unique.ch>",
@@ -16,6 +16,7 @@ classifiers = [
 [tool.poetry.dependencies]
 python = "^3.11"
 typing-extensions = "^4.9.0"
+requests = "^2.32.3"
 
 
 [tool.poetry.group.dev.dependencies]
@@ -25,6 +26,7 @@ tox = "^4.11.4"
 pyright = "^1.1.341"
 pytest-cov = "^4.1.0"
 pytest-asyncio = "^0.24.0"
+python-dotenv = "^1.1.0"
 
 [build-system]
 requires = ["poetry-core"]

{unique_sdk-0.9.26 → unique_sdk-0.9.28}/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-0.9.26 → unique_sdk-0.9.28}/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,