ChatSession class

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

署名:

export declare class ChatSession 

コンストラクタ

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

プロパティ

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

メソッド

メソッド 修飾キー 説明
getHistory()(履歴) それまでのチャットの履歴を取得します。ブロックしたメッセージは履歴には追加されません。ブロックした受験者は履歴には追加されず、その候補を生成した候補も追加されません。
sendMessage(リクエスト) チャット メッセージを送信し、ストリーミング以外の GenerateContentResult を受け取る
sendMessageStream(request) チャット メッセージを送信し、イテラブル ストリームとレスポンス Promise を含む GenerateContentStreamResult としてレスポンスを受け取ります。

ChatSession.(コンストラクタ)

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

署名:

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

パラメータ

パラメータ タイプ 説明
apiSettings API 設定
モデル 文字列
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>;

パラメータ

パラメータ タイプ 説明
request string | 配列<文字列 | 要素>

戻り値:

Promise<GenerateContentResult>

ChatSession.sendMessageStream()

チャット メッセージを送信し、イテラブル ストリームとレスポンス Promise を含む GenerateContentStreamResult としてレスポンスを受け取ります。

署名:

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

パラメータ

パラメータ タイプ 説明
request string | 配列<文字列 | 要素>

戻り値:

Promise<GenerateContentStreamResult>