Method: projects.locations.collections.dataStores.completeQuery

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

בקשת HTTP


GET https://discoveryengine.googleapis.com/v1/{dataStore=projects/*/locations/*/collections/*/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 – שימוש בהצעות שנוצרות מההיסטוריה הקודמת של קריאות ל-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 תווים. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.
includeTailSuggestions

boolean

מציין אם להחזיר הצעות מסוג tail אם אין הצעות שתואמות לשאילתה המלאה. גם אם הערך הוא true, אם יש הצעות שתואמות לשאילתה המלאה, הן מוחזרות ולא מוחזרות הצעות זנב.

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.dataStores.completeQuery

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