REST Resource: settings.searchapplications

Sumber daya: 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 yang diterapkan pada 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 ada)
operationIds[]

string

Hanya output. ID Operasi yang Berjalan Lama (LLO) yang saat ini berjalan untuk skema ini. Kolom hanya output.
enableAuditLog

boolean

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

object (QueryInterpretationConfig)

Opsi default untuk interpretasi kueri

DataSourceRestriction

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

CATATAN: Suggest API hanya mendukung beberapa filter pada 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 yang berikut:
name

string

Nama sumber untuk konten yang diindeks oleh Indexing API.
predefinedSource

enum (Source.PredefinedSource)

Sumber konten yang telah ditentukan sebelumnya untuk Google Apps.

Source.PredefinedSource

Sumber yang telah ditetapkan sebelumnya:

Enum
NONE
QUERY_HISTORY Menyarankan kueri yang dikeluarkan oleh pengguna sebelumnya. Hanya valid jika digunakan dengan API saran. Diabaikan saat digunakan dalam query API.
PERSON Menyarankan orang di organisasi. Hanya valid jika digunakan dengan API saran. Menghasilkan error saat digunakan dalam query API.
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. Hal 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. AND hanya dapat muncul di tingkat yang paling atas. OR hanya dapat muncul di bawah AND tingkat teratas.

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 yang 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 digunakan 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 bernama. value hanya dapat berupa salah satu dari berikut:
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

Stempel waktu dalam 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 pada sub-filter.
OR
NOT TIDAK hanya dapat diterapkan pada satu sub-filter.

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 tempat konfigurasi ini akan digunakan.
scoringConfig

object (SourceScoringConfig)

Konfigurasi penskoran untuk sumber.
crowdingConfig

object (SourceCrowdingConfig)

Konfigurasi kerumunan untuk sumber.

SourceScoringConfig

Tetapkan konfigurasi penskoran. Tindakan 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 suatu sumber harus diberikan prioritas yang lebih tinggi dalam peringkat dibandingkan dengan sumber lain.

Enum
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Menyetel batas keramaian hasil penelusuran. Keramaian ({i>crowd out<i}) adalah situasi ketika beberapa hasil dari sumber atau {i>host<i} yang sama melakukan “{i>crowd out<i}” hasil lainnya, sehingga mengurangi kualitas penelusuran pengguna. Untuk mendorong kualitas penelusuran dan keberagaman sumber yang lebih baik di hasil penelusuran, Anda dapat menetapkan kondisi 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 kerumunan, setel nilai yang lebih besar dari 100.
numSuggestions

integer

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

ScoringConfig

Konfigurasi penskoran 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 akan mempersonalisasi hasil. 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 terkait 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 menampilkan 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 diberi faset. Format: sumber data/{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 maksimumnya adalah 100.
integerFacetingOptions

object (IntegerFacetingOptions)

Jika ditetapkan, menjelaskan opsi facet bilangan bulat untuk properti bilangan bulat yang diberikan. Properti bilangan bulat yang sesuai dalam skema harus ditandai isFacetable. Jumlah bucket yang ditampilkan akan minimal sebesar ini dan numFacetBuckets.

IntegerFacetingOptions

Digunakan untuk menentukan opsi faset bilangan bulat.

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

string (Int64Value format)

Bucket untuk nilai bilangan bulat yang diberikan harus dalam urutan menaik. Misalnya, jika nilai yang diberikan adalah (1,5,10,100), bucket faset 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 penafsiran bahasa alami (NL) kueri, pengambilan hasil tambahan, dan penggunaan sinonim termasuk yang kustom. Jika ditetapkan ke True, tanda ini akan diprioritaskan di atas opsi yang ditetapkan di tingkat Kueri. Untuk nilai default Salah (False), tanda tingkat kueri akan menetapkan penafsiran 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 tertentu. Jika ditetapkan ke True, tanda ini akan diprioritaskan di atas opsi yang ditetapkan di tingkat Kueri. Untuk nilai default Salah (False), 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

 Memperbarui aplikasi penelusuran.

reset

 Mereset aplikasi penelusuran ke setelan default.

update

 Memperbarui aplikasi penelusuran.