Package org.springframework.ai.openai.api

Class OpenAiImageApi

java.lang.Object

org.springframework.ai.openai.api.OpenAiImageApi

public class OpenAiImageApi
extends Object

OpenAI Image API.

See Also:

• Images

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiImageApi.Builder	Builder to construct OpenAiImageApi instance.
static final record	OpenAiImageApi.Data
static enum	OpenAiImageApi.ImageModel	OpenAI Image API model.
static final record	OpenAiImageApi.OpenAiImageRequest
static final record	OpenAiImageApi.OpenAiImageResponse

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_IMAGE_MODEL

Constructor Summary

Constructors

Constructor	Description
OpenAiImageApi(String openAiToken)	Deprecated, for removal: This API element is subject to removal in a future version. use OpenAiImageApi.Builder instead.
OpenAiImageApi(String baseUrl, String apiKey, org.springframework.util.MultiValueMap<String,String> headers, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.client.ResponseErrorHandler responseErrorHandler)	Deprecated, for removal: This API element is subject to removal in a future version. use OpenAiImageApi.Builder instead.
OpenAiImageApi(String baseUrl, String openAiToken, org.springframework.web.client.RestClient.Builder restClientBuilder)	Deprecated, for removal: This API element is subject to removal in a future version. use OpenAiImageApi.Builder instead.
OpenAiImageApi(String baseUrl, String apiKey, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.client.ResponseErrorHandler responseErrorHandler)	Deprecated, for removal: This API element is subject to removal in a future version. use OpenAiImageApi.Builder instead.
OpenAiImageApi(String baseUrl, ApiKey apiKey, org.springframework.util.MultiValueMap<String,String> headers, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.client.ResponseErrorHandler responseErrorHandler)	Create a new OpenAI Image API with the provided base URL.

Method Summary

Modifier and Type	Method	Description
static OpenAiImageApi.Builder	builder()
org.springframework.http.ResponseEntity<OpenAiImageApi.OpenAiImageResponse>	createImage(OpenAiImageApi.OpenAiImageRequest openAiImageRequest)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_IMAGE_MODEL

public static final String DEFAULT_IMAGE_MODEL

Constructor Details

OpenAiImageApi

@Deprecated(forRemoval=true,
            since="1.0.0-M6")
public OpenAiImageApi(String openAiToken)

Deprecated, for removal: This API element is subject to removal in a future version.

use OpenAiImageApi.Builder instead.

Create a new OpenAI Image api with base URL set to https://api.openai.com.

Parameters:

openAiToken - OpenAI apiKey.

OpenAiImageApi

@Deprecated(forRemoval=true,
            since="1.0.0-M6")
public OpenAiImageApi(String baseUrl,
 String openAiToken,
 org.springframework.web.client.RestClient.Builder restClientBuilder)

Deprecated, for removal: This API element is subject to removal in a future version.

use OpenAiImageApi.Builder instead.

Create a new OpenAI Image API with the provided base URL.

Parameters:

baseUrl - the base URL for the OpenAI API.

openAiToken - OpenAI apiKey.

OpenAiImageApi

@Deprecated(forRemoval=true,
            since="1.0.0-M6")
public OpenAiImageApi(String baseUrl,
 String apiKey,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler)

Deprecated, for removal: This API element is subject to removal in a future version.

use OpenAiImageApi.Builder instead.

Create a new OpenAI Image API with the provided base URL.

Parameters:

baseUrl - the base URL for the OpenAI API.

apiKey - OpenAI apiKey.

restClientBuilder - the rest client builder to use.

OpenAiImageApi

@Deprecated(forRemoval=true,
            since="1.0.0-M6")
public OpenAiImageApi(String baseUrl,
 String apiKey,
 org.springframework.util.MultiValueMap<String,String> headers,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler)

Deprecated, for removal: This API element is subject to removal in a future version.

use OpenAiImageApi.Builder instead.

Create a new OpenAI Image API with the provided base URL.

Parameters:

baseUrl - the base URL for the OpenAI API.

apiKey - OpenAI apiKey.

headers - the http headers to use.

restClientBuilder - the rest client builder to use.

responseErrorHandler - the response error handler to use.

OpenAiImageApi

public OpenAiImageApi(String baseUrl,
 ApiKey apiKey,
 org.springframework.util.MultiValueMap<String,String> headers,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler)

Create a new OpenAI Image API with the provided base URL.

Parameters:

baseUrl - the base URL for the OpenAI API.

apiKey - OpenAI apiKey.

headers - the http headers to use.

restClientBuilder - the rest client builder to use.

responseErrorHandler - the response error handler to use.

Method Details

createImage

public org.springframework.http.ResponseEntity<OpenAiImageApi.OpenAiImageResponse> createImage(OpenAiImageApi.OpenAiImageRequest openAiImageRequest)

builder

public static OpenAiImageApi.Builder builder()