REST Resource: projects.locations.collections.dataStores.widgetConfigs

Ressource: WidgetConfig

WidgetConfig erfasst Konfigurationen auf Widget-Ebene.

JSON-Darstellung 
{
  "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
}
Felder
name

string

Nicht veränderbar. Der vollständige Ressourcenname der Widget-Konfiguration. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.
displayName

string

Erforderlich. Der für Menschen lesbare Anzeigename der Widget-Konfiguration. Wird in der Discovery-Benutzeroberfläche verwendet.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung von WidgetConfig.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Aktualisierung von WidgetConfig.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
enableAutocomplete
(deprecated)

boolean

Gibt an, ob die automatische Vervollständigung aktiviert werden soll.
fieldsUiComponentsMap
(deprecated)

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

Der Schlüssel ist die UI-Komponente. Mock. Momentan unterstützt title, thumbnail, url, custom1, custom2, custom3.

Der Wert ist der Name des Felds zusammen mit seiner Gerätesichtbarkeit.

Die drei benutzerdefinierten Felder sind optional und können hinzugefügt oder entfernt werden. title, thumbnail und url sind erforderliche UI-Komponenten, die nicht entfernt werden können.
facetField[]
(deprecated)

object (FacetField)

Konfiguration und Darstellung von Facetten in der Endnutzeransicht.
dataStoreType

enum (DataStoreType)

Nur Ausgabe. Der Typ des übergeordneten Datenspeichers.
contentSearchSpec
(deprecated)

object (ContentSearchSpec)

Die Spezifikation für die Inhaltssuche, mit der das gewünschte Verhalten der Inhaltssuche konfiguriert wird.
enableSummarization
(deprecated)

boolean

Zusammenfassung für die Suchantwort aktivieren oder deaktivieren
enableSnippetResultSummary
(deprecated)

boolean

Sie können die Zusammenfassung für jedes Snippet-Ergebnis aktivieren oder deaktivieren.
configId

string

Nur Ausgabe. Eindeutige verschleierte Kennung eines WidgetConfig.
enableQualityFeedback
(deprecated)

boolean

Sie können das Erfassen von Feedback zur Qualität der Suchergebnisse von Endnutzern aktivieren oder deaktivieren.
solutionType

enum (SolutionType)

Erforderlich. Nicht veränderbar. Gibt den Lösungstyp an, für den diese WidgetConfig verwendet werden kann.
industryVertical

enum (IndustryVertical)

Nur Ausgabe. Die Branche, für die die WidgetConfig registriert wird. Die Branche von WidgetConfig basiert auf der zugehörigen Engine.
allowPublicAccess
(deprecated)

boolean

Gibt an, ob die Integration ohne Authentifizierung mit dem Widget zulässig ist. Wenn „true“ festgelegt ist, ist der öffentliche Zugriff auf die Suche oder andere Lösungen über das Widget ohne Authentifizierungstoken des vom Kunden gehosteten Backend-Servers zulässig.
allowlistedDomains[]
(deprecated)

string

Domains auf der Zulassungsliste, die dieses Widget laden können.
llmEnabled

boolean

Nur Ausgabe. Gibt an, ob LLM im entsprechenden Datenspeicher aktiviert ist.
enableResultScore

boolean

Gibt an, ob die Punktzahl des Ergebnisses angezeigt werden soll.
resultDisplayType
(deprecated)

enum (ResultDisplayType)

Der Typ des Snippets, das im UCS-Widget angezeigt werden soll.

  • RESULT_DISPLAY_TYPE_UNSPECIFIED für bestehende Nutzer.
  • SNIPPET für neue Nutzer der privaten Suche.
  • EXTRACTIVE_ANSWER für neue Nutzer der Unternehmenssuche.
minimumDataTermAccepted

boolean

Nur Ausgabe. Gibt an, ob der Kunde die Datennutzungsbedingungen akzeptiert hat.
enableWebApp
(deprecated)

boolean

Gibt an, ob eine eigenständige Web-App aktiviert werden soll.
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

Konfigurierbare UI-Konfigurationen pro Datenspeicher.
collectionComponents[]

object (CollectionComponent)

Nur Ausgabe. Sammlungskomponenten, in denen alle Sammlungen und untergeordneten Datenspeicher aufgeführt sind, die mit der Widget-Konfiguration verknüpft sind. Diese Datenquellen können zum Filtern in Widget-Service-APIs verwendet werden. Nutzer können Ergebnisse aus ausgewählten Datenquellen zurückgeben.
enableSearchAsYouType
(deprecated)

boolean

Ob die Suche während der Eingabe für das Such-Widget aktiviert werden soll
defaultSearchRequestOrderBy
(deprecated)

string

Die Standardreihenfolge für Suchergebnisse, falls angegeben.

Wird verwendet, um SearchRequest#orderBy für entsprechende Anfragen festzulegen. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
uiSettings

object (UiSettings)

Beschreibt die allgemeinen Einstellungen für die Suche in Widgets, die auf der Konfigurationsseite für Widgets in der Cloud Console zu sehen sind. Ersetzt die wichtigsten eingestellten Attribute der obersten Ebene.
accessSettings

object (AccessSettings)

Wird für alle Einstellungen für den Widget-Zugriff verwendet, die auf der Seite für die Cloud Console-Integration angezeigt werden. Ersetzt die wichtigsten eingestellten Attribute der obersten Ebene.
uiBranding

object (UiBrandingSettings)

Beschreibt die Einstellungen für das Branding der Benutzeroberfläche des Such-Widgets, z. B. der Widget-Titel, das Logo, die Favicons und die Farben.
homepageSetting

object (HomepageSetting)

Optional. Beschreibt die Startseiteneinstellungen des Widgets.
assistantSettings

object (AssistantSettings)

Optional. Nur Ausgabe. Beschreibt die Assistant-Einstellungen des Widgets.
customerProvidedConfig

object (CustomerProvidedConfig)

Optional. Nur Ausgabe. Beschreibt die kundenbezogenen Konfigurationen, die derzeit nur für Behördenkunden verwendet werden. Dieses Feld kann nach dem Onboarding des Projekts nicht mehr geändert werden.
enablePrivateKnowledgeGraph

boolean

Optional. Nur Ausgabe. Gibt an, ob der private Knowledge Graph aktiviert werden soll.
geminiBundle

boolean

Nur Ausgabe. Gibt an, ob das Abo ein Gemini-Bundle ist.

UIComponentField

Facettenfeld, das einer UI-Komponente zugeordnet ist.

JSON-Darstellung 
{
  "field": string,
  "deviceVisibility": [
    enum (DeviceVisibility)
  ],
  "displayTemplate": string
}
Felder
field

string

Erforderlich. Registrierter Feldname. Das Format dafür ist field.abc.
deviceVisibility[]

enum (DeviceVisibility)

Die Sichtbarkeit von Feldern auf verschiedenen Gerätetypen.
displayTemplate

string

Die Vorlage, mit der die Darstellung des Felds angepasst wird. Ein Beispielwert wäre ein String wie „Preis: {value}“.

DeviceVisibility

Die Sichtbarkeit des Felds auf verschiedenen Gerätetypen.

Enums
DEVICE_VISIBILITY_UNSPECIFIED Standardwert, wenn nicht angegeben. Der Server gibt INVALID_ARGUMENT zurück, wenn er in Anfragen verwendet wird.
MOBILE Die UI-Komponente ist auf Mobilgeräten sichtbar.
DESKTOP Die UI-Komponente ist im browserbasierten Client sichtbar.

FacetField

Facettenfelder, in denen die Zuordnung von Feldern zur Darstellung von Endnutzer-Widgets gespeichert wird.

JSON-Darstellung 
{
  "field": string,
  "displayName": string
}
Felder
field

string

Erforderlich. Registrierter Feldname. Das Format dafür ist field.abc.
displayName

string

Optional. Der Feldname, der Endnutzern angezeigt wird.

DataStoreType

Der Typ des übergeordneten Datenspeichers des Widgets.

Enums
DATA_STORE_TYPE_UNSPECIFIED Nicht angegebener Datenspeichertyp
STRUCTURED Der übergeordnete Datenspeicher enthält eine Suchmaschine für strukturierte Daten.
UNSTRUCTURED Der übergeordnete Datenspeicher enthält eine Suchmaschine für unstrukturierte Daten.
BLENDED Der übergeordnete Datenspeicher wird für die zusammengeführte Suche mit mehreren Datenspeichern verwendet.

ResultDisplayType

Der Typ des Ergebnisses, das im UCS-Widget angezeigt werden soll.

Enums
RESULT_DISPLAY_TYPE_UNSPECIFIED Nicht angegebener Anzeigetyp (standardmäßig wird ein Snippet angezeigt).
SNIPPET Ergebnisse aus dem Snippet-Feld anzeigen
EXTRACTIVE_ANSWER Ergebnisse aus dem Feld „Extractive Answers“ (Extraktive Antworten) anzeigen

DataStoreUiConfig

Konfiguration der UI-Komponente für den Datenspeicher.

JSON-Darstellung 
{
  "name": string,
  "id": string,
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  }
}
Felder
name

string

Der Name des Datenspeichers. Es sollte der Ressourcenname des Datenspeichers im Format projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId} sein. Bei APIs unter WidgetService, z. B. [WidgetService.LookUpWidgetConfig][], werden die Projektnummer und der Standortteil in diesem Feld gelöscht.
id

string

Nur Ausgabe. Die Kennung des Datenspeichers, der für den Widget-Dienst verwendet wird. Derzeit bezieht er sich auf „dataStoreId“. In Zukunft wird das Feld zur UUID des verschlüsselten Datenspeichernamens migriert.
facetField[]

object (FacetField)

Facettenfelder, in denen die Zuordnung von Feldern zur Darstellung von Endnutzer-Widgets gespeichert wird.
fieldsUiComponentsMap

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

Der Schlüssel ist die UI-Komponente. Mock. Momentan unterstützt title, thumbnail, url, custom1, custom2, custom3.

Der Wert ist der Name des Felds zusammen mit seiner Gerätesichtbarkeit.

Die drei benutzerdefinierten Felder sind optional und können hinzugefügt oder entfernt werden. title, thumbnail und url sind erforderliche UI-Komponenten, die nicht entfernt werden können.

CollectionComponent

Schreibgeschützte Sammlungskomponente, die Felder für Datenspeichersammlungen enthält, die zum Filtern verwendet werden können

JSON-Darstellung 
{
  "name": string,
  "id": string,
  "displayName": string,
  "dataStoreComponents": [
    {
      object (DataStoreComponent)
    }
  ],
  "dataSource": string,
  "dataSourceDisplayName": string,
  "connectorIconLink": string
}
Felder
name

string

Der Name der Sammlung. Es sollte der Name der Sammlungsressource sein. Format: projects/{project}/locations/{location}/collections/{collectionId}. Bei APIs unter WidgetService, z. B. [WidgetService.LookUpWidgetConfig][], werden die Projektnummer und der Standortteil in diesem Feld gelöscht.
id

string

Nur Ausgabe. Die ID der Sammlung, die für den Widget-Dienst verwendet wird. Derzeit verweist es auf „collectionId“. In Zukunft wird das Feld zur UUID des verschlüsselten Sammlungsnamens migriert.
displayName

string

Der Anzeigename der Sammlung.
dataStoreComponents[]

object (DataStoreComponent)

Für die Datenspeichersammlung: Liste der untergeordneten Datenspeicher.
dataSource

string

Der Name der Datenquelle, der aus Collection.data_connector.data_source abgerufen wird.
dataSourceDisplayName

string

Nur Ausgabe. Der Anzeigename der Datenquelle.

DataStoreComponent

Schreibgeschützte Datenspeicherkomponente, die Datenspeicherfelder enthält, die zum Filtern verwendet werden können. Sie ist das untergeordnete Element von CollectionComponent.

JSON-Darstellung 
{
  "name": string,
  "id": string,
  "displayName": string,
  "entityName": string,
  "dataStoreConfigType": enum (DataStoreConfigType)
}
Felder
name

string

Der Name des Datenspeichers. Es sollte der Ressourcenname des Datenspeichers im Format projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId} sein. Bei APIs unter WidgetService, z. B. [WidgetService.LookUpWidgetConfig][], werden die Projektnummer und der Standortteil in diesem Feld gelöscht.
id

string

Nur Ausgabe. Die Kennung des Datenspeichers, der für den Widget-Dienst verwendet wird. Derzeit bezieht er sich auf „dataStoreId“. In Zukunft wird das Feld zur UUID des verschlüsselten Datenspeichernamens migriert.
displayName

string

Der Anzeigename des Datenspeichers.
entityName

string

Der Name der Entität, abgerufen aus Collection.data_connector.entities.entityName.
dataStoreConfigType

enum (DataStoreConfigType)

Nur Ausgabe. Der Typ der Datenspeicherkonfiguration.

DataStoreConfigType

Der Typ der Datenspeicherkonfiguration.

Enums
DATA_STORE_CONFIG_TYPE_UNSPECIFIED Standardwert. Dieser Wert wird nicht verwendet.
ALLOW_DB_CONFIG Der Datenspeicher ist mit AlloyDB verbunden
THIRD_PARTY_OAUTH_CONFIG Der Datenspeicher ist mit einer Drittanbieter-Datenquelle verbunden.
NOTEBOOKLM_CONFIG Der Datenspeicher ist mit NotebookLM Enterprise verbunden.

UiSettings

Beschreibt die allgemeinen UI-Einstellungen für Widgets (oder Web-Apps), die auf der Konfigurationsseite für die UI in der Cloud Console zu sehen sind.

JSON-Darstellung 
{
  "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),
    ...
  }
}
Felder
interactionType

enum (InteractionType)

Beschreibt den Interaktionstyp des Widgets (oder der Web-App)
generativeAnswerConfig

object (GenerativeAnswerConfig)

Beschreibt die Konfiguration generativer Antworten.
resultDescriptionType

enum (ResultDisplayType)

Steuert, ob und wie ein Ergebnisausschnitt angezeigt wird (Snippet oder extraktive Antwort). Wenn keine Angabe erfolgt, wird standardmäßig kein Ergebnis zurückgegeben.
enableAutocomplete

boolean

Gibt an, ob die automatische Vervollständigung aktiviert werden soll.
enableQualityFeedback

boolean

Sie können das Erfassen von Feedback zur Qualität der Suchergebnisse von Endnutzern aktivieren oder deaktivieren.
enableSearchAsYouType

boolean

Ob die Suche während der Eingabe für das Such-Widget aktiviert werden soll.
defaultSearchRequestOrderBy

string

Die Standardreihenfolge für Suchergebnisse, falls angegeben.

Wird verwendet, um SearchRequest#orderBy für entsprechende Anfragen festzulegen. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
dataStoreUiConfigs[]

object (DataStoreUiConfig)

Pro Datenspeicher.
disableUserEventsCollection

boolean

Wenn diese Option auf „true“ gesetzt ist, werden keine Nutzerereignisse für das Widget erfasst.
enableVisualContentSummary

boolean

Wenn diese Option auf „true“ gesetzt ist, wird im Widget bei entsprechenden Suchanfragen eine visuelle Inhaltszusammenfassung angezeigt. Wird nur für die Suche im Gesundheitswesen verwendet.
enableCreateAgentButton

boolean

Optional. Wenn diese Richtlinie auf „true“ gesetzt ist, wird die Schaltfläche „Agent erstellen“ im Widget aktiviert.
features

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

Nur Ausgabe. Feature-Konfiguration für die Engine, um Funktionen zu aktivieren oder zu deaktivieren. Unterstützte Schlüssel:

  • 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
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
modelConfigs

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

Nur Ausgabe. Ordnet einen Modellnamen der zugehörigen Konfiguration für diese Engine zu. So können Administratoren einzelne Modelle aktivieren oder deaktivieren. Hier werden nur Modelle gespeichert, deren Status vom Administrator überschrieben wird.

Wenn der Status nicht angegeben oder „modelConfigs“ für dieses Modell leer ist, entscheidet das System anhand der Standardkonfiguration, ob dieses Modell verfügbar sein soll. Ein Vorschaumodell sollte beispielsweise standardmäßig deaktiviert sein, wenn der Administrator es nicht aktiviert hat.

InteractionType

Beschreibt den Interaktionstyp.

Enums
INTERACTION_TYPE_UNSPECIFIED Nicht angegeben. Die Standardeinstellung ist SEARCH_ONLY.
SEARCH_ONLY Suchen ohne generative Antwort.
SEARCH_WITH_ANSWER Mit der generativen Antwort suchen
SEARCH_WITH_FOLLOW_UPS Suchen Sie mit der generativen Antwort, die Folgefragen unterstützt. Auch als mehrfache Suche bezeichnet.

GenerativeAnswerConfig

Beschreibt die Konfiguration für generative Antworten.

JSON-Darstellung 
{
  "resultCount": integer,
  "modelVersion": string,
  "modelPromptPreamble": string,
  "maxRephraseSteps": integer,
  "languageCode": string,
  "disableRelatedQuestions": boolean,
  "ignoreNonAnswerSeekingQuery": boolean,
  "ignoreAdversarialQuery": boolean,
  "ignoreLowRelevantContent": boolean,
  "imageSource": enum (ImageSource)
}
Felder
resultCount

integer

Die Anzahl der Top-Ergebnisse, aus denen die Antwort generiert werden soll. Bis zu 10.
modelVersion

string

Die Modellversion, die zum Generieren der Antwort verwendet wurde.
modelPromptPreamble

string

Text am Anfang des Prompts, der das Modell anweist, das die Antwort generiert.
maxRephraseSteps

integer

Maximale Anzahl der Schritte zum Umformulieren. Es sind maximal 5 Schritte möglich. Wenn der Wert nicht festgelegt oder auf < 1 gesetzt ist, wird er standardmäßig auf 1 gesetzt.
languageCode

string

Sprachcode für die Zusammenfassung. Verwenden Sie Sprachentags, wie von BCP47 definiert. Hinweis: Dies ist eine experimentelle Funktion.
ignoreNonAnswerSeekingQuery

boolean

Optional. Gibt an, ob Anfragen herausgefiltert werden sollen, die nicht auf eine Antwort abzielen. Der Standardwert ist false.

Es wird keine Antwort zurückgegeben, wenn die Suchanfrage als Anfrage klassifiziert wird, die nicht auf eine Antwort abzielt. Wenn dieses Feld auf true festgelegt ist, überspringen wir das Generieren von Antworten für Anfragen, die nicht auf eine Antwort abzielen, und geben stattdessen Fallback-Nachrichten zurück.
ignoreAdversarialQuery

boolean

Optional. Gibt an, ob feindselige Anfragen herausgefiltert werden sollen.
ignoreLowRelevantContent

boolean

Optional. Gibt an, ob Anfragen herausgefiltert werden sollen, die nicht relevant für die Inhalte sind.
imageSource

enum (ImageSource)

Optional. Quelle des in der Antwort zurückgegebenen Bildes.

ImageSource

Quelle des in der Antwort zurückgegebenen Bildes.

Enums
IMAGE_SOURCE_UNSPECIFIED Nicht angegebene Bildquelle (multimodale Funktion ist standardmäßig deaktiviert)
ALL_AVAILABLE_SOURCES Verhalten, wenn der Dienst die Auswahl aus allen verfügbaren Quellen bestimmt
CORPUS_IMAGE_ONLY Enthält Bild aus Korpus in der Antwort
FIGURE_GENERATION_ONLY Löst Abbildungsgenerierung in der Antwort aus

FeatureState

Der Status des Features für die Engine.

Enums
FEATURE_STATE_UNSPECIFIED Der Status der Funktion ist nicht angegeben.
FEATURE_STATE_ON Die Funktion ist aktiviert, um sie zugänglich zu machen.
FEATURE_STATE_OFF Die Funktion ist deaktiviert und kann nicht aufgerufen werden.

ModelState

Der Status des Modells für die Engine.

Enums
MODEL_STATE_UNSPECIFIED Der Modellstatus ist nicht angegeben.
MODEL_ENABLED Das Modell wurde vom Administrator aktiviert.
MODEL_DISABLED Das Modell wurde vom Administrator deaktiviert.

AccessSettings

Beschreibt die Zugriffseinstellungen für Widgets.

JSON-Darstellung 
{
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableWebApp": boolean,
  "workforceIdentityPoolProvider": string,
  "languageCode": string
}
Felder
allowPublicAccess

boolean

Gibt an, ob öffentlicher nicht authentifizierter Zugriff zulässig ist.
allowlistedDomains[]

string

Liste der Domains, in die das Such-Widget eingebunden werden darf.
enableWebApp

boolean

Gibt an, ob der Zugriff auf Web-Apps aktiviert ist.
workforceIdentityPoolProvider

string

Optional. Der Anbieter des Workforce Identity-Pools, der für den Zugriff auf das Widget verwendet wird.
languageCode

string

Optional. Sprachcode für die Benutzeroberfläche. Verwenden Sie Sprachentags, wie von BCP47 definiert. Wenn nicht festgelegt, ist der Standardsprachcode „en-US“.

UiBrandingSettings

Beschreibt die Einstellungen für das Branding der Benutzeroberfläche des Widgets.

JSON-Darstellung 
{
  "logo": {
    object (Image)
  }
}
Felder

Bild

Optionen zum Speichern eines Bildes

JSON-Darstellung 
{

  // Union field storage_method can be only one of the following:
  "url": string
  // End of list of possible types for union field storage_method.
}
Felder
Union-Feld storage_method. Verschiedene Möglichkeiten zum Speichern eines Bildes, z.B. als URL oder base64-codierter String. Für storage_method ist nur einer der folgenden Werte zulässig:
url

string

Bild-URL.

HomepageSetting

Beschreibt die Startseiteneinstellung des Widgets. Sie enthält alle Einstellungen und Konfigurationen, die mit der Startseite zusammenhängen, z. B. Verknüpfungen.

JSON-Darstellung 
{
  "shortcuts": [
    {
      object (Shortcut)
    }
  ]
}
Felder
shortcuts[]

object (Shortcut)

Optional. Die Verknüpfungen, die auf der Startseite angezeigt werden sollen.

Tastenkombination

Beschreibt eine Verknüpfungsentität (auch als angepinnte Inhalte bezeichnet) auf der Startseite. Auf der Startseite werden diese Verknüpfungen in derselben Reihenfolge wie in der API-Antwort gerendert. Wenn ein Kunde eine Verknüpfung neu anordnen oder entfernen möchte, sollte die Benutzeroberfläche immer die neue vollständige Liste der Verknüpfungen anzeigen.

JSON-Darstellung 
{
  "title": string,
  "icon": {
    object (Image)
  },
  "destinationUri": string
}
Felder
title

string

Optional. Titel der Verknüpfung.
icon

object (Image)

Optional. Symbol-URL der Verknüpfung.
destinationUri

string

Optional. Ziel-URL der Verknüpfung.

AssistantSettings

Beschreibt die Assistant-Einstellungen des Widgets.

JSON-Darstellung 
{
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "disableLocationContext": boolean
}
Felder
googleSearchGroundingEnabled
(deprecated)

boolean

Gibt an, ob der Schalter für die Fundierung mit der Google Suche angezeigt wird. Verworfen Verwenden Sie stattdessen webGroundingType.
webGroundingType

enum (WebGroundingType)

Optional. Der Typ der zu verwendenden Web-Fundierung.
defaultWebGroundingToggleOff

boolean

Nur Ausgabe. Mit diesem Feld wird die standardmäßige Umschaltfläche für die Web-Grundlage für Endnutzer gesteuert, wenn webGroundingType auf WEB_GROUNDING_TYPE_GOOGLE_SEARCH oder WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH festgelegt ist. Standardmäßig ist dieses Feld auf „false“ gesetzt. Wenn webGroundingType WEB_GROUNDING_TYPE_GOOGLE_SEARCH oder WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH ist, ist die Web-Fundierung für Endnutzer standardmäßig auf der Benutzeroberfläche aktiviert. Wenn der Wert „true“ festgelegt ist, wird die Ein-/Aus-Schaltfläche für die Fundierung standardmäßig in der Benutzeroberfläche deaktiviert. Endnutzer können die Web-Fundierung weiterhin in der Benutzeroberfläche aktivieren, wenn sie aktiviert ist.
disableLocationContext

boolean

Optional. Nur Ausgabe. Gibt an, ob der Kontext des Nutzerstandorts deaktiviert werden soll.

WebGroundingType

Der Typ der zu verwendenden Web-Fundierung.

Enums
WEB_GROUNDING_TYPE_UNSPECIFIED Nicht spezifizierte Standardeinstellung. Dies entspricht „Deaktiviert“.
WEB_GROUNDING_TYPE_DISABLED Die Web-Fundierung ist deaktiviert.

CustomerProvidedConfig

Vom Kunden bereitgestellte Konfigurationen

JSON-Darstellung 
{
  "customerType": enum (CustomerType)
}
Felder
customerType

enum (CustomerType)

Kundentyp

CustomerType

Kundentyp

Enums
DEFAULT_CUSTOMER Standardkundentyp.
GOVERNMENT_CUSTOMER Kundentyp für Behörden. Einige Funktionen sind aufgrund rechtlicher Anforderungen für Kunden aus dem öffentlichen Sektor deaktiviert.

Methoden

get

 Ruft eine WidgetConfig ab.

patch

 Aktualisiert eine „WidgetConfig“