nucliadb-models 6.5.1.post4539__py3-none-any.whl → 6.6.1.post4558__py3-none-any.whl

nucliadb_models/search.py

@@ -706,9 +706,11 @@ class CatalogQueryMatch(str, Enum):
 
 
 class CatalogQuery(BaseModel):
-    field: CatalogQueryField = CatalogQueryField.Title
-    match: CatalogQueryMatch = CatalogQueryMatch.Exact
-    query: str = Field(min_length=1)
+    field: CatalogQueryField = Field(default=CatalogQueryField.Title, description="Field to search in")
+    match: CatalogQueryMatch = Field(
+        default=CatalogQueryMatch.Exact, description="Operator to use for matching results"
+    )
+    query: str = Field(min_length=1, description="Text to search for")
 
     @model_validator(mode="after")
     def check_match_field(self) -> Self:
@@ -1680,7 +1682,8 @@ Using this feature also disables the `citations` parameter. For maximal accuracy
     )
 
     search_configuration: Optional[str] = Field(
-        default=None, description="Load ask parameters from this configuration"
+        default=None,
+        description="Load ask parameters from this configuration. Parameters in the request override parameters from the configuration.",
     )
 
     @field_validator("rag_strategies", mode="before")
@@ -1855,7 +1858,8 @@ class FindRequest(BaseSearchRequest):
     )
 
     search_configuration: Optional[str] = Field(
-        default=None, description="Load find parameters from this configuration"
+        default=None,
+        description="Load find parameters from this configuration. Parameters in the request override parameters from the configuration.",
     )
     generative_model: Optional[str] = Field(
         default=None,
@@ -2324,7 +2328,11 @@ FindRequest.model_rebuild()
 
 class CatalogFacetsPrefix(BaseModel):
     prefix: str = Field(pattern="^((/[^/]+)*)$")
-    depth: Optional[int] = Field(default=None, ge=0)
+    depth: Optional[int] = Field(
+        default=None,
+        ge=0,
+        description="Only include facets up to this depth from the prefix, leave empty to include all depths",
+    )
 
     @model_validator(mode="before")
     @classmethod
@@ -2335,7 +2343,9 @@ class CatalogFacetsPrefix(BaseModel):
 
 
 class CatalogFacetsRequest(BaseModel):
-    prefixes: list[CatalogFacetsPrefix] = Field(default=[])
+    prefixes: list[CatalogFacetsPrefix] = Field(
+        default=[], description="List of facets prefixes to include (empty to includ everything)"
+    )
 
 
 class CatalogFacetsResponse(BaseModel):

{nucliadb_models-6.5.1.post4539.dist-info → nucliadb_models-6.6.1.post4558.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nucliadb_models
-Version: 6.5.1.post4539
+Version: 6.6.1.post4558
 Author-email: Nuclia <nucliadb@nuclia.com>
 License-Expression: Apache-2.0
 Project-URL: Homepage, https://nuclia.com

{nucliadb_models-6.5.1.post4539.dist-info → nucliadb_models-6.6.1.post4558.dist-info}/RECORD

@@ -16,7 +16,7 @@ nucliadb_models/notifications.py,sha256=3w1HeX9F8nuA7WupHdpXIksX7d0bHO9ofmemYp4R
 nucliadb_models/processing.py,sha256=nhKuHQjqCdb9zJVkYGPTLub23tK9e_lwL5OCDVymZjY,719
 nucliadb_models/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nucliadb_models/resource.py,sha256=FkhwmbjoqQBGyKQIqa40WK2Vq3wtryZeIVWmJ4b-84g,9003
-nucliadb_models/search.py,sha256=hASQhuTXXqWqbq-A4wroviYL0JTf6WSTBOumLngpQbY,89612
+nucliadb_models/search.py,sha256=njGUScrDA2Dn1y26lQ9_dVYzHIldkPMVpDgP7zstgXk,90163
 nucliadb_models/security.py,sha256=opxaDLfvk3aU0sjesK0jGrYLx5h4YCwlKKN0moYs_ig,1150
 nucliadb_models/synonyms.py,sha256=afbaVqSQSxGLwi2PusVaLSRpkOtA5AZmWOKd1f4nl2E,690
 nucliadb_models/text.py,sha256=kY2ub7AaGm-4vNaLX3Ju2VvRw-eKZ2LRdM9z7XCNaG0,2898
@@ -32,7 +32,7 @@ nucliadb_models/graph/responses.py,sha256=Sdq8OgFAL1YT-1lJyLLrkqcScvj7YTEqAUwQ-k
 nucliadb_models/internal/__init__.py,sha256=zG33bUz1rHFPtvqQPWn4rDwBJt3FJodGuQYD45quiQg,583
 nucliadb_models/internal/predict.py,sha256=Pnx6MmLfK65eExe1XnVxqmSlvMwdowewwks9BOEoqMw,2029
 nucliadb_models/internal/shards.py,sha256=__y1OZtWGiNcPQEWfSFOj8yw458WGi7mM4vZe0K-L1Y,1691
-nucliadb_models-6.5.1.post4539.dist-info/METADATA,sha256=baj9Sp8r0QE4vdGG6Z2gcW37qZmGDqnJP3B7z5bZzDg,776
-nucliadb_models-6.5.1.post4539.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nucliadb_models-6.5.1.post4539.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
-nucliadb_models-6.5.1.post4539.dist-info/RECORD,,
+nucliadb_models-6.6.1.post4558.dist-info/METADATA,sha256=rQNZCC1B04hcbuk9ke2BqSX-IZ_ckwCY8eQngKNnWik,776
+nucliadb_models-6.6.1.post4558.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nucliadb_models-6.6.1.post4558.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
+nucliadb_models-6.6.1.post4558.dist-info/RECORD,,