Vertex AI untuk Firebase Web SDK.
Functions
| Fungsi | Deskripsi |
|---|---|
| function(app, ...) | |
| getVertexAI(aplikasi, opsi) | Menampilkan instance VertexAI untuk aplikasi tertentu. |
| function(vertexAI, ...) | |
| getGenerativeModel(vertexAI, modelParams, requestOptions) | Menampilkan class GenerativeModel dengan metode untuk inferensi dan fungsi lainnya. |
Kelas
| Class | Deskripsi |
|---|---|
| ChatSession | Class ChatSession yang memungkinkan pengiriman pesan chat dan menyimpan histori pesan yang dikirim dan diterima sejauh ini. |
| Model Generatif | Class untuk API model generatif. |
Enumeration
| Enumerasi | Deskripsi |
|---|---|
| BlockReason | Alasan dialog diblokir. |
| FinishAlasan | Alasan kandidat 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 melampaui batas perintah atau kandidat akan diblokir. |
| Kategori Kerugian | Membahayakan kategori yang akan menyebabkan perintah atau kandidat diblokir. |
| Probabilitas Harm | Probabilitas bahwa prompt atau kandidat cocok dengan kategori berbahaya. |
| Tingkat Keparahan | Tingkat keparahan bahaya. |
Antarmuka
| Antarmuka | Deskripsi |
|---|---|
| BaseParams | Parameter dasar untuk sejumlah metode. |
| Kutipan | Satu kutipan. |
| Metadata Kutipan | Metadata kutipan yang dapat ditemukan pada GenerateContentCandidate. |
| Content | Jenis konten untuk perintah dan kandidat respons. |
| CountTokensRequest | Parameter untuk memanggil GenerativeModel.countTokens() |
| CountTokensResponse | Respons dari pemanggilan GenerativeModel.countTokens(). |
| Tanggal_2 | Protobuf google.type.Date |
| EnhancedGenerateContentResponse | Objek respons yang digabungkan dengan metode bantuan. |
| DataFile | Data yang mengarah ke file yang diupload di Google Cloud Storage. |
| FileDataPart | Antarmuka bagian konten jika bagian tersebut merepresentasikan FileData |
| FunctionCall | Prediksi FunctionCall yang ditampilkan dari model berisi string yang mewakili FunctionDeclaration.name serta objek JSON terstruktur yang berisi parameter dan nilainya. |
| FunctionCallingConfig | |
| FunctionCallPart | Antarmuka bagian konten jika bagian tersebut merepresentasikan FunctionCall. |
| Pernyataan Fungsi | Representasi terstruktur dari deklarasi fungsi seperti yang ditentukan oleh spesifikasi OpenAPI 3.0. Nama fungsi dan parameter telah disertakan dalam deklarasi ini. FunctionDeclaration ini adalah representasi dari 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. Merepresentasikan subset pilihan dari objek skema OpenAPI 3.0. Kolom lain 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 digunakan sebagai konteks untuk model. Panggilan ini harus berisi hasil FunctionCall yang dibuat berdasarkan prediksi model. |
| FunctionResponsePart | Antarmuka bagian konten jika bagian tersebut merepresentasikan FunctionResponse. |
| GenerateContentCandidate | Kandidat ditampilkan sebagai bagian dari GenerateContentResponse. |
| GenerateContentRequest | Permintaan dikirim melalui GenerativeModel.generateContent() |
| GenerateContentResponse | Respons individu dari GenerativeModel.generateContent() dan GenerativeModel.generateContentStream(). generateContentStream() akan menampilkan satu respons 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 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 Grounding | |
| GroundingMetadata | Metadata yang ditampilkan ke klien saat ground diaktifkan. |
| InlineDataPart | Antarmuka bagian konten jika bagian tersebut merepresentasikan gambar. |
| ModelParams | Parameter diteruskan ke getGenerativeModel(). |
| Masukan Minta | Jika dialog diblokir, dialog ini akan diisi dengan blockReason dan safetyRatings yang relevan. |
| RequestOptions | Parameter diteruskan ke getGenerativeModel(). |
| RetrievedContextAttribution | |
| SafetyRating | 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 merepresentasikan 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. |
| Opsi VertexAI | Opsi saat melakukan inisialisasi Vertex AI for Firebase SDK. |
| VideoMetadata | Menjelaskan konten video input. |
| Atribusi Web |
Variabel
| Variabel | Deskripsi |
|---|---|
| PERAN_POSSIBLE | Kemungkinan peran. |
Jenis Alias
| Jenis Alias | Deskripsi |
|---|---|
| Bagian | Bagian konten - termasuk jenis teks, gambar/video, atau panggilan fungsi/respons. |
| Role | Peran adalah produser konten. |
| Alat | Menentukan alat yang dapat dipanggil oleh 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 | Aplikasi Firebase | FirebaseApp yang akan digunakan. |
| opsi | Opsi VertexAI |
Hasil:
function(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 |
|---|---|---|
| AI verteks | VertexAI | |
| modelParams | ModelParams | |
| requestOptions | RequestOptions |
Hasil:
PERAN_POSSIBLE
Kemungkinan peran.
Tanda Tangan:
POSSIBLE_ROLES: readonly ["user", "model", "function", "system"]
Bagian
Bagian konten - termasuk jenis 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
Menentukan alat yang dapat dipanggil oleh model untuk mengakses pengetahuan eksternal.
Tanda Tangan:
export declare type Tool = FunctionDeclarationsTool;
BlockAlasan
Alasan dialog diblokir.
Tanda Tangan:
export declare enum BlockReason
Anggota Enumerasi
| Anggota | Nilai | Deskripsi |
|---|---|---|
| BLOCKED_REASON_UNSPECIFIED | "BLOCKED_REASON_UNSPECIFIED" |
|
| LAINNYA | "OTHER" |
|
| KESELAMATAN | "SAFETY" |
Alasan Selesai
Alasan kandidat selesai.
Tanda Tangan:
export declare enum FinishReason
Anggota Enumerasi
| Anggota | Nilai | Deskripsi |
|---|---|---|
| FINISH_REASON_UNSPECIFIED | "FINISH_REASON_UNSPECIFIED" |
|
| {i>MAX_TOKEN<i} | "MAX_TOKENS" |
|
| LAINNYA | "OTHER" |
|
| RESEP | "RECITATION" |
|
| KESELAMATAN | "SAFETY" |
|
| STOP | "STOP" |
FungsiCallingMode
Tanda Tangan:
export declare enum FunctionCallingMode
Anggota Enumerasi
| Anggota | Nilai | Deskripsi |
|---|---|---|
| APA SAJA | "ANY" |
|
| AUTO | "AUTO" |
|
| MODE_TIDAK_DITENTUKAN | "MODE_UNSPECIFIED" |
|
| NONE | "NONE" |
{i>FunctionDeclarationSchemaType<i}
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" |
Tipe boolean |
| INTEGER | "INTEGER" |
Jenis bilangan bulat. |
| NUMBER | "NUMBER" |
Jenis angka. |
| OBJECT | "OBJECT" |
Jenis objek. |
| STRING | "STRING" |
Jenis string. |
HarmBlockMethod
Tanda Tangan:
export declare enum HarmBlockMethod
Anggota Enumerasi
| Anggota | Nilai | Deskripsi |
|---|---|---|
| HARM_BLOCK_METHOD_UNSPECIFIED | "HARM_BLOCK_METHOD_UNSPECIFIED" |
|
| probabilitas | "PROBABILITY" |
|
| Tingkat Keparahan | "SEVERITY" |
Ambang Batas Harm
Nilai minimum yang melampaui batas perintah atau kandidat akan diblokir.
Tanda Tangan:
export declare enum HarmBlockThreshold
Anggota Enumerasi
| Anggota | Nilai | Deskripsi |
|---|---|---|
| BLOK_LOW_AND_ABOVE | "BLOCK_LOW_AND_ABOVE" |
|
| BLOK_SEDANG_DAN_DI ATAS | "BLOCK_MEDIUM_AND_ABOVE" |
|
| BLOK_NONE | "BLOCK_NONE" |
|
| BLOK_HANYA_TINGGI | "BLOCK_ONLY_HIGH" |
|
| HARM_BLOK_BATAS_UNSPECIFIED | "HARM_BLOCK_THRESHOLD_UNSPECIFIED" |
HarmCategory
Membahayakan kategori yang akan menyebabkan perintah atau kandidat diblokir.
Tanda Tangan:
export declare enum HarmCategory
Anggota Enumerasi
| Anggota | Nilai | Deskripsi |
|---|---|---|
| HARM_CATEGORY_DANGEROUS_CONTENT | "HARM_CATEGORY_DANGEROUS_CONTENT" |
|
| HARM_CATEGORY_HARASSMENT | "HARM_CATEGORY_HARASSMENT" |
|
| {i>HARM_CATEGORY_HATE_SPEECH<i} | "HARM_CATEGORY_HATE_SPEECH" |
|
| HARM_CATEGORY_SEXUALLY_ExpLICIT | "HARM_CATEGORY_SEXUALLY_EXPLICIT" |
|
| HARM_CATEGORY_UNSPECIFIED | "HARM_CATEGORY_UNSPECIFIED" |
Probabilitas Harm
Probabilitas bahwa prompt atau kandidat cocok dengan kategori berbahaya.
Tanda Tangan:
export declare enum HarmProbability
Anggota Enumerasi
| Anggota | Nilai | Deskripsi |
|---|---|---|
| HARM_PROBABILITY_UNSPECIFIED | "HARM_PROBABILITY_UNSPECIFIED" |
|
| TINGGI | "HIGH" |
|
| RENDAH | "LOW" |
|
| SEDANG | "MEDIUM" |
|
| DAPAT DIDASARKAN | "NEGLIGIBLE" |
Tingkat Bahaya
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" |
|
| HARM_SEVERITY_NEGLIGIBLE | "HARM_SEVERITY_NEGLIGIBLE" |
|
| {i>HARM_SEVERITY_UNSPECIFIED<i} | "HARM_SEVERITY_UNSPECIFIED" |