Interface ClientImageAnalysisRequest

Description

Interface contract for ClientImageAnalysisRequest.

interface ClientImageAnalysisRequest {
    extras?: Record<string, unknown>;
    features?: ImageAnalysisFeatures;
    hints?: ImageAnalysisHints;
    images?: ClientReferenceImage[];
    prompt?: string;
}

Index

Properties

extras? features? hints? images? prompt?

Properties

`Optional`extras

extras?: Record<string, unknown>

Provider escape hatch

`Optional`features

features?: ImageAnalysisFeatures

Requested analysis features

`Optional`hints

hints?: ImageAnalysisHints

Optional structured analysis hints. Providers may ignore unsupported hints.

`Optional`images

images?: ClientReferenceImage[]

One or more images to analyze

`Optional`prompt

prompt?: string

Optional instruction to guide analysis. Example: "Describe the scene and identify safety risks."