Method: models.generateMessage

Menghasilkan respons dari model yang diberi MessagePrompt input.

Permintaan HTTP

POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateMessage

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
model

string

Wajib. Nama model yang akan digunakan.

Format name=models/{model}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "prompt": {
    object (MessagePrompt)
  },
  "temperature": number,
  "candidateCount": integer,
  "topP": number,
  "topK": integer
}
Kolom
prompt

object (MessagePrompt)

Wajib. Input tekstual terstruktur yang diberikan ke model sebagai prompt.

Setelah diberikan prompt, model ini akan menampilkan pesan yang diprediksinya sebagai pesan berikutnya dalam diskusi.
temperature

number

Opsional. Mengontrol keacakan output.

Nilai dapat berkisar lebih dari [0.0,1.0], inklusif. Nilai yang lebih dekat ke 1.0 akan menghasilkan respons yang lebih bervariasi, sedangkan nilai yang lebih dekat dengan 0.0 biasanya akan menghasilkan respons yang tidak terlalu mengejutkan dari model.
candidateCount

integer

Opsional. Jumlah pesan respons yang dihasilkan yang akan ditampilkan.

Nilai ini harus antara [1, 8], inklusif. Jika tidak disetel, setelan ini akan ditetapkan secara default ke 1.
topP

number

Opsional. Probabilitas kumulatif token maksimum yang perlu dipertimbangkan saat mengambil sampel.

Model ini menggunakan gabungan pengambilan sampel Top-k dan nukleus.

Pengambilan sampel nukleus mempertimbangkan kumpulan token terkecil yang jumlah probabilitasnya minimal topP.
topK

integer

Opsional. Jumlah token maksimum yang perlu dipertimbangkan saat pengambilan sampel.

Model ini menggunakan gabungan pengambilan sampel Top-k dan nukleus.

Pengambilan sampel top-k mempertimbangkan kumpulan token topK yang paling mungkin.

Isi respons

Respons dari model.

Data ini mencakup pesan kandidat dan histori percakapan dalam bentuk pesan yang diurutkan secara kronologis.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "candidates": [
    {
      object (Message)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ]
}
Kolom
candidates[]

object (Message)

Pesan respons kandidat dari model.
messages[]

object (Message)

Histori percakapan yang digunakan oleh model.
filters[]

object (ContentFilter)

Kumpulan metadata pemfilteran konten untuk teks perintah dan respons.

Nilai ini menunjukkan SafetyCategory mana yang memblokir kandidat dari respons ini, HarmProbability terendah yang memicu pemblokiran, dan setelan HarmThreshold untuk kategori tersebut.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.