Package org.springframework.ai.openai.http.okhttp

Class SpringAiOpenAiHttpClient.Builder

java.lang.Object

org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

Enclosing class:

SpringAiOpenAiHttpClient

public static final class SpringAiOpenAiHttpClient.Builder
extends Object

Builder for SpringAiOpenAiHttpClient. Mirrors the upstream com.openai.client.okhttp.OkHttpClient.Builder surface, with two additional optional inputs: an ObservationRegistry (defaults to ObservationRegistry.NOOP) and a MeterRegistry (optional; when supplied, OkHttp connection-pool gauges are bound to it).

Method Summary

Modifier and Type	Method	Description
SpringAiOpenAiHttpClient	build()
SpringAiOpenAiHttpClient	buildWithInterceptor(okhttp3.Interceptor interceptor)
SpringAiOpenAiHttpClient.Builder	dispatcherExecutorService(@Nullable ExecutorService dispatcherExecutorService)	Sets the executor used by the OkHttp dispatcher.
SpringAiOpenAiHttpClient.Builder	hostnameVerifier(@Nullable HostnameVerifier hostnameVerifier)
SpringAiOpenAiHttpClient.Builder	keepAliveDuration(@Nullable Duration keepAliveDuration)
SpringAiOpenAiHttpClient.Builder	maxIdleConnections(@Nullable Integer maxIdleConnections)
SpringAiOpenAiHttpClient.Builder	meterRegistry(@Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry)	Registers a meter registry to bind OkHttp connection-pool gauges (active/idle connections).
SpringAiOpenAiHttpClient.Builder	meterTags(Iterable<io.micrometer.core.instrument.Tag> meterTags)	Tags applied to the connection-pool gauges registered with the MeterRegistry.
SpringAiOpenAiHttpClient.Builder	observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)	Registers the Micrometer observation registry used by the OkHttp interceptor.
SpringAiOpenAiHttpClient.Builder	proxy(@Nullable Proxy proxy)
SpringAiOpenAiHttpClient.Builder	proxyAuthenticator(@Nullable com.openai.core.http.ProxyAuthenticator proxyAuthenticator)
SpringAiOpenAiHttpClient.Builder	sslSocketFactory(@Nullable SSLSocketFactory sslSocketFactory)
SpringAiOpenAiHttpClient.Builder	timeout(com.openai.core.Timeout timeout)
SpringAiOpenAiHttpClient.Builder	timeout(Duration timeout)
SpringAiOpenAiHttpClient.Builder	trustManager(@Nullable X509TrustManager trustManager)

Methods inherited from class java.lang.Object

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

Method Details

timeout

public SpringAiOpenAiHttpClient.Builder timeout(com.openai.core.Timeout timeout)

timeout

public SpringAiOpenAiHttpClient.Builder timeout(Duration timeout)

proxy

public SpringAiOpenAiHttpClient.Builder proxy(@Nullable Proxy proxy)

proxyAuthenticator

public SpringAiOpenAiHttpClient.Builder proxyAuthenticator(@Nullable com.openai.core.http.ProxyAuthenticator proxyAuthenticator)

maxIdleConnections

public SpringAiOpenAiHttpClient.Builder maxIdleConnections(@Nullable Integer maxIdleConnections)

keepAliveDuration

public SpringAiOpenAiHttpClient.Builder keepAliveDuration(@Nullable Duration keepAliveDuration)

dispatcherExecutorService

public SpringAiOpenAiHttpClient.Builder dispatcherExecutorService(@Nullable ExecutorService dispatcherExecutorService)

Sets the executor used by the OkHttp dispatcher. When supplied, the caller owns the executor's lifecycle — SpringAiOpenAiHttpClient.close() will not shut it down. When null, an internal default is created and closed with the client.

sslSocketFactory

public SpringAiOpenAiHttpClient.Builder sslSocketFactory(@Nullable SSLSocketFactory sslSocketFactory)

trustManager

public SpringAiOpenAiHttpClient.Builder trustManager(@Nullable X509TrustManager trustManager)

hostnameVerifier

public SpringAiOpenAiHttpClient.Builder hostnameVerifier(@Nullable HostnameVerifier hostnameVerifier)

observationRegistry

public SpringAiOpenAiHttpClient.Builder observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)

Registers the Micrometer observation registry used by the OkHttp interceptor. Defaults to ObservationRegistry.NOOP, which makes the interceptor a no-op — no metric/span overhead in environments that don't wire observability.

meterRegistry

public SpringAiOpenAiHttpClient.Builder meterRegistry(@Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry)

Registers a meter registry to bind OkHttp connection-pool gauges (active/idle connections). Optional; when omitted, no pool gauges are registered.

meterTags

public SpringAiOpenAiHttpClient.Builder meterTags(Iterable<io.micrometer.core.instrument.Tag> meterTags)

Tags applied to the connection-pool gauges registered with the MeterRegistry. Useful for distinguishing multiple clients writing pool metrics into the same registry (e.g. a sync and an async client sharing a registry). Has no effect when no meter registry is set.

build

public SpringAiOpenAiHttpClient build()

buildWithInterceptor

public SpringAiOpenAiHttpClient buildWithInterceptor(okhttp3.Interceptor interceptor)