nucliadb-models 6.3.1.post3598__py3-none-any.whl → 6.3.3.post3611__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of nucliadb-models might be problematic. Click here for more details.

nucliadb_models/search.py CHANGED
@@ -449,7 +449,7 @@ class SearchParamDefaults:
449
449
  filters = ParamDefault(
450
450
  default=[],
451
451
  title="Filters",
452
- description="The list of filters to apply. Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search/#filters", # noqa: E501
452
+ description="The list of filters to apply. Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search_filters", # noqa: E501
453
453
  )
454
454
  resource_filters = ParamDefault(
455
455
  default=[],
@@ -459,7 +459,7 @@ class SearchParamDefaults:
459
459
  faceted = ParamDefault(
460
460
  default=[],
461
461
  title="Faceted",
462
- description="The list of facets to calculate. The facets follow the same syntax as filters: https://docs.nuclia.dev/docs/rag/advanced/search/#filters", # noqa: E501
462
+ description="The list of facets to calculate. The facets follow the same syntax as filters: https://docs.nuclia.dev/docs/rag/advanced/search_filters", # noqa: E501
463
463
  max_items=50,
464
464
  )
465
465
  autofilter = ParamDefault(
@@ -650,7 +650,7 @@ class SearchParamDefaults:
650
650
  title="Filter resource by an expression",
651
651
  description=(
652
652
  "Returns only documents that match this filter expression."
653
- "Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search_filters"
653
+ "Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search_filters "
654
654
  "This allows building complex filtering expressions and replaces the following parameters:"
655
655
  "`fields`, `filters`, `range_*`, `resource_filters`, `keyword_filters`."
656
656
  ),
@@ -660,7 +660,7 @@ class SearchParamDefaults:
660
660
  title="Filter resource by an expression",
661
661
  description=(
662
662
  "Returns only documents that match this filter expression."
663
- "Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search_filters"
663
+ "Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search_filters "
664
664
  "This allows building complex filtering expressions and replaces the following parameters:"
665
665
  "`filters`, `range_*`, `with_status`."
666
666
  ),
@@ -682,13 +682,13 @@ class Filter(BaseModel):
682
682
 
683
683
  class CatalogRequest(BaseModel):
684
684
  query: str = SearchParamDefaults.query.to_pydantic_field()
685
- filter_expression: SkipJsonSchema[Optional[CatalogFilterExpression]] = (
685
+ filter_expression: Optional[CatalogFilterExpression] = (
686
686
  SearchParamDefaults.catalog_filter_expression.to_pydantic_field()
687
687
  )
688
688
  filters: Union[list[str], list[Filter]] = Field(
689
689
  default=[],
690
690
  title="Filters",
691
- description="The list of filters to apply. Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search/#filters", # noqa: E501
691
+ description="The list of filters to apply. Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search_filters", # noqa: E501
692
692
  )
693
693
  faceted: list[str] = SearchParamDefaults.faceted.to_pydantic_field()
694
694
  sort: Optional[SortOptions] = SearchParamDefaults.sort.to_pydantic_field()
@@ -764,14 +764,14 @@ class AuditMetadataBase(BaseModel):
764
764
 
765
765
  class BaseSearchRequest(AuditMetadataBase):
766
766
  query: str = SearchParamDefaults.query.to_pydantic_field()
767
- filter_expression: SkipJsonSchema[Optional[FilterExpression]] = (
767
+ filter_expression: Optional[FilterExpression] = (
768
768
  SearchParamDefaults.filter_expression.to_pydantic_field()
769
769
  )
770
770
  fields: list[str] = SearchParamDefaults.fields.to_pydantic_field()
771
771
  filters: Union[list[str], list[Filter]] = Field(
772
772
  default=[],
773
773
  title="Filters",
774
- description="The list of filters to apply. Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search/#filters", # noqa: E501
774
+ description="The list of filters to apply. Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search_filters", # noqa: E501
775
775
  )
776
776
  top_k: int = SearchParamDefaults.top_k.to_pydantic_field()
777
777
  min_score: Optional[Union[float, MinScore]] = Field(
@@ -1400,14 +1400,14 @@ class AskRequest(AuditMetadataBase):
1400
1400
  le=200,
1401
1401
  description="The top most relevant results to fetch at the retrieval step. The maximum number of results allowed is 200.",
1402
1402
  )
1403
- filter_expression: SkipJsonSchema[Optional[FilterExpression]] = (
1403
+ filter_expression: Optional[FilterExpression] = (
1404
1404
  SearchParamDefaults.filter_expression.to_pydantic_field()
1405
1405
  )
1406
1406
  fields: list[str] = SearchParamDefaults.fields.to_pydantic_field()
1407
1407
  filters: Union[list[str], list[Filter]] = Field(
1408
1408
  default=[],
1409
1409
  title="Filters",
1410
- description="The list of filters to apply. Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search/#filters", # noqa: E501
1410
+ description="The list of filters to apply. Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search_filters", # noqa: E501
1411
1411
  )
1412
1412
  keyword_filters: Union[list[str], list[Filter]] = Field(
1413
1413
  default=[],
@@ -1416,7 +1416,7 @@ class AskRequest(AuditMetadataBase):
1416
1416
  "List of keyword filter expressions to apply to the retrieval step. "
1417
1417
  "The text block search will only be performed on the documents that contain the specified keywords. "
1418
1418
  "The filters are case-insensitive, and only alphanumeric characters and spaces are allowed. "
1419
- "Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search/#filters" # noqa: E501
1419
+ "Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search_filters" # noqa: E501
1420
1420
  ),
1421
1421
  examples=[
1422
1422
  ["NLP", "BERT"],
@@ -1578,7 +1578,7 @@ Using this feature also disables the `citations` parameter. For maximal accuracy
1578
1578
  examples=[ANSWER_JSON_SCHEMA_EXAMPLE],
1579
1579
  )
1580
1580
 
1581
- generate_answer: SkipJsonSchema[bool] = Field(
1581
+ generate_answer: bool = Field(
1582
1582
  default=True,
1583
1583
  description="Whether to generate an answer using the generative model. If set to false, the response will only contain the retrieval results.",
1584
1584
  )
@@ -1730,7 +1730,7 @@ class FindRequest(BaseSearchRequest):
1730
1730
  "List of keyword filter expressions to apply to the retrieval step. "
1731
1731
  "The text block search will only be performed on the documents that contain the specified keywords. "
1732
1732
  "The filters are case-insensitive, and only alphanumeric characters and spaces are allowed. "
1733
- "Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search/#filters" # noqa: E501
1733
+ "Filtering examples can be found here: https://docs.nuclia.dev/docs/rag/advanced/search_filters" # noqa: E501
1734
1734
  ),
1735
1735
  examples=[
1736
1736
  ["NLP", "BERT"],
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.2
2
2
  Name: nucliadb_models
3
- Version: 6.3.1.post3598
3
+ Version: 6.3.3.post3611
4
4
  Author-email: Nuclia <nucliadb@nuclia.com>
5
5
  License: AGPL
6
6
  Project-URL: Homepage, https://nuclia.com
@@ -16,7 +16,7 @@ nucliadb_models/notifications.py,sha256=jr2J3zncs880jYf2oZHYt0VFcnlZevsbkyX69ovT
16
16
  nucliadb_models/processing.py,sha256=UeU-VxbBlOzkNxviOS3a0X_k7Ye-jYu3UOdGuu21M8M,971
17
17
  nucliadb_models/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
18
18
  nucliadb_models/resource.py,sha256=cjYloaRuCJFc3lGIxLZcX959oOq_N1f3V9bpPMYv4WA,9255
19
- nucliadb_models/search.py,sha256=QH6Q4r-y6L4As30hGD7eG0k1CjrNAzSoE0gIvYcnEq8,81847
19
+ nucliadb_models/search.py,sha256=xukR-wsHXiXnmYhF3Qo2WBILV8Z1JGyp0y_J2thgDM0,81778
20
20
  nucliadb_models/security.py,sha256=RewdzQ55nPZ9V7B0NX9KHeWg6B4Hg_RkeiFv2TQyrjs,1402
21
21
  nucliadb_models/synonyms.py,sha256=qXTPHfspMgw22hCjAOdFOIoUsRZ7Ju3JW-Lw9Nz4VaI,942
22
22
  nucliadb_models/text.py,sha256=RHN55PzQjyC0ghbf0r5GvVjTbFUTWzEDSCCkHkgnfig,3491
@@ -32,7 +32,7 @@ nucliadb_models/graph/responses.py,sha256=UXDwFY4va6p6T3kgNJSA4iZ7PrLBR5ibyXw_mo
32
32
  nucliadb_models/internal/__init__.py,sha256=cp15ZcFnHvpcu_5-aK2A4uUyvuZVV_MJn4bIXMa20ks,835
33
33
  nucliadb_models/internal/predict.py,sha256=5rgUPrH_98gerySOZ-TR2PX_qzCGF1_8VxyOu3bGhis,2281
34
34
  nucliadb_models/internal/shards.py,sha256=uZLsMkYWrJDHq3xy_w7snSeV2X3aDBuht9GC_MG3sKc,1976
35
- nucliadb_models-6.3.1.post3598.dist-info/METADATA,sha256=6rjKVaVvEPRWvmBazcxqRHxmzygtwlszKHY79GkndK0,759
36
- nucliadb_models-6.3.1.post3598.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
37
- nucliadb_models-6.3.1.post3598.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
38
- nucliadb_models-6.3.1.post3598.dist-info/RECORD,,
35
+ nucliadb_models-6.3.3.post3611.dist-info/METADATA,sha256=Cnk2evCPVKHuIg1uleuoyLnrAJ9YmzuHfwwCtwQsxaY,759
36
+ nucliadb_models-6.3.3.post3611.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
37
+ nucliadb_models-6.3.3.post3611.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
38
+ nucliadb_models-6.3.3.post3611.dist-info/RECORD,,