ai.z.openapi

Class AbstractAiClient.AbstractBuilder<T extends AbstractAiClient,B extends AbstractAiClient.AbstractBuilder<T,B>>

java.lang.Object

ai.z.openapi.AbstractAiClient.AbstractBuilder<T,B>

Direct Known Subclasses:

ZaiClient.Builder, ZhipuAiClient.Builder

Enclosing class:

AbstractAiClient

public abstract static class AbstractAiClient.AbstractBuilder<T extends AbstractAiClient,B extends AbstractAiClient.AbstractBuilder<T,B>>
extends Object

Abstract base builder class for creating AI client instances with custom configurations. This builder provides common functionality for setting up clients with various options including authentication, network settings, and connection pooling.

Field Summary

Fields

Modifier and Type	Field and Description
protected ZaiConfig	config Configuration object that accumulates all builder settings

Constructor Summary

Constructors

Constructor and Description
AbstractBuilder()
AbstractBuilder(String apiKey) Creates a new builder with the specified API key.
AbstractBuilder(String baseUrl, String apiKey) Creates a new builder with a custom base URL and API secret key.

Method Summary

Modifier and Type	Method and Description
B	apiKey(String apiKey) Config the apikey
B	baseUrl(String baseUrl) Config the api service base url
abstract T	build() Builds and returns a new AI client instance with the configured settings.
B	connectionPool(int maxIdleConnections, long keepAliveDuration, TimeUnit timeUnit) Configures the HTTP connection pool settings.
B	customHeaders(Map<String,String> customHeaders) Config the custom headers
B	disableTokenCache() Disables token caching, forcing the client to use API keys for direct requests.
B	enableTokenCache() Enables token caching, allowing the client to use access tokens for requests.
B	networkConfig(int requestTimeOut, int connectTimeout, int readTimeout, int writeTimeout, TimeUnit timeUnit) Configures network request timeout settings.
protected B	self() Returns this builder instance with proper type casting for method chaining.
B	tokenExpire(int expireMillis) Sets the token expiration time in milliseconds.

Methods inherited from class java.lang.Object

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

Field Detail

config

protected final ZaiConfig config

Configuration object that accumulates all builder settings

Constructor Detail

AbstractBuilder

public AbstractBuilder()

AbstractBuilder

public AbstractBuilder(String apiKey)

Creates a new builder with the specified API key.

Parameters:

apiKey - the API key for authentication

Throws:

IllegalArgumentException - if apiKey is null or empty

AbstractBuilder

public AbstractBuilder(String baseUrl,
                       String apiKey)

Creates a new builder with a custom base URL and API secret key.

Parameters:

baseUrl - the custom base URL for the API endpoint

apiKey - the API secret key for authentication

Throws:

IllegalArgumentException - if any parameter is null or empty

Method Detail

self

protected B self()

Returns this builder instance with proper type casting for method chaining.

Returns:

this builder instance

baseUrl

public B baseUrl(String baseUrl)

Config the api service base url

Parameters:

baseUrl - base url

Returns:

this Builder instance for method chaining

apiKey

public B apiKey(String apiKey)

Config the apikey

Parameters:

apiKey - api key

Returns:

this Builder instance for method chaining

customHeaders

public B customHeaders(Map<String,String> customHeaders)

Config the custom headers

Parameters:

customHeaders - custom headers

Returns:

this Builder instance for method chaining

disableTokenCache

public B disableTokenCache()

Disables token caching, forcing the client to use API keys for direct requests. This is the default behavior.

Returns:

this Builder instance for method chaining

enableTokenCache

public B enableTokenCache()

Enables token caching, allowing the client to use access tokens for requests. This can improve performance by reducing authentication overhead.

Returns:

this Builder instance for method chaining

connectionPool

public B connectionPool(int maxIdleConnections,
                        long keepAliveDuration,
                        TimeUnit timeUnit)

Configures the HTTP connection pool settings.

Parameters:

maxIdleConnections - maximum number of idle connections to keep in the pool

keepAliveDuration - how long to keep idle connections alive

timeUnit - the time unit for the keep alive duration

Returns:

this Builder instance for method chaining

tokenExpire

public B tokenExpire(int expireMillis)

Sets the token expiration time in milliseconds.

Parameters:

expireMillis - the token expiration time in milliseconds

Returns:

this Builder instance for method chaining

networkConfig

public B networkConfig(int requestTimeOut,
                       int connectTimeout,
                       int readTimeout,
                       int writeTimeout,
                       TimeUnit timeUnit)

Configures network request timeout settings.

Parameters:

requestTimeOut - the overall request timeout, 0 is no timeout

connectTimeout - the connection timeout

readTimeout - the read timeout

writeTimeout - the write timeout

timeUnit - the time unit for all timeout values

Returns:

this Builder instance for method chaining

build

public abstract T build()

Builds and returns a new AI client instance with the configured settings.

Returns:

a new AI client instance

Throws:

IllegalStateException - if the configuration is invalid