Class VertexAiGeminiChatModel

java.lang.Object

dev.langchain4j.model.vertexai.gemini.VertexAiGeminiChatModel

All Implemented Interfaces:

ChatModel, Closeable, AutoCloseable

public class VertexAiGeminiChatModel
extends Object
implements ChatModel, Closeable

Represents a Google Vertex AI Gemini language model with a chat completion interface, such as gemini-pro. See details here.
Please follow these steps before using this model:
1. Authentication
When developing locally, you can use one of:
a) Google Cloud SDK
b) Service account When using service account, ensure that GOOGLE_APPLICATION_CREDENTIALS environment variable points to your JSON service account key.
2. Authorization
3. Prerequisites

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder

Constructor Summary

Constructors

Constructor	Description
VertexAiGeminiChatModel(com.google.cloud.vertexai.generativeai.GenerativeModel generativeModel, com.google.cloud.vertexai.api.GenerationConfig generationConfig)
VertexAiGeminiChatModel(com.google.cloud.vertexai.generativeai.GenerativeModel generativeModel, com.google.cloud.vertexai.api.GenerationConfig generationConfig, Integer maxRetries)
VertexAiGeminiChatModel(VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder builder)
VertexAiGeminiChatModel(String project, String location, String modelName, Float temperature, Integer maxOutputTokens, Integer topK, Float topP, Integer seed, Integer maxRetries, String responseMimeType, com.google.cloud.vertexai.api.Schema responseSchema, Map<HarmCategory, SafetyThreshold> safetySettings, Boolean useGoogleSearch, String vertexSearchDatastore, ToolCallingMode toolCallingMode, List<String> allowedFunctionNames, Boolean logRequests, Boolean logResponses, List<ChatModelListener> listeners, Set<Capability> supportedCapabilities)	Deprecated, for removal: This API element is subject to removal in a future version. please use VertexAiGeminiChatModel(VertexAiGeminiChatModelBuilder) instead

Method Summary

Modifier and Type	Method	Description
static VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	builder()
ChatResponse	chat(ChatRequest chatRequest)	This is the main API to interact with the chat model.
void	close()
List<ChatModelListener>	listeners()
ModelProvider	provider()
Set<Capability>	supportedCapabilities()

Methods inherited from class Object

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

Methods inherited from interface ChatModel

chat, chat, chat, defaultRequestParameters, doChat

Constructor Details

VertexAiGeminiChatModel

public VertexAiGeminiChatModel(VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder builder)

VertexAiGeminiChatModel

@Deprecated(forRemoval=true,
            since="1.1.0-beta7")
public VertexAiGeminiChatModel(String project,
 String location,
 String modelName,
 Float temperature,
 Integer maxOutputTokens,
 Integer topK,
 Float topP,
 Integer seed,
 Integer maxRetries,
 String responseMimeType,
 com.google.cloud.vertexai.api.Schema responseSchema,
 Map<HarmCategory, SafetyThreshold> safetySettings,
 Boolean useGoogleSearch,
 String vertexSearchDatastore,
 ToolCallingMode toolCallingMode,
 List<String> allowedFunctionNames,
 Boolean logRequests,
 Boolean logResponses,
 List<ChatModelListener> listeners,
 Set<Capability> supportedCapabilities)

Deprecated, for removal: This API element is subject to removal in a future version.

please use VertexAiGeminiChatModel(VertexAiGeminiChatModelBuilder) instead

VertexAiGeminiChatModel

public VertexAiGeminiChatModel(com.google.cloud.vertexai.generativeai.GenerativeModel generativeModel,
 com.google.cloud.vertexai.api.GenerationConfig generationConfig)

VertexAiGeminiChatModel

public VertexAiGeminiChatModel(com.google.cloud.vertexai.generativeai.GenerativeModel generativeModel,
 com.google.cloud.vertexai.api.GenerationConfig generationConfig,
 Integer maxRetries)

Method Details

chat

public ChatResponse chat(ChatRequest chatRequest)

Description copied from interface: ChatModel

This is the main API to interact with the chat model.

Specified by:

chat in interface ChatModel

Parameters:

chatRequest - a ChatRequest, containing all the inputs to the LLM

Returns:

a ChatResponse, containing all the outputs from the LLM

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

supportedCapabilities

public Set<Capability> supportedCapabilities()

Specified by:

supportedCapabilities in interface ChatModel

listeners

public List<ChatModelListener> listeners()

Specified by:

listeners in interface ChatModel

provider

public ModelProvider provider()

Specified by:

provider in interface ChatModel

builder

public static VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder builder()