Package org.springframework.ai.vertexai.gemini

Class VertexAiGeminiChatModel

java.lang.Object

org.springframework.ai.chat.model.AbstractToolCallSupport

org.springframework.ai.vertexai.gemini.VertexAiGeminiChatModel

All Implemented Interfaces:

ChatModel, StreamingChatModel, Model<Prompt,ChatResponse>, StreamingModel<Prompt,ChatResponse>, org.springframework.beans.factory.DisposableBean

public class VertexAiGeminiChatModel
extends AbstractToolCallSupport
implements ChatModel, org.springframework.beans.factory.DisposableBean

Vertex AI Gemini Chat Model implementation.

Since:

0.8.1

Author:

Christian Tzolov, Grogdunn, luocongqiu, Chris Turchin, Mark Pollack, Soby Chacko, Jihoon Kim

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	VertexAiGeminiChatModel.ChatModel
static enum	VertexAiGeminiChatModel.GeminiMessageType
static final record	VertexAiGeminiChatModel.GeminiRequest

Field Summary

Fields inherited from class org.springframework.ai.chat.model.AbstractToolCallSupport

functionCallbackContext, functionCallbackRegister, IS_RUNTIME_CALL

Constructor Summary

Constructors

Constructor	Description
VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI)
VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI, VertexAiGeminiChatOptions options)
VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI, VertexAiGeminiChatOptions options, FunctionCallbackContext functionCallbackContext)
VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI, VertexAiGeminiChatOptions options, FunctionCallbackContext functionCallbackContext, List<FunctionCallback> toolFunctionCallbacks)
VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI, VertexAiGeminiChatOptions options, FunctionCallbackContext functionCallbackContext, List<FunctionCallback> toolFunctionCallbacks, org.springframework.retry.support.RetryTemplate retryTemplate)
VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI, VertexAiGeminiChatOptions options, FunctionCallbackContext functionCallbackContext, List<FunctionCallback> toolFunctionCallbacks, org.springframework.retry.support.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)

Method Summary

Modifier and Type	Method	Description
ChatResponse	call(Prompt prompt)	Executes a method call to the AI model.
void	destroy()
ChatOptions	getDefaultOptions()
protected List<Generation>	responseCandidateToGeneration(com.google.cloud.vertexai.api.Candidate candidate)
void	setObservationConvention(ChatModelObservationConvention observationConvention)	Use the provided convention for reporting observation data
reactor.core.publisher.Flux<ChatResponse>	stream(Prompt prompt)	Executes a method call to the AI model.

Methods inherited from class org.springframework.ai.chat.model.AbstractToolCallSupport

buildToolCallConversation, executeFunctions, getFunctionCallbackRegister, handleToolCalls, isProxyToolCalls, isToolCall, isToolCall, resolveFunctionCallbacks, runtimeFunctionCallbackConfigurations

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

Constructor Details

VertexAiGeminiChatModel

public VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI)

VertexAiGeminiChatModel

public VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI,
 VertexAiGeminiChatOptions options)

VertexAiGeminiChatModel

public VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI,
 VertexAiGeminiChatOptions options,
 FunctionCallbackContext functionCallbackContext)

VertexAiGeminiChatModel

public VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI,
 VertexAiGeminiChatOptions options,
 FunctionCallbackContext functionCallbackContext,
 List<FunctionCallback> toolFunctionCallbacks)

VertexAiGeminiChatModel

public VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI,
 VertexAiGeminiChatOptions options,
 FunctionCallbackContext functionCallbackContext,
 List<FunctionCallback> toolFunctionCallbacks,
 org.springframework.retry.support.RetryTemplate retryTemplate)

VertexAiGeminiChatModel

public VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI,
 VertexAiGeminiChatOptions options,
 FunctionCallbackContext functionCallbackContext,
 List<FunctionCallback> toolFunctionCallbacks,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry)

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

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

responseCandidateToGeneration

protected List<Generation> responseCandidateToGeneration(com.google.cloud.vertexai.api.Candidate candidate)

getDefaultOptions

public ChatOptions getDefaultOptions()

Specified by:

getDefaultOptions in interface ChatModel

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

setObservationConvention

public void setObservationConvention(ChatModelObservationConvention observationConvention)

Use the provided convention for reporting observation data

Parameters:

observationConvention - The provided convention