ChatFutures

abstract class ChatFutures


Wrapper class providing Java compatible methods for Chat.

See also
Chat

Summary

Public companion functions

ChatFutures
from(chat: Chat)

Public functions

abstract Chat

Returns the Chat object wrapped by this object.

abstract ListenableFuture<GenerateContentResponse>

Sends a message using the existing history of this chat as context and the provided Content prompt.

abstract Publisher<GenerateContentResponse>

Sends a message using the existing history of this chat as context and the provided Content prompt.

Public companion functions

from

fun from(chat: Chat): ChatFutures
Returns
ChatFutures

a ChatFutures created around the provided Chat

Public functions

getChat

abstract fun getChat(): Chat

Returns the Chat object wrapped by this object.

sendMessage

abstract fun sendMessage(prompt: Content): ListenableFuture<GenerateContentResponse>

Sends a message using the existing history of this chat as context and the provided Content prompt.

If successful, the message and response will be added to the history. If unsuccessful, history will remain unchanged.

Parameters
prompt: Content

The input(s) that, together with the history, will be given to the model as the prompt.

Throws
com.google.firebase.vertexai.type.InvalidStateException: com.google.firebase.vertexai.type.InvalidStateException

if prompt is not coming from the 'user' role

com.google.firebase.vertexai.type.InvalidStateException: com.google.firebase.vertexai.type.InvalidStateException

if the Chat instance has an active request

sendMessageStream

abstract fun sendMessageStream(prompt: Content): Publisher<GenerateContentResponse>

Sends a message using the existing history of this chat as context and the provided Content prompt.

The response from the model is returned as a stream.

If successful, the message and response will be added to the history. If unsuccessful, history will remain unchanged.

Parameters
prompt: Content

The input(s) that, together with the history, will be given to the model as the prompt.

Throws
com.google.firebase.vertexai.type.InvalidStateException: com.google.firebase.vertexai.type.InvalidStateException

if prompt is not coming from the 'user' role

com.google.firebase.vertexai.type.InvalidStateException: com.google.firebase.vertexai.type.InvalidStateException

if the Chat instance has an active request