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 that provides access to Google's Gemini language models.

Key features include:

• Support for multiple Gemini model versions including Gemini Pro, Gemini 1.5 Pro, Gemini 1.5/2.0 Flash variants
• Tool/Function calling capabilities through ToolCallingManager
• Streaming support via stream(Prompt) method
• Configurable safety settings through VertexAiGeminiSafetySetting
• Support for system messages and multi-modal content (text and images)
• Built-in retry mechanism and observability through Micrometer
• Google Search Retrieval integration

The model can be configured with various options including temperature, top-k, top-p sampling, maximum output tokens, and candidate count through VertexAiGeminiChatOptions.

Use the VertexAiGeminiChatModel.Builder to create instances with custom configurations:

 VertexAiGeminiChatModel model = VertexAiGeminiChatModel.builder()
 		.vertexAI(vertexAI)
 		.defaultOptions(options)
 		.toolCallingManager(toolManager)
 		.build();
 

Since:

0.8.1

Author:

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

See Also:

• VertexAiGeminiChatOptions
• ToolCallingManager
• VertexAiGeminiChatModel.ChatModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VertexAiGeminiChatModel.Builder
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

functionCallbackRegister, functionCallbackResolver, IS_RUNTIME_CALL

Constructor Summary

Constructors

Constructor	Description
VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI)	Deprecated. Use VertexAiGeminiChatModel.Builder.
VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI, VertexAiGeminiChatOptions options)	Deprecated. Use VertexAiGeminiChatModel.Builder.
VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI, VertexAiGeminiChatOptions options, FunctionCallbackResolver functionCallbackResolver)	Deprecated. Use VertexAiGeminiChatModel.Builder.
VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI, VertexAiGeminiChatOptions options, FunctionCallbackResolver functionCallbackResolver, List<FunctionCallback> toolFunctionCallbacks)	Deprecated. Use VertexAiGeminiChatModel.Builder.
VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI, VertexAiGeminiChatOptions options, FunctionCallbackResolver functionCallbackResolver, List<FunctionCallback> toolFunctionCallbacks, org.springframework.retry.support.RetryTemplate retryTemplate)	Deprecated. Use VertexAiGeminiChatModel.Builder.
VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI, VertexAiGeminiChatOptions options, FunctionCallbackResolver functionCallbackResolver, List<FunctionCallback> toolFunctionCallbacks, org.springframework.retry.support.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)	Deprecated. Use VertexAiGeminiChatModel.Builder.
VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI, VertexAiGeminiChatOptions defaultOptions, ToolCallingManager toolCallingManager, org.springframework.retry.support.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)	Creates a new instance of VertexAiGeminiChatModel.

Method Summary

Modifier and Type	Method	Description
static VertexAiGeminiChatModel.Builder	builder()
ChatResponse	call(Prompt prompt)	Executes a method call to the AI model.
void	destroy()
ChatOptions	getDefaultOptions()
reactor.core.publisher.Flux<ChatResponse>	internalStream(Prompt prompt)
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

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

Deprecated.

Use VertexAiGeminiChatModel.Builder.

VertexAiGeminiChatModel

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

Deprecated.

Use VertexAiGeminiChatModel.Builder.

VertexAiGeminiChatModel

@Deprecated
public VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI,
 VertexAiGeminiChatOptions options,
 FunctionCallbackResolver functionCallbackResolver)

Deprecated.

Use VertexAiGeminiChatModel.Builder.

VertexAiGeminiChatModel

@Deprecated
public VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI,
 VertexAiGeminiChatOptions options,
 FunctionCallbackResolver functionCallbackResolver,
 List<FunctionCallback> toolFunctionCallbacks)

Deprecated.

Use VertexAiGeminiChatModel.Builder.

VertexAiGeminiChatModel

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

Deprecated.

Use VertexAiGeminiChatModel.Builder.

VertexAiGeminiChatModel

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

Deprecated.

Use VertexAiGeminiChatModel.Builder.

VertexAiGeminiChatModel

public VertexAiGeminiChatModel(com.google.cloud.vertexai.VertexAI vertexAI,
 VertexAiGeminiChatOptions defaultOptions,
 ToolCallingManager toolCallingManager,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Creates a new instance of VertexAiGeminiChatModel.

Parameters:

vertexAI - the Vertex AI instance to use

defaultOptions - the default options to use

toolCallingManager - the tool calling manager to use. It is wrapped in a VertexToolCallingManager to ensure compatibility with Vertex AI's OpenAPI schema format.

retryTemplate - the retry template to use

observationRegistry - the observation registry to use

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

internalStream

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

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

builder

public static VertexAiGeminiChatModel.Builder builder()