REST Resource: settings.searchapplications

Kaynak: SearchApplication

SearchApplication

JSON gösterimi
{
  "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)
  }
}
Alanlar
name

string

Arama Uygulaması'nın adı.

Biçim: searchapplications/{applicationId}.

displayName

string

Arama Uygulaması'nın görünen adı. En çok 300 karakter kullanılabilir.

dataSourceRestrictions[]

object (DataSourceRestriction)

Yapılandırmalara uygulanan kısıtlamalar. Maksimum öğe sayısı 10'dur.

sourceConfig[]

object (SourceConfig)

dataSourceRestrictions'da belirtilen kaynaklar için yapılandırma.

scoringConfig

object (ScoringConfig)

Sonuçları sıralama yapılandırması.

defaultSortOptions

object (SortOptions)

Arama sonuçlarını sıralamak için varsayılan seçenekler

defaultFacetOptions[]

object (FacetOptions)

Özellik sonuçları döndürmek için varsayılan alanlar. Burada belirtilen kaynaklar yukarıdaki dataSourceRestrictions bölümüne de dahil edilmiştir.

returnResultThumbnailUrls

boolean

Her sonuçla birlikte, küçük resmi için URI döndürmeliyiz (geçerli olduğunda)

operationIds[]

string

Yalnızca çıkış. Bu şema için çalışan Uzun Süreli İşlemlerin (LRO'lar) kimlikleri. Yalnızca çıkış alanı.

enableAuditLog

boolean

Sorgu API'lerinde arama uygulaması için yapılan istekler için denetleme günlük kaydının açık/kapalı olduğunu belirtir.

queryInterpretationConfig

object (QueryInterpretationConfig)

Sorgu yorumlama için varsayılan seçenekler

DataSourceRestriction

Veri Kaynağında Kısıtlama.

JSON gösterimi
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
Alanlar
source

object (Source)

Kısıtlamanın kaynağı.

filterOptions[]

object (FilterOptions)

Sonuçları kısıtlayan filtre seçenekleri. Birden fazla filtre varsa birleştirme işleminden önce nesne türüne göre gruplandırılır. Aynı nesne türüne sahip filtreler bağlı olarak birleştirilir. Daha sonra elde edilen ifadeler ayrı olarak birleştirilir.

Maksimum öğe sayısı 20'dir.

NOT: Suggest API şu anda yalnızca birkaç filtreyi desteklemektedir: "objecttype", "type" ve "mimetype" özelliklerini içerir. Şimdilik, önerileri filtrelemek için şemaya özel filtreler kullanılamaz.

Kaynak

Öneri/arama API'lerinin kaynaklarını tanımlar.

JSON gösterimi
{

  // 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.
}
Alanlar

Birleştirme alanı source.

source şunlardan yalnızca biri olabilir:

name

string

Indexing API tarafından dizine eklenen içeriğin kaynak adı.

predefinedSource

enum (Source.PredefinedSource)

Google Apps için önceden tanımlanmış içerik kaynağı.

Source.PredefinedSource

Önceden tanımlanmış kaynaklar:

Sıralamalar
NONE
QUERY_HISTORY Geçmişte kullanıcı tarafından yapılan sorguları önerir. Yalnızca öneri API'siyle birlikte kullanıldığında geçerlidir. Sorgu API'sinde kullanıldığında yoksayılır.
PERSON Kuruluştaki kullanıcıları önerir. Yalnızca öneri API'siyle birlikte kullanıldığında geçerlidir. Sorgu API'sinde kullanıldığında hatayla sonuçlanır.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

Sorguya uygulanacak filtre seçenekleri.

JSON gösterimi
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
Alanlar
objectType

string

Nesne Türü ayarlanırsa yalnızca bu türdeki nesneler döndürülür. Bu ad, şemanın tanımı dahilinde kaydedilen nesnenin adına karşılık gelmelidir. En çok 256 karakter kullanılabilir.

filter

object (Filter)

Aramayı kısıtlayan genel filtre (ör. lang:en, site:xyz).

Filtre

Bir sorguda filtreleri ifade etmek için iki yaklaşımı destekleyen genel bir yöntem:

1. Değer Filtresi oluşturma. Ad, veri kaynağınızın şemasında tanımlanan bir operatorName ile eşleşmelidir.

2. CompositeFilter ayarlama. Filtreler mantıksal operatör kullanılarak değerlendirilir. Üst düzey operatörler yalnızca AND veya NOT olabilir. VE yalnızca en üst düzeyde görünebilir. VEYA yalnızca üst düzey bir VE altında görünebilir.

JSON gösterimi
{

  // 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.
}
Alanlar

Birleştirme alanı filter.

filter şunlardan yalnızca biri olabilir:

valueFilter

object (Filter.ValueFilter)

compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

JSON gösterimi
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
Alanlar
operatorName

string

Sorguya uygulanan operatorName (ör. price_greater_than) Filtre, veri kaynağınızın şemasında tanımlanan her iki filtre türüyle de çalışabilir:

  1. operatorName. Burada sorgu, sonuçları değerle eşleşen mülke göre filtreler.

  2. Şemanızda greaterThanOperatorName veya lessThanOperatorName. Sorgu, sorguda sağlanan değerden büyük veya küçük olan özellik değerleri için sonuçları filtreler.

value

object (Value)

Karşılaştırılacak değer.

Değer

Genel tür içeren tek bir değerin tanımı.

JSON gösterimi
{

  // 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.
}
Alanlar
Birleştirme alanı value. Adlandırılmış özelliğin değeri. value şunlardan yalnızca biri olabilir:
stringValue

string

integerValue

string (int64 format)

doubleValue

number

timestampValue

string (Timestamp format)

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

booleanValue

boolean

dateValue

object (Date)

Filter.CompositeFilter

JSON gösterimi
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
Alanlar
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

Alt filtrenin mantık operatörü.

subFilters[]

object (Filter)

Alt filtreler.

Filter.CompositeFilter.LogicOperator

Sıralamalar
AND Yalnızca alt filtrelere uygulanabilen mantıksal operatörler.
OR
NOT DEĞİL, yalnızca tek bir alt filtreye uygulanamaz.

SourceConfig

query.search veya query.suggest isteğini işlerken kaynak için yapılan yapılandırmalar.

JSON gösterimi
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
Alanlar
source

object (Source)

Bu yapılandırmanın kullanılacağı kaynak.

scoringConfig

object (SourceScoringConfig)

Kaynağın puanlama yapılandırması.

crowdingConfig

object (SourceCrowdingConfig)

Kaynağın dışlama yapılandırması.

SourceScoringConfig

Puanlama yapılandırmasını ayarlayın. Bu, bir kaynağa ait sonuçların sıralamasının değiştirilmesine olanak tanır.

JSON gösterimi
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
Alanlar
sourceImportance

enum (SourceScoringConfig.SourceImportance)

Kaynağın önemi.

SourceScoringConfig.SourceImportance

Sıralamada bir kaynağa başka bir kaynağa göre daha fazla öncelik verilmesi gerekip gerekmediğini göstermek için kullanılabilen kaynağın önemi.

Sıralamalar
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Arama sonuçları dışlama sınırlarını ayarlayabilirsiniz. Dışlama, aynı kaynaktan veya sunucudan birden fazla sonucun "kalabalığa karışması"dır. diğer sonuçlarla birlikte kullanıcılar için arama kalitesini düşürür. Arama sonuçlarında daha iyi arama kalitesi ve kaynak çeşitliliği sağlamak için, yinelenen sonuçları kaynağa göre azaltacak bir koşul belirleyebilirsiniz.

JSON gösterimi
{
  "numResults": integer,
  "numSuggestions": integer
}
Alanlar
numResults

integer

Diğer kaynaklardan gelen sonuçlar tükenmediği sürece, sonuç sayfasında bir veri kaynağından izin verilen maksimum sonuç sayısı. belirtilen değer negatif olmamalıdır. Bu değer 0'a eşitse varsayılan değer kullanılır. Dışlamayı devre dışı bırakmak için değeri 100'den büyük olacak şekilde ayarlayın.

numSuggestions

integer

Bir kaynaktan izin verilen maksimum öneri sayısı. Bu değer 0'dan küçük veya 0'a eşitse sonuçlar için herhangi bir sınır ayarlanmaz.

ScoringConfig

query.search veya query.suggest isteğini işlerken bir kaynak için puanlama yapılandırmaları.

JSON gösterimi
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
Alanlar
disableFreshness

boolean

Güncelliğin bir sıralama sinyali olarak kullanılıp kullanılmayacağını belirler. Güncellik varsayılan olarak bir sıralama sinyali olarak kullanılır. Bu ayarın Yönetici arayüzünde kullanıma sunulmadığını hatırlatırız.

disablePersonalization

boolean

Sonuçların kişiselleştirilip kişiselleştirilmeyeceğini belirler. Varsayılan olarak, sonuçları iyileştirmek için kişisel sinyaller kullanılır.

SortOptions

JSON gösterimi
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
Alanlar
operatorName

string

Sıralama yapılacak alana karşılık gelen operatör adı. İlgili özellik sortable olarak işaretlenmelidir.

sortOrder

enum (SortOptions.SortOrder)

Varsayılan sıralama ölçütü artan düzendir

SortOptions.SortOrder

Sıralamalar
ASCENDING
DESCENDING

FacetOptions

Façeta sonuçlarını döndürecek operatörleri belirtir. Her sourceName/objectType/operatorName kombinasyonu için bir FacetResult olur.

JSON gösterimi
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Alanlar
sourceName

string

Özellik açık olacak kaynak adı. Biçim: datasources/{sourceId} Boşsa tüm veri kaynakları kullanılır.

objectType

string

Nesne Türü ayarlanırsa façetaları hesaplamak için yalnızca o türdeki nesneler kullanılır. Boşsa, özellikleri hesaplamak için tüm nesneler kullanılır.

operatorName

string

Özellik için seçilen operatörün adı. @cloudsearch.SchemaPropertyOptions'a bakın

numFacetBuckets

integer

Bu özellik için döndürülmesi gereken maksimum özellik paketi sayısı. Varsayılan olarak 10 değerine ayarlanır. Maksimum değer 100'dür.

integerFacetingOptions

object (IntegerFacetingOptions)

Ayarlanırsa belirtilen tamsayı özelliği için tamsayı özellik seçeneklerini açıklar. Şemada karşılık gelen tamsayı özelliği isFacetable olarak işaretlenmelidir. Döndürülen paket sayısı en az bu ve numFacetBuckets olur.

IntegerFacetingOptions

Tam sayı özellik seçeneklerini belirtmek için kullanılır.

JSON gösterimi
{
  "integerBuckets": [
    string
  ]
}
Alanlar
integerBuckets[]

string (Int64Value format)

Verilen tam sayı değerleri için paketler, kesinlikle artan sırada olmalıdır. Örneğin sağlanan değerler (1,5,10,100) ise aşağıdaki özellik grupları {<1, [1,5), [5-10), [10-100), >=100} şeklinde oluşturulur.

QueryInterpretationConfig

Kullanıcı sorgusunu yorumlamak için varsayılan seçenekler.

JSON gösterimi
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
Alanlar
forceVerbatimMode

boolean

Sorguların doğal dil (NL) yorumlanması, ek sonuçların alınması ve özel olanlar da dahil olmak üzere eş anlamlıların kullanımı gibi tüm dahili optimizasyonları kapatmak için bu işareti etkinleştirin. Bu işaret, Doğru değerine ayarlanırsa Sorgu düzeyinde ayarlanan seçeneğe göre öncelikli olur. Varsayılan False değeri için sorgu düzeyi işareti, aynen mod için doğru yorumlamayı ayarlar.

forceDisableSupplementalResults

boolean

Bu işareti, ek sonuçların alınmasını devre dışı bırakmak için ayarlayın. Burada bir işaret ayarlamak, belirli bir arama uygulamasıyla ilişkili sorgular için ek sonuçları almaz. Bu işaret, Doğru değerine ayarlanırsa Sorgu düzeyinde ayarlanan seçeneğe göre öncelikli olur. Sorgu düzeyindeki işaret, varsayılan False değeri için ek sonuçlarda doğru yorumlamayı ayarlar.

Yöntemler

create

Bir arama uygulaması oluşturur.

delete

Bir arama uygulamasını siler.

get

Belirtilen arama uygulamasını alır.

list

Tüm arama uygulamalarını listeler.

patch

Bir arama uygulamasını günceller.

reset

Bir arama uygulamasını varsayılan ayarlarına sıfırlar.

update

Bir arama uygulamasını günceller.