FacetSpec

Spesifikasi faset untuk melakukan penelusuran dengan faset.

Representasi JSON 
{
  "facetKey": {
    object (FacetKey)
  },
  "limit": integer,
  "excludedFilterKeys": [
    string
  ],
  "enableDynamicPosition": boolean
}
Kolom
facetKey

object (FacetKey)

Wajib. Spesifikasi kunci aspek.
limit

integer

Nilai faset maksimum yang ditampilkan untuk faset ini. Jika tidak ditentukan, nilai defaultnya adalah 20. Nilai maksimum yang diizinkan adalah 300. Nilai di atas 300 akan dikonversi menjadi 300. Untuk penggabungan dalam penelusuran layanan kesehatan, jika [FacetKey.key] adalah "healthcare_aggregation_key", batas akan diganti menjadi 10.000 secara internal, terlepas dari nilai yang ditetapkan di sini.

Jika kolom ini negatif, INVALID_ARGUMENT akan ditampilkan.
excludedFilterKeys[]

string

Daftar kunci yang akan dikecualikan saat memfasilitasi.

Secara default, FacetKey.key tidak dikecualikan dari filter kecuali jika tercantum dalam kolom ini.

Mencantumkan kunci faset di kolom ini memungkinkan nilainya muncul sebagai hasil faset, meskipun nilai tersebut difilter dari hasil penelusuran. Penggunaan kolom ini tidak memengaruhi hasil penelusuran yang ditampilkan.

Misalnya, ada 100 dokumen dengan faset warna "Merah" dan 200 dokumen dengan faset warna "Biru". Kueri yang berisi filter "color:ANY("Red")" dan memiliki "color" sebagai FacetKey.key secara default hanya akan menampilkan dokumen "Red" dalam hasil penelusuran, dan juga menampilkan "Red" dengan jumlah 100 sebagai satu-satunya faset warna. Meskipun ada juga dokumen biru yang tersedia, "Biru" tidak akan ditampilkan sebagai nilai faset yang tersedia.

Jika "color" tercantum di "excludedFilterKeys", kueri akan menampilkan nilai faset "Red" dengan jumlah 100 dan "Blue" dengan jumlah 200, karena kunci "color" kini dikecualikan dari filter. Karena kolom ini tidak memengaruhi hasil penelusuran, hasil penelusuran masih difilter dengan benar untuk menampilkan hanya dokumen "Merah".

Maksimum 100 nilai yang diizinkan. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
enableDynamicPosition

boolean

Mengaktifkan posisi dinamis untuk faset ini. Jika disetel ke benar (true), posisi aspek ini di antara semua aspek dalam respons akan ditentukan secara otomatis. Jika faset dinamis diaktifkan, faset tersebut akan diurutkan bersama. Jika disetel ke salah (false), posisi aspek ini dalam respons sama seperti dalam permintaan, dan aspek ini diberi peringkat sebelum aspek dengan posisi dinamis diaktifkan dan semua aspek dinamis.

Misalnya, Anda mungkin selalu ingin aspek rating ditampilkan dalam respons, tetapi aspek rating tidak harus selalu ditampilkan di bagian atas. Dalam hal ini, Anda dapat menetapkan enableDynamicPosition ke benar (true) sehingga posisi aspek rating dalam respons ditentukan secara otomatis.

Contoh lain, dengan asumsi Anda memiliki aspek berikut dalam permintaan:

  • "rating", enableDynamicPosition = true

  • "price", enableDynamicPosition = false

  • "brands", enableDynamicPosition = false

Selain itu, Anda telah mengaktifkan faset dinamis, yang menghasilkan gender faset. Kemudian, urutan akhir faset dalam respons dapat berupa ("price", "brands", "rating", "gender") atau ("price", "brands", "gender", "rating") bergantung pada cara API mengurutkan faset "gender" dan "rating". Namun, perhatikan bahwa "price" dan "brands" selalu berada di peringkat pertama dan kedua karena enableDynamicPosition-nya adalah false.

FacetKey

Menentukan cara penghitungan aspek.

Representasi JSON 
{
  "key": string,
  "intervals": [
    {
      object (Interval)
    }
  ],
  "restrictedValues": [
    string
  ],
  "prefixes": [
    string
  ],
  "contains": [
    string
  ],
  "caseInsensitive": boolean,
  "orderBy": string
}
Kolom
key

string

Wajib. Kunci faset tekstual dan numerik yang didukung dalam objek Document, yang digunakan untuk menghitung nilai faset. Kunci facet peka huruf besar/kecil.
intervals[]

object (Interval)

Tetapkan hanya jika nilai harus dikelompokkan ke dalam interval. Harus ditetapkan untuk aspek dengan nilai numerik. Tidak boleh ditetapkan untuk faset dengan nilai teks. Jumlah interval maksimum adalah 30.
restrictedValues[]

string

Hanya mendapatkan aspek untuk nilai terbatas tertentu. Hanya didukung di kolom tekstual. Misalnya, "kategori" memiliki tiga nilai "Action > 2022", "Action > 2021", dan "Sci-Fi > 2022". Jika "restrictedValues" disetel ke "Action > 2022", faset "category" hanya berisi "Action > 2022". Hanya didukung di kolom tekstual. Maksimum adalah 10.
prefixes[]

string

Hanya dapatkan nilai aspek yang dimulai dengan awalan string tertentu. Misalnya, "kategori" memiliki tiga nilai "Action > 2022", "Action > 2021", dan "Sci-Fi > 2022". Jika "prefixes" ditetapkan ke "Action", faset "category" hanya berisi "Action > 2022" dan "Action > 2021". Hanya didukung di kolom tekstual. Maksimum adalah 10.
contains[]

string

Hanya dapatkan nilai aspek yang berisi string tertentu. Misalnya, "kategori" memiliki tiga nilai "Action > 2022", "Action > 2021", dan "Sci-Fi > 2022". Jika "contains" disetel ke "2022", faset "category" hanya berisi "Action > 2022" dan "Sci-Fi > 2022". Hanya didukung di kolom tekstual. Maksimum adalah 10.
caseInsensitive

boolean

Benar untuk membuat kunci facet tidak peka huruf besar/kecil saat mendapatkan nilai facet dengan awalan atau berisi; salah jika tidak.
orderBy

string

Urutan dokumen yang ditampilkan.

Nilai yang diperbolehkan adalah:

Jika tidak ditetapkan, nilai tekstual diurutkan dalam urutan alami; interval numerik diurutkan dalam urutan yang diberikan oleh FacetSpec.FacetKey.intervals.