nucliadb-models 6.3.4.post3705__py3-none-any.whl → 6.3.4.post3721__py3-none-any.whl

nucliadb_models/graph/requests.py

@@ -23,8 +23,10 @@ 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.filters import And, FieldFilterExpression, Not, Or, filter_discriminator
 from nucliadb_models.metadata import RelationNodeType, RelationType
+from nucliadb_models.search import SearchParamDefaults
+from nucliadb_models.security import RequestSecurity
 
 ## Models for graph nodes and relations
 
@@ -116,8 +118,26 @@ GraphPathQuery = Annotated[
 ]
 
 
+class GraphFilterExpression(BaseModel, extra="forbid"):
+    """Returns only relations from documents that match this filter expression.
+    Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search_filters
+    """
+
+    field: FieldFilterExpression = Field(description="Filter to apply to fields")
+
+
 class GraphSearchRequest(BaseGraphSearchRequest):
     query: GraphPathQuery
+    filter_expression: Optional[GraphFilterExpression] = Field(
+        default=None,
+        title="Filter resource by an expression",
+        description=(
+            "Returns only relations from documents that match this filter expression."
+            "Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search_filters "
+        ),
+    )
+    security: Optional[RequestSecurity] = SearchParamDefaults.security.to_pydantic_field()
+    show_hidden: bool = SearchParamDefaults.show_hidden.to_pydantic_field()
 
 
 # Nodes search
@@ -135,6 +155,16 @@ GraphNodesQuery = Annotated[
 
 class GraphNodesSearchRequest(BaseGraphSearchRequest):
     query: GraphNodesQuery
+    filter_expression: Optional[GraphFilterExpression] = Field(
+        default=None,
+        title="Filter resource by an expression",
+        description=(
+            "Returns only relations from documents that match this filter expression."
+            "Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search_filters "
+        ),
+    )
+    security: Optional[RequestSecurity] = SearchParamDefaults.security.to_pydantic_field()
+    show_hidden: bool = SearchParamDefaults.show_hidden.to_pydantic_field()
 
 
 # Relations search
@@ -152,6 +182,16 @@ GraphRelationsQuery = Annotated[
 
 class GraphRelationsSearchRequest(BaseGraphSearchRequest):
     query: GraphRelationsQuery
+    filter_expression: Optional[GraphFilterExpression] = Field(
+        default=None,
+        title="Filter resource by an expression",
+        description=(
+            "Returns only relations from documents that match this filter expression."
+            "Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search_filters "
+        ),
+    )
+    security: Optional[RequestSecurity] = SearchParamDefaults.security.to_pydantic_field()
+    show_hidden: bool = SearchParamDefaults.show_hidden.to_pydantic_field()
 
 
 # We need this to avoid issues with pydantic and generic types defined in another module

{nucliadb_models-6.3.4.post3705.dist-info → nucliadb_models-6.3.4.post3721.dist-info}/METADATA

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

{nucliadb_models-6.3.4.post3705.dist-info → nucliadb_models-6.3.4.post3721.dist-info}/RECORD

@@ -27,12 +27,12 @@ nucliadb_models/vectorsets.py,sha256=avxwO9JPX2k5sCniuNhh2MSsP7aRNvf1eB1-h3-Ju1o
 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=XniFIyCRrRgEvrPUUu-Tk2m1TiQ3t8m9xdRe1APGCUE,4540
+nucliadb_models/graph/requests.py,sha256=4fJgX7vti3aY6iMKC4EFMEg9MSUnh-sWeiMZPTqHQyI,6616
 nucliadb_models/graph/responses.py,sha256=3aimAHrd3YW1BXHU_ZXRoidlccRtkCcREkfCNotqgIQ,1651
 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.4.post3705.dist-info/METADATA,sha256=MbH2RQOGSXmdOtvRJ9nNeKYWlugQ5j5-iWCbuv_hAiA,759
-nucliadb_models-6.3.4.post3705.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
-nucliadb_models-6.3.4.post3705.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
-nucliadb_models-6.3.4.post3705.dist-info/RECORD,,
+nucliadb_models-6.3.4.post3721.dist-info/METADATA,sha256=QlqYSc8PRhLDzkcojiOAG-wBY7o1eXBr2lrzYE8dKT4,759
+nucliadb_models-6.3.4.post3721.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+nucliadb_models-6.3.4.post3721.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
+nucliadb_models-6.3.4.post3721.dist-info/RECORD,,

{nucliadb_models-6.3.4.post3705.dist-info → nucliadb_models-6.3.4.post3721.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (76.1.0)
+Generator: setuptools (77.0.3)
 Root-Is-Purelib: true
 Tag: py3-none-any