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)
  },
  "appliedControls": [
    string
  ],
  "queryExpansionInfo": {
    object (QueryExpansionInfo)
  },
  "naturalLanguageQueryUnderstandingInfo": {
    object (NaturalLanguageQueryUnderstandingInfo)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "searchLinkPromotions": [
    {
      object (SearchLinkPromotion)
    }
  ],
  "semanticState": enum (SemanticState)
}
Kolom
results[]

object (SearchResult)

Daftar dokumen yang cocok. Urutan tersebut mewakili peringkat.
facets[]

object (Facet)

Hasil dari 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 pencarian unik. Hal ini harus disertakan dalam log UserEvent yang dihasilkan dari pencarian ini, yang memungkinkan atribusi akurat terhadap kinerja model pencarian. Hal ini juga membantu mengidentifikasi permintaan selama skenario dukungan pelanggan.
redirectUri

string

URI halaman pengalihan yang ditentukan pelanggan. Jika tindakan pengalihan dipicu, tidak ada pencarian 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 telah dikoreksi ejaannya, jika ditemukan. Jika tipe koreksi ejaan adalah OTOMATIS, maka hasil pencarian didasarkan pada correctedQuery. Jika tidak, kueri asli akan digunakan untuk pencarian.
summary

object (Summary)

Ringkasan sebagai bagian dari hasil pencarian. Kolom ini hanya akan dikembalikan jika SearchRequest.ContentSearchSpec.summary_spec telah diatur.
appliedControls[]

string

Opsional. Kontrol yang diterapkan sebagai bagian dari layanan Kontrol.
queryExpansionInfo

object (QueryExpansionInfo)

Informasi perluasan kueri untuk hasil yang dikembalikan.
naturalLanguageQueryUnderstandingInfo

object (NaturalLanguageQueryUnderstandingInfo)

Hanya output. Pemahaman kueri bahasa alami terhadap informasi untuk hasil yang dikembalikan.
sessionInfo

object (SessionInfo)

Informasi sesi.

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

enum (SemanticState)

Hanya output. Menunjukkan status semantik respons penelusuran.

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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string,
  "interval": {
    object (Interval)
  }
  // End of mutually exclusive fields.
}
Kolom
count

string (int64 format)

Jumlah item yang memiliki nilai faset ini.
Nilai facet yang berisi nilai. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
value

string

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

object (Interval)

Nilai interval untuk suatu faset, misalnya [10, 20) untuk faset "harga". Cocok dengan SearchRequest.FacetSpec.FacetKey.intervals.
Akhir kolom yang saling eksklusif.

QueryExpansionInfo

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

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

boolean

Nilai boolean yang menjelaskan apakah perluasan kueri telah terjadi.
pinnedResultCount

string (int64 format)

Jumlah hasil yang disematkan. Kolom ini hanya akan diisi saat ekspansi terjadi dan SearchRequest.QueryExpansionSpec.pin_unexpanded_results diatur ke true.

NaturalLanguageQueryUnderstandingInfo

Informasi yang menjelaskan pemahaman bahasa alami apa yang dilakukan pada kueri masukan.

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

string

Filter yang diekstrak dari kueri masukan.
rewrittenQuery

string

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

string

Tujuan yang diklasifikasikan dari kueri masukan.
structuredExtractedFilter

object (StructuredExtractedFilter)

Filter yang diekstrak dari kueri input ditampilkan dalam bentuk terstruktur.

StructuredExtractedFilter

Filter yang diekstrak dari kueri input 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. 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 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringConstraint": {
    object (StringConstraint)
  },
  "numberConstraint": {
    object (NumberConstraint)
  },
  "geolocationConstraint": {
    object (GeolocationConstraint)
  },
  "andExpr": {
    object (AndExpression)
  },
  "orExpr": {
    object (OrExpression)
  }
  // End of mutually exclusive fields.
}
Kolom
Jenis ekspresi. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
stringConstraint

object (StringConstraint)

Ekspresi batasan string.
numberConstraint

object (NumberConstraint)

Ekspresi batasan numerik.
geolocationConstraint

object (GeolocationConstraint)

Ekspresi batasan geolokasi.
andExpr

object (AndExpression)

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

object (OrExpression)

Operator gabungan logika "Atau" yang menghubungkan beberapa ekspresi.
Akhir kolom yang saling eksklusif.

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 masukan. Kedekatan alamat referensi dengan kolom geolokasi akan digunakan untuk memfilter hasil.
latitude

number

Garis lintang dari geolokasi yang disimpulkan dari kueri masukan.
longitude

number

Garis bujur dari geolokasi yang disimpulkan dari kueri masukan.
radiusInMeters

number

Jari-jari dalam meter di sekitar alamat tersebut. Data akan dikembalikan jika lokasi pada kolom geolokasi berada dalam radius yang ditentukan.

AndExpression

Operator logika And.

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

object (Expression)

Ekspresi yang digabungkan dengan operator AND.

OrExpression

Operator logika Or.

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

object (Expression)

Ekspresi yang digabungkan dengan operator OR.

SessionInfo

Informasi tentang sesi.

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

string

Nama sesi. Jika mode sesi otomatis digunakan (ketika SearchRequest.session diakhiri dengan "-"), bidang ini menyimpan nama sesi yang baru dibuat.
queryId

string

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

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

SemanticState

Status semantik respons penelusuran.

Enum
SEMANTIC_STATE_UNSPECIFIED Nilai default. Tidak boleh digunakan.
DISABLED Penelusuran semantik dinonaktifkan untuk respons penelusuran ini.
ENABLED Penelusuran semantik diaktifkan untuk respons penelusuran ini.