Package org.springframework.ai.azure.openai

Class AzureOpenAiImageModel

java.lang.Object

org.springframework.ai.azure.openai.AzureOpenAiImageModel

All Implemented Interfaces:

ImageModel, Model<ImagePrompt,ImageResponse>

public class AzureOpenAiImageModel
extends Object
implements ImageModel

ImageModel implementation for Microsoft Azure AI backed by OpenAIClient.

Since:

1.0.0

Author:

Benoit Moussaud, Sebastien Deleuze

See Also:

• ImageModel
• OpenAIClient

Constructor Summary

Constructors

Constructor	Description
AzureOpenAiImageModel(com.azure.ai.openai.OpenAIClient openAIClient)
AzureOpenAiImageModel(com.azure.ai.openai.OpenAIClient microsoftOpenAiClient, AzureOpenAiImageOptions options)

Method Summary

Modifier and Type	Method	Description
ImageResponse	call(ImagePrompt imagePrompt)	Executes a method call to the AI model.
AzureOpenAiImageOptions	getDefaultOptions()

Methods inherited from class java.lang.Object

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

Constructor Details

AzureOpenAiImageModel

public AzureOpenAiImageModel(com.azure.ai.openai.OpenAIClient openAIClient)

AzureOpenAiImageModel

public AzureOpenAiImageModel(com.azure.ai.openai.OpenAIClient microsoftOpenAiClient,
 AzureOpenAiImageOptions options)

Method Details

getDefaultOptions

public AzureOpenAiImageOptions getDefaultOptions()

call

public ImageResponse call(ImagePrompt imagePrompt)

Description copied from interface: Model

Executes a method call to the AI model.

Specified by:

call in interface ImageModel

Specified by:

call in interface Model<ImagePrompt,ImageResponse>

Parameters:

imagePrompt - the request object to be sent to the AI model

Returns:

the response from the AI model