nucliadb-models 6.4.0.post4241__py3-none-any.whl → 6.4.0.post4271__py3-none-any.whl

nucliadb_models/search.py

@@ -1003,6 +1003,21 @@ class RephraseModel(BaseModel):
         title="Generative model",
         description="The generative model to use for the rephrase endpoint. If not provided, the model configured for the Knowledge Box is used.",  # noqa: E501
     )
+    chat_history_relevance_threshold: Optional[
+        Annotated[
+            float,
+            Field(
+                ge=0.0,
+                le=1.0,
+                description=(
+                    "Threshold to determine if the past chat history is relevant to rephrase the user's question. "
+                    "0 - Always treat previous messages as relevant (always rephrase)."
+                    "1 – Always treat previous messages as irrelevant (never rephrase)."
+                    "Values in between adjust the sensitivity."
+                ),
+            ),
+        ]
+    ] = None
 
 
 class RagStrategyName:
@@ -1578,6 +1593,21 @@ If empty, the default strategy is used, which simply adds the text of the matchi
             "Rephrase the query for a more efficient retrieval. This will consume LLM tokens and make the request slower."
         ),
     )
+    chat_history_relevance_threshold: Optional[
+        Annotated[
+            float,
+            Field(
+                ge=0.0,
+                le=1.0,
+                description=(
+                    "Threshold to determine if the past chat history is relevant to rephrase the user's question. "
+                    "0 - Always treat previous messages as relevant (always rephrase)."
+                    "1 – Always treat previous messages as irrelevant (never rephrase)."
+                    "Values in between adjust the sensitivity."
+                ),
+            ),
+        ]
+    ] = None
 
     prefer_markdown: bool = Field(
         default=False,
@@ -1905,6 +1935,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 +2116,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 +2180,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.post4241.dist-info → nucliadb_models-6.4.0.post4271.dist-info}/METADATA

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

{nucliadb_models-6.4.0.post4241.dist-info → nucliadb_models-6.4.0.post4271.dist-info}/RECORD

@@ -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=Emf02fKF9cmOOZBXk4LYpJGkiMl4hkNSTUPAtS8j86A,85538
 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.post4241.dist-info/METADATA,sha256=72uIhNFBCdc1xaVdLPlYzcI-u0ols5EzCl__2to7MFQ,759
-nucliadb_models-6.4.0.post4241.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-nucliadb_models-6.4.0.post4241.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
-nucliadb_models-6.4.0.post4241.dist-info/RECORD,,
+nucliadb_models-6.4.0.post4271.dist-info/METADATA,sha256=ULdypfYzDrgthxaONN6S3U3g0Tx-jKOlFGAEOHvTwnI,759
+nucliadb_models-6.4.0.post4271.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+nucliadb_models-6.4.0.post4271.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
+nucliadb_models-6.4.0.post4271.dist-info/RECORD,,

{nucliadb_models-6.4.0.post4241.dist-info → nucliadb_models-6.4.0.post4271.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