Interface ChatSession

Interface representing a ChatSession that enables sending chat messages and stores a history of sent and received messages so far.

interface ChatSession {
    model: string;
    params?: StartChatParams;
    requestOptions?: RequestOptions;
    getHistory(): Promise<Content[]>;
    sendMessage(
        request: string | (string | Part)[],
        singleRequestOptions?: SingleRequestOptions,
    ): Promise<GenerateContentResult>;
    sendMessageStream(
        request: string | (string | Part)[],
        singleRequestOptions?: SingleRequestOptions,
    ): Promise<GenerateContentStreamResult>;
}

Index

Methods

getHistory sendMessage sendMessageStream

Properties

model params? requestOptions?

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[]>
- Defined in methods/chat-session.ts:117

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

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

Properties

model

model: string

`Optional`params

params?: StartChatParams

`Optional`requestOptions

requestOptions?: RequestOptions