ChatSession class

ChatSession 类,用于发送聊天消息,并存储到目前为止已发送和已接收消息的历史记录。

签名

export declare class ChatSession 

构造函数

构造函数 修饰符 说明
(structor)(apiSettings, model, params, requestOptions) 构造 ChatSession 类的新实例

属性

属性 修饰符 类型 说明
model 字符串
参数 StartChatParams |未定义
requestOptions RequestOptions |未定义

方法

方法 修饰符 说明
getHistory() 获取到目前为止的聊天记录。被屏蔽的提示不会添加到历史记录中。被屏蔽的候选字词以及生成这些候选字词的提示都不会添加到历史记录中。
sendMessage(请求) 发送聊天消息并接收非流式 GenerateContentResult
sendMessageStream(请求) 发送聊天消息,并作为包含可迭代流和响应 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>;

参数

参数 类型 说明
请求 字符串 |数组<字符串 |部分>

返回

Promise<GenerateContentResult>

ChatSession.sendMessageStream()

发送聊天消息,并作为包含可迭代流和响应 promise 的 GenerateContentStreamResult 接收响应。

签名

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

参数

参数 类型 说明
请求 字符串 |数组<字符串 |部分>

返回

Promise<GenerateContentStreamResult>