Package dev.langchain4j.model.vertexai

Class VertexAiGeminiStreamingChatModel

java.lang.Object

dev.langchain4j.model.vertexai.VertexAiGeminiStreamingChatModel

All Implemented Interfaces:

StreamingChatModel, Closeable, AutoCloseable

public class VertexAiGeminiStreamingChatModel
extends Object
implements StreamingChatModel, Closeable

Represents a Google Vertex AI Gemini language model with a stream chat completion interface, such as gemini-pro. See details here.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VertexAiGeminiStreamingChatModel.VertexAiGeminiStreamingChatModelBuilder

Constructor Summary

Constructors

Constructor	Description
VertexAiGeminiStreamingChatModel(com.google.cloud.vertexai.generativeai.GenerativeModel generativeModel, com.google.cloud.vertexai.api.GenerationConfig generationConfig)
VertexAiGeminiStreamingChatModel(String project, String location, String modelName, Float temperature, Integer maxOutputTokens, Integer topK, Float topP, 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, Map<String,String> customHeaders)

Method Summary

Modifier and Type	Method	Description
static VertexAiGeminiStreamingChatModel.VertexAiGeminiStreamingChatModelBuilder	builder()
void	chat(ChatRequest chatRequest, StreamingChatResponseHandler handler)	This is the main API to interact with the chat model.
void	close()
List<ChatModelListener>	listeners()
ModelProvider	provider()

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.langchain4j.model.chat.StreamingChatModel

chat, chat, defaultRequestParameters, doChat, supportedCapabilities

Constructor Details

VertexAiGeminiStreamingChatModel

public VertexAiGeminiStreamingChatModel(String project,
 String location,
 String modelName,
 Float temperature,
 Integer maxOutputTokens,
 Integer topK,
 Float topP,
 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,
 Map<String,String> customHeaders)

VertexAiGeminiStreamingChatModel

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

Method Details

chat

public void chat(ChatRequest chatRequest,
 StreamingChatResponseHandler handler)

Description copied from interface: StreamingChatModel

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

Specified by:

chat in interface StreamingChatModel

Parameters:

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

handler - a StreamingChatResponseHandler that will handle streaming response from the LLM

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

listeners

public List<ChatModelListener> listeners()

Specified by:

listeners in interface StreamingChatModel

provider

public ModelProvider provider()

Specified by:

provider in interface StreamingChatModel

builder

public static VertexAiGeminiStreamingChatModel.VertexAiGeminiStreamingChatModelBuilder builder()