Method: documents.searchDocumentChunks

Menelusuri pengetahuan developer di seluruh dokumentasi developer Google. Menampilkan DocumentChunk berdasarkan kueri pengguna. Mungkin ada banyak potongan dari Document yang sama. Untuk mengambil dokumen lengkap, gunakan DeveloperKnowledge.GetDocument atau DeveloperKnowledge.BatchGetDocuments dengan DocumentChunk.parent yang ditampilkan di SearchDocumentChunksResponse.results.

Permintaan HTTP

GET https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
query

string

Wajib. Menyediakan string kueri mentah yang diberikan oleh pengguna, seperti "How to create a Cloud Storage bucket?".
pageSize

integer

Opsional. Menentukan jumlah maksimum hasil yang akan ditampilkan. Layanan dapat menampilkan kurang dari nilai ini.

Jika tidak ditentukan, maksimal 5 hasil akan ditampilkan.

Nilai maksimumnya adalah 100; nilai di atas 100 akan dipaksa menjadi 100.
pageToken

string

Opsional. Berisi token halaman, yang diterima dari panggilan documents.searchDocumentChunks sebelumnya. Berikan token ini untuk mengambil halaman berikutnya.
filter

string

Opsional. Menerapkan filter ketat ke hasil penelusuran. Ekspresi ini mendukung subkumpulan sintaksis yang dijelaskan di https://google.aip.dev/160.

Meskipun documents.searchDocumentChunks menampilkan DocumentChunks, filter diterapkan ke kolom DocumentChunk.document.

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 mengetahui daftar lengkap sumber data dalam korpus.
  • updateTime (TIMESTAMP): Stempel waktu saat dokumen terakhir diperbarui secara bermakna. 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 = (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 yang lebih tinggi daripada AND. Gunakan tanda kurung untuk pengelompokan prioritas eksplisit.

Contoh:

  • Filter menurut 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 permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk DeveloperKnowledge.SearchDocumentChunks.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
Kolom
results[]

object (DocumentChunk)

Berisi hasil penelusuran untuk kueri yang diberikan. Setiap DocumentChunk dalam daftar ini berisi cuplikan konten yang relevan dengan kueri penelusuran. Gunakan kolom DocumentChunk.parent dari setiap hasil dengan DeveloperKnowledge.GetDocument atau DeveloperKnowledge.BatchGetDocuments untuk mengambil konten dokumen lengkap.
nextPageToken

string

Opsional. Menyediakan token yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak ada halaman berikutnya.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.