ai.z.openapi

Class ZaiClient.Builder

java.lang.Object

ai.z.openapi.ZaiClient.Builder

Enclosing class:

ZaiClient

public static final class ZaiClient.Builder
extends Object

Builder class for creating ZaiClient instances with custom configurations. This builder provides a fluent API for setting up the client with various options including authentication, network settings, and connection pooling.

Example usage:

 ZaiClient client = new ZaiClient.Builder("your-api-key")
     .networkConfig(30, 10, 30, 30, TimeUnit.SECONDS)
     .connectionPool(10, 5, TimeUnit.MINUTES)
     .enableTokenCache()
     .build();
 

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(String apiKey) Creates a new builder with the specified API key.
Builder(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
ZaiClient.Builder	apiKey(String apiKey) Config the apikey
ZaiClient.Builder	baseUrl(String baseUrl) Config the api service base url
ZaiClient	build() Builds and returns a new ZaiClient instance with the configured settings.
ZaiClient.Builder	connectionPool(int maxIdleConnections, long keepAliveDuration, TimeUnit timeUnit) Configures the HTTP connection pool settings.
ZaiClient.Builder	disableTokenCache() Disables token caching, forcing the client to use API keys for direct requests.
ZaiClient.Builder	enableTokenCache() Enables token caching, allowing the client to use access tokens for requests.
ZaiClient.Builder	networkConfig(int requestTimeOut, int connectTimeout, int readTimeout, int writeTimeout, TimeUnit timeUnit) Configures network request timeout settings.
ZaiClient.Builder	ofZAI() Use the Z AI base url
ZaiClient.Builder	ofZHIPU() Use the ZHIPU AI base url
ZaiClient.Builder	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

Constructor Detail

Builder

public Builder()

Builder

public Builder(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

Builder

public Builder(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

baseUrl

public ZaiClient.Builder baseUrl(String baseUrl)

Config the api service base url

Parameters:

baseUrl - base url

Returns:

this Builder instance for method chaining

apiKey

public ZaiClient.Builder apiKey(String apiKey)

Config the apikey

Parameters:

apiKey - api key

Returns:

this Builder instance for method chaining

ofZHIPU

public ZaiClient.Builder ofZHIPU()

Use the ZHIPU AI base url

Returns:

this Builder instance for method chaining

ofZAI

public ZaiClient.Builder ofZAI()

Use the Z AI base url

Returns:

this Builder instance for method chaining

disableTokenCache

public ZaiClient.Builder 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 ZaiClient.Builder 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 ZaiClient.Builder 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 ZaiClient.Builder 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 ZaiClient.Builder networkConfig(int requestTimeOut,
                                       int connectTimeout,
                                       int readTimeout,
                                       int writeTimeout,
                                       TimeUnit timeUnit)

Configures network request timeout settings.

Parameters:

requestTimeOut - the overall request timeout (see OkHttpClient.Builder#callTimeout(long, TimeUnit))

connectTimeout - the connection timeout (see OkHttpClient.Builder#connectTimeout(long, TimeUnit))

readTimeout - the read timeout (see OkHttpClient.Builder#readTimeout(long, TimeUnit))

writeTimeout - the write timeout (see OkHttpClient.Builder#writeTimeout(long, TimeUnit))

timeUnit - the time unit for all timeout values

Returns:

this Builder instance for method chaining

build

public ZaiClient build()

Builds and returns a new ZaiClient instance with the configured settings.

Returns:

a new ZaiClient instance

Throws:

IllegalStateException - if the configuration is invalid