Method: projects.locations.dataStores.completionConfig.completeQuery

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

בקשת HTTP

POST https://discoveryengine.googleapis.com/v1/{completionConfig=projects/*/locations/*/dataStores/*/completionConfig}:completeQuery

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
completionConfig

string

חובה. ה-completionConfig של מאגר הנתונים הראשי או שם משאב המנוע שעבורו מתבצעת ההשלמה, כמו projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "query": string,
  "queryModel": string,
  "userPseudoId": string,
  "userInfo": {
    object (UserInfo)
  },
  "includeTailSuggestions": boolean,
  "boostSpec": {
    object (BoostSpec)
  },
  "suggestionTypes": [
    enum (SuggestionType)
  ],
  "suggestionTypeSpecs": [
    {
      object (SuggestionTypeSpec)
    }
  ],
  "experimentIds": [
    string
  ]
}
שדות
query

string

חובה. הקלט של התכונה להשלמה אוטומטית שמשמש לאחזור הצעות. האורך המרבי הוא 128 תווים.

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

string

הפרמטר הזה מציין את מודל השלמת השאילתה, שרלוונטי רק ל-SuggestionType מסוג QUERY. ההגדרה הזו מבטלת כל מודל שצוין בקטע Configuration > Autocomplete במסוף Cloud. ערכים נתמכים כרגע:

  • ‫document – שימוש בהצעות שנוצרו ממסמכים שיובאו על ידי המשתמש.
  • ‫search-history – שימוש בהצעות שנוצרות מתוך היסטוריית הקריאות הקודמות ל-API של SearchService.Search. אל תשתמשו בו אם אין תנועה ל-Search API.
  • ‫user-event – שימוש בהצעות שנוצרות מאירועי חיפוש שיובאו על ידי המשתמש.
  • ‫document-completable – שימוש בהצעות שנלקחות ישירות משדות במסמך שיובא על ידי המשתמשים, שסומנו כניתנים להשלמה.

ערכי ברירת מחדל:

  • ‫document הוא מודל ברירת המחדל ל-DataStore רגיל.
  • ‫search-history הוא מודל ברירת המחדל למאגרי נתונים של חיפוש באתרים.
userPseudoId

string

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

בשדה הזה לא צריך להזין ערך קבוע כמו unknown_visitor.

המזהה הזה צריך להיות זהה למזהים UserEvent.user_pseudo_id ו-SearchRequest.user_pseudo_id.

השדה חייב להיות מחרוזת בקידוד UTF-8 עם מגבלת אורך של 128
userInfo

object (UserInfo)

זה שינוי אופציונלי. מידע על משתמש הקצה.

פרטי המזהה צריכים להיות זהים לפרטים שמופיעים ב-UserEvent.user_info וב-SearchRequest.user_info.
includeTailSuggestions

boolean

מציין אם להחזיר הצעות מסוף השאילתה אם אין הצעות שתואמות לשאילתה המלאה. גם אם הערך מוגדר כ-true, אם יש הצעות שתואמות לשאילתה המלאה, הן מוחזרות ולא מוחזרות הצעות שמתאימות לסוף השאילתה.
boostSpec

object (BoostSpec)

זה שינוי אופציונלי. הגדרה לשיפור ההתאמה של ההצעות לתנאי.
suggestionTypes[]

enum (SuggestionType)

זה שינוי אופציונלי. סוגי ההצעות שיוחזרו. אם לא מציינים כלום או אם מציינים מחרוזת ריקה, מוחזרות הצעות לשאילתות. בשלב הזה יש תמיכה רק בסוג אחד של הצעות.
suggestionTypeSpecs[]

object (SuggestionTypeSpec)

זה שינוי אופציונלי. מפרט של כל סוג הצעה.
experimentIds[]

string

אופציונלי. מזהי הניסויים של הבקשה הזו.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של AdvancedCompleteQueryResponse.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/discoveryengine.complete_query
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב completionConfig:

  • discoveryengine.completionConfigs.completeQuery

מידע נוסף מופיע במאמרי העזרה בנושא IAM.