nucliadb-models 6.7.2.post4908__py3-none-any.whl → 6.7.2.post4917__py3-none-any.whl

nucliadb_models/search.py

@@ -985,6 +985,29 @@ def parse_max_tokens(max_tokens: Optional[Union[int, MaxTokens]]) -> Optional[Ma
     return max_tokens
 
 
+class Reasoning(BaseModel):
+    display: bool = Field(
+        default=True,
+        description="Whether to display the reasoning steps in the response.",
+    )
+    effort: Literal["low", "medium", "high"] = Field(
+        default="medium",
+        description=(
+            "Level of reasoning effort. Used by OpenAI models to control the depth of reasoning. "
+            "This parameter will be automatically mapped to budget_tokens "
+            "if the chosen model does not support effort."
+        ),
+    )
+    budget_tokens: int = Field(
+        default=15_000,
+        description=(
+            "Token budget for reasoning. Used by Anthropic or Google models to limit the number of "
+            "tokens used for reasoning. This parameter will be automatically mapped to effort "
+            "if the chosen model does not support budget_tokens."
+        ),
+    )
+
+
 class ChatModel(BaseModel):
     """
     This is the model for the predict request payload on the chat endpoint
@@ -1058,6 +1081,13 @@ class ChatModel(BaseModel):
         default=None,
         description="Seed use for the generative model for a deterministic output.",
     )
+    reasoning: Union[Reasoning, bool] = Field(
+        default=False,
+        description=(
+            "Reasoning options for the generative model. "
+            "Set to True to enable default reasoning, False to disable, or provide a Reasoning object for custom options."
+        ),
+    )
 
 
 class RephraseModel(BaseModel):
@@ -1723,6 +1753,14 @@ Using this feature also disables the `citations` parameter. For maximal accuracy
         description="Load ask parameters from this configuration. Parameters in the request override parameters from the configuration.",
     )
 
+    reasoning: Union[Reasoning, bool] = Field(
+        default=False,
+        description=(
+            "Reasoning options for the generative model. "
+            "Set to True to enable default reasoning, False to disable, or provide a Reasoning object for custom options."
+        ),
+    )
+
     @field_validator("rag_strategies", mode="before")
     @classmethod
     def validate_rag_strategies(cls, rag_strategies: list[RagStrategies]) -> list[RagStrategies]:
@@ -2180,6 +2218,11 @@ class SyncAskResponse(BaseModel):
         title="Answer",
         description="The generative answer to the query",
     )
+    reasoning: Optional[str] = Field(
+        default=None,
+        title="Reasoning",
+        description="The reasoning steps followed by the LLM to generate the answer. This is returned only if the reasoning feature is enabled in the request.",  # noqa: E501
+    )
     answer_json: Optional[dict[str, Any]] = Field(
         default=None,
         title="Answer JSON",
@@ -2284,6 +2327,11 @@ class AnswerAskResponseItem(BaseModel):
     text: str
 
 
+class ReasoningAskResponseItem(BaseModel):
+    type: Literal["reasoning"] = "reasoning"
+    text: str
+
+
 class JSONAskResponseItem(BaseModel):
     type: Literal["answer_json"] = "answer_json"
     object: dict[str, Any]
@@ -2347,6 +2395,7 @@ class DebugAskResponseItem(BaseModel):
 
 AskResponseItemType = Union[
     AnswerAskResponseItem,
+    ReasoningAskResponseItem,
     JSONAskResponseItem,
     MetadataAskResponseItem,
     AugmentedContextResponseItem,

{nucliadb_models-6.7.2.post4908.dist-info → nucliadb_models-6.7.2.post4917.dist-info}/METADATA

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

{nucliadb_models-6.7.2.post4908.dist-info → nucliadb_models-6.7.2.post4917.dist-info}/RECORD

@@ -16,7 +16,7 @@ nucliadb_models/notifications.py,sha256=mna8-AoD_29Wds0Thl0AF0zpERnJmYGLZX1w1fUo
 nucliadb_models/processing.py,sha256=nhKuHQjqCdb9zJVkYGPTLub23tK9e_lwL5OCDVymZjY,719
 nucliadb_models/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nucliadb_models/resource.py,sha256=RzCos0QRgSMkaV-p7EoceSmt7UTzt9G9be5BKF-iGrQ,9021
-nucliadb_models/search.py,sha256=2pmXfnVkmWqs0WAlJC0XlMk3sqnhlpJx1AbtTQ_BjN8,92190
+nucliadb_models/search.py,sha256=d1KTOxd2VDKTkrJmwKSqOcZ8lcSXZpULK7a5zbMUS2c,94050
 nucliadb_models/security.py,sha256=opxaDLfvk3aU0sjesK0jGrYLx5h4YCwlKKN0moYs_ig,1150
 nucliadb_models/synonyms.py,sha256=afbaVqSQSxGLwi2PusVaLSRpkOtA5AZmWOKd1f4nl2E,690
 nucliadb_models/text.py,sha256=60bxZnOjRHnDdezR8VfR3AZsXTOwePFPs2BKB8wxBak,3414
@@ -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.7.2.post4908.dist-info/METADATA,sha256=5VuyV7-015hZyA4X4lZ8RKmmP2coZ5SodhUr_i9tR0A,794
-nucliadb_models-6.7.2.post4908.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nucliadb_models-6.7.2.post4908.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
-nucliadb_models-6.7.2.post4908.dist-info/RECORD,,
+nucliadb_models-6.7.2.post4917.dist-info/METADATA,sha256=AHr1MblOtlhLomO-AF2r6ID0eu2TZWCzj_cmdYpihYU,794
+nucliadb_models-6.7.2.post4917.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nucliadb_models-6.7.2.post4917.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
+nucliadb_models-6.7.2.post4917.dist-info/RECORD,,