MediaInputMetadata

Defined in: packages/ai/src/types.ts:2325

Metadata convention for image / video / audio inputs to media generation. Carried on ImagePart.metadata / VideoPart.metadata / AudioPart.metadata when used as conditioning inputs to generateImage() or generateVideo().

Properties#

role?#

optional role?: MediaInputRole;

Defined in: packages/ai/src/types.ts:2327

Optional role hint disambiguating the part's intent for the adapter

tag?#

optional tag?: string;

Defined in: packages/ai/src/types.ts:2336

Optional user-defined label for this input (e.g. 'woman-in-red-dress'). Informational only — adapters never read it and the SDK never rewrites prompt text based on it. Use it to correlate parts with the references you write in your prompt using the provider's own syntax (fal's @Image1, OpenAI's "image 1", etc.), or for your own bookkeeping/logging.