用于生成模型 API 的类。
签名:
export declare class GenerativeModel
构造函数
构造函数 | 修饰符 | 说明 |
---|---|---|
(构造函数)(vertexAI, modelParams, requestOptions) | 构造 GenerativeModel 类的新实例 |
属性
属性 | 修饰符 | 类型 | 说明 |
---|---|---|---|
generationConfig | GenerationConfig | ||
model | 字符串 | ||
requestOptions | RequestOptions | ||
safetySettings | SafetySetting[] | ||
systemInstruction | 内容 | ||
toolConfig | 工具配置 | ||
工具 | 工具[] |
方法
方法 | 修饰符 | 说明 |
---|---|---|
countTokens(请求) | 计算提供的请求中的词元数量。 | |
generateContent(request) | 对模型进行单次非流式调用,并返回包含单个 GenerateContentResponse 的对象。 | |
generateContentStream(request) | 对模型进行单次流式调用,并返回一个对象,该对象包含一个可迭代流(可迭代流式响应中的所有分块)以及返回最终汇总响应的 promise。 | |
startChat(startChatParams) | 获取新的 ChatSession 实例,该实例可用于多轮聊天。 |
GenerativeModel.(构造函数)
构造 GenerativeModel
类的新实例
签名:
constructor(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions);
参数
参数 | 类型 | 说明 |
---|---|---|
Vertex AI | VertexAI | |
modelParams | ModelParams | |
requestOptions | RequestOptions |
GenerativeModel.generationConfig
签名:
generationConfig: GenerationConfig;
GenerativeModel
签名:
model: string;
GenerativeModel.requestOptions
签名:
requestOptions?: RequestOptions;
GenerativeModel.safetySettings
签名:
safetySettings: SafetySetting[];
GenerativeModel.systemInstruction
签名:
systemInstruction?: Content;
GenerativeModel.toolConfig
签名:
toolConfig?: ToolConfig;
GenerativeModel.tools
签名:
tools?: Tool[];
GenerativeModel.countTokens()
计算提供的请求中的词元数量。
签名:
countTokens(request: CountTokensRequest | string | Array<string | Part>): Promise<CountTokensResponse>;
参数
参数 | 类型 | 说明 |
---|---|---|
请求 | CountTokensRequest |字符串 |数组<字符串 |部分> |
返回:
Promise<CountTokensResponse>
GenerativeModel.generateContent()
对模型进行单次非流式调用,并返回包含单个 GenerateContentResponse 的对象。
签名:
generateContent(request: GenerateContentRequest | string | Array<string | Part>): Promise<GenerateContentResult>;
参数
参数 | 类型 | 说明 |
---|---|---|
请求 | GenerateContentRequest |字符串 |数组<字符串 |部分> |
返回:
Promise<GenerateContentResult>
GenerativeModel.generateContentStream()
对模型进行单次流式调用,并返回一个对象,该对象包含一个可迭代流(可迭代流式响应中的所有分块)以及返回最终汇总响应的 promise。
签名:
generateContentStream(request: GenerateContentRequest | string | Array<string | Part>): Promise<GenerateContentStreamResult>;
参数
参数 | 类型 | 说明 |
---|---|---|
请求 | GenerateContentRequest |字符串 |数组<字符串 |部分> |
返回:
Promise<GenerateContentStreamResult>
GenerativeModel.startChat()
获取新的 ChatSession 实例,该实例可用于多轮聊天。
签名:
startChat(startChatParams?: StartChatParams): ChatSession;
参数
参数 | 类型 | 说明 |
---|---|---|
startChatParams | StartChatParams |
返回: