CompletionConfig

הגדרה להתאמה אישית של התגובה של Autocomplete API למנועים ולמאגרי נתונים. חלק מהשדות רלוונטיים רק לאחד מהם.

ייצוג JSON 
{
  "name": string,
  "matchingOrder": string,
  "maxSuggestions": integer,
  "minPrefixLength": integer,
  "queryModel": string,
  "queryFrequencyThreshold": integer,
  "numUniqueUsersThreshold": integer,
  "shouldServeContentSuggestions": boolean,
  "filterPiiSuggestionsUsingDlp": boolean,
  "enableMode": enum (EnableMode)
}
שדות
name

string

חובה. אי אפשר לשנות. שם ייחודי במלואו projects/*/locations/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/engines/*/completionConfig
matchingOrder

string

סדר ההתאמה של הצעות להשלמה אוטומטית, למשל, שאילתה שמורכבת מ-sh עם out-of-order שצוין תציע women's shoes, בעוד ששאילתה של red s עם exact-prefix שצוין תציע red shoes. ערכים נתמכים כרגע:

  • out-of-order
  • exact-prefix

ערך ברירת המחדל: exact-prefix.
maxSuggestions

integer

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

הערך של maxSuggestions חייב להיות בטווח [1, 20]. אם לא מגדירים את ההגדרה הזו או מגדירים אותה ל-0, ברירת המחדל היא 20 הצעות.
minPrefixLength

integer

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

הערך של minPrefixLength צריך להיות בטווח [1, 20]. אם לא מגדירים את הערך או מגדירים אותו כ-0, הערך שיוגדר יהיה ברירת המחדל – תו אחד.
queryModel

string

מודל הנתונים של הצעות לשאילתות להצגה.

ערכים נתמכים כרגע:

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

אם מודל השאילתה ריק, המערכת תחיל כברירת מחדל את המודל 'אוטומטי'.
queryFrequencyThreshold

integer

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

integer

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

boolean

האם ליצור ולהציג הצעות לתוכן. כך אפשר להציג הצעות לתוכן בנוסף להצעות לשאילתות.
filterPiiSuggestionsUsingDlp

boolean

אם הערך הוא true, המערכת תנסה לזהות ולהסיר את ההצעות שמכילות סוגים מסוימים של פרטים אישיים מזהים (PII). הזיהוי הזה מתבצע על ידי DLP מאחורי הקלעים.
enableMode

enum (EnableMode)

מצב ההפעלה של צינורות ליצירת השלמה אוטומטית. אם השדה הזה לא מוגדר, התנהגות השרת בברירת המחדל היא CompletionConfig.EnableMode.AUTOMATIC. ההגדרה רלוונטית ל-DataStore בלבד. המערכת מתעלמת מההגדרה הזו עבור המנוע.

EnableMode

מציינת את מצב ההפעלה של צינורות ליצירת השלמה אוטומטית.

טיפוסים בני מנייה (enum)
ENABLE_MODE_UNSPECIFIED אם לא מציינים את מצב ההפעלה של ההשלמה האוטומטית, ברירת המחדל היא מצב אוטומטי.
AUTOMATIC ההשלמה האוטומטית תופעל כשמאגר הנתונים יעמוד בקריטריונים.
MANUAL ההשלמה האוטומטית תופעל ללא קשר לדרישות הנתונים של UCS.