|
1 | | -"""StreamResult — concrete wrapper around a message stream.""" |
| 1 | +"""Core model-layer types — parameter objects and StreamResult. |
| 2 | +
|
| 3 | +Parameter types (:class:`ImageParams`, :class:`VideoParams`) live here |
| 4 | +because they parameterise the public :func:`generate` API. |
| 5 | +
|
| 6 | +:class:`StreamResult` is the concrete wrapper returned by :func:`stream`. |
| 7 | +""" |
2 | 8 |
|
3 | 9 | from __future__ import annotations |
4 | 10 |
|
5 | 11 | from collections.abc import AsyncGenerator |
6 | 12 | from typing import Any |
7 | 13 |
|
| 14 | +import pydantic |
| 15 | + |
8 | 16 | from ...types import messages as messages_ |
9 | 17 |
|
| 18 | +# --------------------------------------------------------------------------- |
| 19 | +# Generation parameter types |
| 20 | +# --------------------------------------------------------------------------- |
| 21 | + |
| 22 | +_PARAMS_CONFIG = pydantic.ConfigDict(frozen=True, populate_by_name=True) |
| 23 | + |
| 24 | + |
| 25 | +class ImageParams(pydantic.BaseModel): |
| 26 | + """Parameters for image generation (``/image-model`` endpoint).""" |
| 27 | + |
| 28 | + model_config = _PARAMS_CONFIG |
| 29 | + |
| 30 | + n: int = 1 |
| 31 | + size: str | None = None |
| 32 | + aspect_ratio: str | None = pydantic.Field( |
| 33 | + default=None, serialization_alias="aspectRatio" |
| 34 | + ) |
| 35 | + seed: int | None = None |
| 36 | + provider_options: dict[str, Any] = pydantic.Field( |
| 37 | + default_factory=dict, serialization_alias="providerOptions" |
| 38 | + ) |
| 39 | + |
| 40 | + |
| 41 | +class VideoParams(pydantic.BaseModel): |
| 42 | + """Parameters for video generation (``/video-model`` endpoint).""" |
| 43 | + |
| 44 | + model_config = _PARAMS_CONFIG |
| 45 | + |
| 46 | + n: int = 1 |
| 47 | + aspect_ratio: str | None = pydantic.Field( |
| 48 | + default=None, serialization_alias="aspectRatio" |
| 49 | + ) |
| 50 | + resolution: str | None = None |
| 51 | + duration: int | None = None |
| 52 | + fps: int | None = None |
| 53 | + seed: int | None = None |
| 54 | + provider_options: dict[str, Any] = pydantic.Field( |
| 55 | + default_factory=dict, serialization_alias="providerOptions" |
| 56 | + ) |
| 57 | + |
| 58 | + |
| 59 | +GenerateParams = ImageParams | VideoParams |
| 60 | + |
| 61 | +# --------------------------------------------------------------------------- |
| 62 | +# StreamResult |
| 63 | +# --------------------------------------------------------------------------- |
| 64 | + |
10 | 65 |
|
11 | 66 | class StreamResult: |
12 | 67 | """Wrapper around a message stream. Async-iterable; collects the final result. |
|
0 commit comments