REST Resource: projects.locations.collections.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,
  "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))

המפתח הוא רכיב ממשק המשתמש. 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 למשתמשים קיימים.
  • תקציר למשתמשים חדשים בחיפוש שאינם משתמשים בחיפוש ארגוני.
  • EXTRACTIVE_ANSWER למשתמשים חדשים בחיפוש ארגוני.
minimumDataTermAccepted

boolean

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

boolean

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

object (DataStoreUiConfig)

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

object (CollectionComponent)

פלט בלבד. רכיבי אוסף שמציגים רשימה של כל האוספים ומאגרי הנתונים המשויכים להגדרת הווידג'ט. אפשר להשתמש במקורות הנתונים האלה לסינון בממשקי ה-API של שירות הווידג'ט, והמשתמשים יכולים לקבל תוצאות ממקורות נתונים נבחרים.
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 או לא.
nodes[]

object (Node)

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

UIComponentField

שדה של היבט שממופה לרכיב בממשק המשתמש.

ייצוג ב-JSON 
{
  "field": string,
  "deviceVisibility": [
    enum (DeviceVisibility)
  ],
  "displayTemplate": string
}
שדות
field

string

חובה. שם השדה הרשום. הפורמט הוא field.abc.
deviceVisibility[]

enum (DeviceVisibility)

השדה גלוי בסוגים שונים של מכשירים.
displayTemplate

string

התבנית שמשמשת להתאמה אישית של אופן הצגת השדה. ערך לדוגמה יכול להיות מחרוזת שנראית כך: "Price: {value}".

DeviceVisibility

האם השדה גלוי בסוגים שונים של מכשירים.

טיפוסים בני מנייה (enum)
DEVICE_VISIBILITY_UNSPECIFIED ערך ברירת המחדל אם לא מציינים ערך. השרת מחזיר INVALID_ARGUMENT אם משתמשים בו בבקשות.
MOBILE רכיב ממשק המשתמש גלוי במכשירים ניידים.
DESKTOP רכיב ממשק המשתמש גלוי בלקוח מבוסס-דפדפן.

FacetField

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

ייצוג ב-JSON 
{
  "field": string,
  "displayName": string
}
שדות
field

string

חובה. שם השדה הרשום. הפורמט הוא field.abc.
displayName

string

זה שינוי אופציונלי. שם השדה שמשתמשי הקצה יראו.

DataStoreType

הסוג של מאגר נתוני ההורה של הווידג'ט.

טיפוסים בני מנייה (enum)
DATA_STORE_TYPE_UNSPECIFIED סוג מאגר נתונים לא מוגדר.
STRUCTURED מאגר הנתונים הראשי מכיל מנוע חיפוש לנתונים מובְנים.
UNSTRUCTURED מאגר הנתונים הראשי מכיל מנוע חיפוש לנתונים לא מובְנים.
BLENDED מאגר נתוני ההורה מוצג בחיפוש משולב עם כמה מאגרי נתונים.

ResultDisplayType

סוג התוצאה שיוצג בווידג'ט של ucs.

טיפוסים בני מנייה (enum)
RESULT_DISPLAY_TYPE_UNSPECIFIED סוג המסך לא צוין (ברירת המחדל היא הצגת קטע קוד).
SNIPPET הצגת התוצאות משדה התקציר.
EXTRACTIVE_ANSWER הצגת תוצאות מהשדה 'תשובות חילוץ'.

DataStoreUiConfig

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

ייצוג ב-JSON 
{
  "name": string,
  "id": string,
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  }
}
שדות
name

string

השם של מאגר הנתונים. הפורמט של שם המשאב של מאגר הנתונים צריך להיות: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. בממשקי API של WidgetService, כמו WidgetService.LookupWidgetConfig, השדה הזה לא יכלול את מספר הפרויקט ואת המיקום.
id

string

פלט בלבד. המזהה של מאגר הנתונים, שמשמש לשירות הווידג'טים. בשלב הזה הוא מתייחס ל-dataStoreId, בעתיד נעביר את השדה ל-UUID של שם מאגר נתונים מוצפן.
facetField[]

object (FacetField)

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

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

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

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

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

CollectionComponent

רכיב אוסף לקריאה בלבד שמכיל שדות של אוספים במאגר נתונים שאפשר להשתמש בהם לסינון

ייצוג ב-JSON 
{
  "name": string,
  "id": string,
  "displayName": string,
  "dataStoreComponents": [
    {
      object (DataStoreComponent)
    }
  ],
  "dataSource": string,
  "dataSourceDisplayName": string,
  "connectorIconLink": string
}
שדות
name

string

השם של האוסף. הוא צריך להיות שם משאב של אוסף. פורמט: projects/{project}/locations/{location}/collections/{collectionId} בממשקי API של WidgetService, כמו WidgetService.LookupWidgetConfig, השדה הזה לא יכלול את מספר הפרויקט ואת המיקום.
id

string

פלט בלבד. המזהה של האוסף, שמשמש לשירות הווידג'טים. בשלב הזה, השדה מתייחס ל-collectionId, אבל בעתיד נעביר את השדה ל-UUID של שם האוסף המוצפן.
displayName

string

השם המוצג של האוסף.
dataStoreComponents[]

object (DataStoreComponent)

ברשימת מאגרי הנתונים של הילדים.
dataSource

string

שם מקור הנתונים, שאוחזר מ-Collection.data_connector.data_source.
dataSourceDisplayName

string

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

DataStoreComponent

רכיב של מאגר נתונים לקריאה בלבד, שמכיל שדות של מאגרי נתונים שאפשר להשתמש בהם לסינון. זהו רכיב צאצא של CollectionComponent.

ייצוג ב-JSON 
{
  "name": string,
  "id": string,
  "displayName": string,
  "entityName": string,
  "workspaceType": enum (Type),
  "contentConfig": enum (ContentConfig),
  "dataStoreConfigType": enum (DataStoreConfigType)
}
שדות
name

string

השם של מאגר הנתונים. הפורמט של שם המשאב של מאגר הנתונים צריך להיות: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. בממשקי API של WidgetService, כמו WidgetService.LookupWidgetConfig, השדה הזה לא יכלול את מספר הפרויקט ואת המיקום.
id

string

פלט בלבד. המזהה של מאגר הנתונים, שמשמש לשירות הווידג'טים. בשלב הזה הוא מתייחס ל-dataStoreId, בעתיד נעביר את השדה ל-UUID של שם מאגר נתונים מוצפן.
displayName

string

השם המוצג של מאגר הנתונים.
entityName

string

שם הישות, שאוחזר מ-Collection.data_connector.entities.entityName.
workspaceType

enum (Type)

פלט בלבד. סוגי מקורות ב-Workspace לנתוני Workspace, שאוחזרו מ-DataStore.workspace_config.type.
contentConfig

enum (ContentConfig)

פלט בלבד. הגדרת התוכן של מאגר הנתונים.
dataStoreConfigType

enum (DataStoreConfigType)

פלט בלבד. סוג ההגדרה של מאגר הנתונים.

DataStoreConfigType

סוג ההגדרה של מאגר הנתונים.

טיפוסים בני מנייה (enum)
DATA_STORE_CONFIG_TYPE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
ALLOW_DB_CONFIG מאגר הנתונים מחובר ל-AlloyDB
THIRD_PARTY_OAUTH_CONFIG מאגר הנתונים מחובר למקור נתונים של צד שלישי.
NOTEBOOKLM_CONFIG מאגר הנתונים מקושר ל-NotebookLM Enterprise.

UiSettings

תיאור של הגדרות כלליות של ממשק משתמש של ווידג'ט (או אפליקציית אינטרנט) כפי שמופיעות בדף ההגדרות של ממשק המשתמש במסוף Cloud.

ייצוג ב-JSON 
{
  "interactionType": enum (InteractionType),
  "generativeAnswerConfig": {
    object (GenerativeAnswerConfig)
  },
  "resultDescriptionType": enum (ResultDisplayType),
  "enableAutocomplete": boolean,
  "enableSafeSearch": boolean,
  "enableQualityFeedback": boolean,
  "enableSearchAsYouType": boolean,
  "defaultSearchRequestOrderBy": string,
  "dataStoreUiConfigs": [
    {
      object (DataStoreUiConfig)
    }
  ],
  "disableUserEventsCollection": boolean,
  "enableVisualContentSummary": boolean,
  "enablePeopleSearch": boolean,
  "enableCreateAgentButton": boolean,
  "features": {
    string: enum (FeatureState),
    ...
  },
  "modelConfigs": {
    string: enum (ModelState),
    ...
  },
  "searchAddonSpec": {
    object (SearchAddonSpec)
  }
}
שדות
interactionType

enum (InteractionType)

תיאור סוג האינטראקציה עם הווידג'ט (או אפליקציית האינטרנט)
generativeAnswerConfig

object (GenerativeAnswerConfig)

תיאור של הגדרת תשובות גנרטיביות.
resultDescriptionType

enum (ResultDisplayType)

קובעת אם תמצית התוצאה תוצג ואיך (תקציר או תשובה שמבוססת על מידע מתוך התוצאה). אם לא מציינים ערך, ברירת המחדל היא ללא תוצאה.
enableAutocomplete

boolean

האם להפעיל או לא להפעיל את ההשלמה האוטומטית.
enableQualityFeedback

boolean

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

boolean

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

string

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

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

object (DataStoreUiConfig)

לכל הגדרה של מאגר נתונים.
disableUserEventsCollection

boolean

אם המדיניות מוגדרת כ-True, הווידג'ט לא יאסוף אירועים של משתמשים.
enableVisualContentSummary

boolean

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

boolean

זה שינוי אופציונלי. אם ההגדרה היא True, הווידג'ט יאפשר להפעיל את הלחצן ליצירת סוכן.
features

map (key: string, value: enum (FeatureState))

פלט בלבד. הגדרת התכונה של המנוע להצטרפות לתכונות או לביטול ההצטרפות אליהן. מקשים נתמכים:

  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • feedback
  • session-sharing
  • personalization-memory
  • personalization-suggested-highlights
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
modelConfigs

map (key: string, value: enum (ModelState))

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

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

object (SearchAddonSpec)

זה שינוי אופציונלי. המאפיין SearchAddonSpec משמש להשבתת תוספים לחיפוש. השדה הזה נתמך רק בבקשות חיפוש.

InteractionType

תיאור של סוג האינטראקציה.

טיפוסים בני מנייה (enum)
INTERACTION_TYPE_UNSPECIFIED לא צוין. ברירת המחדל היא SEARCH_ONLY.
SEARCH_ONLY חיפוש בלי תשובה גנרטיבית.
SEARCH_WITH_ANSWER חיפוש באמצעות התשובה הגנרטיבית.
SEARCH_WITH_FOLLOW_UPS חיפוש עם תשובה גנרטיבית שאפשר לשאול עליה שאלות המשך. נקרא גם חיפוש רב-שלבי.

GenerativeAnswerConfig

מתאר את ההגדרה של תשובה גנרטיבית.

ייצוג ב-JSON 
{
  "resultCount": integer,
  "modelVersion": string,
  "modelPromptPreamble": string,
  "maxRephraseSteps": integer,
  "languageCode": string,
  "disableRelatedQuestions": boolean,
  "ignoreNonAnswerSeekingQuery": boolean,
  "ignoreAdversarialQuery": boolean,
  "ignoreLowRelevantContent": boolean,
  "imageSource": enum (ImageSource)
}
שדות
resultCount

integer

מספר התוצאות המובילות שמהן תיווצר התשובה. עד 10.
modelVersion

string

גרסת המודל ששימשה ליצירת התשובה.
modelPromptPreamble

string

טקסט בתחילת ההנחיה שמנחה את המודל שיוצר את התשובה.
maxRephraseSteps

integer

מספר השלבים המקסימלי לניסוח מחדש. מספר השלבים המקסימלי הוא 5. אם לא מגדירים את הערך או מגדירים ערך נמוך מ-1, ברירת המחדל היא 1.
languageCode

string

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

boolean

זה שינוי אופציונלי. מציינים אם לסנן שאילתות שלא מחפשות תשובות. ערך ברירת המחדל הוא false.

אם שאילתת החיפוש מסווגת כשאילתה שלא נועדה לקבל תשובה, לא מוחזרת תשובה. אם השדה הזה מוגדר ל-true, אנחנו מדלגים על יצירת תשובות לשאילתות שלא מחפשות תשובות, ומחזירים במקום זאת הודעות חלופיות.
ignoreAdversarialQuery

boolean

זה שינוי אופציונלי. קובעת אם לסנן שאילתות שהן עוינות.
ignoreLowRelevantContent

boolean

זה שינוי אופציונלי. מציין אם לסנן שאילתות שלא רלוונטיות לתוכן.
imageSource

enum (ImageSource)

זה שינוי אופציונלי. מקור התמונה שמוחזרת בתשובה.

ImageSource

מקור התמונה שמוחזרת בתשובה.

טיפוסים בני מנייה (enum)
IMAGE_SOURCE_UNSPECIFIED מקור תמונה לא מוגדר (התכונה הרב-אופנית מושבתת כברירת מחדל)
ALL_AVAILABLE_SOURCES התנהגות כששירות קובע את הבחירה מכל המקורות הזמינים.
CORPUS_IMAGE_ONLY תכלול תמונה מהמאגר בתשובה.
FIGURE_GENERATION_ONLY מפעיל יצירת נתונים בתשובה.

FeatureState

מצב התכונה במנוע.

טיפוסים בני מנייה (enum)
FEATURE_STATE_UNSPECIFIED לא צוין סטטוס התכונה.
FEATURE_STATE_ON התכונה מופעלת כדי שיהיה אפשר לגשת אליה.
FEATURE_STATE_OFF התכונה מושבתת כדי שלא תהיה אליה גישה.

ModelState

המצב של המודל של המנוע.

טיפוסים בני מנייה (enum)
MODEL_STATE_UNSPECIFIED מצב המודל לא צוין.
MODEL_ENABLED האדמין הפעיל את המודל.
MODEL_DISABLED האדמין השבית את המודל.

SearchAddonSpec

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

ייצוג ב-JSON 
{
  "semanticAddOnDisabled": boolean,
  "kpiPersonalizationAddOnDisabled": boolean,
  "generativeAnswerAddOnDisabled": boolean
}
שדות
semanticAddOnDisabled

boolean

זה שינוי אופציונלי. אם הערך הוא True, התוסף הסמנטי מושבת. התוסף הסמנטי כולל הטמעות ו-Jetstream.
kpiPersonalizationAddOnDisabled

boolean

זה שינוי אופציונלי. אם הערך הוא True, המערכת משביתה את הדירוג מחדש של האירועים ואת ההתאמה האישית כדי לבצע אופטימיזציה של מדדי ה-KPI ולהתאים אישית את התוצאות.
generativeAnswerAddOnDisabled

boolean

זה שינוי אופציונלי. אם הערך הוא True, התוסף של תשובות גנרטיביות מושבת. התוסף 'תשובה גנרטיבית' כולל שפה טבעית לסינון ותשובות פשוטות.

AccessSettings

הסבר על הגדרות הגישה לווידג'טים.

ייצוג ב-JSON 
{
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableWebApp": boolean,
  "workforceIdentityPoolProvider": string,
  "languageCode": string
}
שדות
allowPublicAccess

boolean

האם מותרת גישה ציבורית ללא אימות.
allowlistedDomains[]

string

רשימת הדומיינים שמותר להם לשלב את ווידג'ט החיפוש.
enableWebApp

boolean

האם הגישה לאפליקציית האינטרנט מופעלת.
workforceIdentityPoolProvider

string

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

string

זה שינוי אופציונלי. קוד השפה של ממשק המשתמש. צריך להשתמש בתגי שפה שמוגדרים על ידי BCP47. אם לא מגדירים את קוד השפה, קוד השפה שמוגדר כברירת מחדל הוא en-US.

UiBrandingSettings

תיאור של הגדרות המיתוג של ממשק המשתמש של הווידג'ט.

ייצוג ב-JSON 
{
  "logo": {
    object (Image)
  }
}
שדות

תמונה

אפשרויות לאחסון תמונה.

ייצוג ב-JSON 
{

  // Union field storage_method can be only one of the following:
  "url": string
  // End of list of possible types for union field storage_method.
}
שדות
שדה איחוד storage_method. דרכים שונות לאחסון תמונה, למשל ככתובת URL או כמחרוזת בקידוד base64. הערך storage_method יכול להיות רק אחד מהבאים:
url

string

כתובת URL של תמונה.

HomepageSetting

תיאור של הגדרת דף הבית של הווידג'ט. היא כוללת את כל ההגדרות וההגדרות שקשורות לדף הבית, כמו קיצורי דרך.

ייצוג ב-JSON 
{
  "shortcuts": [
    {
      object (Shortcut)
    }
  ]
}
שדות
shortcuts[]

object (Shortcut)

זה שינוי אופציונלי. קיצורי הדרך שיוצגו בדף הבית.

קיצור דרך

מתארת ישות של קיצור דרך (כלומר תוכן מוצמד) בדף הבית. דף הבית יציג את קיצורי הדרך האלה באותו סדר שמוחזר על ידי ה-API. אם לקוח רוצה לשנות את הסדר של קיצור דרך או להסיר אותו, ממשק המשתמש צריך תמיד לספק את הרשימה המלאה החדשה של קיצורי הדרך.

ייצוג ב-JSON 
{
  "title": string,
  "icon": {
    object (Image)
  },
  "destinationUri": string
}
שדות
title

string

זה שינוי אופציונלי. השם של קיצור הדרך.
icon

object (Image)

זה שינוי אופציונלי. כתובת ה-URL של הסמל של קיצור הדרך.
destinationUri

string

זה שינוי אופציונלי. כתובת היעד של קיצור הדרך.

AssistantSettings

תיאור של הגדרות ה-Assistant של הווידג'ט.

ייצוג ב-JSON 
{
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "disableLocationContext": boolean
}
שדות
googleSearchGroundingEnabled
(deprecated)

boolean

האם מתג ההארקה של חיפוש Google מוצג או לא. הוצאה משימוש, במקום זאת, אתם צריכים להשתמש ב-webGroundingType.
webGroundingType

enum (WebGroundingType)

זה שינוי אופציונלי. סוג ההצמדה לאתר שבה רוצים להשתמש.
defaultWebGroundingToggleOff

boolean

פלט בלבד. השדה הזה קובע את מצב ברירת המחדל של המתג להארקה באינטרנט עבור משתמשי קצה, אם webGroundingType מוגדר ל-WEB_GROUNDING_TYPE_GOOGLE_SEARCH או ל-WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. כברירת מחדל, הערך שמוגדר בשדה הזה הוא False. אם webGroundingType הוא WEB_GROUNDING_TYPE_GOOGLE_SEARCH או WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, משתמשי הקצה יקבלו כברירת מחדל את האפשרות להשתמש בנתוני אינטרנט בממשק המשתמש. אם הערך הוא True, מתג ההארקה מושבת כברירת מחדל בממשק המשתמש. משתמשי קצה עדיין יכולים להפעיל את העיגון בנתונים מהאינטרנט בממשק המשתמש אם העיגון בנתונים מהאינטרנט מופעל.
disableLocationContext

boolean

זה שינוי אופציונלי. פלט בלבד. האם להשבית את ההקשר של מיקום המשתמש.

WebGroundingType

סוג ההצמדה לאתר שבה רוצים להשתמש.

טיפוסים בני מנייה (enum)
WEB_GROUNDING_TYPE_UNSPECIFIED הגדרה לא מוגדרת, ברירת מחדל. ההגדרה הזו זהה להגדרה 'מושבת'.
WEB_GROUNDING_TYPE_DISABLED העיגון בנתונים מהאינטרנט מושבת.

CustomerProvidedConfig

הגדרות שהלקוח סיפק.

ייצוג ב-JSON 
{
  "customerType": enum (CustomerType)
}
שדות
customerType

enum (CustomerType)

סוג הלקוח.

CustomerType

סוג הלקוח.

טיפוסים בני מנייה (enum)
DEFAULT_CUSTOMER סוג לקוח שמוגדר כברירת מחדל.
GOVERNMENT_CUSTOMER סוג הלקוח הממשלתי. חלק מהתכונות מושבתות ללקוחות ממשלתיים בגלל דרישות משפטיות.

צומת

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

ייצוג ב-JSON 
{
  "displayName": string,
  "iconUrl": string,
  "description": string,
  "parameterSchema": {
    object
  },
  "outputSchema": {
    object
  },
  "type": enum (Type)
}
שדות
displayName

string

פלט בלבד. שם של הצומת שקריא לאנשים.
iconUrl

string

פלט בלבד. מזהה או כתובת URL שמפנים לסמל שמייצג את סוג הצומת הזה.
description

string

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

object (Struct format)

פלט בלבד. סכימת הפרמטרים של הכלי.

הסכימה הזו צריכה להיות תואמת לתקן של סכימת OpenAPI (ראו https://spec.openapis.org/oas/v3.0.3.html ו-AIP-146). הוא מתאר את המבנה הצפוי של הפרמטרים שהצומת הזה מקבל.
outputSchema

object (Struct format)

פלט בלבד. סכימת הפלט של הכלי.

הסכימה הזו צריכה להיות תואמת לתקן של סכימת OpenAPI (ראו https://spec.openapis.org/oas/v3.0.3.html/ ו-AIP-146). הוא מתאר את מבנה הפלט שנוצר על ידי הצומת הזה.
type

enum (Type)

פלט בלבד. סוג הצומת.

סוג

מציין את סוג הצומת בתהליך העבודה של הסוכן.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג לא מוגדר.
TRIGGER סוג הטריגר.
FLOW סוג התהליך.
CONNECTOR סוג המחבר.

Methods

get

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

patch

 עדכון של WidgetConfig.