polly-python 4.5.0__tar.gz → 4.7.0__tar.gz

{polly_python-4.5.0/polly_python.egg-info → polly_python-4.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: polly_python
-Version: 4.5.0
+Version: 4.7.0
 Summary: Polly SDK
 Home-page: https://github.com/ElucidataInc/polly-python
 Project-URL: Documentation, https://docs.elucidata.io

polly_python-4.7.0/polly/__init__.py

@@ -0,0 +1 @@
+__version__ = "4.7.0"

{polly_python-4.5.0 → polly_python-4.7.0}/polly/atlas.py

@@ -84,6 +84,12 @@ class Column:
     ### Boolean & JSON Data Types
     - `boolean`: Stores `true`, `false` values
     - `json`: Stores structured JSON data
+
+    ### Array Data Types
+    - `bigint_array`: Stores `bigint` values as arrays. For example: `[1234567894, 9876543216]`
+    - `double_precision_array`: Stores `double precision` values as arrays. For example: `[12.34, 56.78, 90.12]`
+    - `text_array`: Stores `text` values as arrays. For example: `["sample1", "sample2", "sample3"]`
+    - `integer_array`: Stores `integer` values as arrays. For example: `[100, 200, 300]`
     """
 
     def __init__(

{polly_python-4.5.0 → polly_python-4.7.0}/polly/help.py

@@ -273,8 +273,11 @@ def get_txt(
         and (not function_name or function_name == fun.split(".")[-1])
         and should_show_fun
     ):
-        import rst2txt
-        from docutils.core import publish_string
+        try:
+            import rst2txt
+            from docutils.core import publish_string
+        except ImportError:
+            return None
 
         # converting rst to txt
         txt = publish_string(

{polly_python-4.5.0 → polly_python-4.7.0}/polly/polly_kg.py

@@ -222,17 +222,14 @@ class PollyKG:
         if not query or query == "":
             raise InvalidParameterException("query")
         query_url = f"{self.polly_kg_neo4j_endpoint}/kg/{self.kg_id}/versions/{self.version_id}/queries/"
-        is_async = True
-        if query_type == "NLQ":
-            is_async = False  # NLQ queries are always synchronous
+        if query_type != "CYPHER":
+            raise InvalidParameterException(
+                f"Invalid query_type: '{query_type}'. Only 'CYPHER' query type is supported."
+            )
         payload = {
             "data": {
                 "type": "kg_query",
-                "attributes": {
-                    "query_string": query,
-                    "query_type": query_type,
-                    "is_async": is_async,
-                },
+                "attributes": {"query_string": query, "query_type": query_type},
             }
         }
         try:
@@ -326,15 +323,17 @@ class PollyKG:
         if not query or query == "":
             raise InvalidParameterException("query")
         query_url = f"{self.polly_kg_neo4j_endpoint}/kg/{self.kg_id}/versions/{self.version_id}/queries/"
+        if query_type != "CYPHER":
+            raise InvalidParameterException(
+                f"Invalid query_type: '{query_type}'. Only 'CYPHER' query type is supported."
+            )
         is_async = True
-        if query_type == "NLQ":
-            is_async = False  # NLQ queries are always synchronous
         payload = {
             "data": {
                 "type": "kg_query",
                 "attributes": {
                     "query_string": query,
-                    "query_type": query_type,
+                    "query_type": "CYPHER",
                     "is_async": is_async,
                 },
             }
@@ -509,9 +508,10 @@ class PollyKG:
             print(e)
             raise
 
-    def get_summary(self) -> dict:
+    def get_summary(self, stats: bool = False) -> dict:
         """Retrieve a summary of the Polly Knowledge Graph.
-
+        Params:
+            stats: A boolean flag to retrieve the detailed counts edges.
         Returns:
             dict: A dictionary containing summary information about the graph,
                  such as node counts, edge counts, and other metadata.
@@ -522,9 +522,14 @@ class PollyKG:
             RequestFailureException: Raised when the request fails due to an unexpected error.
         """
         try:
-            response = self.session.get(
-                f"{self.polly_kg_neo4j_endpoint}/kg/{self.kg_id}/versions/{self.version_id}/summary"
-            )
+            if stats:
+                response = self.session.get(
+                    f"{self.polly_kg_neo4j_endpoint}/kg/{self.kg_id}/versions/{self.version_id}/summary?stats=true"
+                )
+            else:
+                response = self.session.get(
+                    f"{self.polly_kg_neo4j_endpoint}/kg/{self.kg_id}/versions/{self.version_id}/summary"
+                )
             return handle_success_and_error_response(response)
         except Exception as e:
             print(e)
@@ -564,6 +569,101 @@ class PollyKG:
             print(e)
             raise
 
+    @Track.track_decorator
+    def get_all_queries(
+        self,
+        status: str = "IN_PROGRESS",
+        page_size: int = 100,
+        next_token: str = None,
+        instance_id: str = None,
+    ) -> dict:
+        """Retrieve a list of queries for the specified KG version.
+
+        This function fetches queries based on their status, allowing you to filter
+        and paginate through query results. It supports filtering by status and
+        optionally by instance_id.
+
+        Args:
+            status (str, optional): Filter queries by status. Accepts "IN_PROGRESS",
+                "COMPLETED", "FAILED", "QUEUED", or "CANCELLED". Defaults to "IN_PROGRESS".
+            page_size (int, optional): Number of queries to return per page.
+                Maximum 100. Defaults to 100.
+            next_token (str, optional): Pagination token for retrieving the next page
+                of results. Obtained from the 'meta' section of the previous response.
+                Defaults to None.
+            instance_id (str, optional): Filter queries by specific instance ID.
+                Defaults to None.
+
+        Returns:
+            dict: A dictionary containing query data and pagination metadata:
+                - data (list): List of query objects with attributes including query_id,
+                  query_string, status, created_at, and metadata.
+                - meta (dict): Pagination metadata including next_token if more results exist.
+                If no queries are found, returns a message string.
+
+        Raises:
+            BadRequestError: If invalid parameters are provided.
+            UnauthorizedException: If authentication fails.
+            RequestFailureException: If the request fails due to an unexpected error.
+        """
+        queries_url = f"{self.polly_kg_neo4j_endpoint}/kg/{self.kg_id}/versions/{self.version_id}/queries/"
+        params = {"status": status, "page_size": page_size}
+
+        if next_token:
+            params["next_token"] = next_token
+        if instance_id:
+            params["instance_id"] = instance_id
+
+        response = self.session.get(queries_url, params=params)
+        handle_success_and_error_response(response)
+        response_json = response.json()
+        meta = response_json.get("meta", {})
+
+        if "data" in response_json:
+            count = len(response_json["data"])
+            if count == 0:
+                return f"No {status} queries found"
+            return {"data": response_json["data"], "meta": meta}
+        return {
+            "message": response_json.get("message", "No information available"),
+            "meta": meta,
+        }
+
+    @Track.track_decorator
+    def cancel_query(self, query_id: str) -> dict:
+        """Cancel a running or queued query.
+
+        This function attempts to cancel a query that is currently in "IN_PROGRESS"
+        or "QUEUED" status. Once cancelled, the query status will be updated to
+        "CANCELLED" and it will stop execution.
+
+        Args:
+            query_id (str): The unique ID of the query to cancel. Must be a non-empty string.
+
+        Returns:
+            dict: A dictionary containing the cancellation response with updated query status.
+
+        Raises:
+            InvalidParameterException: If query_id is None, empty, or not a valid string.
+            ResourceNotFoundError: If the specified query_id does not exist.
+            BadRequestError: If the query cannot be cancelled (e.g., already completed or failed).
+            UnauthorizedException: If authentication fails.
+            RequestFailureException: If the request fails due to an unexpected error.
+        """
+        if not query_id or not isinstance(query_id, str) or query_id.strip() == "":
+            raise InvalidParameterException("query_id")
+
+        queries_url = f"{self.polly_kg_neo4j_endpoint}/kg/{self.kg_id}/versions/{self.version_id}/queries/{query_id}/status"
+        payload = {"data": {"type": "kg_query", "attributes": {"status": "CANCELLED"}}}
+
+        try:
+            response = self.session.patch(queries_url, data=json.dumps(payload))
+            handle_success_and_error_response(response)
+            return response.json()
+        except Exception as e:
+            print(e)
+            raise e
+
     def _transform_schema_to_legacy_format(
         self, new_schema: dict, kg_id: str, version_id: str
     ) -> dict:
@@ -580,6 +680,7 @@ class PollyKG:
         data = new_schema.get("data", {})
         attributes = data.get("attributes", {})
         schema = attributes.get("schema", {})
+        custom_attributes = attributes.get("custom_attributes", {})
 
         # Extract basic information
         node_types = schema.get("node_types", [])
@@ -658,19 +759,24 @@ class PollyKG:
         # Build legacy format response
         from datetime import datetime
 
+        # Build metadata with standard fields
+        metadata = {
+            "name": "schema",
+            "kg_id": str(kg_id),
+            "kg_version": str(version_id),
+            "last_updated": datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%SZ"),
+            "computed_at": datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%SZ"),
+        }
+
+        data_source = custom_attributes.get("data_source")
+        if data_source is not None:
+            metadata["data_source"] = data_source
+
         legacy_format = {
             "data": {
                 "type": "kg_schema",
                 "attributes": {
-                    "metadata": {
-                        "name": "schema",
-                        "kg_id": str(kg_id),
-                        "kg_version": str(version_id),
-                        "last_updated": datetime.utcnow().strftime(
-                            "%Y-%m-%dT%H:%M:%SZ"
-                        ),
-                        "computed_at": datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%SZ"),
-                    },
+                    "metadata": metadata,
                     "node_types": node_types,
                     "edge_types": edge_types,
                     "nodes": transformed_nodes,
@@ -726,23 +832,6 @@ class PollyKG:
             ResourceNotFoundError: Raised when no knowledge graphs are found.
             AccessDeniedError: Raised when the user does not have permission to access the KGs.
             RequestFailureException: Raised when the request fails due to an unexpected error.
-
-        Example:
-            >>> kg = PollyKG()
-            >>> # Get only published KGs
-            >>> kgs = kg.get_all_kgs()
-            >>> for kg_info in kgs:
-            ...     print(f"{kg_info['kg_name']} (ID: {kg_info['kg_id']})")
-            base kg v3 (ID: 14_base_kg_v3)
-
-            >>> # Get all KGs including unpublished ones with instance details
-            >>> kgs_with_instances = kg.get_all_kgs(
-            ...     include_unpublished=True,
-            ...     include_instances=True,
-            ...     include_terminated=True
-            ... )
-            >>> for kg_info in kgs_with_instances:
-            ...     print(f"{kg_info['kg_name']} - {len(kg_info.get('instances', []))} instances")
         """
         try:
             kg_url = f"{self.polly_kg_neo4j_endpoint}/kg"

{polly_python-4.5.0 → polly_python-4.7.0/polly_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: polly_python
-Version: 4.5.0
+Version: 4.7.0
 Summary: Polly SDK
 Home-page: https://github.com/ElucidataInc/polly-python
 Project-URL: Documentation, https://docs.elucidata.io

polly_python-4.5.0/polly/__init__.py

@@ -1 +0,0 @@
-__version__ = "4.5.0"