Merge pull request #23 from root-signals/sdk-v1.5.2

version 1.5.2

Author: kkjarvis

docs/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 1.5.2
+
+### Added
+
+- Added evaluator execution by name
+
+### Changed
+
+- Evaluator uses new endpoints instead of deprecated ones in all functions
+
 ## 1.5.1
 
 ### Added

examples/run_evaluator_by_name.py

@@ -0,0 +1,48 @@
+from root import RootSignals
+
+client = RootSignals()
+
+# Run a root evaluator by name using the run_by_name method
+result = client.evaluators.run_by_name(
+    name="Helpfulness",
+    response="You can find the instructions from our Careers page.",
+    request="Where can I find the application instructions?",
+)
+
+print(f"Score: {result.score} / 1.0")
+print(f"Justification: {result.justification}")
+
+# Run a custom evaluator by name
+# Assuming you have created a custom evaluator named "Network Troubleshooting"
+try:
+    custom_result = client.evaluators.run_by_name(
+        name="Network Troubleshooting",
+        request="My internet is not working.",
+        response="""
+        I'm sorry to hear that your internet isn't working.
+        Let's troubleshoot this step by step:
+        1. Check if your router is powered on and all cables are properly connected
+        2. Try restarting your router and modem
+        3. Check if other devices can connect to the network
+        4. Try connecting to a different network if available
+        """,
+    )
+
+    print(f"Score: {custom_result.score} / 1.0")
+    print(f"Justification: {custom_result.justification}")
+except Exception as e:
+    print(f"Error: {e}")
+    print(
+        "Note: This example requires that you have previously created a custom evaluator named 'Network Troubleshooting'"
+    )
+
+result_with_context = client.evaluators.run_by_name(
+    name="Context_Precision",
+    response="The capital of France is Paris, which is known for the Eiffel Tower.",
+    request="What is the capital of France?",
+    contexts=["France is a country in Western Europe with a population of about 67 million people."],
+    variables={"criteria": "geographical accuracy"},
+)
+
+print(f"Score: {result_with_context.score} / 1.0")
+print(f"Justification: {result_with_context.justification}")

src/root/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2024-present juho.ylikyla <[email protected]>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "1.5.1"
+__version__ = "1.5.2"