nucliadb-models 6.4.0.post4158__py3-none-any.whl → 6.4.0.post4161__py3-none-any.whl

nucliadb_models/configuration.py

@@ -23,6 +23,7 @@ from typing import Annotated, Literal, Optional, Union
 
 from pydantic import BaseModel, Field, create_model
 
+from .graph.requests import GraphPathQuery  # noqa # we need this import for pydantic magic
 from .search import AskRequest, FindRequest
 
 
@@ -79,3 +80,7 @@ class AskSearchConfiguration(BaseModel):
 SearchConfiguration = Annotated[
     Union[FindSearchConfiguration, AskSearchConfiguration], Field(discriminator="kind")
 ]
+
+# We need this to avoid issues with pydantic and generic types defined in another module
+FindConfig.model_rebuild()
+AskConfig.model_rebuild()

nucliadb_models/graph/requests.py

@@ -25,7 +25,6 @@ from typing_extensions import Self
 
 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
@@ -161,8 +160,16 @@ class GraphSearchRequest(BaseGraphSearchRequest):
             "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()
+    security: Optional[RequestSecurity] = Field(
+        default=None,
+        title="Security",
+        description="Security metadata for the request. If not provided, the search request is done without the security lookup phase.",  # noqa: E501
+    )
+    show_hidden: bool = Field(
+        default=False,
+        title="Show hidden resources",
+        description="If set to false (default), excludes hidden resources from search",
+    )
 
 
 # Nodes search
@@ -189,8 +196,16 @@ class GraphNodesSearchRequest(BaseGraphSearchRequest):
             "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()
+    security: Optional[RequestSecurity] = Field(
+        default=None,
+        title="Security",
+        description="Security metadata for the request. If not provided, the search request is done without the security lookup phase.",  # noqa: E501
+    )
+    show_hidden: bool = Field(
+        default=False,
+        title="Show hidden resources",
+        description="If set to false (default), excludes hidden resources from search",
+    )
 
 
 # Relations search
@@ -217,8 +232,16 @@ class GraphRelationsSearchRequest(BaseGraphSearchRequest):
             "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()
+    security: Optional[RequestSecurity] = Field(
+        default=None,
+        title="Security",
+        description="Security metadata for the request. If not provided, the search request is done without the security lookup phase.",  # noqa: E501
+    )
+    show_hidden: bool = Field(
+        default=False,
+        title="Show hidden resources",
+        description="If set to false (default), excludes hidden resources from search",
+    )
 
 
 # We need this to avoid issues with pydantic and generic types defined in another module

nucliadb_models/search.py

@@ -27,6 +27,7 @@ from typing_extensions import Annotated, Self
 
 from nucliadb_models import RelationMetadata
 from nucliadb_models.common import FieldTypeName, ParamDefault
+from nucliadb_models.graph.requests import GraphPathQuery
 
 # Bw/c import to avoid breaking users
 # noqa isort: skip
@@ -104,9 +105,10 @@ class SearchOptions(str, Enum):
 
 
 class FindOptions(str, Enum):
-    RELATIONS = "relations"
     KEYWORD = "keyword"
     SEMANTIC = "semantic"
+    RELATIONS = "relations"
+    GRAPH = "graph"
 
 
 class ChatOptions(str, Enum):
@@ -359,6 +361,7 @@ class _BaseRankFusion(BaseModel):
 class ReciprocalRankFusionWeights(BaseModel):
     keyword: float = 1.0
     semantic: float = 1.0
+    graph: SkipJsonSchema[float] = 1.0
 
 
 class ReciprocalRankFusion(_BaseRankFusion):
@@ -1724,6 +1727,11 @@ class FindRequest(BaseSearchRequest):
     query_entities: SkipJsonSchema[Optional[list[KnowledgeGraphEntity]]] = Field(
         default=None, title="Query entities", description="Entities to use in a knowledge graph search"
     )
+    graph_query: SkipJsonSchema[Optional[GraphPathQuery]] = Field(
+        default=None,
+        title="Graph query",
+        description="Query for the knowledge graph. Paths (node-relation-node) extracted from a paragraph_id will be used to extend the results",
+    )
     features: list[FindOptions] = SearchParamDefaults.search_features.to_pydantic_field(
         default=[
             FindOptions.KEYWORD,
@@ -1769,6 +1777,13 @@ class FindRequest(BaseSearchRequest):
                 values["rank_fusion"] = RankFusionName.RECIPROCAL_RANK_FUSION
         return values
 
+    @field_validator("features")
+    @classmethod
+    def incompatible_features(cls, features: list[FindOptions]):
+        if FindOptions.RELATIONS in features and FindOptions.GRAPH in features:
+            raise ValueError("Relations and graph are incompatible features, please, use only one")
+        return features
+
 
 class SCORE_TYPE(str, Enum):
     VECTOR = "VECTOR"
@@ -2139,3 +2154,7 @@ def parse_custom_prompt(item: AskRequest) -> CustomPrompt:
 def parse_rephrase_prompt(item: AskRequest) -> Optional[str]:
     prompt = parse_custom_prompt(item)
     return prompt.rephrase
+
+
+# We need this to avoid issues with pydantic and generic types defined in another module
+FindRequest.model_rebuild()

{nucliadb_models-6.4.0.post4158.dist-info → nucliadb_models-6.4.0.post4161.dist-info}/METADATA

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

{nucliadb_models-6.4.0.post4158.dist-info → nucliadb_models-6.4.0.post4161.dist-info}/RECORD

@@ -1,6 +1,6 @@
 nucliadb_models/__init__.py,sha256=qSmhNKACMwdbU1rklMWlmJKmlRaWvrSksTtwEVkiydQ,1331
 nucliadb_models/common.py,sha256=JEEY7_AxRCBPHUF6J8XptR_QnGEjRBd02Kqm5WOySYc,7828
-nucliadb_models/configuration.py,sha256=7iUgSCkmFinu6clCfT54P5tuz5Lvf6eJVmahYjwI7qk,2525
+nucliadb_models/configuration.py,sha256=dogTdIJ7lmlT2JwIFs2e18JvNKiwzsGlD_UJp8Fna3Q,2760
 nucliadb_models/content_types.py,sha256=2B3TJpPYJqd-9xGiNiHJFngSIrVyNsZlN4PeB-HafIk,3682
 nucliadb_models/conversation.py,sha256=nUXvcH3J_xk4HB7raI38dGtZebc_G6TZZWjicjyAa7g,3635
 nucliadb_models/entities.py,sha256=IqsbF0dSCWkp222sd_R2Ste0iG1eoBPNh1Fh6mNVcu0,2608
@@ -16,7 +16,7 @@ nucliadb_models/notifications.py,sha256=jr2J3zncs880jYf2oZHYt0VFcnlZevsbkyX69ovT
 nucliadb_models/processing.py,sha256=UeU-VxbBlOzkNxviOS3a0X_k7Ye-jYu3UOdGuu21M8M,971
 nucliadb_models/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nucliadb_models/resource.py,sha256=cjYloaRuCJFc3lGIxLZcX959oOq_N1f3V9bpPMYv4WA,9255
-nucliadb_models/search.py,sha256=HfXBMzRlRBKeFWmzsA4pWQmtR3Pt-EGLdp-rySqwWN8,82075
+nucliadb_models/search.py,sha256=zuTZ8g3Rbkjx0Y99cFm8SYZBVMt17ubkw6EToW1q3DI,82901
 nucliadb_models/security.py,sha256=RewdzQ55nPZ9V7B0NX9KHeWg6B4Hg_RkeiFv2TQyrjs,1402
 nucliadb_models/synonyms.py,sha256=qXTPHfspMgw22hCjAOdFOIoUsRZ7Ju3JW-Lw9Nz4VaI,942
 nucliadb_models/text.py,sha256=dr-ckEIK0a8c5u-7uO1wpund_8KKb_4T79Au4Lfv-Bo,3150
@@ -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=W0Dy1AV2H1JJiweoCRqzsvMReNksNZDd4QXzKWNScH4,7544
+nucliadb_models/graph/requests.py,sha256=w63Put4SvIHE-b0StA4MHqSt2vQkymfMlv5YPycpibA,8311
 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=bcnkxF_zViHZfT6WTAMBcWgY3UV-OAV65cVdSqGkcHY,1943
-nucliadb_models-6.4.0.post4158.dist-info/METADATA,sha256=ojRL69H57YQwa9UP6naBdyh_bmBRQH1cD4nXHh44mh4,759
-nucliadb_models-6.4.0.post4158.dist-info/WHEEL,sha256=ck4Vq1_RXyvS4Jt6SI0Vz6fyVs4GWg7AINwpsaGEgPE,91
-nucliadb_models-6.4.0.post4158.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
-nucliadb_models-6.4.0.post4158.dist-info/RECORD,,
+nucliadb_models-6.4.0.post4161.dist-info/METADATA,sha256=latuGNCpI-5Dro9yhaVLt6rTfe9r48OM2M_5uOGNqUE,759
+nucliadb_models-6.4.0.post4161.dist-info/WHEEL,sha256=ck4Vq1_RXyvS4Jt6SI0Vz6fyVs4GWg7AINwpsaGEgPE,91
+nucliadb_models-6.4.0.post4161.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
+nucliadb_models-6.4.0.post4161.dist-info/RECORD,,