- ייצוג JSON
- 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
הגדרת הסכימה של מקור נתונים.
ייצוג JSON |
---|
{
"objectDefinitions": [
{
object ( |
שדות | |
---|---|
objectDefinitions[] |
רשימת האובייקטים ברמה העליונה של מקור הנתונים. מספר הרכיבים המקסימלי הוא 10. |
operationIds[] |
מזהים של פעולות ממושכות (LRO) שפועלות כרגע עבור הסכימה הזו. אחרי שמשנים את הסכימה, צריך להמתין עד לסיום הפעולות לפני שמוסיפים תוכן נוסף לאינדקס. |
ObjectDefinition
ההגדרה של אובייקט בתוך מקור נתונים.
ייצוג JSON |
---|
{ "name": string, "options": { object ( |
שדות | |
---|---|
name |
שם האובייקט, שמגדיר את סוג האובייקט. בבקשות להוספת פריטים לאינדקס, צריך להגדיר את השדה |
options |
האפשרויות האופציונליות הספציפיות לאובייקט. |
propertyDefinitions[] |
הגדרות המאפיין של האובייקט. מספר הרכיבים המקסימלי הוא 1,000. |
ObjectOptions
האפשרויות של אובייקט.
ייצוג JSON |
---|
{ "freshnessOptions": { object ( |
שדות | |
---|---|
freshnessOptions |
אפשרויות העדכניות של אובייקט. |
displayOptions |
האפשרויות שקובעות איך האובייקט יוצג בדף התוצאות ב-Cloud Search. |
suggestionFilteringOperators[] |
אופרטורים שאפשר להשתמש בהם כדי לסנן הצעות. עבור API מסוג הערה: כבר יש תמיכה ב-"objecttype", ב-"type" וב-"mimetype". הנכס הזה משמש להגדרת אופרטורים ספציפיים לסכימה. למרות שזהו מערך, אפשר לציין רק אופרטור אחד. זהו מערך להרחבה עתידי. אין תמיכה באופרטורים שממפים לנכסים מרובים בתוך אותו אובייקט. אם האופרטור משתרע על פני סוגי אובייקטים שונים, יש להגדיר את האפשרות הזו פעם אחת לכל הגדרת אובייקט. |
ObjectOptions.FreshnessOptions
מציין באיזה מאפיין עדכניות להשתמש כשמשנים את דירוג החיפוש של פריט. תאריכים עדכניים יותר מעידים על איכות גבוהה יותר. כדאי להשתמש במאפיין אפשרות הרענון המתאים ביותר לנתונים שלכם. במסמכי שיתוף קבצים, מועד השינוי האחרון הוא הרלוונטי ביותר. כשמדובר בנתונים של אירועים ביומן, השעה שבה האירוע מתרחש היא מדד רלוונטי יותר של עדכניות. כך, אירועים ביומן שמתרחשים בסמוך למועד שבו שאילתת החיפוש נחשבים איכותיים יותר ומדורגים בהתאם.
ייצוג JSON |
---|
{ "freshnessProperty": string, "freshnessDuration": string } |
שדות | |
---|---|
freshnessProperty |
המאפיין הזה מציין את רמת הרענון של האובייקט באינדקס. אם המאפיין מוגדר, המאפיין הזה חייב להיות נכס ברמה העליונה בתוך כשנכס משמש לחישוב עדכניות, ערך ברירת המחדל הוא שנתיים מהזמן הנוכחי. |
freshnessDuration |
משך הזמן שאחריו האובייקט נחשב לא פעיל. ערך ברירת המחדל הוא 180 ימים (בשניות). משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, המסתיים ב-' |
ObjectDisplayOptions
אפשרויות התצוגה של אובייקט.
ייצוג JSON |
---|
{
"objectDisplayLabel": string,
"metalines": [
{
object ( |
שדות | |
---|---|
objectDisplayLabel |
תווית ידידותית למשתמש שיש להציג בתוצאת החיפוש כדי לציין את סוג הפריט. הפרט הזה אופציונלי. אם הוא לא סופק, תווית אובייקט לא תוצג בשורת ההקשר של תוצאות החיפוש. האורך המקסימלי הוא 64 תווים. |
metalines[] |
מגדירה את המאפיינים שיוצגו במטא-לינות של תוצאות החיפוש. ערכי המאפיינים מוצגים לפי הסדר שנקבע כאן. אם לנכס יש כמה ערכים, כל הערכים מוצגים לפני הנכסים הבאים. לכן, מומלץ לציין מאפיינים בודדים לפני מאפיינים שחוזרים על עצמם ברשימה זו. בכל המאפיינים צריך להגדיר את |
ObjectDisplayOptions.Metaline
מטאלין היא רשימה של מאפיינים שמוצגים יחד עם תוצאת החיפוש כדי לספק הקשר.
ייצוג JSON |
---|
{
"properties": [
{
object ( |
שדות | |
---|---|
properties[] |
רשימת המאפיינים המוצגים עבור המטא-ליין. מספר הנכסים המקסימלי הוא 5. |
ObjectDisplayOptions.DisplayedProperty
הפניה לנכס ברמה עליונה בתוך האובייקט שצריך להציג בתוצאות החיפוש. הערכים של המאפיינים שנבחרו מוצגים בתוצאות החיפוש יחד עם הערך display label
של אותו מאפיין, אם מצוין אחד מהם. אם לא צוינה תווית לתצוגה, יוצגו רק הערכים.
ייצוג JSON |
---|
{ "propertyName": string } |
שדות | |
---|---|
propertyName |
שם המאפיין ברמה העליונה כפי שמוגדר בהגדרת המאפיין של האובייקט. אם השם אינו מאפיין מוגדר בסכימה, תתקבל שגיאה במהלך הניסיון לעדכן את הסכימה. |
PropertyDefinition
ההגדרה של מאפיין בתוך אובייקט.
ייצוג JSON |
---|
{ "name": string, "isReturnable": boolean, "isRepeatable": boolean, "isSortable": boolean, "isFacetable": boolean, "isSuggestable": boolean, "isWildcardSearchable": boolean, "displayOptions": { object ( |
שדות | |
---|---|
name |
שם הנכס. בבקשות להוספה לאינדקס של פריטים שנשלחות לממשק ה-API ליצירת אינדקס, צריך להגדיר את |
isReturnable |
מציין שהנכס מזהה נתונים שצריכים להיות מוחזרים בתוצאות חיפוש דרך Query API. אם הוא מוגדר כ-true, המשמעות היא שמשתמשי ה-API של השאילתה יכולים להשתמש בשדות המאפיינים התואמים בתוצאות. עם זאת, אחסון שדות מחייב הקצאת מקום רב יותר ושימוש ברוחב פס גדול יותר לשאילתות חיפוש, ויש לכך השפעה על הביצועים במערכי נתונים גדולים. יש להגדיר כאן את הערך true רק אם השדה נדרש להצגת תוצאות חיפוש. לא יכול להיות נכון לגבי מאפיינים שהסוג שלהם הוא אובייקט. |
isRepeatable |
מציין שמותר להשתמש במספר ערכים עבור המאפיין. לדוגמה: למסמך יש רק תיאור אחד אבל יכולות להיות לו מספר תגובות. הערך לא יכול להיות true לנכסים שהסוג שלהם הוא בוליאני. אם המדיניות מוגדרת כ-False, מאפיינים שמכילים יותר מערך אחד יגרמו לדחיית הבקשה להוספה לאינדקס של הפריט. |
isSortable |
מציין שהמאפיין יכול לשמש למיון. הערך לא יכול להיות true למאפיינים שחוזרים על עצמם. לא יכול להיות נכון לגבי מאפיינים שהסוג שלהם הוא אובייקט. כדי להגדיר את האפשרות הזו, הערך של IsReturnable חייב להיות True. נתמך רק במאפיינים בוליאניים, תאריך, כפול, מספר שלם וחותמת זמן. |
isFacetable |
מציין שאפשר להשתמש בנכס כדי ליצור מאפיינים. לא יכול להיות נכון לגבי מאפיינים שהסוג שלהם הוא אובייקט. כדי להגדיר את האפשרות הזו, הערך של IsReturnable חייב להיות True. נתמך רק במאפיינים בוליאניים, טיפוסים בני מנייה (enum), מספר שלם (integer) ומאפייני טקסט (text). |
isSuggestable |
מציין שניתן להשתמש בנכס כדי ליצור הצעות לשאילתות. |
isWildcardSearchable |
האפשרות מציינת שמשתמשים יכולים לבצע חיפוש עם תווים כלליים לחיפוש בנכס הזה. נתמך רק במאפייני טקסט. כדי להגדיר את האפשרות הזו, הערך של IsReturnable חייב להיות True. במקור נתונים נתון אפשר לסמן עד 5 נכסים כ-isWildcardSearchable. פרטים נוספים זמינים במאמר הגדרת מאפייני אובייקט. |
displayOptions |
האפשרויות שקובעות איך הנכס יוצג בדף התוצאות של Cloud Search, אם הוא מוגדר להצגה ב- |
שדה איחוד property_options . האפשרויות הספציפיות לסוג שקובעות איך הנכס יתווסף לאינדקס ואיך ייעשה בו שימוש. אם האפשרויות הן אפשרויות ברירת המחדל של סוג מסוים, השדה הזה עדיין צריך להיות מוגדר כאחד מהסוגים. אם לא תגדירו את השדה הזה, עדכוני סכימה יידחו. הערך של property_options יכול להיות רק אחת מהאפשרויות הבאות: |
|
integerPropertyOptions |
|
doublePropertyOptions |
|
timestampPropertyOptions |
|
booleanPropertyOptions |
|
objectPropertyOptions |
|
enumPropertyOptions |
|
datePropertyOptions |
|
textPropertyOptions |
|
htmlPropertyOptions |
|
IntegerPropertyOptions
האפשרויות למאפיינים של מספרים שלמים.
ייצוג JSON |
---|
{ "orderedRanking": enum ( |
שדות | |
---|---|
orderedRanking |
משמש לציון הדירוג הסדור של המספר השלם. ניתן להשתמש במאפיין רק אם הערך של |
minimumValue |
הערך המינימלי של הנכס. ערכי המינימום והמקסימום של הנכס משמשים לדירוג תוצאות לפי |
maximumValue |
הערך המקסימלי של הנכס. ערכי המינימום והמקסימום של הנכס משמשים לדירוג תוצאות לפי |
operatorOptions |
אם הוגדר, מתאר כיצד יש להשתמש במספר השלם כאופרטור חיפוש. |
integerFacetingOptions |
אם השדה מוגדר, מתאר את האפשרויות למיקוד לפי מספרים שלמים למאפיין הנתון של מספר שלם. המאפיין של המספר השלם המתאים צריך להיות מסומן כ-isFacetable. |
IntegerPropertyOptions.OrderedRanking
משמש לציון האופן שבו יש לדרג ערך של מספר שלם ביחס לערכים אחרים. מספר שלם עם דירוג גבוה יותר מרמז על חשיבות גבוהה יותר. לדוגמה: בחלק ממקורות הנתונים, עדיפות נמוכה יותר מצביעה על חשיבות גבוהה יותר. לעומת זאת, באחרים עדיפות גבוהה יותר מצביעה על חשיבות גבוהה יותר.
טיפוסים בני מנייה (enums) | |
---|---|
NO_ORDER |
אין סדר דירוג לנכס. התוצאות לא משתנות לפי הערך של הנכס הזה. |
ASCENDING |
הנכס הזה מדורג בסדר עולה. ערכים נמוכים יותר מציינים דירוג נמוך יותר. |
DESCENDING |
הנכס הזה מדורג בסדר יורד. ערכים נמוכים יותר מציינים דירוג גבוה יותר. |
IntegerPropertyOptions.IntegerOperatorOptions
משמש לציון אופרטור חיפוש במאפיינים של מספרים שלמים. זוהי אפשרות אופציונלית. אופרטורים של query.search מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים הרלוונטיים לסוג הפריט שבו מתבצע החיפוש.
ייצוג JSON |
---|
{ "operatorName": string, "lessThanOperatorName": string, "greaterThanOperatorName": string } |
שדות | |
---|---|
operatorName |
מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין המספר השלם. לדוגמה, אם המפעיל keyName הוא priority ושם המאפיין הוא priorityVal, אז שאילתות כמו priority:<value> יציגו תוצאות רק כאשר ערך המאפיין ששמו priorityVal תואם ל-<value>. לעומת זאת, חיפוש שמשתמש באותו <value> ללא אופרטור יחזיר את כל הפריטים שבהם <value> תואם את הערך של המאפיין כלשהו במחרוזת או את הערך שלו. שם האופרטור יכול להכיל אותיות קטנות בלבד (a-z). האורך המקסימלי הוא 32 תווים. |
lessThanOperatorName |
מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין המספר השלם באמצעות האופרטור 'פחות מ-'. לדוגמה, אם הפרמטר defaultThanOperatorName הוא priority below ושם הנכס הוא priorityVal, אז שאילתות כמו priority below:<value> יציגו תוצאות רק שבהן ערך הנכס בשם priorityVal נמוך מ-<value>. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים. |
greaterThanOperatorName |
מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין המספר השלם באמצעות האופרטור 'גדול מ-'. לדוגמה, אם הפרמטר largeThanOperatorName הוא priority above ושם המאפיין הוא priorityVal, אז שאילתות כמו priorityabove:<value> יציגו תוצאות רק שבהן ערך המאפיין priorityVal גדול מ-<value>. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים. |
DoublePropertyOptions
האפשרויות לנכסים כפולים.
ייצוג JSON |
---|
{
"operatorOptions": {
object ( |
שדות | |
---|---|
operatorOptions |
אם הוגדר, מתאר כיצד יש להשתמש בכפולה כאופרטור חיפוש. |
DoublePropertyOptions.DoubleOperatorOptions
משמש להצגת אופרטור חיפוש לנכסים כפולים. זוהי אפשרות אופציונלית. אופרטורים של query.search מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים הרלוונטיים לסוג הפריט שבו מתבצע החיפוש.
ייצוג JSON |
---|
{ "operatorName": string } |
שדות | |
---|---|
operatorName |
מציין את שם האופרטור שנדרש בשאילתה כדי להשתמש במאפיין הכפול במיון או בתור היבט. שם האופרטור יכול להכיל אותיות קטנות בלבד (a-z). האורך המקסימלי הוא 32 תווים. |
TimestampPropertyOptions
האפשרויות למאפיינים של חותמת זמן.
ייצוג JSON |
---|
{
"operatorOptions": {
object ( |
שדות | |
---|---|
operatorOptions |
אם היא מוגדרת, מתואר איך יש להשתמש בחותמת הזמן כאופרטור חיפוש. |
TimestampPropertyOptions.TimestampOperatorOptions
משמש להצגת אופרטור חיפוש למאפיינים של חותמות זמן. זוהי אפשרות אופציונלית. אופרטורים של query.search מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים הרלוונטיים לסוג הפריט שבו מתבצע החיפוש.
ייצוג JSON |
---|
{ "operatorName": string, "lessThanOperatorName": string, "greaterThanOperatorName": string } |
שדות | |
---|---|
operatorName |
מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין חותמת הזמן. לדוגמה, אם searchName הוא closedon ושם המאפיין הוא closeDate, שאילתות כמו closeon:<value> יציגו תוצאות רק שבהן הערך של המאפיין בשם closeDate תואם ל-<value>. לעומת זאת, חיפוש שמשתמש באותו <value> בלי אופרטור יחזיר את כל הפריטים שבהם <value> תואם לערך של מאפיין מחרוזת כלשהו או טקסט כלשהו בשדה התוכן של השדה התוכן. שם האופרטור יכול להכיל אותיות קטנות בלבד (a-z). האורך המקסימלי הוא 32 תווים. |
lessThanOperatorName |
מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין חותמת הזמן באמצעות האופרטור 'פחות מ-'. לדוגמה, אם defaultThanOperatorName הוא closedbefore ושם הנכס closeDate, שאילתות כמו closedbefore:<value> יוצגו תוצאות רק כאשר ערך הנכס בשם closeDate מוקדם יותר מ-<value>. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים. |
greaterThanOperatorName |
מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין חותמת הזמן באמצעות האופרטור 'גדול מ-'. לדוגמה, אם LargeThanOperatorName הוא closedafter ושם הנכס הוא closeDate, שאילתות כמו closedafter:<value> יציג תוצאות רק כאשר ערך הנכס בשם closeDate מאוחר יותר מ-<value>. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים. |
BooleanPropertyOptions
האפשרויות של נכסים בוליאניים.
ייצוג JSON |
---|
{
"operatorOptions": {
object ( |
שדות | |
---|---|
operatorOptions |
אם הוא מוגדר, מתאר את האופן שבו יש להשתמש בערך הבוליאני כאופרטור חיפוש. |
BooleanPropertyOptions.BooleanOperatorOptions
משמש לספק אופרטור חיפוש לנכסים בוליאניים. זוהי אפשרות אופציונלית. אופרטורים של query.search מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים הרלוונטיים לסוג הפריט שבו מתבצע החיפוש.
ייצוג JSON |
---|
{ "operatorName": string } |
שדות | |
---|---|
operatorName |
מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את הנכס הבוליאני. לדוגמה, אם keyName סגור ושם הנכס isClosed, אז שאילתות כמו closed:<value> יוצגו תוצאות רק שבהן ערך הנכס בשם isClosed תואם ל-<value>. לעומת זאת, חיפוש עם אותו <value> בלי אופרטור יחזיר את כל הפריטים שבהם <value> תואם לערך של מאפייני מחרוזת או טקסט מסוימים בשדה התוכן של הפריט. שם האופרטור יכול להכיל אותיות קטנות בלבד (a-z). האורך המקסימלי הוא 32 תווים. |
ObjectPropertyOptions
האפשרויות של מאפייני האובייקט.
ייצוג JSON |
---|
{
"subobjectProperties": [
{
object ( |
שדות | |
---|---|
subobjectProperties[] |
המאפיינים של אובייקט המשנה. המאפיינים האלה מייצגים אובייקט בתוך אובייקט. לדוגמה, אם הנכס הזה מייצג כתובת למשלוח דואר, השמות של הפרמטרים המשניים יכולים להיות street , city ו-state. מספר הרכיבים המקסימלי הוא 1,000. |
EnumPropertyOptions
האפשרויות של מאפייני טיפוסים בני מנייה (enum) מאפשרות להגדיר קבוצה מוגבלת של מחרוזות כך שיתאימו לשאילתות של משתמשים, להגדיר דירוגים לערכי המחרוזת האלו ולהגדיר שם אופרטור שיקושר למחרוזות האלה, כדי שהמשתמשים יוכלו לצמצם את התוצאות רק לפריטים בעלי ערך ספציפי. לדוגמה, עבור פריטים במערכת למעקב אחר בקשות עם נתוני עדיפות, אפשר להגדיר את p0 כערך טיפוסים מותר של טיפוסים בני מנייה (enum) ולקשור את המספר הזה לשם האופרטור priority. כך המשתמשים יוכלו להוסיף לשאילתה שלהם את priority:p0, וכך להגביל את קבוצת התוצאות רק לפריטים שנוספו לאינדקס עם הערך p0.
ייצוג JSON |
---|
{ "possibleValues": [ { object ( |
שדות | |
---|---|
possibleValues[] |
רשימת הערכים האפשריים למאפיין המספור. כל EnumValuePairs חייב לספק ערך מחרוזת. אם מציינים ערך של מספר שלם ל-EnumValuePair אחד, כל ערכי EnumValuePairs האפשריים חייבים לספק ערך של מספר שלם. גם ערך המחרוזת וגם הערך של המספר השלם חייבים להיות ייחודיים בכל הערכים האפשריים. לאחר שמגדירים ערכים אפשריים, אי אפשר להסיר או לשנות אותם. אם אתם מספקים דירוג מסודר וחושבים שבעתיד אולי תוסיפו עוד ערכי טיפוסים בני מנייה (enum), השאירו פערים בערכים של המספרים השלמים הראשוניים כדי לאפשר הוספה של ערך בין הערכים שנרשמו בעבר. מספר הרכיבים המקסימלי הוא 100. |
orderedRanking |
משמש לציון הדירוג הסדור של המספור הקובע את השימוש של ערכי המספרים השלמים שמופיעים ב-EnumValuePairs לדירוג התוצאות. אם צוינו, חובה לספק ערכים של מספרים שלמים לכל ערכי EnumValuePair שניתנו למאפיין הזה. ניתן להשתמש במאפיין רק אם הערך של |
operatorOptions |
אם הוא מוגדר, מתאר את האופן שבו יש להשתמש ב-טיפוסים בני מנייה (enum) כאופרטור חיפוש. |
EnumPropertyOptions.EnumValuePair
צמד ערכי המספור מגדיר שני דברים: ערך מחרוזת נדרש וערך מספר שלם אופציונלי. ערך המחרוזת מגדיר את מונח השאילתה הנדרש כדי לאחזר את הפריט, למשל p0 עבור פריט בעדיפות גבוהה. ערך המספר השלם קובע את הדירוג של ערך המחרוזת הזה ביחס לערכים ספירה אחרים עבור אותו נכס. לדוגמה, אפשר לשייך את p0 ל-0 ולהגדיר צמד אחר של טיפוסים בני מנייה (enum), כמו p1 ו-1. צריך להשתמש בערך של המספר השלם בשילוב עם ordered ranking
כדי לקבוע את הדירוג של ערך נתון ביחס לערכים נקובים אחרים לאותו שם מאפיין. במקרה הזה, סדר הדירוג של DESCENDING בנכסים ברמת עדיפות מוביל לעלייה בדירוג של פריטים שנוספו לאינדקס עם הערך p0, בהשוואה לפריטים שנוספו לאינדקס עם הערך p1. ללא סדר דירוג מוגדר, לערך המספר השלם אין השפעה על דירוג הפריטים.
ייצוג JSON |
---|
{ "stringValue": string, "integerValue": integer } |
שדות | |
---|---|
stringValue |
ערך המחרוזת של EnumValuePair. האורך המקסימלי הוא 32 תווים. |
integerValue |
הערך השלם של EnumValuePair חייב להיות לא שלילי. אפשרות. |
EnumPropertyOptions.OrderedRanking
משמש לציון כיוון הדירוג של מספר שלם EnumValuePair
ביחס לערכים שלמים אחרים ב-EnumValuePair. במאפיינים מסוימים, ערכים נמוכים יותר של מספרים שלמים מציינים חשיבות גבוהה יותר, בעוד שבנכסים אחרים מספר שלם גבוה יותר מצביע על חשיבות גבוהה יותר.
טיפוסים בני מנייה (enums) | |
---|---|
NO_ORDER |
אין סדר דירוג לנכס. הערך של הנכס הזה לא משנה את התוצאות. |
ASCENDING |
הנכס הזה מדורג בסדר עולה. ערכים נמוכים יותר מציינים דירוג נמוך יותר. |
DESCENDING |
הנכס הזה מדורג בסדר יורד. ערכים נמוכים יותר מציינים דירוג גבוה יותר. |
EnumPropertyOptions.EnumOperatorOptions
משמש לספק אופרטור חיפוש למאפייני טיפוסים בני מנייה (enum). זוהי אפשרות אופציונלית. אופרטורים של query.search מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים הרלוונטיים לסוג הפריט שבו מתבצע החיפוש. לדוגמה, אם לא תספקו אופרטור למאפיין 'טיפוסים בני מנייה (enum)' בעדיפות גבוהה, עם הערכים האפשריים p0 ו-p1, שאילתה שתכלול את המונח p0 תחזיר פריטים שהערך שלהם הוא p0 כערך של המאפיין priority, וכן פריטים שמכילים את המחרוזת p0 בשדות אחרים. אם תספקו שם אופרטור של טיפוסים בני מנייה (enum), למשל עדיפות, משתמשי החיפוש יוכלו להשתמש באופרטור הזה כדי לצמצם את התוצאות רק לפריטים שהערך של המאפיין p0 שלהם הוא p0, עם השאילתה priority:p0.
ייצוג JSON |
---|
{ "operatorName": string } |
שדות | |
---|---|
operatorName |
מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את המאפיין 'טיפוסים בני מנייה (enum)'. לדוגמה, אם המפעיל keyName הוא priority ושם המאפיין הוא priorityVal, אז שאילתות כמו priority:<value> יציגו תוצאות רק כאשר ערך המאפיין ששמו priorityVal תואם ל-<value>. לעומת זאת, חיפוש שמשתמש באותו <value> ללא אופרטור יחזיר את כל הפריטים שבהם <value> תואם את הערך של המאפיין כלשהו במחרוזת או את הערך שלו. שם האופרטור יכול להכיל אותיות קטנות בלבד (a-z). האורך המקסימלי הוא 32 תווים. |
DatePropertyOptions
האפשרויות של מאפייני תאריך.
ייצוג JSON |
---|
{
"operatorOptions": {
object ( |
שדות | |
---|---|
operatorOptions |
אם הוא מוגדר, מתאר כיצד יש להשתמש בתאריך כאופרטור חיפוש. |
DatePropertyOptions.DateOperatorOptions
אפשרות. מספק אופרטור חיפוש למאפייני תאריך. אופרטורים של query.search מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים הרלוונטיים לסוג הפריט שבו מתבצע החיפוש.
ייצוג JSON |
---|
{ "operatorName": string, "lessThanOperatorName": string, "greaterThanOperatorName": string } |
שדות | |
---|---|
operatorName |
מציין את המחרוזת בפועל הנדרשת בשאילתה כדי לבודד את מאפיין התאריך. לדוגמה, נניח שאובייקט של סכימת מעקב בעיות מכיל מאפיין בשם closeDate, שמציין אופרטור עם אופרטור name מסוג closedon. עבור חיפושים אחר נתונים אלה, שאילתות כמו closedon:<value> מוצגות תוצאות רק שבהן הערך של המאפיין closeDate תואם ל-<value>. לעומת זאת, חיפוש שמשתמש באותו <value> ללא אופרטור יחזיר את כל הפריטים שבהם <value> תואם לערך של מאפייני מחרוזת או טקסט בתוך שדה התוכן עבור מקור הנתונים שנוסף לאינדקס. שם האופרטור יכול להכיל אותיות קטנות בלבד (a-z). האורך המקסימלי הוא 32 תווים. |
lessThanOperatorName |
מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין התאריך באמצעות האופרטור 'פחות מ-'. לדוגמה, אם defaultThanOperatorName הוא closedbefore ושם הנכס closeDate, שאילתות כמו closedbefore:<value> יוצגו תוצאות רק כאשר ערך הנכס בשם closeDate מוקדם יותר מ-<value>. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים. |
greaterThanOperatorName |
מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין התאריך באמצעות האופרטור 'גדול מ-'. לדוגמה, אם LargeThanOperatorName הוא closedafter ושם הנכס הוא closeDate, שאילתות כמו closedafter:<value> יציג תוצאות רק כאשר ערך הנכס בשם closeDate מאוחר יותר מ-<value>. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים. |
TextPropertyOptions
האפשרויות של מאפייני הטקסט.
ייצוג JSON |
---|
{ "retrievalImportance": { object ( |
שדות | |
---|---|
retrievalImportance |
מציין את חשיבות איכות החיפוש של האסימונים בשדה כשמשתמשים בהם לאחזור. |
operatorOptions |
אם המאפיין מוגדר, מתאר כיצד יש להשתמש בנכס כאופרטור חיפוש. |
RetrievalImportance
ייצוג JSON |
---|
{
"importance": enum ( |
שדות | |
---|---|
importance |
מציין את חשיבות הדירוג שניתן לנכס כאשר יש התאמה במהלך האחזור. אחרי שמגדירים נכס, לא ניתן לשנות את חשיבות האסימון. |
RetrievalImportance.Importance
טיפוסים בני מנייה (enums) | |
---|---|
DEFAULT |
חשוב להתייחס להתאמה כמו לגוף הטקסט. |
HIGHEST |
יש להתייחס להתאמה כמו אל שם הפריט. |
HIGH |
יש להתייחס להתאמה עם חשיבות גבוהה יותר מגוף ההודעה. |
LOW |
יש להתייחס להתאמה עם חשיבות נמוכה יותר מגוף ההודעה. |
NONE |
אין לבצע התאמה לשדה הזה במהלך האחזור. אפשר עדיין להשתמש במאפיין להתאמה של אופרטורים, לזיהוי מאפיינים ולהציע אותם לפי הצורך. |
TextPropertyOptions.TextOperatorOptions
משמש להצגת אופרטור חיפוש למאפייני טקסט. זוהי אפשרות אופציונלית. אופרטורים של query.search מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים הרלוונטיים לסוג הפריט שבו מתבצע החיפוש.
ייצוג JSON |
---|
{ "operatorName": string, "exactMatchWithOperator": boolean } |
שדות | |
---|---|
operatorName |
מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין הטקסט. לדוגמה, אם המפעיל keyName הוא subject ושם הנכס הוא subjectLine, אז שאילתות כמו subject:<value> מציגות תוצאות רק שבהן ערך הנכס בשם subjectLine תואם ל-<value>. לעומת זאת, חיפוש עם אותו <value> ללא אופרטור מחזיר את כל הפריטים שבהם <value> תואם לערך של מאפייני טקסט או טקסט כלשהם בשדה התוכן של הפריט. שם האופרטור יכול להכיל אותיות קטנות בלבד (a-z). האורך המקסימלי הוא 32 תווים. |
exactMatchWithOperator |
אם השדה הזה הוא True, ערך הטקסט עובר הצפנה כערך אטומי אחד בחיפושי אופרטורים ובהתאמות מאפיינים. לדוגמה, אם שם האופרטור הוא 'ז'אנר' והערך הוא 'science-science', הגבלות השאילתה 'genre:science' ו-'genre:') לא יתאימו לפריט; 'genre:science-science' כן לא יתאים. ההתאמה של ערכי טקסט היא תלוית אותיות רישיות ולא מסירה תווים מיוחדים. אם False, הטקסט עובר המרה לאסימונים. לדוגמה, אם הערך הוא "science-science", השאילתות "genre:science" ו-"genre:פעם" יתאימו לפריט. |
HtmlPropertyOptions
האפשרויות למאפייני html.
ייצוג JSON |
---|
{ "retrievalImportance": { object ( |
שדות | |
---|---|
retrievalImportance |
מציין את חשיבות איכות החיפוש של האסימונים בשדה כשמשתמשים בהם לאחזור. ניתן להגדיר רק ל-DEFAULT או ל-NONE. |
operatorOptions |
אם המאפיין מוגדר, מתאר כיצד יש להשתמש בנכס כאופרטור חיפוש. |
HtmlPropertyOptions.HtmlOperatorOptions
משמש להצגת אופרטור חיפוש עבור מאפייני html. זוהי אפשרות אופציונלית. אופרטורים של query.search מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים הרלוונטיים לסוג הפריט שבו מתבצע החיפוש.
ייצוג JSON |
---|
{ "operatorName": string } |
שדות | |
---|---|
operatorName |
מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין ה-HTML. לדוגמה, אם המפעיל keyName הוא subject ושם הנכס הוא subjectLine, אז שאילתות כמו subject:<value> מציגות תוצאות רק שבהן ערך המאפיין בשם subjectLine תואם ל-<value>. לעומת זאת, חיפוש עם אותו <value> ללא אופרטור מחזיר את כל הפריטים שבהם <value> תואם לערך של מאפייני HTML או טקסט כלשהם בתוך שדה התוכן של הפריט. שם האופרטור יכול להכיל אותיות קטנות בלבד (a-z). האורך המקסימלי הוא 32 תווים. |
PropertyDisplayOptions
אפשרויות התצוגה של הנכס.
ייצוג JSON |
---|
{ "displayLabel": string } |
שדות | |
---|---|
displayLabel |
התווית הידידותית למשתמש של הנכס שבו נעשה שימוש אם הנכס צוין להצגה ב-ObjectDisplayOptions. אם תספקו את האפשרות הזו, תווית התצוגה תוצג לפני ערכי המאפיין כאשר המאפיין הוא חלק מהאפשרויות להצגת אובייקטים. לדוגמה, אם ערך הנכס הוא 1, יכול להיות שהערך עצמו לא יועיל למשתמש. אם השם המוצג היה 'עדיפות', המשתמש יראה בתוצאות החיפוש את הערך 'עדיפות : 1' שמספק הקשר ברור למשתמשים בחיפוש. המאפיין הזה אופציונלי. אם הוא לא נתון, יוצגו רק ערכי המאפיין. האורך המקסימלי הוא 64 תווים. |