- JSON gösterimi
- ObjectDefinition
- ObjectOptions
- ObjectOptions.FreshnessOptions
- ObjectDisplayOptions
- ObjectDisplayOptions.Metaline
- ObjectDisplayOptions.DisplayedProperty
- PropertyDefinition
- IntegerPropertyOptions
- IntegerPropertyOptions.OrderedRanking
- IntegerPropertyOptions.IntegerOperatorOptions
- DoublePropertyOptions
- DoublePropertyOptions.DoubleOperatorOptions
- TimestampPropertyOptions
- TimestampPropertyOptions.TimestampOperatorOptions
- BooleanPropertyOptions
- BooleanPropertyOptions.BooleanOperatorOptions
- ObjectPropertyOptions
- EnumPropertyOptions
- EnumPropertyOptions.EnumValuePair
- EnumPropertyOptions.OrderedRanking
- EnumPropertyOptions.EnumOperatorOptions
- DatePropertyOptions
- DatePropertyOptions.DateOperatorOptions
- TextPropertyOptions
- RetrievalImportance
- RetrievalImportance.Importance
- TextPropertyOptions.TextOperatorOptions
- HtmlPropertyOptions
- HtmlPropertyOptions.HtmlOperatorOptions
- PropertyDisplayOptions
Bir veri kaynağının şema tanımıdır.
JSON gösterimi |
---|
{
"objectDefinitions": [
{
object ( |
Alanlar | |
---|---|
objectDefinitions[] |
Veri kaynağı için üst düzey nesnelerin listesi. Maksimum öğe sayısı 10'dur. |
operationIds[] |
Bu şema için şu anda çalışan Uzun Süreli İşlemlerin (LRO'lar) kimlikleri. Şemayı değiştirdikten sonra, ek içeriği dizine eklemeden önce işlemlerin tamamlanmasını bekleyin. |
ObjectDefinition
Bir veri kaynağındaki nesnenin tanımıdır.
JSON gösterimi |
---|
{ "name": string, "options": { object ( |
Alanlar | |
---|---|
name |
Nesnenin adı; bu ad, nesnenin türünü tanımlar. Öğe dizine ekleme istekleri, |
options |
Nesneye özgü isteğe bağlı seçenekler. |
propertyDefinitions[] |
Nesnenin özellik tanımları. Maksimum öğe sayısı 1.000'dir. |
ObjectOptions
Bir nesneye ilişkin seçenekler.
JSON gösterimi |
---|
{ "freshnessOptions": { object ( |
Alanlar | |
---|---|
freshnessOptions |
Bir nesne için güncellik seçenekleri. |
displayOptions |
Nesnenin Cloud Search sonuçlar sayfasında nasıl görüntüleneceğini belirleyen seçenekler. |
suggestionFilteringOperators[] |
Önerileri filtrelemek için kullanılabilecek operatörler. NOT: "objecttype", "type" ve "mimetype" zaten desteklenmektedir. Bu özellik, şemaya özgü operatörleri yapılandırmak içindir. Bu bir dizi olsa da yalnızca bir operatör belirtilebilir. Bu, gelecekte genişletilebilirlik için bir dizidir. Aynı nesne içinde birden çok mülkle eşleme yapan operatörler desteklenmez. Operatör farklı nesne türlerini kapsıyorsa bu seçeneğin her nesne tanımı için bir kez ayarlanması gerekir. |
ObjectOptions.FreshnessOptions
Bir öğenin arama sıralamasını ayarlarken kullanılacak güncellik özelliğini belirtir. Daha güncel ve yakın tarihler daha yüksek kaliteyi gösterir. Verileriniz için en uygun güncellik seçeneği özelliğini kullanın. Dosya paylaşımı dokümanları için son değiştirilme zamanı en alakalı olanıdır. Takvim etkinliği verilerinde, etkinliğin gerçekleşme zamanı daha alakalı bir güncellik göstergesidir. Böylece arama sorgusu zamanına daha yakın zamanda gerçekleşen takvim etkinlikleri daha kaliteli kabul edilir ve buna göre sıralanır.
JSON gösterimi |
---|
{ "freshnessProperty": string, "freshnessDuration": string } |
Alanlar | |
---|---|
freshnessProperty |
Bu özellik, dizindeki nesnenin güncellik düzeyini gösterir. Ayarlanırsa bu özellik, Güncelliği hesaplamak için bir özellik kullanıldığında bu değer varsayılan olarak şu anki tarihten 2 yıl sonrasına ayarlanır. |
freshnessDuration |
Bir nesnenin eski olarak kabul edilmesi için geçmesi gereken süredir. Varsayılan değer 180 gündür (saniye cinsinden). En fazla dokuz kesir basamağı içeren ve " |
ObjectDisplayOptions
Bir nesne için görüntüleme seçenekleri.
JSON gösterimi |
---|
{
"objectDisplayLabel": string,
"metalines": [
{
object ( |
Alanlar | |
---|---|
objectDisplayLabel |
Öğenin türünü belirtmek için arama sonucunda görüntülenecek kullanıcı dostu etiket. Bu İSTEĞE BAĞLIDIR; sağlanmazsa arama sonuçlarının bağlam satırında bir nesne etiketi görüntülenmez. Maksimum uzunluk 64 karakterdir. |
metalines[] |
Arama sonuçlarının meta satırlarında görüntülenen özellikleri tanımlar. Özellik değerleri burada verilen sırayla görüntülenir. Bir mülk birden fazla değer içeriyorsa değerlerin tamamı sonraki özelliklerden önce görüntülenir. Bu nedenle, bu listede yinelenen özelliklerden önce tekil özelliklerin belirtilmesi iyi bir uygulamadır. Tüm özellikler, |
ObjectDisplayOptions.Metaline
Metaline, bağlam bilgisi sağlamak için arama sonucuyla birlikte görüntülenen özelliklerin listesidir.
JSON gösterimi |
---|
{
"properties": [
{
object ( |
Alanlar | |
---|---|
properties[] |
Metaline için görüntülenen özelliklerin listesi. Maksimum mülk sayısı 5'tir. |
ObjectDisplayOptions.DisplayedProperty
Nesnenin içinde bulunan ve arama sonuçlarında görüntülenmesi gereken üst düzey bir mülke başvuru. Seçilen özelliklerin değerleri, belirtilmişse arama sonuçlarında o mülk için display label
ile birlikte görüntülenir. Bir görüntü etiketi belirtilmezse yalnızca değerler gösterilir.
JSON gösterimi |
---|
{ "propertyName": string } |
Alanlar | |
---|---|
propertyName |
Nesnenin özellik tanımında tanımlanan üst düzey mülkün adı. Ad, şemada tanımlı bir özellik değilse şema güncellenmeye çalışılırken hata mesajı verilir. |
PropertyDefinition
Bir nesne içindeki özelliğin tanımı.
JSON gösterimi |
---|
{ "name": string, "isReturnable": boolean, "isRepeatable": boolean, "isSortable": boolean, "isFacetable": boolean, "isSuggestable": boolean, "isWildcardSearchable": boolean, "displayOptions": { object ( |
Alanlar | |
---|---|
name |
Mülkün adı. Dizine Ekleme API'sine gönderilen öğe dizine ekleme istekleri, |
isReturnable |
Mülkün, Sorgu API'si aracılığıyla arama sonuçlarında döndürülmesi gereken verileri tanımladığını belirtir. true (doğru) olarak ayarlanması, Query API kullanıcılarının sonuçlarda eşleşen mülk alanlarını kullanabileceğini belirtir. Ancak, alanları depolamak daha fazla alan ayırma gerektirir ve arama sorguları için daha fazla bant genişliği kullanır. Bu da büyük veri kümelerinde performansı etkiler. Bu alan, yalnızca arama sonuçları için gerekliyse true değerine ayarlayın. Türü nesne olan mülkler için doğru olamaz. |
isRepeatable |
Mülk için birden çok değere izin verildiğini belirtir. Örneğin, bir dokümanın yalnızca bir açıklaması vardır, ancak birden fazla açıklaması olabilir. Türü boole olan mülkler için doğru olamaz. Yanlış değerine ayarlanırsa birden fazla değer içeren özellikler, söz konusu öğeye ilişkin dizine ekleme isteğinin reddedilmesine neden olur. |
isSortable |
Özelliğin sıralama için kullanılabileceğini belirtir. Tekrarlanabilir özellikler için doğru olamaz. Türü nesne olan mülkler için doğru olamaz. Bu seçeneği ayarlamak için IsReturnable değeri doğru olmalıdır. Yalnızca boole, tarih, çift, tamsayı ve zaman damgası özellikleri için desteklenir. |
isFacetable |
Özelliğin özellik oluşturmak için kullanılabileceğini belirtir. Türü nesne olan mülkler için doğru olamaz. Bu seçeneği ayarlamak için IsReturnable değeri doğru olmalıdır. Yalnızca boole, enum, tamsayı ve metin özellikleri için desteklenir. |
isSuggestable |
Özelliğin sorgu önerileri oluşturmak için kullanılabileceğini belirtir. |
isWildcardSearchable |
Kullanıcıların bu özellik için joker karakterle arama yapabileceğini belirtir. Yalnızca Metin özellikleri için desteklenir. Bu seçeneği ayarlamak için IsReturnable değeri doğru olmalıdır. Belirli bir veri kaynağında en fazla 5 özellik isWildcardSearchable olarak işaretlenebilir. Daha fazla ayrıntı için Nesne özelliklerini tanımlama bölümüne bakın. |
displayOptions |
Nesnenin |
property_options alanı. Mülkün nasıl dizine ekleneceğini ve kullanılacağını belirleyen türe özel seçenekler. Seçeneklerin bir tür için varsayılan seçenekler olması gereken durumlarda, bu alan yine de türlerden birine ayarlanmalıdır. Bu alan ayarlanmazsa şema güncellemeleri reddedilir. property_options şunlardan yalnızca biri olabilir: |
|
integerPropertyOptions |
|
doublePropertyOptions |
|
timestampPropertyOptions |
|
booleanPropertyOptions |
|
objectPropertyOptions |
|
enumPropertyOptions |
|
datePropertyOptions |
|
textPropertyOptions |
|
htmlPropertyOptions |
|
IntegerPropertyOptions
Tam sayı özellikleri için seçenekler.
JSON gösterimi |
---|
{ "orderedRanking": enum ( |
Alanlar | |
---|---|
orderedRanking |
Tam sayı için sıralı sıralamayı belirtmek amacıyla kullanılır. Yalnızca |
minimumValue |
Mülkün minimum değeri. Tesisin minimum ve maksimum değerleri, sonuçları |
maximumValue |
Mülkün maksimum değeri. Tesisin minimum ve maksimum değerleri, sonuçları |
operatorOptions |
Ayarlanırsa tam sayının bir arama operatörü olarak nasıl kullanılması gerektiğini açıklar. |
integerFacetingOptions |
Ayarlanırsa, belirtilen tam sayı özelliği için tam sayı özelliği seçeneklerini açıklar. İlgili tam sayı özelliği isFacetable olarak işaretlenmelidir. |
IntegerPropertyOptions.OrderedRanking
Bir tam sayı değerinin diğer değerlere göre nasıl sıralanması gerektiğini belirtmek için kullanılır. Sıralamada daha yukarıda olan bir tam sayı daha büyük öneme sahip olduğunu gösterir. Örneğin, bazı veri kaynaklarında düşük öncelik, diğerlerinde yüksek öncelik düzeyi daha yüksek öneme işaret eder.
Sıralamalar | |
---|---|
NO_ORDER |
Mülk için sıralama yoktur. Sonuçlar, bu mülkün değerine göre ayarlanmaz. |
ASCENDING |
Bu mülk, artan düzende sıralanmıştır. Düşük değerler sıralamanın düşük olduğunu gösterir. |
DESCENDING |
Bu tesis azalan düzende sıralandı. Düşük değerler sıralamanın daha yüksek olduğunu gösterir. |
IntegerPropertyOptions.IntegerOperatorOptions
Tam sayı özellikler için bir arama operatörü sağlamak üzere kullanılır. Bu isteğe bağlıdır. query.search operatörleri, kullanıcıların sorguyu aranan öğenin türüyle alakalı belirli alanlarla sınırlamasına olanak tanır.
JSON gösterimi |
---|
{ "operatorName": string, "lessThanOperatorName": string, "greaterThanOperatorName": string } |
Alanlar | |
---|---|
operatorName |
Tam sayı özelliğini izole etmek için sorguda gereken operatör adını belirtir. Örneğin, operatörünName önceliği ve mülkün adı PriorityVal ise Priority:<value> gibi sorgular yalnızca PriorityVal adlı mülkün değerinin <value> ile eşleştiği durumlarda sonuçları gösterir. Buna karşılık, operatör olmadan aynı <value> operatörünün kullanıldığı bir aramada <value> işlevi, dize özelliklerinin veya metin içindeki metin içinde bulunan metinle eşleşen tüm öğeleri döndürür. Operatör adı yalnızca küçük harfler (a-z) içerebilir. Maksimum uzunluk 32 karakterdir. |
lessThanOperatorName |
Küçüktür operatörünü kullanarak tam sayı özelliğini ayırmak için sorguda gerekli olan operatör adını belirtir. Örneğin, lessThanOperatorName öncelikli ve özelliğin adı PriorityVal ise Priorityaşağıda:<value> gibi sorgularda sonuçlar yalnızca PriorityVal adlı özelliğin değeri <value> değerinden küçük olduğunda gösterilir. Operatör adı yalnızca küçük harfler (a-z) içerebilir. Maksimum uzunluk 32 karakterdir. |
greaterThanOperatorName |
Tam sayı özelliğini büyüktür operatörünü kullanarak ayırmak için sorguda gerekli olan operatör adını belirtir. Örneğin, daha büyükThanOperatorName öncelik düzeyi ve mülkün adı PriorityVal ise öncelik:<value> gibi sorgularda sonuçlar yalnızca PriorityVal adlı özelliğin değeri <value> değerinden büyük olduğunda gösterilir. Operatör adı yalnızca küçük harfler (a-z) içerebilir. Maksimum uzunluk 32 karakterdir. |
DoublePropertyOptions
Çift mülklerle ilgili seçenekler.
JSON gösterimi |
---|
{
"operatorOptions": {
object ( |
Alanlar | |
---|---|
operatorOptions |
Ayarlanırsa, çift anahtarın bir arama operatörü olarak nasıl kullanılması gerektiğini açıklar. |
DoublePropertyOptions.DoubleOperatorOptions
Çift mülkler için arama operatörü sağlamak amacıyla kullanılır. Bu isteğe bağlıdır. query.search operatörleri, kullanıcıların sorguyu aranan öğenin türüyle alakalı belirli alanlarla sınırlamasına olanak tanır.
JSON gösterimi |
---|
{ "operatorName": string } |
Alanlar | |
---|---|
operatorName |
Çift özelliği sıralama veya özellik olarak kullanmak için sorguda gereken operatör adını belirtir. Operatör adı yalnızca küçük harfler (a-z) içerebilir. Maksimum uzunluk 32 karakterdir. |
TimestampPropertyOptions
Zaman damgası özelliklerine ilişkin seçenekler.
JSON gösterimi |
---|
{
"operatorOptions": {
object ( |
Alanlar | |
---|---|
operatorOptions |
Ayarlanırsa zaman damgasının bir arama operatörü olarak nasıl kullanılması gerektiğini açıklar. |
TimestampPropertyOptions.TimestampOperatorOptions
Zaman damgası özellikleri için bir arama operatörü sağlamak amacıyla kullanılır. Bu isteğe bağlıdır. query.search operatörleri, kullanıcıların sorguyu aranan öğenin türüyle alakalı belirli alanlarla sınırlamasına olanak tanır.
JSON gösterimi |
---|
{ "operatorName": string, "lessThanOperatorName": string, "greaterThanOperatorName": string } |
Alanlar | |
---|---|
operatorName |
Zaman damgası özelliğini ayırmak için sorguda gereken operatör adını belirtir. Örneğin, transactionName closedon ve mülkün adı closeDate ise closedon:<value> gibi sorgular, yalnızca closeDate adlı mülkün değerinin <value> ile eşleştiği durumlarda sonuçları gösterir. Buna karşılık, aynı <value> işleci olmadan aynı <value> kullanan bir arama, <value> değerinin dize özelliklerinin veya içerik içindeki metin içindeki metinle eşleştiği tüm öğeleri döndürür. Operatör adı yalnızca küçük harfler (a-z) içerebilir. Maksimum uzunluk 32 karakterdir. |
lessThanOperatorName |
Zaman damgası özelliğini "küçüktür" operatörünü kullanarak ayırmak için sorguda gerekli olan operatör adını belirtir. Örneğin, lessThanOperatorName closedbefore ve mülkün adı closeDate ise closedbefore:<value> gibi sorgular yalnızca closeDate adlı özelliğin değeri <value> değerinden önce olduğunda sonuçları gösterir. Operatör adı yalnızca küçük harfler (a-z) içerebilir. Maksimum uzunluk 32 karakterdir. |
greaterThanOperatorName |
Zaman damgası özelliğini büyüktür operatörünü kullanarak ayırmak için sorguda gerekli olan operatör adını belirtir. Örneğin, daha büyükThanOperatorName closedAfter ve mülkün adı closeDate ise closedsonra:<value> gibi sorgular yalnızca closeDate adlı özelliğin değeri <value> değerinden sonra olduğunda sonuçları gösterir. Operatör adı yalnızca küçük harfler (a-z) içerebilir. Maksimum uzunluk 32 karakterdir. |
BooleanPropertyOptions
Boole özellikleri için seçenekler.
JSON gösterimi |
---|
{
"operatorOptions": {
object ( |
Alanlar | |
---|---|
operatorOptions |
Ayarlanırsa boole'nin, arama operatörü olarak nasıl kullanılması gerektiğini açıklar. |
BooleanPropertyOptions.BooleanOperatorOptions
Boole özellikleri için bir arama operatörü sağlamak üzere kullanılır. Bu isteğe bağlıdır. query.search operatörleri, kullanıcıların sorguyu aranan öğenin türüyle alakalı belirli alanlarla sınırlamasına olanak tanır.
JSON gösterimi |
---|
{ "operatorName": string } |
Alanlar | |
---|---|
operatorName |
Boole özelliğini izole etmek için sorguda gereken operatör adını belirtir. Örneğin, transactionName closed ise ve mülkün adı isClosed ise closed:<value> gibi sorgular yalnızca isClosed adlı mülkün değerinin <value> ile eşleştiği durumlarda sonuçları gösterir. Buna karşılık, aynı <value> işleci olmadan aynı <value> kullanılan arama, <value> içeriği dize özelliklerinin içeriğindeki metin veya dize özelliklerinin değeriyle eşleşen tüm öğeleri döndürür. Operatör adı yalnızca küçük harfler (a-z) içerebilir. Maksimum uzunluk 32 karakterdir. |
ObjectPropertyOptions
Nesne özellikleriyle ilgili seçenekler.
JSON gösterimi |
---|
{
"subobjectProperties": [
{
object ( |
Alanlar | |
---|---|
subobjectProperties[] |
Alt nesnenin özellikleri. Bu özellikler iç içe yerleştirilmiş bir nesneyi temsil eder. Örneğin, bu özellik bir posta adresini temsil ediyorsa altobjectÖzellikleri street, city ve state olarak adlandırılabilir. Maksimum öğe sayısı 1.000'dir. |
EnumPropertyOptions
Kullanıcı sorgularını eşleştirmek için kısıtlanmış bir dize grubu tanımlamanıza, bu dize değerlerinin sıralamalarını ayarlamanıza ve kullanıcıların, sonuçları yalnızca belirli bir değere sahip öğelerle daraltabilmesi için bu dizelerle eşleştirilecek bir operatör adı tanımlamanıza olanak tanıyan numaralandırma özelliklerinin seçenekleri. Örneğin, öncelik bilgilerine sahip bir istek izleme sistemindeki öğeler için p0'u izin verilen bir enum değeri olarak tanımlayabilir ve bu sıralamayı öncelik operatör adına bağlayabilirsiniz. Böylece, arama kullanıcıları, sonuç grubunu yalnızca p0 değeriyle dizine eklenen öğelerle kısıtlamak için sorgularına Priority:p0 ekleyebilir.
JSON gösterimi |
---|
{ "possibleValues": [ { object ( |
Alanlar | |
---|---|
possibleValues[] |
Sıralama özelliği için olası değerlerin listesi. Tüm EnumValueEşlemeler bir dize değeri sağlamalıdır. Bir EnumValuepair için bir tam sayı değeri belirtirseniz mümkün olan tüm EnumValuepairs bir tam sayı değeri sağlamalıdır. Hem dize değeri hem de tam sayı değeri, olası tüm değerler arasında benzersiz olmalıdır. Olası değerler ayarlandıktan sonra kaldırılamaz veya değiştirilemez. Sıralı bir sıralama sağlarsanız ve gelecekte başka enum değerleri ekleyebileceğinizi düşünüyorsanız önceden kaydedilen değerler arasına değer eklenmesine olanak tanımak için ilk tam sayı değerlerinde boşluklar bırakın. Maksimum öğe sayısı 100'dür. |
orderedRanking |
Olası EnumValuepairs içinde sağlanan tam sayı değerlerinin, sonuçları sıralamak için nasıl kullanıldığını belirleyen numaralandırmanın sıralı sıralamasını belirtmek için kullanılır. Belirtilirse bu özellik için verilen olası tüm EnumValueEşleme değerleri için tam sayı değerleri sağlanmalıdır. Yalnızca |
operatorOptions |
Ayarlanırsa, numaralandırmanın bir arama operatörü olarak nasıl kullanılması gerektiğini açıklar. |
EnumPropertyOptions.EnumValuePair
Sıralama değer çifti iki şeyi tanımlar: gerekli bir dize değeri ve isteğe bağlı bir tam sayı değeri. Dize değeri, bu öğeyi almak için gereken sorgu terimini tanımlar (örneğin, öncelikli öğe için p0). Tam sayı değeri, dize değerinin aynı özellik için diğer numalandırılmış değerlere göre sıralamasını belirler. Örneğin, p0'ı 0 ile ilişkilendirebilir ve p1 ve 1 gibi başka bir enum çifti tanımlayabilirsiniz. Belirli bir değerin sıralamasını, aynı özellik adına ilişkin diğer numalandırılmış değerlere göre ayarlamak için tam sayı değerini ordered ranking
ile birlikte kullanmanız gerekir. Burada, öncelikli özellikler için DESCENDING sıralaması, p0 değeriyle dizine eklenen öğelerin, p1 değeriyle dizine eklenen öğelere kıyasla bir sıralamada yükselmesini sağlar. Sıralama sıralaması belirtilmemişse tam sayı değerinin öğe sıralaması üzerinde hiçbir etkisi olmaz.
JSON gösterimi |
---|
{ "stringValue": string, "integerValue": integer } |
Alanlar | |
---|---|
stringValue |
EnumValueValue öğesinin dize değeri. Maksimum uzunluk 32 karakterdir. |
integerValue |
EnumValuepair öğesinin negatif olmaması gereken tam sayı değeri. İsteğe bağlı. |
EnumPropertyOptions.OrderedRanking
Diğer EnumValueEşleme tam sayı değerlerine göre EnumValuePair
tam sayısının sıralama yönünü belirtmek için kullanılır. Bazı özellikler için küçük tam sayı değerleri daha yüksek önem düzeyini gösterirken, diğerlerinde yüksek tam sayı değerleri daha yüksek önem derecesini belirtir.
Sıralamalar | |
---|---|
NO_ORDER |
Mülk için sıralama yoktur. Sonuçlar bu mülkün değerine göre ayarlanmamıştır. |
ASCENDING |
Bu mülk, artan düzende sıralanmıştır. Düşük değerler sıralamanın düşük olduğunu gösterir. |
DESCENDING |
Bu tesis azalan düzende sıralandı. Düşük değerler sıralamanın daha yüksek olduğunu gösterir. |
EnumPropertyOptions.EnumOperatorOptions
Enum özellikleri için bir arama operatörü sağlamak üzere kullanılır. Bu isteğe bağlıdır. query.search operatörleri, kullanıcıların sorguyu aranan öğenin türüyle alakalı belirli alanlarla sınırlamasına olanak tanır. Örneğin, p0 ve p1 olası değerlerine sahip öncelik enum özelliği için hiçbir operatör sağlamazsanız p0 terimini içeren bir sorgu, öncelik özelliğinin değeri olarak p0 olan öğeleri ve diğer alanlarda p0 dizesini içeren öğeleri döndürür. Sıralama için öncelik gibi bir operatör adı sağlarsanız arama kullanıcıları sonuçları yalnızca öncelik:p0 sorgusuyla bu özelliğin değeri p0 olan öğelere göre hassaslaştırmak için bu operatörü kullanabilir.
JSON gösterimi |
---|
{ "operatorName": string } |
Alanlar | |
---|---|
operatorName |
Enum özelliğini izole etmek için sorguda gereken operatör adını belirtir. Örneğin, operatörünName önceliği ve mülkün adı PriorityVal ise Priority:<value> gibi sorgular yalnızca PriorityVal adlı mülkün değerinin <value> ile eşleştiği durumlarda sonuçları gösterir. Buna karşılık, operatör olmadan aynı <value> operatörünün kullanıldığı bir aramada <value> işlevi, dize özelliklerinin veya metin içindeki metin içinde bulunan metinle eşleşen tüm öğeleri döndürür. Operatör adı yalnızca küçük harfler (a-z) içerebilir. Maksimum uzunluk 32 karakterdir. |
DatePropertyOptions
Tarih özellikleriyle ilgili seçenekler.
JSON gösterimi |
---|
{
"operatorOptions": {
object ( |
Alanlar | |
---|---|
operatorOptions |
Ayarlanırsa tarihin arama operatörü olarak nasıl kullanılması gerektiğini açıklar. |
DatePropertyOptions.DateOperatorOptions
İsteğe bağlı. Tarih özellikleri için bir arama operatörü sağlar. query.search operatörleri, kullanıcıların sorguyu aranmakta olan öğenin türüyle alakalı belirli alanlarla sınırlamasına olanak tanır.
JSON gösterimi |
---|
{ "operatorName": string, "lessThanOperatorName": string, "greaterThanOperatorName": string } |
Alanlar | |
---|---|
operatorName |
Tarih özelliğini ayırmak için sorguda gereken gerçek dizeyi belirtir. Örneğin, bir sorun izleme şema nesnesinin closeDate adlı bir mülke sahip olduğunu ve bu operatörün, closedon olan bir işlecini belirttiğini varsayalım. Bu verilerle ilgili aramalarda closedon:<value> gibi sorgular, yalnızca closeDate özelliğinin değeri <value> ile eşleştiğinde sonuçları gösterir. Buna karşılık, operatör olmadan aynı <value> kullanan bir arama, <value> değerinin, dizine eklenen veri kaynağının içerik alanındaki herhangi bir Dize özelliklerinin veya metinle eşleştiği tüm öğeleri döndürür. Operatör adı yalnızca küçük harfler (a-z) içerebilir. Maksimum uzunluk 32 karakterdir. |
lessThanOperatorName |
Tarih özelliğini küçüktür operatörünü kullanarak ayırmak için sorguda gerekli olan operatör adını belirtir. Örneğin, lessThanOperatorName closedbefore ve mülkün adı closeDate ise closedbefore:<value> gibi sorgular yalnızca closeDate adlı özelliğin değeri <value> değerinden önce olduğunda sonuçları gösterir. Operatör adı yalnızca küçük harfler (a-z) içerebilir. Maksimum uzunluk 32 karakterdir. |
greaterThanOperatorName |
Tarih özelliğini büyüktür operatörünü kullanarak ayırmak için sorguda gerekli olan operatör adını belirtir. Örneğin, daha büyükThanOperatorName closedAfter ve mülkün adı closeDate ise closedsonra:<value> gibi sorgular yalnızca closeDate adlı özelliğin değeri <value> değerinden sonra olduğunda sonuçları gösterir. Operatör adı yalnızca küçük harfler (a-z) içerebilir. Maksimum uzunluk 32 karakterdir. |
TextPropertyOptions
Metin özelliklerine ilişkin seçenekler.
JSON gösterimi |
---|
{ "retrievalImportance": { object ( |
Alanlar | |
---|---|
retrievalImportance |
Alma için kullanıldığında alandaki jetonların arama kalitesi önemini belirtir. |
operatorOptions |
Ayarlanırsa mülkün bir arama operatörü olarak nasıl kullanılması gerektiğini açıklar. |
RetrievalImportance
JSON gösterimi |
---|
{
"importance": enum ( |
Alanlar | |
---|---|
importance |
Tesis alma sırasında eşleştiğinde tesise verilen sıralama önemini belirtir. Bir mülkün jeton önemi ayarlandıktan sonra değiştirilemez. |
RetrievalImportance.Importance
Sıralamalar | |
---|---|
DEFAULT |
Eşleşmeyi, gövde metni eşleşmesi gibi değerlendirin. |
HIGHEST |
Eşleşmeyi, öğenin başlığına karşı bir eşleşme gibi değerlendirin. |
HIGH |
Eşleşmeyi, gövde metninden daha önemli olacak şekilde değerlendirin. |
LOW |
Eşleşmeyi, gövde metninden daha düşük öneme sahip olacak şekilde değerlendirin. |
NONE |
Alma sırasında bu alanla eşleştirme. Bu mülk; operatör eşleştirme, özellik belirleme ve istenirse öneride bulunmaya devam edebilir. |
TextPropertyOptions.TextOperatorOptions
Metin özellikleri için bir arama operatörü sağlamak üzere kullanılır. Bu isteğe bağlıdır. query.search operatörleri, kullanıcıların sorguyu aranan öğenin türüyle alakalı belirli alanlarla sınırlamasına olanak tanır.
JSON gösterimi |
---|
{ "operatorName": string, "exactMatchWithOperator": boolean } |
Alanlar | |
---|---|
operatorName |
Metin özelliğini izole etmek için sorguda gereken operatör adını belirtir. Örneğin, operatörünName subject ve özelliğin adı subjectLine ise subject:<value> gibi sorgular yalnızca subjectLine adlı özelliğin değerinin <value> ile eşleştiği durumlarda sonuçları gösterir. Buna karşılık, operatör olmadan aynı <value> değerini kullanan bir arama, <value> öğesinin içerik alanındaki metin özelliği veya metin değeri ile eşleştiği tüm öğeleri döndürür. Operatör adı yalnızca küçük harfler (a-z) içerebilir. Maksimum uzunluk 32 karakterdir. |
exactMatchWithOperator |
Doğru ise metin değeri, operatör aramalarında ve özellik eşleşmelerinde tek bir atom değeri olarak tokenlere ayrılır. Örneğin, operatör adı "genre" (tür) ve değeri "bilim-kurgu" ise "genre:science" ve "genre:özellikler" sorgu kısıtlamaları öğeyle eşleşmez; "tür:bilim-kurgu" ile eşleşmez. Metin değeri eşleştirmesi büyük/küçük harfe duyarlıdır ve özel karakterleri kaldırmaz. False (yanlış) değerine ayarlanırsa metin jetonlara ayrılır. Örneğin, değer "bilim-kurgu" ise "genre:science" ve "genre:benzeyen" sorguları öğeyle eşleşir. |
HtmlPropertyOptions
HTML özellikleri için seçenekler.
JSON gösterimi |
---|
{ "retrievalImportance": { object ( |
Alanlar | |
---|---|
retrievalImportance |
Alma için kullanıldığında alandaki jetonların arama kalitesi önemini belirtir. Yalnızca VARSAYILAN veya YOK olarak ayarlanabilir. |
operatorOptions |
Ayarlanırsa mülkün bir arama operatörü olarak nasıl kullanılması gerektiğini açıklar. |
HtmlPropertyOptions.HtmlOperatorOptions
HTML mülkleri için bir arama operatörü sağlamak üzere kullanılır. Bu isteğe bağlıdır. query.search operatörleri, kullanıcıların sorguyu aranan öğenin türüyle alakalı belirli alanlarla sınırlamasına olanak tanır.
JSON gösterimi |
---|
{ "operatorName": string } |
Alanlar | |
---|---|
operatorName |
HTML özelliğini ayırmak için sorguda gereken operatör adını belirtir. Örneğin, operatörünAdı subject ve özelliğin adı subjectLine ise subject:<değer> gibi sorgular yalnızca subjectLine adlı özelliğin değerinin <değer> ile eşleştiği durumlarda sonuçları gösterir. Buna karşılık, operatör olmadan aynı <value> değerini kullanan bir arama, <value> işlevinin içerik alanındaki öğe alanındaki <value> değeriyle eşleşen tüm öğeleri döndürür. Operatör adı yalnızca küçük harfler (a-z) içerebilir. Maksimum uzunluk 32 karakterdir. |
PropertyDisplayOptions
Bir mülke ait görüntüleme seçenekleri.
JSON gösterimi |
---|
{ "displayLabel": string } |
Alanlar | |
---|---|
displayLabel |
Mülkün ObjectDisplayOptions içinde gösterileceği belirtilirse kullanılan kullanıcı dostu etiketidir. Sağlanırsa, mülk nesne görüntüleme seçeneklerinin bir parçası olduğunda görüntü etiketi özellik değerlerinin önünde gösterilir. Örneğin, özellik değeri "1" ise değer tek başına kullanıcı için yararlı bir bağlam olmayabilir. Verilen görünen ad "öncelik" ise kullanıcı, arama sonuçlarında "öncelik : 1" ifadesini görür ve bu, arama kullanıcılarına net bağlam sağlar. Bu İSTEĞE BAĞLIDIR; sağlanmamışsa yalnızca özellik değerleri gösterilir. Maksimum uzunluk 64 karakterdir. |