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'de 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ını döndürmek için varsayılan alanlar. Burada belirtilen kaynaklar yukarıdaki dataSourceRestrictions maddesine de dahil edilmiştir.
returnResultThumbnailUrls

boolean

Her sonuçla birlikte, küçük resmi için URI'yı döndürmemiz gerekir (varsa)
operationIds[]

string

Yalnızca çıkış. Bu şema için şu anda ç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üğünün açık/kapalı olup olmadığını belirtir.
queryInterpretationConfig

object (QueryInterpretationConfig)

Sorgu yorumlama için varsayılan seçenekler

DataSourceRestriction

Veri Kaynağı Kısıtlaması.

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

object (Source)

Kısıtlama kaynağı.
filterOptions[]

object (FilterOptions)

Sonuçları kısıtlayan filtre seçenekleri. Birden fazla filtre varsa bunlar birleştirmeden önce nesne türüne göre gruplandırılır. Aynı nesne türüne sahip filtreler birlikte birleştirilir, ardından sonuçta ortaya çıkan ifadeler ayrık bir şekilde birleştirilir.

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

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

Kaynak

Öneri/arama API'leri için kaynakları 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

source alanı.

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 Kullanıcı tarafından geçmişte verilen sorguları önerir. Yalnızca öneri API'si ile 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'si ile birlikte kullanıldığında geçerlidir. Sorgu API'sinde kullanıldığında hata oluşur.
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, şemanın tanımı dahilinde kaydedilen nesnenin adına karşılık gelmelidir. Maksimum uzunluk 256 karakterdir.
filter

object (Filter)

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

Filtre

Bir sorguda filtreleri ifade etmenin genel bir yolu. Bu yöntem, iki yaklaşımı destekler:

1. Bir Değer Filtresi ayarlama. Ad, veri kaynağınızın şemasında tanımlanan operatörle eşleşmelidir.

2. Bir 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 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

filter alanı.

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 operatorName uygulandı (ör. price_greater_than). Filtre, veri kaynağınızın şemasında tanımlanan 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ğerlerinin sonuçlarını filtreler.
value

object (Value)

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

Değer

Genel türle 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
value alanı. Adlandırılan özelliğin değeri. value şunlardan yalnızca biri olabilir:
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

Nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağına sahip, 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ı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 NOT 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)

Kaynak için dışlama yapılandırması.

SourceScoringConfig

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

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

enum (SourceScoringConfig.SourceImportance)

Kaynağın önemi.

SourceScoringConfig.SourceImportance

Bir kaynağa başka bir kaynağa kıyasla sıralamada daha fazla öncelik verilmesi gerekip gerekmediğini belirtmek için kullanılabilen bir kaynağın önemi.

Sıralamalar
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Arama sonuçları için dış yükleme sınırları belirleyin. Sonuçlandırma, aynı kaynaktan gelen birden fazla sonucun veya diğer sonuçların "kalabalığı" barındırmasına neden olarak kullanıcılar için aramanın kalitesini düşürdüğü bir durumdur. Arama sonuçlarında daha iyi arama kalitesini ve kaynak çeşitliliğini artırmak için kaynağa göre 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. Dışlamaları 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çlarda sınır ayarlanmaz.

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ğını belirler. Varsayılan olarak yenilik, sıralama sinyali olarak kullanılır. Bu ayarın Yönetici arayüzünde kullanıma sunulmadığını hatırlatmak isteriz.
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ün adı. İlgili özellik sortable olarak işaretlenmelidir.
sortOrder

enum (SortOptions.SortOrder)

Varsayılan sıralama düzeninde artan düzen kullanılır

SortOptions.SortOrder

Sıralamalar
ASCENDING
DESCENDING

FacetOptions

Özellik sonuçları döndürülecek operatörleri belirtir. Her sourceName/objectType/operatorName kombinasyonu için bir FacetResult olacaktır.

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

string

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

string

ObjectType ayarlanırsa özellikleri hesaplamak için yalnızca bu türdeki nesneler kullanılır. Boş bırakılırsa özellikleri hesaplamak için tüm nesneler kullanılır.
operatorName

string

Özellik için seçilen operatörün adı. @cloudsearch'e bakın.Schema PropertyOptions
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 tam sayı özelliği için tam sayı özelliği seçeneklerini açıklar. Şemadaki karşılık gelen tam sayı özelliği isFacetable olarak işaretlenmelidir. Döndürülen paket sayısı en az bu ve numFacetBuckets olur.

IntegerFacetingOptions

Tam sayı özelliği 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 tam olarak artan düzende olmalıdır. Örneğin, sağlanan değerler (1,5,10,100) ise aşağıdaki façeta paketleri oluşturulur {<1, [1,5), [5-10), [10-100), >=100}.

QueryInterpretationConfig

Kullanıcı sorgusunun yorumlanması 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ç alma ve özel olanlar da dahil 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. False (Yanlış) adlı varsayılan değer için sorgu düzeyinde flag, 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 ayarladığınızda belirli bir arama uygulamasıyla ilişkili sorgular için ek sonuçlar alınmaz. Bu işaret, Doğru değerine ayarlanırsa Sorgu düzeyinde ayarlanan seçeneğe göre öncelikli olur. False varsayılan değeri için sorgu düzeyindeki işaret, ek sonuçlar için doğru yorumlamayı ayarlar.

Yöntemler

create

 Bir arama uygulaması oluşturur.

delete

 Bir arama uygulamasını siler.

get

 Belirtilen arama uygulamasını getirir.

list

 Tüm arama uygulamalarını listeler.

patch

 Bir arama uygulamasını günceller.

reset

 Arama uygulamasını varsayılan ayarlarına sıfırlar.

update

 Bir arama uygulamasını günceller.