REST Resource: settings.searchapplications

Resource: SearchApplication

Aplikasi Penelusuran

Representasi JSON
{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}
Kolom
name

string

Nama Aplikasi Penelusuran.

Format: searchapplications/{applicationId}.

displayName

string

Nama tampilan Aplikasi Penelusuran. Panjang maksimum adalah 300 karakter.

dataSourceRestrictions[]

object (DataSourceRestriction)

Batasan diterapkan ke konfigurasi. Jumlah elemen maksimum adalah 10.

sourceConfig[]

object (SourceConfig)

Konfigurasi untuk sumber yang ditentukan dalam dataSourceRestrictions.

scoringConfig

object (ScoringConfig)

Konfigurasi untuk menentukan peringkat hasil.

defaultSortOptions

object (SortOptions)

Opsi default untuk mengurutkan hasil penelusuran

defaultFacetOptions[]

object (FacetOptions)

Kolom default untuk menampilkan hasil faset. Sumber yang ditentukan di sini juga telah disertakan dalam dataSourceRestrictions di atas.

returnResultThumbnailUrls

boolean

Dengan setiap hasil, kita harus menampilkan URI untuk thumbnail-nya (jika berlaku)

operationIds[]

string

Hanya output. ID Operasi yang Berjalan Lama (LRO) yang saat ini berjalan untuk skema ini. Kolom output saja.

enableAuditLog

boolean

Menunjukkan apakah logging audit aktif/nonaktif untuk permintaan yang dibuat untuk aplikasi penelusuran di API kueri.

queryInterpretationConfig

object (QueryInterpretationConfig)

Opsi default untuk penafsiran kueri

DataSourceRestriction

Pembatasan pada Sumber Data.

Representasi JSON
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
Kolom
source

object (Source)

Sumber pembatasan.

filterOptions[]

object (FilterOptions)

Filter opsi yang membatasi hasil. Jika beberapa filter ditampilkan, filter akan dikelompokkan menurut jenis objek sebelum bergabung. Filter dengan jenis objek yang sama digabungkan secara bersamaan, lalu ekspresi yang dihasilkan digabungkan secara disjungtif.

Jumlah maksimum elemen adalah 20.

CATATAN: suggest API hanya mendukung sedikit filter saat ini: "objecttype", "type", dan "mimetype". Untuk saat ini, filter khusus skema tidak dapat digunakan untuk memfilter saran.

Sumber

Menentukan sumber untuk API saran/penelusuran.

Representasi JSON
{

  // Union field source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}
Kolom

Kolom union source.

source hanya dapat berupa salah satu dari berikut:

name

string

Nama sumber untuk konten yang diindeks oleh Indexing API.

predefinedSource

enum (Source.PredefinedSource)

Sumber konten yang telah ditetapkan untuk Google Apps.

Source.StandarSumber

Sumber standar:

Enumerasi
NONE
QUERY_HISTORY Menyarankan kueri yang dikeluarkan oleh pengguna di masa lalu. Hanya valid saat digunakan dengan API yang disarankan. Diabaikan saat digunakan di API kueri.
PERSON Menyarankan orang di organisasi. Hanya valid saat digunakan dengan API yang disarankan. Menghasilkan error saat digunakan di API kueri.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

Opsi Filter

Filter opsi yang akan diterapkan pada kueri.

Representasi JSON
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
Kolom
objectType

string

Jika objectType ditetapkan, hanya objek dari jenis tersebut yang ditampilkan. Ini harus sesuai dengan nama objek yang terdaftar dalam definisi skema. Panjang maksimum adalah 256 karakter.

filter

object (Filter)

Filter umum untuk membatasi penelusuran, seperti lang:en, site:xyz.

Filter

Cara umum mengekspresikan filter dalam kueri, yang mendukung dua pendekatan:

1. Menetapkan ValueFilter. Nama harus cocok dengan operatorName yang ditentukan dalam skema untuk sumber data Anda.

2. Menetapkan CompositeFilter. Filter dievaluasi menggunakan operator logis. Operator tingkat teratas hanya dapat menggunakan operator AND atau NOT. DAN hanya dapat muncul di tingkat yang paling atas. ATAU hanya dapat muncul di bawah DAN.

Representasi JSON
{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}
Kolom

Kolom union filter.

filter hanya dapat berupa salah satu dari berikut:

valueFilter

object (Filter.ValueFilter)

compositeFilter

object (Filter.CompositeFilter)

Filter.NilaiFilter

Representasi JSON
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
Kolom
operatorName

string

operatorName yang diterapkan ke kueri, seperti price_greater_than. Filter dapat berfungsi pada kedua jenis filter yang ditentukan dalam skema untuk sumber data Anda:

  1. operatorName, tempat kueri memfilter hasil berdasarkan properti yang cocok dengan nilai.

  2. greaterThanOperatorName atau lessThanOperatorName dalam skema Anda. Kueri memfilter hasil untuk nilai properti yang lebih besar atau lebih kecil daripada nilai yang diberikan dalam kueri.

value

object (Value)

Nilai yang akan dibandingkan.

Nilai

Definisi satu nilai dengan jenis generik.

Representasi JSON
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
Kolom
Kolom union value. Nilai properti bernama. value hanya dapat berupa salah satu dari berikut:
stringValue

string

integerValue

string (int64 format)

doubleValue

number

timestampValue

string (Timestamp format)

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

booleanValue

boolean

dateValue

object (Date)

Filter.CompositeFilter

Representasi JSON
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
Kolom
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

Operator logika sub-filter.

subFilters[]

object (Filter)

Subfilter.

Filter.CompositeFilter.LogicOperator

Enumerasi
AND Operator logika, yang hanya dapat diterapkan ke sub-filter.
OR
NOT TIDAK hanya dapat diterapkan pada satu sub-filter.

SumberKonfigurasi

Konfigurasi sumber saat memproses permintaan query.search atau query.suggest.

Representasi JSON
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
Kolom
source

object (Source)

Sumber yang akan digunakan konfigurasi ini.

scoringConfig

object (SourceScoringConfig)

Konfigurasi penskoran untuk sumber.

crowdingConfig

object (SourceCrowdingConfig)

Konfigurasi kepadatan untuk sumber.

SourceScoringConfig

Tetapkan konfigurasi skor. Hal ini memungkinkan modifikasi peringkat hasil untuk sumber.

Representasi JSON
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
Kolom
sourceImportance

enum (SourceScoringConfig.SourceImportance)

Tingkat kepentingan sumber.

SourceScoringConfig.SourcePriority

Pentingnya sumber yang dapat digunakan untuk menunjukkan apakah suatu sumber harus diberi prioritas yang lebih dalam dibandingkan dengan sumber lain.

Enumerasi
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Menetapkan batas kerumunan hasil penelusuran. Kepadatan adalah situasi di mana beberapa hasil dari sumber yang sama atau menghosting "menghabiskan" hasil lain, sehingga mengurangi kualitas penelusuran bagi pengguna. Untuk meningkatkan kualitas penelusuran dan keragaman sumber di hasil penelusuran, Anda dapat menetapkan ketentuan untuk mengurangi hasil berulang menurut sumber.

Representasi JSON
{
  "numResults": integer,
  "numSuggestions": integer
}
Kolom
numResults

integer

Jumlah hasil maksimum yang diizinkan dari sumber data di halaman hasil selama hasil dari sumber lain tidak habis. Nilai yang ditentukan tidak boleh negatif. Nilai default digunakan jika nilai ini sama dengan 0. Untuk menonaktifkan kepadatan, tetapkan nilai lebih besar dari 100.

numSuggestions

integer

Jumlah maksimum saran yang diizinkan dari sumber. Tidak ada batas yang akan ditetapkan pada hasil jika nilai ini kurang dari atau sama dengan 0.

Penskoran

Penskoran konfigurasi untuk sumber saat memproses permintaan query.search atau query.suggest.

Representasi JSON
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
Kolom
disableFreshness

boolean

Apakah akan menggunakan keaktualan sebagai sinyal penentu peringkat. Secara default, keaktualan digunakan sebagai sinyal penentu peringkat. Perhatikan bahwa setelan ini tidak tersedia di UI Admin.

disablePersonalization

boolean

Apakah akan mempersonalisasi hasil. Secara default, sinyal pribadi akan digunakan untuk meningkatkan hasil.

OpsiPengurutan

Representasi JSON
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
Kolom
operatorName

string

Nama operator yang sesuai dengan kolom yang akan diurutkan. Properti yang sesuai harus ditandai sebagai sortable.

sortOrder

enum (SortOptions.SortOrder)

Naik adalah tata urutan default

UrutkanOpsi.UrutkanPesanan

Enumerasi
ASCENDING
DESCENDING

Opsi Faset

Menentukan operator yang akan ditampilkan di hasil faset. Akan ada satu FacetResult untuk setiap kombinasi sourceName/objectType/operatorName.

Representasi JSON
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Kolom
sourceName

string

Nama sumber untuk faset. Format: datasources/{sourceId} Jika kosong, semua sumber data akan digunakan.

objectType

string

Jika objectType ditetapkan, hanya objek dari jenis tersebut yang akan digunakan untuk menghitung faset. Jika kosong, semua objek akan digunakan untuk menghitung faset.

operatorName

string

Nama operator yang dipilih untuk faset. @lihat cloudsearch.SchemaPropertyOptions

numFacetBuckets

integer

Jumlah maksimum bucket faset yang harus ditampilkan untuk faset ini. Default-nya adalah 10. Nilai maksimum adalah 100.

integerFacetingOptions

object (IntegerFacetingOptions)

Jika ditetapkan, menjelaskan opsi faset bilangan bulat untuk properti bilangan bulat tertentu. Properti bilangan bulat yang sesuai dalam skema harus ditandai isFacetable. Jumlah bucket yang ditampilkan akan menjadi minimum untuk hal ini dan numFacetBucket.

IntegerFacetingOptions

Digunakan untuk menentukan opsi faset bilangan bulat.

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

string (Int64Value format)

Bucket untuk nilai bilangan bulat tertentu harus dalam urutan menaik secara ketat. Misalnya, jika nilai yang diberikan adalah (1,5,10,100), bucket faset berikut akan dibentuk {<1, [1,5), [5-10), [10-100), >=100}.

QueryInterpretationConfig

Opsi default untuk menafsirkan kueri pengguna.

Representasi JSON
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
Kolom
forceVerbatimMode

boolean

Aktifkan tanda ini untuk menonaktifkan semua pengoptimalan internal seperti penafsiran bahasa alami (NL) pada kueri, pengambilan hasil tambahan, dan penggunaan sinonim termasuk yang khusus. Jika disetel ke Benar (True), tanda ini akan lebih diutamakan daripada opsi yang ditetapkan di tingkat Kueri. Untuk nilai default Salah, tanda tingkat kueri akan menetapkan penafsiran yang benar untuk mode kata demi kata.

forceDisableSupplementalResults

boolean

Menyetel tanda ini untuk menonaktifkan pengambilan hasil tambahan, menyetel tanda di sini tidak akan mengambil hasil tambahan untuk kueri yang terkait dengan aplikasi penelusuran tertentu. Jika disetel ke Benar (True), tanda ini akan lebih diutamakan daripada opsi yang ditetapkan di tingkat Kueri. Untuk nilai default Salah, tanda tingkat kueri akan menetapkan penafsiran yang benar untuk hasil tambahan.

Metode

create

Membuat aplikasi penelusuran.

delete

Menghapus aplikasi penelusuran.

get

Mendapatkan aplikasi penelusuran yang ditentukan.

list

Mencantumkan semua aplikasi penelusuran.

patch

Mengupdate aplikasi penelusuran.

reset

Mereset aplikasi penelusuran ke setelan default.

update

Mengupdate aplikasi penelusuran.