Class ChatSession

ChatSession class that enables sending chat messages and stores history of sent and received messages so far.

Hierarchy (View Summary)

ChatSessionBase<StartChatParams>
- ChatSession

Index

Constructors

Methods

getHistory sendMessage sendMessageStream

Properties

_history _sendPromise model params? requestOptions?

Constructors

constructor

new ChatSession(
    apiSettings: ApiSettings,
    model: string,
    params?: StartChatParams,
    requestOptions?: RequestOptions,
): ChatSession
Parameters
- apiSettings: ApiSettings
- model: string
- Optionalparams: StartChatParams
- OptionalrequestOptions: RequestOptions
Returns ChatSession
Overrides ChatSessionBase.constructor
- Defined in methods/chat-session.ts:94

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>
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:108

sendMessageStream

sendMessageStream(
request: string | (string | Part)[],
singleRequestOptions?: SingleRequestOptions,
): Promise<GenerateContentStreamResult>
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:170

Properties

`Protected`_history

_history: Content[] = []

`Protected`_sendPromise

_sendPromise: Promise<void> = ...

model

model: string

`Optional`params

params?: StartChatParams

`Optional`requestOptions

requestOptions?: RequestOptions