Package org.springframework.ai.openai

Class OpenAiImageClient

java.lang.Object

org.springframework.ai.openai.OpenAiImageClient

All Implemented Interfaces:

ImageClient, ModelClient<ImagePrompt,ImageResponse>

public class OpenAiImageClient
extends Object
implements ImageClient

OpenAiImageClient is a class that implements the ImageClient interface. It provides a client for calling the OpenAI image generation API.

Since:

0.8.0

Author:

Mark Pollack, Christian Tzolov

Field Summary

Fields

Modifier and Type	Field	Description
final org.springframework.retry.support.RetryTemplate	retryTemplate

Constructor Summary

Constructors

Constructor	Description
OpenAiImageClient(OpenAiImageApi openAiImageApi)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

retryTemplate

public final org.springframework.retry.support.RetryTemplate retryTemplate

Constructor Details

OpenAiImageClient

public OpenAiImageClient(OpenAiImageApi openAiImageApi)

Method Details

getDefaultOptions

public OpenAiImageOptions getDefaultOptions()

withDefaultOptions

public OpenAiImageClient withDefaultOptions(OpenAiImageOptions defaultOptions)

call

public ImageResponse call(ImagePrompt imagePrompt)

Description copied from interface: ModelClient

Executes a method call to the AI model.

Specified by:

call in interface ImageClient

Specified by:

call in interface ModelClient<ImagePrompt,ImageResponse>

Parameters:

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

Returns:

the response from the AI model