Trang này được dịch bởi Cloud Translation API.

vertexai-preview package

Vertex AI cho Firebase Web SDK.

Hàm

Chức năng	Mô tả
hàm(app, ...)
getVertexAI(ứng dụng; tuỳ chọn)	Trả về một thực thể VertexAI cho ứng dụng cụ thể.
hàm(vertexAI, ...)
getGenerativeModel(vertexAI, modelParams, requestOptions)	Trả về một lớp GenerativeModel kèm theo các phương thức suy luận và chức năng khác.

Hạng

Hạng	Mô tả
ChatSession	Lớp ChatSession cho phép gửi tin nhắn trò chuyện và lưu trữ nhật ký tin nhắn đã gửi và nhận cho đến thời điểm hiện tại.
Mô hình tạo sinh	Lớp cho các API mô hình tạo sinh.
VertexAIError	Lớp lỗi cho SDK Vertex AI cho Firebase.

Liệt kê

Liệt kê	Mô tả
BlockLý do	Lý do chặn lời nhắc.
Hoàn tất lý do	Lý do ứng cử viên đã hoàn tất.
FunctionCallbackMode
FunctionDeclarationSchemaType	Chứa danh sách các loại dữ liệu OpenAPI như được xác định theo https://swagger.io/docs/specification/data-models/data-types/
HarmBlockMethod
HarmBlockThreshold	Ngưỡng mà khi đó một câu lệnh hoặc ứng viên sẽ bị chặn.
Danh mục xúc phạm	Các danh mục gây hại sẽ khiến câu lệnh hoặc đề xuất bị chặn.
Xác suất gây tổn hại	Xác suất mà một câu lệnh hoặc ứng viên khớp với một danh mục gây hại.
Mức độ nghiêm trọng	Mức độ nghiêm trọng của tổn hại.
VertexAIErrorCode	Các mã lỗi được chuẩn hoá mà VertexAIError có thể gặp phải.

Giao diện

Giao diện	Mô tả
BaseParams (Thông số cơ bản)	Tham số cơ sở cho một số phương thức.
Câu trích dẫn	Một trích dẫn duy nhất.
Siêu dữ liệu trích dẫn	Siêu dữ liệu trích dẫn có thể tìm thấy trên GenerateContentCandidate.
Nội dung	Loại nội dung cho cả câu lệnh và câu trả lời đề xuất.
CountTokensRequest	Các thông số để gọi GenerativeModel.countTokens()
CountTokensResponse	Phản hồi từ lệnh gọi GenerativeModel.countTokens().
CustomErrorData	Đối tượng Chi tiết chứa dữ liệu bắt nguồn từ một phản hồi HTTP không hợp lệ.
Ngày_2	Protobuf google.type.Date
Nâng caoGenerateContentResponse	Đối tượng phản hồi được gói bằng các phương thức trợ giúp.
Thông tin chi tiết về lỗi	Đối tượng chi tiết có thể được đưa vào trong phản hồi lỗi.
FileData	Dữ liệu trỏ đến một tệp được tải lên Google Cloud Storage.
FileDataPart	Giao diện phần nội dung nếu phần đó biểu thị FileData
FunctionCall	Một FunctionCall được dự đoán được trả về từ mô hình chứa chuỗi đại diện cho FunctionDeclaration.name và một đối tượng JSON có cấu trúc chứa các tham số và giá trị của các tham số đó.
FunctionCallConfig
FunctionCallPart	Giao diện phần nội dung nếu phần đó đại diện cho FunctionCall.
FunctionKhailaration	Biểu diễn có cấu trúc của nội dung khai báo hàm như được xác định trong quy cách OpenAPI 3.0. Tên hàm và tham số có trong phần khai báo này. `FunctionDeclaration` này là đại diện của một khối mã mà mô hình có thể dùng làm Công cụ và được ứng dụng thực thi.
FunctionKhailarationSchema	Giản đồ cho các tham số được truyền đến Functiondeclaration.parameters.
FunctionDeclarationSchemaProperty	Giản đồ dùng để xác định định dạng của dữ liệu đầu vào/đầu ra. Đại diện cho một tập hợp con chọn lọc của đối tượng giản đồ OpenAPI 3.0. Trong tương lai, chúng tôi có thể thêm các trường khác nếu cần.
FunctionDeclarationsTool	`FunctionDeclarationsTool` là một đoạn mã cho phép hệ thống tương tác với các hệ thống bên ngoài để thực hiện một hành động hoặc một tập hợp hành động, nằm ngoài phạm vi kiến thức và phạm vi của mô hình.
FunctionResponse	Kết quả đầu ra từ một hàm FunctionCall có chứa chuỗi đại diện cho FunctionDeclaration.name và một đối tượng JSON có cấu trúc chứa bất kỳ dữ liệu đầu ra nào của hàm sẽ được dùng làm ngữ cảnh cho mô hình. Hàm này sẽ chứa kết quả của FunctionCall được đưa ra dựa trên thông tin dự đoán về mô hình.
FunctionResponsePart	Giao diện phần nội dung nếu phần đó biểu thị hàm FunctionResponse.
GenerateContentCandidate	Một đề xuất được trả về trong quá trình GenerateContentResponse.
GenerateContentRequest	Yêu cầu được gửi qua GenerativeModel.generateContent()
GenerateContentResponse	Phản hồi riêng lẻ từ GenerativeModel.generateContent() và GenerativeModel.generateContentStream(). `generateContentStream()` sẽ trả về một giá trị trong mỗi đoạn cho đến khi luồng hoàn tất.
GenerateContentResult	Đối tượng kết quả được trả về từ lệnh gọi GenerativeModel.generateContent().
GenerateContentStreamResult	Đối tượng kết quả được trả về từ lệnh gọi GenerativeModel.generateContentStream(). Lặp lại `stream` để nhận các phân đoạn khi chúng được đưa vào và/hoặc sử dụng lời hứa `response` để nhận được phản hồi tổng hợp khi luồng hoàn tất.
GenerationConfig	Các lựa chọn cấu hình cho các yêu cầu liên quan đến nội dung
GenerativeContentBlob	Giao diện để gửi hình ảnh.
Phân bổ tiếp đất
Siêu dữ liệu nối đất	Siêu dữ liệu được trả về máy khách khi tính năng tiếp đất đang bật.
InlineDataPart	Giao diện phần nội dung nếu phần đó biểu thị một hình ảnh.
ModelParams	Các tham số được chuyển đến getGenerativeModel().
PromptResponse	Nếu bạn chặn lời nhắc, thì giá trị này sẽ được điền bằng `blockReason` và `safetyRatings` liên quan.
RequestOptions (Tuỳ chọn yêu cầu)	Các tham số được chuyển đến getGenerativeModel().
RetrievedContextAttribution
SafetyRating	Mức xếp hạng an toàn được liên kết với GenerateContentCandidate
Cài đặt an toàn	Bạn có thể gửi chế độ cài đặt an toàn trong tham số yêu cầu.
Segment
StartChatParams	Tham số cho GenerativeModel.startChat().
Phần văn bản	Giao diện phần nội dung nếu phần đó biểu thị một chuỗi văn bản.
ToolConfig	Cấu hình công cụ. Cấu hình này được dùng chung cho tất cả các công cụ được cung cấp trong yêu cầu.
Siêu dữ liệu sử dụng	Siêu dữ liệu về hoạt động sử dụng về một GenerateContentResponse.
VertexAI	Một bản sao của SDK Vertex AI cho Firebase.
VertexAIOptions	Các lựa chọn khi khởi chạy SDK Vertex AI cho Firebase.
VideoMetadata	Mô tả nội dung video đầu vào.
Phân bổ web

Biến

Biến	Mô tả
POSSIBLE_ROLES	Vai trò có thể có.

Nhập bí danh

Nhập bí danh	Mô tả
Phần	Phần nội dung – bao gồm văn bản, hình ảnh/video hoặc các loại phần cuộc gọi/phản hồi hàm.
Vai trò	Vai trò là nhà sản xuất nội dung.
Công cụ	Xác định một công cụ mà mô hình có thể gọi để truy cập kiến thức bên ngoài.

function(app, ...)

getVertexAI(ứng dụng; tuỳ chọn)

Trả về một thực thể VertexAI cho ứng dụng cụ thể.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng Firebase	FirebaseApp để sử dụng.
tuỳ chọn	VertexAIOptions

Trường hợp trả lại hàng:

VertexAI

hàm(vertexAI, ...)

getGenerativeModel(vertexAI; modelParams; requestOptions)

Trả về một lớp GenerativeModel kèm theo các phương thức suy luận và chức năng khác.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
đỉnh (vertexAI)	VertexAI
mô hình tham số	ModelParams
requestOptions	RequestOptions (Tuỳ chọn yêu cầu)

Trường hợp trả lại hàng:

Mô hình tạo sinh

POSSIBLE_ROLES

Vai trò có thể có.

Chữ ký:

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

Phần

Phần nội dung – bao gồm văn bản, hình ảnh/video hoặc các loại phần cuộc gọi/phản hồi hàm.

Chữ ký:

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

Vai trò

Vai trò là nhà sản xuất nội dung.

Chữ ký:

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

Dụng cụ

Xác định một công cụ mà mô hình có thể gọi để truy cập kiến thức bên ngoài.

Chữ ký:

export declare type Tool = FunctionDeclarationsTool;

Lý do chặn

Lý do chặn lời nhắc.

Chữ ký:

export declare enum BlockReason

Thành viên liệt kê

Thành viên	Giá trị	Mô tả
BLOCKED_REASON_UNSPECIFIED	`"BLOCKED_REASON_UNSPECIFIED"`
KHÁC	`"OTHER"`
AN TOÀN	`"SAFETY"`

lý do hoàn thành

Lý do ứng cử viên đã hoàn tất.

Chữ ký:

export declare enum FinishReason

Thành viên liệt kê

Thành viên	Giá trị	Mô tả
XONG_REASON_UNSPECIFIED	`"FINISH_REASON_UNSPECIFIED"`
MAX_TOKENS	`"MAX_TOKENS"`
KHÁC	`"OTHER"`
TĂNG CƯỜNG	`"RECITATION"`
AN TOÀN	`"SAFETY"`
DỪNG	`"STOP"`

FunctionCallbackMode

Chữ ký:

export declare enum FunctionCallingMode

Thành viên liệt kê

Thành viên	Giá trị	Mô tả
BẤT KỲ	`"ANY"`
TỰ ĐỘNG	`"AUTO"`
MODE_UNSPECIFIED	`"MODE_UNSPECIFIED"`
KHÔNG MÀU	`"NONE"`

FunctionDeclarationSchemaType

Chứa danh sách các loại dữ liệu OpenAPI như được xác định theo https://swagger.io/docs/specification/data-models/data-types/

Chữ ký:

export declare enum FunctionDeclarationSchemaType

Thành viên liệt kê

Thành viên	Giá trị	Mô tả
Hàm ARRAY	`"ARRAY"`	Loại mảng.
BOOLEAN	`"BOOLEAN"`	Loại boolean.
INTEGER	`"INTEGER"`	Loại số nguyên.
SỐ	`"NUMBER"`	Loại số.
ĐỐI TƯỢNG	`"OBJECT"`	Loại đối tượng.
STRING	`"STRING"`	Loại chuỗi.

HarmBlockMethod

Chữ ký:

export declare enum HarmBlockMethod

Thành viên liệt kê

Thành viên	Giá trị	Mô tả
HARM_BLOCK_METHOD_UNSPECIFIED	`"HARM_BLOCK_METHOD_UNSPECIFIED"`
KHẢ NĂNG	`"PROBABILITY"`
Mức độ nghiêm trọng	`"SEVERITY"`

Ngưỡng Tác hại

Ngưỡng mà khi đó một câu lệnh hoặc ứng viên sẽ bị chặn.

Chữ ký:

export declare enum HarmBlockThreshold

Thành viên liệt kê

Thành viên	Giá trị	Mô tả
BLOCK_LOW_AND_ABOVE	`"BLOCK_LOW_AND_ABOVE"`
BLOCK_MEDIUM_AND_Ở TRÊN	`"BLOCK_MEDIUM_AND_ABOVE"`
BLOCK_NONE	`"BLOCK_NONE"`
BLOCK_ONLY_HIGH	`"BLOCK_ONLY_HIGH"`
HARM_BLOCK_ hai lần lượt nhấp vào để xác minh	`"HARM_BLOCK_THRESHOLD_UNSPECIFIED"`

Danh mục Harm

Các danh mục gây hại sẽ khiến câu lệnh hoặc đề xuất bị chặn.

Chữ ký:

export declare enum HarmCategory

Thành viên liệt kê

Thành viên	Giá trị	Mô tả
NỘI DUNG 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"`

Khả năng gây hại

Xác suất mà một câu lệnh hoặc ứng viên khớp với một danh mục gây hại.

Chữ ký:

export declare enum HarmProbability

Thành viên liệt kê

Thành viên	Giá trị	Mô tả
HARM_PROBABILITY_UNSPECIFIED	`"HARM_PROBABILITY_UNSPECIFIED"`
CAO	`"HIGH"`
THẤP	`"LOW"`
VỪA PHẢI	`"MEDIUM"`
PHÙ HỢP	`"NEGLIGIBLE"`

Mức độ nghiêm trọng

Mức độ nghiêm trọng của tổn hại.

Chữ ký:

export declare enum HarmSeverity

Thành viên liệt kê

Thành viên	Giá trị	Mô tả
HARM_SEVERITY_HIGH	`"HARM_SEVERITY_HIGH"`
HARM_SEVERITY_LOW	`"HARM_SEVERITY_LOW"`
HARM_SEVERITY_TRUNG BÌNH	`"HARM_SEVERITY_MEDIUM"`
HARM_SEVERITY_NEGLIGIBLE	`"HARM_SEVERITY_NEGLIGIBLE"`
HARM_SEVERITY_UNSPECIFIED	`"HARM_SEVERITY_UNSPECIFIED"`

Mã lỗi VertexAI

Các mã lỗi được chuẩn hoá mà VertexAIError có thể gặp phải.

Chữ ký:

export declare const enum VertexAIErrorCode

Thành viên liệt kê

Thành viên	Giá trị	Mô tả
LỖI	`"error"`	Đã xảy ra lỗi chung.
TÌM NẠP_LỖI	`"fetch-error"`	Đã xảy ra lỗi trong khi thực hiện tìm nạp.
NỘI_ DUNG KHÔNG HỢP LỆ	`"invalid-content"`	Lỗi liên quan đến đối tượng Nội dung.
NO_API_KEY	`"no-api-key"`	Đã xảy ra lỗi do thiếu khoá API Firebase.
NO_MODEL	`"no-model"`	Đã xảy ra lỗi do tên mô hình chưa được chỉ định trong quá trình khởi chạy.
NO_PROJECT_ID	`"no-project-id"`	Đã xảy ra lỗi do thiếu mã dự án.
PARSE_FAILED	`"parse-failed"`	Đã xảy ra lỗi khi phân tích cú pháp.
LỖI_YÊU CẦU	`"request-error"`	Đã xảy ra lỗi trong yêu cầu.
PHẢN_ẢN_H_ẢNH	`"response-error"`	Đã xảy ra lỗi trong phản hồi.