nucliadb-models 6.5.0.post4404__py3-none-any.whl → 6.5.0.post4413__py3-none-any.whl

nucliadb_models/search.py

@@ -691,40 +691,86 @@ class Filter(BaseModel):
         return self
 
 
+class CatalogQueryField(str, Enum):
+    Title = "title"
+    # Slug = "slug"
+
+
+class CatalogQueryMatch(str, Enum):
+    Exact = "exact"
+    Words = "words"
+    Fuzzy = "fuzzy"
+    StartsWith = "starts_with"
+    EndsWith = "ends_with"
+    Contains = "contains"
+
+
+class CatalogQuery(BaseModel):
+    field: CatalogQueryField = CatalogQueryField.Title
+    match: CatalogQueryMatch = CatalogQueryMatch.Exact
+    query: str = Field(min_length=1)
+
+    @model_validator(mode="after")
+    def check_match_field(self) -> Self:
+        if self.field != CatalogQueryField.Title:
+            if self.match not in [CatalogQueryMatch.Exact, CatalogQueryMatch.StartsWith]:
+                raise ValueError(
+                    f"Match type `{self.match.value}` not supported for {self.field.value}. Use `exact` or `starts_with`."
+                )
+
+        return self
+
+
 class CatalogRequest(BaseModel):
-    query: str = SearchParamDefaults.query.to_pydantic_field()
+    query: Union[str, CatalogQuery] = ParamDefault(
+        default="",
+        title="Query",
+        description="The query to search for",
+    ).to_pydantic_field()
     filter_expression: Optional[CatalogFilterExpression] = (
         SearchParamDefaults.catalog_filter_expression.to_pydantic_field()
     )
-    filters: Union[list[str], list[Filter]] = Field(
-        default=[],
-        title="Filters",
-        description="The list of filters to apply. Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search-filters",  # noqa: E501
-    )
     faceted: list[str] = SearchParamDefaults.faceted.to_pydantic_field()
     sort: Optional[SortOptions] = SearchParamDefaults.sort.to_pydantic_field()
     page_number: int = SearchParamDefaults.catalog_page_number.to_pydantic_field()
     page_size: int = SearchParamDefaults.catalog_page_size.to_pydantic_field()
+    hidden: Optional[bool] = SearchParamDefaults.hidden.to_pydantic_field()
+    show: list[ResourceProperties] = SearchParamDefaults.show.to_pydantic_field(
+        default=[ResourceProperties.BASIC, ResourceProperties.ERRORS]
+    )
+
     debug: SkipJsonSchema[bool] = SearchParamDefaults.debug.to_pydantic_field()
+
+    # Deprecated filter parameters
+    filters: Union[list[str], list[Filter]] = Field(
+        default=[],
+        title="Filters",
+        description="The list of filters to apply. Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search-filters",  # noqa: E501
+        deprecated="Use filter_expression instead",
+    )
     with_status: Optional[ResourceProcessingStatus] = Field(
         default=None,
         title="With processing status",
         description="Filter results by resource processing status",
-        deprecated="Use filters instead",
+        deprecated="Use filter_expression instead",
     )
     range_creation_start: Optional[DateTime] = (
-        SearchParamDefaults.range_creation_start.to_pydantic_field()
+        SearchParamDefaults.range_creation_start.to_pydantic_field(
+            deprecated="Use filter_expression instead",
+        )
+    )
+    range_creation_end: Optional[DateTime] = SearchParamDefaults.range_creation_end.to_pydantic_field(
+        deprecated="Use filter_expression instead",
     )
-    range_creation_end: Optional[DateTime] = SearchParamDefaults.range_creation_end.to_pydantic_field()
     range_modification_start: Optional[DateTime] = (
-        SearchParamDefaults.range_modification_start.to_pydantic_field()
+        SearchParamDefaults.range_modification_start.to_pydantic_field(
+            deprecated="Use filter_expression instead",
+        )
     )
     range_modification_end: Optional[DateTime] = (
-        SearchParamDefaults.range_modification_end.to_pydantic_field()
-    )
-    hidden: Optional[bool] = SearchParamDefaults.hidden.to_pydantic_field()
-    show: list[ResourceProperties] = SearchParamDefaults.show.to_pydantic_field(
-        default=[ResourceProperties.BASIC, ResourceProperties.ERRORS]
+        SearchParamDefaults.range_modification_end.to_pydantic_field(
+            deprecated="Use filter_expression instead",
+        )
     )
 
     @field_validator("faceted")

{nucliadb_models-6.5.0.post4404.dist-info → nucliadb_models-6.5.0.post4413.dist-info}/METADATA

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

{nucliadb_models-6.5.0.post4404.dist-info → nucliadb_models-6.5.0.post4413.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=Cg7W4Ng7G5UgMOAD-pkSz6fEcaiSTBdju6q8ApUNgag,85393
+nucliadb_models/search.py,sha256=A-XM5zyv7QYL5MXhWRhOVIOJyaea2OSucDeWZchEtPo,86702
 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.0.post4404.dist-info/METADATA,sha256=TNc6ywS-RXIapZG3UPtqRSoYuNQPT73lu77BzwcDeUU,776
-nucliadb_models-6.5.0.post4404.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nucliadb_models-6.5.0.post4404.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
-nucliadb_models-6.5.0.post4404.dist-info/RECORD,,
+nucliadb_models-6.5.0.post4413.dist-info/METADATA,sha256=ez6vy328OlONZAbqhKZq6MjIXzObzJ_saPNIxQKVsF8,776
+nucliadb_models-6.5.0.post4413.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nucliadb_models-6.5.0.post4413.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
+nucliadb_models-6.5.0.post4413.dist-info/RECORD,,