Gemini API mendukung pembuatan konten dengan gambar, audio, kode, alat, dan lainnya. Untuk mengetahui detail setiap fitur ini, baca terus dan lihat contoh kode yang berfokus pada tugas, atau baca panduan komprehensif.
- Pembuatan teks
- Visual
- Audio
- Embedding
- Konteks panjang
- Eksekusi kode
- Mode JSON
- Pemanggilan fungsi
- Petunjuk sistem
Metode: models.generateContent
Menghasilkan respons model berdasarkan input GenerateContentRequest
. Lihat panduan pembuatan teks untuk mengetahui informasi penggunaan yang mendetail. Kemampuan input berbeda-beda di setiap model, termasuk model yang di-tune. Lihat panduan model dan panduan penyesuaian untuk mengetahui detailnya.
Endpoint
postinganhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
Parameter jalur
model
string
Wajib. Nama Model
yang akan digunakan untuk membuat penyelesaian.
Format: models/{model}
. Formatnya adalah models/{model}
.
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
tools[]
object (Tool
)
Opsional. Daftar Tools
yang dapat digunakan Model
untuk membuat respons berikutnya.
Tool
adalah bagian kode yang memungkinkan sistem berinteraksi dengan sistem eksternal untuk melakukan tindakan, atau serangkaian tindakan, di luar pengetahuan dan cakupan Model
. Tool
yang didukung adalah Function
dan codeExecution
. Lihat panduan Panggilan fungsi dan Eksekusi kode untuk mempelajari lebih lanjut.
toolConfig
object (ToolConfig
)
Opsional. Konfigurasi alat untuk Tool
yang ditentukan dalam permintaan. Lihat Panduan pemanggilan fungsi untuk contoh penggunaan.
safetySettings[]
object (SafetySetting
)
Opsional. Daftar instance SafetySetting
unik untuk memblokir konten tidak aman.
Kebijakan ini akan diterapkan pada GenerateContentRequest.contents
dan GenerateContentResponse.candidates
. Tidak boleh ada lebih dari satu setelan untuk setiap jenis SafetyCategory
. API akan memblokir konten dan respons apa pun yang tidak memenuhi nilai minimum yang ditetapkan oleh setelan ini. Daftar ini menggantikan setelan default untuk setiap SafetyCategory
yang ditentukan dalam safetySettings. Jika tidak ada SafetySetting
untuk SafetyCategory
tertentu yang diberikan dalam daftar, API akan menggunakan setelan keamanan default untuk kategori tersebut. Kategori bahaya HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY didukung. Lihat panduan untuk mengetahui informasi mendetail tentang setelan keamanan yang tersedia. Lihat juga Panduan keselamatan untuk mempelajari cara memasukkan pertimbangan keselamatan dalam aplikasi AI Anda.
systemInstruction
object (Content
)
Opsional. Developer menetapkan petunjuk sistem. Saat ini, hanya teks.
generationConfig
object (GenerationConfig
)
Opsional. Opsi konfigurasi untuk pembuatan dan output model.
cachedContent
string
Opsional. Nama konten yang di-cache untuk digunakan sebagai konteks dalam menyajikan prediksi. Format: cachedContents/{cachedContent}
Contoh permintaan
Teks
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
Gambar
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
Audio
Python
Node.js
Go
Shell
Video
Python
Node.js
Go
Shell
Python
Go
Shell
Chat
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
Cache
Python
Node.js
Go
Model yang Disesuaikan
Python
Mode JSON
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
Eksekusi kode
Python
Go
Kotlin
Java
Panggilan Fungsi
Python
Go
Node.js
Shell
Kotlin
Swift
Dart
Java
Konfigurasi pembuatan
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
Setelan Keamanan
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
Petunjuk Sistem
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
Isi respons
Jika berhasil, isi respons memuat instance GenerateContentResponse
.
Metode: models.streamGenerateContent
Menghasilkan respons streaming dari model yang diberi input GenerateContentRequest
.
Endpoint
postinganhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContent
Parameter jalur
model
string
Wajib. Nama Model
yang akan digunakan untuk membuat penyelesaian.
Format: models/{model}
. Formatnya adalah models/{model}
.
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
tools[]
object (Tool
)
Opsional. Daftar Tools
yang dapat digunakan Model
untuk membuat respons berikutnya.
Tool
adalah bagian kode yang memungkinkan sistem berinteraksi dengan sistem eksternal untuk melakukan tindakan, atau serangkaian tindakan, di luar pengetahuan dan cakupan Model
. Tool
yang didukung adalah Function
dan codeExecution
. Lihat panduan Panggilan fungsi dan Eksekusi kode untuk mempelajari lebih lanjut.
toolConfig
object (ToolConfig
)
Opsional. Konfigurasi alat untuk Tool
yang ditentukan dalam permintaan. Lihat Panduan pemanggilan fungsi untuk contoh penggunaan.
safetySettings[]
object (SafetySetting
)
Opsional. Daftar instance SafetySetting
unik untuk memblokir konten tidak aman.
Kebijakan ini akan diterapkan pada GenerateContentRequest.contents
dan GenerateContentResponse.candidates
. Tidak boleh ada lebih dari satu setelan untuk setiap jenis SafetyCategory
. API akan memblokir konten dan respons apa pun yang tidak memenuhi nilai minimum yang ditetapkan oleh setelan ini. Daftar ini menggantikan setelan default untuk setiap SafetyCategory
yang ditentukan dalam safetySettings. Jika tidak ada SafetySetting
untuk SafetyCategory
tertentu yang diberikan dalam daftar, API akan menggunakan setelan keamanan default untuk kategori tersebut. Kategori bahaya HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY didukung. Lihat panduan untuk mengetahui informasi mendetail tentang setelan keamanan yang tersedia. Lihat juga Panduan keselamatan untuk mempelajari cara memasukkan pertimbangan keselamatan dalam aplikasi AI Anda.
systemInstruction
object (Content
)
Opsional. Developer menetapkan petunjuk sistem. Saat ini, hanya teks.
generationConfig
object (GenerationConfig
)
Opsional. Opsi konfigurasi untuk pembuatan dan output model.
cachedContent
string
Opsional. Nama konten yang di-cache untuk digunakan sebagai konteks dalam menyajikan prediksi. Format: cachedContents/{cachedContent}
Contoh permintaan
Teks
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
Gambar
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
Audio
Python
Go
Shell
Video
Python
Node.js
Go
Shell
Python
Go
Shell
Chat
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
Isi respons
Jika berhasil, isi respons akan berisi aliran instance GenerateContentResponse
.
GenerateContentResponse
Respons dari model yang mendukung beberapa respons kandidat.
Rating keamanan dan pemfilteran konten dilaporkan untuk kedua perintah di GenerateContentResponse.prompt_feedback
dan untuk setiap kandidat di finishReason
dan di safetyRatings
. API: - Menampilkan semua kandidat yang diminta atau tidak sama sekali - Tidak menampilkan kandidat sama sekali hanya jika ada yang salah dengan perintah (periksa promptFeedback
) - Melaporkan masukan tentang setiap kandidat di finishReason
dan safetyRatings
.
candidates[]
object (Candidate
)
Respons kandidat dari model.
promptFeedback
object (PromptFeedback
)
Menampilkan masukan perintah terkait filter konten.
usageMetadata
object (UsageMetadata
)
Hanya output. Metadata tentang penggunaan token permintaan pembuatan.
modelVersion
string
Hanya output. Versi model yang digunakan untuk menghasilkan respons.
responseId
string
Hanya output. responseId digunakan untuk mengidentifikasi setiap respons.
Representasi JSON |
---|
{ "candidates": [ { object ( |
PromptFeedback
Kumpulan metadata masukan yang ditentukan perintah dalam GenerateContentRequest.content
.
blockReason
enum (BlockReason
)
Opsional. Jika disetel, perintah diblokir dan tidak ada kandidat yang ditampilkan. Susun ulang kata-kata pada perintah.
safetyRatings[]
object (SafetyRating
)
Rating untuk keamanan perintah. Maksimal ada satu rating per kategori.
Representasi JSON |
---|
{ "blockReason": enum ( |
BlockReason
Menentukan alasan mengapa perintah diblokir.
Enum | |
---|---|
BLOCK_REASON_UNSPECIFIED |
Nilai default. Nilai ini tidak digunakan. |
SAFETY |
Perintah diblokir karena alasan keamanan. Periksa safetyRatings untuk memahami kategori keamanan mana yang memblokirnya. |
OTHER |
Perintah diblokir karena alasan yang tidak diketahui. |
BLOCKLIST |
Perintah diblokir karena istilah yang disertakan berasal dari daftar blokir terminologi. |
PROHIBITED_CONTENT |
Perintah diblokir karena konten yang dilarang. |
IMAGE_SAFETY |
Kandidat diblokir karena konten pembuatan gambar yang tidak aman. |
UsageMetadata
Metadata tentang penggunaan token permintaan pembuatan.
promptTokenCount
integer
Jumlah token dalam perintah. Jika cachedContent
ditetapkan, ini tetap merupakan ukuran perintah efektif total yang berarti mencakup jumlah token dalam konten yang di-cache.
cachedContentTokenCount
integer
Jumlah token di bagian perintah yang di-cache (konten yang di-cache)
candidatesTokenCount
integer
Jumlah total token di semua kandidat respons yang dihasilkan.
toolUsePromptTokenCount
integer
Hanya output. Jumlah token yang ada dalam perintah penggunaan alat.
thoughtsTokenCount
integer
Hanya output. Jumlah token pemikiran untuk model pemikiran.
totalTokenCount
integer
Jumlah total token untuk permintaan pembuatan (perintah + kandidat respons).
promptTokensDetails[]
object (ModalityTokenCount
)
Hanya output. Daftar modalitas yang diproses dalam input permintaan.
cacheTokensDetails[]
object (ModalityTokenCount
)
Hanya output. Daftar modalitas konten yang di-cache dalam input permintaan.
candidatesTokensDetails[]
object (ModalityTokenCount
)
Hanya output. Daftar modalitas yang ditampilkan dalam respons.
toolUsePromptTokensDetails[]
object (ModalityTokenCount
)
Hanya output. Daftar modalitas yang diproses untuk input permintaan penggunaan alat.
Representasi JSON |
---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
Kandidat
- Representasi JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- Web
- GroundingSupport
- Segmen
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- Kandidat
- UrlContextMetadata
- UrlMetadata
- UrlRetrievalStatus
Kandidat respons yang dihasilkan dari model.
content
object (Content
)
Hanya output. Konten yang dihasilkan yang ditampilkan dari model.
finishReason
enum (FinishReason
)
Opsional. Hanya output. Alasan model berhenti menghasilkan token.
Jika kosong, model belum berhenti menghasilkan token.
safetyRatings[]
object (SafetyRating
)
Daftar rating untuk keamanan kandidat respons.
Maksimal ada satu rating per kategori.
citationMetadata
object (CitationMetadata
)
Hanya output. Informasi kutipan untuk kandidat yang dihasilkan model.
Kolom ini dapat diisi dengan informasi bacaan untuk teks apa pun yang disertakan dalam content
. Ini adalah bagian yang "dibacakan" dari materi berhak cipta dalam data pelatihan LLM dasar.
tokenCount
integer
Hanya output. Jumlah token untuk kandidat ini.
groundingAttributions[]
object (GroundingAttribution
)
Hanya output. Informasi atribusi untuk sumber yang berkontribusi pada jawaban yang mendasar.
Kolom ini diisi untuk panggilan GenerateAnswer
.
groundingMetadata
object (GroundingMetadata
)
Hanya output. Metadata perujukan untuk kandidat.
Kolom ini diisi untuk panggilan GenerateContent
.
avgLogprobs
number
Hanya output. Skor probabilitas log rata-rata kandidat.
logprobsResult
object (LogprobsResult
)
Hanya output. Skor log-likelihood untuk token respons dan token teratas
urlContextMetadata
object (UrlContextMetadata
)
Hanya output. Metadata yang terkait dengan alat pengambilan konteks URL.
index
integer
Hanya output. Indeks kandidat dalam daftar kandidat respons.
Representasi JSON |
---|
{ "content": { object ( |
FinishReason
Menentukan alasan model berhenti membuat token.
Enum | |
---|---|
FINISH_REASON_UNSPECIFIED |
Nilai default. Nilai ini tidak digunakan. |
STOP |
Titik penghentian alami model atau urutan penghentian yang diberikan. |
MAX_TOKENS |
Jumlah maksimum token seperti yang ditentukan dalam permintaan telah tercapai. |
SAFETY |
Konten kandidat respons ditandai karena alasan keamanan. |
RECITATION |
Konten kandidat respons ditandai karena alasan pembacaan. |
LANGUAGE |
Konten kandidat respons ditandai karena menggunakan bahasa yang tidak didukung. |
OTHER |
Alasan tidak diketahui. |
BLOCKLIST |
Pembuatan token berhenti karena konten berisi istilah yang dilarang. |
PROHIBITED_CONTENT |
Pembuatan token dihentikan karena berpotensi berisi konten terlarang. |
SPII |
Pembuatan token dihentikan karena konten berpotensi berisi Informasi Identitas Pribadi Sensitif (SPII). |
MALFORMED_FUNCTION_CALL |
Panggilan fungsi yang dihasilkan oleh model tidak valid. |
IMAGE_SAFETY |
Pembuatan token dihentikan karena gambar yang dihasilkan berisi pelanggaran keamanan. |
UNEXPECTED_TOOL_CALL |
Model membuat panggilan alat, tetapi tidak ada alat yang diaktifkan dalam permintaan. |
GroundingAttribution
Atribusi untuk sumber yang berkontribusi pada jawaban.
sourceId
object (AttributionSourceId
)
Hanya output. ID untuk sumber yang berkontribusi pada atribusi ini.
content
object (Content
)
Merujuk pada konten sumber yang membentuk atribusi ini.
Representasi JSON |
---|
{ "sourceId": { object ( |
AttributionSourceId
ID untuk sumber yang berkontribusi pada atribusi ini.
source
Union type
source
hanya dapat berupa salah satu dari hal berikut:groundingPassage
object (GroundingPassageId
)
ID untuk bagian inline.
semanticRetrieverChunk
object (SemanticRetrieverChunk
)
ID untuk Chunk
yang diambil melalui Semantic Retriever.
Representasi JSON |
---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
ID untuk bagian dalam GroundingPassage
.
passageId
string
Hanya output. ID bagian yang cocok dengan GroundingPassage.id
GenerateAnswerRequest
.
partIndex
integer
Hanya output. Indeks bagian dalam GroundingPassage.content
GenerateAnswerRequest
.
Representasi JSON |
---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
ID untuk Chunk
yang diambil melalui Pengambilan Semantik yang ditentukan dalam GenerateAnswerRequest
menggunakan SemanticRetrieverConfig
.
source
string
Hanya output. Nama sumber yang cocok dengan SemanticRetrieverConfig.source
permintaan. Contoh: corpora/123
atau corpora/123/documents/abc
chunk
string
Hanya output. Nama Chunk
yang berisi teks yang diatribusikan. Contoh: corpora/123/documents/abc/chunks/xyz
Representasi JSON |
---|
{ "source": string, "chunk": string } |
GroundingMetadata
Metadata yang ditampilkan ke klien saat perujukan diaktifkan.
groundingChunks[]
object (GroundingChunk
)
Daftar referensi pendukung yang diambil dari sumber perujukan yang ditentukan.
groundingSupports[]
object (GroundingSupport
)
Daftar dukungan perujukan.
webSearchQueries[]
string
Kueri penelusuran web untuk penelusuran web lanjutan.
searchEntryPoint
object (SearchEntryPoint
)
Opsional. Entri penelusuran Google untuk penelusuran web lanjutan.
retrievalMetadata
object (RetrievalMetadata
)
Metadata yang terkait dengan pengambilan dalam alur perujukan.
Representasi JSON |
---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
Titik entri penelusuran Google.
renderedContent
string
Opsional. Cuplikan konten web yang dapat disematkan di halaman web atau webview aplikasi.
sdkBlob
string (bytes format)
Opsional. JSON berenkode Base64 yang merepresentasikan tuple array <istilah penelusuran, URL penelusuran>.
String berenkode base64.
Representasi JSON |
---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
Potongan perujukan.
chunk_type
Union type
chunk_type
hanya dapat berupa salah satu dari hal berikut:web
object (Web
)
Bagian perujukan dari web.
Representasi JSON |
---|
{
// chunk_type
"web": {
object ( |
Web
Potongan dari web.
uri
string
Referensi URI potongan.
title
string
Judul potongan.
Representasi JSON |
---|
{ "uri": string, "title": string } |
GroundingSupport
Dukungan perujukan.
groundingChunkIndices[]
integer
Daftar indeks (ke dalam 'grounding_chunk') yang menentukan kutipan yang terkait dengan klaim. Misalnya, [1,3,4] berarti grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] adalah konten yang diambil dan diatribusikan ke klaim.
confidenceScores[]
number
Skor keyakinan referensi dukungan. Rentang dari 0 hingga 1. 1 adalah yang paling yakin. Daftar ini harus memiliki ukuran yang sama dengan groundingChunkIndices.
segment
object (Segment
)
Segmen konten yang terkait dengan dukungan ini.
Representasi JSON |
---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"segment": {
object ( |
Segmen
Segmen konten.
partIndex
integer
Hanya output. Indeks objek Part dalam objek Content induknya.
startIndex
integer
Hanya output. Indeks awal dalam Bagian yang diberikan, diukur dalam byte. Offset dari awal Bagian, inklusif, dimulai dari nol.
endIndex
integer
Hanya output. Indeks akhir dalam Bagian yang diberikan, diukur dalam byte. Offset dari awal Bagian, eksklusif, dimulai dari nol.
text
string
Hanya output. Teks yang sesuai dengan segmen dari respons.
Representasi JSON |
---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
RetrievalMetadata
Metadata yang terkait dengan pengambilan dalam alur perujukan.
googleSearchDynamicRetrievalScore
number
Opsional. Skor yang menunjukkan kemungkinan informasi dari Google Penelusuran dapat membantu menjawab perintah. Skor berada dalam rentang [0, 1], dengan 0 adalah yang paling tidak mungkin dan 1 adalah yang paling mungkin. Skor ini hanya diisi jika perujukan penelusuran Google dan pengambilan dinamis diaktifkan. Nilai ini akan dibandingkan dengan nilai minimum untuk menentukan apakah penelusuran Google harus dipicu atau tidak.
Representasi JSON |
---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
Hasil Logprob
topCandidates[]
object (TopCandidates
)
Panjang = jumlah total langkah decoding.
chosenCandidates[]
object (Candidate
)
Panjang = jumlah total langkah decoding. Kandidat yang dipilih mungkin ada atau tidak ada di topCandidates.
Representasi JSON |
---|
{ "topCandidates": [ { object ( |
TopCandidates
Kandidat dengan probabilitas log teratas di setiap langkah decoding.
candidates[]
object (Candidate
)
Diurutkan berdasarkan probabilitas log dalam urutan menurun.
Representasi JSON |
---|
{
"candidates": [
{
object ( |
Kandidat
Kandidat untuk token dan skor logprobs.
token
string
Nilai string token kandidat.
tokenId
integer
Nilai ID token kandidat.
logProbability
number
Probabilitas log kandidat.
Representasi JSON |
---|
{ "token": string, "tokenId": integer, "logProbability": number } |
UrlContextMetadata
Metadata yang terkait dengan alat pengambilan konteks URL.
urlMetadata[]
object (UrlMetadata
)
Daftar konteks URL.
Representasi JSON |
---|
{
"urlMetadata": [
{
object ( |
UrlMetadata
Konteks pengambilan satu URL.
retrievedUrl
string
URL yang diambil oleh alat.
urlRetrievalStatus
enum (UrlRetrievalStatus
)
Status pengambilan URL.
Representasi JSON |
---|
{
"retrievedUrl": string,
"urlRetrievalStatus": enum ( |
UrlRetrievalStatus
Status pengambilan URL.
Enum | |
---|---|
URL_RETRIEVAL_STATUS_UNSPECIFIED |
Nilai default. Nilai ini tidak digunakan. |
URL_RETRIEVAL_STATUS_SUCCESS |
Pengambilan URL berhasil. |
URL_RETRIEVAL_STATUS_ERROR |
Pengambilan URL gagal karena error. |
CitationMetadata
Kumpulan atribusi sumber untuk suatu konten.
citationSources[]
object (CitationSource
)
Kutipan ke sumber untuk respons tertentu.
Representasi JSON |
---|
{
"citationSources": [
{
object ( |
CitationSource
Kutipan ke sumber untuk sebagian respons tertentu.
startIndex
integer
Opsional. Awal segmen respons yang diatribusikan ke sumber ini.
Indeks menunjukkan awal segmen, yang diukur dalam byte.
endIndex
integer
Opsional. Akhir segmen yang diatribusikan, eksklusif.
uri
string
Opsional. URI yang diatribusikan sebagai sumber untuk sebagian teks.
license
string
Opsional. Lisensi untuk project GitHub yang diatribusikan sebagai sumber segmen.
Info lisensi diperlukan untuk kutipan kode.
Representasi JSON |
---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
GenerationConfig
- Representasi JSON
- Modalitas
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- MediaResolution
Opsi konfigurasi untuk pembuatan dan output model. Tidak semua parameter dapat dikonfigurasi untuk setiap model.
stopSequences[]
string
Opsional. Kumpulan urutan karakter (hingga 5) yang akan menghentikan pembuatan output. Jika ditentukan, API akan berhenti pada kemunculan pertama stop_sequence
. Urutan berhenti tidak akan disertakan sebagai bagian dari respons.
responseMimeType
string
Opsional. Jenis MIME teks kandidat yang dihasilkan. Jenis MIME yang didukung adalah: text/plain
: (default) Output teks. application/json
: Respons JSON dalam kandidat respons. text/x.enum
: ENUM sebagai respons string dalam kandidat respons. Lihat dokumen untuk mengetahui daftar semua jenis MIME teks yang didukung.
responseSchema
object (Schema
)
Opsional. Skema output teks kandidat yang dihasilkan. Skema harus berupa subset dari skema OpenAPI dan dapat berupa objek, elemen dasar, atau array.
Jika disetel, responseMimeType
yang kompatibel juga harus disetel. Jenis MIME yang kompatibel: application/json
: Skema untuk respons JSON. Lihat panduan pembuatan teks JSON untuk mengetahui detail selengkapnya.
responseJsonSchema
value (Value
format)
Opsional. Skema output respons yang dihasilkan. Ini adalah alternatif untuk responseSchema
yang menerima Skema JSON.
Jika ditetapkan, responseSchema
harus dihapus, tetapi responseMimeType
diperlukan.
Meskipun Skema JSON lengkap dapat dikirim, tidak semua fitur didukung. Secara khusus, hanya properti berikut yang didukung:
$id
$defs
$ref
$anchor
type
format
title
description
enum
(untuk string dan angka)items
prefixItems
minItems
maxItems
minimum
maximum
anyOf
oneOf
(ditafsirkan sama sepertianyOf
)properties
additionalProperties
required
Properti propertyOrdering
non-standar juga dapat disetel.
Referensi siklik diuraikan hingga tingkat tertentu dan, oleh karena itu, hanya dapat digunakan dalam properti yang tidak wajib. (Properti yang dapat bernilai null tidak cukup.) Jika $ref
disetel pada sub-skema, tidak ada properti lain, kecuali yang dimulai sebagai $
, yang dapat disetel.
responseModalities[]
enum (Modality
)
Opsional. Modalitas respons yang diminta. Mewakili kumpulan modalitas yang dapat ditampilkan model, dan harus diharapkan dalam respons. Ini adalah kecocokan persis dengan modalitas respons.
Model dapat memiliki beberapa kombinasi modalitas yang didukung. Jika modalitas yang diminta tidak cocok dengan kombinasi yang didukung, error akan ditampilkan.
Daftar kosong setara dengan hanya meminta teks.
candidateCount
integer
Opsional. Jumlah respons yang dihasilkan untuk ditampilkan. Jika tidak disetel, nilai defaultnya adalah 1. Perhatikan bahwa fitur ini tidak berfungsi untuk model generasi sebelumnya (keluarga Gemini 1.0)
maxOutputTokens
integer
Opsional. Jumlah maksimum token yang akan disertakan dalam kandidat respons.
Catatan: Nilai default bervariasi menurut model. Lihat atribut Model.output_token_limit
dari Model
yang ditampilkan dari fungsi getModel
.
temperature
number
Opsional. Mengontrol keacakan output.
Catatan: Nilai default bervariasi menurut model. Lihat atribut Model.temperature
dari Model
yang ditampilkan dari fungsi getModel
.
Nilai dapat berkisar dari [0.0, 2.0].
topP
number
Opsional. Probabilitas kumulatif maksimum token yang akan dipertimbangkan saat melakukan pengambilan sampel.
Model ini menggunakan gabungan pengambilan sampel Top-k dan Top-p (inti).
Token diurutkan berdasarkan probabilitas yang ditetapkan sehingga hanya token yang paling mungkin yang dipertimbangkan. Sampling top-k secara langsung membatasi jumlah maksimum token yang akan dipertimbangkan, sementara sampling Nucleus membatasi jumlah token berdasarkan probabilitas kumulatif.
Catatan: Nilai default bervariasi menurut Model
dan ditentukan oleh atribut Model.top_p
yang ditampilkan dari fungsi getModel
. Atribut topK
yang kosong menunjukkan bahwa model tidak menerapkan pengambilan sampel top-k dan tidak mengizinkan setelan topK
pada permintaan.
topK
integer
Opsional. Jumlah maksimum token yang akan dipertimbangkan saat pengambilan sampel.
Model Gemini menggunakan sampling Top-p (inti) atau kombinasi sampling Top-k dan inti. Pengambilan sampel top-k mempertimbangkan kumpulan topK
token yang paling mungkin. Model yang berjalan dengan pengambilan sampel inti tidak mengizinkan setelan topK.
Catatan: Nilai default bervariasi menurut Model
dan ditentukan oleh atribut Model.top_p
yang ditampilkan dari fungsi getModel
. Atribut topK
yang kosong menunjukkan bahwa model tidak menerapkan pengambilan sampel top-k dan tidak mengizinkan setelan topK
pada permintaan.
seed
integer
Opsional. Seed yang digunakan dalam decoding. Jika tidak disetel, permintaan akan menggunakan seed yang dibuat secara acak.
presencePenalty
number
Opsional. Penalti kehadiran diterapkan ke logprob token berikutnya jika token telah dilihat dalam respons.
Penalti ini bersifat biner aktif/nonaktif dan tidak bergantung pada berapa kali token digunakan (setelah yang pertama). Gunakan frequencyPenalty
untuk penalti yang meningkat setiap kali digunakan.
Penalti positif akan mencegah penggunaan token yang telah digunakan dalam respons, sehingga meningkatkan kosakata.
Penalti negatif akan mendorong penggunaan token yang telah digunakan dalam respons, sehingga mengurangi kosakata.
frequencyPenalty
number
Opsional. Penalti frekuensi yang diterapkan pada logprob token berikutnya, dikalikan dengan jumlah berapa kali setiap token telah terlihat dalam respons sejauh ini.
Penalti positif akan mencegah penggunaan token yang telah digunakan, secara proporsional dengan jumlah penggunaan token: Semakin sering token digunakan, semakin sulit model menggunakan token tersebut lagi, sehingga meningkatkan kosakata respons.
Perhatian: Penalti negatif akan mendorong model untuk menggunakan kembali token secara proporsional dengan jumlah penggunaan token. Nilai negatif kecil akan mengurangi kosakata respons. Nilai negatif yang lebih besar akan menyebabkan model mulai mengulangi token umum hingga mencapai batas maxOutputTokens
.
responseLogprobs
boolean
Opsional. Jika benar, ekspor hasil logprobs dalam respons.
logprobs
integer
Opsional. Hanya valid jika responseLogprobs=True
. Parameter ini menetapkan jumlah logprob teratas yang akan ditampilkan di setiap langkah decoding dalam Candidate.logprobs_result
.
enableEnhancedCivicAnswers
boolean
Opsional. Mengaktifkan jawaban publik yang lebih baik. Fitur ini mungkin hanya tersedia untuk model tertentu.
speechConfig
object (SpeechConfig
)
Opsional. Konfigurasi pembuatan ucapan.
thinkingConfig
object (ThinkingConfig
)
Opsional. Konfigurasi untuk fitur penalaran. Error akan ditampilkan jika kolom ini ditetapkan untuk model yang tidak mendukung pemikiran.
mediaResolution
enum (MediaResolution
)
Opsional. Jika ditentukan, resolusi media yang ditentukan akan digunakan.
Representasi JSON |
---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
Metode
Modalitas respons yang didukung.
Enum | |
---|---|
MODALITY_UNSPECIFIED |
Nilai default. |
TEXT |
Menunjukkan bahwa model harus menampilkan teks. |
IMAGE |
Menunjukkan bahwa model harus menampilkan gambar. |
AUDIO |
Menunjukkan bahwa model harus menampilkan audio. |
SpeechConfig
Konfigurasi pembuatan ucapan.
voiceConfig
object (VoiceConfig
)
Konfigurasi jika output satu suara.
multiSpeakerVoiceConfig
object (MultiSpeakerVoiceConfig
)
Opsional. Konfigurasi untuk penyiapan multi-speaker. Kolom ini tidak dapat muncul bersamaan dengan kolom voiceConfig.
languageCode
string
Opsional. Kode bahasa (dalam format BCP 47, misalnya "en-US") untuk sintesis ucapan.
Nilai yang valid adalah: de-DE, en-AU, en-GB, en-IN, en-US, es-US, fr-FR, hi-IN, pt-BR, ar-XA, es-ES, fr-CA, id-ID, it-IT, ja-JP, tr-TR, vi-VN, bn-IN, gu-IN, kn-IN, ml-IN, mr-IN, ta-IN, te-IN, nl-NL, ko-KR, cmn-CN, pl-PL, ru-RU, dan th-TH.
Representasi JSON |
---|
{ "voiceConfig": { object ( |
VoiceConfig
Konfigurasi untuk suara yang akan digunakan.
voice_config
Union type
voice_config
hanya dapat berupa salah satu dari hal berikut:prebuiltVoiceConfig
object (PrebuiltVoiceConfig
)
Konfigurasi untuk suara bawaan yang akan digunakan.
Representasi JSON |
---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
Konfigurasi untuk speaker bawaan yang akan digunakan.
voiceName
string
Nama suara preset yang akan digunakan.
Representasi JSON |
---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
Konfigurasi untuk penyiapan multi-speaker.
speakerVoiceConfigs[]
object (SpeakerVoiceConfig
)
Wajib. Semua suara speaker yang diaktifkan.
Representasi JSON |
---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
Konfigurasi untuk satu speaker dalam penyiapan multi-speaker.
speaker
string
Wajib. Nama speaker yang akan digunakan. Harus sama seperti dalam perintah.
voiceConfig
object (VoiceConfig
)
Wajib. Konfigurasi untuk suara yang akan digunakan.
Representasi JSON |
---|
{
"speaker": string,
"voiceConfig": {
object ( |
ThinkingConfig
Konfigurasi untuk fitur penalaran.
includeThoughts
boolean
Menunjukkan apakah akan menyertakan pemikiran dalam respons. Jika benar (true), pikiran hanya ditampilkan jika tersedia.
thinkingBudget
integer
Jumlah token pemikiran yang harus dihasilkan model.
Representasi JSON |
---|
{ "includeThoughts": boolean, "thinkingBudget": integer } |
MediaResolution
Resolusi media untuk media input.
Enum | |
---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
Resolusi media belum ditetapkan. |
MEDIA_RESOLUTION_LOW |
Resolusi media disetel ke rendah (64 token). |
MEDIA_RESOLUTION_MEDIUM |
Resolusi media ditetapkan ke sedang (256 token). |
MEDIA_RESOLUTION_HIGH |
Resolusi media ditetapkan ke tinggi (penyesuaian frame yang di-zoom dengan 256 token). |
HarmCategory
Kategori rating.
Kategori ini mencakup berbagai jenis bahaya yang mungkin ingin disesuaikan oleh developer.
Enum | |
---|---|
HARM_CATEGORY_UNSPECIFIED |
Kategori tidak ditentukan. |
HARM_CATEGORY_DEROGATORY |
PaLM - Komentar negatif atau berbahaya yang menargetkan identitas dan/atau atribut yang dilindungi. |
HARM_CATEGORY_TOXICITY |
PaLM - Konten yang kasar, tidak sopan, atau tidak senonoh. |
HARM_CATEGORY_VIOLENCE |
PaLM - Menjelaskan skenario yang menggambarkan kekerasan terhadap individu atau kelompok, atau deskripsi umum tentang adegan menyeramkan. |
HARM_CATEGORY_SEXUAL |
PaLM - Berisi referensi ke tindakan seksual atau konten cabul lainnya. |
HARM_CATEGORY_MEDICAL |
PaLM - Mempromosikan saran medis yang tidak diperiksa. |
HARM_CATEGORY_DANGEROUS |
PaLM - Konten berbahaya yang mempromosikan, memfasilitasi, atau mendorong tindakan berbahaya. |
HARM_CATEGORY_HARASSMENT |
Gemini - Konten pelecehan. |
HARM_CATEGORY_HATE_SPEECH |
Gemini - Ujaran kebencian dan konten. |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
Gemini - Konten seksual vulgar. |
HARM_CATEGORY_DANGEROUS_CONTENT |
Gemini - Konten berbahaya. |
HARM_CATEGORY_CIVIC_INTEGRITY |
Gemini - Konten yang dapat digunakan untuk merusak integritas masyarakat. |
ModalityTokenCount
Menampilkan info penghitungan token untuk satu modalitas.
modality
enum (Modality
)
Modalitas yang terkait dengan jumlah token ini.
tokenCount
integer
Jumlah token.
Representasi JSON |
---|
{
"modality": enum ( |
Metode
Modalitas Bagian Konten
Enum | |
---|---|
MODALITY_UNSPECIFIED |
Modalitas tidak ditentukan. |
TEXT |
Teks biasa. |
IMAGE |
Gambar. |
VIDEO |
Video. |
AUDIO |
Audio. |
DOCUMENT |
Dokumen, misalnya PDF. |
SafetyRating
Rating keamanan untuk suatu konten.
Peringkat keamanan berisi kategori bahaya dan tingkat probabilitas bahaya dalam kategori tersebut untuk sebuah konten. Konten diklasifikasikan untuk keamanan di sejumlah kategori bahaya dan probabilitas klasifikasi bahaya disertakan di sini.
category
enum (HarmCategory
)
Wajib. Kategori untuk rating ini.
probability
enum (HarmProbability
)
Wajib. Probabilitas bahaya untuk konten ini.
blocked
boolean
Apakah konten ini diblokir karena rating ini?
Representasi JSON |
---|
{ "category": enum ( |
HarmProbability
Probabilitas bahwa suatu konten berbahaya.
Sistem klasifikasi memberikan probabilitas konten tersebut tidak aman. Hal ini tidak menunjukkan tingkat keparahan bahaya untuk suatu konten.
Enum | |
---|---|
HARM_PROBABILITY_UNSPECIFIED |
Probabilitas tidak ditentukan. |
NEGLIGIBLE |
Konten memiliki peluang yang sangat kecil untuk menjadi tidak aman. |
LOW |
Konten memiliki peluang rendah untuk menjadi tidak aman. |
MEDIUM |
Konten memiliki peluang sedang untuk menjadi tidak aman. |
HIGH |
Konten berpeluang besar tidak aman. |
SafetySetting
Setelan keamanan, yang memengaruhi perilaku pemblokiran keamanan.
Melampaui setelan keamanan untuk suatu kategori akan mengubah probabilitas yang diizinkan agar konten diblokir.
category
enum (HarmCategory
)
Wajib. Kategori untuk setelan ini.
threshold
enum (HarmBlockThreshold
)
Wajib. Mengontrol nilai minimum probabilitas bahaya yang akan diblokir.
Representasi JSON |
---|
{ "category": enum ( |
HarmBlockThreshold
Blokir pada dan di atas probabilitas bahaya yang ditentukan.
Enum | |
---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
Nilai minimum tidak ditentukan. |
BLOCK_LOW_AND_ABOVE |
Konten dengan tingkat PELANGGARAN RINGAN akan diizinkan. |
BLOCK_MEDIUM_AND_ABOVE |
Konten dengan tingkat NEGLIGIBLE dan LOW akan diizinkan. |
BLOCK_ONLY_HIGH |
Konten dengan tingkat NEGLIGIBLE, LOW, dan MEDIUM akan diizinkan. |
BLOCK_NONE |
Semua konten akan diizinkan. |
OFF |
Nonaktifkan filter keamanan. |