SearchResponse

Pesan respons untuk metode SearchService.Search.

Representasi JSON 
{
  "results": [
    {
      object (SearchResult)
    }
  ],
  "facets": [
    {
      object (Facet)
    }
  ],
  "guidedSearchResult": {
    object (GuidedSearchResult)
  },
  "totalSize": integer,
  "attributionToken": string,
  "redirectUri": string,
  "nextPageToken": string,
  "correctedQuery": string,
  "suggestedQuery": string,
  "summary": {
    object (Summary)
  },
  "appliedControls": [
    string
  ],
  "geoSearchDebugInfo": [
    {
      object (GeoSearchDebugInfo)
    }
  ],
  "queryExpansionInfo": {
    object (QueryExpansionInfo)
  },
  "naturalLanguageQueryUnderstandingInfo": {
    object (NaturalLanguageQueryUnderstandingInfo)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "oneBoxResults": [
    {
      object (OneBoxResult)
    }
  ],
  "searchLinkPromotions": [
    {
      object (SearchLinkPromotion)
    }
  ]
}
Kolom
results[]

object (SearchResult)

Daftar dokumen yang cocok. Urutan ini menunjukkan peringkat.
facets[]

object (Facet)

Hasil aspek yang diminta oleh pengguna.
guidedSearchResult

object (GuidedSearchResult)

Hasil penelusuran terpandu.
totalSize

integer

Perkiraan jumlah total item yang cocok, terlepas dari penomoran halaman. Jumlah results yang ditampilkan oleh penomoran halaman mungkin kurang dari totalSize yang cocok.
attributionToken

string

Token penelusuran unik. Ini harus disertakan dalam log UserEvent yang dihasilkan dari penelusuran ini, yang memungkinkan atribusi akurat performa model penelusuran. ID ini juga membantu mengidentifikasi permintaan selama skenario dukungan pelanggan.
redirectUri

string

URI halaman pengalihan yang ditentukan pelanggan. Jika tindakan pengalihan dipicu, tidak ada penelusuran yang dilakukan, dan hanya redirectUri dan attributionToken yang ditetapkan dalam respons.
nextPageToken

string

Token yang dapat dikirim sebagai SearchRequest.page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.
correctedQuery

string

Berisi kueri yang ejaannya dikoreksi, jika ditemukan. Jika jenis koreksi ejaan adalah OTOMATIS, hasil penelusuran didasarkan pada correctedQuery. Jika tidak, kueri asli akan digunakan untuk penelusuran.
suggestedQuery

string

Kueri yang dikoreksi dengan keyakinan rendah, alias kueri yang dimaksud. Dibandingkan dengan correctedQuery, kolom ini ditetapkan saat SpellCorrector menampilkan respons, tetapi FPR(penggantian halaman penuh) tidak dipicu karena koreksinya memiliki tingkat keyakinan yang rendah(misalnya, dibalik karena ada kecocokan kueri asli dalam korpus dokumen).
summary

object (Summary)

Ringkasan sebagai bagian dari hasil penelusuran. Kolom ini hanya ditampilkan jika SearchRequest.ContentSearchSpec.summary_spec ditetapkan.
appliedControls[]

string

Kontrol yang diterapkan sebagai bagian dari layanan Kontrol.
geoSearchDebugInfo[]

object (GeoSearchDebugInfo)
queryExpansionInfo

object (QueryExpansionInfo)

Informasi perluasan kueri untuk hasil yang ditampilkan.
naturalLanguageQueryUnderstandingInfo

object (NaturalLanguageQueryUnderstandingInfo)

Informasi pemahaman kueri bahasa alami untuk hasil yang ditampilkan.
sessionInfo

object (SessionInfo)

Informasi sesi.

Hanya disetel jika SearchRequest.session diberikan. Lihat deskripsinya untuk mengetahui detail selengkapnya.
oneBoxResults[]

object (OneBoxResult)

Daftar hasil Kotak satu. Ada beberapa hasil Kotak satu yang berbeda jenisnya.

Faset

Hasil faset.

Representasi JSON 
{
  "key": string,
  "values": [
    {
      object (FacetValue)
    }
  ],
  "dynamicFacet": boolean
}
Kolom
key

string

Kunci untuk faset ini. Misalnya "colors" atau "price". Cocok dengan SearchRequest.FacetSpec.FacetKey.key.
values[]

object (FacetValue)

Nilai faset untuk kolom ini.
dynamicFacet

boolean

Apakah aspek dibuat secara dinamis.

FacetValue

Nilai facet yang berisi nama nilai dan jumlahnya.

Representasi JSON 
{
  "count": string,

  // Union field facet_value can be only one of the following:
  "value": string,
  "interval": {
    object (Interval)
  }
  // End of list of possible types for union field facet_value.
}
Kolom
count

string (int64 format)

Jumlah item yang memiliki nilai faset ini.
Kolom union facet_value. Nilai facet yang berisi nilai. facet_value hanya ada berupa salah satu diantara berikut:
value

string

Nilai teks faset, seperti "Hitam" untuk faset "warna".
interval

object (Interval)

Nilai interval untuk faset, seperti [10, 20) untuk faset "harga". Cocok dengan SearchRequest.FacetSpec.FacetKey.intervals.

GuidedSearchResult

Hasil penelusuran terpandu. Penelusuran terpandu membantu pengguna menyaring hasil penelusuran dan mempersempitnya untuk menemukan kebutuhan yang sebenarnya dari hasil penelusuran yang lebih luas.

Representasi JSON 
{
  "refinementAttributes": [
    {
      object (RefinementAttribute)
    }
  ],
  "followUpQuestions": [
    string
  ]
}
Kolom
refinementAttributes[]

object (RefinementAttribute)

Daftar atribut penelusuran yang diberi peringkat.
followUpQuestions[]

string

Pertanyaan lanjutan yang disarankan.

RefinementAttribute

Atribut yang berguna untuk penajaman hasil penelusuran.

Representasi JSON 
{
  "attributeKey": string,
  "attributeValue": string
}
Kolom
attributeKey

string

kunci atribut yang digunakan untuk mempersempit hasil. Misalnya, "movie_type".
attributeValue

string

nilai atribut yang digunakan untuk mempersempit hasil. Misalnya, "drama".

GeoSearchDebugInfo

Informasi debug yang secara khusus terkait dengan masalah geocoding penerusan yang muncul dari Penelusuran Geolocation.

Representasi JSON 
{
  "originalAddressQuery": string,
  "errorMessage": string
}
Kolom
originalAddressQuery

string

Alamat yang menyebabkan masalah saat penyerapan geocoding penerusan.
errorMessage

string

Error yang dihasilkan.

QueryExpansionInfo

Informasi yang menjelaskan perluasan kueri, termasuk apakah perluasan telah terjadi.

Representasi JSON 
{
  "expandedQuery": boolean,
  "pinnedResultCount": string
}
Kolom
expandedQuery

boolean

Bool yang menjelaskan apakah perluasan kueri telah terjadi.
pinnedResultCount

string (int64 format)

Jumlah hasil yang disematkan. Kolom ini hanya akan ditetapkan saat ekspansi terjadi dan SearchRequest.QueryExpansionSpec.pin_unexpanded_results ditetapkan ke benar (true).

NaturalLanguageQueryUnderstandingInfo

Informasi yang menjelaskan apa yang dilakukan natural language understanding pada kueri input.

Representasi JSON 
{
  "extractedFilters": string,
  "rewrittenQuery": string,
  "classifiedIntents": [
    string
  ],
  "structuredExtractedFilter": {
    object (StructuredExtractedFilter)
  }
}
Kolom
extractedFilters

string

Filter yang diekstrak dari kueri input.
rewrittenQuery

string

Kueri input yang ditulis ulang tanpa filter yang diekstrak.
classifiedIntents[]

string

Maksud yang diklasifikasikan dari kueri input.
structuredExtractedFilter

object (StructuredExtractedFilter)

Filter yang diekstrak dari kueri input yang ditampilkan dalam bentuk terstruktur.

StructuredExtractedFilter

Filter yang diekstrak dari kueri input yang ditampilkan dalam bentuk terstruktur.

Representasi JSON 
{
  "expression": {
    object (Expression)
  }
}
Kolom
expression

object (Expression)

Ekspresi yang menunjukkan filter yang diekstrak dari kueri input dalam bentuk terstruktur. Ekspresi ini dapat berupa ekspresi sederhana yang menunjukkan batasan string, numerik, atau geolokasi tunggal, atau ekspresi gabungan yang merupakan kombinasi dari beberapa ekspresi yang terhubung menggunakan operator logis (OR dan AND).

Ekspresi

Ekspresi yang menunjukkan filter yang diekstrak dari kueri input.

Representasi JSON 
{

  // Union field expr can be only one of the following:
  "stringConstraint": {
    object (StringConstraint)
  },
  "numberConstraint": {
    object (NumberConstraint)
  },
  "geolocationConstraint": {
    object (GeolocationConstraint)
  },
  "andExpr": {
    object (AndExpression)
  },
  "orExpr": {
    object (OrExpression)
  }
  // End of list of possible types for union field expr.
}
Kolom
Kolom union expr. Jenis ekspresi. expr hanya ada berupa salah satu diantara berikut:
stringConstraint

object (StringConstraint)

Ekspresi batasan string.
numberConstraint

object (NumberConstraint)

Ekspresi batasan numerik.
geolocationConstraint

object (GeolocationConstraint)

Ekspresi batasan geolokasi.
andExpr

object (AndExpression)

Operator gabungan "And" logis yang menghubungkan beberapa ekspresi.
orExpr

object (OrExpression)

Operator gabungan "Atau" logis yang menghubungkan beberapa ekspresi.

StringConstraint

Ekspresi batasan kolom string.

Representasi JSON 
{
  "fieldName": string,
  "values": [
    string
  ],
  "querySegment": string
}
Kolom
fieldName

string

nama kolom string seperti yang ditentukan dalam skema.
values[]

string

Nilai kolom string. Record hanya akan ditampilkan jika nilai kolom cocok dengan salah satu nilai yang ditentukan di sini.
querySegment

string

Mengidentifikasi kata kunci dalam kueri penelusuran yang cocok dengan filter.

NumberConstraint

Ekspresi batasan kolom angka. Contoh: harga < 100.

Representasi JSON 
{
  "fieldName": string,
  "comparison": enum (Comparison),
  "value": number,
  "querySegment": string
}
Kolom
fieldName

string

nama kolom numerik seperti yang ditentukan dalam skema.
comparison

enum (Comparison)

Operasi perbandingan yang dilakukan antara nilai kolom dan nilai yang ditentukan dalam batasan.
value

number

Nilai yang ditentukan dalam batasan numerik.
querySegment

string

Mengidentifikasi kata kunci dalam kueri penelusuran yang cocok dengan filter.

Perbandingan

Operasi perbandingan yang dilakukan.

Enum
COMPARISON_UNSPECIFIED Operator perbandingan tidak ditentukan.
EQUALS Menunjukkan operator = persamaan.
LESS_THAN_EQUALS Menunjukkan operator kurang dari atau sama dengan <=.
LESS_THAN Menunjukkan operator kurang dari <.
GREATER_THAN_EQUALS Menunjukkan operator lebih besar dari atau sama dengan >=.
GREATER_THAN Menunjukkan operator lebih besar dari >.

GeolocationConstraint

Batasan kolom geolokasi. Nama kolom geolokasi sebagaimana ditentukan dalam skema.

Representasi JSON 
{
  "fieldName": string,
  "address": string,
  "latitude": number,
  "longitude": number,
  "radiusInMeters": number
}
Kolom
fieldName

string

Nama kolom geolokasi seperti yang ditentukan dalam skema.
address

string

Alamat referensi yang disimpulkan dari kueri input. Kedekatan alamat referensi dengan kolom geolokasi akan digunakan untuk memfilter hasil.
latitude

number

Lintang geolokasi yang disimpulkan dari kueri input.
longitude

number

Bujur geolokasi yang disimpulkan dari kueri input.
radiusInMeters

number

Radius dalam meter di sekitar alamat. Data ditampilkan jika lokasi kolom geolokasi berada dalam radius.

AndExpression

Operator And logis.

Representasi JSON 
{
  "expressions": [
    {
      object (Expression)
    }
  ]
}
Kolom
expressions[]

object (Expression)

Ekspresi yang digabungkan dengan logika AND.

OrExpression

Operator Or logis.

Representasi JSON 
{
  "expressions": [
    {
      object (Expression)
    }
  ]
}
Kolom
expressions[]

object (Expression)

Ekspresi yang digabungkan dengan OR.

SessionInfo

Informasi tentang sesi.

Representasi JSON 
{
  "name": string,
  "queryId": string
}
Kolom
name

string

Nama sesi. Jika mode sesi otomatis digunakan (saat SearchRequest.session berakhir dengan "-"), kolom ini akan menyimpan nama sesi yang baru dibuat.
queryId

string

ID kueri yang sesuai dengan panggilan API penelusuran ini. Satu sesi dapat memiliki beberapa giliran, yang masing-masing memiliki ID kueri unik.

Dengan menentukan nama sesi dan ID kueri ini dalam panggilan Answer API, pembuatan jawaban terjadi dalam konteks hasil penelusuran dari panggilan penelusuran ini.

OneBoxResult

OneBoxResult adalah penampung untuk semua hasil jenis tertentu yang ingin kita tampilkan secara berbeda di UI.

Representasi JSON 
{
  "oneBoxType": enum (OneBoxType),
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Kolom
oneBoxType

enum (OneBoxType)

Jenis hasil Kotak info.
searchResults[]

object (SearchResult)

Hasil penelusuran untuk Kotak satu ini.

OneBoxType

Jenis hasil Kotak info.

Enum
ONE_BOX_TYPE_UNSPECIFIED Nilai default. Tidak boleh digunakan.
PEOPLE Satu hasil kotak berisi hasil penelusuran orang.
ORGANIZATION Satu hasil kotak berisi hasil organisasi.
SLACK Satu hasil kotak berisi hasil slack.
KNOWLEDGE_GRAPH Hasil satu kotak berisi respons penelusuran Pustaka Pengetahuan.