deeprails 1.4.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

deeprails/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "deeprails"
-__version__ = "1.4.0"  # x-release-please-version
+__version__ = "1.5.0"  # x-release-please-version

deeprails/resources/defend.py

@@ -213,9 +213,9 @@ class DefendResource(SyncAPIResource):
         evaluation
 
         Args:
-          model_input: A dictionary of inputs sent to the LLM to generate output. This must contain a
-              `user_prompt` field and an optional `context` field. Additional properties are
-              allowed.
+          model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
+              contain at least one of `user_prompt` or `system_prompt`. For
+              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.
 
@@ -491,9 +491,9 @@ class AsyncDefendResource(AsyncAPIResource):
         evaluation
 
         Args:
-          model_input: A dictionary of inputs sent to the LLM to generate output. This must contain a
-              `user_prompt` field and an optional `context` field. Additional properties are
-              allowed.
+          model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
+              contain at least one of `user_prompt` or `system_prompt`. For
+              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.
 

deeprails/resources/evaluate.py

@@ -75,9 +75,9 @@ class EvaluateResource(SyncAPIResource):
         guardrail metrics
 
         Args:
-          model_input: A dictionary of inputs sent to the LLM to generate output. This must contain a
-              `user_prompt` field and an optional `context` field. Additional properties are
-              allowed.
+          model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
+              contain at least one of `user_prompt` or `system_prompt`. For
+              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.
 
@@ -206,9 +206,9 @@ class AsyncEvaluateResource(AsyncAPIResource):
         guardrail metrics
 
         Args:
-          model_input: A dictionary of inputs sent to the LLM to generate output. This must contain a
-              `user_prompt` field and an optional `context` field. Additional properties are
-              allowed.
+          model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
+              contain at least one of `user_prompt` or `system_prompt`. For
+              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.
 

deeprails/resources/monitor.py

@@ -219,9 +219,9 @@ class MonitorResource(SyncAPIResource):
               `completeness`, `instruction_adherence`, `context_adherence`,
               `ground_truth_adherence`, and/or `comprehensive_safety`.
 
-          model_input: A dictionary of inputs sent to the LLM to generate output. This must contain a
-              `user_prompt` field and an optional `context` field. Additional properties are
-              allowed.
+          model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
+              contain at least one of `user_prompt` or `system_prompt`. For
+              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.
 
@@ -457,9 +457,9 @@ class AsyncMonitorResource(AsyncAPIResource):
               `completeness`, `instruction_adherence`, `context_adherence`,
               `ground_truth_adherence`, and/or `comprehensive_safety`.
 
-          model_input: A dictionary of inputs sent to the LLM to generate output. This must contain a
-              `user_prompt` field and an optional `context` field. Additional properties are
-              allowed.
+          model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
+              contain at least one of `user_prompt` or `system_prompt`. For
+              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.
 

deeprails/types/defend_submit_event_params.py

@@ -2,8 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Dict, Union
-from typing_extensions import Literal, Required, TypeAlias, TypedDict
+from typing_extensions import Literal, Required, TypedDict
 
 __all__ = ["DefendSubmitEventParams", "ModelInput"]
 
@@ -12,8 +11,8 @@ class DefendSubmitEventParams(TypedDict, total=False):
     model_input: Required[ModelInput]
     """A dictionary of inputs sent to the LLM to generate output.
 
-    This must contain a `user_prompt` field and an optional `context` field.
-    Additional properties are allowed.
+    The dictionary must contain at least one of `user_prompt` or `system_prompt`.
+    For ground_truth_aherence guadrail metric, `ground_truth` should be provided.
     """
 
     model_output: Required[str]
@@ -35,10 +34,12 @@ class DefendSubmitEventParams(TypedDict, total=False):
     """An optional, user-defined tag for the event."""
 
 
-class ModelInputTyped(TypedDict, total=False):
-    user_prompt: Required[str]
+class ModelInput(TypedDict, total=False):
+    ground_truth: str
+    """The ground truth for evaluating Ground Truth Adherence guardrail."""
 
-    context: str
+    system_prompt: str
+    """The system prompt used to generate the output."""
 
-
-ModelInput: TypeAlias = Union[ModelInputTyped, Dict[str, object]]
+    user_prompt: str
+    """The user prompt used to generate the output."""

deeprails/types/evaluate_create_params.py

@@ -2,8 +2,8 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Union
-from typing_extensions import Literal, Required, TypeAlias, TypedDict
+from typing import List
+from typing_extensions import Literal, Required, TypedDict
 
 __all__ = ["EvaluateCreateParams", "ModelInput"]
 
@@ -12,8 +12,8 @@ class EvaluateCreateParams(TypedDict, total=False):
     model_input: Required[ModelInput]
     """A dictionary of inputs sent to the LLM to generate output.
 
-    This must contain a `user_prompt` field and an optional `context` field.
-    Additional properties are allowed.
+    The dictionary must contain at least one of `user_prompt` or `system_prompt`.
+    For ground_truth_aherence guadrail metric, `ground_truth` should be provided.
     """
 
     model_output: Required[str]
@@ -51,10 +51,12 @@ class EvaluateCreateParams(TypedDict, total=False):
     """An optional, user-defined tag for the evaluation."""
 
 
-class ModelInputTyped(TypedDict, total=False):
-    user_prompt: Required[str]
+class ModelInput(TypedDict, total=False):
+    ground_truth: str
+    """The ground truth for evaluating Ground Truth Adherence guardrail."""
 
-    context: str
+    system_prompt: str
+    """The system prompt used to generate the output."""
 
-
-ModelInput: TypeAlias = Union[ModelInputTyped, Dict[str, object]]
+    user_prompt: str
+    """The user prompt used to generate the output."""

deeprails/types/evaluation.py

@@ -1,6 +1,6 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import TYPE_CHECKING, Dict, List, Optional
+from typing import Dict, List, Optional
 from datetime import datetime
 from typing_extensions import Literal
 
@@ -12,23 +12,14 @@ __all__ = ["Evaluation", "ModelInput"]
 
 
 class ModelInput(BaseModel):
-    user_prompt: str
-    """The user prompt used to generate the output."""
-
-    context: Optional[str] = None
-    """Optional context supplied to the LLM when generating the output."""
+    ground_truth: Optional[str] = None
+    """The ground truth for evaluating Ground Truth Adherence guardrail."""
 
-    if TYPE_CHECKING:
-        # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a
-        # value to this field, so for compatibility we avoid doing it at runtime.
-        __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+    system_prompt: Optional[str] = None
+    """The system prompt used to generate the output."""
 
-        # Stub to indicate that arbitrary properties are accepted.
-        # To access properties that are not valid identifiers you can use `getattr`, e.g.
-        # `getattr(obj, '$type')`
-        def __getattr__(self, attr: str) -> object: ...
-    else:
-        __pydantic_extra__: Dict[str, object]
+    user_prompt: Optional[str] = None
+    """The user prompt used to generate the output."""
 
 
 class Evaluation(BaseModel):
@@ -41,8 +32,8 @@ class Evaluation(BaseModel):
     api_model_input: ModelInput = FieldInfo(alias="model_input")
     """A dictionary of inputs sent to the LLM to generate output.
 
-    The dictionary must contain a `user_prompt` field and an optional `context`
-    field. Additional properties are allowed.
+    The dictionary must contain at least one of `user_prompt` or `system_prompt`.
+    For ground_truth_aherence guadrail metric, `ground_truth` should be provided.
     """
 
     api_model_output: str = FieldInfo(alias="model_output")

deeprails/types/monitor_submit_event_params.py

@@ -2,8 +2,8 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Union
-from typing_extensions import Literal, Required, TypeAlias, TypedDict
+from typing import List
+from typing_extensions import Literal, Required, TypedDict
 
 __all__ = ["MonitorSubmitEventParams", "ModelInput"]
 
@@ -31,8 +31,8 @@ class MonitorSubmitEventParams(TypedDict, total=False):
     model_input: Required[ModelInput]
     """A dictionary of inputs sent to the LLM to generate output.
 
-    This must contain a `user_prompt` field and an optional `context` field.
-    Additional properties are allowed.
+    The dictionary must contain at least one of `user_prompt` or `system_prompt`.
+    For ground_truth_aherence guadrail metric, `ground_truth` should be provided.
     """
 
     model_output: Required[str]
@@ -54,10 +54,12 @@ class MonitorSubmitEventParams(TypedDict, total=False):
     """
 
 
-class ModelInputTyped(TypedDict, total=False):
-    user_prompt: Required[str]
+class ModelInput(TypedDict, total=False):
+    ground_truth: str
+    """The ground truth for evaluating Ground Truth Adherence guardrail."""
 
-    context: str
+    system_prompt: str
+    """The system prompt used to generate the output."""
 
-
-ModelInput: TypeAlias = Union[ModelInputTyped, Dict[str, object]]
+    user_prompt: str
+    """The user prompt used to generate the output."""

{deeprails-1.4.0.dist-info → deeprails-1.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: deeprails
-Version: 1.4.0
+Version: 1.5.0
 Summary: The official Python library for the deeprails API
 Project-URL: Homepage, https://docs.deeprails.com/
 Project-URL: Repository, https://github.com/deeprails/deeprails-sdk-python

{deeprails-1.4.0.dist-info → deeprails-1.5.0.dist-info}/RECORD

@@ -11,7 +11,7 @@ deeprails/_resource.py,sha256=7RXX5KZr4j0TIE66vnduHp7p9Yf9X0FyDDECuvRHARg,1118
 deeprails/_response.py,sha256=yj0HJDU91WPpiczwi6CBOLAl_bqf4I_I96vWMAwx6Fg,28806
 deeprails/_streaming.py,sha256=hCp5bK9dyw2TyrVL69m-6qGC-QtGYwhXmFzITCWPgAs,10112
 deeprails/_types.py,sha256=XR3mad9NsGqZsjrd1VVJ657-4O4kwyw9Qzg4M3i6Vh0,7239
-deeprails/_version.py,sha256=nMhAqvtoJeGjBNmKA2YxYmQHli9dlJv7NRk8ULgsvMo,161
+deeprails/_version.py,sha256=jCDXp6wEoGAvrBnXqEpS6sMaB-F2z1SwoSA6LKbEblM,161
 deeprails/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 deeprails/_utils/__init__.py,sha256=7fch0GT9zpNnErbciSpUNa-SjTxxjY6kxHxKMOM4AGs,2305
 deeprails/_utils/_compat.py,sha256=D8gtAvjJQrDWt9upS0XaG9Rr5l1QhiAx_I_1utT_tt0,1195
@@ -27,25 +27,25 @@ deeprails/_utils/_typing.py,sha256=N_5PPuFNsaygbtA_npZd98SVN1LQQvFTKL6bkWPBZGU,4
 deeprails/_utils/_utils.py,sha256=0dDqauUbVZEXV0NVl7Bwu904Wwo5eyFCZpQThhFNhyA,12253
 deeprails/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
 deeprails/resources/__init__.py,sha256=ha0jL9Et8fHzPdkTa7ecihYapOC4I6O-PHf2X9igprE,1491
-deeprails/resources/defend.py,sha256=_11GJ0jphqPP7RRPceLHfzyaLf-Mcmi29tinsA0F_cM,27566
-deeprails/resources/evaluate.py,sha256=_jAPyR1ULkz8yrU3nOtwJstdRIoCuwDiT1leAYPQCUY,12907
-deeprails/resources/monitor.py,sha256=hF-aLOS2whKsE-EVdNIj6hPY-YGKpo8xWoAwwCq4B34,22415
+deeprails/resources/defend.py,sha256=oBH27YIClgm8l6jn_4No-JHNKrZl26RPmQJjsbe8vRw,27662
+deeprails/resources/evaluate.py,sha256=eGuPv4kvQd9UPO_8GLcAOe0z6q_Q6zv1Cum2eyrRorU,13003
+deeprails/resources/monitor.py,sha256=uSMhU23FziLy8NWaezqC7RfQ5UqyYTEqaS5FbvIK1vM,22511
 deeprails/types/__init__.py,sha256=tLO-5DMMKt-F4qQYht3F-RFgLbthP-8a36853IhNoGI,1267
 deeprails/types/api_response.py,sha256=eHEQeL677tvm1RK0A_S03EAoprQbJzmHspiKrtjKRt4,1232
 deeprails/types/defend_create_workflow_params.py,sha256=EWYlSeoojWf8pp7VawZh8IbShHWsd0iZfdKq6qlh8OA,2076
 deeprails/types/defend_response.py,sha256=u508zff61fbo7DqotbJLEoYzYg2VUDWbFScx8Ec8EGA,1617
-deeprails/types/defend_submit_event_params.py,sha256=PAmzDkpzaOZjCxGy0c_UTZDvb57N7uhG7NZm5ICRcIg,1376
+deeprails/types/defend_submit_event_params.py,sha256=ZZwHoDz0Q2StafJq7pSLS-ivRSr39pzZJeUC6m63Aqc,1516
 deeprails/types/defend_update_workflow_params.py,sha256=QH2k7EDMLub3mW1lPV5SUoKDHW_T2arSo-RGHLterwo,373
-deeprails/types/evaluate_create_params.py,sha256=8P3jDuSgGRfGSdgq50Zq9J709ZltRZw29hI8R3MoS84,1828
-deeprails/types/evaluation.py,sha256=cLFQtazZyAEOVGkGqQ_VUmCFE8WMS2pBzUPLQ9MioOA,3787
+deeprails/types/evaluate_create_params.py,sha256=xDR0kfjTC2s5Lajc5i8yLwyjWMXunv_JZ4EstYP6dfo,1986
+deeprails/types/evaluation.py,sha256=NMax-Thd9qXKyoo76XfoByhdYH4Ve4yntMnUzp1okBA,3313
 deeprails/types/monitor_create_params.py,sha256=kTSj-PhuzpT-HPDTQJemRWfd8w32foUMH9FQZj8symk,384
 deeprails/types/monitor_retrieve_params.py,sha256=PEsRmbd-81z4pJvhfi4JbrQWNzmeiLkoNsTUoPZ6kFY,352
 deeprails/types/monitor_retrieve_response.py,sha256=BZp7-6PFVdqYU5ZDhbr1Eao3kU132zTm9idgoaA65Gg,2245
-deeprails/types/monitor_submit_event_params.py,sha256=q8Mq24McRr1WdXQ8L1YunKqLBb9-u91J2MLmhUCdaIw,1991
+deeprails/types/monitor_submit_event_params.py,sha256=PQwn2wH8F0uMmVGg7KyMIBbbExtHE5onZrzIXkz3NGs,2149
 deeprails/types/monitor_submit_event_response.py,sha256=qlraxIJaclNSR_JOizMPj9gOiz-0x7lIChSX3DmFllM,867
 deeprails/types/monitor_update_params.py,sha256=gJyFFxT_u_iWABknuKnLpPl9r-VPfCcGtOAmh6sPwUw,550
 deeprails/types/workflow_event_response.py,sha256=mIzOCnYJg4TDSq_tG_0WfA0_Gmc9-0q-befyookfUFM,867
-deeprails-1.4.0.dist-info/METADATA,sha256=XK3jbhDy18tMUqJk5AJZyNQqB2rQ3kEwHTmdp8Jmkog,11840
-deeprails-1.4.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-deeprails-1.4.0.dist-info/licenses/LICENSE,sha256=rFTxPcYE516UQLju2SCY1r2pSDDfodL0-ZvxF_fgueg,11339
-deeprails-1.4.0.dist-info/RECORD,,
+deeprails-1.5.0.dist-info/METADATA,sha256=wfmdxH8g3LT2DmuNdXZs6rXpxgKK4__pvRfGf5u2ifU,11840
+deeprails-1.5.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+deeprails-1.5.0.dist-info/licenses/LICENSE,sha256=rFTxPcYE516UQLju2SCY1r2pSDDfodL0-ZvxF_fgueg,11339
+deeprails-1.5.0.dist-info/RECORD,,