Method: answerQuery

Menjawab kueri menggunakan pembuatan berbasis perujukan.

Permintaan HTTP

POST https://developerknowledge.googleapis.com/v1alpha:answerQuery

URL ini menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "query": string,
  "filter": string
}
Kolom
query

string

Wajib. Kueri yang akan dijawab.
filter

string

Opsional. Menerapkan filter ketat pada hasil penelusuran yang digunakan untuk merujuk jawaban. Ekspresi ini mendukung subset sintaksis yang dijelaskan di https://google.aip.dev/160.

Kolom yang didukung untuk pemfilteran:

  • content_length_bytes (INTEGER): Panjang kolom Document.content dalam byte.
  • data_source (STRING): Sumber dokumen, misalnya, docs.cloud.google.com. Lihat https://developers.google.com/knowledge/reference/corpus-reference untuk mengetahui daftar lengkap sumber data dalam korpus.
  • update_time (TIMESTAMP): Stempel waktu saat dokumen terakhir kali diperbarui secara signifikan. Pembaruan yang bermakna adalah pembaruan yang mengubah konten atau metadata markdown dokumen.
  • uri (STRING): URI dokumen, misalnya, https://docs.cloud.google.com/bigquery/docs/tables.

Kolom INTEGER mendukung operator =, <, <=, >, dan >=.

Kolom STRING mendukung operator = (sama dengan) dan != (tidak sama dengan) untuk pencocokan persis pada seluruh string. Pencocokan parsial, pencocokan awalan, dan pencocokan ekspresi reguler tidak didukung.

Kolom TIMESTAMP mendukung operator =, <, <=, >, dan >=. Stempel waktu harus dalam format RFC-3339, misalnya, "2025-01-01T00:00:00Z".

Anda dapat menggabungkan ekspresi menggunakan operator logika AND, OR, dan NOT (atau -). OR memiliki prioritas lebih tinggi daripada AND. Gunakan tanda kurung untuk pengelompokan prioritas eksplisit.

Contoh:

  • Filter menurut Document.content_length_bytes: content_length_bytes < 50000
  • data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"
  • data_source != "firebase.google.com"
  • update_time < "2024-01-01T00:00:00Z"
  • update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

String filter tidak boleh melebihi 500 karakter; nilai yang lebih panjang dari 500 karakter akan menghasilkan error INVALID_ARGUMENT.

Isi respons

Pesan respons untuk DeveloperKnowledge.AnswerQuery.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "answer": {
    object (Answer)
  }
}
Kolom
answer

object (Answer)

Jawaban atas kueri.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.

Jawaban

Jawaban atas kueri.

Representasi JSON 
{
  "answerText": string,
  "citations": [
    {
      object (AnswerCitation)
    }
  ],
  "references": [
    {
      object (AnswerReference)
    }
  ]
}
Kolom
answerText

string

Berisi teks jawaban.
citations[]

object (AnswerCitation)

Hanya output. Berisi kutipan untuk jawaban.
references[]

object (AnswerReference)

Hanya output. Berisi referensi untuk jawaban.

AnswerCitation

Info kutipan untuk segmen.

Representasi JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
Kolom
startIndex

integer

Hanya output. Menunjukkan awal segmen, diukur dalam byte (Unicode UTF-8), inklusif. Jika ada karakter multi-byte, seperti karakter non-ASCII, pengukuran indeks lebih panjang daripada panjang string.
endIndex

integer

Hanya output. Menunjukkan akhir segmen, diukur dalam byte (Unicode UTF-8), eksklusif. Jika ada karakter multi-byte, seperti karakter non-ASCII, pengukuran indeks lebih panjang daripada panjang string.
sources[]

object (CitationSource)

Hanya output. Berisi sumber kutipan untuk segmen yang diatribusikan.

CitationSource

Sumber kutipan.

Representasi JSON 
{
  "referenceIndex": integer
}
Kolom
referenceIndex

integer

Hanya output. Berisi indeks Answer.AnswerReference dalam kolom berulang references.

AnswerReference

Menampilkan referensi ke sumber.

Representasi JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "documentReference": {
    object (DocumentReference)
  }
  // End of mutually exclusive fields.
}
Kolom
Berisi konten referensi. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
documentReference

object (DocumentReference)

Hanya output. Dokumen referensi.
Akhir kolom yang saling eksklusif.

DocumentReference

Menampilkan referensi ke dokumen.

Representasi JSON 
{
  "documentChunk": {
    object (DocumentChunk)
  }
}
Kolom
documentChunk

object (DocumentChunk)

Hanya output. Berisi potongan dokumen. Kolom documentChunk.id tidak ditetapkan dan akan kosong.