vertexai-preview package

Vertex AI for Firebase Web SDK。

函式

函式	說明
功能(應用程式, ...)
getVertexAI(應用程式、選項)	傳回指定應用程式的 VertexAI 執行個體。
function(vertexAI, ...)
getGenerativeModel(vertexAI, modelParams, requestOptions)	傳回含有推論和其他功能方法的 GenerativeModel 類別。

等級

類別	說明
Chat 工作階段	能傳送即時通訊訊息，以及儲存目前收發訊息記錄的 ChatSession 類別。
GenerativeModel	生成式模型 API 的類別。
VertexAIError	Vertex AI for Firebase SDK 的錯誤類別。

列舉

Enumeration	說明
封鎖原因	封鎖提示的原因。
FinishReason	候選人完成原因。
FunctionCallingMode
FunctionDeclarationSchemaType	包含 https://swagger.io/docs/specification/data-models/data-types/ 定義的 OpenAPI 資料類型清單
HarmBlockMethod
HarmBlockThreshold	提示或候選人遭封鎖的門檻。
有害類別	有害類別，可能導致提示或候選人遭到封鎖。
損害機率	提示或候選人與傷害類別相符的機率。
有害物質	有害的嚴重性等級。
VertexAIErrorCode	VertexAIError 可能包含的標準化錯誤代碼。

介面

介面	說明
BaseParams	多種方法的基本參數。
引用	單一引文。
引用中繼資料	GenerateContentCandidate 中提供的引用中繼資料。
Content	提示和回應候選的內容類型。
CountTokensRequest	用於呼叫 GenerativeModel.countTokens() 的參數
CountTokensResponse	呼叫 GenerativeModel.countTokens() 的回應。
CustomErrorData	Details 物件，包含來自錯誤 HTTP 回應的資料。
日期_2	Protobuf google.type.Date
EnhancedGenerateContentResponse (強化版產生內容回應)	隨附輔助方法的回應物件。
ErrorDetails	可能包含在錯誤回應中的詳細資料物件。
檔案資料	指向上傳至 Google Cloud Storage 檔案的資料。
FileDataPart	部分代表 FileData 的內容部分介面
FunctionCall (函式呼叫)	從模型傳回的 FunctionCall，其中包含代表 FunctionDeclaration.name 的字串，以及包含參數及其值的結構化 JSON 物件。
FunctionCallingConfig
FunctionCallPart	如果部分代表 FunctionCall，則內容部分介面。
函式宣告	根據 OpenAPI 3.0 規格定義的函式宣告結構化表示。此宣告中包含函式名稱和參數。此 FunctionDeclaration 代表程式碼區塊的表示法，可當做模型使用的工具，並由用戶端執行。
FunctionDeclarationSchema	傳送至 FunctionDeclaration.parameters 的參數的結構定義。
FunctionDeclarationSchemaProperty	「結構定義」可用來定義輸入/輸出資料的格式。代表 OpenAPI 3.0 結構定義物件的選取子集。日後可能會視需要新增更多欄位。
函式宣告工具	FunctionDeclarationsTool 是一段程式碼，可讓系統與外部系統互動，在模型知識和範圍外，執行操作或一組動作。
FunctionResponse	FunctionCall 傳回的結果，其中包含代表 FunctionDeclaration.name 的字串，以及包含函式任何輸出內容的結構化 JSON 物件，會做為模型的內容。這應包含根據模型預測產生的 FunctionCall 結果。
FunctionResponsePart	部分代表 FunctionResponse 的內容部分介面。
GenerateContentCandidate	以 GenerateContentResponse 部分傳回的候選項目。
產生內容要求	透過 GenerativeModel.generateContent() 傳送要求
產生內容回應	GenerativeModel.generateContent() 和 GenerativeModel.generateContentStream() 的個別回應。generateContentStream() 會在串流完成前，在每個區塊中傳回一個回應。
產生內容結果	GenerativeModel.generateContent() 呼叫傳回的結果物件。
GenerateContentStreamResult	GenerativeModel.generateContentStream() 呼叫傳回的結果物件。反覆執行 stream 以取得切片，並在串流完成後/或使用 response 承諾，取得匯總回應。
GenerationConfig	內容相關要求的設定選項
GenerativeContentBlob	傳送圖片的介面。
GroundingAttribution
GroundingMetadata	啟用依據功能之後，傳回給用戶端的中繼資料。
InlineDataPart	內容部分代表圖片的內容部分。
ModelParams	傳送至 getGenerativeModel() 的參數。
PromptFeedback	如果提示遭到封鎖，系統會填入 blockReason 和相關 safetyRatings。
要求選項	傳送至 getGenerativeModel() 的參數。
RetrievedContextAttribution
SafetyRating	與 GenerateContentCandidate 相關聯的安全評分
安全設定	可做為要求參數傳送的安全設定。
Segment
StartChatParams	GenerativeModel.startChat() 的參數。
文字部分	部分代表文字字串的內容部分介面。
工具設定	工具設定。系統會為要求中提供的所有工具共用這項設定。
使用中繼資料	有關 GenerateContentResponse 的使用中繼資料。
VertexAI	Vertex AI for Firebase SDK 的執行個體。
VertexAIOptions	初始化 Vertex AI for Firebase SDK 時可用的選項。
影片中繼資料	說明輸入的影片內容。
網頁歸因

變數

變數	說明
POSSIBLE_ROLES	可能的角色。

型別別名

類型別名	說明
零件	內容部分 - 包括文字、圖片/影片，或函式呼叫/回應部分類型。
角色	角色是內容製作者，
工具	定義模型可以呼叫來存取外部知識的工具。

function(應用程式, ...)

getVertexAI(應用程式、選項)

傳回指定應用程式的 VertexAI 執行個體。

簽名：

export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;

參數

參數	類型	說明
app	Firebase 應用程式	要使用的 FirebaseApp。
選項	VertexAIOptions

傳回：

VertexAI

function(vertexAI, ...)

getGenerativeModel(vertexAI、modelParams、requestOptions)

傳回含有推論和其他功能方法的 GenerativeModel 類別。

簽名：

export declare function getGenerativeModel(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;

參數

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

傳回：

GenerativeModel

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"	回應發生錯誤。