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/v1/documents:searchDocumentChunks

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
query

string

Wajib. Menyediakan string kueri mentah yang diberikan oleh pengguna, seperti "Bagaimana cara membuat bucket Cloud Storage?".
pageSize

integer

Opsional. Menentukan jumlah maksimum hasil yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini.

Jika tidak ditentukan, paling banyak 5 hasil akan ditampilkan.

Nilai maksimum adalah 20; nilai di atas 20 akan menghasilkan error INVALID_ARGUMENT.
pageToken

string

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

string

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

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

Kolom yang didukung untuk pemfilteran:

  • 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 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 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:

  • 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 tertentu. 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 akan 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.

DocumentChunk

DocumentChunk mewakili bagian konten dari Document dalam korpus DeveloperKnowledge. Untuk mengambil seluruh konten dokumen, teruskan parent ke DeveloperKnowledge.GetDocument atau DeveloperKnowledge.BatchGetDocuments.

Representasi JSON 
{
  "parent": string,
  "id": string,
  "content": string,
  "document": {
    object (Document)
  }
}
Kolom
parent

string

Hanya output. Berisi nama resource dokumen asal potongan ini. Format: documents/{uri_without_scheme} Contoh: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Hanya output. Menentukan ID potongan ini dalam dokumen. ID potongan bersifat unik dalam dokumen, tetapi tidak unik secara global di seluruh dokumen. ID chunk tidak stabil dan dapat berubah seiring waktu.
content

string

Hanya output. Berisi konten potongan dokumen.
document

object (Document)

Hanya output. Mewakili metadata tentang Document asal potongan ini. DocumentView pesan Document ini akan ditetapkan ke DOCUMENT_VIEW_BASIC. Kolom ini disertakan di sini untuk memudahkan sehingga klien tidak perlu memanggil DeveloperKnowledge.GetDocument atau DeveloperKnowledge.BatchGetDocuments jika hanya memerlukan kolom metadata. Jika tidak, klien harus menggunakan DeveloperKnowledge.GetDocument atau DeveloperKnowledge.BatchGetDocuments untuk mengambil konten dokumen lengkap.