Method: projects.locations.collections.dataStores.widgetConfigs.get

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

בקשת HTTP


GET https://discoveryengine.googleapis.com/v1/{name=projects/*/locations/*/collections/*/dataStores/*/widgetConfigs/*}

כתובות ה-URL כתובות בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
name

string

חובה. שם המשאב המלא של WidgetConfig. פורמט: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}

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

פרמטרים
acceptCache

boolean

זה שינוי אופציונלי. האם אפשר לטעון את הגדרות הווידג'ט מהמטמון. אם המדיניות מוגדרת כ-True, יכול להיות שיעברו כמה דקות עד שהשינויים האחרונים בהגדרות הווידג'ט ישתקפו בתצוגה של משתמש הקצה. מומלץ להגדיר את הערך כ-true בווידג'טים מפותחים, כי זה משפר את הביצועים של הווידג'ט. אם הווידג'ט נמצא בפיתוח, אפשר להגדיר את הערך כ-false כדי שהשינויים ישתקפו בסביבת הייצור באופן מיידי.
getWidgetConfigRequestOption

object (GetWidgetConfigRequestOption)

זה שינוי אופציונלי. אפשרויות ל-GetWidgetConfigRequest.
languageCode

string

זה שינוי אופציונלי. תג שפה בתקן BCP-47 (למשל, 'en',‏ 'fr-CA'). הפרמטר הזה משמש להתאמה לשוק המקומי של מחרוזות קריאות לאנשים בתגובה, כמו בורר המודלים displayName / description ב-WidgetConfig.UiSettings.ModelConfigInfo. אם השדה ריק או לא מוגדר, המערכת חוזרת לשפת ברירת המחדל (אנגלית).
modelInfoView

enum (ModelInfoView)

זה שינוי אופציונלי. בחירה של התצוגה של WidgetConfig.UiSettings.ModelConfigInfo שהקצה האחורי מחשב. הפרמטר ADMIN מוגדר בדף Feature Management (ניהול תכונות) במסוף Cloud (מסך/4Vn9gQKbN8tb7gm) כדי לקבל את המודל שמוצג לאדמין, שמוגדר עם הפרמטר ResolvedModel.admin_view. הפרמטר END_USER_MOBILE מוגדר באפליקציית Gemini Enterprise לנייד כדי לקבל את המודל לנייד. אם הפרמטר לא מוגדר (unset) או אם הוא END_USER_WEB, המערכת מחזירה את בורר האינטרנט של משתמש הקצה.

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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 הבאה במשאב name:

  • discoveryengine.widgetConfigs.get

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