Halaman ini diterjemahkan oleh Cloud Translation API.

vertexai-preview package

Vertex AI For Firebase Web SDK.

Functions

Fungsi	Deskripsi
fungsi(aplikasi, ...)
getVertexAI(aplikasi, opsi)	Menampilkan instance VertexAI untuk aplikasi tertentu.
fungsi(vertexAI, ...)
getGenerativeModel(vertexAI, modelParams, requestOptions)	Menampilkan class GenerativeModel dengan metode untuk inferensi dan fungsi lainnya.

Kelas

Class	Deskripsi
ChatSession	Kelas ChatSession yang memungkinkan pengiriman pesan chat dan menyimpan histori pesan yang dikirim dan diterima sejauh ini.
GenerativeModel	Class untuk API model generatif.
VertexAIError	Class error untuk Vertex AI for Firebase SDK.

Enumeration

Enumerasi	Deskripsi
BlockAlasan	Alasan perintah diblokir.
FinishAlasan	Alasan kandidat sudah selesai.
FunctionCallingMode
FunctionDeclarationSchemaType	Berisi daftar jenis data OpenAPI seperti yang ditentukan oleh https://swagger.io/docs/specification/data-models/data-types/
HarmBlockMethod
HarmBlockThreshold	Nilai minimum yang melebihi nilai tersebut, sehingga perintah atau kandidat akan diblokir.
HarmCategory	Kategori berbahaya yang dapat menyebabkan perintah atau kandidat diblokir.
HarmProbability	Probabilitas bahwa perintah atau kandidat cocok dengan kategori bahaya.
Tingkat Keseriusan Bahaya	Tingkat keparahan bahaya.
VertexAIErrorCode	Kode error standar yang dapat dimiliki VertexAIError.

Antarmuka

Antarmuka	Deskripsi
BaseParams	Parameter dasar untuk sejumlah metode.
Kutipan	Satu kutipan.
Kutipan Metadata	Metadata kutipan yang dapat ditemukan di GenerateContentCandidate.
Content	Jenis konten untuk perintah dan kandidat respons.
CountTokensRequest	Parameter untuk memanggil GenerativeModel.countTokens()
CountTokensResponse	Respons dari pemanggilan GenerativeModel.countTokens().
CustomErrorData	Detail objek yang berisi data yang berasal dari respons HTTP yang buruk.
Tanggal_2	Protobuf google.type.Date
EnhancedGenerateContentResponse	Objek respons yang digabungkan dengan metode bantuan.
ErrorDetails	Detail objek yang mungkin disertakan dalam respons error.
DataFile	Data yang mengarah ke file yang diupload di Google Cloud Storage.
FileDataPart	Antarmuka bagian konten jika bagian tersebut mewakili FileData
PanggilanFungsi	FunctionCall yang diprediksi ditampilkan dari model yang berisi string yang mewakili FunctionDeclaration.name dan objek JSON terstruktur yang berisi parameter dan nilainya.
FunctionCallingConfig
FunctionCallPart	Antarmuka bagian konten jika bagian tersebut mewakili FunctionCall.
FunctionDeclaration	Representasi terstruktur dari deklarasi fungsi seperti yang ditentukan oleh spesifikasi OpenAPI 3.0. Nama fungsi dan parameter disertakan dalam deklarasi ini. `FunctionDeclaration` ini adalah representasi blok kode yang dapat digunakan sebagai Alat oleh model dan dieksekusi oleh klien.
FunctionDeclarationSchema	Skema untuk parameter yang diteruskan ke FunctionDeclaration.parameters.
FunctionDeclarationSchemaProperty	Skema digunakan untuk menentukan format data input/output. Mewakili subset yang dipilih dari objek skema OpenAPI 3.0. Kolom lainnya dapat ditambahkan di masa mendatang sesuai kebutuhan.
FunctionDeclarationsTool	`FunctionDeclarationsTool` adalah potongan kode yang memungkinkan sistem berinteraksi dengan sistem eksternal untuk melakukan suatu tindakan, atau serangkaian tindakan, di luar pengetahuan dan cakupan model.
FunctionResponse	Output hasil dari FunctionCall yang berisi string yang mewakili FunctionDeclaration.name dan objek JSON terstruktur yang berisi output dari fungsi tersebut akan digunakan sebagai konteks untuk model. Fungsi ini harus berisi hasil FunctionCall yang dibuat berdasarkan prediksi model.
FunctionResponsePart	Antarmuka bagian konten jika bagian tersebut mewakili FunctionResponse.
GenerateContentCandidate	Kandidat yang ditampilkan sebagai bagian dari GenerateContentResponse.
GenerateContentRequest	Permintaan dikirim melalui GenerativeModel.generateContent()
GenerateContentResponse	Masing-masing respons dari GenerativeModel.generateContent() dan GenerativeModel.generateContentStream(). `generateContentStream()` akan menampilkan satu di setiap potongan hingga streaming selesai.
GenerateContentResult	Objek hasil yang ditampilkan dari panggilan GenerativeModel.generateContent().
GenerateContentStreamResult	Objek hasil yang ditampilkan dari panggilan GenerativeModel.generateContentStream(). Lakukan iterasi melalui `stream` untuk mendapatkan potongan saat potongan tersebut masuk dan/atau gunakan promise `response` untuk mendapatkan respons gabungan saat streaming selesai.
GenerationConfig	Opsi konfigurasi untuk permintaan terkait konten
GenerativeContentBlob	Antarmuka untuk mengirim gambar.
Atribusi Dasar
GroundingMetadata	Metadata ditampilkan ke klien saat grounding diaktifkan.
InlineDataPart	Antarmuka bagian konten jika bagian tersebut mewakili gambar.
ModelParams	Parameter yang diteruskan ke getGenerativeModel().
PromptFeedback	Jika perintah diblokir, perintah ini akan diisi dengan `blockReason` dan `safetyRatings` yang relevan.
RequestOptions	Parameter yang diteruskan ke getGenerativeModel().
RetrievedContextAttribution
SecurityRating	Rating keamanan yang terkait dengan GenerateContentCandidate
Setelan Keamanan	Setelan keamanan yang dapat dikirim sebagai bagian dari parameter permintaan.
Segment
StartChatParams	Parameter untuk GenerativeModel.startChat().
TextPart	Antarmuka bagian konten jika bagian tersebut mewakili string teks.
ToolConfig	Konfigurasi alat. Konfigurasi ini dibagikan untuk semua alat yang disediakan dalam permintaan.
UsageMetadata	Metadata penggunaan tentang GenerateContentResponse.
VertexAI	Instance Vertex AI for Firebase SDK.
VertexAIOptions	Opsi saat menginisialisasi Vertex AI for Firebase SDK.
MetadataVideo	Menjelaskan konten video input.
WebAttribution

Variabel

Variabel	Deskripsi
PERAN_POSSIBLE	Peran yang memungkinkan.

Ketik Alias

Ketik Alias	Deskripsi
Bagian	Bagian konten - mencakup jenis bagian teks, gambar/video, atau panggilan fungsi/respons.
Role	Peran adalah produser konten.
Alat	Mendefinisikan alat yang dapat dipanggil model untuk mengakses pengetahuan eksternal.

function(aplikasi, ...)

getVertexAI(aplikasi, opsi)

Menampilkan instance VertexAI untuk aplikasi tertentu.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	AplikasiFirebase	FirebaseApp yang akan digunakan.
opsi	VertexAIOptions

Hasil:

VertexAI

fungsi(vertexAI, ...)

getGenerativeModel(vertexAI, modelParams, requestOptions)

Menampilkan class GenerativeModel dengan metode untuk inferensi dan fungsi lainnya.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
VertexAI	VertexAI
modelParams	ModelParams
opsipermintaan	RequestOptions

Hasil:

GenerativeModel

PERAN_POSSIBEL

Peran yang memungkinkan.

Tanda Tangan:

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

Bagian

Bagian konten - mencakup jenis bagian teks, gambar/video, atau panggilan fungsi/respons.

Tanda Tangan:

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

Peran

Peran adalah produser konten.

Tanda Tangan:

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

Alat

Mendefinisikan alat yang dapat dipanggil model untuk mengakses pengetahuan eksternal.

Tanda Tangan:

export declare type Tool = FunctionDeclarationsTool;

Alasan Pemblokiran

Alasan perintah diblokir.

Tanda Tangan:

export declare enum BlockReason

Anggota Enumerasi

Anggota	Nilai	Deskripsi
DIBLOKIR_REASON_UNSPECIFIED	`"BLOCKED_REASON_UNSPECIFIED"`
LAINNYA	`"OTHER"`
KESELAMATAN	`"SAFETY"`

Alasan Selesai

Alasan kandidat sudah selesai.

Tanda Tangan:

export declare enum FinishReason

Anggota Enumerasi

Anggota	Nilai	Deskripsi
FINISH_REASON_UNSPECIFIED	`"FINISH_REASON_UNSPECIFIED"`
MAX_TOKEN	`"MAX_TOKENS"`
LAINNYA	`"OTHER"`
REKITASI	`"RECITATION"`
KESELAMATAN	`"SAFETY"`
STOP	`"STOP"`

FunctionCallingMode

Tanda Tangan:

export declare enum FunctionCallingMode

Anggota Enumerasi

Anggota	Nilai	Deskripsi
APA SAJA	`"ANY"`
AUTO	`"AUTO"`
MODE_UNSPECIFIED	`"MODE_UNSPECIFIED"`
NONE	`"NONE"`

FunctionDeclarationSchemaType

Berisi daftar jenis data OpenAPI seperti yang ditentukan oleh https://swagger.io/docs/specification/data-models/data-types/

Tanda Tangan:

export declare enum FunctionDeclarationSchemaType

Anggota Enumerasi

Anggota	Nilai	Deskripsi
ARRAY	`"ARRAY"`	Jenis array.
BOOLEAN	`"BOOLEAN"`	Jenis Boolean.
INTEGER	`"INTEGER"`	Jenis bilangan bulat.
NUMBER	`"NUMBER"`	Jenis angka.
OBJECT	`"OBJECT"`	Jenis objek.
STRING	`"STRING"`	Jenis string.

MetodeBlokHarm

Tanda Tangan:

export declare enum HarmBlockMethod

Anggota Enumerasi

Anggota	Nilai	Deskripsi
HARM_BLOCK_METHOD_UNSPECIFIED	`"HARM_BLOCK_METHOD_UNSPECIFIED"`
PROBABILITAS	`"PROBABILITY"`
KEKERASAN	`"SEVERITY"`

HarmBlockThreshold

Nilai minimum yang melebihi nilai tersebut, sehingga perintah atau kandidat akan diblokir.

Tanda Tangan:

export declare enum HarmBlockThreshold

Anggota Enumerasi

Anggota	Nilai	Deskripsi
BLOKIR_LOW_AND_ABOVE	`"BLOCK_LOW_AND_ABOVE"`
BLOKIR_MEDIUM_AND_ABOVE	`"BLOCK_MEDIUM_AND_ABOVE"`
TIDAK ADA DIBLOKIR	`"BLOCK_NONE"`
KHUSUS_BLOKIR_TINGGI	`"BLOCK_ONLY_HIGH"`
HARM_BLOKIR_BATAS_UNSPECIFIED	`"HARM_BLOCK_THRESHOLD_UNSPECIFIED"`

HarmCategory

Kategori berbahaya yang dapat menyebabkan perintah atau kandidat diblokir.

Tanda Tangan:

export declare enum HarmCategory

Anggota Enumerasi

Anggota	Nilai	Deskripsi
KONTEN_BERBAHAN_KATEGORI	`"HARM_CATEGORY_DANGEROUS_CONTENT"`
HARM_CATEGORY_HARASSMENT	`"HARM_CATEGORY_HARASSMENT"`
HARM_CATEGORY_HATE_SPEECH	`"HARM_CATEGORY_HATE_SPEECH"`
{i>HARM_CATEGORY_SEXUALLY_EXPLICIT<i}	`"HARM_CATEGORY_SEXUALLY_EXPLICIT"`
HARM_CATEGORY_UNSPECIFIED	`"HARM_CATEGORY_UNSPECIFIED"`

Probabilitas Bahaya

Probabilitas bahwa perintah atau kandidat cocok dengan kategori bahaya.

Tanda Tangan:

export declare enum HarmProbability

Anggota Enumerasi

Anggota	Nilai	Deskripsi
KERAS_PROBABILITAS_UNSPECIFIED	`"HARM_PROBABILITY_UNSPECIFIED"`
TINGGI	`"HIGH"`
RENDAH	`"LOW"`
SEDANG	`"MEDIUM"`
TIDAK BOLEH	`"NEGLIGIBLE"`

Tingkat Keparahan

Tingkat keparahan bahaya.

Tanda Tangan:

export declare enum HarmSeverity

Anggota Enumerasi

Anggota	Nilai	Deskripsi
HARM_SEVERITY_TINGGI	`"HARM_SEVERITY_HIGH"`
HARM_SEVERITY_LOW	`"HARM_SEVERITY_LOW"`
HARM_SEVERITY_MEDIUM	`"HARM_SEVERITY_MEDIUM"`
KERAS_SEVERITY_NEGLIGIBLE	`"HARM_SEVERITY_NEGLIGIBLE"`
HARM_SEVERITY_UNSPECIFIED	`"HARM_SEVERITY_UNSPECIFIED"`

VertexAIErrorCode

Kode error standar yang dapat dimiliki VertexAIError.

Tanda Tangan:

export declare const enum VertexAIErrorCode

Anggota Enumerasi

Anggota	Nilai	Deskripsi
ERROR	`"error"`	Terjadi error umum.
KESALAHAN_FETCH	`"fetch-error"`	Terjadi error ketika melakukan pengambilan.
KONTEN_TIDAK VALID	`"invalid-content"`	Error yang terkait dengan objek Content.
KUNCI_API_TIDAK_ADA	`"no-api-key"`	Terjadi error karena kunci Firebase API tidak ada.
TIDAK ADA MODEL	`"no-model"`	Terjadi error karena nama model tidak ditentukan selama inisialisasi.
TIDAK ADA_PROJECT_ID	`"no-project-id"`	Terjadi error karena project ID tidak ada.
PARSE_FAILED (GAGAL_GAGAL)	`"parse-failed"`	Terjadi error saat mengurai.
KESALAHAN_PERMINTAAN	`"request-error"`	Terjadi error dalam permintaan.
RESPONS_ERROR	`"response-error"`	Terjadi error dalam respons.