naas-abi 1.0.0__py3-none-any.whl

naas_abi/workflows/CreateClassOntologyYamlWorkflow.py

@@ -0,0 +1,208 @@
+from dataclasses import dataclass
+from enum import Enum
+from typing import Annotated, Any, Union
+
+from fastapi import APIRouter
+from langchain_core.tools import BaseTool, StructuredTool
+from naas_abi.utils.SPARQL import get_class_uri_from_individual_uri, results_to_list
+from naas_abi.workflows.ConvertOntologyGraphToYamlWorkflow import (
+    ConvertOntologyGraphToYamlWorkflow,
+    ConvertOntologyGraphToYamlWorkflowConfiguration,
+    ConvertOntologyGraphToYamlWorkflowParameters,
+)
+from naas_abi_core import logger, services
+from naas_abi_core.services.triple_store.TripleStorePorts import (
+    ITripleStoreService,
+    OntologyEvent,
+)
+from naas_abi_core.workflow import Workflow, WorkflowConfiguration
+from naas_abi_core.workflow.workflow import WorkflowParameters
+from pydantic import Field
+from rdflib import OWL, RDF, RDFS, Graph, Literal, URIRef
+
+
+@dataclass
+class CreateClassOntologyYamlWorkflowConfiguration(WorkflowConfiguration):
+    """Configuration for CreateOntologyYAML workflow.
+
+    Attributes:
+        naas_integration_config (NaasIntegrationConfiguration): Configuration for the Naas integration
+    """
+
+    triple_store: ITripleStoreService
+    convert_ontology_graph_config: ConvertOntologyGraphToYamlWorkflowConfiguration
+
+
+class CreateClassOntologyYamlWorkflowParameters(WorkflowParameters):
+    """Parameters for CreateOntologyYAML workflow execution.
+
+    Attributes:
+        ontology_name (str): The name of the ontology store to use
+        label (str): The label of the ontology
+        description (str): The description of the ontology
+        logo_url (str): The URL of the ontology logo
+        level (str): The level of the ontology (e.g., 'TOP_LEVEL', 'MID_LEVEL', 'DOMAIN', 'USE_CASE')
+        display_relations_names (bool): Whether to display relation names in the visualization
+    """
+
+    class_uri: Annotated[
+        str, Field(..., description="The URI of the class to convert to YAML")
+    ]
+
+
+class CreateClassOntologyYamlWorkflow(Workflow):
+    """Workflow for converting ontology files to YAML and pushing them to a Naas workspace."""
+
+    __configuration: CreateClassOntologyYamlWorkflowConfiguration
+
+    def __init__(self, configuration: CreateClassOntologyYamlWorkflowConfiguration):
+        self.__configuration = configuration
+        self.__convert_ontology_graph_workflow = ConvertOntologyGraphToYamlWorkflow(
+            self.__configuration.convert_ontology_graph_config
+        )
+
+    def trigger(
+        self, event: OntologyEvent, triple: tuple[Any, Any, Any]
+    ) -> Union[str, None]:
+        s, p, o = triple
+        # logger.debug(f"==> Triggering Create Class Ontology YAML Workflow: {s} {p} {o}")
+        if (
+            str(event) != str(OntologyEvent.INSERT)
+            or not str(o).startswith("http")
+            or str(o) == "http://www.w3.org/2002/07/owl#NamedIndividual"
+        ):
+            # logger.debug(f"==> Skipping class ontology YAML creation for {s} {p} {o}")
+            return None
+
+        # Get class type from URI
+        class_uri = get_class_uri_from_individual_uri(s)
+        class_uri_triggers = [
+            "https://www.commoncoreontologies.org/ont00001262",  # Person
+            "https://www.commoncoreontologies.org/ont00000443",  # Commercial Organization
+        ]
+        if class_uri in class_uri_triggers:
+            logger.debug(
+                f"==> Creating class ontology YAML for {class_uri} ({s} {p} {o})"
+            )
+            return self.graph_to_yaml(
+                CreateClassOntologyYamlWorkflowParameters(class_uri=class_uri)
+            )
+        return None
+
+    def graph_to_yaml(
+        self, parameters: CreateClassOntologyYamlWorkflowParameters
+    ) -> str:
+        # Initialize graph
+        graph = Graph()
+        graph.bind("abi", "http://ontology.naas.ai/abi/")
+
+        # Get label and description from class uri
+        query = f"""
+        PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
+        PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
+        SELECT ?label ?definition
+        WHERE {{
+            <{parameters.class_uri}> rdfs:label ?label .
+            <{parameters.class_uri}> skos:definition ?definition .
+        }}
+        """
+        results = services.triple_store_service.query(query)
+        result_list = results_to_list(results)
+        if result_list:
+            ontology_label = result_list[0]["label"]
+            ontology_description = result_list[0]["definition"]
+        else:
+            ontology_label = ""
+            ontology_description = ""
+
+        # Get triples from class uri
+        query = f"""
+        PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
+
+        SELECT DISTINCT ?subject ?predicate ?object
+        WHERE {{
+            ?subject a <{parameters.class_uri}> .
+            ?subject ?predicate ?object .
+        }}
+        ORDER BY ?subject ?predicate
+        """
+        results = services.triple_store_service.query(query)
+        list_uri = []
+        # Add triples to graph
+        for row in results:
+            subject = URIRef(row.get("subject"))
+            predicate = URIRef(row.get("predicate"))
+            obj = row.get("object")
+
+            # Add triple to graph
+            if isinstance(obj, str) and obj.startswith("http://ontology.naas.ai/abi/"):
+                obj = URIRef(obj)
+                list_uri.append(obj)
+            else:
+                obj = Literal(obj)
+            graph.add((subject, predicate, obj))
+
+        # Get all object properties label and type
+        if len(list_uri) > 0:
+            # Filter only ABI URIs
+            uri_filter = (
+                "(" + " || ".join([f"?object = <{uri}>" for uri in list_uri]) + ")"
+            )
+            query = f"""
+            PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
+
+            SELECT DISTINCT ?object ?label ?type
+            WHERE {{
+            ?object rdfs:label ?label .
+            ?object rdf:type ?type .
+            FILTER {uri_filter}
+            }}
+            ORDER BY ?object
+            """
+            results = services.triple_store_service.query(query)
+
+            # Add object properties to graph
+            for row in results:
+                graph.add(
+                    (URIRef(row.get("object")), RDF.type, URIRef(row.get("type")))
+                )
+                graph.add((URIRef(row.get("object")), RDF.type, OWL.NamedIndividual))
+                graph.add(
+                    (URIRef(row.get("object")), RDFS.label, Literal(row.get("label")))
+                )
+
+        # Convert graph to YAML & push to Naas workspace
+        ontology_id = self.__convert_ontology_graph_workflow.graph_to_yaml(
+            ConvertOntologyGraphToYamlWorkflowParameters(
+                graph=graph.serialize(format="turtle"),
+                label=ontology_label,
+                description=ontology_description,
+            )
+        )
+        return ontology_id
+
+    def as_tools(self) -> list[BaseTool]:
+        """Returns a list of LangChain tools for this workflow."""
+        return [
+            StructuredTool(
+                name="ontology_create_class_yaml",
+                description="Create an ontology class YAML and push it to Naas workspace.",
+                func=lambda **kwargs: self.graph_to_yaml(
+                    CreateClassOntologyYamlWorkflowParameters(**kwargs)
+                ),
+                args_schema=CreateClassOntologyYamlWorkflowParameters,
+            )
+        ]
+
+    def as_api(
+        self,
+        router: APIRouter,
+        route_name: str = "",
+        name: str = "",
+        description: str = "",
+        description_stream: str = "",
+        tags: list[str | Enum] | None = None,
+    ) -> None:
+        if tags is None:
+            tags = []
+        return None

naas_abi/workflows/CreateClassOntologyYamlWorkflow_test.py

@@ -0,0 +1,65 @@
+import pytest
+from naas_abi import secret, services
+from naas_abi.workflows.ConvertOntologyGraphToYamlWorkflow import (
+    ConvertOntologyGraphToYamlWorkflowConfiguration,
+)
+from naas_abi.workflows.CreateClassOntologyYamlWorkflow import (
+    CreateClassOntologyYamlWorkflow,
+    CreateClassOntologyYamlWorkflowConfiguration,
+    CreateClassOntologyYamlWorkflowParameters,
+)
+from naas_abi_marketplace.applications.naas.integrations.NaasIntegration import (
+    NaasIntegrationConfiguration,
+)
+
+
+@pytest.fixture
+def workflow() -> CreateClassOntologyYamlWorkflow:
+    return CreateClassOntologyYamlWorkflow(
+        CreateClassOntologyYamlWorkflowConfiguration(
+            services.triple_store_service,
+            ConvertOntologyGraphToYamlWorkflowConfiguration(
+                NaasIntegrationConfiguration(api_key=secret.get("NAAS_API_KEY"))
+            ),
+        )
+    )
+
+
+def test_create_class_ontology_yaml_workflow(workflow: CreateClassOntologyYamlWorkflow):
+    import time
+    from uuid import uuid4
+
+    from naas_abi import services
+    from rdflib import OWL, RDF, RDFS, Graph, Literal, Namespace, URIRef
+
+    ABI = Namespace("http://ontology.naas.ai/abi/")
+
+    graph = Graph()
+    uri = ABI[str(uuid4())]
+    graph.add(
+        (uri, RDF.type, URIRef("https://www.commoncoreontologies.org/ont00000443"))
+    )
+    graph.add((uri, RDF.type, OWL.NamedIndividual))
+    graph.add((uri, RDFS.label, Literal("Naas.ai")))
+    graph.add(
+        (
+            uri,
+            ABI.logo,
+            Literal(
+                "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQ9gXMaBLQZ39W6Pk53PRuzFjUvv_6lLRWPoQ&s"
+            ),
+        )
+    )
+    services.triple_store_service.insert(graph)
+    time.sleep(3)
+
+    # Parameters
+    class_uri = "https://www.commoncoreontologies.org/ont00001262"
+
+    # Run workflow
+    ontology_id = workflow.graph_to_yaml(
+        CreateClassOntologyYamlWorkflowParameters(class_uri=class_uri)
+    )
+    assert ontology_id is not None, ontology_id
+    assert ontology_id != "", ontology_id
+    assert isinstance(ontology_id, str), ontology_id

naas_abi/workflows/CreateIndividualOntologyYamlWorkflow.py

@@ -0,0 +1,183 @@
+from dataclasses import dataclass
+from enum import Enum
+from typing import Annotated, Any, Union
+
+from fastapi import APIRouter
+from langchain_core.tools import BaseTool, StructuredTool
+from naas_abi import ABIModule
+from naas_abi.workflows.ConvertOntologyGraphToYamlWorkflow import (
+    ConvertOntologyGraphToYamlWorkflow,
+    ConvertOntologyGraphToYamlWorkflowConfiguration,
+    ConvertOntologyGraphToYamlWorkflowParameters,
+)
+from naas_abi_core.services.triple_store.TripleStorePorts import (
+    ITripleStoreService,
+    OntologyEvent,
+)
+from naas_abi_core.utils.Graph import URI_REGEX
+from naas_abi_core.utils.SPARQL import SPARQLUtils
+from naas_abi_core.workflow import Workflow, WorkflowConfiguration
+from naas_abi_core.workflow.workflow import WorkflowParameters
+from pydantic import Field
+from rdflib import RDFS, Graph, Literal, URIRef
+
+
+@dataclass
+class CreateIndividualOntologyYamlWorkflowConfiguration(WorkflowConfiguration):
+    """Configuration for CreateOntologyYAML workflow.
+
+    Attributes:
+        naas_integration_config (NaasIntegrationConfiguration): Configuration for the Naas integration
+    """
+
+    triple_store: ITripleStoreService
+    convert_ontology_graph_config: ConvertOntologyGraphToYamlWorkflowConfiguration
+
+
+class CreateIndividualOntologyYamlWorkflowParameters(WorkflowParameters):
+    """Parameters for CreateOntologyYAML workflow execution.
+
+    Attributes:
+        ontology_name (str): The name of the ontology store to use
+        label (str): The label of the ontology
+        description (str): The description of the ontology
+        logo_url (str): The URL of the ontology logo
+        level (str): The level of the ontology (e.g., 'TOP_LEVEL', 'MID_LEVEL', 'DOMAIN', 'USE_CASE')
+        display_relations_names (bool): Whether to display relation names in the visualization
+    """
+
+    individual_uri: Annotated[
+        str,
+        Field(
+            ...,
+            description="The URI of the individual to convert to YAML",
+            pattern=URI_REGEX,
+        ),
+    ]
+    depth: Annotated[
+        int,
+        Field(
+            description="The depth of the subject graph to get. 1 means the individual and its direct properties, 2 means the individual and its direct properties and the properties of the properties, etc."
+        ),
+    ] = 2
+
+
+class CreateIndividualOntologyYamlWorkflow(Workflow):
+    """Workflow for converting ontology files to YAML and pushing them to a Naas workspace."""
+
+    __configuration: CreateIndividualOntologyYamlWorkflowConfiguration
+    __sparql_utils: SPARQLUtils
+
+    def __init__(
+        self, configuration: CreateIndividualOntologyYamlWorkflowConfiguration
+    ):
+        self.__configuration = configuration
+        self.__convert_ontology_graph_workflow = ConvertOntologyGraphToYamlWorkflow(
+            self.__configuration.convert_ontology_graph_config
+        )
+        self.__sparql_utils: SPARQLUtils = SPARQLUtils(
+            ABIModule.get_instance().engine.services.triple_store
+        )
+
+    def trigger(
+        self, event: OntologyEvent, triple: tuple[Any, Any, Any]
+    ) -> Union[str, None]:
+        s, p, o = triple
+        if (
+            str(event) != str(OntologyEvent.INSERT)
+            or not str(s).startswith("http://ontology.naas.ai/abi/")
+            or not str(o).startswith("http://ontology.naas.ai/abi/")
+        ):
+            return None
+
+        # Get class type from URI
+        class_uri = self.__sparql_utils.get_class_uri_from_individual_uri(s)
+        class_uri_triggers = [
+            "https://www.commoncoreontologies.org/ont00001262",  # Person
+            "https://www.commoncoreontologies.org/ont00000443",  # Commercial Organization
+        ]
+        if class_uri in class_uri_triggers:
+            return self.graph_to_yaml(
+                CreateIndividualOntologyYamlWorkflowParameters(
+                    individual_uri=s, depth=2
+                )
+            )
+        return None
+
+    def graph_to_yaml(
+        self, parameters: CreateIndividualOntologyYamlWorkflowParameters
+    ) -> Union[str, None]:
+        # Create individual graph
+        graph = self.__sparql_utils.get_subject_graph(
+            parameters.individual_uri, parameters.depth
+        )
+
+        # Get label from individual URI
+        ontology_id = None
+        ontology_label = ""
+        ontology_description = ""
+        ontology_logo_url = ""
+        new_ontology = True
+        for s, p, o in graph:
+            if s == URIRef(parameters.individual_uri) and p == RDFS.label:
+                ontology_label = str(o)
+                ontology_description = f"{ontology_label} Ontology"
+            if (
+                s == URIRef(parameters.individual_uri)
+                and str(p) == "http://ontology.naas.ai/abi/logo"
+            ):
+                ontology_logo_url = str(o)
+            if (
+                s == URIRef(parameters.individual_uri)
+                and str(p) == "http://ontology.naas.ai/abi/naas_ontology_id"
+            ):
+                ontology_id = str(o)
+                new_ontology = False
+
+        # Convert graph to YAML & push to Naas workspace
+        ontology_id = self.__convert_ontology_graph_workflow.graph_to_yaml(
+            ConvertOntologyGraphToYamlWorkflowParameters(
+                graph=graph.serialize(format="turtle"),
+                ontology_id=ontology_id,
+                label=ontology_label,
+                description=ontology_description,
+                logo_url=ontology_logo_url,
+            )
+        )
+        if new_ontology:
+            graph_insert = Graph()
+            graph_insert.add(
+                (
+                    URIRef(parameters.individual_uri),
+                    URIRef("http://ontology.naas.ai/abi/naas_ontology_id"),
+                    Literal(ontology_id),
+                )
+            )
+            self.__configuration.triple_store.insert(graph_insert)
+        return ontology_id
+
+    def as_tools(self) -> list[BaseTool]:
+        """Returns a list of LangChain tools for this workflow."""
+        return [
+            StructuredTool(
+                name="create_individual_ontology_yaml",
+                description="Create or Update a YAML ontology from an individual/instance in triple store and push it to Naas workspace.",
+                func=lambda **kwargs: self.graph_to_yaml(
+                    CreateIndividualOntologyYamlWorkflowParameters(**kwargs)
+                ),
+                args_schema=CreateIndividualOntologyYamlWorkflowParameters,
+            )
+        ]
+
+    def as_api(
+        self,
+        router: APIRouter,
+        route_name: str = "",
+        name: str = "",
+        description: str = "",
+        description_stream: str = "",
+        tags: list[str | Enum] | None = None,
+    ) -> None:
+        if tags is None:
+            tags = []
+        return None

naas_abi/workflows/CreateIndividualOntologyYamlWorkflow_test.py

@@ -0,0 +1,86 @@
+import pytest
+from naas_abi import secret, services
+from naas_abi.workflows.ConvertOntologyGraphToYamlWorkflow import (
+    ConvertOntologyGraphToYamlWorkflowConfiguration,
+)
+from naas_abi.workflows.CreateIndividualOntologyYamlWorkflow import (
+    CreateIndividualOntologyYamlWorkflow,
+    CreateIndividualOntologyYamlWorkflowConfiguration,
+    CreateIndividualOntologyYamlWorkflowParameters,
+)
+from naas_abi_marketplace.applications.naas.integrations.NaasIntegration import (
+    NaasIntegration,
+    NaasIntegrationConfiguration,
+)
+
+
+@pytest.fixture
+def workflow() -> CreateIndividualOntologyYamlWorkflow:
+    return CreateIndividualOntologyYamlWorkflow(
+        CreateIndividualOntologyYamlWorkflowConfiguration(
+            services.triple_store_service,
+            ConvertOntologyGraphToYamlWorkflowConfiguration(
+                NaasIntegrationConfiguration(api_key=secret.get("NAAS_API_KEY"))
+            ),
+        )
+    )
+
+
+def test_create_individual_ontology_yaml_workflow(
+    workflow: CreateIndividualOntologyYamlWorkflow,
+):
+    import time
+    from uuid import uuid4
+
+    from naas_abi import config, logger, services
+    from naas_abi.utils.SPARQL import get_subject_graph
+    from rdflib import OWL, RDF, RDFS, Graph, Literal, Namespace, URIRef
+
+    ABI = Namespace("http://ontology.naas.ai/abi/")
+
+    graph = Graph()
+    uri = ABI[str(uuid4())]
+    graph.add(
+        (uri, RDF.type, URIRef("https://www.commoncoreontologies.org/ont00000443"))
+    )
+    graph.add((uri, RDF.type, OWL.NamedIndividual))
+    graph.add((uri, RDFS.label, Literal("Naas.ai")))
+    graph.add(
+        (
+            uri,
+            ABI.logo,
+            Literal(
+                "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQ9gXMaBLQZ39W6Pk53PRuzFjUvv_6lLRWPoQ&s"
+            ),
+        )
+    )
+    services.triple_store_service.insert(graph)
+    time.sleep(3)
+
+    # Run workflow
+    ontology_id = workflow.graph_to_yaml(
+        CreateIndividualOntologyYamlWorkflowParameters(individual_uri=str(uri), depth=1)
+    )
+
+    # Check if ontology id is set
+    graph = get_subject_graph(str(uri), 1)
+    naas_ontology_id = list(
+        graph.triples(
+            (None, URIRef("http://ontology.naas.ai/abi/naas_ontology_id"), None)
+        )
+    )[0][2]
+    assert str(ontology_id) == str(naas_ontology_id), ontology_id
+
+    # Remove graph
+    services.triple_store_service.remove(graph)
+
+    # Remove ontology
+    if ontology_id:
+        naas_integration = NaasIntegration(
+            NaasIntegrationConfiguration(api_key=secret.get("NAAS_API_KEY"))
+        )
+        result = naas_integration.delete_ontology(
+            workspace_id=config.workspace_id, ontology_id=ontology_id
+        )
+        logger.info(f"Removed ontology: {result}")
+        assert result is not None, result