- Permintaan HTTP
- Isi permintaan
- Isi respons
- Cakupan Otorisasi
- QueryInterpretationOptions
- QueryInterpretation
- QueryInterpretation.InterpretationType
- QueryInterpretation.Reason
- SearchResult
- Cuplikan
- MatchRange
- Metadata
- ResultDisplayMetadata
- ResultDisplayMetadata.ResultDisplayLine
- ResultDisplayMetadata.ResultDisplayField
- ResultDebugInfo
- StructuredResult
- SpellResult
- FacetResult
- FacetBucket
- ResponseDebugInfo
- ErrorInfo
- ErrorMessage
- ResultCounts
- SourceResultCount
- Cobalah!
Cloud Search Query API menyediakan metode penelusuran, yang menampilkan hasil paling relevan dari kueri pengguna. Hasilnya dapat berasal dari aplikasi Google Workspace, seperti Gmail atau Google Drive, atau dapat berasal dari data yang telah Anda indeks dari pihak ketiga.
Catatan: API ini memerlukan akun pengguna akhir standar agar dapat dijalankan. Akun layanan tidak dapat melakukan permintaan Query API secara langsung. Untuk menggunakan akun layanan guna menjalankan kueri, siapkan delegasi otoritas seluruh domain Google Workspace.
Permintaan HTTP
POST https://cloudsearch.googleapis.com/v1/query/search
URL menggunakan sintaksis gRPC Transcoding.
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "requestOptions": { object ( |
Kolom | |
---|---|
requestOptions |
Opsi permintaan, seperti aplikasi penelusuran dan zona waktu pengguna. |
query |
String kueri mentah. Lihat operator penelusuran yang didukung di artikel Mempersempit penelusuran dengan operator |
pageSize |
Jumlah maksimum hasil penelusuran yang akan ditampilkan dalam satu halaman. Nilai yang valid adalah antara 1 dan 100, inklusif. Nilai defaultnya adalah 10. Nilai minimum adalah 50 jika hasil yang diminta melebihi 2.000. |
start |
Memulai indeks hasil. |
dataSourceRestrictions[] |
Sumber yang digunakan untuk membuat kueri. Jika tidak ditentukan, semua sumber data dari aplikasi penelusuran saat ini akan digunakan. |
facetOptions[] |
|
sortOptions |
Opsi untuk mengurutkan hasil penelusuran |
queryInterpretationOptions |
opsi untuk menginterpretasikan kueri pengguna. |
contextAttributes[] |
Atribut konteks untuk permintaan yang akan digunakan untuk menyesuaikan peringkat hasil penelusuran. Jumlah maksimum elemen adalah 10. |
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
Respons API penelusuran.
Representasi JSON |
---|
{ "queryInterpretation": { object ( |
Kolom | |
---|---|
queryInterpretation |
Hasil interpretasi kueri untuk kueri pengguna. Kosong jika interpretasi kueri dinonaktifkan. |
results[] |
Hasil dari kueri penelusuran. |
structuredResults[] |
Hasil terstruktur untuk kueri pengguna. Hasil ini tidak dihitung terhadap pageSize. |
spellResults[] |
Saran ejaan untuk kueri. |
facetResults[] |
Hasil faset berulang. |
hasMoreResults |
Apakah ada hasil penelusuran lainnya yang cocok dengan kueri. |
debugInfo |
Men-debug informasi tentang respons. |
errorInfo |
Informasi error tentang respons. |
resultCounts |
Informasi jumlah hasil yang diperluas. |
Kolom union
Pada kasus yang jarang terjadi, ketika sistem tidak dapat menelusuri semua dokumen, jalankan kembali kuerinya. |
|
resultCountEstimate |
Estimasi jumlah hasil untuk kueri ini. |
resultCountExact |
Jumlah hasil persis untuk kueri ini. |
Cakupan Otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/cloud_search.query
https://www.googleapis.com/auth/cloud_search
Untuk informasi selengkapnya, lihat Panduan otorisasi.
QueryInterpretationOptions
opsi untuk menginterpretasikan kueri pengguna.
Representasi JSON |
---|
{ "disableNlInterpretation": boolean, "enableVerbatimMode": boolean, "disableSupplementalResults": boolean } |
Kolom | |
---|---|
disableNlInterpretation |
Tanda untuk menonaktifkan interpretasi kueri dalam bahasa alami (NL). Defaultnya adalah false (salah). Tetapkan ke true (benar) untuk menonaktifkan penafsiran bahasa alami. Penafsiran NL hanya berlaku untuk sumber data standar. |
enableVerbatimMode |
Aktifkan tanda ini untuk menonaktifkan semua pengoptimalan internal seperti interpretasi kueri dalam bahasa natural (NL), pengambilan hasil tambahan, dan penggunaan sinonim termasuk yang kustom. Penafsiran Nl akan dinonaktifkan jika salah satu dari kedua tanda benar. |
disableSupplementalResults |
Gunakan tanda ini untuk menonaktifkan hasil tambahan untuk kueri. Setelan hasil tambahan yang dipilih di tingkat SearchApplication akan diprioritaskan jika disetel ke True. |
QueryInterpretation
Representasi JSON |
---|
{ "interpretedQuery": string, "interpretationType": enum ( |
Kolom | |
---|---|
interpretedQuery |
Penafsiran kueri yang digunakan dalam penelusuran. Misalnya, kueri dengan intent bahasa alami seperti "email from john" akan ditafsirkan sebagai "from:john source:mail". Kolom ini tidak akan diisi jika alasannya adalah NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY. |
interpretationType |
|
reason |
Alasan penafsiran kueri. Kolom ini tidak akan DITENTUKAN jika jenis interpretasinya TIDAK ADA. |
QueryInterpretation.InterpretationType
Enum | |
---|---|
NONE |
Baik interpretasi bahasa alami maupun versi kueri yang lebih luas tidak digunakan untuk mengambil hasil penelusuran. |
BLEND |
Hasil dari kueri asli digabungkan dengan hasil lainnya. Alasan menggabungkan hasil lainnya dengan hasil dari kueri asli diisi dalam kolom 'Alasan' di bawah. |
REPLACE |
Hasil dari kueri asli akan diganti. Alasan untuk mengganti hasil dari kueri asli diisi di kolom 'Alasan' di bawah. |
QueryInterpretation.Reason
Enum | |
---|---|
UNSPECIFIED |
|
QUERY_HAS_NATURAL_LANGUAGE_INTENT |
Penafsiran bahasa alami kueri digunakan untuk mengambil hasil penelusuran. |
NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY |
Kesamaan istilah kueri dan dokumen digunakan untuk memperluas kueri secara selektif guna mengambil hasil penelusuran tambahan karena hasil yang memadai tidak ditemukan untuk kueri pengguna. Kueri yang ditafsirkan akan kosong untuk kasus ini. |
SearchResult
Hasil yang berisi informasi terindeks untuk dokumen.
Representasi JSON |
---|
{ "title": string, "url": string, "snippet": { object ( |
Kolom | |
---|---|
title |
Judul hasil penelusuran. |
url |
URL hasil penelusuran. URL berisi pengalihan Google ke item yang sebenarnya. URL ini ditandatangani dan tidak boleh diubah. |
snippet |
Penyambungan semua cuplikan (ringkasan) yang tersedia untuk hasil ini. |
metadata |
{i>metadata<i} dari hasil penelusuran. |
clusteredResults[] |
Jika sumber dikelompokkan, berikan daftar hasil yang dikelompokkan. Hanya akan ada satu tingkat hasil yang dikelompokkan. Jika sumber saat ini tidak diaktifkan untuk pengelompokan, kolom ini akan kosong. |
debugInfo |
Informasi proses debug tentang hasil penelusuran ini. |
Cuplikan
Cuplikan hasil penelusuran, yang merangkum konten halaman yang dihasilkan.
Representasi JSON |
---|
{
"snippet": string,
"matchRanges": [
{
object ( |
Kolom | |
---|---|
snippet |
Cuplikan dokumen. Cuplikan dokumen. Dapat berisi karakter HTML yang di-escape dan harus di-escape sebelum rendering. |
matchRanges[] |
Rentang yang cocok dalam cuplikan. |
MatchRange
Rentang cuplikan yang cocok [awal, akhir).
Representasi JSON |
---|
{ "start": integer, "end": integer } |
Kolom | |
---|---|
start |
Posisi awal kecocokan dalam cuplikan. |
end |
Akhir kecocokan dalam cuplikan. |
Metadata
{i>metadata<i} dari hasil penelusuran yang cocok.
Representasi JSON |
---|
{ "source": { object ( |
Kolom | |
---|---|
source |
Sumber bernama untuk hasil, seperti Gmail. |
mimeType |
Jenis MIME dari hasil penelusuran. |
thumbnailUrl |
URL thumbnail hasil. |
owner |
pemilik (biasanya pembuat) dokumen atau objek hasil penelusuran. |
createTime |
Waktu pembuatan untuk dokumen atau objek ini dalam hasil penelusuran. Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
updateTime |
Tanggal terakhir diubah untuk objek dalam hasil penelusuran. Jika tidak ditetapkan dalam item, nilai yang ditampilkan di sini akan kosong. Jika Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
fields[] |
Kolom yang diindeks dalam data terstruktur, ditampilkan sebagai properti bernama generik. |
displayOptions |
opsi yang menentukan cara menampilkan hasil penelusuran data terstruktur. |
objectType |
Jenis objek dari hasil penelusuran. |
ResultDisplayMetadata
Representasi JSON |
---|
{
"objectTypeLabel": string,
"metalines": [
{
object ( |
Kolom | |
---|---|
objectTypeLabel |
Label tampilan untuk objek. |
metalines[] |
Konten metaline yang akan ditampilkan dengan hasil. |
ResultDisplayMetadata.ResultDisplayLine
Kumpulan kolom yang membentuk garis yang ditampilkan
Representasi JSON |
---|
{
"fields": [
{
object ( |
Kolom | |
---|---|
fields[] |
ResultDisplayMetadata.ResultDisplayField
Tampilkan Kolom untuk Hasil query.search
Representasi JSON |
---|
{
"label": string,
"operatorName": string,
"property": {
object ( |
Kolom | |
---|---|
label |
Label tampilan untuk properti. |
operatorName |
Nama operator properti. |
property |
Pasangan nilai nama untuk properti. |
ResultDebugInfo
Informasi proses debug tentang hasil.
Representasi JSON |
---|
{ "formattedDebugInfo": string } |
Kolom | |
---|---|
formattedDebugInfo |
Info debug umum yang diformat untuk ditampilkan. |
StructuredResult
Hasil terstruktur yang ditampilkan sebagai bagian dari permintaan penelusuran.
Representasi JSON |
---|
{
"person": {
object ( |
Kolom | |
---|---|
person |
Representasi seseorang |
SpellResult
Representasi JSON |
---|
{ "suggestedQuery": string } |
Kolom | |
---|---|
suggestedQuery |
Ejaan kueri yang disarankan. |
FacetResult
Respons faset khusus sumber
Representasi JSON |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"buckets": [
{
object ( |
Kolom | |
---|---|
sourceName |
Nama sumber yang hasil faset ditampilkan. Wajib diisi. |
objectType |
Jenis objek yang hasil fasetnya ditampilkan. Boleh kosong. |
operatorName |
Nama operator yang dipilih untuk facet. @lihat cloudsearch.SchemaPropertyOptions |
buckets[] |
FacetBuckets untuk nilai dalam respons yang berisi setidaknya satu hasil dengan filter yang sesuai. |
FacetBucket
Bucket pada facet adalah unit operasi dasar. Bucket dapat terdiri dari nilai tunggal ATAU rentang nilai yang berdekatan, bergantung pada jenis kolom yang dikelompokkan. FacetBucket saat ini hanya digunakan untuk menampilkan objek respons.
Representasi JSON |
---|
{ "count": integer, "percentage": integer, "filter": { object ( |
Kolom | |
---|---|
count |
Jumlah hasil yang cocok dengan nilai bucket. Jumlah hanya ditampilkan untuk penelusuran jika akurasi jumlah dijamin. Cloud Search tidak menjamin jumlah faset untuk setiap kueri dan jumlah faset mungkin hanya muncul sesekali, bahkan untuk kueri yang identik. Jangan membuat dependensi pada keberadaan jumlah faset; sebagai gantinya gunakan persentase ount facet yang selalu ditampilkan. |
percentage |
Persentase hasil yang cocok dengan nilai bucket. Nilai yang dikembalikan antara (0-100], dan dibulatkan ke bawah menjadi bilangan bulat jika pecahan. Jika tidak secara eksplisit ditampilkan, nilai mewakili nilai persentase yang dibulatkan ke 0. Persentase ditampilkan untuk semua penelusuran, namun merupakan perkiraan. Karena persentase selalu ditampilkan, Anda harus merender persentase, bukan hitungan. |
filter |
Filter yang akan diteruskan dalam permintaan penelusuran jika bucket yang sesuai dipilih. |
value |
|
ResponseDebugInfo
Men-debug informasi tentang respons.
Representasi JSON |
---|
{ "formattedDebugInfo": string } |
Kolom | |
---|---|
formattedDebugInfo |
Info debug umum yang diformat untuk ditampilkan. |
ErrorInfo
Informasi error tentang respons.
Representasi JSON |
---|
{
"errorMessages": [
{
object ( |
Kolom | |
---|---|
errorMessages[] |
|
ErrorMessage
Pesan error per respons sumber.
Representasi JSON |
---|
{
"source": {
object ( |
Kolom | |
---|---|
source |
|
errorMessage |
|
ResultCounts
Informasi jumlah hasil
Representasi JSON |
---|
{
"sourceResultCounts": [
{
object ( |
Kolom | |
---|---|
sourceResultCounts[] |
Informasi jumlah hasil untuk setiap sumber dengan hasil. |
SourceResultCount
Informasi jumlah hasil per sumber.
Representasi JSON |
---|
{ "source": { object ( |
Kolom | |
---|---|
source |
Sumber yang dikaitkan dengan informasi jumlah hasil. |
hasMoreResults |
Apakah ada hasil penelusuran lainnya untuk sumber ini. |
Kolom union
|
|
resultCountEstimate |
Estimasi jumlah hasil untuk sumber ini. |
resultCountExact |
Jumlah hasil persis untuk sumber ini. |