REST Resource: projects.locations.corpora.searchConfigs

Resource: SearchConfig

SearchConfig menyimpan berbagai properti yang akan memengaruhi perilaku penelusuran dan hasil penelusuran.

Representasi JSON 
{
  "name": string,
  "facetProperty": {
    object (FacetProperty)
  },
  "searchCriteriaProperty": {
    object (SearchCriteriaProperty)
  }
}
Kolom
name

string

Nama resource konfigurasi penelusuran. Untuk CustomSearchCriteria, searchConfig akan menjadi nama operator penelusuran. Untuk Faset, searchConfig akan menjadi nama dimensi faset. Formulir: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{searchConfig}
facetProperty

object (FacetProperty)

Menetapkan FacetDimension dan spesifikasi terkait.
searchCriteriaProperty

object (SearchCriteriaProperty)

Membuat pemetaan antara SearchCriteria kustom dan satu atau beberapa kunci UGA.

FacetProperty

Konfigurasi pusat untuk suatu aspek.

Representasi JSON 
{
  "mappedFields": [
    string
  ],
  "displayName": string,
  "resultSize": string,
  "bucketType": enum (FacetBucketType),

  // Union field range_facet_config can be only one of the following:
  "fixedRangeBucketSpec": {
    object (FixedRangeBucketSpec)
  },
  "customRangeBucketSpec": {
    object (CustomRangeBucketSpec)
  },
  "datetimeBucketSpec": {
    object (DateTimeBucketSpec)
  }
  // End of list of possible types for union field range_facet_config.
}
Kolom
mappedFields[]

string

Nama faset, yang merupakan dimensi yang ingin digunakan pengguna untuk menyaring hasil penelusuran. mappedFields akan cocok dengan kunci UserSpecifiedDataSchema.

Misalnya, pengguna dapat menambahkan banyak UGA dengan kunci yang sama, seperti player:adam, player:bob, player:charles. Jika beberapa mappedFields ditentukan, nilainya akan digabungkan sebagai nilai facet akhir. Misalnya, home_team: a, home_team:b, away_team:a, away_team:c, jika facet_field = [home_team, away_team], facet_value akan menjadi [a, b, c].

KECUALI jika ini adalah dimensi facet 1:1 (mappedFields.size() == 1) DAN mapped_field sama dengan SearchConfig.name induk, induk juga harus berisi SearchCriteriaProperty yang dipetakan ke kolom yang sama. mappedFields tidak boleh kosong.
displayName

string

Nama tampilan faset. Untuk digunakan oleh UI untuk rendering faset.
resultSize

string (int64 format)

Jumlah maksimum bucket unik yang akan ditampilkan untuk satu faset. Jumlah bucket dapat besar untuk faset berkardinalitas tinggi seperti "pemain". Kami hanya menampilkan n teratas yang paling relevan kepada pengguna. Jika <= 0, server akan menentukan resultSize yang sesuai.
bucketType

enum (FacetBucketType)

Jenis bucket faset, misalnya nilai, rentang.

Kolom union range_facet_config.

range_facet_config hanya dapat berupa salah satu dari hal berikut:
fixedRangeBucketSpec

object (FixedRangeBucketSpec)

Konfigurasi bucket facet rentang tetap.
customRangeBucketSpec

object (CustomRangeBucketSpec)

Konfigurasi bucket aspek rentang kustom.
datetimeBucketSpec

object (DateTimeBucketSpec)

Konfigurasi bucket aspek rentang waktu.

FixedRangeBucketSpec

Jika jenis bucket adalah FIXED_RANGE, tentukan cara nilai dikelompokkan. Gunakan FixedRangeBucketSpec jika Anda ingin membuat beberapa bucket dengan tingkat perincian yang sama. Menggunakan nilai bucket bilangan bulat sebagai contoh, jika bucketStart = 0, bucketGranularity = 10, bucketCount = 5, aspek ini akan digabungkan melalui bucket berikut: [-inf, 0), [0, 10), [10, 20), [20, 30), [30, inf). Secara khusus, bucketCount <= 1 adalah spesifikasi yang tidak valid.

Representasi JSON 
{
  "bucketStart": {
    object (FacetValue)
  },
  "bucketGranularity": {
    object (FacetValue)
  },
  "bucketCount": integer
}
Kolom
bucketStart

object (FacetValue)

Batas bawah bucket. CATATAN: Saat ini hanya jenis bilangan bulat yang didukung untuk kolom ini.
bucketGranularity

object (FacetValue)

Perincian bucket. CATATAN: Saat ini hanya jenis bilangan bulat yang didukung untuk kolom ini.
bucketCount

integer

Jumlah total bucket.

FacetValue

Definisi satu nilai dengan jenis generik.

Representasi JSON 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "datetimeValue": {
    object (DateTime)
  }
  // End of list of possible types for union field value.
}
Kolom

Kolom union value.

value hanya dapat berupa salah satu dari hal berikut:
stringValue

string

Nilai jenis string.
integerValue

string (int64 format)

Nilai jenis bilangan bulat.
datetimeValue

object (DateTime)

Nilai jenis DateTime.

CustomRangeBucketSpec

Jika jenis bucket adalah CUSTOM_RANGE, tentukan cara nilai dikelompokkan. Gunakan nilai bucket bilangan bulat sebagai contoh, jika endpoint adalah 0, 10, 100, dan 1.000, kita akan membuat facet berikut: [-inf, 0), [0, 10), [10, 100), [100, 1000), [1000, inf). Terutama: - endpoint harus dicantumkan dalam urutan menaik. Jika tidak, SearchConfig API akan menolak konfigurasi facet. - < 1 endpoint adalah spesifikasi yang tidak valid.

Representasi JSON 
{
  "endpoints": [
    {
      object (FacetValue)
    }
  ]
}
Kolom
endpoints[]

object (FacetValue)

Saat ini, hanya jenis bilangan bulat yang didukung untuk kolom ini.

DateTimeBucketSpec

Jika jenis bucket adalah DATE, tentukan cara pengelompokan nilai tanggal.

Representasi JSON 
{
  "granularity": enum (Granularity)
}
Kolom
granularity

enum (Granularity)

Perincian aspek jenis tanggal.

Perincian

Enum perincian untuk bucket tanggal dan waktu.

Enum
GRANULARITY_UNSPECIFIED Perincian tidak ditentukan.
YEAR Perinciannya adalah tahun.
MONTH Perinciannya adalah bulan.
DAY Perinciannya adalah hari.

FacetBucketType

Berbagai jenis untuk bucket facet.

Enum
FACET_BUCKET_TYPE_UNSPECIFIED Jenis tidak ditentukan.
FACET_BUCKET_TYPE_VALUE Jenis nilai.
FACET_BUCKET_TYPE_DATETIME Jenis tanggal/waktu.
FACET_BUCKET_TYPE_FIXED_RANGE Jenis Rentang Tetap.
FACET_BUCKET_TYPE_CUSTOM_RANGE Jenis Rentang Kustom.

SearchCriteriaProperty

Konfigurasi terpusat untuk kriteria penelusuran kustom.

Representasi JSON 
{
  "mappedFields": [
    string
  ]
}
Kolom
mappedFields[]

string

Setiap kolom yang dipetakan sesuai dengan kunci UGA. Untuk memahami cara kerja properti ini, perhatikan contoh berikut. Di tabel SearchConfig, pengguna menambahkan entri ini: searchConfig { name: "person" searchCriteriaProperty { mappedFields: "player" mappedFields: "coach" } }

Sekarang, saat pengguna mengeluarkan kueri seperti: criteria { field: "person" textArray { txtValues: "Tom Brady" txtValues: "Bill Belichick" } }

Penelusuran MWH akan menampilkan dokumen penelusuran dengan (player=Tom Brady || coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick).

Metode

create

 Membuat konfigurasi penelusuran di dalam korpus.

delete

 Menghapus konfigurasi penelusuran di dalam korpus.

get

 Mendapatkan konfigurasi penelusuran di dalam korpus.

list

 Mencantumkan semua konfigurasi penelusuran di dalam korpus.

patch

 Memperbarui konfigurasi penelusuran di dalam korpus.