unique_sdk 0.9.23__py3-none-any.whl → 0.9.28__py3-none-any.whl

unique_sdk/api_resources/_content.py

@@ -65,8 +65,38 @@ class Content(APIResource["Content"]):
         where: "Content.ContentWhereInput"
         chatId: NotRequired[str]
 
-    class IngestionConfig(TypedDict):
+    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]
+        customisationType: str
+
+    class VttConfig(TypedDict, total=False):
+        languageModel: Optional[str]
+
+    class IngestionConfig(TypedDict, total=False):
+        chunkMaxTokens: Optional[int]
+        chunkMaxTokensOnePager: Optional[int]
+        chunkMinTokens: Optional[int]
+        chunkStrategy: Optional[str]
+        customApiOptions: Optional[List["Content.CustomApiOptions"]]
+        documentMinTokens: Optional[int]
+        excelReadMode: Optional[str]
+        jpgReadMode: Optional[str]
+        pdfReadMode: Optional[str]
+        pptReadMode: Optional[str]
         uniqueIngestionMode: str
+        vttConfig: Optional["Content.VttConfig"]
+        wordReadMode: Optional[str]
 
     class Input(TypedDict):
         key: str
@@ -76,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"
@@ -92,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]
@@ -136,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/_search.py

@@ -8,7 +8,7 @@ class Search(APIResource["Search"]):
     OBJECT_NAME: ClassVar[Literal["search.search"]] = "search.search"
 
     class CreateParams(RequestOptions):
-        chatId: str
+        chatId: NotRequired[Optional[str]]
         searchString: str
         searchType: Literal["VECTOR", "COMBINED"]
         language: NotRequired[Optional[str]]

unique_sdk/utils/file_io.py

@@ -1,10 +1,12 @@
 import os
 import tempfile
 from pathlib import Path
+from typing import Optional
 
 import requests
 
 import unique_sdk
+from unique_sdk.api_resources._content import Content
 
 
 # download readUrl a random directory in /tmp
@@ -38,19 +40,23 @@ def upload_file(
     mime_type,
     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:
         raise ValueError("chat_id or scope_or_unique_path must be provided")
 
     size = os.path.getsize(path_to_file)
-    createdContent = unique_sdk.Content.upsert(
+    createdContent = Content.upsert(
         user_id=userId,
         company_id=companyId,
         input={
             "key": displayed_filename,
             "title": displayed_filename,
             "mimeType": mime_type,
+            "ingestionConfig": ingestion_config,
+            "metadata": metadata,
         },
         scopeId=scope_or_unique_path,
         chatId=chat_id,
@@ -78,6 +84,8 @@ def upload_file(
                 "title": displayed_filename,
                 "mimeType": mime_type,
                 "byteSize": size,
+                "ingestionConfig": ingestion_config,
+                "metadata": metadata,
             },
             fileUrl=createdContent.readUrl,
             chatId=chat_id,
@@ -91,6 +99,8 @@ def upload_file(
                 "title": displayed_filename,
                 "mimeType": mime_type,
                 "byteSize": size,
+                "ingestionConfig": ingestion_config,
+                "metadata": metadata,
             },
             fileUrl=createdContent.readUrl,
             scopeId=scope_or_unique_path,

{unique_sdk-0.9.23.dist-info → unique_sdk-0.9.28.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.9.23
+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.
@@ -297,6 +365,14 @@ createdContent = upload_file(
     "test.pdf",
     "application/pdf",
     "scope_stcj2osgbl722m22jayidx0n",
+    ingestionConfig={
+        "chunkMaxTokens": 1000,
+        "chunkStrategy": "default",
+        "uniqueIngestionMode": "standard",
+    },
+    metadata={
+        "folderIdPath": "uniquepathid://scope_id"
+    }
 )
 
 def upload_file(
@@ -306,6 +382,8 @@ def upload_file(
     displayed_filename,
     mimeType,
     scope_or_unique_path,
+    ingestion_config=None,
+    metadata=None,
 ):
     size = os.path.getsize(path_to_file)
     createdContent = unique_sdk.Content.upsert(
@@ -315,6 +393,8 @@ def upload_file(
             "key": displayed_filename,
             "title": displayed_filename,
             "mimeType": mimeType,
+            "ingestionConfig": ingestionConfig,
+            "metadata": metadata,
         },
         scopeId=scope_or_unique_path,
     )
@@ -340,6 +420,8 @@ def upload_file(
             "title": displayed_filename,
             "mimeType": mimeType,
             "byteSize": size,
+            "ingestionConfig": ingestionConfig,
+            "metadata": metadata,
         },
         scopeId=scope_or_unique_path,
         readUrl=createdContent.readUrl,
@@ -544,6 +626,7 @@ These are the options are available for `searchType`:
 `scopeIds` Specifies a collection of scope IDs to confine the search.
 `language` Optional. The language specification for full text search.
 `reranker` Optional. The reranker service to be used for re-ranking the search results.
+`chatId` Optional, adds the documents uploaded in this chat to the scope of searched documents.
 
 ```python
 search = unique_sdk.Search.create(
@@ -715,7 +798,7 @@ A metadata filter such as the one designed above can be used in a `Search.create
 
 ### Chat History
 
-#### `unique_sdk.util.chat_history.load_history`
+#### `unique_sdk.utils.chat_history.load_history`
 
 A helper function that makes sure the chat history is fully loaded and cut to the size of the token window that it fits into the next round of chat interactions.
 
@@ -733,7 +816,7 @@ history = unique_sdk.utils.chat_history.load_history(
 )
 ```
 
-#### `unique_sdk.util.chat_history.convert_chat_history_to_injectable_string`
+#### `unique_sdk.utils.chat_history.convert_chat_history_to_injectable_string`
 
 convert history into a string that can be injected into a prompt. it als returns the token length of the converted history.
 
@@ -747,7 +830,7 @@ chat_history-string, chat_context_token_length = unique_sdk.utils.chat_history.c
 
 Interacting with the knowledge-base.
 
-#### `unique_sdk.util.file_io.download_content`
+#### `unique_sdk.utils.file_io.download_content`
 
 download files and save them into a folder in `/tmp`
 
@@ -763,7 +846,7 @@ pdfFile = download_content(
 }
 ```
 
-#### `unique_sdk.util.file_io.upload_file`
+#### `unique_sdk.utils.file_io.upload_file`
 
 Allows for uploading files that then get ingested in a scope or a chat.
 
@@ -773,15 +856,15 @@ createdContent = upload_file(
     userId=userId,
     path_to_file="/tmp/hello.pdf",
     displayed_filename="hello.pdf",
-    mimeType="application/pdf",
-    uploadScope="scope_stcj2osgbl722m22jayidx0n",
+    mime_type="application/pdf",
+    scope_or_unique_path="scope_stcj2osgbl722m22jayidx0n",
     chat_id=None,
 )
 ```
 
 ### Sources
 
-#### `unique_sdk.util.sources.merge_sources`
+#### `unique_sdk.utils.sources.merge_sources`
 
 Merges multiple search results based on their 'id', removing redundant document and info markers.
 
@@ -810,15 +893,15 @@ search = unique_sdk.Search.create(
     chatOnly=False,
 )
 
-searchContext = unique_sdk.util.token.pick_search_results_for_token_window(
+searchContext = unique_sdk.utils.token.pick_search_results_for_token_window(
         search["data"], config["maxTokens"] - historyLength
     )
 
-searchContext = unique_sdk.util.sources.merge_sources(search)
+searchContext = unique_sdk.utils.sources.merge_sources(search)
 
 ```
 
-#### `unique_sdk.util.sources.sort_sources`
+#### `unique_sdk.utils.sources.sort_sources`
 
 Sort sources by order of appearance in documents
 
@@ -835,14 +918,14 @@ search = unique_sdk.Search.create(
     chatOnly=False,
 )
 
-searchContext = unique_sdk.util.token.pick_search_results_for_token_window(
+searchContext = unique_sdk.utils.token.pick_search_results_for_token_window(
         search["data"], config["maxTokens"] - historyLength
     )
 
-searchContext = unique_sdk.util.sources.sort_sources(search)
+searchContext = unique_sdk.utils.sources.sort_sources(search)
 ```
 
-#### `unique_sdk.util.sources.post_process_sources`
+#### `unique_sdk.utils.sources.post_process_sources`
 
 Post-processes the provided text by converting source references into superscript numerals (required
 format by backend to display sources in the chat window)
@@ -869,7 +952,7 @@ text_with_sup = post_process_sources(text)
 
 ### Token
 
-#### unique_sdk.util.token.pick_search_results_for_token_window
+#### unique_sdk.utils.token.pick_search_results_for_token_window
 
 Selects and returns a list of search results that fit within a specified token limit.
 
@@ -898,12 +981,12 @@ search = unique_sdk.Search.create(
     chatOnly=False,
 )
 
-searchContext = unique_sdk.util.token.pick_search_results_for_token_window(
+searchContext = unique_sdk.utils.token.pick_search_results_for_token_window(
         search["data"], config["maxTokens"] - historyLength
     )
 ```
 
-#### unique_sdk.util.token.count_tokens
+#### unique_sdk.utils.token.count_tokens
 
 Counts the number of tokens in the provided text.
 
@@ -920,7 +1003,7 @@ Returns:
 
 ```python
 hello = "hello you!"
-searchContext = unique_sdk.util.token.count_tokens(hello)
+searchContext = unique_sdk.utils.token.count_tokens(hello)
 ```
 
 ## Error Handling
@@ -940,6 +1023,20 @@ 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.
+
+## [0.9.25] - 2025-05-02
+- Fixed typos in `README.md`, including incorrect `sdk.utils` imports and code example errors.
+
+## [0.9.24] - 2025-04-23
+- Make `chatId` property in `Search.CreateParams` optional
 
 ## [0.9.23] - 2025-03-25
 - Define programming language classifier explicitly for python 3.11

{unique_sdk-0.9.23.dist-info → unique_sdk-0.9.28.dist-info}/RECORD

@@ -16,20 +16,20 @@ 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=MrAXhgZS3v2S9OwKh3ROfv5wU8Y947A6gD3wgaYe_aM,4989
+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/_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
-unique_sdk/api_resources/_search.py,sha256=m9gL-Cv347r6cM9MwGWgddORGHzPF3jK5dzL3plaeNI,1883
+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/utils/chat_history.py,sha256=5UqL9hF1O9pV7skbNOlEibF5rHdYsmG3m5-YEPUowOs,3037
-unique_sdk/utils/file_io.py,sha256=tcS-5NA97AyiJPhKpWs3i0qKNFsZlttToxrvnWRDJrs,3857
+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.23.dist-info/LICENSE,sha256=EJCWoHgrXVBUb47PnjeV4MFIEOR71MAdCOIgv61J-4k,1065
-unique_sdk-0.9.23.dist-info/METADATA,sha256=pL_p-F4itfNfefymBvs0YJv_luucdxZkI3yLprf86Zs,30266
-unique_sdk-0.9.23.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-unique_sdk-0.9.23.dist-info/RECORD,,
+unique_sdk-0.9.28.dist-info/LICENSE,sha256=EJCWoHgrXVBUb47PnjeV4MFIEOR71MAdCOIgv61J-4k,1065
+unique_sdk-0.9.28.dist-info/METADATA,sha256=xYS1uF8nf68oCH1Q8veoEejLG5jkDtIuo5NIzy2PDS0,33458
+unique_sdk-0.9.28.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+unique_sdk-0.9.28.dist-info/RECORD,,