GenerativeModel class

生成式模型 API 的類別。

簽名:

export declare class GenerativeModel 

建構函式

建構函式 修飾符 說明
(建構函式)(vertexAI, modelParams, requestOptions) 建構 GenerativeModel 類別的新例項

屬性

屬性 修飾符 類型 說明
generationConfig GenerationConfig
模型 字串
requestOptions 要求選項
safetySettings 安全設定[]
system 指令 Content
toolConfig 工具設定
工具 工具[]

方法

方法 修飾符 說明
countTokens(要求) 計算所提供要求中的符記。
generateContent(要求) 對模型發出單一非串流呼叫,並傳回包含單一 GenerateContentResponse 的物件。
generateContentStream(要求) 對模型發出單一串流呼叫,並傳回含有可疊代串流的物件 (可疊代串流,此串流會在串流回應中的所有區塊),以及傳回最終匯總回應的承諾。
startChat(startChatParams) 取得新的 ChatSession 執行個體,可用於多輪對話。

GenerativeModel.(建構函式)

建構 GenerativeModel 類別的新例項

簽名:

constructor(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions);

參數

參數 類型 說明
頂點 AI VertexAI
modelParams ModelParams
requestOptions 要求選項

GenerativeModel.generationConfig

簽名:

generationConfig: GenerationConfig;

GenerativeModel.model

簽名:

model: string;

GenerativeModel.requestOptions

簽名:

requestOptions?: RequestOptions;

GenerativeModel.safetySettings

簽名:

safetySettings: SafetySetting[];

GenerativeModel.system 指令

簽名:

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:字串 |陣列<字串 |零件>

傳回:

承諾<GenerateContentResult>

GenerativeModel.generateContentStream()

對模型發出單一串流呼叫,並傳回含有可疊代串流的物件 (可疊代串流,此串流會在串流回應中的所有區塊),以及傳回最終匯總回應的承諾。

簽名:

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

參數

參數 類型 說明
要求 GenerateContentRequest:字串 |陣列<字串 |零件>

傳回:

Promise<GenerateContentStreamResult>

GenerativeModel.startChat()

取得新的 ChatSession 執行個體,可用於多輪對話。

簽名:

startChat(startChatParams?: StartChatParams): ChatSession;

參數

參數 類型 說明
startChatParams StartChatParams

傳回:

Chat 工作階段