Class TemplateChatSession`Beta`

ChatSession class for server-side templates that enables sending chat messages and stores history of sent and received messages so far.

Hierarchy (View Summary)

ChatSessionBase<StartTemplateChatParams>
- TemplateChatSession

Index

Constructors

Methods

getHistory sendMessage sendMessageStream

Properties

_history _sendPromise params requestOptions?

Constructors

constructor

new TemplateChatSession(
    apiSettings: ApiSettings,
    params: StartTemplateChatParams,
    requestOptions?: RequestOptions,
): TemplateChatSession
Beta
Parameters
- apiSettings: ApiSettings
- params: StartTemplateChatParams
- OptionalrequestOptions: RequestOptions
Returns TemplateChatSession
Overrides ChatSessionBase.constructor
- Defined in methods/chat-session.ts:253

Methods

getHistory

getHistory(): Promise<Content[]>
Gets the chat history so far. Blocked prompts are not added to history. Neither blocked candidates nor the prompts that generated them are added to history.

Returns Promise<Content[]>
Inherited from ChatSessionBase.getHistory
- Defined in methods/chat-session.ts:79

sendMessage

sendMessage(
request: string | (string | Part)[],
singleRequestOptions?: SingleRequestOptions,
): Promise<GenerateContentResult>
Beta
Sends a chat message and receives a non-streaming GenerateContentResult
Parameters
- request: string | (string | Part)[]
- OptionalsingleRequestOptions: SingleRequestOptions
Returns Promise<GenerateContentResult>
- Defined in methods/chat-session.ts:266

sendMessageStream

sendMessageStream(
request: string | (string | Part)[],
singleRequestOptions?: SingleRequestOptions,
): Promise<GenerateContentStreamResult>
Beta
Sends a chat message and receives the response as a GenerateContentStreamResult containing an iterable stream and a response promise.
Parameters
- request: string | (string | Part)[]
- OptionalsingleRequestOptions: SingleRequestOptions
Returns Promise<GenerateContentStreamResult>
- Defined in methods/chat-session.ts:321

Properties

`Protected` `Beta`_history

_history: Content[] = []

`Protected` `Beta`_sendPromise

_sendPromise: Promise<void> = ...

`Beta`params

params: StartTemplateChatParams

`Optional` `Beta`requestOptions

requestOptions?: RequestOptions