personal_knowledge_library 3.2.1__tar.gz → 3.2.2__tar.gz

{personal_knowledge_library-3.2.1 → personal_knowledge_library-3.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: personal_knowledge_library
-Version: 3.2.1
+Version: 3.2.2
 Summary: Library to access Wacom's Personal Knowledge graph.
 License: Apache-2.0
 Keywords: semantic-knowledge,knowledge-graph

{personal_knowledge_library-3.2.1 → personal_knowledge_library-3.2.2}/knowledge/__init__.py

@@ -17,7 +17,7 @@ __license__ = "Wacom"
 __maintainer__ = ["Markus Weber"]
 __email__ = "markus.weber@wacom.com"
 __status__ = "beta"
-__version__ = "3.2.1"
+__version__ = "3.2.2"
 
 import loguru
 

{personal_knowledge_library-3.2.1 → personal_knowledge_library-3.2.2}/knowledge/services/asyncio/graph.py

@@ -180,6 +180,61 @@ class AsyncWacomKnowledgeService(AsyncServiceAPIClient):
         thing: ThingObject = ThingObject.from_dict(e)
         return thing
 
+    async def entities(self, uris: List[str], locale: Optional[LocaleCode] = None, auth_key: Optional[str] = None) \
+            -> List[ThingObject]:
+        """
+        Retrieve entities information from personal knowledge, using the  URI as identifier.
+
+        **Remark:** Object properties (relations) must be requested separately.
+
+        Parameters
+        ----------
+        uris: List[str]
+            List of URIs of the entities
+        locale: LocaleCode
+            ISO-3166 Country Codes and ISO-639 Language Codes in the format <language_code>_<country>, e.g., en_US.
+        auth_key: Optional[str]
+            Use a different auth key than the one from the client
+
+        Returns
+        -------
+        things: List[ThingObject]
+            Entities with is type URI, description, an image/icon, and tags (labels).
+
+        Raises
+        ------
+        WacomServiceException
+            If the graph service returns an error code or the entity is not found in the knowledge graph
+        """
+        if auth_key is None:
+            auth_key, _ = await self.handle_token()
+        url: str = f"{self.service_base_url}{AsyncWacomKnowledgeService.ENTITY_ENDPOINT}/"
+        headers: Dict[str, str] = {
+            USER_AGENT_HEADER_FLAG: self.user_agent,
+            AUTHORIZATION_HEADER_FLAG: f"Bearer {auth_key}",
+        }
+        things: List[ThingObject] = []
+        params: Dict[str, Any] = {
+            URIS_TAG: uris
+        }
+        if locale:
+            params[LOCALE_TAG] = locale
+        async with AsyncServiceAPIClient.__async_session__() as session:
+            async with session.get(url, headers=headers, params=params, verify_ssl=self.verify_calls) as response:
+                if response.ok:
+                    entities: List[Dict[str, Any]] = await response.json()
+                    for e in entities:
+                        thing: ThingObject = ThingObject.from_dict(e)
+                        things.append(thing)
+                else:
+                    raise await handle_error(
+                        f"Retrieving of entities content failed. List of URIs: {uris}.", response,
+                        headers=headers
+                    )
+        await asyncio.sleep(0.25 if self.use_graceful_shutdown else 0.0)
+        # Create ThingObject
+        return things
+
     async def set_entity_image_local(self, entity_uri: str, path: Path, auth_key: Optional[str] = None) -> str:
         """Setting the image of the entity.
         The image is stored locally.

{personal_knowledge_library-3.2.1 → personal_knowledge_library-3.2.2}/knowledge/services/base.py

@@ -300,7 +300,8 @@ class WacomServiceAPIClient(RESTAPIClient):
             raise WacomServiceException(f"Unknown session id:= {self.__current_session_id}. Please login first.")
         return session
 
-    def request_user_token(self, tenant_api_key: str, external_id: str) -> Tuple[str, str, datetime]:
+    def request_user_token(self, tenant_api_key: str, external_id: str, timeout: int = DEFAULT_TIMEOUT) \
+            -> Tuple[str, str, datetime]:
         """
         Login as user by using the tenant key and its external user id.
 
@@ -310,6 +311,8 @@ class WacomServiceAPIClient(RESTAPIClient):
             Tenant API key
         external_id: str
             External id.
+        timeout: int (Default:= DEFAULT_TIMEOUT)
+            Timeout for the request in seconds.
 
         Returns
         -------
@@ -333,7 +336,8 @@ class WacomServiceAPIClient(RESTAPIClient):
         }
         payload: dict = {EXTERNAL_USER_ID: external_id}
         response: Response = requests.post(
-            url, headers=headers, json=payload, timeout=DEFAULT_TIMEOUT, verify=self.verify_calls
+            url, headers=headers, json=payload, timeout=timeout, verify=self.verify_calls,
+            allow_redirects=True
         )
         if response.ok:
             try:

{personal_knowledge_library-3.2.1 → personal_knowledge_library-3.2.2}/knowledge/services/graph.py

@@ -18,7 +18,6 @@ from knowledge.base.entity import (
     DATA_PROPERTIES_TAG,
     TYPE_TAG,
     LABELS_TAG,
-    IS_MAIN_TAG,
     RELATIONS_TAG,
     LOCALE_TAG,
     EntityStatus,
@@ -226,18 +225,74 @@ class WacomKnowledgeService(WacomServiceAPIClient):
             response: Response = session.get(url, headers=headers, timeout=timeout, verify=self.verify_calls)
             if response.ok:
                 e: Dict[str, Any] = response.json()
-                pref_label: List[Label] = []
-                aliases: List[Label] = []
-                # Extract labels and alias
-                for label in e[LABELS_TAG]:
-                    if label[IS_MAIN_TAG]:  # Labels
-                        pref_label.append(Label.create_from_dict(label))
-                    else:  # Alias
-                        aliases.append(Label.create_from_dict(label))
                 thing: ThingObject = ThingObject.from_dict(e)
                 return thing
             raise handle_error(f"Retrieving of entity content failed. URI:={uri}.", response)
 
+    def entities(self,
+        uris: List[str],
+        locale: Optional[LocaleCode] = None,
+        auth_key: Optional[str] = None,
+        timeout: int = DEFAULT_TIMEOUT,
+        max_retries: int = DEFAULT_MAX_RETRIES,
+        backoff_factor: float = DEFAULT_BACKOFF_FACTOR,
+    ) -> List[ThingObject]:
+        """
+        Retrieve entity information from personal knowledge, using the  URI as identifier.
+
+        **Remark:** Object properties (relations) must be requested separately.
+
+        Parameters
+        ----------
+        uris: List[str]
+            List of URIs of entities
+        locale: Optional[LocaleCode]
+            ISO-3166 Country Codes and ISO-639 Language Codes in the format <language_code>_<country>, e.g., en_US.
+        auth_key: Optional[str]
+            If the auth key is set the logged-in user (if any) will be ignored and the auth key will be used.
+        timeout: int
+            Timeout for the request (default: 60 seconds)
+        max_retries: int
+            Maximum number of retries (default: 3)
+        backoff_factor: float
+            A backoff factor to apply between attempts after the second try (most errors are resolved immediately by a
+            second try without a delay) (default: 0.1)
+
+        Returns
+        -------
+        things: List[ThingObject]
+            Entities with is type URI, description, an image/icon, and tags (labels).
+
+        Raises
+        ------
+        WacomServiceException
+            If the graph service returns an error code or the entity is not found in the knowledge graph
+        """
+        if auth_key is None:
+            auth_key, _ = self.handle_token()
+        url: str = f"{self.service_base_url}{WacomKnowledgeService.ENTITY_ENDPOINT}/"
+        headers: Dict[str, str] = {
+            USER_AGENT_HEADER_FLAG: self.user_agent,
+            AUTHORIZATION_HEADER_FLAG: f"Bearer {auth_key}",
+        }
+        params: Dict[str, Any] = {URIS_TAG: uris}
+        if locale is not None:
+            params[LOCALE_TAG] = locale
+        mount_point: str = "https://" if self.service_url.startswith("https") else "http://"
+        with requests.Session() as session:
+            retries: Retry = Retry(total=max_retries, backoff_factor=backoff_factor, status_forcelist=STATUS_FORCE_LIST)
+            session.mount(mount_point, HTTPAdapter(max_retries=retries))
+            response: Response = session.get(url, params=params, headers=headers, timeout=timeout,
+                                             verify=self.verify_calls)
+            if response.ok:
+                things: List[ThingObject] = []
+                entities: List[Dict[str, Any]] = response.json()
+                for e in entities:
+                    thing: ThingObject = ThingObject.from_dict(e)
+                    things.append(thing)
+                return things
+            raise handle_error(f"Retrieving of entity content failed. URIs:={uris}.", response)
+
     def delete_entities(
         self,
         uris: List[str],
@@ -2017,7 +2072,7 @@ class WacomKnowledgeService(WacomServiceAPIClient):
 
     def rebuild_nel_index(
         self,
-        nel_index: Literal["western", "japanese"],
+        nel_index: Literal["Western", "Japanese"],
         prune: bool = False,
         auth_key: Optional[str] = None,
         timeout: int = DEFAULT_TIMEOUT,

{personal_knowledge_library-3.2.1 → personal_knowledge_library-3.2.2}/knowledge/services/search.py

@@ -263,6 +263,7 @@ class SemanticSearchClient(WacomServiceAPIClient):
         locale: LocaleCode,
         concept_type: Optional[str] = None,
         auth_key: Optional[str] = None,
+        timeout: float = DEFAULT_TIMEOUT,
         max_retries: int = 3,
         backoff_factor: float = 0.1,
     ) -> int:
@@ -275,6 +276,8 @@ class SemanticSearchClient(WacomServiceAPIClient):
             ISO-3166 Country Codes and ISO-639 Language Codes in the format '<language_code>_<country>', e.g., en_US.
         concept_type: Optional[str] (Default:= None)
             Concept type.
+        timeout: int (Default:= DEFAULT_TIMEOUT)
+            Timeout for the request in seconds.
         max_retries: int
             Maximum number of retries
         backoff_factor: float
@@ -306,7 +309,7 @@ class SemanticSearchClient(WacomServiceAPIClient):
         with requests.Session() as session:
             retries: Retry = Retry(total=max_retries, backoff_factor=backoff_factor, status_forcelist=STATUS_FORCE_LIST)
             session.mount(mount_point, HTTPAdapter(max_retries=retries))
-            response = session.get(url, params=params, headers=headers)
+            response = session.get(url, params=params, headers=headers, timeout=timeout)
             if response.ok:
                 return response.json().get("count", 0)
             raise handle_error("Counting labels failed.", response, headers=headers, parameters={"locale": locale})

{personal_knowledge_library-3.2.1 → personal_knowledge_library-3.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "personal_knowledge_library"
-version = "3.2.1"
+version = "3.2.2"
 description = "Library to access Wacom's Personal Knowledge graph."
 authors = [{ name = "Markus Weber", email = "markus.weber@wacom.com" }]
 license = "Apache-2.0"