nucliadb-models 6.4.0.post4227__py3-none-any.whl → 6.4.0.post4265__py3-none-any.whl

nucliadb_models/filters.py

@@ -20,14 +20,15 @@
 
 from enum import Enum
 from typing import Any, Generic, Literal, Optional, TypeVar, Union
+from uuid import UUID
 
 import pydantic
-from pydantic import AliasChoices, BaseModel, Discriminator, Tag, model_validator
+from pydantic import AliasChoices, BaseModel, Discriminator, Tag, field_validator, model_validator
 from typing_extensions import Annotated, Self
 
 from .common import FieldTypeName, Paragraph
 from .metadata import ResourceProcessingStatus
-from .utils import DateTime
+from .utils import DateTime, SlugString
 
 F = TypeVar("F", bound=BaseModel)
 
@@ -72,8 +73,19 @@ class Resource(BaseModel, extra="forbid"):
     """Matches all fields of a resource given its id or slug"""
 
     prop: Literal["resource"] = "resource"
-    id: Optional[str] = pydantic.Field(default=None, description="ID of the resource to match")
-    slug: Optional[str] = pydantic.Field(default=None, description="Slug of the resource to match")
+    id: Optional[str] = pydantic.Field(default=None, description="UUID of the resource to match")
+    slug: Optional[SlugString] = pydantic.Field(
+        default=None, description="Slug of the resource to match"
+    )
+
+    @field_validator("id", mode="after")
+    def validate_id(cls, v: str) -> str:
+        if v is not None:
+            try:
+                UUID(v)
+            except ValueError:
+                raise ValueError("Invalid UUID")
+        return v
 
     @model_validator(mode="after")
     def single_field(self) -> Self:

nucliadb_models/search.py

@@ -1905,6 +1905,15 @@ class KnowledgeboxFindResults(JsonBaseModel):
         title="Best matches",
         description="List of ids of best matching paragraphs. The list is sorted by decreasing relevance (most relevant first).",  # noqa: E501
     )
+    metrics: Optional[dict[str, Any]] = Field(
+        default=None,
+        title="Metrics",
+        description=(
+            "Metrics information about the search operation. "
+            "The metadata included in this field is subject to change and should not be used in production. "
+            "This is only available if the `debug` parameter is set to true in the request."
+        ),
+    )
 
 
 class FeedbackTasks(str, Enum):
@@ -2077,7 +2086,11 @@ class SyncAskResponse(BaseModel):
     debug: Optional[dict[str, Any]] = Field(
         default=None,
         title="Debug information",
-        description="Debug information about predict",
+        description=(
+            "Debug information about the ask operation. "
+            "The metadata included in this field is subject to change and should not be used in production. "
+            "Note that it is only available if the `debug` parameter is set to true in the request."
+        ),
     )
 
 
@@ -2137,6 +2150,7 @@ class RelationsAskResponseItem(BaseModel):
 class DebugAskResponseItem(BaseModel):
     type: Literal["debug"] = "debug"
     metadata: dict[str, Any]
+    metrics: dict[str, Any]
 
 
 AskResponseItemType = Union[

{nucliadb_models-6.4.0.post4227.dist-info → nucliadb_models-6.4.0.post4265.dist-info}/METADATA

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

{nucliadb_models-6.4.0.post4227.dist-info → nucliadb_models-6.4.0.post4265.dist-info}/RECORD

@@ -8,7 +8,7 @@ nucliadb_models/export_import.py,sha256=A1KTjwQCRtyVAWcgabXsdltI78rauXBmZX1ie6Rx
 nucliadb_models/external_index_providers.py,sha256=aVyj-P4kVqfqPjF13E_lUM0FZsq8-DTbIsh-kHOgt2s,1787
 nucliadb_models/extracted.py,sha256=CBeC0hUphXq1T79K7Cpohuyg7f1pqTB4WGErb0HGgRs,6497
 nucliadb_models/file.py,sha256=FKnaYUZPjxCEDUpbyDTudnHHKeSuQLfBnRR2FL6tL2s,1992
-nucliadb_models/filters.py,sha256=fVbQLwzidnugeYBSAvc_NN32UwcGg44y2DMsuBFnvoM,14182
+nucliadb_models/filters.py,sha256=xWSs5vHowbEHLfGGh8BTKBCZmFMY_rx6T0FR8Do2iPE,14503
 nucliadb_models/labels.py,sha256=OUlX-apmFkibEN9bWThRJlbCD84hzJdddN1YYUV2Y3w,4201
 nucliadb_models/link.py,sha256=x6YainEQ9gx6X1KF8oelA-RTaqjOesoWJNYENihDfgo,2262
 nucliadb_models/metadata.py,sha256=ppwU__5IWHvBNDUT5EGLZxgpSBTwuA-rEpY-8Ef-Lwo,8600
@@ -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=AviTtBGQZ-zAKYbD-rprzX7yfIjsIh09IW4sDbC9FnU,83666
+nucliadb_models/search.py,sha256=Eq4Q6Xb4Tz_PQHAAKExJ2cdsjKYARWb1c5N_btNXp2I,84340
 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
@@ -32,7 +32,7 @@ nucliadb_models/graph/responses.py,sha256=3aimAHrd3YW1BXHU_ZXRoidlccRtkCcREkfCNo
 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.post4227.dist-info/METADATA,sha256=gPGn1QjOaiVSqJR0o5teMnWoLK0w_B3lOpYriRRvMlU,759
-nucliadb_models-6.4.0.post4227.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-nucliadb_models-6.4.0.post4227.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
-nucliadb_models-6.4.0.post4227.dist-info/RECORD,,
+nucliadb_models-6.4.0.post4265.dist-info/METADATA,sha256=t45eYQsz8Y7waNfmXhdtU6A_qCRBBddctYfwugEaOy0,759
+nucliadb_models-6.4.0.post4265.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+nucliadb_models-6.4.0.post4265.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
+nucliadb_models-6.4.0.post4265.dist-info/RECORD,,

{nucliadb_models-6.4.0.post4227.dist-info → nucliadb_models-6.4.0.post4265.dist-info}/WHEEL

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