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ı. Maksimum uzunluk 300 karakterdir.
dataSourceRestrictions[]

object (DataSourceRestriction)

Yapılandırmalara kısıtlamalar uygulanır. Maksimum öğe sayısı 10'dur.
sourceConfig[]

object (SourceConfig)

dataSourceRestrictions parametresinde belirtilen kaynakların yapılandırması.
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ını döndürmek için varsayılan alanlar. Burada belirtilen kaynaklar, yukarıdaki dataSourceRestrictions alanına da eklenmiştir.
returnResultThumbnailUrls

boolean

Her sonuçla birlikte, küçük resminin URI'sini (varsa) döndürmemiz gerekir.
operationIds[]

string

Yalnızca çıkış. Şu anda bu şema için çalışan uzun süreli işlemlerin (LROs) kimlikleri. Yalnızca çıkış alanı.
enableAuditLog

boolean

Sorgu API'lerinde arama uygulaması için yapılan istekler için denetleme günlüğünün etkin olup olmadığını 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 bunlar birleştirilmeden önce nesne türüne göre gruplandırılır. Aynı nesne türüne sahip filtreler birleşik olarak birleştirilir, ardından ortaya çıkan ifadeler ayrık olarak birleştirilir.

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

NOT: Öner API şu anda yalnızca birkaç filtreyi desteklemektedir: "objecttype", "type" ve "mimetype". Önerileri filtrelemek için şu anda şemaya özgü filtreler kullanılamaz.

Kaynak

Öner/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

Birlik alanı source.

source yalnızca aşağıdakilerden 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 Kullanıcının geçmişte gönderdiği sorguları önerir. Yalnızca suggest API ile birlikte kullanıldığında geçerlidir. Sorgu API'sinde kullanıldığında yok sayılır.
PERSON Kuruluştaki kullanıcıları önerir. Yalnızca suggest API ile birlikte kullanıldığında geçerlidir. Sorgu API'sinde kullanıldığında hata verir.
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

objectType ayarlanırsa yalnızca bu türdeki nesneler döndürülür. Bu, şema tanımında kayıtlı nesnenin adıyla eşleşmelidir. Maksimum uzunluk 256 karakterdir.
filter

object (Filter)

Aramayı kısıtlamak için kullanılan genel filtre (ör. lang:en, site:xyz).

Filtre

Sorgudaki filtreleri ifade etmenin genel bir yoludur ve iki yaklaşımı destekler:

1. ValueFilter ayarlama Ad, veri kaynağınızın şemasında tanımlanan bir operatorName ile eşleşmelidir.

2. Bir CompositeFilter ayarlama. Filtreler mantıksal operatör kullanılarak değerlendirilir. Üst düzey operatörler yalnızca VEYA veya DEĞİL olabilir. VE yalnızca en üst düzeyde görünebilir. VEYA yalnızca üst düzey bir VEYA 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

Birlik alanı filter.

filter yalnızca aşağıdakilerden 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 için şemada tanımlanan her iki filtre türüyle de çalışabilir:

  1. operatorName, burada sorgu sonuçları değeri eşleşen özelliğe göre filtreler.

  2. greaterThanOperatorName veya lessThanOperatorName değerini kullanabilirsiniz. Sorgu, sonuçlarda sorgudaki sağlanan değerden daha büyük veya daha küçük mülk değerlerini filtreler.
value

object (Value)

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

Değer

Genel türe sahip 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
Birlik alanı value. Adlandırılmış özelliğin değeri. value yalnızca aşağıdakilerden biri olabilir:
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

Nanosaniye çözünürlüğüne sahip ve en fazla dokuz kesirli basamak içeren RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Ö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ıksal 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 uygulanabilir.

SourceConfig

query.search veya query.suggest isteği işlenirken bir kaynak için 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 tıkanıklık yapılandırması.

SourceScoringConfig

Puanlama yapılandırmasını ayarlayın. Bu sayede bir kaynağın sonuçlarının sıralamasını değiştirebilirsiniz.

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

enum (SourceScoringConfig.SourceImportance)

Kaynağın önemi.

SourceScoringConfig.SourceImportance

Bir kaynağın sıralamada diğerine kıyasla daha fazla öncelik verilip verilmeyeceğini belirtmek için kullanılabilen kaynağın önemi.

Sıralamalar
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Arama sonuçlarının tıklanabilirliğini sınırlayın. Sıkışıklık, aynı kaynaktan veya barındırıcıdan gelen birden fazla sonucun diğer sonuçları "sıkıştırması" ve kullanıcılar için arama kalitesini düşürmesi durumudur. Arama sonuçlarında daha iyi arama kalitesi ve kaynak çeşitliliği sağlamak için kaynak bazında yinelenen sonuçları 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 bir sonuç sayfasındaki 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. Sonuç yükleme sınırını devre dışı bırakmak için değeri 100'den büyük bir değere 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 sınır belirlenmez.

ScoringConfig

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

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

boolean

Güncelliğin sıralama sinyali olarak kullanılıp kullanılmayacağı. Güncellilik, varsayılan olarak bir sıralama sinyali olarak kullanılır. Bu ayarın Yönetici kullanıcı arayüzünde kullanılamadığını unutmayın.
disablePersonalization

boolean

Sonuçların kişiselleştirilip kişiselleştirilmeyeceği. 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ün adı. İlgili mülk sortable olarak işaretlenmelidir.
sortOrder

enum (SortOptions.SortOrder)

Varsayılan sıralama düzeni artan düzendir.

SortOptions.SortOrder

Sıralamalar
ASCENDING
DESCENDING

FacetOptions

Hangi operatörlerin özellik sonuçları döndüreceğini 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

Ayrıştırılacak kaynak adı. Biçim: datasources/{sourceId} Boşsa tüm veri kaynakları kullanılır.
objectType

string

objectType ayarlanırsa yalnızca bu türdeki nesneler yönleri hesaplamak için kullanılır. Boşsa tüm nesneler yönleri hesaplamak için kullanılır.
operatorName

string

Kelime öbeğine ayırma için seçilen operatörün adı. @see cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

Bu yön için döndürülecek maksimum yön paketi sayısı. Varsayılan olarak 10 değerine ayarlanır. Maksimum değer 100'dür.
integerFacetingOptions

object (IntegerFacetingOptions)

Ayarlanırsa, belirtilen tam sayı özelliği için tam sayı kırma seçeneklerini açıklar. Şemada ilgili tam sayı özelliği isFacetable olarak işaretlenmelidir. Döndürülen paket sayısı, bu değer ile numFacetBuckets değerinin minimumudur.

IntegerFacetingOptions

Tam sayı boyutlandırma seçeneklerini belirtmek için kullanılır.

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

string (Int64Value format)

Belirli tam sayı değerleri için kaplar kesinlikle artan düzende olmalıdır. Örneğin, sağlanan değerler (1,5,10,100) ise aşağıdaki yön kümeleri oluşturulur: {<1, [1,5), [5-10), [10-100), >=100}.

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) yorumu, ek sonuçların alınması ve özel olanlar da dahil olmak üzere eş anlamlı kelimelerin kullanımı gibi tüm dahili optimizasyonları devre dışı bırakmak için bu işareti etkinleştirin. Bu işaret True (Doğru) değerine ayarlanırsa sorgu düzeyinde ayarlanan seçenekten öncelikli olur. Varsayılan değer False (Yanlış) ise sorgu düzeyindeki işaret, tam metin modu için doğru yorumu ayarlar.
forceDisableSupplementalResults

boolean

Ek sonuçların alınmasını devre dışı bırakmak için bu işareti ayarlayın. Burada bir işaret ayarlamak, belirli bir arama uygulamasıyla ilişkili sorgular için ek sonuçlar getirmez. Bu işaret True (Doğru) değerine ayarlanırsa sorgu düzeyinde ayarlanan seçenekten öncelikli olur. Varsayılan değer False olduğunda sorgu düzeyindeki işaretçi, ek sonuçlar için doğru yorumu 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 ayarlara sıfırlar.

update

 Bir arama uygulamasını günceller.