Firebase Web SDK 中的 Vertex AI。
函数
函数 | 说明 |
---|---|
function(应用, ...) | |
getVertexAI(app, options) | 返回给定应用的 VertexAI 实例。 |
function(vertexAI, ...) | |
getGenerativeModel(vertexAI, modelParams, requestOptions) | 返回具有推理和其他功能的方法的 GenerativeModel 类。 |
类
类 | 说明 |
---|---|
ChatSession | ChatSession 类,用于发送聊天消息,并存储到目前为止已发送和已接收消息的历史记录。 |
GenerativeModel | 用于生成模型 API 的类。 |
VertexAIError | Vertex AI in Firebase SDK 的错误类。 |
枚举
枚举 | 说明 |
---|---|
BlockReason | 提示被屏蔽的原因。 |
FinishReason | 候选人结束投票的原因。 |
FunctionCallingMode | |
FunctionDeclarationSchemaType | 包含 https://swagger.io/docs/specification/data-models/data-types/ 定义的 OpenAPI 数据类型列表 |
HarmBlockMethod | |
HarmBlockThreshold | 如果超出此阈值,系统将屏蔽提示或候选字词。 |
危害类别 | 会导致提示或候选者被屏蔽的有害类别。 |
HarmProbability | 提示或候选人与伤害类别匹配的概率。 |
HarmSeverity | 危害严重级别。 |
VertexAIErrorCode | VertexAIError 可能包含的标准化错误代码。 |
接口
变量
变量 | 说明 |
---|---|
POSSIBLE_ROLES | 可能的角色。 |
类型别名
类型别名 | 说明 |
---|---|
部分 | 内容部分 - 包括文本、图片/视频或函数调用/响应部分类型。 |
角色 | 角色是内容的制作者。 |
工具 | 定义模型可以调用以访问外部知识的工具。 |
function(应用, ...)
getVertexAI(app, options)
返回给定应用的 VertexAI 实例。
签名:
export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
参数
参数 | 类型 | 说明 |
---|---|---|
应用 | FirebaseApp | 要使用的 FirebaseApp。 |
选项 | VertexAIOptions |
返回:
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 |
返回:
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 | "SAFETY" |
完成原因
候选人结束投票的原因。
签名:
export declare enum FinishReason
枚举成员
成员 | 值 | 说明 |
---|---|---|
FINISH_REASON_UNSPECIFIED | "FINISH_REASON_UNSPECIFIED" |
|
MAX_TOKENS | "MAX_TOKENS" |
|
其他 | "OTHER" |
|
RECITATION | "RECITATION" |
|
SAFETY | "SAFETY" |
|
停止 | "STOP" |
函数调用模式
签名:
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 | "BOOLEAN" |
布尔值类型。 |
INTEGER | "INTEGER" |
整数类型。 |
数字 | "NUMBER" |
数字类型。 |
OBJECT | "OBJECT" |
对象类型。 |
STRING | "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" |
回复时出错。 |