REST Resource: projects.locations.dataStores.servingConfigs

משאב: ServingConfig

הגדרת מטא-נתונים שמשמשים ליצירת תוצאות בזמן ההצגה (למשל, תוצאות חיפוש או תחזיות של המלצות). ה-ServingConfig מועבר בבקשת החיפוש והחיזוי ומפיק תוצאות.

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "solutionType": enum (SolutionType),
  "modelId": string,
  "diversityLevel": string,
  "embeddingConfig": {
    object (EmbeddingConfig)
  },
  "rankingExpression": string,
  "createTime": string,
  "updateTime": string,
  "filterControlIds": [
    string
  ],
  "boostControlIds": [
    string
  ],
  "redirectControlIds": [
    string
  ],
  "synonymsControlIds": [
    string
  ],
  "onewaySynonymsControlIds": [
    string
  ],
  "dissociateControlIds": [
    string
  ],
  "replacementControlIds": [
    string
  ],
  "ignoreControlIds": [
    string
  ],
  "promoteControlIds": [
    string
  ],
  "personalizationSpec": {
    object (PersonalizationSpec)
  },
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "mediaConfig": {
    object (MediaConfig)
  },
  "genericConfig": {
    object (GenericConfig)
  }
  // End of mutually exclusive fields.
}
שדות
name

string

אי אפשר לשנות. שם ייחודי מלא projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}/servingConfigs/{servingConfigId}
displayName

string

חובה. השם המוצג של הגדרת ההצגה, בפורמט שקריא לבני אדם. היא משמשת בממשק המשתמש של Discovery.

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

enum (SolutionType)

חובה. אי אפשר לשנות. מציין את סוג הפתרון שאפשר לשייך אליו הגדרת הצגה.
modelId

string

המזהה של המודל שבו רוצים להשתמש בזמן הצגת המודעות. בשלב הזה יש תמיכה רק ב-RecommendationModels. אפשר לשנות את המודל, אבל רק למודל תואם (למשל, משיעור קליקים של 'עוד אפליקציות שאולי תאהבו' לשיעור המרות של 'עוד אפליקציות שאולי תאהבו').

חובה אם הערך של SolutionType הוא SOLUTION_TYPE_RECOMMENDATION.
diversityLevel

string

מידת הגיוון שבה רוצים להשתמש בתוצאות של מודל ההמלצות, למשל medium-diversity או high-diversity. ערכים נתמכים כרגע:

  • no-diversity
  • low-diversity
  • medium-diversity
  • high-diversity
  • auto-diversity

אם לא מציינים, המערכת בוחרת ברירת מחדל על סמך סוג מודל ההמלצות. ערך ברירת המחדל: no-diversity.

אפשר להגדיר את הערך הזה רק אם SolutionType הוא SOLUTION_TYPE_RECOMMENDATION.
embeddingConfig

object (EmbeddingConfig)

שימוש בהגדרות הטמעה משלכם. ההגדרה משמשת לאחזור סמנטי של חיפושים. האחזור מבוסס על המכפלה הסקלרית של SearchRequest.EmbeddingSpec.EmbeddingVector.vector ועל הטמעות המסמכים שסופקו על ידי EmbeddingConfig הזה. אם מציינים את SearchRequest.EmbeddingSpec.EmbeddingVector.vector, הוא מבטל את ServingConfig.embedding_config.
rankingExpression

string

ביטוי הדירוג קובע את הדירוג המותאם אישית של מסמכי האחזור. כדי להשתמש בתכונה הזו, צריך להטמיע מסמכים. הגדרת הביטוי לדירוג ב-ServingConfig חלה על כל בקשות החיפוש שמוצגות על ידי הגדרת הביצוע. עם זאת, אם מציינים את SearchRequest.ranking_expression, הוא מבטל את הביטוי לדירוג של ServingConfig.

ביטוי הדירוג הוא פונקציה אחת או כמה פונקציות שמחוברות באמצעות '+'.

  • rankingExpression = function, { " + ", function };

פונקציות נתמכות:

  • ‫double * relevanceScore
  • ‫double * dotProduct(embedding_field_path)

משתני פונקציה:

  • ‫relevanceScore: מילות מפתח מוגדרות מראש, שמשמשות למדידת הרלוונטיות בין השאילתה לבין המסמך.
  • ‫embedding_field_path: שדה הטמעת המסמך שמשמש עם וקטור הטמעת השאילתה.
  • ‫dotProduct: פונקציית הטמעה בין embedding_field_path לבין וקטור ההטמעה של השאילתה.

ביטוי דירוג לדוגמה:

אם במסמך יש שדה הטמעה doc_embedding, ביטוי הדירוג יכול להיות 0.5 * relevanceScore + 0.3 * dotProduct(doc_embedding).
createTime

string (Timestamp format)

פלט בלבד. חותמת הזמן של יצירת ServingConfig.

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

פלט בלבד. חותמת הזמן של העדכון של ServingConfig.

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
filterControlIds[]

string

אמצעי בקרה של מסננים לשימוש בנתיב הצגת המודעות. כל אמצעי הבקרה של המסננים שהופעלו יחולו. אמצעי הבקרה של המסננים צריכים להיות באותו מאגר נתונים כמו קובץ ההגדרות של הצגת המודעות. אפשר להוסיף עד 20 אמצעי בקרה של מסננים.
boostControlIds[]

string

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

string

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

אפשר להגדיר את הערך הזה רק אם SolutionType הוא SOLUTION_TYPE_SEARCH.
synonymsControlIds[]

string

מפרט של מילים נרדפות לתנאים. אם כמה תנאים של מילים נרדפות תואמים, כל אמצעי הבקרה של המילים הנרדפות התואמות ברשימה יופעלו. מספר המפרטים המקסימלי הוא 100.

אפשר להגדיר את הערך הזה רק אם SolutionType הוא SOLUTION_TYPE_SEARCH.
onewaySynonymsControlIds[]

string

מפרט של מילים נרדפות חד-כיווניות בתנאי. אם כמה תנאים של מילים נרדפות חד-כיווניות תואמים, כל אמצעי הבקרה של המילים הנרדפות החד-כיווניות התואמים ברשימה יופעלו. מספר המפרטים המקסימלי הוא 100.

אפשר להגדיר את הערך הזה רק אם SolutionType הוא SOLUTION_TYPE_SEARCH.
dissociateControlIds[]

string

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

אפשר להגדיר את הערך הזה רק אם SolutionType הוא SOLUTION_TYPE_SEARCH.
replacementControlIds[]

string

מפרטים של החלפת תנאים. ההחלה מתבצעת לפי הסדר ברשימה. אי אפשר להחליף מחדש מונח שכבר הוחלף. מספר המפרטים המקסימלי הוא 100.

אפשר להגדיר את הערך הזה רק אם SolutionType הוא SOLUTION_TYPE_SEARCH.
ignoreControlIds[]

string

מפרטים של התעלמות מתנאים. אם כמה תנאי התעלמות תואמים, כל אמצעי הבקרה להתעלמות שמופיעים ברשימה יופעלו. הסדר לא משנה. מספר המפרטים המקסימלי הוא 100.
promoteControlIds[]

string

מפרטים לקידום תנאים.

מספר המפרטים המקסימלי הוא 100.
personalizationSpec

object (PersonalizationSpec)

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

שימו לב: אם גם ServingConfig.personalization_spec וגם SearchRequest.personalization_spec מוגדרים, SearchRequest.personalization_spec מבטל את ServingConfig.personalization_spec.
answerGenerationSpec

object (AnswerGenerationSpec)

זה שינוי אופציונלי. המפרט ליצירת תשובות.
הגדרה ספציפית לענף. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה:
mediaConfig

object (MediaConfig)

ה-MediaConfig של הגדרת ההצגה.
genericConfig

object (GenericConfig)

ה-GenericConfig של הגדרת הצגת המודעות.
סוף השדות הבלעדיים.

Methods

answer

 שיטת מענה לשאילתה.

create

 יוצר ServingConfig.

delete

 מחיקת ServingConfig.

get

 מקבל ServingConfig.

list

 רשימה של כל ה-ServingConfigs שמקושרים ל-DataStore הזה.

patch

 עדכון של ServingConfig.

recommend

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

searchLite

 מבצע חיפוש.

streamAnswer

 שיטת מענה לשאילתה (סטרימינג).