ai.z.openapi

Class AbstractAiClient

java.lang.Object

ai.z.openapi.service.AbstractClientBaseService

ai.z.openapi.AbstractAiClient

Direct Known Subclasses:

ZaiClient, ZhipuAiClient

public abstract class AbstractAiClient
extends AbstractClientBaseService

AbstractAiClient is the abstract base class for AI client implementations. This class provides common functionality for interacting with AI APIs including service management, request execution, and resource management.

This class serves as the foundation for specific AI client implementations such as ZaiClient and ZhipuAiClient, providing shared functionality while allowing each implementation to have its own static factory methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractAiClient.AbstractBuilder<T extends AbstractAiClient,B extends AbstractAiClient.AbstractBuilder<T,B>> Abstract base builder class for creating AI client instances with custom configurations.

Field Summary

Fields

Modifier and Type	Field and Description
protected okhttp3.OkHttpClient	httpClient HTTP client for making network requests
protected retrofit2.Retrofit	retrofit Retrofit instance for API communication

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

mapper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAiClient(ZaiConfig config, String baseUrl) Constructs a new AbstractAiClient 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.
ChatService	chat() Returns the chat service for conversational AI operations.
void	close() Closes the AI client and releases all associated resources.
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.
FileParsingService	fileParsing() Returns the file service for file operations.
FileService	files() Returns the file service for file operations.
HandwritingOcrService	handwriting()
ImageService	images() Returns the image service for image generation and processing.
ModerationService	moderations() Returns the moderation service for content safety detection.
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.
VoiceCloneService	voiceClone() Returns the voice clone service for voice cloning operations.
WebReaderService	webReader() Returns the web reader service for parsing web pages.
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

Field Detail

httpClient

protected final okhttp3.OkHttpClient httpClient

HTTP client for making network requests

retrofit

protected final retrofit2.Retrofit retrofit

Retrofit instance for API communication

Constructor Detail

AbstractAiClient

protected AbstractAiClient(ZaiConfig config,
                           String baseUrl)

Constructs a new AbstractAiClient with the specified configuration.

Parameters:

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

baseUrl - the base URL for the API endpoint

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)

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)

webReader

public WebReaderService webReader()

Returns the web reader service for parsing web pages. This service reads and extracts content, metadata, images, and links from URLs.

Returns:

the WebReaderService 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)

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)

voiceClone

public VoiceCloneService voiceClone()

Returns the voice clone service for voice cloning operations. This service handles voice cloning creation, deletion, and listing functionality.

Returns:

the VoiceCloneService instance (lazily initialized)

fileParsing

public FileParsingService fileParsing()

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

Returns:

the FileParsingService instance (lazily initialized)

handwriting

public HandwritingOcrService handwriting()

moderations

public ModerationService moderations()

Returns the moderation service for content safety detection. This service handles content moderation for text, image, video, and audio inputs.

Returns:

the ModerationService 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 AI 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