root.client
===========

.. py:module:: root.client


Classes
-------

.. autoapisummary::

   root.client.RootSignals


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

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

   Root Signals 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 RootSignals constructor    ,
   2. environment variable `ROOTSIGNALS_API_KEY`, or
   3. .env file containing `ROOTSIGNALS_API_KEY=`

   :param api_key: Root Signals API Key (if not provided from environment)
   :param base_url: Root Signals base URL to use (default is fine)


   .. py:attribute:: api_key


   .. py:attribute:: base_url


   .. py:property:: datasets
      :type: root.datasets.DataSets


      Get DataSets API


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


      Get Evaluators API


   .. py:property:: execution_logs
      :type: root.execution_logs.ExecutionLogs


      Get Execution Logs API


   .. py:property:: get_api_client
      :type: Union[root.generated.openapi_client.ApiClient, root.generated.openapi_aclient.ApiClient]



   .. py:property:: models
      :type: root.models.Models


      Get Models API


   .. py:property:: objectives
      :type: root.objectives.Objectives


      Get Objectives API


   .. py:attribute:: run_async


   .. py:property:: skills
      :type: root.skills.Skills


      Get Skills API