Package org.springframework.ai.zhipuai

Class ZhiPuAiChatModel

java.lang.Object

org.springframework.ai.zhipuai.ZhiPuAiChatModel

All Implemented Interfaces:

ChatModel, StreamingChatModel, Model<Prompt,ChatResponse>, StreamingModel<Prompt,ChatResponse>

public class ZhiPuAiChatModel
extends Object
implements ChatModel

ChatModel and StreamingChatModel implementation for ZhiPuAI backed by ZhiPuAiApi.

Since:

1.0.0 M1

Author:

Geng Rong, Alexandros Pappas, Ilayaperumal Gopinathan

See Also:

• ChatModel
• StreamingChatModel
• ZhiPuAiApi

Field Summary

Fields

Modifier and Type	Field	Description
final org.springframework.retry.support.RetryTemplate	retryTemplate	The retry template used to retry the ZhiPuAI API calls.

Constructor Summary

Constructors

Constructor	Description
ZhiPuAiChatModel(ZhiPuAiApi zhiPuAiApi)	Creates an instance of the ZhiPuAiChatModel.
ZhiPuAiChatModel(ZhiPuAiApi zhiPuAiApi, ZhiPuAiChatOptions options)	Initializes an instance of the ZhiPuAiChatModel.
ZhiPuAiChatModel(ZhiPuAiApi zhiPuAiApi, ZhiPuAiChatOptions options, ToolCallingManager toolCallingManager, org.springframework.retry.support.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)	Initializes an instance of the ZhiPuAiChatModel.
ZhiPuAiChatModel(ZhiPuAiApi zhiPuAiApi, ZhiPuAiChatOptions options, ToolCallingManager toolCallingManager, org.springframework.retry.support.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry, ToolExecutionEligibilityPredicate toolExecutionEligibilityPredicate)	Initializes a new instance of the ZhiPuAiChatModel.
ZhiPuAiChatModel(ZhiPuAiApi zhiPuAiApi, ZhiPuAiChatOptions options, org.springframework.retry.support.RetryTemplate retryTemplate)	Initializes an instance of the ZhiPuAiChatModel.
ZhiPuAiChatModel(ZhiPuAiApi zhiPuAiApi, ZhiPuAiChatOptions options, org.springframework.retry.support.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)	Initializes an instance of the ZhiPuAiChatModel.

Method Summary

Modifier and Type	Method	Description
ChatResponse	call(Prompt prompt)	Executes a method call to the AI model.
ChatOptions	getDefaultOptions()
void	setObservationConvention(ChatModelObservationConvention observationConvention)
reactor.core.publisher.Flux<ChatResponse>	stream(Prompt prompt)	Executes a method call to the AI model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.chat.model.ChatModel

call, call

Methods inherited from interface org.springframework.ai.chat.model.StreamingChatModel

stream, stream

Field Details

retryTemplate

public final org.springframework.retry.support.RetryTemplate retryTemplate

The retry template used to retry the ZhiPuAI API calls.

Constructor Details

ZhiPuAiChatModel

public ZhiPuAiChatModel(ZhiPuAiApi zhiPuAiApi)

Creates an instance of the ZhiPuAiChatModel.

Parameters:

zhiPuAiApi - The ZhiPuAiApi instance to be used for interacting with the ZhiPuAI Chat API.

Throws:

IllegalArgumentException - if zhiPuAiApi is null

ZhiPuAiChatModel

public ZhiPuAiChatModel(ZhiPuAiApi zhiPuAiApi,
 ZhiPuAiChatOptions options)

Initializes an instance of the ZhiPuAiChatModel.

Parameters:

zhiPuAiApi - The ZhiPuAiApi instance to be used for interacting with the ZhiPuAI Chat API.

options - The ZhiPuAiChatOptions to configure the chat model.

ZhiPuAiChatModel

public ZhiPuAiChatModel(ZhiPuAiApi zhiPuAiApi,
 ZhiPuAiChatOptions options,
 org.springframework.retry.support.RetryTemplate retryTemplate)

Initializes an instance of the ZhiPuAiChatModel.

Parameters:

zhiPuAiApi - The ZhiPuAiApi instance to be used for interacting with the ZhiPuAI Chat API.

options - The ZhiPuAiChatOptions to configure the chat model.

retryTemplate - The retry template.

ZhiPuAiChatModel

public ZhiPuAiChatModel(ZhiPuAiApi zhiPuAiApi,
 ZhiPuAiChatOptions options,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Initializes an instance of the ZhiPuAiChatModel.

Parameters:

zhiPuAiApi - The ZhiPuAiApi instance to be used for interacting with the ZhiPuAI Chat API.

options - The ZhiPuAiChatOptions to configure the chat model.

retryTemplate - The retry template.

observationRegistry - The Observation Registry.

ZhiPuAiChatModel

public ZhiPuAiChatModel(ZhiPuAiApi zhiPuAiApi,
 ZhiPuAiChatOptions options,
 ToolCallingManager toolCallingManager,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Initializes an instance of the ZhiPuAiChatModel.

Parameters:

zhiPuAiApi - The ZhiPuAiApi instance to be used for interacting with the ZhiPuAI Chat API.

options - The ZhiPuAiChatOptions to configure the chat model.

toolCallingManager - The tool calling manager

retryTemplate - The retry template.

observationRegistry - The Observation Registry.

ZhiPuAiChatModel

public ZhiPuAiChatModel(ZhiPuAiApi zhiPuAiApi,
 ZhiPuAiChatOptions options,
 ToolCallingManager toolCallingManager,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry,
 ToolExecutionEligibilityPredicate toolExecutionEligibilityPredicate)

Initializes a new instance of the ZhiPuAiChatModel.

Parameters:

zhiPuAiApi - The ZhiPuAiApi instance to be used for interacting with the ZhiPuAI Chat API.

options - The ZhiPuAiChatOptions to configure the chat model.

toolCallingManager - The tool calling manager

retryTemplate - The retry template.

observationRegistry - The ObservationRegistry used for instrumentation.

toolExecutionEligibilityPredicate - The Tool execution eligibility predicate.

Method Details

call

public ChatResponse call(Prompt prompt)

Description copied from interface: Model

Executes a method call to the AI model.

Specified by:

call in interface ChatModel

Specified by:

call in interface Model<Prompt,ChatResponse>

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the response from the AI model

getDefaultOptions

public ChatOptions getDefaultOptions()

Specified by:

getDefaultOptions in interface ChatModel

stream

public reactor.core.publisher.Flux<ChatResponse> stream(Prompt prompt)

Description copied from interface: StreamingModel

Executes a method call to the AI model.

Specified by:

stream in interface ChatModel

Specified by:

stream in interface StreamingChatModel

Specified by:

stream in interface StreamingModel<Prompt,ChatResponse>

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the streaming response from the AI model

setObservationConvention

public void setObservationConvention(ChatModelObservationConvention observationConvention)