Package org.springframework.ai.stabilityai

Class StabilityAiImageModel

java.lang.Object

org.springframework.ai.stabilityai.StabilityAiImageModel

All Implemented Interfaces:

ImageModel, Model<ImagePrompt,ImageResponse>

public class StabilityAiImageModel
extends Object
implements ImageModel

StabilityAiImageModel is a class that implements the ImageModel interface. It provides a client for calling the StabilityAI image generation API.

Constructor Summary

Constructors

Constructor	Description
StabilityAiImageModel(StabilityAiApi stabilityAiApi)
StabilityAiImageModel(StabilityAiApi stabilityAiApi, StabilityAiImageOptions options)
StabilityAiImageModel(StabilityAiApi stabilityAiApi, StabilityAiImageOptions options, io.micrometer.observation.ObservationRegistry observationRegistry)	Creates a model that reports its calls to the given observation registry.

Method Summary

Modifier and Type	Method	Description
ImageResponse	call(ImagePrompt imagePrompt)	Calls the StabilityAiImageModel with the given StabilityAiImagePrompt and returns the ImageResponse.
StabilityAiImageOptions	getOptions()
void	setObservationConvention(ImageModelObservationConvention observationConvention)	Use the provided convention for reporting observation data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StabilityAiImageModel

public StabilityAiImageModel(StabilityAiApi stabilityAiApi)

StabilityAiImageModel

public StabilityAiImageModel(StabilityAiApi stabilityAiApi,
 StabilityAiImageOptions options)

StabilityAiImageModel

public StabilityAiImageModel(StabilityAiApi stabilityAiApi,
 StabilityAiImageOptions options,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Creates a model that reports its calls to the given observation registry.

Parameters:

stabilityAiApi - the Stability AI API client

options - the default options

observationRegistry - the observation registry, ObservationRegistry.NOOP for none

Since:

2.0.2

Method Details

setObservationConvention

public void setObservationConvention(ImageModelObservationConvention observationConvention)

Use the provided convention for reporting observation data.

Parameters:

observationConvention - the provided convention

Since:

2.0.2

getOptions

public StabilityAiImageOptions getOptions()

call

public ImageResponse call(ImagePrompt imagePrompt)

Calls the StabilityAiImageModel with the given StabilityAiImagePrompt and returns the ImageResponse. This overloaded call method lets you pass the full set of Prompt instructions that StabilityAI supports.

Specified by:

call in interface ImageModel

Specified by:

call in interface Model<ImagePrompt,ImageResponse>

Parameters:

imagePrompt - the StabilityAiImagePrompt containing the prompt and image model options

Returns:

the ImageResponse generated by the StabilityAiImageModel