- 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'de 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ını döndürmek için varsayılan alanlar. Burada belirtilen kaynaklar yukarıdaki |
returnResultThumbnailUrls |
Her sonuçla birlikte, küçük resmi için URI'yı döndürmemiz gerekir (varsa) |
operationIds[] |
Yalnızca çıkış. Bu şema için şu anda ç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üğünün açık/kapalı olup olmadığını belirtir. |
queryInterpretationConfig |
Sorgu yorumlama için varsayılan seçenekler |
DataSourceRestriction
Veri Kaynağı Kısıtlaması.
JSON gösterimi |
---|
{ "source": { object ( |
Alanlar | |
---|---|
source |
Kısıtlama kaynağı. |
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 |
Alanlar | |
---|---|
|
|
name |
|
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 ( |
Alanlar | |
---|---|
objectType |
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 |
Aramayı kısıtlamak için genel filtre (ör. |
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 |
Alanlar | |
---|---|
|
|
valueFilter |
|
compositeFilter |
|
Filter.ValueFilter
JSON gösterimi |
---|
{
"operatorName": string,
"value": {
object ( |
Alanlar | |
---|---|
operatorName |
Sorguya
|
value |
Karşılaştırılacak değer. |
Değer
Genel türle tek bir değerin tanımı.
JSON gösterimi |
---|
{ // Union field |
Alanlar | |
---|---|
value alanı. Adlandırılan özelliğin değeri. value şunlardan yalnızca biri olabilir: |
|
stringValue |
|
integerValue |
|
doubleValue |
|
timestampValue |
Nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağına sahip, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Ö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 |
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 ( |
Alanlar | |
---|---|
source |
Bu yapılandırmanın kullanılacağı kaynak. |
scoringConfig |
Kaynağın puanlama yapılandırması. |
crowdingConfig |
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 ( |
Alanlar | |
---|---|
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 |
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 |
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 |
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 |
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ün adı. İlgili özellik |
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 ( |
Alanlar | |
---|---|
sourceName |
Özellik için kullanılacak kaynak adı. Biçim: datasources/{sourceId} Boşsa tüm veri kaynakları kullanılır. |
objectType |
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 |
Özellik için seçilen operatörün adı. @cloudsearch'e bakın.Schema PropertyOptions |
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 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[] |
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 |
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 |
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 |
|
---|---|
|
Bir arama uygulaması oluşturur. |
|
Bir arama uygulamasını siler. |
|
Belirtilen arama uygulamasını getirir. |
|
Tüm arama uygulamalarını listeler. |
|
Bir arama uygulamasını günceller. |
|
Arama uygulamasını varsayılan ayarlarına sıfırlar. |
|
Bir arama uygulamasını günceller. |