scorable 1.6.4__py3-none-any.whl

root/utils.py

@@ -0,0 +1,90 @@
+from contextlib import AbstractAsyncContextManager, AbstractContextManager
+from typing import (
+    Any,
+    AsyncContextManager,
+    AsyncIterator,
+    Callable,
+    ContextManager,
+    Generic,
+    Iterator,
+    List,
+    Optional,
+    TypeVar,
+    Union,
+)
+
+from pydantic import StrictStr
+from typing_extensions import TypeAlias
+
+from .generated import openapi_aclient, openapi_client
+
+T = TypeVar("T")
+
+
+ClientContextCallable: TypeAlias = Union[
+    Callable[[], ContextManager[openapi_client.ApiClient]], Callable[[], AsyncContextManager[openapi_aclient.ApiClient]]
+]
+
+
+# This is internal generic class only to handle duck typing of the
+# local codes' correctness.
+#
+# The original classes returned by partial_list may or may not have
+# anything to do with this (in practise they are pydantic BaseModel
+# subclasses that have no shared superclass unfortunately).
+#
+# Update November 2024. - This does not work well with our async iterators
+# since we end up in a nested async iterator situation. Not DRY.
+# Usable and left in one place with test for convenience.s
+class _PartialResult(Generic[T]):
+    next: Optional[StrictStr] = None
+    results: Optional[List[T]] = None
+
+
+async def aiterate_cursor_list(partial_list: Any, *, limit: int) -> AsyncIterator[T]:
+    # TODO: it would be nice to type partial_list correctly.
+    cursor: Optional[StrictStr] = None
+    while limit > 0:
+        result: _PartialResult[T] = await partial_list(page_size=limit, cursor=cursor)
+        if not result.results:
+            return
+
+        used_results = result.results[:limit]
+        yield used_results  # type: ignore[misc]
+        limit -= len(used_results)
+        if not (cursor := result.next):
+            return
+
+
+def iterate_cursor_list(partial_list: Any, *, limit: int) -> Iterator[T]:
+    # TODO: it would be nice to type partial_list correctly.
+    cursor: Optional[StrictStr] = None
+    while limit > 0:
+        result: _PartialResult[T] = partial_list(page_size=limit, cursor=cursor)
+        if not result.results:
+            return
+        used_results = result.results[:limit]
+        yield from used_results
+        limit -= len(used_results)
+        if not (cursor := result.next):
+            return
+
+
+def with_sync_client(func: Callable) -> Callable:
+    def wrapper(self: Any, *args: Any, **kwargs: Any) -> Any:
+        context = self.client_context()
+        assert isinstance(context, AbstractContextManager), "This method is not available in asynchronous mode"
+        with context as client:
+            return func(self, *args, _client=client, **kwargs)
+
+    return wrapper
+
+
+def with_async_client(func: Callable) -> Callable:
+    async def wrapper(self: Any, *args: Any, **kwargs: Any) -> Any:
+        context = self.client_context()
+        assert isinstance(context, AbstractAsyncContextManager), "This method is not available in synchronous mode"
+        async with context as client:
+            return await func(self, *args, _client=client, **kwargs)
+
+    return wrapper

scorable-1.6.4.dist-info/METADATA

@@ -0,0 +1,395 @@
+Metadata-Version: 2.4
+Name: scorable
+Version: 1.6.4
+Summary: The Python SDK for API of Scorable
+Project-URL: Homepage, https://rootsignals.ai/
+Project-URL: Repository, https://github.com/root-signals/rs-python-sdk
+Project-URL: CHANGELOG, https://sdk.rootsignals.ai/en/latest/CHANGELOG.html
+Maintainer-email: Ari Heljakka <ari.heljakka@scorable.ai>
+License: 
+                                         Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright [yyyy] [name of copyright owner]
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: aiohttp
+Requires-Dist: aiohttp-retry
+Requires-Dist: aioitertools
+Requires-Dist: asgiref
+Requires-Dist: pydantic<3,>=2.6.2
+Requires-Dist: python-dateutil
+Requires-Dist: requests
+Requires-Dist: typing-extensions
+Requires-Dist: validators
+Provides-Extra: dev
+Requires-Dist: furo; extra == 'dev'
+Requires-Dist: hatch; extra == 'dev'
+Requires-Dist: mypy==1.14.1; extra == 'dev'
+Requires-Dist: myst-parser; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: sphinx; extra == 'dev'
+Requires-Dist: sphinx-autoapi; extra == 'dev'
+Requires-Dist: sphinx-markdown-builder; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Requires-Dist: types-requests; extra == 'dev'
+Requires-Dist: validators; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<h1 align="center">
+  <img width="600" alt="Scorable logo" src="https://app.rootsignals.ai/images/root-signals-color.svg" loading="lazy">
+</h1>
+
+  <!-- This is commented so it is easier to sync with the docs/index.rst -->
+
+<p align="center" class="large-text">
+  <i><strong>Measurement & Control for LLM Automations</strong></i>
+</p>
+
+<p align="center">
+    <a href="https://pypi.org/project/root-signals/">
+      <img alt="Supported Python versions" src="https://img.shields.io/badge/Python-3.10%20to%203.13-yellow?style=for-the-badge&logo=python&logoColor=yellow">
+    </a>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/root-signals">
+    <img src="https://img.shields.io/pypi/v/root-signals" alt="PyPI">
+  </a>
+  <img src="https://img.shields.io/pypi/dm/root-signals?color=orange" alt="Downloads">
+  <a href="https://github.com/root-signals/rs-python-sdk/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/root-signals/rs-python-sdk.svg" alt="License">
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://app.rootsignals.ai/register">
+    <img src="https://img.shields.io/badge/Get_Started-2E6AFB?style=for-the-badge&logo=rocket&logoColor=white&scale=2" />
+  </a>
+
+  <a href="https://huggingface.co/root-signals">
+    <img src="https://img.shields.io/badge/HuggingFace-FF9D00?style=for-the-badge&logo=huggingface&logoColor=white&scale=2" />
+  </a>
+
+  <a href="https://discord.gg/QbDAAmW9yz">
+    <img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white&scale=2" />
+  </a>
+
+  <a href="https://sdk.rootsignals.ai/en/latest/">
+    <img src="https://img.shields.io/badge/Documentation-E53935?style=for-the-badge&logo=readthedocs&logoColor=white&scale=2" />
+  </a>
+
+  <a href="https://app.rootsignals.ai/demo-user">
+    <img src="https://img.shields.io/badge/Temporary_API_Key-15a20b?style=for-the-badge&logo=keycdn&logoColor=white&scale=2" />
+  </a>
+</p>
+
+**Scorable** streamlines the evaluation of your LLM and agentic pipelines. We provide a holistic approach to GenAI measurability & observability with **carefully-crafted ready-to-use evaluators** based on cutting-edge LLM research as well as a framework for systematically adding **your own custom evaluators**.
+
+With Scorable you can develop your LLM application reliably, deploy them in confidence, and ensure optimal performance with continuous monitoring.
+
+## 📦 Install
+
+```bash
+pip install scorable
+```
+
+## ⚡ Quickstart
+
+### 🔑 Get Your API Key
+[Sign up & create a key](https://app.rootsignals.ai/settings/api-keys) or [generate a temporary key](https://app.rootsignals.ai/demo-user)
+
+**Setup Option 1: Environment Variable**
+```bash
+export ROOTSIGNALS_API_KEY=your-Root-API-key
+```
+
+**Setup Option 2: `.env` File**
+```bash
+echo ROOTSIGNALS_API_KEY=your-Root-API-key >> .env
+```
+
+### *Root* Evaluators
+```python
+from root import RootSignals
+
+# Connect to Scorable API
+client = RootSignals()
+
+# Run any of our ready-made evaluators
+result = client.evaluators.Politeness(
+    response="You can find the instructions from our Careers page."
+)
+# Example result:
+#   {
+#     "score": 0.7, --> a normalized score between [0, 1]
+#     "justification": "The response is st...",
+#     "execution_log_id": "..."
+#   }
+```
+
+Check the full list of *Root* evaluators from the [Root evaluators documentation](https://docs.rootsignals.ai/quick-start/usage/evaluators#list-of-evaluators-maintained-by-root-signals). You can also [add your own custom evaluators](https://sdk.rootsignals.ai/en/latest/examples.html#custom-evaluator).
+
+
+## 📖 Documentation
+
+| Resource | Link |
+|----------|------|
+| 🐍 Python SDK | [View Documentation](https://sdk.rootsignals.ai) |
+| 📘 Product Docs | [View Documentation](https://docs.rootsignals.ai) |
+| 📑 API Docs | [View Documentation](https://api.docs.rootsignals.ai/) |
+| 🔌 MCP | [View Repo](https://github.com/root-signals/root-signals-mcp) |
+
+<table>
+  <thead>
+    <tr>
+      <th>Tutorial</th>
+      <th>Link</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td style="text-align: right;"><em>Quickstart</em></td>
+      <td>
+        <a href="https://colab.research.google.com/drive/1ztDFIItKGEruDD2SOiixatm4klxpT6Of?usp=sharing">
+          <img alt="Quickstart in Colab" src="https://colab.research.google.com/assets/colab-badge.svg">
+        </a>
+      </td>
+    </tr>
+    <tr>
+      <td style="text-align: right;"><em>Tuning a Custom Judge</em></td>
+      <td>
+        <a href="https://colab.research.google.com/drive/1Rz6h9wWFK97g08RTQGyi6JV1bJLk5Dwf?usp=sharing">
+          <img alt="Tuning a Custom Judge in Colab" src="https://colab.research.google.com/assets/colab-badge.svg">
+        </a>
+      </td>
+    </tr>
+    <tr>
+      <td style="text-align: right;"><em>RAG Hallucination Detection with Root Judge</em></td>
+      <td>
+        <a href="https://colab.research.google.com/drive/1A1mmE2jHVntSJiXzBIpMpDjxrtgWC8uq?usp=sharing">
+          <img alt="RAG Hallucination Detection in Colab" src="https://colab.research.google.com/assets/colab-badge.svg">
+        </a>
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+## 🌍 Community
+
+💬 Welcome to our [Discord Server](https://discord.gg/EhazTQsFnj)! It's a great place to ask questions, get help, and discuss ideas.