Skip to content

Schemas

PredictPayload

Bases: BaseModel

Content declaration of the request body to keyless read.

Source code in src/trecover/app/api/schemas.py
class PredictPayload(BaseModel):
    """ Content declaration of the request body to keyless read. """

    columns: List[str]
    beam_width: int
    delimiter: Optional[str] = ''

    @validator('columns')
    def columns_validator(cls, columns: List[str]) -> List[str]:
        """
        Check columns to keyless read.

        Parameters
        ----------
        columns: List[str]
            Columns to keyless read

        Returns
        -------
        data : List[str]
            Columns to keyless read.

        Raises
        ------
        ValueError:
            If at least one column is empty.

        """

        if any([len(column) == 0 for column in columns]):
            raise ValueError(f'Columns to keyless read must contain at least one character')

        return columns

    @validator('beam_width')
    def beam_width_validator(cls, beam_width: int) -> int:
        """
        Check columns to keyless read.

        Parameters
        ----------
        beam_width: int
            Columns to keyless read

        Returns
        -------
        beam_width : int
            Width of beam search algorithm.

        Raises
        ------
        ValueError:
            If the beam width is out of range.

        """

        if not 1 <= beam_width <= len(var.ALPHABET):
            raise ValueError(f'Beam width must be in between 1 and {len(var.ALPHABET)}')

        return beam_width

    class Config:
        """ PredictPayload example for API documentation"""

        schema_extra = {
            'example': {
                'columns': [
                    'adin', 'scjz', 'pzxz', 'evft', 'odev', 'pkzc', 'lipss', 'eayh', 'aepqc', 'rvuqh', 'ozldx',
                    'ulgq', 'nabhr', 'dvvf', 'tmil', 'huiow', 'euzq', 'cdmh', 'ompzv', 'uguq', 'ntvqi', 'tctm',
                    'rwgi', 'yuonh', 'wkvr', 'efau', 'nrele', 'tbhxq', 'iiqd', 'nhwfy', 'tymio', 'onzpj', 'turho',
                    'hhgnd', 'ehmof', 'scpoi', 'tyqbn', 'roul', 'exoe', 'edwyc', 'thid', 'snqrp', 'tmmh', 'oejg',
                    'cjbaw', 'hgzmb', 'ezlwj', 'esxb', 'rria', 'taeo', 'hpnln', 'eeomf', 'cvxr', 'ofwy', 'nuon',
                    'vvex', 'ikbd', 'cmusb', 'tdnkb', 'iccd', 'ocay', 'nnxds', 'slbgd', 'oupap', 'mhip', 'ebtv',
                    'bipta', 'unazv', 'sccol', 'iovq', 'nxzev', 'ezaz', 'sakm', 'skls', 'eipvd', 'segz', 'inrlo',
                    'nzkug', 'puau', 'oolt', 'recs', 'tjot', 'lwds', 'assb', 'ntyzf', 'dpad', 'byep', 'owgol',
                    'aiwbb', 'ralk', 'dffos', 'ejfp', 'dwyug', 'uxucm', 'ppch', 'teznz', 'hpfbv', 'eaocf', 'iist',
                    'rdlyx', 'wseu', 'ivgg', 'nabi', 'dtuiw', 'oxzje', 'wderj', 'sawm', 'odpw', 'noqs', 'cimnf',
                    'eukjx', 'aszy', 'ghmiq', 'ajcsd', 'ipwgf', 'nhth', 'tpvfp', 'hnede', 'aclb', 'tteuq', 'nbvi',
                    'isgc', 'gejbz', 'hufnl', 'tggvn', 'aahfn', 'skkxl', 'mmwq', 'anqgw', 'lrvji', 'lker', 'gvqt',
                    'rdcd', 'obvt', 'ussht', 'piwb', 'ozbn', 'fyig', 'aczx', 'clak', 'tgnxi', 'iieyi', 'vqyqo',
                    'ijgp', 'shfth', 'tnbeg', 'sbuzx', 'wwnja', 'eguhn', 'aneai', 'rpsl', 'izut', 'njixa', 'grgh',
                    'bkypw', 'lliv', 'azeob', 'cojl', 'kmqnd', 'ahpq', 'pckw', 'phvpa', 'rgqv', 'opqby', 'aiqsp',
                    'clirf', 'hlrp', 'eztn', 'dgek', 'azubn', 'gnskd', 'rajo', 'okgv', 'ugcp', 'pilf', 'oxbx',
                    'fwqq', 'jsmf', 'okgw', 'uvjyg', 'rfio', 'nbtcy', 'aryp', 'ledgj', 'inex', 'sdqmm', 'tcmtw',
                    'soqh', 'tquu', 'hrfi', 'rsddp', 'ewfye', 'aumxj', 'tssui', 'ecgd', 'nunfp', 'isfka', 'ncvx',
                    'gqxi', 'typc', 'okcdt', 'sgcaq', 'mbcwd', 'angb', 'svyl', 'hjmk', 'tlcgd', 'hpka', 'efule',
                    'cbjou', 'agjjr', 'mziur', 'emoqh', 'rajte', 'ahoz', 'shaxe', 'okeyj', 'fgwnq', 'twojw',
                    'hcyfc', 'ojehd', 'soij', 'ekhpc', 'wbyq', 'hdfi', 'opyas', 'rzba', 'ediml', 'mvwys', 'avtmz',
                    'ilvj', 'nefy', 'eycng', 'dqdk', 'oihcj', 'nzuw', 'srrye', 'ccsi', 'emhnz', 'neosn', 'ewzki'
                ],
                'beam_width': 5,
                'delimiter': ''
            }
        }

Config

PredictPayload example for API documentation

Source code in src/trecover/app/api/schemas.py
class Config:
    """ PredictPayload example for API documentation"""

    schema_extra = {
        'example': {
            'columns': [
                'adin', 'scjz', 'pzxz', 'evft', 'odev', 'pkzc', 'lipss', 'eayh', 'aepqc', 'rvuqh', 'ozldx',
                'ulgq', 'nabhr', 'dvvf', 'tmil', 'huiow', 'euzq', 'cdmh', 'ompzv', 'uguq', 'ntvqi', 'tctm',
                'rwgi', 'yuonh', 'wkvr', 'efau', 'nrele', 'tbhxq', 'iiqd', 'nhwfy', 'tymio', 'onzpj', 'turho',
                'hhgnd', 'ehmof', 'scpoi', 'tyqbn', 'roul', 'exoe', 'edwyc', 'thid', 'snqrp', 'tmmh', 'oejg',
                'cjbaw', 'hgzmb', 'ezlwj', 'esxb', 'rria', 'taeo', 'hpnln', 'eeomf', 'cvxr', 'ofwy', 'nuon',
                'vvex', 'ikbd', 'cmusb', 'tdnkb', 'iccd', 'ocay', 'nnxds', 'slbgd', 'oupap', 'mhip', 'ebtv',
                'bipta', 'unazv', 'sccol', 'iovq', 'nxzev', 'ezaz', 'sakm', 'skls', 'eipvd', 'segz', 'inrlo',
                'nzkug', 'puau', 'oolt', 'recs', 'tjot', 'lwds', 'assb', 'ntyzf', 'dpad', 'byep', 'owgol',
                'aiwbb', 'ralk', 'dffos', 'ejfp', 'dwyug', 'uxucm', 'ppch', 'teznz', 'hpfbv', 'eaocf', 'iist',
                'rdlyx', 'wseu', 'ivgg', 'nabi', 'dtuiw', 'oxzje', 'wderj', 'sawm', 'odpw', 'noqs', 'cimnf',
                'eukjx', 'aszy', 'ghmiq', 'ajcsd', 'ipwgf', 'nhth', 'tpvfp', 'hnede', 'aclb', 'tteuq', 'nbvi',
                'isgc', 'gejbz', 'hufnl', 'tggvn', 'aahfn', 'skkxl', 'mmwq', 'anqgw', 'lrvji', 'lker', 'gvqt',
                'rdcd', 'obvt', 'ussht', 'piwb', 'ozbn', 'fyig', 'aczx', 'clak', 'tgnxi', 'iieyi', 'vqyqo',
                'ijgp', 'shfth', 'tnbeg', 'sbuzx', 'wwnja', 'eguhn', 'aneai', 'rpsl', 'izut', 'njixa', 'grgh',
                'bkypw', 'lliv', 'azeob', 'cojl', 'kmqnd', 'ahpq', 'pckw', 'phvpa', 'rgqv', 'opqby', 'aiqsp',
                'clirf', 'hlrp', 'eztn', 'dgek', 'azubn', 'gnskd', 'rajo', 'okgv', 'ugcp', 'pilf', 'oxbx',
                'fwqq', 'jsmf', 'okgw', 'uvjyg', 'rfio', 'nbtcy', 'aryp', 'ledgj', 'inex', 'sdqmm', 'tcmtw',
                'soqh', 'tquu', 'hrfi', 'rsddp', 'ewfye', 'aumxj', 'tssui', 'ecgd', 'nunfp', 'isfka', 'ncvx',
                'gqxi', 'typc', 'okcdt', 'sgcaq', 'mbcwd', 'angb', 'svyl', 'hjmk', 'tlcgd', 'hpka', 'efule',
                'cbjou', 'agjjr', 'mziur', 'emoqh', 'rajte', 'ahoz', 'shaxe', 'okeyj', 'fgwnq', 'twojw',
                'hcyfc', 'ojehd', 'soij', 'ekhpc', 'wbyq', 'hdfi', 'opyas', 'rzba', 'ediml', 'mvwys', 'avtmz',
                'ilvj', 'nefy', 'eycng', 'dqdk', 'oihcj', 'nzuw', 'srrye', 'ccsi', 'emhnz', 'neosn', 'ewzki'
            ],
            'beam_width': 5,
            'delimiter': ''
        }
    }

columns_validator

columns_validator(columns)

Check columns to keyless read.

Parameters:

Name Type Description Default
columns List[str]

Columns to keyless read

required

Returns:

Name Type Description
data List[str]

Columns to keyless read.

Raises:

Type Description
ValueError:

If at least one column is empty.

Source code in src/trecover/app/api/schemas.py
@validator('columns')
def columns_validator(cls, columns: List[str]) -> List[str]:
    """
    Check columns to keyless read.

    Parameters
    ----------
    columns: List[str]
        Columns to keyless read

    Returns
    -------
    data : List[str]
        Columns to keyless read.

    Raises
    ------
    ValueError:
        If at least one column is empty.

    """

    if any([len(column) == 0 for column in columns]):
        raise ValueError(f'Columns to keyless read must contain at least one character')

    return columns

beam_width_validator

beam_width_validator(beam_width)

Check columns to keyless read.

Parameters:

Name Type Description Default
beam_width int

Columns to keyless read

required

Returns:

Name Type Description
beam_width int

Width of beam search algorithm.

Raises:

Type Description
ValueError:

If the beam width is out of range.

Source code in src/trecover/app/api/schemas.py
@validator('beam_width')
def beam_width_validator(cls, beam_width: int) -> int:
    """
    Check columns to keyless read.

    Parameters
    ----------
    beam_width: int
        Columns to keyless read

    Returns
    -------
    beam_width : int
        Width of beam search algorithm.

    Raises
    ------
    ValueError:
        If the beam width is out of range.

    """

    if not 1 <= beam_width <= len(var.ALPHABET):
        raise ValueError(f'Beam width must be in between 1 and {len(var.ALPHABET)}')

    return beam_width

BaseResponse

Bases: BaseModel

Basic contents declaration of the response body for all API handlers.

Source code in src/trecover/app/api/schemas.py
class BaseResponse(BaseModel):
    """ Basic contents declaration of the response body for all API handlers. """

    message: str
    method: str
    status_code: int
    timestamp: str
    url: str

TaskResponse

Bases: BaseResponse

Contents declaration of the 'recover' handler response body.

Source code in src/trecover/app/api/schemas.py
class TaskResponse(BaseResponse):
    """ Contents declaration of the 'recover' handler response body. """

    task_id: Optional[str]

    class Config:
        """ TaskResponse example for API documentation"""

        schema_extra = {
            'example': {
                "message": "Accepted",
                "method": "POST",
                "status_code": 202,
                "timestamp": "2021-09-04T12:53:35.512412",
                "url": "http://localhost:8001/recover",
                "task_id": "909e4817-cca3-4dbf-a598-f7f83c5d60c9"
            }
        }

Config

TaskResponse example for API documentation

Source code in src/trecover/app/api/schemas.py
class Config:
    """ TaskResponse example for API documentation"""

    schema_extra = {
        'example': {
            "message": "Accepted",
            "method": "POST",
            "status_code": 202,
            "timestamp": "2021-09-04T12:53:35.512412",
            "url": "http://localhost:8001/recover",
            "task_id": "909e4817-cca3-4dbf-a598-f7f83c5d60c9"
        }
    }

PredictResponse

Bases: BaseResponse

Contents declaration of the 'status' handler response body.

Source code in src/trecover/app/api/schemas.py
class PredictResponse(BaseResponse):
    """ Contents declaration of the 'status' handler response body. """

    columns: Optional[List[str]]
    chains: Optional[List[Tuple]]
    state: Optional[str]
    progress: Optional[int]

    class Config:
        """ PredictResponse example for API documentation"""

        schema_extra = {
            'example': {
                "message": "OK",
                "method": "GET",
                "status_code": 200,
                "timestamp": "2021-09-04T12:54:49.801614",
                "url": "http://localhost:8001/status/909e4817-cca3-4dbf-a598-f7f83c5d60c9",
                "columns": [
                    "adin", "scjz", "pzxz", "evft", "odev", "pkzc", "lipss", "eayh", "aepqc", "rvuqh", "ozldx", "ulgq",
                    "nabhr", "dvvf", "tmil", "huiow", "euzq", "cdmh", "ompzv", "uguq", "ntvqi", "tctm", "rwgi", "yuonh",
                    "wkvr", "efau", "nrele", "tbhxq", "iiqd", "nhwfy", "tymio", "onzpj", "turho", "hhgnd", "ehmof",
                    "scpoi", "tyqbn", "roul", "exoe", "edwyc", "thid", "snqrp", "tmmh", "oejg", "cjbaw", "hgzmb",
                    "ezlwj", "esxb", "rria", "taeo", "hpnln", "eeomf", "cvxr", "ofwy", "nuon", "vvex", "ikbd", "cmusb",
                    "tdnkb", "iccd", "ocay", "nnxds", "slbgd", "oupap", "mhip", "ebtv", "bipta", "unazv", "sccol",
                    "iovq", "nxzev", "ezaz", "sakm", "skls", "eipvd", "segz", "inrlo", "nzkug", "puau", "oolt", "recs",
                    "tjot", "lwds", "assb", "ntyzf", "dpad", "byep", "owgol", "aiwbb", "ralk", "dffos", "ejfp", "dwyug",
                    "uxucm", "ppch", "teznz", "hpfbv", "eaocf", "iist", "rdlyx", "wseu", "ivgg", "nabi", "dtuiw",
                    "oxzje", "wderj", "sawm", "odpw", "noqs", "cimnf", "eukjx", "aszy", "ghmiq", "ajcsd", "ipwgf",
                    "nhth", "tpvfp", "hnede", "aclb", "tteuq", "nbvi", "isgc", "gejbz", "hufnl", "tggvn", "aahfn",
                    "skkxl", "mmwq", "anqgw", "lrvji", "lker", "gvqt", "rdcd", "obvt", "ussht", "piwb", "ozbn", "fyig",
                    "aczx", "clak", "tgnxi", "iieyi", "vqyqo", "ijgp", "shfth", "tnbeg", "sbuzx", "wwnja", "eguhn",
                    "aneai", "rpsl", "izut", "njixa", "grgh", "bkypw", "lliv", "azeob", "cojl", "kmqnd", "ahpq", "pckw",
                    "phvpa", "rgqv", "opqby", "aiqsp", "clirf", "hlrp", "eztn", "dgek", "azubn", "gnskd", "rajo",
                    "okgv", "ugcp", "pilf", "oxbx", "fwqq", "jsmf", "okgw", "uvjyg", "rfio", "nbtcy", "aryp", "ledgj",
                    "inex", "sdqmm", "tcmtw", "soqh", "tquu", "hrfi", "rsddp", "ewfye", "aumxj", "tssui", "ecgd",
                    "nunfp", "isfka", "ncvx", "gqxi", "typc", "okcdt", "sgcaq", "mbcwd", "angb", "svyl", "hjmk",
                    "tlcgd", "hpka", "efule", "cbjou", "agjjr", "mziur", "emoqh", "rajte", "ahoz", "shaxe", "okeyj",
                    "fgwnq", "twojw", "hcyfc", "ojehd", "soij", "ekhpc", "wbyq", "hdfi", "opyas", "rzba", "ediml",
                    "mvwys", "avtmz", "ilvj", "nefy", "eycng", "dqdk", "oihcj", "nzuw", "srrye", "ccsi", "emhnz",
                    "neosn", "ewzki"

                ],
                "chains": [
                    [
                        "aspeoplearoundthecountrywentintothestreetstoabeertheconvictionsametalineaspeonportsandboarded"
                        "uptheirwindowsonceagainthatnightasmallgroupofactivistswearingbloodapproachedagroupoffourtales"
                        "courseateningtoawalkthecametheonthesewisremainedourcesw",
                        -33.01948561671179
                    ],
                    [
                        "aspeoplearoundthecountrywentintothestreetstoabeertheconvictionsametalineaspeonportsandboarded"
                        "uptheirwindowsdoneagainthatnightasmallgroupofactivistswearingbloodapproachedagroupoffourtales"
                        "courseateningtoawalkthecametheonthesewisremainedourcesw",
                        -33.05044434355386
                    ],
                    [
                        "aspeoplearoundthecountrywentintothestreetstoabeertheconvictionsametalineaspeonportsandboarded"
                        "uptheirwindowsdoneagainthatnightasmallgroupofactivistswearingbloodapproachedagroupoffourtales"
                        "courseateningtoawalkthecametheonthesewisremainedourchew",
                        -33.686079347001396
                    ],
                    [
                        "aspeoplearoundthecountrywentintothestreetstoabeertheconvictionsametalineaspeonportsandboarded"
                        "uptheirwindowsdoneagainthatnightasmallgroupofactivistswearingbloodapproachedagroupoffourtales"
                        "coursexteningtoawalkthecametheonthesewisremainedourchew",
                        -33.83420559252136
                    ],
                    [
                        "aspeoplearoundthecountrywentintothestreetstoabeertheconvictionsametalineaspeonportsandboarded"
                        "uptheirwindowsonceagainthatnightasmallgroupofactivistswearingbloodapproachedagroupoffourtales"
                        "courseateningtoawalkthecametheonthesewisremainedourchew",
                        -33.948646204201395
                    ]
                ],
                "state": None,
                "progress": None
            }
        }

Config

PredictResponse example for API documentation

Source code in src/trecover/app/api/schemas.py
class Config:
    """ PredictResponse example for API documentation"""

    schema_extra = {
        'example': {
            "message": "OK",
            "method": "GET",
            "status_code": 200,
            "timestamp": "2021-09-04T12:54:49.801614",
            "url": "http://localhost:8001/status/909e4817-cca3-4dbf-a598-f7f83c5d60c9",
            "columns": [
                "adin", "scjz", "pzxz", "evft", "odev", "pkzc", "lipss", "eayh", "aepqc", "rvuqh", "ozldx", "ulgq",
                "nabhr", "dvvf", "tmil", "huiow", "euzq", "cdmh", "ompzv", "uguq", "ntvqi", "tctm", "rwgi", "yuonh",
                "wkvr", "efau", "nrele", "tbhxq", "iiqd", "nhwfy", "tymio", "onzpj", "turho", "hhgnd", "ehmof",
                "scpoi", "tyqbn", "roul", "exoe", "edwyc", "thid", "snqrp", "tmmh", "oejg", "cjbaw", "hgzmb",
                "ezlwj", "esxb", "rria", "taeo", "hpnln", "eeomf", "cvxr", "ofwy", "nuon", "vvex", "ikbd", "cmusb",
                "tdnkb", "iccd", "ocay", "nnxds", "slbgd", "oupap", "mhip", "ebtv", "bipta", "unazv", "sccol",
                "iovq", "nxzev", "ezaz", "sakm", "skls", "eipvd", "segz", "inrlo", "nzkug", "puau", "oolt", "recs",
                "tjot", "lwds", "assb", "ntyzf", "dpad", "byep", "owgol", "aiwbb", "ralk", "dffos", "ejfp", "dwyug",
                "uxucm", "ppch", "teznz", "hpfbv", "eaocf", "iist", "rdlyx", "wseu", "ivgg", "nabi", "dtuiw",
                "oxzje", "wderj", "sawm", "odpw", "noqs", "cimnf", "eukjx", "aszy", "ghmiq", "ajcsd", "ipwgf",
                "nhth", "tpvfp", "hnede", "aclb", "tteuq", "nbvi", "isgc", "gejbz", "hufnl", "tggvn", "aahfn",
                "skkxl", "mmwq", "anqgw", "lrvji", "lker", "gvqt", "rdcd", "obvt", "ussht", "piwb", "ozbn", "fyig",
                "aczx", "clak", "tgnxi", "iieyi", "vqyqo", "ijgp", "shfth", "tnbeg", "sbuzx", "wwnja", "eguhn",
                "aneai", "rpsl", "izut", "njixa", "grgh", "bkypw", "lliv", "azeob", "cojl", "kmqnd", "ahpq", "pckw",
                "phvpa", "rgqv", "opqby", "aiqsp", "clirf", "hlrp", "eztn", "dgek", "azubn", "gnskd", "rajo",
                "okgv", "ugcp", "pilf", "oxbx", "fwqq", "jsmf", "okgw", "uvjyg", "rfio", "nbtcy", "aryp", "ledgj",
                "inex", "sdqmm", "tcmtw", "soqh", "tquu", "hrfi", "rsddp", "ewfye", "aumxj", "tssui", "ecgd",
                "nunfp", "isfka", "ncvx", "gqxi", "typc", "okcdt", "sgcaq", "mbcwd", "angb", "svyl", "hjmk",
                "tlcgd", "hpka", "efule", "cbjou", "agjjr", "mziur", "emoqh", "rajte", "ahoz", "shaxe", "okeyj",
                "fgwnq", "twojw", "hcyfc", "ojehd", "soij", "ekhpc", "wbyq", "hdfi", "opyas", "rzba", "ediml",
                "mvwys", "avtmz", "ilvj", "nefy", "eycng", "dqdk", "oihcj", "nzuw", "srrye", "ccsi", "emhnz",
                "neosn", "ewzki"

            ],
            "chains": [
                [
                    "aspeoplearoundthecountrywentintothestreetstoabeertheconvictionsametalineaspeonportsandboarded"
                    "uptheirwindowsonceagainthatnightasmallgroupofactivistswearingbloodapproachedagroupoffourtales"
                    "courseateningtoawalkthecametheonthesewisremainedourcesw",
                    -33.01948561671179
                ],
                [
                    "aspeoplearoundthecountrywentintothestreetstoabeertheconvictionsametalineaspeonportsandboarded"
                    "uptheirwindowsdoneagainthatnightasmallgroupofactivistswearingbloodapproachedagroupoffourtales"
                    "courseateningtoawalkthecametheonthesewisremainedourcesw",
                    -33.05044434355386
                ],
                [
                    "aspeoplearoundthecountrywentintothestreetstoabeertheconvictionsametalineaspeonportsandboarded"
                    "uptheirwindowsdoneagainthatnightasmallgroupofactivistswearingbloodapproachedagroupoffourtales"
                    "courseateningtoawalkthecametheonthesewisremainedourchew",
                    -33.686079347001396
                ],
                [
                    "aspeoplearoundthecountrywentintothestreetstoabeertheconvictionsametalineaspeonportsandboarded"
                    "uptheirwindowsdoneagainthatnightasmallgroupofactivistswearingbloodapproachedagroupoffourtales"
                    "coursexteningtoawalkthecametheonthesewisremainedourchew",
                    -33.83420559252136
                ],
                [
                    "aspeoplearoundthecountrywentintothestreetstoabeertheconvictionsametalineaspeonportsandboarded"
                    "uptheirwindowsonceagainthatnightasmallgroupofactivistswearingbloodapproachedagroupoffourtales"
                    "courseateningtoawalkthecametheonthesewisremainedourchew",
                    -33.948646204201395
                ]
            ],
            "state": None,
            "progress": None
        }
    }