Method: documents.searchDocumentChunks

Menelusuri pengetahuan developer di seluruh dokumentasi developer Google. Metode ini menampilkan potongan dokumen berdasarkan kueri pengguna. Ada banyak potongan Dokumen yang sama. Untuk mengambil dokumen lengkap, gunakan DeveloperKnowledge.GetDocument atau DeveloperKnowledge.BatchGetDocuments dengan DocumentChunk.parent yang ditampilkan dalam SearchDocumentChunksResponse.results.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
query

string

Wajib. String kueri mentah yang diberikan oleh pengguna, seperti "Cara membuat bucket Cloud Storage?".
pageSize

integer

Opsional. Jumlah hasil maksimum 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. Token halaman, yang diterima dari panggilan documents.searchDocumentChunks sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

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)

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. Token yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/devprofiles.full_control

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.

DocumentChunk

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

Representasi JSON 
{
  "parent": string,
  "id": string,
  "content": string
}
Kolom
parent

string

Hanya output. 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. ID potongan ini dalam dokumen. ID potongan unik dalam dokumen, tetapi tidak unik secara global di seluruh dokumen. ID chunk tidak stabil dan dapat berubah seiring waktu.
content

string

Hanya output. Konten potongan dokumen.