REST Resource: settings.searchapplications

Resource: SearchApplication

SearchApplication

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 maksimum elemen adalah 10.

sourceConfig[]

object (SourceConfig)

Konfigurasi untuk sumber yang ditentukan dalam dataSourceRestrictions.

scoringConfig

object (ScoringConfig)

Konfigurasi untuk hasil peringkat.

defaultSortOptions

object (SortOptions)

Opsi default untuk mengurutkan hasil penelusuran

defaultFacetOptions[]

object (FacetOptions)

Bidang default untuk menampilkan hasil faset. Sumber yang disebutkan di sini juga telah disertakan di dataSourceRestrictions di atas.

returnResultThumbnailUrls

boolean

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

operationIds[]

string

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

enableAuditLog

boolean

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

queryInterpretationConfig

object (QueryInterpretationConfig)

Opsi default untuk interpretasi kueri

DataSourceRestriction

Batasan pada Sumber Data.

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

object (Source)

Sumber pembatasan.

filterOptions[]

object (FilterOptions)

Opsi filter yang membatasi hasil. Jika ada beberapa filter, filter tersebut akan dikelompokkan berdasarkan jenis objek sebelum bergabung. Filter dengan jenis objek yang sama digabungkan secara konjungtif, lalu ekspresi yang dihasilkan digabungkan secara disjungtif.

Jumlah maksimum elemen adalah 20.

CATATAN: Suggest API saat ini hanya mendukung beberapa filter: "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 standar untuk Google Apps.

Source.PredefinedSource

Sumber yang telah ditentukan sebelumnya:

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

FilterOptions

Opsi filter 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 didaftarkan dalam definisi skema. Panjang maksimum adalah 256 karakter.

filter

object (Filter)

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

Filter

Cara umum untuk 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 berupa AND atau NOT. DAN hanya dapat muncul di tingkat paling atas. OR hanya dapat muncul di bawah AND tingkat atas.

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

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 menurut properti yang cocok dengan nilai.

  2. greaterThanOperatorName atau lessThanOperatorName dalam skema Anda. Kueri memfilter hasil untuk nilai properti yang lebih besar dari atau kurang dari 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 yang dinamai. value hanya ada berupa salah satu diantara 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)

Sub-filter.

Filter.CompositeFilter.LogicOperator

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

SourceConfig

Konfigurasi untuk 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 menggunakan konfigurasi ini.

scoringConfig

object (SourceScoringConfig)

Konfigurasi penskoran untuk sumber.

crowdingConfig

object (SourceCrowdingConfig)

Konfigurasi kerumunan untuk sumber.

SourceScoringConfig

Atur konfigurasi penskoran. Hal ini memungkinkan modifikasi peringkat hasil untuk suatu sumber.

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

enum (SourceScoringConfig.SourceImportance)

Pentingnya sumber.

SourceScoringConfig.SourceImportance

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

Enum
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Tetapkan batas kerumunan hasil penelusuran. Kerumunan adalah situasi ketika beberapa hasil dari sumber atau host yang sama "memaksa" hasil lain, sehingga mengurangi kualitas penelusuran untuk pengguna. Untuk mendorong kualitas penelusuran dan keberagaman sumber yang lebih baik dalam hasil penelusuran, Anda dapat menetapkan kondisi untuk mengurangi hasil berulang berdasarkan sumber.

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

integer

Jumlah maksimum hasil 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.

ScoringConfig

Konfigurasi skor 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 peringkat. Secara default, keaktualan digunakan sebagai sinyal peringkat. Perhatikan bahwa setelan ini tidak tersedia di UI Admin.

disablePersonalization

boolean

Apakah hasil akan dipersonalisasi atau tidak. Secara default, sinyal pribadi akan digunakan untuk meningkatkan hasil.

SortOptions

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)

Menaik adalah tata urutan {i>default<i}

SortOptions.SortOrder

Enum
ASCENDING
DESCENDING

FacetOptions

Menentukan operator yang akan ditampilkan 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 yang akan digunakan 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 facet. @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 yang diberikan. Properti bilangan bulat yang sesuai dalam skema harus ditandai sebagai isFacetable. Jumlah bucket yang ditampilkan adalah jumlah minimum sebesar ini dan numFacetBuckets.

IntegerFacetingOptions

Digunakan untuk menentukan opsi facet bilangan bulat.

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

string (Int64Value format)

Bucket untuk nilai bilangan bulat tertentu harus dalam urutan menaik. Misalnya, jika nilai yang diberikan adalah (1,5,10,100), bucket facet berikut akan terbentuk {<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 interpretasi kueri dalam bahasa natural (NL), pengambilan hasil tambahan, dan penggunaan sinonim termasuk yang kustom. Jika tanda ini ditetapkan ke Benar (True), tanda ini akan lebih diutamakan daripada opsi yang ditetapkan di tingkat Kueri. Untuk nilai default False, tanda tingkat kueri akan menetapkan interpretasi yang benar untuk mode kata demi kata.

forceDisableSupplementalResults

boolean

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

Metode

create

Membuat aplikasi penelusuran.

delete

Menghapus aplikasi penelusuran.

get

Mendapatkan aplikasi penelusuran tertentu.

list

Mencantumkan semua aplikasi penelusuran.

patch

Memperbarui aplikasi penelusuran.

reset

Mereset aplikasi penelusuran ke setelan default.

update

Memperbarui aplikasi penelusuran.