SearchResponse

Pesan respons untuk metode SearchService.Search.

Representasi JSON
{
  "results": [
    {
      object (SearchResult)
    }
  ],
  "facets": [
    {
      object (Facet)
    }
  ],
  "totalSize": integer,
  "attributionToken": string,
  "redirectUri": string,
  "nextPageToken": string,
  "correctedQuery": string,
  "summary": {
    object (Summary)
  },
  "queryExpansionInfo": {
    object (QueryExpansionInfo)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "searchLinkPromotions": [
    {
      object (SearchLinkPromotion)
    }
  ]
}
Kolom
results[]

object (SearchResult)

Daftar dokumen yang cocok. Urutan ini menunjukkan peringkat.

facets[]

object (Facet)

Hasil aspek yang diminta oleh pengguna.

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.

summary

object (Summary)

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

queryExpansionInfo

object (QueryExpansionInfo)

Informasi perluasan kueri untuk hasil yang ditampilkan.

sessionInfo

object (SessionInfo)

Informasi sesi.

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

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.

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).

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.