nucliadb-models 6.3.1.post3584__py3-none-any.whl → 6.3.1.post3590__py3-none-any.whl

nucliadb_models/graph/__init__.py

@@ -0,0 +1,24 @@
+# Copyright (C) 2021 Bosutech XXI S.L.
+#
+# nucliadb is offered under the AGPL v3.0 and as commercial software.
+# For commercial licensing, contact us at info@nuclia.com.
+#
+# AGPL:
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+from . import (  # noqa: F401
+    requests,
+    responses,
+)

nucliadb_models/graph/requests.py

@@ -0,0 +1,160 @@
+# Copyright (C) 2021 Bosutech XXI S.L.
+#
+# nucliadb is offered under the AGPL v3.0 and as commercial software.
+# For commercial licensing, contact us at info@nuclia.com.
+#
+# AGPL:
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+from enum import Enum
+from typing import Annotated, Literal, Optional, Union
+
+from pydantic import BaseModel, Discriminator, Field, Tag, model_validator
+from typing_extensions import Self
+
+from nucliadb_models.filters import And, Not, Or, filter_discriminator
+from nucliadb_models.metadata import RelationNodeType
+
+## Models for graph nodes and relations
+
+
+class NodeMatchKind(str, Enum):
+    EXACT = "exact"
+    FUZZY = "fuzzy"
+
+
+class GraphNode(BaseModel):
+    value: Optional[str] = None
+    match: NodeMatchKind = NodeMatchKind.EXACT
+    type: Optional[RelationNodeType] = RelationNodeType.ENTITY
+    group: Optional[str] = None
+
+    @model_validator(mode="after")
+    def validate_fuzzy_usage(self) -> Self:
+        if self.match == NodeMatchKind.FUZZY:
+            if self.value is None:
+                raise ValueError("Fuzzy match can only be used if a node value is provided")
+            else:
+                if len(self.value) < 3:
+                    raise ValueError(
+                        "Fuzzy match must be used with values containing at least 3 characters"
+                    )
+        return self
+
+
+class GraphRelation(BaseModel):
+    label: Optional[str] = None
+
+
+## Models for query expressions
+
+
+class AnyNode(GraphNode):
+    prop: Literal["node"]
+
+
+class SourceNode(GraphNode):
+    prop: Literal["source_node"]
+
+
+class DestinationNode(GraphNode):
+    prop: Literal["destination_node"]
+
+
+class Relation(GraphRelation):
+    prop: Literal["relation"]
+
+
+class GraphPath(BaseModel, extra="forbid"):
+    prop: Literal["path"] = "path"
+    source: Optional[GraphNode] = None
+    relation: Optional[GraphRelation] = None
+    destination: Optional[GraphNode] = None
+    undirected: bool = False
+
+
+## Requests models
+
+
+class BaseGraphSearchRequest(BaseModel):
+    top_k: int = Field(default=50, title="Number of results to retrieve")
+
+
+graph_query_discriminator = filter_discriminator
+
+
+# Paths search
+
+GraphPathQuery = Annotated[
+    Union[
+        # bool expressions
+        Annotated[And["GraphPathQuery"], Tag("and")],
+        Annotated[Or["GraphPathQuery"], Tag("or")],
+        Annotated[Not["GraphPathQuery"], Tag("not")],
+        # paths
+        Annotated[GraphPath, Tag("path")],
+        # nodes
+        Annotated[SourceNode, Tag("source_node")],
+        Annotated[DestinationNode, Tag("destination_node")],
+        Annotated[AnyNode, Tag("node")],
+        # relations
+        Annotated[Relation, Tag("relation")],
+    ],
+    Discriminator(graph_query_discriminator),
+]
+
+
+class GraphSearchRequest(BaseGraphSearchRequest):
+    query: GraphPathQuery
+
+
+# Nodes search
+
+GraphNodesQuery = Annotated[
+    Union[
+        Annotated[And["GraphNodesQuery"], Tag("and")],
+        Annotated[Or["GraphNodesQuery"], Tag("or")],
+        Annotated[Not["GraphNodesQuery"], Tag("not")],
+        Annotated[SourceNode, Tag("source_node")],
+        Annotated[DestinationNode, Tag("destination_node")],
+        Annotated[AnyNode, Tag("node")],
+    ],
+    Discriminator(graph_query_discriminator),
+]
+
+
+class GraphNodesSearchRequest(BaseGraphSearchRequest):
+    query: GraphNodesQuery
+
+
+# Relations search
+
+GraphRelationsQuery = Annotated[
+    Union[
+        Annotated[Or["GraphRelationsQuery"], Tag("or")],
+        Annotated[Not["GraphRelationsQuery"], Tag("not")],
+        Annotated[Relation, Tag("relation")],
+    ],
+    Discriminator(graph_query_discriminator),
+]
+
+
+class GraphRelationsSearchRequest(BaseGraphSearchRequest):
+    query: GraphRelationsQuery
+
+
+# We need this to avoid issues with pydantic and generic types defined in another module
+GraphSearchRequest.model_rebuild()
+GraphNodesSearchRequest.model_rebuild()
+GraphRelationsSearchRequest.model_rebuild()

nucliadb_models/graph/responses.py

@@ -0,0 +1,62 @@
+# Copyright (C) 2021 Bosutech XXI S.L.
+#
+# nucliadb is offered under the AGPL v3.0 and as commercial software.
+# For commercial licensing, contact us at info@nuclia.com.
+#
+# AGPL:
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+from enum import Enum
+
+from pydantic import BaseModel
+
+from nucliadb_models.metadata import RelationNodeType
+
+
+class GraphNode(BaseModel):
+    value: str
+    type: RelationNodeType
+    group: str
+
+
+class GraphNodePosition(str, Enum):
+    ANY = "any"
+    SOURCE = "source"
+    DESTINATION = "destination"
+
+
+class PositionedGraphNode(GraphNode):
+    position: GraphNodePosition = GraphNodePosition.ANY
+
+
+class GraphRelation(BaseModel):
+    label: str
+
+
+class GraphPath(BaseModel):
+    source: GraphNode
+    relation: GraphRelation
+    destination: GraphNode
+
+
+class GraphSearchResponse(BaseModel):
+    paths: list[GraphPath]
+
+
+class GraphNodesSearchResponse(BaseModel):
+    nodes: list[GraphNode]
+
+
+class GraphRelationsSearchResponse(BaseModel):
+    relations: list[GraphRelation]

{nucliadb_models-6.3.1.post3584.dist-info → nucliadb_models-6.3.1.post3590.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: nucliadb_models
-Version: 6.3.1.post3584
+Version: 6.3.1.post3590
 Author-email: Nuclia <nucliadb@nuclia.com>
 License: AGPL
 Project-URL: Homepage, https://nuclia.com

{nucliadb_models-6.3.1.post3584.dist-info → nucliadb_models-6.3.1.post3590.dist-info}/RECORD

@@ -26,10 +26,13 @@ nucliadb_models/vectors.py,sha256=hDrvUag4WpmQkM8rN5v868IlKSNpVc9OEddJxaxuYws,74
 nucliadb_models/vectorsets.py,sha256=avxwO9JPX2k5sCniuNhh2MSsP7aRNvf1eB1-h3-Ju1o,1040
 nucliadb_models/writer.py,sha256=OLtCGmicpVf56pXi2_myTAvStpnaBKKOVNtZzHkKKtw,8472
 nucliadb_models/agents/ingestion.py,sha256=mV7gV6VpYg4VNpc59K3275TMUJZbUzeUnp3SZzO5uxY,3137
+nucliadb_models/graph/__init__.py,sha256=eu_1UK7GlBQRg5IRUqJkxVMcBxkXeqX4SZL6fuvwjDg,897
+nucliadb_models/graph/requests.py,sha256=fQUoF89Y8IKFkDVQB0Lhxnv7bw0YSDec0NZ9-6-y-5Q,4507
+nucliadb_models/graph/responses.py,sha256=UXDwFY4va6p6T3kgNJSA4iZ7PrLBR5ibyXw_moQixj0,1614
 nucliadb_models/internal/__init__.py,sha256=cp15ZcFnHvpcu_5-aK2A4uUyvuZVV_MJn4bIXMa20ks,835
 nucliadb_models/internal/predict.py,sha256=5rgUPrH_98gerySOZ-TR2PX_qzCGF1_8VxyOu3bGhis,2281
 nucliadb_models/internal/shards.py,sha256=uZLsMkYWrJDHq3xy_w7snSeV2X3aDBuht9GC_MG3sKc,1976
-nucliadb_models-6.3.1.post3584.dist-info/METADATA,sha256=nxf1IcoRQGHcuNxU6anr7m-WqIB5YtbYl5O0JFgozYY,759
-nucliadb_models-6.3.1.post3584.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-nucliadb_models-6.3.1.post3584.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
-nucliadb_models-6.3.1.post3584.dist-info/RECORD,,
+nucliadb_models-6.3.1.post3590.dist-info/METADATA,sha256=M88eVauScltV6u9fQOQbYB_A1X_6k-c9LwT1ymU0yJA,759
+nucliadb_models-6.3.1.post3590.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
+nucliadb_models-6.3.1.post3590.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
+nucliadb_models-6.3.1.post3590.dist-info/RECORD,,