vertexai-preview package

Vertex AI For Firebase Web SDK。

Functions

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

类

类	说明
ChatSession	ChatSession 类，用于发送聊天消息，并存储到目前为止已发送和已接收消息的历史记录。
GenerativeModel	用于生成模型 API 的类。
VertexAIError	Vertex AI for Firebase SDK 的错误类。

枚举

Enumeration	说明
BlockReason	提示被屏蔽的原因。
FinishReason	候选人结束投票的原因。
FunctionCallingMode
FunctionDeclarationSchemaType	包含 https://swagger.io/docs/specification/data-models/data-types/ 定义的 OpenAPI 数据类型列表
HarmBlockMethod
HarmBlockThreshold	如果超出此阈值，系统将屏蔽提示或候选字词。
危害类别	会导致提示或候选者被屏蔽的有害类别。
HarmProbability	提示或候选人与伤害类别匹配的概率。
HarmSeverity	危害严重级别。
VertexAIErrorCode	VertexAIError 可能包含的标准化错误代码。

接口

接口	说明
BaseParams	许多方法的基本参数。
引用	单次引用。
引用元数据	可以在 GenerateContentCandidate 中找到的引用元数据。
内容	提示和候选回复的内容类型。
CountTokensRequest	用于调用 GenerativeModel.countTokens() 的参数
CountTokensResponse	调用 GenerativeModel.countTokens() 时的响应。
CustomErrorData	Details 对象，包含源自错误 HTTP 响应的数据。
日期 2	协议缓冲区 google.type.Date
EnhancedGenerateContentResponse	使用辅助方法封装的响应对象。
错误详细信息	错误响应可能包含的详细信息对象。
FileData 类中的方法	指向上传到 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	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	用于发送图片的接口。
依据归因
GroundingMetadata	启用依据功能时向客户端返回的元数据。
InlineDataPart	内容部分接口（如果相应部分表示图片）。
ModelParams	传递给 getGenerativeModel() 的参数。
PromptFeedback 接口	如果提示被屏蔽，将使用 blockReason 和相关的 safetyRatings 进行填充。
RequestOptions	传递给 getGenerativeModel() 的参数。
RetrievedContextAttribution
安全评级	与 GenerateContentCandidate 关联的安全评级
SafetySetting	可作为请求参数的一部分发送的安全设置。
Segment
StartChatParams	GenerativeModel.startChat() 的参数。
TextPart	内容部分接口（如果部分表示文本字符串）。
工具配置	工具配置。请求中提供的所有工具共享此配置。
UsageMetadata	有关 GenerateContentResponse 的使用情况元数据。
VertexAI	一个 Vertex AI for Firebase SDK 实例。
VertexAIOptions	初始化 Vertex AI for Firebase SDK 时的选项。
VideoMetadata	描述输入的视频内容。
网络归因

变量

变量	说明
POSSIBLE_ROLES	可能的角色。

类型别名

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

function(应用, ...)

getVertexAI(app, options)

返回给定应用的 VertexAI 实例。

签名：

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

参数

参数	类型	说明
app	FirebaseApp	要使用的 FirebaseApp。
选项	VertexAIOptions

返回：

VertexAI

function(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;

屏蔽原因

提示被屏蔽的原因。

签名：

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	"MODE_UNSPECIFIED"
无	"NONE"

FunctionDeclarationSchemaType

包含 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"

VertexAIErrorCode

VertexAIError 可能包含的标准化错误代码。

签名：

export declare const enum VertexAIErrorCode 

枚举成员

成员	价值	说明
错误	"error"	发生常规错误。
FETCH_错误	"fetch-error"	执行提取操作时出错。
INVALID_CONTENT	"invalid-content"	与 Content 对象相关的错误。
NO_API_KEY	"no-api-key"	由于缺少 Firebase API 密钥，发生错误。
NO_MODEL	"no-model"	由于未在初始化期间指定模型名称，因此发生错误。
NO_PROJECT_ID	"no-project-id"	缺少项目 ID 时出错。
PARSE_FAILED	"parse-failed"	解析时出错。
请求错误	"request-error"	请求出错。
RESPONSE_ERROR 错误	"response-error"	回复时出错。