- Kaynak: SearchApplication
- DataSourceRestriction
- Kaynak
- Source.PredefinedSource
- FilterOptions
- Filtrele
- Filter.ValueFilter
- Değer
- Filter.CompositeFilter
- Filter.CompositeFilter.LogicOperator
- SourceConfig
- SourceScoringConfig
- SourceScoringConfig.SourceImportance
- SourceCrowdingConfig
- ScoringConfig
- SortOptions
- SortOptions.SortOrder
- FacetOptions
- IntegerFacetingOptions
- QueryInterpretationConfig
- Yöntemler
Kaynak: SearchApplication
SearchApplication
JSON gösterimi |
---|
{ "name": string, "displayName": string, "dataSourceRestrictions": [ { object ( |
Alanlar | |
---|---|
name |
Arama Uygulaması'nın adı. Biçim: searchapplications/{applicationId}. |
displayName |
Arama Uygulaması'nın görünen adı. En çok 300 karakter kullanılabilir. |
dataSourceRestrictions[] |
Yapılandırmalara uygulanan kısıtlamalar. Maksimum öğe sayısı 10'dur. |
sourceConfig[] |
dataSourceRestrictions'da belirtilen kaynaklar için yapılandırma. |
scoringConfig |
Sonuçları sıralama yapılandırması. |
defaultSortOptions |
Arama sonuçlarını sıralamak için varsayılan seçenekler |
defaultFacetOptions[] |
Özellik sonuçları döndürmek için varsayılan alanlar. Burada belirtilen kaynaklar yukarıdaki |
returnResultThumbnailUrls |
Her sonuçla birlikte, küçük resmi için URI döndürmeliyiz (geçerli olduğunda) |
operationIds[] |
Yalnızca çıkış. Bu şema için çalışan Uzun Süreli İşlemlerin (LRO'lar) kimlikleri. Yalnızca çıkış alanı. |
enableAuditLog |
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 |
Sorgu yorumlama için varsayılan seçenekler |
DataSourceRestriction
Veri Kaynağında Kısıtlama.
JSON gösterimi |
---|
{ "source": { object ( |
Alanlar | |
---|---|
source |
Kısıtlamanın kaynağı. |
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 |
Alanlar | |
---|---|
Birleştirme alanı
|
|
name |
|
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 ( |
Alanlar | |
---|---|
objectType |
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 |
Aramayı kısıtlayan genel filtre (ör. |
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 |
Alanlar | |
---|---|
Birleştirme alanı
|
|
valueFilter |
|
compositeFilter |
|
Filter.ValueFilter
JSON gösterimi |
---|
{
"operatorName": string,
"value": {
object ( |
Alanlar | |
---|---|
operatorName |
Sorguya uygulanan
|
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 |
Alanlar | |
---|---|
Birleştirme alanı value . Adlandırılmış özelliğin değeri. value şunlardan yalnızca biri olabilir: |
|
stringValue |
|
integerValue |
|
doubleValue |
|
timestampValue |
RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: |
booleanValue |
|
dateValue |
|
Filter.CompositeFilter
JSON gösterimi |
---|
{ "logicOperator": enum ( |
Alanlar | |
---|---|
logicOperator |
Alt filtrenin mantık operatörü. |
subFilters[] |
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 ( |
Alanlar | |
---|---|
source |
Bu yapılandırmanın kullanılacağı kaynak. |
scoringConfig |
Kaynağın puanlama yapılandırması. |
crowdingConfig |
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 ( |
Alanlar | |
---|---|
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 |
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 |
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 |
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 |
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 ( |
Alanlar | |
---|---|
operatorName |
Sıralama yapılacak alana karşılık gelen operatör adı. İlgili özellik |
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 ( |
Alanlar | |
---|---|
sourceName |
Özellik açık olacak kaynak adı. Biçim: datasources/{sourceId} Boşsa tüm veri kaynakları kullanılır. |
objectType |
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 |
Özellik için seçilen operatörün adı. @cloudsearch.SchemaPropertyOptions'a bakın |
numFacetBuckets |
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 |
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[] |
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 |
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 |
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 |
|
---|---|
|
Bir arama uygulaması oluşturur. |
|
Bir arama uygulamasını siler. |
|
Belirtilen arama uygulamasını alır. |
|
Tüm arama uygulamalarını listeler. |
|
Bir arama uygulamasını günceller. |
|
Bir arama uygulamasını varsayılan ayarlarına sıfırlar. |
|
Bir arama uygulamasını günceller. |