Interface: IImageProvider
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:346
Properties
defaultModelId?
readonlyoptionaldefaultModelId:string
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:349
isInitialized
readonlyisInitialized:boolean
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:348
providerId
readonlyproviderId:string
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:347
Methods
editImage()?
optionaleditImage(request):Promise<ImageGenerationResult>
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:362
Perform an image-to-image edit, inpainting, or outpainting operation.
Providers that do not support editing should leave this undefined.
Parameters
request
Returns
Promise<ImageGenerationResult>
generateImage()
generateImage(
request):Promise<ImageGenerationResult>
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:352
Parameters
request
Returns
Promise<ImageGenerationResult>
initialize()
initialize(
config):Promise<void>
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:351
Parameters
config
Record<string, unknown>
Returns
Promise<void>
listAvailableModels()?
optionallistAvailableModels():Promise<ImageModelInfo[]>
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:353
Returns
Promise<ImageModelInfo[]>
shutdown()?
optionalshutdown():Promise<void>
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:354
Returns
Promise<void>
styleTransferModel()?
optionalstyleTransferModel(modelId):string
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:392
The model a style transfer runs on for modelId (an empty string for
the provider's default), decided by an initialised provider from its own
configuration, without a request. Throws for a model its style transfer
cannot run. A provider whose base URL is not its own may take a model
outside its list, by its own rule: OpenAI and Fal any name, Replicate
any owner/name (never a pinned version), Stability none, since its
endpoint takes no model. A provider defines this exactly when it
defines transferStyle.
Parameters
modelId
string
Returns
string
transferStyle()?
optionaltransferStyle(request):Promise<ImageGenerationResult>
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:380
Restyle image after styleImage, sending the provider both. A provider
with no call that takes both images leaves this undefined.
Parameters
request
Returns
Promise<ImageGenerationResult>
upscaleImage()?
optionalupscaleImage(request):Promise<ImageGenerationResult>
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:368
Upscale / super-resolve an image.
Providers that do not support upscaling should leave this undefined.
Parameters
request
Returns
Promise<ImageGenerationResult>
variateImage()?
optionalvariateImage(request):Promise<ImageGenerationResult>
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:374
Generate visual variations of the supplied image.
Providers that do not support variations should leave this undefined.
Parameters
request
Returns
Promise<ImageGenerationResult>