scorable.client
===============

.. py:module:: scorable.client


Classes
-------

.. autoapisummary::

   scorable.client.Beta
   scorable.client.Scorable


Module Contents
---------------

.. py:class:: Beta(get_client_context: Union[Callable[[], AsyncContextManager[scorable.generated.openapi_aclient.ApiClient]], Callable[[], ContextManager[scorable.generated.openapi_client.ApiClient]]])

   Beta API features namespace


   .. py:property:: judges
      :type: scorable.judges.Judges


      Get Judges API (Beta)


.. py:class:: Scorable(api_key: Optional[str] = None, *, run_async: bool = False, _api_client: Union[Optional[scorable.generated.openapi_aclient.ApiClient], Optional[scorable.generated.openapi_client.ApiClient]] = None, base_url: Optional[str] = None)

   Scorable API Python client.

   The API key must be provided via one of the following methods - the code uses the first one that is found:

   1. as an argument to Scorable constructor,
   2. environment variable `SCORABLE_API_KEY`, or
   3. .env file containing `SCORABLE_API_KEY=`

   :param api_key: Scorable API Key (if not provided from environment)
   :param run_async: Whether to run the API client asynchronously


   .. py:attribute:: api_key
      :value: None



   .. py:attribute:: base_url
      :value: None



   .. py:property:: beta
      :type: Beta


      Get Beta API features


   .. py:property:: datasets
      :type: scorable.datasets.DataSets


      Get DataSets API


   .. py:property:: evaluators
      :type: scorable.skills.Evaluators


      Get Evaluators API


   .. py:property:: execution_logs
      :type: scorable.execution_logs.ExecutionLogs


      Get Execution Logs API


   .. py:property:: get_client_context
      :type: Union[Callable[[], AsyncContextManager[scorable.generated.openapi_aclient.ApiClient]], Callable[[], ContextManager[scorable.generated.openapi_client.ApiClient]]]



   .. py:property:: judges
      :type: scorable.judges.Judges


      Get Judges API


   .. py:property:: models
      :type: scorable.models.Models


      Get Models API


   .. py:property:: objectives
      :type: scorable.objectives.Objectives


      Get Objectives API


   .. py:attribute:: run_async
      :value: False