TemplateChatFutures

@PublicPreviewAPI
abstract class TemplateChatFutures


Wrapper class providing Java compatible methods for TemplateChat.

See also
TemplateChat

Summary

Public companion functions

TemplateChatFutures
from(templateChat: TemplateChat)

Public functions

abstract TemplateChat

Returns the TemplateChat 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(templateChat: TemplateChat): TemplateChatFutures
Returns
TemplateChatFutures

a TemplateChatFutures created around the provided TemplateChat

Public functions

getTemplateChat

abstract fun getTemplateChat(): TemplateChat

Returns the TemplateChat 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.ai.type.InvalidStateException: com.google.firebase.ai.type.InvalidStateException

if prompt is not coming from the 'user' role

com.google.firebase.ai.type.InvalidStateException: com.google.firebase.ai.type.InvalidStateException

if the TemplateChat 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.ai.type.InvalidStateException: com.google.firebase.ai.type.InvalidStateException

if prompt is not coming from the 'user' role

com.google.firebase.ai.type.InvalidStateException: com.google.firebase.ai.type.InvalidStateException

if the TemplateChat instance has an active request