Method: projects.locations.dataStores.completeQuery

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

בקשת HTTP

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

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

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

פרמטרים
dataStore

string

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

פרמטרים של שאילתה

פרמטרים
query

string

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

string

מציין את מודל הנתונים של ההשלמה האוטומטית. ההגדרה הזו מבטלת כל מודל שצוין בקטע 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 תווים. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.
includeTailSuggestions

boolean

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

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.dataStores.completeQuery

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