nucliadb-models 6.6.1.post4573__py3-none-any.whl → 6.6.1.post4584__py3-none-any.whl

nucliadb_models/search.py

@@ -42,6 +42,8 @@ from nucliadb_models.internal.shards import (  # noqa isort: skip
     ShardReplica,
     KnowledgeboxShards,
 )
+from nuclia_models.common.consumption import Consumption
+
 from nucliadb_models.filters import CatalogFilterExpression, FilterExpression
 
 ANSWER_JSON_SCHEMA_EXAMPLE = {
@@ -1815,6 +1817,7 @@ class SummarizedResponse(BaseModel):
         title="Summary",
         description="Global summary of all resources combined.",
     )
+    consumption: Optional[Consumption] = None
 
 
 class KnowledgeGraphEntity(BaseModel):
@@ -2200,6 +2203,14 @@ class SyncAskResponse(BaseModel):
         title="Metadata",
         description="Metadata of the query execution. This includes the number of tokens used in the LLM context and answer, and the timings of the generative model.",  # noqa: E501
     )
+    consumption: Optional[Consumption] = Field(
+        default=None,
+        title="Consumption",
+        description=(
+            "The consumption of the query execution. Return only if"
+            " 'X-show-consumption' header is set to true in the request."
+        ),
+    )
     error_details: Optional[str] = Field(
         default=None,
         title="Error details",
@@ -2247,6 +2258,18 @@ class MetadataAskResponseItem(BaseModel):
     timings: AskTimings
 
 
+class TokensDetail(BaseModel):
+    input: float
+    output: float
+    image: float
+
+
+class ConsumptionResponseItem(BaseModel):
+    type: Literal["consumption"] = "consumption"
+    normalized_tokens: TokensDetail
+    customer_key_tokens: TokensDetail
+
+
 class AugmentedContextResponseItem(BaseModel):
     type: Literal["augmented_context"] = "augmented_context"
     augmented: AugmentedContext = Field(
@@ -2297,6 +2320,7 @@ AskResponseItemType = Union[
     RelationsAskResponseItem,
     DebugAskResponseItem,
     PrequeriesAskResponseItem,
+    ConsumptionResponseItem,
 ]
 
 

{nucliadb_models-6.6.1.post4573.dist-info → nucliadb_models-6.6.1.post4584.dist-info}/METADATA

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

{nucliadb_models-6.6.1.post4573.dist-info → nucliadb_models-6.6.1.post4584.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=njGUScrDA2Dn1y26lQ9_dVYzHIldkPMVpDgP7zstgXk,90163
+nucliadb_models/search.py,sha256=eV3XKS4XbR8iw0Rnw3S3OTRLvjB_iHgWqezGnDrXIIU,90829
 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.6.1.post4573.dist-info/METADATA,sha256=wOK1fjJ2foPMOqyVnSTjHH3Ag_qsOjSXttdjv5_sCYY,794
-nucliadb_models-6.6.1.post4573.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nucliadb_models-6.6.1.post4573.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
-nucliadb_models-6.6.1.post4573.dist-info/RECORD,,
+nucliadb_models-6.6.1.post4584.dist-info/METADATA,sha256=fz9kWvEuuAPmk3-JYssjzarXREkuPXXughb3r9D1RKg,794
+nucliadb_models-6.6.1.post4584.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nucliadb_models-6.6.1.post4584.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
+nucliadb_models-6.6.1.post4584.dist-info/RECORD,,