pixano_inference.schemas.base

Pydantic base models for request and response.

BaseRequest(**data)

Bases: _BaseModel, ABC

Base request model.

Attributes:

Name	Type	Description
model	str	Name of the model.

Source code in pydantic/main.py

def __init__(self, /, **data: Any) -> None:
    """Create a new model by parsing and validating input data from keyword arguments.

    Raises [`ValidationError`][pydantic_core.ValidationError] if the input data cannot be
    validated to form a valid model.

    `self` is explicitly positional-only to allow `self` as a field name.
    """
    # `__tracebackhide__` tells pytest and some other tools to omit this function from tracebacks
    __tracebackhide__ = True
    validated_self = self.__pydantic_validator__.validate_python(data, self_instance=self)
    if self is not validated_self:
        warnings.warn(
            'A custom validator is returning a value other than `self`.\n'
            "Returning anything other than `self` from a top level model validator isn't supported when validating via `__init__`.\n"
            f'See the `model_validator` docs (https://pydantic.dev/docs/validation/{version_short()}/concepts/validators/#model-validators) for more details.',
            stacklevel=2,
        )

to_base_model(base_model)

Convert request to input type.

Source code in pixano_inference/schemas/base.py

def to_base_model(self, base_model: type[T]) -> T:
    """Convert request to input type."""
    if not issubclass(base_model, BaseModel):
        raise ValueError(f"base_model must be a subclass of pydantic's BaseModel, got {base_model.__name__}.")
    return base_model.model_validate(self.model_dump(include=set(base_model.model_fields.keys())))

BaseResponse(**data)

Bases: _BaseModel, ABC

Base response envelope.

Attributes:

Name	Type	Description
id	str	ID of the task.
status	str	Status of the task.
timestamp	datetime	Timestamp of the response.
processing_time	float	Processing time of the response.
metadata	dict[str, Any]	Metadata of the response.
data	Any	Task-specific output payload.

Source code in pydantic/main.py

def __init__(self, /, **data: Any) -> None:
    """Create a new model by parsing and validating input data from keyword arguments.

    Raises [`ValidationError`][pydantic_core.ValidationError] if the input data cannot be
    validated to form a valid model.

    `self` is explicitly positional-only to allow `self` as a field name.
    """
    # `__tracebackhide__` tells pytest and some other tools to omit this function from tracebacks
    __tracebackhide__ = True
    validated_self = self.__pydantic_validator__.validate_python(data, self_instance=self)
    if self is not validated_self:
        warnings.warn(
            'A custom validator is returning a value other than `self`.\n'
            "Returning anything other than `self` from a top level model validator isn't supported when validating via `__init__`.\n"
            f'See the `model_validator` docs (https://pydantic.dev/docs/validation/{version_short()}/concepts/validators/#model-validators) for more details.',
            stacklevel=2,
        )