REST Resource: projects.locations.dataStores.widgetConfigs

משאב: WidgetConfig

ההגדרות נשמרות ב-WidgetConfig ברמת הווידג'ט.

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "enableAutocomplete": boolean,
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  },
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "dataStoreType": enum (DataStoreType),
  "contentSearchSpec": {
    object (ContentSearchSpec)
  },
  "enableSummarization": boolean,
  "enableSnippetResultSummary": boolean,
  "configId": string,
  "enableQualityFeedback": boolean,
  "solutionType": enum (SolutionType),
  "industryVertical": enum (IndustryVertical),
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableSafeSearch": boolean,
  "enableConversationalSearch": boolean,
  "llmEnabled": boolean,
  "enableResultScore": boolean,
  "resultDisplayType": enum (ResultDisplayType),
  "minimumDataTermAccepted": boolean,
  "enableWebApp": boolean,
  "dataStoreUiConfigs": [
    {
      object (DataStoreUiConfig)
    }
  ],
  "collectionComponents": [
    {
      object (CollectionComponent)
    }
  ],
  "enableSearchAsYouType": boolean,
  "defaultSearchRequestOrderBy": string,
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": boolean,
  "geminiBundle": boolean,
  "batchAuthStatuses": [
    {
      object (BatchAuthStatus)
    }
  ],
  "nodes": [
    {
      object (Node)
    }
  ]
}
שדות
name

string

אי אפשר לשנות. השם המלא של המשאב של הגדרת הווידג'ט. פורמט: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}

השדה הזה חייב להיות מחרוזת בקידוד UTF-8, עם מגבלת אורך של 1,024 תווים.
displayName

string

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

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

string (Timestamp format)

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

הפלט שנוצר תמיד יהיה בפורמט 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)

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

הפלט שנוצר תמיד יהיה בפורמט 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".
enableAutocomplete
(deprecated)

boolean

האם להפעיל או לא להפעיל את ההשלמה האוטומטית.
fieldsUiComponentsMap
(deprecated)

map (key: string, value: object (UIComponentField))

המפתח הוא רכיב ה-UI. Mock. כרגע נתמכים title, thumbnail, url, custom1, custom2, custom3.

הערך הוא שם השדה והרשאות הגישה שלו למכשיר.

שלושת השדות המותאמים אישית הם אופציונליים ואפשר להוסיף או להסיר אותם. title, thumbnail ו-url הם רכיבי ממשק משתמש נדרשים שלא ניתן להסיר.
facetField[]
(deprecated)

object (FacetField)

ההגדרה והמראה של ההיבטים בתצוגה של משתמש הקצה.
dataStoreType

enum (DataStoreType)

פלט בלבד. הסוג של מאגר נתוני ההורה.
contentSearchSpec
(deprecated)

object (ContentSearchSpec)

מפרט חיפוש התוכן שקובע את ההתנהגות הרצויה של חיפוש התוכן.
enableSummarization
(deprecated)

boolean

מפעילים או משביתים את הסיכום של תשובת החיפוש.
enableSnippetResultSummary
(deprecated)

boolean

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

string

פלט בלבד. מזהה ייחודי שעובר ערפול של WidgetConfig.
enableQualityFeedback
(deprecated)

boolean

הפעלה או השבתה של איסוף משוב ממשתמשי קצה על איכות תוצאות החיפוש.
solutionType

enum (SolutionType)

חובה. אי אפשר לשנות. מציין את סוג הפתרון שאפשר להשתמש ב-WidgetConfig הזה בשבילו.
industryVertical

enum (IndustryVertical)

פלט בלבד. הענף שרכיב WidgetConfig רושם. הענף של WidgetConfig מבוסס על Engine המשויך.
allowPublicAccess
(deprecated)

boolean

האם יש הרשאה לשילוב ללא אימות עם הווידג'ט. אם הערך מוגדר כ-true, מותרת גישה ציבורית לחיפוש או לפתרונות אחרים מהווידג'ט ללא אסימון אימות שסופק על ידי שרת קצה עורפי שמתארח אצל הלקוח.
allowlistedDomains[]
(deprecated)

string

דומיינים ברשימת ההיתרים שיכולים לטעון את הווידג'ט הזה.
llmEnabled

boolean

פלט בלבד. האם מודל שפה גדול (LLM) מופעל במאגר הנתונים המתאים.
enableResultScore

boolean

האם להציג את ניקוד התוצאה.
resultDisplayType
(deprecated)

enum (ResultDisplayType)

סוג קטע הקוד שיוצג בווידג'ט של UCS.

  • ‫RESULT_DISPLAY_TYPE_UNSPECIFIED למשתמשים קיימים.
  • תקציר למשתמשים חדשים בחיפוש שאינם משתמשים ב-Enterprise.
  • ‫EXTRACTIVE_ANSWER למשתמשים חדשים בחיפוש ארגוני.
minimumDataTermAccepted

boolean

פלט בלבד. האם הלקוח קיבל את התנאים לשימוש בנתונים.
enableWebApp
(deprecated)

boolean

האם להפעיל אפליקציית אינטרנט עצמאית.
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

הגדרות ממשק משתמש שניתנות להגדרה לכל מאגר נתונים.
collectionComponents[]

object (CollectionComponent)

פלט בלבד. רכיבי אוסף שמציגים רשימה של כל האוספים ומאגרי הנתונים המשויכים להגדרת הווידג'ט. אפשר להשתמש במקורות הנתונים האלה לסינון בממשקי ה-API של שירות הווידג'ט, והמשתמשים יכולים לקבל תוצאות ממקורות נתונים נבחרים.

במנועי SaaS / Business, כשמתבצעת קריאה ל-LookupWidgetConfig עם view = WITH_AVAILABLE_CONNECTORS, הרשימה הזו מורחבת עם ערכי placeholder סינתטיים למחברים שהמתקשר יכול לצרף אבל עדיין לא צירף (ראו CollectionComponent לחוזה ה-placeholder). לכן, הקצה הקדמי יכול לעבד רשימה מאוחדת של מקורות שכבר צורפו ומקורות שזמינים לצירוף על ידי איטרציה של השדה היחיד הזה. במנועי Enterprise ובמנוע ברירת המחדל view, מוחזרים רק מחברים שכבר צורפו (ההתנהגות הנוכחית).
enableSearchAsYouType
(deprecated)

boolean

האם להפעיל את ההתנהגות של חיפוש בזמן ההקלדה בווידג'ט החיפוש
defaultSearchRequestOrderBy
(deprecated)

string

סדר ברירת המחדל של תוצאות החיפוש, אם הוא צוין.

משמש להגדרת SearchRequest#orderBy בבקשות רלוונטיות. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
uiSettings

object (UiSettings)

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

object (AccessSettings)

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

object (UiBrandingSettings)

מאמר שמתאר את הגדרות המיתוג של ממשק המשתמש של ווידג'ט החיפוש, כמו כותרת הווידג'ט, הלוגו, סמלי האתר והצבעים.
homepageSetting

object (HomepageSetting)

זה שינוי אופציונלי. תיאור של הגדרות דף הבית של הווידג'ט.
assistantSettings

object (AssistantSettings)

זה שינוי אופציונלי. פלט בלבד. תיאור של הגדרות הווידג'ט של Assistant.
customerProvidedConfig

object (CustomerProvidedConfig)

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

boolean

זה שינוי אופציונלי. פלט בלבד. האם להפעיל Knowledge Graph פרטי.
geminiBundle

boolean

פלט בלבד. האם המינוי הוא חבילת Gemini או לא.
batchAuthStatuses[]

object (BatchAuthStatus)

פלט בלבד. סטטוסי ההרשאה של המחברים של הווידג'ט.
nodes[]

object (Node)

פלט בלבד. הצמתים שמשויכים להגדרת הווידג'ט.

Methods

get

 הפונקציה מחזירה את ה-WidgetConfig.

patch

 עדכון של WidgetConfig.