ChatSession class

チャット メッセージの送信を可能にする ChatSession クラス。これまでの送受信メッセージの履歴を保存します。

署名:

export declare class ChatSession 

コンストラクタ

コンストラクタ	修飾キー	説明
(コンストラクタ)(apiSettings, model, params, requestOptions)		ChatSession クラスの新しいインスタンスを作成します。

プロパティ

プロパティ	修飾キー	タイプ	説明
model		文字列
params		StartChatParams |未定義
requestOptions		RequestOptions |未定義

メソッド

メソッド	修飾キー	説明
getHistory()		これまでのチャット履歴を取得します。ブロックしたプロンプトは履歴に追加されません。ブロックした候補も、その候補を生成したプロンプトも、履歴に追加されません。
sendMessage(request)		チャット メッセージを送信し、非ストリーミング GenerateContentResult を受け取ります。
sendMessageStream(request)		チャット メッセージを送信し、反復可能なストリームとレスポンスの Promise を含むレスポンスを GenerateContentStreamResult として受け取ります。

ChatSession.（コンストラクタ）

ChatSession クラスの新しいインスタンスを作成します。

署名:

constructor(apiSettings: ApiSettings, model: string, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);

パラメータ

パラメータ	型	説明
apiSettings	ApiSettings
モデル	文字列
params	StartChatParams |未定義
requestOptions	RequestOptions |未定義

ChatSession.model

署名:

model: string;

ChatSession.params

署名:

params?: StartChatParams | undefined;

ChatSession.requestOptions

署名:

requestOptions?: RequestOptions | undefined;

ChatSession.getHistory()

これまでのチャット履歴を取得します。ブロックしたプロンプトは履歴に追加されません。ブロックした候補も、その候補を生成したプロンプトも、履歴に追加されません。

署名:

getHistory(): Promise<Content[]>;

戻り値:

Promise<Content[]>

ChatSession.sendMessage()

チャット メッセージを送信し、非ストリーミング GenerateContentResult を受け取ります。

署名:

sendMessage(request: string | Array<string | Part>): Promise<GenerateContentResult>;

パラメータ

パラメータ	型	説明
リクエスト	文字列 |配列<文字列 |パート>

戻り値:

Promise<GenerateContentResult>

ChatSession.sendMessageStream()

チャット メッセージを送信し、反復可能なストリームとレスポンスの Promise を含むレスポンスを GenerateContentStreamResult として受け取ります。

署名:

sendMessageStream(request: string | Array<string | Part>): Promise<GenerateContentStreamResult>;

パラメータ

パラメータ	型	説明
リクエスト	文字列 |配列<文字列 |パート>

戻り値:

Promise<GenerateContentStreamResult>