Firebase Web SDK 中的 Vertex AI。
函式
函式 | 說明 |
---|---|
功能(應用程式, ...) | |
getVertexAI(應用程式、選項) | 傳回指定應用程式的 VertexAI 執行個體。 |
功能(vertexAI, ...) | |
getGenerativeModel(vertexAI, modelParams, requestOptions) | 傳回含有推論和其他功能方法的 GenerativeModel 類別。 |
類別
類別 | 說明 |
---|---|
Chat 工作階段 | 能傳送即時通訊訊息,以及儲存目前收發訊息記錄的 ChatSession 類別。 |
GenerativeModel | 生成式模型 API 的類別。 |
VertexAIError | Firebase SDK 中 Vertex AI 的錯誤類別。 |
列舉
列舉 | 說明 |
---|---|
封鎖原因 | 封鎖提示的原因。 |
FinishReason | 候選人完成原因。 |
FunctionCallingMode | |
FunctionDeclarationSchemaType | 包含 https://swagger.io/docs/specification/data-models/data-types/ 定義的 OpenAPI 資料類型清單 |
HarmBlockMethod | |
HarmBlockThreshold | 提示或候選人遭封鎖的門檻。 |
有害類別 | 有害類別,可能導致提示或候選人遭到封鎖。 |
損害機率 | 提示或候選人與傷害類別相符的機率。 |
有害物質 | 有害的嚴重性等級。 |
VertexAIErrorCode | VertexAIError 可能包含的標準化錯誤代碼。 |
介面
變數
變數 | 說明 |
---|---|
POSSIBLE_ROLES | 可能的角色。 |
型別別名
類型別名 | 說明 |
---|---|
零件 | 內容部分 - 包括文字、圖片/影片,或函式呼叫/回應部分類型。 |
角色 | 角色是內容製作者, |
工具 | 定義模型可以呼叫來存取外部知識的工具。 |
function(應用程式, ...)
getVertexAI(應用程式、選項)
傳回指定應用程式的 VertexAI 執行個體。
簽名:
export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
參數
參數 | 類型 | 說明 |
---|---|---|
應用程式 | Firebase 應用程式 | 要使用的 FirebaseApp。 |
選項 | VertexAIOptions |
傳回:
function(vertexAI, ...)
getGenerativeModel(vertexAI、modelParams、requestOptions)
傳回含有推論和其他功能方法的 GenerativeModel 類別。
簽名:
export declare function getGenerativeModel(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
參數
參數 | 類型 | 說明 |
---|---|---|
頂點 AI | VertexAI | |
modelParams | ModelParams | |
requestOptions | 要求選項 |
傳回:
POSSIBLE_ROLES
可能的角色。
簽名:
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" |
字串類型。 |
HarmBlockMethod
簽名:
export declare enum HarmBlockMethod
列舉成員
成員 | 值 | 說明 |
---|---|---|
HARM_BLOCK_METHOD_UNSPECIFIED | "HARM_BLOCK_METHOD_UNSPECIFIED" |
|
可用性 | "PROBABILITY" |
|
分割 | "SEVERITY" |
HarmBlockThreshold 危險
提示或候選人遭封鎖的門檻。
簽名:
export declare enum HarmBlockThreshold
列舉成員
成員 | 值 | 說明 |
---|---|---|
BLOCK_LOW_AND_ABOVE | "BLOCK_LOW_AND_ABOVE" |
|
BLOCK_MEDIUM_AND_ABOVE | "BLOCK_MEDIUM_AND_ABOVE" |
|
BLOCK_NONE | "BLOCK_NONE" |
|
BLOCK_ONLY_HIGH | "BLOCK_ONLY_HIGH" |
|
HARM_BLOCK_THRESHOLD_UNSPECIFIED | "HARM_BLOCK_THRESHOLD_UNSPECIFIED" |
有害類別
有害類別,可能導致提示或候選人遭到封鎖。
簽名:
export declare enum HarmCategory
列舉成員
成員 | 值 | 說明 |
---|---|---|
HARM_CATEGORY_DANGEROUS_CONTENT | "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_LOW | "HARM_SEVERITY_LOW" |
|
HARM_SEVERITY_MEDIUM | "HARM_SEVERITY_MEDIUM" |
|
HARM_SEVERITY_NEGLIGIBLE | "HARM_SEVERITY_NEGLIGIBLE" |
|
HARM_SEVERITY_UNSPECIFIED | "HARM_SEVERITY_UNSPECIFIED" |
VertexAIErrorCode
VertexAIError 可能包含的標準化錯誤代碼。
簽名:
export declare const enum VertexAIErrorCode
列舉成員
成員 | 值 | 說明 |
---|---|---|
錯誤 | "error" |
發生一般錯誤。 |
擷取錯誤 | "fetch-error" |
執行擷取作業時發生錯誤, |
無效內容 | "invalid-content" |
與內容物件相關聯的錯誤。 |
NO_API 金鑰 | "no-api-key" |
缺少 Firebase API 金鑰,因此發生錯誤。 |
NO_MODEL | "no-model" |
初始化期間未指定模型名稱,因此發生錯誤。 |
NO_PROJECT_ID | "no-project-id" |
缺少專案 ID,因此發生錯誤。 |
PARSE_FAILED | "parse-failed" |
剖析時發生錯誤, |
要求錯誤 | "request-error" |
要求發生錯誤, |
回應_錯誤 | "response-error" |
回應發生錯誤。 |