deepsights-api 1.2.2__tar.gz → 1.2.3__tar.gz

{deepsights_api-1.2.2 → deepsights_api-1.2.3}/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 <!--next-version-placeholder-->
 
+## v1.2.3 (25-Jan-2025)
+
+- Support item text download from content store
+
+
 ## v1.2.2 (12-Jan-2025)
 
 - Add AI generated title to model 

{deepsights_api-1.2.2 → deepsights_api-1.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deepsights-api
-Version: 1.2.2
+Version: 1.2.3
 Summary: Python library for the DeepSights APIs
 Project-URL: Documentation, https://marketlogicsoftware.github.io/deepsights-api/
 Project-URL: Repository, https://github.com/marketlogicsoftware/deepsights-api

{deepsights_api-1.2.2 → deepsights_api-1.2.3}/deepsights/api/api.py

@@ -16,18 +16,19 @@
 This module contains base API client classes.
 """
 
-import os
 import logging
+import os
 from typing import Dict
+
+from ratelimit import limits, sleep_and_retry
+from requests import Session
+from requests.exceptions import Timeout
 from tenacity import (
     retry,
+    retry_if_exception_type,
     stop_after_attempt,
     wait_random_exponential,
-    retry_if_exception_type,
 )
-from requests import Session
-from requests.exceptions import Timeout
-from ratelimit import limits, sleep_and_retry
 
 
 #################################################
@@ -107,6 +108,50 @@ class API:
 
         return response.json()
 
+    #######################################
+    @retry(
+        stop=stop_after_attempt(3),
+        wait=wait_random_exponential(max=5),
+        retry=retry_if_exception_type(Timeout),
+    )
+    @sleep_and_retry
+    @limits(calls=1000, period=60)
+    def get_content(
+        self, path: str, params: Dict = None, timeout=15, expected_statuscodes=[]
+    ) -> bytes:
+        """
+        Sends a GET request to the specified path and returns the raw response content.
+
+        This method is similar to get() but returns the raw response content instead of parsing it as JSON.
+        Useful for downloading binary data like files or images.
+
+        Args:
+            path (str): The path to send the GET request to.
+            params (Dict, optional): Optional parameters to include in the request. Defaults to None.
+            timeout (int, optional): The timeout in seconds for the request. Defaults to 15.
+            expected_statuscodes (List[int], optional): List of expected status codes. Defaults to an empty list.
+
+        Returns:
+            bytes: The raw content of the server's response.
+
+        Raises:
+            HTTPError: If the GET request fails with a non-200 status code and not in the expected_statuscodes list.
+        """
+        response = self._session.get(
+            self._endpoint(path), params=params, timeout=timeout
+        )
+
+        if (
+            response.status_code != 200
+            and not response.status_code in expected_statuscodes
+        ):
+            logging.error(
+                "GET %s failed with status code %s", path, response.status_code
+            )
+            response.raise_for_status()
+
+        return response.content.decode("utf-8")
+
     #######################################
     @retry(
         stop=stop_after_attempt(3),
@@ -208,9 +253,9 @@ class APIKeyAPI(API):
         super().__init__(endpoint_base)
 
         # set api key
-        assert (
-            api_key or api_key_env_var
-        ), "Must provide either API key or environment variable"
+        assert api_key or api_key_env_var, (
+            "Must provide either API key or environment variable"
+        )
         if not api_key:
             api_key = os.environ.get(api_key_env_var)
         self._api_key = api_key

deepsights_api-1.2.3/deepsights/contentstore/resources/_download.py

@@ -0,0 +1,51 @@
+# Copyright 2024 Market Logic Software AG. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+This module contains the base functions to download content from the ContentStore.
+"""
+
+import os
+import tempfile
+import urllib.request
+
+from deepsights.api import APIResource
+
+
+#################################################
+def contentstore_download(resource: APIResource, item_id: str) -> str:
+    """
+    Downloads and returns the extracted text content of an item from the ContentStore.
+
+    This function retrieves a signed download link for the specified item's extracted text content
+    from the ContentStore API, downloads the content to a temporary file, reads the text content,
+    and returns it as a string. The temporary file is automatically cleaned up after use.
+
+    Args:
+        resource (APIResource): An instance of the DeepSights API resource used to make API calls
+            to the ContentStore service.
+        item_id (str): The unique identifier of the item whose content should be downloaded.
+
+    Raises:
+        ValueError: If the download fails for any reason, such as network errors, invalid item ID,
+            or issues reading the downloaded content.
+
+    Returns:
+        str: The extracted text content of the downloaded item as a string.
+    """
+    return str(
+        resource.api.get_content(
+            f"/item-service/items/{item_id}/_download-content-extracted-text",
+        )
+    )

{deepsights_api-1.2.2 → deepsights_api-1.2.3}/deepsights/contentstore/resources/news.py

@@ -16,19 +16,19 @@
 This module defines the resource to retrieve news content from the DeepSights API.
 """
 
-from typing import List
 from datetime import datetime
+from typing import List
 
 from deepsights.api import APIResource
+from deepsights.contentstore.resources._download import contentstore_download
 from deepsights.contentstore.resources._model import ContentStoreSearchResult
 from deepsights.contentstore.resources._search import (
+    contentstore_hybrid_search,
     contentstore_text_search,
     contentstore_vector_search,
-    contentstore_hybrid_search,
 )
 
 
-
 #################################################
 class NewsSearchResult(ContentStoreSearchResult):
     """
@@ -42,6 +42,12 @@ class NewsResource(APIResource):
     Represents a resource for retrieving news articles from the DeepSights content store.
     """
 
+    def download(self, item_id: str) -> str:
+        """
+        Download the extracted text content of an item from the ContentStore.
+        """
+        return contentstore_download(self, item_id)
+
     #################################################
     def vector_search(
         self,

{deepsights_api-1.2.2 → deepsights_api-1.2.3}/deepsights/contentstore/resources/secondary.py

@@ -16,15 +16,16 @@
 This module contains the resource to retrieve secondary reports from the DeepSights content store.
 """
 
-from typing import List
 from datetime import datetime
+from typing import List
 
 from deepsights.api import APIResource
+from deepsights.contentstore.resources._download import contentstore_download
 from deepsights.contentstore.resources._model import ContentStoreSearchResult
 from deepsights.contentstore.resources._search import (
+    contentstore_hybrid_search,
     contentstore_text_search,
     contentstore_vector_search,
-    contentstore_hybrid_search,
 )
 
 
@@ -41,6 +42,12 @@ class SecondaryResource(APIResource):
     Represents a resource for retrieving secondary reports from the DeepSights content store.
     """
 
+    def download(self, item_id: str) -> str:
+        """
+        Download the extracted text content of an item from the ContentStore.
+        """
+        return contentstore_download(self, item_id)
+
     #################################################
     def vector_search(
         self,

{deepsights_api-1.2.2 → deepsights_api-1.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "deepsights-api"
-version = "1.2.2"
+version = "1.2.3"
 description = "Python library for the DeepSights APIs"
 readme = "README.md"
 requires-python = ">=3.10"

{deepsights_api-1.2.2 → deepsights_api-1.2.3}/tests/contentstore/test_news_search.py

@@ -79,6 +79,17 @@ def test_news_text_empty_search():
             assert result.publication_date <= results[ix - 1].publication_date
 
 
+def test_news_download():
+    """ """
+    results = ds.contentstore.news.text_search(
+        query="",
+        max_results=1,
+    )
+
+    content = ds.contentstore.news.download(results[0].id)
+    assert len(content) > 0
+
+
 def test_news_text_search_offset():
     """
     Test the news text search function with an offset.

{deepsights_api-1.2.2 → deepsights_api-1.2.3}/tests/contentstore/test_secondary_search.py

@@ -80,6 +80,17 @@ def test_secondary_text_empty_search():
             assert result.publication_date <= results[ix - 1].publication_date
 
 
+def test_news_download():
+    """ """
+    results = ds.contentstore.secondary.text_search(
+        query="",
+        max_results=1,
+    )
+
+    content = ds.contentstore.secondary.download(results[0].id)
+    assert len(content) > 0
+
+
 def test_secondary_text_search_offset():
     """
     Test the secondary text search function with an offset.
@@ -480,7 +491,7 @@ def test_secondary_text_search_with_title_promotion():
     This test case verifies that the hybrid search function returns the expected results
     when searching for secondary articles based on a query with title promotion enabled.
     """
-    query = "consumer spending"
+    query = "shopping consumer"
 
     # first find top 10 results without title promotion and hard recency weight
     hybrid_results_no_promotion = ds.contentstore.secondary.search(