Skip to main content

Interface: IImageProvider

Defined in: packages/agentos/src/media/images/IImageProvider.ts:300

Properties​

defaultModelId?​

readonly optional defaultModelId: string

Defined in: packages/agentos/src/media/images/IImageProvider.ts:303

isInitialized​

readonly isInitialized: boolean

Defined in: packages/agentos/src/media/images/IImageProvider.ts:302

providerId​

readonly providerId: string

Defined in: packages/agentos/src/media/images/IImageProvider.ts:301

Methods​

editImage()?​

optional editImage(request): Promise<ImageGenerationResult>

Defined in: packages/agentos/src/media/images/IImageProvider.ts:316

Perform an image-to-image edit, inpainting, or outpainting operation. Providers that do not support editing should leave this undefined.

Parameters​

request​

ImageEditRequest

Returns​

Promise<ImageGenerationResult>

generateImage()​

generateImage(request): Promise<ImageGenerationResult>

Defined in: packages/agentos/src/media/images/IImageProvider.ts:306

Parameters​

request​

ImageGenerationRequest

Returns​

Promise<ImageGenerationResult>

initialize()​

initialize(config): Promise<void>

Defined in: packages/agentos/src/media/images/IImageProvider.ts:305

Parameters​

config​

Record<string, unknown>

Returns​

Promise<void>

listAvailableModels()?​

optional listAvailableModels(): Promise<ImageModelInfo[]>

Defined in: packages/agentos/src/media/images/IImageProvider.ts:307

Returns​

Promise<ImageModelInfo[]>

shutdown()?​

optional shutdown(): Promise<void>

Defined in: packages/agentos/src/media/images/IImageProvider.ts:308

Returns​

Promise<void>

upscaleImage()?​

optional upscaleImage(request): Promise<ImageGenerationResult>

Defined in: packages/agentos/src/media/images/IImageProvider.ts:322

Upscale / super-resolve an image. Providers that do not support upscaling should leave this undefined.

Parameters​

request​

ImageUpscaleRequest

Returns​

Promise<ImageGenerationResult>

variateImage()?​

optional variateImage(request): Promise<ImageGenerationResult>

Defined in: packages/agentos/src/media/images/IImageProvider.ts:328

Generate visual variations of the supplied image. Providers that do not support variations should leave this undefined.

Parameters​

request​

ImageVariateRequest

Returns​

Promise<ImageGenerationResult>