Interface: IVisionProvider
Makaio Framework / contracts / IVisionProvider
Interface: IVisionProvider
Section titled “Interface: IVisionProvider”Defined in: ../../../packages/contracts/src/capabilities/vision/types.ts:9
Vision provider interface.
Providers enable image analysis for non-vision LLMs.
Extends
Section titled “Extends”Properties
Section titled “Properties”displayName
Section titled “displayName”
readonlydisplayName:string
Defined in: ../../../packages/contracts/src/capability/types.ts:11
Human-readable name for display in UI
Inherited from
Section titled “Inherited from”ICapabilityProvider.displayName
readonlyid:string
Defined in: ../../../packages/contracts/src/capability/types.ts:9
Unique identifier for this provider instance
Inherited from
Section titled “Inherited from”providerKey?
Section titled “providerKey?”
readonlyoptionalproviderKey?:string
Defined in: ../../../packages/contracts/src/capability/types.ts:17
Stable provider identity used for joins across registries.
Unlike id, this should remain stable across runtime re-registration.
Inherited from
Section titled “Inherited from”ICapabilityProvider.providerKey
Methods
Section titled “Methods”analyze()
Section titled “analyze()”analyze(
request):Promise<{confidence?:number;description:string; }>
Defined in: ../../../packages/contracts/src/capabilities/vision/types.ts:14
Analyze an image and return a description.
Parameters
Section titled “Parameters”request
Section titled “request”Analysis request with image and optional prompt
string = ...
Image source: file path, base64 data URI, or URL
prompt?
Section titled “prompt?”string = ...
Optional prompt to guide the analysis (default: “Describe this image”)
Returns
Section titled “Returns”Promise<{ confidence?: number; description: string; }>
isAvailable()
Section titled “isAvailable()”isAvailable():
Promise<boolean>
Defined in: ../../../packages/contracts/src/capabilities/vision/types.ts:19
Check if the provider is available (e.g. underlying adapter is ready).
Returns
Section titled “Returns”Promise<boolean>
validate()?
Section titled “validate()?”
optionalvalidate():Promise<{error?:string;valid:boolean; }>
Defined in: ../../../packages/contracts/src/capability/types.ts:22
Optional validation method to check provider configuration/credentials.
Returns
Section titled “Returns”Promise<{ error?: string; valid: boolean; }>
Validation result with optional error message