vertexai-preview package

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 資料類型清單
有害封鎖方法
傷害封鎖門檻	系統會封鎖提示或候選人的門檻。
有害類別	可能導致提示或候選人遭封鎖的有害類別。
不良機率	提示或候選人與傷害類別相符的機率。
危害	危害的嚴重性等級。

介面

介面	說明
BaseParams	多種方法的基礎參數。
引用	單一引用資料。
引用中繼資料	您可以在 GenerateContentCandidate 中找到引用中繼資料。
Content	提示和回應候選項目的內容類型。
CountTokensRequest	呼叫 GenerativeModel.countTokens() 的參數
CountTokens 回應	呼叫 GenerativeModel.countTokens() 的回應。
日期_2	Protobuf google.type.Date
EnhancedGenerateContentResponse	以輔助方法包裝的回應物件。
檔案資料	指向上傳至 Google Cloud Storage 檔案的資料。
檔案資料部分	內容部分介面 (如果部分代表 FileData)
FunctionCall	從模型傳回的預測 FunctionCall。該模型包含代表 FunctionDeclaration.name 的字串，以及內含參數和參數值的結構化 JSON 物件。
FunctionCallingConfig
函式 CallPart	內容部分介面 (如果部分代表 FunctionCall)。
函式宣告	OpenAPI 3.0 規格所定義的函式宣告結構化表示法。此宣告中包含函式名稱和參數。這個 FunctionDeclaration 代表程式碼區塊，可用於模型做為工具，並由用戶端執行。
FunctionDeclarationSchema	傳送至 FunctionDeclaration.parameters 的參數結構定義。
FunctionDeclarationSchemaProperty	結構定義用於定義輸入/輸出資料的格式。代表 OpenAPI 3.0 結構定義物件的一部分。日後可視需求新增更多欄位。
FunctionDeclarationsTool	FunctionDeclarationsTool 是一段程式碼，可讓系統與外部系統互動，以便在模型的知識和範圍外執行動作或一組動作。
FunctionResponse	FunctionCall 產生的結果輸出結果，其中包含的字串代表 FunctionDeclaration.name，以及來自函式的任何輸出內容的結構化 JSON 物件，會做為模型的背景資訊。這應包含根據模型預測結果建立的 FunctionCall 結果。
FunctionResponsePart	如果部分代表 FunctionResponse，則內容部分介面。
GenerateContentCandidate	做為 GenerateContentResponse 的一部分傳回的候選項目。
GenerateContentRequest	透過 GenerativeModel.generateContent() 傳送要求
GenerateContentResponse	GenerativeModel.generateContent() 和 GenerativeModel.generateContentStream() 提供的個別回應。generateContentStream() 會在每個區塊中傳回一個回應，直到串流完成為止。
GenerateContentResult	GenerativeModel.generateContent() 呼叫傳回的結果物件。
GenerateContentStreamResult	從 GenerativeModel.generateContentStream() 呼叫傳回的結果物件。對 stream 進行疊代作業，取得傳入的區塊，和/或使用 response 承諾在串流完成後取得匯總回應。
GenerationConfig	內容相關要求的設定選項
GenerativeContentBlob	用於傳送圖片的介面。
基本歸因
基本中繼資料	啟用依據功能啟用時，系統傳回用戶端的中繼資料。
InlineDataPart	內容部分介面 (如果區塊代表圖片的話)。
ModelParams	傳遞至 getGenerativeModel() 的參數。
提示意見回饋	如果提示遭到封鎖，系統會填入 blockReason 和相關的 safetyRatings。
RequestOptions	傳遞至 getGenerativeModel() 的參數。
RetrievedContextAttribution
SafetyRating	與 GenerateContentCandidate 相關聯的安全性評分
SafetySettings	可在要求參數中傳送的安全設定。
Segment
StartChatParams	GenerativeModel.startChat() 的參數。
文字部分	內容部分介面 (如果部分代表文字字串)。
ToolConfig	工具設定。這項要求會提供給要求中提供的所有工具。
UsageMetadata	有關 GenerateContentResponse 的使用中繼資料。
VertexAI	Vertex AI for Firebase SDK 的執行個體，
VertexAIOptions	初始化 Vertex AI for Firebase SDK 的選項。
影片中繼資料	說明輸入的影片內容。
網路歸因

變數

變數	說明
可能的角色	可能的角色。

類型別名

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

function(app, ...)

getVertexAI(應用程式, 選項)

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

簽名：

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

參數

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

傳回：

VertexAI

函式(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"