vertexai-preview package

Vertex AI for Firebase Web SDK。

Functions

函数	说明
function(app, ...)
getVertexAI(app, options)	返回指定应用的 VertexAI 实例。
function(vertexAI, ...)
getGenerativeModel(vertexAI, modelParams, requestOptions)	返回包含推断方法和其他功能的 GenerativeModel 类。

类

类	说明
ChatSession	ChatSession 类，支持发送聊天消息，并存储到目前为止已发送和已接收消息的历史记录。
GenerativeModel	用于生成模型 API 的类。

枚举

Enumeration	说明
BlockReason	提示被屏蔽的原因。
FinishReason	候选人结束播放的原因。
FunctionCallingMode
FunctionDeclarationSchemaType	包含 https://swagger.io/docs/specification/data-models/data-types/ 定义的 OpenAPI 数据类型列表
HarmBlockMethod
HarmBlockThreshold	超过这个阈值后，提示或候选字词就会被屏蔽。
HarmCategory	会导致提示或候选人被屏蔽的有害类别。
危害概率	提示或候选对象与某个伤害类别匹配的概率。
有害程度	危害的严重程度。

接口

接口	说明
BaseParams	许多方法的基本参数。
引用	单个引用。
CitationMetadata	可以在 GenerateContentCandidate 上找到的引用元数据。
内容	提示和候选回答的内容类型。
CountTokensRequest	用于调用 GenerativeModel.countTokens() 的参数
CountTokensResponse	调用 GenerativeModel.countTokens() 的响应。
日期 2	协议缓冲区 google.type.Date
增强型转化	使用辅助方法封装的响应对象。
FileData 类）	指向上传到 Google Cloud Storage 的文件的数据。
FileDataPart	内容部分接口（如果该部分表示 FileData）
函数调用	从模型返回的预测 FunctionCall，其中包含一个表示 FunctionDeclaration.name 的字符串和一个包含参数及其值的结构化 JSON 对象。
FunctionCallingConfig
FunctionCallPart	内容部分接口（如果该部分表示 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 promise 在流完成时获取汇总响应。
GenerationConfig	内容相关请求的配置选项
GenerativeContentBlob	用于发送图片的界面。
GroundingAttribution
GroundingMetadata	启用依据时向客户端返回的元数据。
InlineDataPart	内容部分接口（如果该部分表示图片）。
ModelParams	传递给 getGenerativeModel() 的参数。
提示反馈	如果提示被屏蔽，系统将使用 blockReason 和相关的 safetyRatings 填充此字段。
RequestOptions	传递给 getGenerativeModel() 的参数。
RetrievedContextAttribution
安全等级	与 GenerateContentCandidate 相关联的安全评分
安全设置	可作为请求参数的一部分发送的安全设置。
Segment
StartChatParams	GenerativeModel.startChat() 的参数。
TextPart	内容部分接口（如果该部分表示文本字符串）。
ToolConfig	工具配置系统会为请求中提供的所有工具共享此配置。
UsageMetadata	有关 GenerateContentResponse 的使用情况元数据。
VertexAI	一个 Vertex AI for Firebase SDK 实例。
VertexAIOptions	初始化 Vertex AI for Firebase SDK 时的选项。
VideoMetadata	描述输入视频内容。
网站归因

变量

变量	说明
POSSIBLE_ROLES	可能的角色。

类型别名

类型别名	说明
部分	内容部分 - 包括文本、图片/视频或函数调用/响应部分类型。
Role	角色是内容的制作者。
工具	定义模型可调用以访问外部知识的工具。

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;

参数

参数	类型	说明
Vertex AI	VertexAI
modelParams	ModelParams
requestOptions	RequestOptions

返回：

GenerativeModel

POSSIBLE_ROLES

可能的角色。

签名：

POSSIBLE_ROLES: readonly ["user", "model", "function", "system"]

部分

内容部分 - 包括文本、图片/视频或函数调用/响应部分类型。

签名：

export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;

角色

角色是内容的制作者。

签名：

export declare type Role = (typeof POSSIBLE_ROLES)[number];

工具

定义模型可调用以访问外部知识的工具。

签名：

export declare type Tool = FunctionDeclarationsTool;

BlockReason

提示被屏蔽的原因。

签名：

export declare enum BlockReason 

枚举成员

成员	值	说明
BLOCKED_REASON_UNSPECIFIED	"BLOCKED_REASON_UNSPECIFIED"
其他	"OTHER"
安全	"SAFETY"

FinishReason

候选人结束播放的原因。

签名：

export declare enum FinishReason 

枚举成员

成员	值	说明
FINISH_REASON_UNSPECIFIED	"FINISH_REASON_UNSPECIFIED"
MAX_TOKENS 个	"MAX_TOKENS"
其他	"OTHER"
邀请	"RECITATION"
安全	"SAFETY"
停止	"STOP"

FunctionCallingMode

签名：

export declare enum FunctionCallingMode 

枚举成员

成员	值	说明
任意	"ANY"
自动	"AUTO"
MODE_UNSPECIFIED	"MODE_UNSPECIFIED"
无	"NONE"

函数声明架构类型

包含 https://swagger.io/docs/specification/data-models/data-types/ 定义的 OpenAPI 数据类型列表

签名：

export declare enum FunctionDeclarationSchemaType 

枚举成员

成员	值	说明
ARRAY	"ARRAY"	数组类型。
布尔值	"BOOLEAN"	布尔值类型。
INTEGER	"INTEGER"	整数类型。
数字	"NUMBER"	数字类型。
OBJECT	"OBJECT"	对象类型。
字符串	"STRING"	字符串类型。

HarmBlockMethod

签名：

export declare enum HarmBlockMethod 

枚举成员

成员	值	说明
HARM_BLOCK_METHOD_UNSPECIFIED	"HARM_BLOCK_METHOD_UNSPECIFIED"
概率	"PROBABILITY"
SEVERITY	"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"

HarmCategory

会导致提示或候选人被屏蔽的有害类别。

签名：

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"