Method: answerQuery

Menjawab kueri menggunakan pembuatan yang didasarkan pada data terpercaya.

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 ke hasil penelusuran yang digunakan untuk mendasarkan jawaban. Ekspresi ini mendukung subset sintaksis yang dijelaskan di https://google.aip.dev/160.

Kolom yang didukung untuk pemfilteran:

  • contentLengthBytes (INTEGER): Panjang kolom Document.content dalam byte.
  • dataSource (STRING): Sumber dokumen, misalnya docs.cloud.google.com. Lihat https://developers.google.com/knowledge/reference/corpus-reference untuk daftar lengkap sumber data dalam korpus.
  • updateTime (TIMESTAMP): Stempel waktu saat dokumen terakhir diperbarui secara signifikan. Pembaruan yang signifikan 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 = (sama dengan) dan != (tidak sama dengan) operator untuk pencocokan persis pada seluruh string. Pencocokan sebagian, 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:

  • Memfilter berdasarkan Document.content_length_bytes: contentLengthBytes < 50000
  • dataSource = "docs.cloud.google.com" OR dataSource = "firebase.google.com"
  • dataSource != "firebase.google.com"
  • updateTime < "2024-01-01T00:00:00Z"
  • updateTime >= "2025-01-22T00:00:00Z" AND (dataSource = "developer.chrome.com" OR dataSource = "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 akan 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 akan lebih panjang daripada panjang string.
sources[]

object (CitationSource)

Hanya output. Berisi sumber kutipan untuk segmen yang dikaitkan.

CitationSource

Sumber kutipan.

Representasi JSON 
{
  "referenceIndex": integer
}
Kolom
referenceIndex

integer

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

AnswerReference

Menampilkan referensi ke sumber.

Representasi JSON 
{

  // Union field content can be only one of the following:
  "documentReference": {
    object (DocumentReference)
  }
  // End of list of possible types for union field content.
}
Kolom
Kolom union content. Berisi konten referensi. content hanya dapat berupa salah satu dari berikut:
documentReference

object (DocumentReference)

Hanya output. Dokumen referensi.

DocumentReference

Menampilkan referensi ke dokumen.

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

object (DocumentChunk)

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