יצירה ורישום של סכימה

סכימה של Google Cloud Search היא מבנה JSON שמגדיר אובייקטים, מאפיינים ואפשרויות לאינדוקס ולשאילתות של נתונים. מחבר התוכן שלכם משתמש בסכימה הרשומה כדי לבנות את הנתונים במאגר ולבצע עליהם אינדוקס.

כדי ליצור סכימה, צריך לספק אובייקט סכימת JSON ל-API. לפני שמבצעים אינדוקס של נתונים, צריך לרשום סכימה לכל מאגר.

במאמר הזה מוסבר על יצירת סכימות. כדי לשפר את חוויית החיפוש, אפשר לעיין במאמר שיפור איכות החיפוש.

יצירה של סכימה

כדי ליצור סכימה של Cloud Search:

1. זיהוי התנהגות משתמשים צפויה
2. איך מאתחלים מקור נתונים
3. הגדרת האובייקטים
4. הגדרת מאפייני אובייקט
5. רישום הסכימה
6. אינדוקס של הנתונים
7. בדיקת הסכימה
8. התאמה של הסכימה

זיהוי התנהגות משתמשים צפויה

הבנה של אופן החיפוש של המשתמשים עוזרת להגדיר את אסטרטגיית הסכימה. במסד נתונים של סרטים, משתמשים יכולים לחפש "סרטים בכיכובו של רוברט רדפורד". הסכימה צריכה לתמוך בשאילתות לגבי סרטים עם שחקן ספציפי.

כדי להתאים את הסכימה להתנהגות המשתמשים:

1. הערכה של שאילתות מגוונות ממשתמשים שונים.
2. זיהוי של מערכי נתונים לוגיים, או אובייקטים, כמו "סרט".
3. זיהוי מאפיינים (תכונות) כמו שם או תאריך פרסום.
4. צריך לציין ערכים תקינים למאפיינים, כמו 'שודדי התיבה'.
5. לקבוע את הצורך במיון ובדירוג, למשל לפי סדר כרונולוגי או לפי דירוג הקהל.
6. זיהוי מאפייני הקשר, כמו תפקיד, כדי לשפר את ההצעות להשלמה אוטומטית.
7. מפרטים את האובייקטים, המאפיינים וערכי הדוגמה. אפשר להשתמש ברשימה הזו כדי להגדיר אפשרויות לאופרטורים.

אתחול מקור הנתונים

מקור נתונים מייצג נתונים ממאגר מידע שעברו אינדוקס ואוחסנו ב-Google Cloud. אפשר לעיין במאמר בנושא ניהול מקורות נתונים של צדדים שלישיים. כשמשתמש לוחץ על תוצאה, Cloud Search מפנה אותו לפריט באמצעות כתובת ה-URL מבקשת ההוספה לאינדקס.

הגדרת האובייקטים

אובייקט הוא היחידה הבסיסית של סכימה. מבנים לוגיים כמו 'סרט' או 'אדם' הם אובייקטים. לכל אובייקט יש מאפיינים כמו שם, משך או כותרת.

סכימה היא רשימה של הגדרות אובייקטים בתג objectDefinitions.

{
  "objectDefinitions": [
    { "name": "movie" },
    { "name": "person" }
  ]
}

צריך להשתמש בשמות ייחודיים לכל אובייקט, כמו movie. שירות הסכימה משתמש בשמות האלה כמפתחות. ObjectDefinition

הגדרת מאפייני אובייקט

מגדירים מאפיינים כמו שם ותאריך פרסום בקטע propertyDefinitions. משתמשים ב-options כדי להגדיר freshnessOptions (דירוג) וב-displayOptions (תוויות בממשק המשתמש).

{
  "objectDefinitions": [{
    "name": "movie",
    "propertyDefinitions": [
      {
        "name": "movieTitle",
        "isReturnable": true,
        "textPropertyOptions": {
          "retrievalImportance": { "importance": "HIGHEST" },
          "operatorOptions": { "operatorName": "title" }
        },
        "displayOptions": { "displayLabel": "Title" }
      },
      {
        "name": "releaseDate",
        "isReturnable": true,
        "isSortable": true,
        "datePropertyOptions": {
          "operatorOptions": {
            "operatorName": "released",
            "lessThanOperatorName": "releasedbefore",
            "greaterThanOperatorName": "releasedafter"
          }
        }
      }
    ]
  }]
}

‫PropertyDefinition כולל:

• מחרוזת name.
• אפשרויות שלא תלויות בסוג (לדוגמה, isReturnable).
• סוג ואפשרויות ספציפיות לסוג (למשל, textPropertyOptions).
• ‫operatorOptions לאופרטורים לחיפוש.
• ‫displayOptions לתוויות בממשק המשתמש.

אפשר להשתמש בשמות מאפיינים שוב באובייקטים שונים. לדוגמה, movieTitle יכול להופיע גם באובייקט movie וגם בפילמוגרפיה של אובייקט person.

הוספת אפשרויות שלא תלויות בסוג

‫PropertyDefinition כולל אפשרויות בוליאניות להגדרת פונקציונליות החיפוש של נכס, ללא קשר לסוג שלו. ברירת המחדל של האפשרויות האלה היא false, וצריך להגדיר אותן ל-true כדי להשתמש בהן.

• ‫isReturnable: הערך שמוגדר הוא true אם נתוני הנכס צריכים להיות מוחזרים בתוצאות החיפוש באמצעות Query API. אפשר להשתמש במאפיינים שאי אפשר להחזיר כדי לחפש או לדרג מוצרים בלי שהם יופיעו בתוצאות.
• ‫isRepeatable: מגדירים את הערך true אם למאפיין יכולים להיות כמה ערכים. לדוגמה, לסרט יש תאריך יציאה אחד אבל כמה שחקנים.
• ‫isSortable: הערך שמוגדר הוא true אם אפשר להשתמש במאפיין למיון. הערך לא יכול להיות true אם הערך של isRepeatable הוא true או אם המאפיין נמצא באובייקט משנה שניתן לחזרה.
• ‫isFacetable: הערך מוגדר ל-true אם אפשר להשתמש בנכס ליצירת היבטים (מאפיינים שמשמשים לסינון תוצאות החיפוש).
  • הערך של isReturnable חייב להיות true.
  • התכונה נתמכת רק בנכסי enum,‏ boolean וטקסט.
• ‫isWildcardSearchable: אם מגדירים את הערך true, המשתמשים יכולים לבצע חיפושים עם תו כללי בנכס הזה. האפשרות הזו זמינה רק במאפייני טקסט, וההתנהגות שלה תלויה בהגדרה של exactMatchWithOperator:
  • אם exactMatchWithOperator הוא true: ערך הטקסט נחשב לטוקן יחיד. שאילתה כמו science-* תתאים לערך science-fiction.
  • אם exactMatchWithOperator הוא false: ערך הטקסט עובר טוקניזציה. שאילתה כמו sci* או fi* תואמת ל-science-fiction, אבל science-* לא.

הגדרת סוג

מגדירים את סוג הנתונים על ידי הגדרת אובייקט האפשרויות המתאים של המאפיין (לדוגמה, textPropertyOptions). אם אתם יודעים את כל הערכים האפשריים, השתמשו ב-enums‏ (enumPropertyOptions). לנכס יכול להיות רק סוג נתונים אחד.

הגדרת אפשרויות לאופרטור

operatorOptions תארו איך מאפיין פועל כאופרטור חיפוש.

לכל operatorOptions צריך להיות operatorName (לדוגמה, title). זהו הפרמטר שהמשתמשים מקלידים בשאילתות (לדוגמה, title:titanic). כדאי להשתמש בשמות אינטואיטיביים ולחשוף אותם למשתמשים.

אפשר לשתף operatorName בין נכסים מאותו סוג. שאילתות שמשתמשות בשם הזה מאחזרות תוצאות מכל הנכסים התואמים.

מאפיינים שניתן למיין יכולים לכלול את lessThanOperatorName ואת greaterThanOperatorName בשאילתות השוואה. במאפייני טקסט אפשר להשתמש ב-exactMatchWithOperator כדי להתייחס לערך כולו כאל טוקן יחיד.

הוספת אפשרויות תצוגה

המקטע האופציונלי displayOptions מכיל displayLabel. זוהי תווית ידידותית למשתמש שמוצגת בתוצאות החיפוש.

הוספת אופרטורים לסינון הצעות

משתמשים ב-suggestionFilteringOperators[] כדי להגדיר מאפיין שמסנן הצעות להשלמה אוטומטית (למשל, סינון של הצעות לסרטים לפי הז'אנר המועדף על המשתמש). אפשר להגדיר רק מסנן הצעות אחד.

רישום הסכימה

רושמים את הסכימה בשירות הסכימות באמצעות המזהה של מקור הנתונים. שליחת בקשת UpdateSchema:

PUT https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/schema

אפשר להשתמש ב-validateOnly: true כדי לבדוק את הסכימה בלי לרשום אותה.

יצירת אינדקס של הנתונים

אחרי ההרשמה, מאכלסים את מקור הנתונים באמצעות קריאות ל-Index, בדרך כלל באמצעות מחבר.

דוגמה לבקשה להוספה לאינדקס:

{
  "name": "datasource/<data_source_id>/items/titanic",
  "metadata": {
    "title": "Titanic",
    "objectType": "movie"
  },
  "structuredData": {
    "object": {
      "properties": [{
        "name": "movieTitle",
        "textValues": { "values": ["Titanic"] }
      }]
    }
  },
  "itemType": "CONTENT_ITEM"
}

בדיקת הסכימה

לפני שמעבירים לסביבת הייצור, מומלץ לבצע בדיקה עם מאגר קטן. יוצרים רשימת בקרת גישה שמגבילה את התוצאות למשתמש לצורך בדיקה.

• שאילתה כללית: מחפשים מחרוזת (למשל, titanic) כדי לראות את כל הפריטים התואמים.
• שאילתת אופרטור: משתמשים באופרטור (למשל, actor:Zane) כדי להגביל את התוצאות.

התאמה של הסכימה

עוקבים אחרי המשוב של המשתמשים ומשנים את הסכימה בהתאם. יכול להיות שתצטרכו ליצור אינדקס לשדות חדשים או לשנות את השם של האופרטורים כדי שיהיו אינטואיטיביים יותר.

ביצוע אינדוקס מחדש אחרי שינוי בסכימה

לא צריך ליצור אינדקס מחדש כדי שהשינויים הבאים ייכנסו לתוקף:

• שמות האופרטורים.
• מגבלות מספריות.
• דירוג מסודר.
• אפשרויות רענון או תצוגה.

צריך ליצור אינדקס מחדש בשביל:

• הוספה או הסרה של נכסים או אובייקטים.
• החלפת isReturnable,‏ isFacetable או isSortable ב-true.
• סימון נכס isSuggestable.

שינויים אסורים במאפיינים

אסור לבצע שינויים שפוגעים באינדקס או גורמים לתוצאות לא עקביות, כולל:

• שם או סוג הנתונים של המאפיין.
• ההגדרות של exactMatchWithOperator או retrievalImportance.

ביצוע שינוי מורכב בסכימה

כדי לבצע שינוי שלא מותר, צריך להעביר נכסים מהגדרה ישנה להגדרה חדשה:

1. מוסיפים לנכס החדש שם שונה בסכימה.
2. רושמים את הסכימה עם המאפיינים החדשים והישנים.
3. מאכלסים מחדש את האינדקס באמצעות הנכס החדש בלבד.
4. מוחקים את המאפיין הישן מהסכימה.
5. מעדכנים את קוד השאילתה כדי להשתמש בשם הנכס החדש.

‫Cloud Search מתעד פריטים שנמחקו למשך 30 יום כדי למנוע בעיות בשימוש חוזר.

מגבלות גודל

• עד 10 אובייקטים ברמה העליונה.
• עומק מקסימלי של 10 רמות.
• עד 1,000 שדות לכל אובייקט (כולל שדות מקוננים).

השלבים הבאים

1. יוצרים ממשק חיפוש.
2. שיפור איכות החיפוש.
3. איך לבנות סכימה לפרשנות אופטימלית של שאילתות
4. הגדרת מילים נרדפות.