Package org.springframework.ai.openai

Class OpenAiImageModel.Builder

java.lang.Object

org.springframework.ai.openai.OpenAiImageModel.Builder

Enclosing class:

OpenAiImageModel

public static final class OpenAiImageModel.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
OpenAiImageModel	build()
OpenAiImageModel.Builder	httpClientBuilderCustomizer(OpenAiHttpClientBuilderCustomizer customizer)	Registers an OpenAiHttpClientBuilderCustomizer that mutates the underlying OkHttp client builder before the OpenAI clients are constructed.
OpenAiImageModel.Builder	httpClientBuilderCustomizers(List<OpenAiHttpClientBuilderCustomizer> customizers)	Sets the full list of customizers to apply, replacing any customizers registered earlier on this builder.
OpenAiImageModel.Builder	observationRegistry(@Nullable io.micrometer.observation.ObservationRegistry observationRegistry)
OpenAiImageModel.Builder	openAiClient(@Nullable com.openai.client.OpenAIClient openAiClient)
OpenAiImageModel.Builder	options(@Nullable OpenAiImageOptions options)

Methods inherited from class java.lang.Object

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

Method Details

openAiClient

public OpenAiImageModel.Builder openAiClient(@Nullable com.openai.client.OpenAIClient openAiClient)

options

public OpenAiImageModel.Builder options(@Nullable OpenAiImageOptions options)

observationRegistry

public OpenAiImageModel.Builder observationRegistry(@Nullable io.micrometer.observation.ObservationRegistry observationRegistry)

httpClientBuilderCustomizer

public OpenAiImageModel.Builder httpClientBuilderCustomizer(OpenAiHttpClientBuilderCustomizer customizer)

Registers an OpenAiHttpClientBuilderCustomizer that mutates the underlying OkHttp client builder before the OpenAI clients are constructed. Use this to attach OkHttp interceptors (e.g. OAuth2 bearer-token injection), swap the dispatcher executor, or tweak any other OkHttp setting. Customizers are applied in the order they are registered, after Spring AI's own defaults, so user code wins.

httpClientBuilderCustomizers

public OpenAiImageModel.Builder httpClientBuilderCustomizers(List<OpenAiHttpClientBuilderCustomizer> customizers)

Sets the full list of customizers to apply, replacing any customizers registered earlier on this builder. The order of the list is preserved when invoking the customizers.

build

public OpenAiImageModel build()