com.google.cloud.vertexai.generativeai

Class ChatSession

java.lang.Object

com.google.cloud.vertexai.generativeai.ChatSession

public final class ChatSession
extends Object

Represents a conversation between the user and the model.

Note: this class is NOT thread-safe.

Constructor Summary

Constructors

Constructor and Description
ChatSession(GenerativeModel model) Creates a new chat session given a GenerativeModel instance.

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableList<Content>	getHistory() Returns the history of the conversation.
GenerateContentResponse	sendMessage(Content content) Sends a message to the model and returns a response.
GenerateContentResponse	sendMessage(String text) Sends a message to the model and returns a response.
ResponseStream<GenerateContentResponse>	sendMessageStream(Content content) Sends a message to the model and returns a stream of responses.
ResponseStream<GenerateContentResponse>	sendMessageStream(String text) Sends a message to the model and returns a stream of responses.
void	setHistory(List<Content> history) Sets the history to a list of Content.
ChatSession	withAutomaticFunctionCallingResponder(AutomaticFunctionCallingResponder automaticFunctionCallingResponder) Creates a copy of the current ChatSession with updated AutomaticFunctionCallingResponder.
ChatSession	withGenerationConfig(GenerationConfig generationConfig) Creates a copy of the current ChatSession with updated GenerationConfig.
ChatSession	withSafetySettings(List<SafetySetting> safetySettings) Creates a copy of the current ChatSession with updated SafetySettings.
ChatSession	withSystemInstruction(Content systemInstruction) Creates a copy of the current ChatSession with updated SystemInstruction.
ChatSession	withToolConfig(ToolConfig toolConfig) Creates a copy of the current ChatSession with updated ToolConfig.
ChatSession	withTools(List<Tool> tools) Creates a copy of the current ChatSession with updated Tools.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChatSession

public ChatSession(GenerativeModel model)

Creates a new chat session given a GenerativeModel instance. Configurations of the chat (e.g., GenerationConfig) inherits from the model.

Method Detail

withGenerationConfig

public ChatSession withGenerationConfig(GenerationConfig generationConfig)

Creates a copy of the current ChatSession with updated GenerationConfig.

Parameters:

generationConfig - a GenerationConfig that will be used in the new ChatSession.

Returns:

a new ChatSession instance with the specified GenerationConfig.

withSafetySettings

public ChatSession withSafetySettings(List<SafetySetting> safetySettings)

Creates a copy of the current ChatSession with updated SafetySettings.

Parameters:

safetySettings - a SafetySetting that will be used in the new ChatSession.

Returns:

a new ChatSession instance with the specified SafetySettings.

withTools

public ChatSession withTools(List<Tool> tools)

Creates a copy of the current ChatSession with updated Tools.

Parameters:

tools - a Tool that will be used in the new ChatSession.

Returns:

a new ChatSession instance with the specified Tools.

withToolConfig

public ChatSession withToolConfig(ToolConfig toolConfig)

Creates a copy of the current ChatSession with updated ToolConfig.

Parameters:

toolConfig - a ToolConfig that will be used in the new ChatSession.

Returns:

a new ChatSession instance with the specified ToolConfigs.

withSystemInstruction

public ChatSession withSystemInstruction(Content systemInstruction)

Creates a copy of the current ChatSession with updated SystemInstruction.

Parameters:

systemInstruction - a Content containing system instructions.

Returns:

a new ChatSession instance with the specified ToolConfigs.

withAutomaticFunctionCallingResponder

public ChatSession withAutomaticFunctionCallingResponder(AutomaticFunctionCallingResponder automaticFunctionCallingResponder)

Creates a copy of the current ChatSession with updated AutomaticFunctionCallingResponder.

Parameters:

automaticFunctionCallingResponder - an AutomaticFunctionCallingResponder instance that will be used in the new ChatSession.

Returns:

a new ChatSession instance with the specified AutomaticFunctionCallingResponder.

sendMessageStream

public ResponseStream<GenerateContentResponse> sendMessageStream(String text)
                                                          throws IOException

Sends a message to the model and returns a stream of responses.

Parameters:

text - the message to be sent.

Returns:

an iterable in which each element is a GenerateContentResponse. Can be converted to stream by stream() method.

Throws:

IOException

sendMessageStream

public ResponseStream<GenerateContentResponse> sendMessageStream(Content content)
                                                          throws IOException

Sends a message to the model and returns a stream of responses.

Parameters:

content - the content to be sent.

Returns:

an iterable in which each element is a GenerateContentResponse. Can be converted to stream by stream() method.

Throws:

IOException

sendMessage

public GenerateContentResponse sendMessage(String text)
                                    throws IOException

Sends a message to the model and returns a response.

Parameters:

text - the message to be sent.

Returns:

a response.

Throws:

IOException

sendMessage

public GenerateContentResponse sendMessage(Content content)
                                    throws IOException

Sends a message to the model and returns a response.

Parameters:

content - the content to be sent.

Returns:

a response.

Throws:

IOException

getHistory

public com.google.common.collect.ImmutableList<Content> getHistory()

Returns the history of the conversation.

Returns:

a history of the conversation as an immutable list of Content.

setHistory

public void setHistory(List<Content> history)

Sets the history to a list of Content.

Parameters:

history - A list of Content containing interleaving conversation between "user" and "model".