ToolOutputImage

type ToolOutputImage = object;

Type Declaration

detail?

optional detail: "low" | "high" | "auto" | string & object;

Controls the requested level of detail for vision models. Use a string to avoid constraining future model capabilities.

image?

optional image:
  | string
  | {
  data: string | Uint8Array<ArrayBuffer>;
  mediaType?: string;
}
  | {
  url: string;
}
  | {
  fileId: string;
};

Inline image content or a reference to an uploaded file. Accepts a URL/data URL string or an object describing the data/url/fileId source.

providerData?

optional providerData: Record<string, any>;

Additional optional provider specific data. Used for custom functionality or model provider specific fields.

type

type: "image";