Vertex AI for Firebase Web SDK。
函式
函式 | 說明 |
---|---|
function(app, ...) | |
getVertexAI(應用程式, 選項) | 傳回指定應用程式的 VertexAI 執行個體。 |
功能(vertexAI, ...) | |
getGenerativeModel(vertexAI, modelParams, requestOptions) | 傳回含有推論和其他功能方法的 GenerativeModel 類別。 |
等級
類別 | 說明 |
---|---|
即時通訊工作階段 | ChatSession 類別,能夠傳送即時通訊訊息,並儲存目前為止已收發的訊息記錄。 |
生成式模型 | 生成式模型 API 的類別。 |
列舉
Enumeration | 說明 |
---|---|
BlockReason | 提示遭到封鎖的原因。 |
結束原因 | 求職者完成的原因。 |
FunctionCallingMode | |
FunctionDeclarationSchemaType | 包含由 https://swagger.io/docs/specification/data-models/data-types/ 定義的 OpenAPI 資料類型清單 |
有害封鎖方法 | |
傷害封鎖門檻 | 系統會封鎖提示或候選人的門檻。 |
有害類別 | 可能導致提示或候選人遭封鎖的有害類別。 |
不良機率 | 提示或候選人與傷害類別相符的機率。 |
危害 | 危害的嚴重性等級。 |
介面
變數
變數 | 說明 |
---|---|
可能的角色 | 可能的角色。 |
類型別名
類型別名 | 說明 |
---|---|
零件 | 內容部分 - 包括文字、圖片/影片,或函式呼叫/回應部分類型。 |
角色 | 角色是內容的製作人, |
工具 | 定義模型可以呼叫以存取外部知識。 |
function(app, ...)
getVertexAI(應用程式, 選項)
傳回指定應用程式的 VertexAI 執行個體。
簽名:
export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
參數
參數 | 類型 | 說明 |
---|---|---|
app | FirebaseApp | 要使用的 FirebaseApp。 |
選項 | VertexAIOptions |
傳回:
函式(vertexAI, ...)
getGenerativeModel(vertexAI, modelParams, requestOptions)
傳回含有推論和其他功能方法的 GenerativeModel 類別。
簽名:
export declare function getGenerativeModel(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
參數
參數 | 類型 | 說明 |
---|---|---|
頂點 AI | VertexAI | |
modelParams | ModelParams | |
requestOptions | RequestOptions |
傳回:
可能的角色
可能的角色。
簽名:
POSSIBLE_ROLES: readonly ["user", "model", "function", "system"]
Part
內容部分 - 包括文字、圖片/影片,或函式呼叫/回應部分類型。
簽名:
export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;
職務
角色是內容的製作人,
簽名:
export declare type Role = (typeof POSSIBLE_ROLES)[number];
工具
定義模型可以呼叫以存取外部知識。
簽名:
export declare type Tool = FunctionDeclarationsTool;
封鎖原因
提示遭到封鎖的原因。
簽名:
export declare enum BlockReason
列舉成員
成員 | 值 | 說明 |
---|---|---|
BLOCKED_REASON_UNSPECIFIED | "BLOCKED_REASON_UNSPECIFIED" |
|
其他 | "OTHER" |
|
安全 | "SAFETY" |
完成原因
求職者完成的原因。
簽名:
export declare enum FinishReason
列舉成員
成員 | 值 | 說明 |
---|---|---|
FINISH_REASON_UNSPECIFIED | "FINISH_REASON_UNSPECIFIED" |
|
MAX_TOKENS 次 | "MAX_TOKENS" |
|
其他 | "OTHER" |
|
留存 | "RECITATION" |
|
安全 | "SAFETY" |
|
停止 | "STOP" |
函式呼叫模式
簽名:
export declare enum FunctionCallingMode
列舉成員
成員 | 值 | 說明 |
---|---|---|
下列任一項目 | "ANY" |
|
自動 | "AUTO" |
|
模式不明 | "MODE_UNSPECIFIED" |
|
無 | "NONE" |
函式宣告結構定義類型
包含由 https://swagger.io/docs/specification/data-models/data-types/ 定義的 OpenAPI 資料類型清單
簽名:
export declare enum FunctionDeclarationSchemaType
列舉成員
成員 | 值 | 說明 |
---|---|---|
ARRAY | "ARRAY" |
陣列類型。 |
BOOLEAN | "BOOLEAN" |
布林值類型。 |
INTEGER | "INTEGER" |
整數類型。 |
數字 | "NUMBER" |
數字類型。 |
OBJECT | "OBJECT" |
物件類型。 |
STRING | "STRING" |
字串類型。 |
傷害封鎖方法
簽名:
export declare enum HarmBlockMethod
列舉成員
成員 | 值 | 說明 |
---|---|---|
HARM_Block_method_UNSPECIFIED | "HARM_BLOCK_METHOD_UNSPECIFIED" |
|
能力 | "PROBABILITY" |
|
嚴重性 | "SEVERITY" |
傷害區塊門檻
系統會封鎖提示或候選人的門檻。
簽名:
export declare enum HarmBlockThreshold
列舉成員
成員 | 值 | 說明 |
---|---|---|
封鎖:封鎖 | "BLOCK_LOW_AND_ABOVE" |
|
封鎖中 | "BLOCK_MEDIUM_AND_ABOVE" |
|
封鎖 (無) | "BLOCK_NONE" |
|
封鎖等級:高 | "BLOCK_ONLY_HIGH" |
|
HARM_Block_THRESHOLD_UNSPECIFIED | "HARM_BLOCK_THRESHOLD_UNSPECIFIED" |
傷害類別
可能導致提示或候選人遭封鎖的有害類別。
簽名:
export declare enum HarmCategory
列舉成員
成員 | 值 | 說明 |
---|---|---|
HARM_CATEGORY_DANGEROUS_內容 | "HARM_CATEGORY_DANGEROUS_CONTENT" |
|
HARM_CATEGORY_HARASSMENT | "HARM_CATEGORY_HARASSMENT" |
|
HARM_CATEGORY_HATE_SPEECH | "HARM_CATEGORY_HATE_SPEECH" |
|
HARM_CATEGORY_SEXUALLY_EXPLICIT | "HARM_CATEGORY_SEXUALLY_EXPLICIT" |
|
HARM_CATEGORY_UNSPECIFIED | "HARM_CATEGORY_UNSPECIFIED" |
傷害機率
提示或候選人與傷害類別相符的機率。
簽名:
export declare enum HarmProbability
列舉成員
成員 | 值 | 說明 |
---|---|---|
HARM_PROBABILITY_UNSPECIFIED | "HARM_PROBABILITY_UNSPECIFIED" |
|
高 | "HIGH" |
|
低 | "LOW" |
|
中 | "MEDIUM" |
|
負面 | "NEGLIGIBLE" |
危害程度
危害的嚴重性等級。
簽名:
export declare enum HarmSeverity
列舉成員
成員 | 值 | 說明 |
---|---|---|
HARM_SEVERITY_HIGH | "HARM_SEVERITY_HIGH" |
|
HARM_SEVERITY_低 | "HARM_SEVERITY_LOW" |
|
HARM_SEVERITY_MEDIUM | "HARM_SEVERITY_MEDIUM" |
|
HARM_SEVERITY_NEGLIGIBLE | "HARM_SEVERITY_NEGLIGIBLE" |
|
HARM_SEVERITY_UNSPECIFIED | "HARM_SEVERITY_UNSPECIFIED" |