ai.z.openapi

Class ZaiClient

java.lang.Object

ai.z.openapi.service.AbstractClientBaseService

ai.z.openapi.ZaiClient

public class ZaiClient
extends AbstractClientBaseService

ZaiClient is the main entry point for interacting with the Z.ai API. This client provides access to various AI services including chat, embeddings, file operations, audio processing, image generation, and more.

The client supports both Z.ai and ZHIPU AI endpoints and provides thread-safe lazy initialization of services.

Example usage:

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

 ChatService chatService = client.chat();
 // Use the chat service...

 client.close(); // Don't forget to close when done
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZaiClient.Builder Builder class for creating ZaiClient instances with custom configurations.

Field Summary

Fields inherited from class ai.z.openapi.service.AbstractClientBaseService

mapper

Constructor Summary

Constructors

Constructor and Description
ZaiClient(ZaiConfig config) Constructs a new ZaiClient with the specified configuration.

Method Summary

Modifier and Type	Method and Description
AgentService	agents() Returns the agent service for AI agent management.
AssistantService	assistants() Returns the assistant service for AI assistant functionality.
AudioService	audio() Returns the audio service for audio processing.
BatchService	batches() Returns the batch service for batch processing operations.
<Data,F,Param,TReq extends ClientRequest<Param>,TResp extends BiFlowableClientResponse<Data,F>> TResp	biStreamRequest(TReq request, FlowableRequestSupplier<Param,retrofit2.Call<okhttp3.ResponseBody>> requestSupplier, Class<TResp> tRespClass, Class<F> tStreamDataClass) Executes a streaming API request and returns a BiFlowableClientResponse where response body and stream element type can differ.
static ZaiClient.Builder	builder() Creates a new Builder instance for constructing ZaiClient.
ChatService	chat() Returns the chat service for conversational AI operations.
void	close() Closes the ZAi client and releases all associated resources.
DocumentService	documents() Returns the document service for document processing.
EmbeddingService	embeddings() Returns the embedding service for text embeddings.
<Data,Param,TReq extends ClientRequest<Param>,TResp extends ClientResponse<Data>> TResp	executeRequest(TReq request, RequestSupplier<Param,Data> requestSupplier, Class<TResp> tRespClass) Executes a synchronous API request and returns the response.
FileService	files() Returns the file service for file operations.
FineTuningService	fineTuning() Returns the fine-tuning service for model customization.
ImageService	images() Returns the image service for image generation and processing.
KnowledgeService	knowledge() Returns the knowledge service for knowledge base operations.
static ZaiClient.Builder	ofZHIPU() Creates a ZaiClient configured for ZHIPU AI platform with the specified API key.
static ZaiClient.Builder	ofZHIPU(String apiKey) Creates a ZaiClient configured for ZHIPU AI platform with the specified API key.
retrofit2.Retrofit	retrofit() Returns the underlying Retrofit instance used for API communication.
<Data,Param,TReq extends ClientRequest<Param>,TResp extends FlowableClientResponse<Data>> TResp	streamRequest(TReq request, FlowableRequestSupplier<Param,retrofit2.Call<okhttp3.ResponseBody>> requestSupplier, Class<TResp> tRespClass, Class<Data> tDataClass) Executes a streaming API request and returns a FlowableClientResponse with stream elements of type Data.
VideosService	videos() Returns the videos service for video processing.
WebSearchService	webSearch() Returns the web search service for internet search capabilities.

Methods inherited from class ai.z.openapi.service.AbstractClientBaseService

execute, stream, stream, stream

Methods inherited from class java.lang.Object

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

Constructor Detail

ZaiClient

public ZaiClient(ZaiConfig config)

Constructs a new ZaiClient with the specified configuration. By default, this client uses the Z.ai OpenAPI endpoint.

Parameters:

config - the configuration object containing API keys, timeouts, and other settings

Throws:

IllegalArgumentException - if config is null or invalid

Method Detail

chat

public ChatService chat()

Returns the chat service for conversational AI operations. This service handles chat completions, streaming conversations, and related functionality.

Returns:

the ChatService instance (lazily initialized)

agents

public AgentService agents()

Returns the agent service for AI agent management. This service handles agent creation, configuration, and execution.

Returns:

the AgentService instance (lazily initialized)

embeddings

public EmbeddingService embeddings()

Returns the embedding service for text embeddings. This service converts text into numerical vector representations.

Returns:

the EmbeddingService instance (lazily initialized)

files

public FileService files()

Returns the file service for file operations. This service handles file uploads, downloads, and management.

Returns:

the FileService instance (lazily initialized)

audio

public AudioService audio()

Returns the audio service for audio processing. This service handles speech-to-text, text-to-speech, and audio analysis.

Returns:

the AudioService instance (lazily initialized)

images

public ImageService images()

Returns the image service for image generation and processing. This service handles image creation, editing, and analysis.

Returns:

the ImageService instance (lazily initialized)

batches

public BatchService batches()

Returns the batch service for batch processing operations. This service handles large-scale batch processing of requests.

Returns:

the BatchService instance (lazily initialized)

fineTuning

public FineTuningService fineTuning()

Returns the fine-tuning service for model customization. This service handles training custom models on user data.

Returns:

the FineTuningService instance (lazily initialized)

webSearch

public WebSearchService webSearch()

Returns the web search service for internet search capabilities. This service provides AI-powered web search functionality.

Returns:

the WebSearchService instance (lazily initialized)

videos

public VideosService videos()

Returns the videos service for video processing. This service handles video analysis, generation, and manipulation.

Returns:

the VideosService instance (lazily initialized)

knowledge

public KnowledgeService knowledge()

Returns the knowledge service for knowledge base operations. This service manages knowledge bases and retrieval operations.

Returns:

the KnowledgeService instance (lazily initialized)

documents

public DocumentService documents()

Returns the document service for document processing. This service handles document parsing, analysis, and manipulation.

Returns:

the DocumentService instance (lazily initialized)

assistants

public AssistantService assistants()

Returns the assistant service for AI assistant functionality. This service provides advanced AI assistant capabilities.

Returns:

the AssistantService instance (lazily initialized)

retrofit

public retrofit2.Retrofit retrofit()

Returns the underlying Retrofit instance used for API communication. This method is primarily intended for advanced users who need direct access to the Retrofit client for custom API calls.

Returns:

the Retrofit instance

close

public void close()

Closes the ZAi client and releases all associated resources. This method shuts down the HTTP client's connection pool and executor service. After calling this method, the client should not be used for further requests.

Important: Always call this method when you're done with the client to prevent resource leaks.

executeRequest

public <Data,Param,TReq extends ClientRequest<Param>,TResp extends ClientResponse<Data>> TResp executeRequest(TReq request,
                                                                                                              RequestSupplier<Param,Data> requestSupplier,
                                                                                                              Class<TResp> tRespClass)

Executes a synchronous API request and returns the response. This method handles the complete request lifecycle including error handling and response wrapping.

Specified by:

executeRequest in class AbstractClientBaseService

Type Parameters:

Data - the type of data expected in the response

Param - the type of parameters for the request

TReq - the type of client request

TResp - the type of client response

Parameters:

request - the client request containing parameters

requestSupplier - the supplier that creates the actual API call

tRespClass - the class of the response type

Returns:

the wrapped response containing either success data or error information

biStreamRequest

public <Data,F,Param,TReq extends ClientRequest<Param>,TResp extends BiFlowableClientResponse<Data,F>> TResp biStreamRequest(TReq request,
                                                                                                                             FlowableRequestSupplier<Param,retrofit2.Call<okhttp3.ResponseBody>> requestSupplier,
                                                                                                                             Class<TResp> tRespClass,
                                                                                                                             Class<F> tStreamDataClass)

Executes a streaming API request and returns a BiFlowableClientResponse where response body and stream element type can differ.

Specified by:

biStreamRequest in class AbstractClientBaseService

Type Parameters:

Data - type of response body

F - type of each element in the stream (can be same as Data)

Param - request param type

TReq - request type

TResp - response type (must extend BiFlowableClientResponse)

Parameters:

request - the request object

requestSupplier - the streaming API supplier

tRespClass - the client response class (must implement BiFlowableClientResponse)

tStreamDataClass - the stream data element class

Returns:

a response containing a Flowable stream

streamRequest

public <Data,Param,TReq extends ClientRequest<Param>,TResp extends FlowableClientResponse<Data>> TResp streamRequest(TReq request,
                                                                                                                     FlowableRequestSupplier<Param,retrofit2.Call<okhttp3.ResponseBody>> requestSupplier,
                                                                                                                     Class<TResp> tRespClass,
                                                                                                                     Class<Data> tDataClass)

Executes a streaming API request and returns a FlowableClientResponse with stream elements of type Data.

Overrides:

streamRequest in class AbstractClientBaseService

Type Parameters:

Data - data type for both response and stream

Param - request param type

TReq - request type

TResp - response type (must extend FlowableClientResponse)

Parameters:

request - the request object

requestSupplier - the streaming API supplier

tRespClass - the client response class (must implement FlowableClientResponse)

tDataClass - the class representing stream data type

Returns:

a response containing a Flowable stream

builder

public static ZaiClient.Builder builder()

Creates a new Builder instance for constructing ZaiClient.

Returns:

a new Builder instance

ofZHIPU

public static ZaiClient.Builder ofZHIPU(String apiKey)

Creates a ZaiClient configured for ZHIPU AI platform with the specified API key.

Parameters:

apiKey - the API key for authentication

Returns:

a new ZaiClient instance configured for ZHIPU AI

Throws:

IllegalArgumentException - if apiKey is null or empty

ofZHIPU

public static ZaiClient.Builder ofZHIPU()

Creates a ZaiClient configured for ZHIPU AI platform with the specified API key.

Returns:

a new ZaiClient instance configured for ZHIPU AI

Throws:

IllegalArgumentException - if apiKey is null or empty