|
| 1 | +"""Output metadata types for pricing and usage tracking.""" |
| 2 | + |
| 3 | +from typing import Any, List, Optional |
| 4 | +from enum import Enum |
| 5 | +from pydantic import BaseModel, Field |
| 6 | + |
| 7 | + |
| 8 | +class MetaItemType(str, Enum): |
| 9 | + """Type discriminator for MetaItem.""" |
| 10 | + TEXT = "text" |
| 11 | + IMAGE = "image" |
| 12 | + VIDEO = "video" |
| 13 | + AUDIO = "audio" |
| 14 | + |
| 15 | + |
| 16 | +class VideoResolution(str, Enum): |
| 17 | + """Standard video resolution presets.""" |
| 18 | + RES_480P = "480p" |
| 19 | + RES_720P = "720p" |
| 20 | + RES_1080P = "1080p" |
| 21 | + RES_1440P = "1440p" |
| 22 | + RES_4K = "4k" |
| 23 | + |
| 24 | + |
| 25 | +class MetaItem(BaseModel): |
| 26 | + """Base class for input/output metadata items.""" |
| 27 | + type: str # "text", "image", "video", "audio" |
| 28 | + extra: Optional[dict[str, Any]] = Field( |
| 29 | + default=None, |
| 30 | + description="App-specific key-value pairs for custom pricing factors" |
| 31 | + ) |
| 32 | + |
| 33 | + |
| 34 | +class TextMeta(MetaItem): |
| 35 | + """Metadata for text inputs/outputs (e.g., LLM tokens).""" |
| 36 | + type: str = MetaItemType.TEXT.value |
| 37 | + tokens: int = Field( |
| 38 | + default=0, |
| 39 | + description="Token count - in inputs[] = input tokens, in outputs[] = output tokens" |
| 40 | + ) |
| 41 | + |
| 42 | + |
| 43 | +class ImageMeta(MetaItem): |
| 44 | + """Metadata for image inputs/outputs.""" |
| 45 | + type: str = MetaItemType.IMAGE.value |
| 46 | + width: int = Field(default=0, description="Image width in pixels") |
| 47 | + height: int = Field(default=0, description="Image height in pixels") |
| 48 | + resolution_mp: float = Field( |
| 49 | + default=0, |
| 50 | + description="Resolution in megapixels (width * height / 1_000_000)" |
| 51 | + ) |
| 52 | + steps: int = Field(default=0, description="Number of diffusion steps") |
| 53 | + count: int = Field(default=1, description="Number of images") |
| 54 | + |
| 55 | + |
| 56 | +class VideoMeta(MetaItem): |
| 57 | + """Metadata for video inputs/outputs.""" |
| 58 | + type: str = MetaItemType.VIDEO.value |
| 59 | + width: int = Field(default=0, description="Video width in pixels") |
| 60 | + height: int = Field(default=0, description="Video height in pixels") |
| 61 | + resolution_mp: float = Field( |
| 62 | + default=0, |
| 63 | + description="Resolution in megapixels per frame" |
| 64 | + ) |
| 65 | + resolution: Optional[VideoResolution] = Field( |
| 66 | + default=None, |
| 67 | + description="Standard resolution preset (480p, 720p, 1080p, 1440p, 4k)" |
| 68 | + ) |
| 69 | + seconds: float = Field(default=0, description="Duration in seconds") |
| 70 | + fps: int = Field(default=0, description="Frames per second") |
| 71 | + |
| 72 | + |
| 73 | +class AudioMeta(MetaItem): |
| 74 | + """Metadata for audio inputs/outputs.""" |
| 75 | + type: str = MetaItemType.AUDIO.value |
| 76 | + seconds: float = Field(default=0, description="Duration in seconds") |
| 77 | + sample_rate: int = Field(default=0, description="Sample rate in Hz") |
| 78 | + |
| 79 | + |
| 80 | +class OutputMeta(BaseModel): |
| 81 | + """ |
| 82 | + Structured metadata about task inputs and outputs for pricing calculation. |
| 83 | + |
| 84 | + Apps include this in their output to report what was consumed (inputs) |
| 85 | + and what was produced (outputs). The backend uses this with CEL expressions |
| 86 | + to calculate app-level pricing. |
| 87 | + |
| 88 | + Example usage in an LLM app: |
| 89 | + output_meta = OutputMeta( |
| 90 | + inputs=[TextMeta(tokens=150)], |
| 91 | + outputs=[TextMeta(tokens=500)] |
| 92 | + ) |
| 93 | + |
| 94 | + Example usage in a video generation app: |
| 95 | + output_meta = OutputMeta( |
| 96 | + outputs=[VideoMeta( |
| 97 | + resolution=VideoResolution.RES_1080P, |
| 98 | + resolution_mp=2.07, |
| 99 | + seconds=10.5, |
| 100 | + fps=30 |
| 101 | + )] |
| 102 | + ) |
| 103 | + """ |
| 104 | + inputs: List[MetaItem] = Field( |
| 105 | + default_factory=list, |
| 106 | + description="Metadata about consumed inputs" |
| 107 | + ) |
| 108 | + outputs: List[MetaItem] = Field( |
| 109 | + default_factory=list, |
| 110 | + description="Metadata about produced outputs" |
| 111 | + ) |
| 112 | + |
0 commit comments