Method: projects.locations.collections.dataStores.completionConfig.completeQuery

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

בקשת HTTP


POST https://discoveryengine.googleapis.com/v1alpha/{completionConfig=projects/*/locations/*/collections/*/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 – שימוש בהצעות שנוצרות מההיסטוריה הקודמת של קריאות ל-SearchService.Search API. אל תשתמשו בו כשאין תנועה ל-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

מציין אם להחזיר הצעות מסוג tail אם אין הצעות שתואמות לשאילתה המלאה. גם אם הערך הוא 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/cloud_search.query
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.complete_query
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

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

הרשאות IAM

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

  • discoveryengine.completionConfigs.completeQuery

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