retuve.app.classes

  1# Copyright 2024 Adam McArthur
  2#
  3# Licensed under the Apache License, Version 2.0 (the "License");
  4# you may not use this file except in compliance with the License.
  5# You may obtain a copy of the License at
  6#
  7#     http://www.apache.org/licenses/LICENSE-2.0
  8#
  9# Unless required by applicable law or agreed to in writing, software
 10# distributed under the License is distributed on an "AS IS" BASIS,
 11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12# See the License for the specific language governing permissions and
 13# limitations under the License.
 14
 15"""
 16All the input/output structure classes used to power the Retuve API.
 17"""
 18
 19from enum import Enum
 20from typing import List, Optional
 21
 22from pydantic import BaseModel
 23
 24from retuve.hip_us.classes.general import Metric2D, Metric3D
 25
 26
 27class FileEnum(str, Enum):
 28    PENDING = "pending"
 29    COMPLETED = "completed"
 30    IMCOMPLETE = "incomplete"
 31    FAILED = "failed"
 32    DEAD = "dead"
 33    DEAD_WITH_RESULTS = "dead_with_results"
 34
 35    def __str__(self):
 36        return self.name
 37
 38
 39class Metric2D(BaseModel):
 40    """
 41    Any 2D metric.
 42    """
 43
 44    name: str
 45    value: float
 46
 47
 48class Metric3D(BaseModel):
 49    """
 50    Any 3D metric.
 51    """
 52
 53    name: str
 54    post: float
 55    graf: float
 56    ant: float
 57    full: float
 58
 59
 60class ModelResponse(BaseModel):
 61    """
 62    The output of a Retuve Model.
 63    """
 64
 65    notes: str
 66    metrics_3d: Optional[List[Metric3D]]
 67    metrics_2d: Optional[List[Metric2D]]
 68    video_url: Optional[str]
 69    figure_url: Optional[str]
 70    img_url: Optional[str]
 71    retuve_version: str
 72    keyphrase_name: str
 73
 74
 75class LiveResponse(BaseModel):
 76    file_id: str
 77    video_url: str
 78    img_url: str
 79
 80
 81class File(BaseModel):
 82    """
 83    The details attached to any file analyzed by Retuve.
 84    """
 85
 86    file_id: str
 87    state: FileEnum
 88    metrics_url: str
 89    video_url: str
 90    img_url: str
 91    figure_url: str
 92    attempts: int
 93
 94
 95class SystemFiles(BaseModel):
 96    """
 97    The files in the Retuve System.
 98    """
 99
100    states: List[File]
101    length: int
102
103
104class FeedbackRequest(BaseModel):
105    """
106    The feedback request for any file.
107    """
108
109    file_id: str
110    feedback: str