deeprails 1.7.0__py3-none-any.whl → 1.8.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.7.0"  # x-release-please-version
+__version__ = "1.8.0"  # x-release-please-version

deeprails/resources/defend.py

@@ -214,8 +214,8 @@ class DefendResource(SyncAPIResource):
 
         Args:
           model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
-              contain at least `user_prompt` or `system_prompt` field. For
-              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+              contain at least `user_prompt` or `system_prompt` field. For the
+              ground_truth_adherence guardrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.
 
@@ -492,8 +492,8 @@ class AsyncDefendResource(AsyncAPIResource):
 
         Args:
           model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
-              contain at least `user_prompt` or `system_prompt` field. For
-              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+              contain at least `user_prompt` or `system_prompt` field. For the
+              ground_truth_adherence guardrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.
 

deeprails/resources/evaluate.py

@@ -77,7 +77,7 @@ class EvaluateResource(SyncAPIResource):
         Args:
           model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
               contain at least `user_prompt` or `system_prompt` field. For
-              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+              ground_truth_adherence guardrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.
 
@@ -208,7 +208,7 @@ class AsyncEvaluateResource(AsyncAPIResource):
         Args:
           model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
               contain at least `user_prompt` or `system_prompt` field. For
-              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+              ground_truth_adherence guardrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.
 

deeprails/resources/monitor.py

@@ -221,7 +221,7 @@ class MonitorResource(SyncAPIResource):
 
           model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
               contain at least a `user_prompt` or `system_prompt` field. For
-              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+              ground_truth_adherence guardrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.
 
@@ -459,7 +459,7 @@ class AsyncMonitorResource(AsyncAPIResource):
 
           model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
               contain at least a `user_prompt` or `system_prompt` field. For
-              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+              ground_truth_adherence guardrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.
 

deeprails/types/defend_submit_event_params.py

@@ -12,7 +12,7 @@ class DefendSubmitEventParams(TypedDict, total=False):
     """A dictionary of inputs sent to the LLM to generate output.
 
     The dictionary must contain at least `user_prompt` or `system_prompt` field. For
-    ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+    the ground_truth_adherence guardrail metric, `ground_truth` should be provided.
     """
 
     model_output: Required[str]

deeprails/types/evaluate_create_params.py

@@ -13,7 +13,7 @@ class EvaluateCreateParams(TypedDict, total=False):
     """A dictionary of inputs sent to the LLM to generate output.
 
     The dictionary must contain at least `user_prompt` or `system_prompt` field. For
-    ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+    ground_truth_adherence guardrail metric, `ground_truth` should be provided.
     """
 
     model_output: Required[str]

deeprails/types/evaluation.py

@@ -33,7 +33,7 @@ class Evaluation(BaseModel):
     """A dictionary of inputs sent to the LLM to generate output.
 
     The dictionary must contain at least `user_prompt` or `system_prompt` field. For
-    ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+    ground_truth_adherence guardrail metric, `ground_truth` should be provided.
     """
 
     api_model_output: str = FieldInfo(alias="model_output")

deeprails/types/monitor_submit_event_params.py

@@ -32,7 +32,7 @@ class MonitorSubmitEventParams(TypedDict, total=False):
     """A dictionary of inputs sent to the LLM to generate output.
 
     The dictionary must contain at least a `user_prompt` or `system_prompt` field.
-    For ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+    For ground_truth_adherence guardrail metric, `ground_truth` should be provided.
     """
 
     model_output: Required[str]

{deeprails-1.7.0.dist-info → deeprails-1.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: deeprails
-Version: 1.7.0
+Version: 1.8.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
@@ -69,6 +69,10 @@ defend_response = client.defend.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
     type="custom",
+    custom_hallucination_threshold_values={
+        "completeness": 0.7,
+        "instruction_adherence": 0.75,
+    },
 )
 print(defend_response.workflow_id)
 ```
@@ -97,6 +101,10 @@ async def main() -> None:
         improvement_action="fixit",
         name="Push Alert Workflow",
         type="custom",
+        custom_hallucination_threshold_values={
+            "completeness": 0.7,
+            "instruction_adherence": 0.75,
+        },
     )
     print(defend_response.workflow_id)
 
@@ -134,6 +142,10 @@ async def main() -> None:
             improvement_action="fixit",
             name="Push Alert Workflow",
             type="custom",
+            custom_hallucination_threshold_values={
+                "completeness": 0.7,
+                "instruction_adherence": 0.75,
+            },
         )
         print(defend_response.workflow_id)
 
@@ -189,6 +201,10 @@ try:
         improvement_action="fixit",
         name="Push Alert Workflow",
         type="custom",
+        custom_hallucination_threshold_values={
+            "completeness": 0.7,
+            "instruction_adherence": 0.75,
+        },
     )
 except deeprails.APIConnectionError as e:
     print("The server could not be reached")
@@ -236,6 +252,10 @@ client.with_options(max_retries=5).defend.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
     type="custom",
+    custom_hallucination_threshold_values={
+        "completeness": 0.7,
+        "instruction_adherence": 0.75,
+    },
 )
 ```
 
@@ -263,6 +283,10 @@ client.with_options(timeout=5.0).defend.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
     type="custom",
+    custom_hallucination_threshold_values={
+        "completeness": 0.7,
+        "instruction_adherence": 0.75,
+    },
 )
 ```
 
@@ -308,6 +332,10 @@ response = client.defend.with_raw_response.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
     type="custom",
+    custom_hallucination_threshold_values={
+        "completeness": 0.7,
+        "instruction_adherence": 0.75,
+    },
 )
 print(response.headers.get('X-My-Header'))
 
@@ -330,6 +358,10 @@ with client.defend.with_streaming_response.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
     type="custom",
+    custom_hallucination_threshold_values={
+        "completeness": 0.7,
+        "instruction_adherence": 0.75,
+    },
 ) as response:
     print(response.headers.get("X-My-Header"))
 

{deeprails-1.7.0.dist-info → deeprails-1.8.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=YHKK91JaYK_no60ap2JlKWyIwHFkmLObGPVTl_njTPk,161
+deeprails/_version.py,sha256=V8Z_1JKT_bgLyhd5iqPYjkEjv9Mii5vfV23cYHHyts8,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=wN1AvMBo1E6fIkVUQJn_xykL5SeZ2B7THGyxiXDcbig,28146
-deeprails/resources/evaluate.py,sha256=i0uZZHab7A0THAvhsGPxyiNSZt3_s7CLyW7tR_PLaT4,13001
-deeprails/resources/monitor.py,sha256=OVG0fIZF1ztN2ABtQXjjGKGPd2-5fyCxXAaSIO7j0bQ,22513
+deeprails/resources/defend.py,sha256=TRuF6F3YEmgGBkJRxf8Mx6JofmZjstUeLTUpHV0S4gQ,28158
+deeprails/resources/evaluate.py,sha256=uoElGfpFyH-bO8cbq-2xM2bgfKsQN3P6YF8nmEAPugg,13005
+deeprails/resources/monitor.py,sha256=bFCz3t8-wweF76KZoD3n8jHY-xtL8ZA7S-3eI1FiHik,22517
 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=b2wWr-DtON4XcbPyKD45oO7016F4ji5LoIqyNdM3B5k,2101
 deeprails/types/defend_response.py,sha256=sIS9nBgW2a_yBYxVWo33pgy1IKEn-m4AzamOr5Eov5g,1602
-deeprails/types/defend_submit_event_params.py,sha256=zT_Jf6wfb7P_e67CqrbI34ys6JxLbLbydRdSb_Ylx80,1515
+deeprails/types/defend_submit_event_params.py,sha256=nbrszvTg_I8WEZJe6hPzP22pCC8Fkp60nmgH3p211uU,1521
 deeprails/types/defend_update_workflow_params.py,sha256=QH2k7EDMLub3mW1lPV5SUoKDHW_T2arSo-RGHLterwo,373
-deeprails/types/evaluate_create_params.py,sha256=12xRsjf8SyfWxcxIk6Rs7DSMDN8wGlNWQm015UBJifI,1985
-deeprails/types/evaluation.py,sha256=XKXmzQfKcCzrYH3BoFYxl_46M04MUQZTh0rAKLmtN-Q,3312
+deeprails/types/evaluate_create_params.py,sha256=B_WthHkJJzH7vjvKYd_PhJcQTilOhUsMBd6mz5hxGbQ,1987
+deeprails/types/evaluation.py,sha256=GAzuZMOD51bCNVLUeROO4Vi26j3DE3kEIRFf9-UfZjQ,3314
 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=xIiZxkYz-uuAy1AQb7SY5MD3r38L5p5IUE14gf-g8xU,2150
+deeprails/types/monitor_submit_event_params.py,sha256=d2AzwBe-d0tBfvnknfy0fGCrCCd0GC2kJb1AXbje3cg,2152
 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.7.0.dist-info/METADATA,sha256=8aWnlEA5RbZSFo-JgYs0ZJaUExVdgWNprA91lBgiJ4M,11064
-deeprails-1.7.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-deeprails-1.7.0.dist-info/licenses/LICENSE,sha256=rFTxPcYE516UQLju2SCY1r2pSDDfodL0-ZvxF_fgueg,11339
-deeprails-1.7.0.dist-info/RECORD,,
+deeprails-1.8.0.dist-info/METADATA,sha256=taDsSz0VVSWTfKlHscWkFvDJPNLZz-ALaMMo9MfLjsc,12080
+deeprails-1.8.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+deeprails-1.8.0.dist-info/licenses/LICENSE,sha256=rFTxPcYE516UQLju2SCY1r2pSDDfodL0-ZvxF_fgueg,11339
+deeprails-1.8.0.dist-info/RECORD,,