flip_api.domain.schemas.private
===============================

.. py:module:: flip_api.domain.schemas.private


Classes
-------

.. autoapisummary::

   flip_api.domain.schemas.private.Results
   flip_api.domain.schemas.private.OmopData
   flip_api.domain.schemas.private.OmopCohortResults
   flip_api.domain.schemas.private.TrainingMetrics
   flip_api.domain.schemas.private.TrainingLog
   flip_api.domain.schemas.private.ProjectApprovalBody
   flip_api.domain.schemas.private.ProjectApproval
   flip_api.domain.schemas.private.TrustSpecificData
   flip_api.domain.schemas.private.AggregatedTrustFieldResult
   flip_api.domain.schemas.private.AggregatedFieldResult
   flip_api.domain.schemas.private.AggregatedCohortStats
   flip_api.domain.schemas.private.FetchedAggregationData
   flip_api.domain.schemas.private.TrustTaskResponse
   flip_api.domain.schemas.private.TaskResultInput


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

.. py:class:: Results

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: value
      :type:  str


   .. py:attribute:: count
      :type:  int


.. py:class:: OmopData

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: results
      :type:  list[Results]


.. py:class:: OmopCohortResults

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: query_id
      :type:  uuid.UUID


   .. py:attribute:: trust_id
      :type:  uuid.UUID


   .. py:attribute:: created
      :type:  str


   .. py:attribute:: record_count
      :type:  int


   .. py:attribute:: data
      :type:  list[OmopData]


   .. py:attribute:: error
      :type:  str | None
      :value: None



   .. py:attribute:: suppressed
      :type:  bool
      :value: False



   .. py:method:: ensure_data_is_list(value: Any) -> list[Any]


.. py:class:: TrainingMetrics

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: fl_client_name
      :type:  str


   .. py:attribute:: global_round
      :type:  int


   .. py:attribute:: label
      :type:  str


   .. py:attribute:: result
      :type:  float


.. py:class:: TrainingLog

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: fl_client_name
      :type:  str


   .. py:attribute:: log
      :type:  str


.. py:class:: ProjectApprovalBody

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: trusts
      :type:  list[uuid.UUID]


.. py:class:: ProjectApproval

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: project_id
      :type:  uuid.UUID


   .. py:attribute:: trust_ids
      :type:  list[uuid.UUID]


.. py:class:: TrustSpecificData

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: record_count
      :type:  int


   .. py:attribute:: data
      :type:  list[OmopData]


   .. py:attribute:: error
      :type:  str | None
      :value: None



   .. py:attribute:: suppressed
      :type:  bool
      :value: False



.. py:class:: AggregatedTrustFieldResult

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: data
      :type:  Any


   .. py:attribute:: trust_name
      :type:  str


   .. py:attribute:: trust_id
      :type:  str


.. py:class:: AggregatedFieldResult

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: results
      :type:  list[AggregatedTrustFieldResult]


.. py:class:: AggregatedCohortStats

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: record_count
      :type:  int


   .. py:attribute:: trusts_results
      :type:  list[AggregatedFieldResult]


   .. py:attribute:: trust_record_counts
      :type:  dict[str, int]


   .. py:attribute:: trust_errors
      :type:  dict[str, str]


   .. py:attribute:: trust_suppressed
      :type:  list[str]


.. py:class:: FetchedAggregationData

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: trust_name
      :type:  list[str]


   .. py:attribute:: trust_id
      :type:  list[str]


   .. py:attribute:: data
      :type:  list[str]


.. py:class:: TrustTaskResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Response model for a single trust task.


   .. py:attribute:: id
      :type:  uuid.UUID


   .. py:attribute:: task_type
      :type:  flip_api.domain.schemas.status.TaskType


   .. py:attribute:: payload
      :type:  str


   .. py:attribute:: created_at
      :type:  datetime.datetime


.. py:class:: TaskResultInput

   Bases: :py:obj:`pydantic.BaseModel`


   Input model for submitting a task result.


   .. py:attribute:: success
      :type:  bool


   .. py:attribute:: result
      :type:  str | None