Class VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder

java.lang.Object

dev.langchain4j.model.vertexai.gemini.VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder

Enclosing class:

VertexAiGeminiChatModel

public static class VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
VertexAiGeminiChatModelBuilder()

Method Summary

Modifier and Type	Method	Description
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	allowedFunctionNames(List<String> allowedFunctionNames)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	apiEndpoint(String apiEndpoint)
VertexAiGeminiChatModel	build()
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	credentials(com.google.auth.oauth2.GoogleCredentials credentials)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	customHeaders(Map<String,String> customHeaders)	Sets custom headers to be included in the LLM requests.
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	labels(Map<String,String> labels)	Sets billing/reporting labels that will be attached to every request the model issues.
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	listeners(List<ChatModelListener> listeners)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	location(String location)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	logRequests(Boolean logRequests)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	logResponses(Boolean logResponses)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	maxOutputTokens(Integer maxOutputTokens)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	maxRetries(Integer maxRetries)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	modelName(String modelName)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	project(String project)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	responseMimeType(String responseMimeType)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	responseSchema(com.google.cloud.vertexai.api.Schema responseSchema)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	safetySettings(Map<HarmCategory, SafetyThreshold> safetySettings)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	seed(Integer seed)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	supportedCapabilities(Capability... supportedCapabilities)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	supportedCapabilities(Set<Capability> supportedCapabilities)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	temperature(Float temperature)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	toolCallingMode(ToolCallingMode toolCallingMode)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	topK(Integer topK)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	topP(Float topP)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	useGoogleSearch(Boolean useGoogleSearch)
VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder	vertexSearchDatastore(String vertexSearchDatastore)

Methods inherited from class Object

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

Constructor Details

VertexAiGeminiChatModelBuilder

public VertexAiGeminiChatModelBuilder()

Method Details

project

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder project(String project)

location

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder location(String location)

modelName

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder modelName(String modelName)

temperature

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder temperature(Float temperature)

maxOutputTokens

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder maxOutputTokens(Integer maxOutputTokens)

topK

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder topK(Integer topK)

topP

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder topP(Float topP)

seed

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder seed(Integer seed)

maxRetries

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder maxRetries(Integer maxRetries)

responseMimeType

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder responseMimeType(String responseMimeType)

responseSchema

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder responseSchema(com.google.cloud.vertexai.api.Schema responseSchema)

safetySettings

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder safetySettings(Map<HarmCategory, SafetyThreshold> safetySettings)

useGoogleSearch

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder useGoogleSearch(Boolean useGoogleSearch)

vertexSearchDatastore

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder vertexSearchDatastore(String vertexSearchDatastore)

toolCallingMode

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder toolCallingMode(ToolCallingMode toolCallingMode)

allowedFunctionNames

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder allowedFunctionNames(List<String> allowedFunctionNames)

logRequests

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder logRequests(Boolean logRequests)

logResponses

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder logResponses(Boolean logResponses)

listeners

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder listeners(List<ChatModelListener> listeners)

supportedCapabilities

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder supportedCapabilities(Set<Capability> supportedCapabilities)

supportedCapabilities

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder supportedCapabilities(Capability... supportedCapabilities)

credentials

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder credentials(com.google.auth.oauth2.GoogleCredentials credentials)

apiEndpoint

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder apiEndpoint(String apiEndpoint)

customHeaders

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder customHeaders(Map<String,String> customHeaders)

Sets custom headers to be included in the LLM requests. Main use-case is to support provision throughput quota. E.g: "X-Vertex-AI-LLM-Request-Type: dedicated" will exhaust the provisioned throughput quota first, and will return HTTP_429 if the quota is exhausted. "X-Vertex-AI-LLM-Request-Type: shared" will bypass the provisioned throughput quota completely. For more information please refer to the official documentation

Parameters:

customHeaders - a map of custom header keys and their corresponding values

Returns:

the updated instance of VertexAiGeminiChatModelBuilder

labels

public VertexAiGeminiChatModel.VertexAiGeminiChatModelBuilder labels(Map<String,String> labels)

Sets billing/reporting labels that will be attached to every request the model issues.

Vertex AI's generateContent request body has a top-level labels map intended for billing and reporting only. The labels surface in Cloud Billing reports (Group by → Labels) and in Cloud Logging audit entries when Data Access audit logs are enabled, allowing per-tenant cost attribution and request filtering.

Per the official spec: keys must start with a letter; keys and values may use lowercase letters, digits, underscores, and dashes (international characters are allowed); each is at most 63 Unicode code points; up to 64 labels per request.

Parameters:

labels - a map of label keys and their corresponding values

Returns:

the updated instance of VertexAiGeminiChatModelBuilder

build

public VertexAiGeminiChatModel build()