vertexai-preview package

SDK web của Vertex AI cho Firebase.

Hàm

Chức năng	Mô tả
hàm(ứng dụng, ...)
getVertexAI(ứng dụng, tuỳ chọn)	Trả về một thực thể VertexAI cho ứng dụng đã cho.
hàm(vertexAI, ...)
getGenerativeModel(vertexAI, modelParams, requestOptions)	Trả về một lớp GenerativeModel với các phương thức để dự đoán và chức năng khác.

Hạng

Hạng	Mô tả
ChatSession (Phiên trò chuyện)	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 từ trước đến nay.
Mô hình tạo sinh	Lớp dành cho các API mô hình tạo sinh.

Bảng liệt kê

Liệt kê	Mô tả
BlockReason	Lý do chặn lời nhắc.
FinishReason	Lý do khiến một ứng cử viên hoàn thành.
FunctionGọiMode
FunctionDeclarationSchemaType	Chứa danh sách các loại dữ liệu OpenAPI như được xác định tại https://swagger.io/docs/specification/data-models/data-types/
HarmBlockMethod
HarmBlockNgưỡng	Ngưỡng mà trên đó lời nhắc hoặc đề xuất sẽ bị chặn.
HarmCategory	Gây hại cho các danh mục khiến câu lệnh hoặc đề xuất bị chặn.
Xác suất gây thương tích	Xác suất mà một câu lệnh hoặc đề xuất 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 gây hại.

Giao diện

Giao diện	Mô tả
BaseParams	Tham số cơ sở cho một số phương thức.
Tài liệu tham khảo	Một lời trích dẫn.
CitationMetadata	Siêu dữ liệu trích dẫn có thể có trên GenerateContentCandidate.
Nội dung	Loại nội dung cho cả câu lệnh và câu trả lời cho đề xuất.
CountTokensRequest	Các tham số để gọi GenerativeModel.countTokens()
CountTokensResponse	Phản hồi từ lệnh gọi GenerativeModel.countTokens().
Ngày_2	Protobuf google.type.Date
AdvancedGenerateContentResponse (Tạo nội dung phản hồi nâng cao)	Đối tượng phản hồi được gói bằng các phương thức trợ giúp.
FileData	Dữ liệu trỏ tới một tệp đã tải lên Google Cloud Storage.
FileDataPart	Giao diện của phần nội dung nếu phần đó đại diện cho FileData
FunctionCall	Hàm FunctionCall được dự đoán được trả về từ mô hình chứa một 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ố đó.
FunctionGọiConfig
FunctionCallPart	Giao diện phần nội dung nếu phần đó đại diện cho một FunctionCall.
Khai báo hàm	Nội dung trình bày có cấu trúc của phần khai báo hàm theo xác định trong quy cách OpenAPI 3.0. Nội dung khai báo này có tên hàm và các tham số. FunctionDeclaration này là đại diện của một khối mã mà mô hình có thể sử dụng làm Công cụ và được ứng dụng thực thi.
FunctionDeclarationSchema	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 nhóm hành động 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 FunctionCall chứa một 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ỳ đầu ra nào của hàm đượ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 thực hiện dựa trên dự đoán mô hình.
FunctionResponsePart	Giao diện phần nội dung nếu phần đó đại diện cho FunctionResponse.
GenerateContentCandidate	Một đề xuất được trả về trong GenerateContentResponse.
GenerateContentRequest	Yêu cầu được gửi thông qua GenerativeModel.generateContent()
GenerateContentResponse	Phản hồi riêng lẻ từ GenerativeModel.generateContent() và GenerativeModel.generateContentStream(). generateContentStream() sẽ trả về một phản hồi trong mỗi đoạn cho đến khi quá trình truyền 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 hứa hẹn 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ổ mặt đất
GroundingMetadata (Siêu dữ liệu mặt đất)	Siêu dữ liệu được trả về ứng dụng khi nối đất đang bật.
InlineDataPart	Giao diện của phần nội dung nếu phần đó đại diện cho một hình ảnh.
ModelParams	Các tham số được truyền đến getGenerativeModel().
PromptPhản hồi	Nếu câu lệnh bị chặn, thì hàm này sẽ được điền bằng blockReason và safetyRatings có liên quan.
RequestOptions (Tùy chọn yêu cầu)	Các tham số được truyền đến getGenerativeModel().
RetrievedContextAttribution
Mức phân loại an toàn	Điểm xếp hạng an toàn liên kết với GenerateContentCandidate
Cài đặt an toàn	Chế độ cài đặt an toàn có thể được gửi dưới dạng một phần của tham số yêu cầu.
Segment
StartChatParams	Các tham số cho GenerativeModel.startChat().
Phần văn bản	Giao diện của phần nội dung nếu phần đó đại diện cho một chuỗi văn bản.
Cấu hình công cụ	Cấu hình công cụ. Cấu hình này dùng chung cho tất cả công cụ được cung cấp trong yêu cầu.
UsageMetadata	Siêu dữ liệu sử dụng cho GenerateContentResponse.
AI Vertex	Một phiên bản 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	Các vai trò có thể đảm nhiệm.

Loại bí danh

Loại 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 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 vào kiến thức bên ngoài.

chức năng(ứng dụng, ...)

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

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

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.
tuỳ chọn	VertexAIOptions

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

AI Vertex

hàm(vertexAI, ...)

getGenerativeModel(vertexAI, modelParams, requestOptions)

Trả về một lớp GenerativeModel với các phương thức để dự đoá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ả
AI đỉnh cao	AI Vertex
modelParams	ModelParams
Tùy chọn yêu cầu	RequestOptions (Tùy chọn yêu cầu)

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

Mô hình tạo sinh

VAI_BỊ CÓ THỂ

Các vai trò có thể đảm nhiệm.

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 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 vào kiến thức bên ngoài.

Chữ ký:

export declare type Tool = FunctionDeclarationsTool;

BlockReason

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 tất

Lý do khiến một ứng cử viên hoàn thành.

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"
TUYỂN TẬP	"RECITATION"
AN TOÀN	"SAFETY"
DỪNG	"STOP"

Chế độ gọi hàm

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 tại 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"	Kiểu 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.

Phương thức HarmBlock

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"

HarmBlockNgưỡng

Ngưỡng mà trên đó lời nhắc hoặc đề xuất 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ả
CHẶN_THẤP_VÀ_TRÊN	"BLOCK_LOW_AND_ABOVE"
CHẶN_TRUNG_BÌNH_VÀ_Ở TRÊN	"BLOCK_MEDIUM_AND_ABOVE"
CHẶN_NONE	"BLOCK_NONE"
CHẶN_CHỈ_CAO	"BLOCK_ONLY_HIGH"
HARM_BLOCK_Crashlytics_UNSPECIFIED	"HARM_BLOCK_THRESHOLD_UNSPECIFIED"

Thể loại gây hại

Gây hại cho các danh mục 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ả
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"

Xác suất gây hại

Xác suất mà một câu lệnh hoặc đề xuất 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"
KHÔNG BẮT BUỘC	"NEGLIGIBLE"

Mức độ nghiêm trọng

Mức độ nghiêm trọng gây 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"