Class ZhiPuAiApi

java.lang.Object

org.springframework.ai.zhipuai.api.ZhiPuAiApi

public class ZhiPuAiApi
extends Object

Single class implementation of the ZhiPuAI Chat Completion API and ZhiPuAI Embedding API.

Since:

1.0.0

Author:

Geng Rong, Thomas Vitale, YunKui Lu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ZhiPuAiApi.Builder
static final record	ZhiPuAiApi.ChatCompletion	Represents a chat completion response returned by model, based on the provided input.
static final record	ZhiPuAiApi.ChatCompletionChunk	Represents a streamed chunk of a chat completion response returned by model, based on the provided input.
static enum	ZhiPuAiApi.ChatCompletionFinishReason	The reason the model stopped generating tokens.
static final record	ZhiPuAiApi.ChatCompletionMessage	Message comprising the conversation.
static final record	ZhiPuAiApi.ChatCompletionRequest	Creates a model response for the given chat conversation.
static enum	ZhiPuAiApi.ChatModel	ZhiPuAI Chat Completion Models: ZhiPuAI Model.
static final record	ZhiPuAiApi.Embedding	Represents an embedding vector returned by embedding endpoint.
static final record	ZhiPuAiApi.EmbeddingList<T>	List of multiple embedding responses.
static enum	ZhiPuAiApi.EmbeddingModel	ZhiPuAI Embeddings Models: Embeddings.
static final record	ZhiPuAiApi.EmbeddingRequest<T>	Creates an embedding vector representing the input text.
static class	ZhiPuAiApi.FunctionTool	Represents a tool the model may call.
static final record	ZhiPuAiApi.LogProbs	Log probability information for the choice.
static final record	ZhiPuAiApi.Usage	Usage statistics for the completion request.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CHAT_MODEL
static final String	DEFAULT_COMPLETIONS_PATH
static final String	DEFAULT_EMBEDDING_MODEL
static final String	DEFAULT_EMBEDDINGS_PATH

Constructor Summary

Constructors

Constructor	Description
ZhiPuAiApi(String baseUrl, ApiKey apiKey, org.springframework.http.HttpHeaders headers, String completionsPath, String embeddingsPath, org.springframework.web.client.ResponseErrorHandler responseErrorHandler, org.springframework.web.client.RestClient restClient, org.springframework.web.reactive.function.client.WebClient webClient)	Create a new chat completion api.

Method Summary

Modifier and Type	Method	Description
static ZhiPuAiApi.Builder	builder()
org.springframework.http.ResponseEntity<ZhiPuAiApi.ChatCompletion>	chatCompletionEntity(ZhiPuAiApi.ChatCompletionRequest chatRequest)	Creates a model response for the given chat conversation.
org.springframework.http.ResponseEntity<ZhiPuAiApi.ChatCompletion>	chatCompletionEntity(ZhiPuAiApi.ChatCompletionRequest chatRequest, org.springframework.http.HttpHeaders additionalHttpHeader)	Creates a model response for the given chat conversation.
reactor.core.publisher.Flux<ZhiPuAiApi.ChatCompletionChunk>	chatCompletionStream(ZhiPuAiApi.ChatCompletionRequest chatRequest)	Creates a streaming chat response for the given chat conversation.
reactor.core.publisher.Flux<ZhiPuAiApi.ChatCompletionChunk>	chatCompletionStream(ZhiPuAiApi.ChatCompletionRequest chatRequest, org.springframework.http.HttpHeaders additionalHttpHeader)	Creates a streaming chat response for the given chat conversation.
<T> org.springframework.http.ResponseEntity<ZhiPuAiApi.EmbeddingList<ZhiPuAiApi.Embedding>>	embeddings(ZhiPuAiApi.EmbeddingRequest<T> embeddingRequest)	Creates an embedding vector representing the input text or token array.
static String	getTextContent(List<ZhiPuAiApi.ChatCompletionMessage.MediaContent> content)
ZhiPuAiApi.Builder	mutate()	Returns a builder pre-populated with the current configuration for mutation.

Methods inherited from class Object

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

Field Details

DEFAULT_CHAT_MODEL

public static final String DEFAULT_CHAT_MODEL

DEFAULT_EMBEDDING_MODEL

public static final String DEFAULT_EMBEDDING_MODEL

DEFAULT_EMBEDDINGS_PATH

public static final String DEFAULT_EMBEDDINGS_PATH

See Also:

• Constant Field Values

DEFAULT_COMPLETIONS_PATH

public static final String DEFAULT_COMPLETIONS_PATH

See Also:

• Constant Field Values

Constructor Details

ZhiPuAiApi

public ZhiPuAiApi(String baseUrl,
 ApiKey apiKey,
 org.springframework.http.HttpHeaders headers,
 String completionsPath,
 String embeddingsPath,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler,
 org.springframework.web.client.RestClient restClient,
 org.springframework.web.reactive.function.client.WebClient webClient)

Create a new chat completion api.

Parameters:

baseUrl - api base URL.

apiKey - ZhiPuAI apiKey.

headers - the http headers to use.

completionsPath - the path to the chat completions endpoint.

embeddingsPath - the path to the embeddings endpoint.

responseErrorHandler - Response error handler.

restClient - RestClient instance.

webClient - WebClient instance.

Method Details

mutate

public ZhiPuAiApi.Builder mutate()

Returns a builder pre-populated with the current configuration for mutation.

builder

public static ZhiPuAiApi.Builder builder()

getTextContent

public static String getTextContent(List<ZhiPuAiApi.ChatCompletionMessage.MediaContent> content)

chatCompletionEntity

public org.springframework.http.ResponseEntity<ZhiPuAiApi.ChatCompletion> chatCompletionEntity(ZhiPuAiApi.ChatCompletionRequest chatRequest)

Creates a model response for the given chat conversation.

Parameters:

chatRequest - The chat completion request.

Returns:

Entity response with ZhiPuAiApi.ChatCompletion as a body and HTTP status code and headers.

chatCompletionEntity

public org.springframework.http.ResponseEntity<ZhiPuAiApi.ChatCompletion> chatCompletionEntity(ZhiPuAiApi.ChatCompletionRequest chatRequest,
 org.springframework.http.HttpHeaders additionalHttpHeader)

Creates a model response for the given chat conversation.

Parameters:

chatRequest - The chat completion request.

Returns:

Entity response with ZhiPuAiApi.ChatCompletion as a body and HTTP status code and headers.

chatCompletionStream

public reactor.core.publisher.Flux<ZhiPuAiApi.ChatCompletionChunk> chatCompletionStream(ZhiPuAiApi.ChatCompletionRequest chatRequest)

Creates a streaming chat response for the given chat conversation.

Parameters:

chatRequest - The chat completion request. Must have the stream property set to true.

Returns:

Returns a Flux stream from chat completion chunks.

chatCompletionStream

public reactor.core.publisher.Flux<ZhiPuAiApi.ChatCompletionChunk> chatCompletionStream(ZhiPuAiApi.ChatCompletionRequest chatRequest,
 org.springframework.http.HttpHeaders additionalHttpHeader)

Creates a streaming chat response for the given chat conversation.

Parameters:

chatRequest - The chat completion request. Must have the stream property set to true.

Returns:

Returns a Flux stream from chat completion chunks.

embeddings

public <T>
org.springframework.http.ResponseEntity<ZhiPuAiApi.EmbeddingList<ZhiPuAiApi.Embedding>> embeddings(ZhiPuAiApi.EmbeddingRequest<T> embeddingRequest)

Creates an embedding vector representing the input text or token array.

Type Parameters:

T - Type of the entity in the data list. Can be a String or List of tokens (e.g. Integers). For embedding multiple inputs in a single request, You can pass a List of String or List of List of tokens. For example:

List.of("text1", "text2", "text3") or List.of(List.of(1, 2, 3), List.of(3, 4, 5)) 

Parameters:

embeddingRequest - The embedding request.

Returns:

Returns list of ZhiPuAiApi.Embedding wrapped in ZhiPuAiApi.EmbeddingList.