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,
  "batchAuthStatuses": [
    {
      object (BatchAuthStatus)
    }
  ],
  "nodes": [
    {
      object (Node)
    }
  ]
}
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 Endnutzerfeedback zur Qualität der Suchergebnisse 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.

Bei SaaS-/Business-Engines wird diese Liste zusätzlich mit synthetischen Platzhalter-Einträgen für Connectors ergänzt, die der Aufrufer möglicherweise anhängen, aber noch nicht angehängt hat (siehe CollectionComponent für den Platzhaltervertrag), wenn LookupWidgetConfig mit view = WITH_AVAILABLE_CONNECTORS aufgerufen wird. Das Frontend kann daher eine einheitliche Liste der bereits angehängten und der zum Anhängen verfügbaren Quellen rendern, indem es dieses einzelne Feld durchläuft. Bei Enterprise-Engines und der Standard-Engine view werden nur bereits verknüpfte Connectors zurückgegeben (aktuelles Verhalten).
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.
batchAuthStatuses[]

object (BatchAuthStatus)

Nur Ausgabe. Die Batch-Autorisierungsstatus für die Connectors des Widgets.
nodes[]

object (Node)

Nur Ausgabe. Die Knoten, die der Widget-Konfiguration zugeordnet sind.

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 der Wert 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 für extrahierte 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. Er muss dem Format des Datenspeicherressourcennamens entsprechen: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. 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 sie 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.

Bei SaaS-/Business-Engines werden Instanzen dieser Meldung, wenn LookupWidgetConfig mit view = WITH_AVAILABLE_CONNECTORS aufgerufen wird, auch verwendet, um synthetische Platzhalter-Einträge für Connectors darzustellen, die der Aufrufer möglicherweise anhängt, aber noch nicht angehängt hat. Platzhalter-Einträge haben connectorAuthState.auth_state == AUTH_STATE_UNSPECIFIED (oder NO_AUTH), ein leeres connectorAuthState.authorization_uri (das Widget ruft WidgetBuildAuthorizationUrl auf, wenn der Nutzer auf „Verbinden“ klickt) und synthetische Platzhalterwerte in name / id (siehe Feldkommentare). Felder, die nur für materialisierte Connectors (dataStoreComponents, tenant, actionConnector) sinnvoll sind, werden für Platzhalter-Einträge nicht festgelegt.

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

string

Der Name der Sammlung. Er sollte dem Namen der Sammlungsressource entsprechen. 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.

Bei synthetischen Platzhalter-Einträgen (siehe Kommentar auf Nachrichtenebene) enthält dieses Feld eine synthetische Platzhalter-Sammlungs-ID, die keiner echten Sammlung entspricht. Anrufer dürfen nicht versuchen, diese Ressource aufzulösen oder abzurufen, bis der Nutzer den Connector autorisiert hat.
id

string

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

Für synthetische Platzhalter-Einträge (siehe Kommentar auf Nachrichtenebene) ist dies eine synthetische Platzhalter-ID, keine echte „collectionId“.
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.
connectorAuthState

object (ConnectorAuthState)

Nur Ausgabe. Der Autorisierungs-URI der Connector-Quelle.

DataStoreComponent

Schreibgeschützte Datenspeicherkomponente mit Datenspeicherfeldern, die zum Filtern verwendet werden können. Sie ist das untergeordnete Element von CollectionComponent.

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

string

Der Name des Datenspeichers. Er muss dem Format des Datenspeicherressourcennamens entsprechen: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. 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 sie 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.
workspaceType

enum (Type)

Nur Ausgabe. Workspace-Quelltypen für Workspace-Daten, die aus DataStore.workspace_config.type abgerufen werden.
contentConfig

enum (ContentConfig)

Nur Ausgabe. Die Inhaltskonfiguration des Datenspeichers.
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.

ConnectorAuthState

Schreibgeschützter Connector im Authentifizierungsstatus „CollectionComponent“.

JSON-Darstellung 
{
  "authState": enum (AuthState),
  "authorizationUri": string,
  "updateTime": string
}
Felder
authState

enum (AuthState)

Nur Ausgabe. Der Autorisierungsstatus des Daten-Connectors.
authorizationUri

string

Nur Ausgabe. Der Autorisierungs-URI für den Daten-Connector.

Bei synthetischen Platzhalter-Einträgen CollectionComponent, die von LookupWidgetConfig mit view = WITH_AVAILABLE_CONNECTORS für SaaS-/Business-Engines zurückgegeben werden, ist dieses Feld leer. Das Widget sollte bei einem Klick des Nutzers auf „Verbinden“ WidgetService.WidgetBuildAuthorizationUrl aufrufen, um eine neu erstellte Autorisierungs-URL abzurufen.
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel der Aktualisierung des Autorisierungsstatus.

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".

AuthState

Der Autorisierungsstatus des Daten-Connectors.

Enums
AUTH_STATE_UNSPECIFIED Standardwert. Wird auch für synthetische Platzhalter-Einträge CollectionComponent zurückgegeben, die von LookupWidgetConfig mit view = WITH_AVAILABLE_CONNECTORS (nur SaaS / Business) angezeigt werden. Diese Einträge stellen Connectors dar, die der Aufrufer anhängen kann, aber noch nicht angehängt hat.
AUTHORIZED Der Nutzer hat den Daten-Connector autorisiert.
EXPIRED Die Nutzerautorisierung für den Daten-Connector ist abgelaufen.
ACTIONS_DISABLED Der Nutzer kann weiterhin Suchanfragen stellen, aber Aktionen müssen aktiviert sein.
NO_AUTH Für den Daten-Connector ist keine Autorisierung erforderlich. Wird auch für Platzhalter verwendet, für deren zugrunde liegenden Connector kein Nutzer-OAuth erforderlich ist.

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),
    ...
  },
  "searchAddonSpec": {
    object (SearchAddonSpec)
  },
  "modelConfigInfo": {
    object (ModelConfigInfo)
  },
  "sourceAdminDisplayNameEnabled": boolean,
  "onedrivePickerEnabled": boolean,
  "googleDrivePickerEnabled": boolean
}
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 extrahierte 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 Endnutzerfeedback zur Qualität der Suchergebnisse 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 Datenspeicherkonfiguration.
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 der Button „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
  • personalization-suggested-highlights
  • mobile-app-access
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
  • disable-canvas
  • canvas-workspace
  • disable-skills
  • disable-projects
  • enable-end-user-sharing-with-groups
  • single-agent-orchestration
  • multi-agent-orchestration
  • cross-product-intelligence
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 Modell der Vorabversion sollte beispielsweise standardmäßig deaktiviert sein, wenn der Administrator es nicht aktiviert hat.
searchAddonSpec

object (SearchAddonSpec)

Optional. Mit SearchAddonSpec werden Add-ons für die Suche deaktiviert. Dieses Feld wird nur für Suchanfragen unterstützt.
modelConfigInfo

object (ModelConfigInfo)

Nur Ausgabe. Die aufgelöste serverseitige Ansicht der Konfiguration der Modellauswahl. Enthält sowohl die geordnete Liste der Modelle, die im Drop-down-Menü für die Modellauswahl angezeigt werden sollen, als auch das Modell, das standardmäßig ausgewählt werden soll.

Clients sollten diese direkt rendern, ohne eigene Filterung, Sortierung oder Lokalisierung anzuwenden. Die alte modelConfigs-Karte oben wird zur Abwärtskompatibilität mit Clients beibehalten, die noch nicht auf die Verwendung dieses Felds umgestellt wurden.
sourceAdminDisplayNameEnabled

boolean

Optional. Gibt an, ob der vom Administrator konfigurierte Anzeigename für Daten-Connectors in der Benutzeroberfläche für Widget-Quellen (anstelle des Connector-Typs) angezeigt werden soll. Aktivierung erforderlich; Standardeinstellung ist „false“.
onedrivePickerEnabled

boolean

Nur Ausgabe. Gibt an, ob die OneDrive-Dateiauswahl für Endnutzer verfügbar ist. Wird vom Backend aus der Aktivierung des Admin-Connectors (Business-Version) oder der angehängten OneDrive-Connectors (Enterprise-Version) in Kombination mit der vorhandenen disable-onedrive-upload-Admin-Funktion berechnet.

optional deklariert, damit ein explizit berechnetes false mit Feldpräsenz serialisiert wird. Bei einem einfachen proto3-bool wird ein Standard-false über die Leitung gesendet. Dadurch konnten Clients nicht zwischen „Auswahl deaktiviert“ (false) und „Feld nicht ausgefüllt“ (nicht festgelegt) unterscheiden.
googleDrivePickerEnabled

boolean

Nur Ausgabe. Gibt an, ob die Google Drive-Dateiauswahl für Endnutzer verfügbar ist. optional wurde aus demselben Grund für die Feldpräsenz wie onedrivePickerEnabled oben deklariert.

InteractionType

Beschreibt den Interaktionstyp.

Enums
INTERACTION_TYPE_UNSPECIFIED Nicht angegeben. Die Standardeinstellung ist SEARCH_ONLY.
SEARCH_ONLY Ohne generative Antwort suchen.
SEARCH_WITH_ANSWER Mit der generativen Antwort suchen.
SEARCH_WITH_FOLLOW_UPS Mit der generativen Antwort, die Folgefragen unterstützt, suchen. Auch als Suche in mehreren Schritten 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 wird.
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 < 1 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 Abfragen herausgefiltert werden sollen, die nicht auf eine Antwort abzielen. Der Standardwert ist false.

Es wird keine Antwort zurückgegeben, wenn die Suchanfrage als Abfrage 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 schädliche Abfragen herausgefiltert werden sollen.
ignoreLowRelevantContent

boolean

Optional. Gibt an, ob Abfragen 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 der Funktion 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.

SearchAddonSpec

Mit SearchAddonSpec werden Add-ons für die Suche deaktiviert. Wenn dieses Feld nicht angegeben ist, werden Add-ons standardmäßig überall aktiviert, wo sie anwendbar sind.

JSON-Darstellung 
{
  "semanticAddOnDisabled": boolean,
  "kpiPersonalizationAddOnDisabled": boolean,
  "generativeAnswerAddOnDisabled": boolean
}
Felder
semanticAddOnDisabled

boolean

Optional. Wenn „true“, ist das semantische Add-on deaktiviert. Das semantische Add-on umfasst Einbettungen und Jetstream.
kpiPersonalizationAddOnDisabled

boolean

Optional. Bei „true“ werden das Neuklassifizieren von Ereignissen und die Personalisierung deaktiviert, um KPIs zu optimieren und Ergebnisse zu personalisieren.
generativeAnswerAddOnDisabled

boolean

Optional. Wenn „true“ festgelegt ist, ist das Add-on für generative Antworten deaktiviert. Das Add-on für generative Antworten umfasst natürliche Sprache für Filter und einfache Antworten.

ModelConfigInfo

Die aufgelöste serverseitige Ansicht der Konfiguration der Modellauswahl für den Endnutzer. Das Backend berechnet dies pro Anfrage, indem es in der folgenden Reihenfolge anwendet: Mendel-Flag-Auswertung, Regeln zur regionalen Verfügbarkeit basierend auf dem Standort der Engine und Überschreibungen über das Admin-Panel aus modelConfigs.

Das Backend ist die einzige Quelle für diese Konfiguration. Clients sollten resolvedModels direkt im Drop-down-Menü für die Modellauswahl in der angegebenen Reihenfolge rendern, ohne eigene Filterung, Sortierung oder Lokalisierung anzuwenden.

JSON-Darstellung 
{
  "resolvedModels": [
    {
      object (ResolvedModel)
    }
  ],
  "defaultModelId": string
}
Felder
resolvedModels[]

object (ResolvedModel)

Nur Ausgabe. Die Liste der Modelle, die dem Endnutzer in der Modellauswahl zur Verfügung stehen, in der Reihenfolge, in der sie angezeigt werden sollen.
defaultModelId

string

Nur Ausgabe. Die modelId des Modells, das standardmäßig in der Modellauswahl ausgewählt werden soll, wenn der Endnutzer keine explizite Auswahl getroffen hat. Der Wert ist immer einer der modelId in resolvedModels.

ResolvedModel

Ein einzelnes Modell, das im Modellselektor für den Endnutzer verfügbar ist, mit allen lokalisierten Anzeigemetadaten.

JSON-Darstellung 
{
  "modelId": string,
  "displayName": string,
  "icon": string,
  "description": string,
  "isPreview": boolean,
  "adminView": {
    object (AdminView)
  }
}
Felder
modelId

string

Nur Ausgabe. Eindeutige Kennung des Modells (z.B. gemini-2.5-flash, gemini-3.1-pro-preview).

Dies ist dieselbe Kennung, die Clients an den Assistentendienst zurückgeben, um dieses Modell auszuwählen. Virtuelle oder „Pseudo“-Modelle (z. B. gemini-fast) sind hier ebenfalls gültige Werte. Sie werden im Backend in das zugrunde liegende konkrete Modell aufgelöst.
displayName

string

Nur Ausgabe. Lokalisierter Anzeigename des Modells, z.B. Gemini 3.1 Pro. Serverseitige Lokalisierung basierend auf LookupWidgetConfigRequest.language_code und LookupWidgetConfigRequest.region_code der Anfrage.
icon

string

Nur Ausgabe. GM3-kompatibles Symbol-Token, das dem Modell zugeordnet ist (z.B. rocket_launch, bolt, graph_5).
description

string

Nur Ausgabe. Lokalisierter Beschreibungstext (z.B. state-of-the-art reasoning). Die Lokalisierung erfolgt in derselben Sprache wie displayName.
isPreview

boolean

Nur Ausgabe. Gibt an, ob sich das Modell derzeit in der Vorschau befindet. Kunden sollten dies über das „Vorschau“-Logo auf der Benutzeroberfläche der Auswahl kennzeichnen.
adminView

object (AdminView)

Nur Ausgabe. Metadaten der Admin-Oberfläche, die nur für die Seite „Funktionssteuerung“ des Konsolenadministrators (siehe AdminView) ausgefüllt werden. Für Endnutzer-Oberflächen nicht festgelegt.

AdminView

Metadaten der Administratoroberfläche. Wird nur ausgefüllt, wenn die Anfrage von der Seite „Funktionssteuerung“ in der Cloud Console stammt. Für Endnutzer-Oberflächen (Web, Mobil) wird der Wert nicht festgelegt. Die Ein-/Aus-Schalttabelle der Admin-Seite wird direkt vom Backend gerendert, anstatt von einer hartcodierten clientseitigen Registrierung.

JSON-Darstellung 
{
  "adminOverridable": boolean,
  "enabledByDefault": boolean,
  "regions": [
    string
  ]
}
Felder
adminOverridable

boolean

Nur Ausgabe. Gibt an, ob der Administrator den Aktivierungs-/Deaktivierungsstatus dieses Modells über UiSettings.model_configs ändern kann. Abgeleitet von MODEL_TAG_ADMIN_OVERRIDABLE. Wenn „false“, wird das Modell „erzwungen“ und sein Zustand unterliegt enabledByDefault.
enabledByDefault

boolean

Nur Ausgabe. Gibt an, ob das Modell aktiviert ist, wenn der Administrator in UiSettings.model_configs keine explizite Überschreibung festgelegt hat. Abgeleitet von MODEL_TAG_ENABLED_BY_DEFAULT.
regions[]

string

Nur Ausgabe. Regionen, in denen dieses Modell eingeführt wird.

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

Image-URL

HomepageSetting

Beschreibt die Startseiteneinstellungen des Widgets. Dies umfasst alle Einstellungen und Konfigurationen, die mit der Startseite zusammenhängen, z. B. Tastenkombinationen.

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

object (Shortcut)

Optional. Die Tastenkombinationen, die auf der Startseite angezeigt werden sollen.

Tastenkombination

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

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

string

Optional. Titel der Tastenkombination.
icon

object (Image)

Optional. Symbol-URL der Tastenkombination.
destinationUri

string

Optional. Ziel-URL der Tastenkombination.

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 Ein/Aus-Button 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 der Ein-/Aus-Button 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 „Behörden“. Einige Funktionen sind aufgrund rechtlicher Anforderungen für Kunden aus dem öffentlichen Sektor deaktiviert.

BatchAuthStatus

Beschreibt den Status der Batchautorisierung für eine „batchAuthorizationGroup“.

JSON-Darstellung 
{
  "placeholder": string,
  "batchAuthorizationGroup": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  }
}
Felder
placeholder

string

Nur Ausgabe. Es ist der Platzhalter für den vollständigen Ressourcenname der Batch-Autorisierungsgruppe. Dies ist kein echter Daten-Connector (er ist nicht in der DataConnector-Tabelle in Spanner vorhanden). Es handelt sich um einen Ressourcennamen, der nur in der connector_authorization in der Nutzertabelle vorhanden ist. Beispiel: projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector.
batchAuthorizationGroup

string

Nur Ausgabe. Die Batch-Autorisierungsgruppe, zu der der Platzhalter gehört.
connectorAuthState

object (ConnectorAuthState)

Nur Ausgabe. Der aktuelle Autorisierungsstatus für diesen Connector.

Knoten

Stellt eine einzelne wiederverwendbare Rechen- oder Logikeinheit dar.

JSON-Darstellung 
{
  "displayName": string,
  "iconUrl": string,
  "description": string,
  "parameterSchema": {
    object
  },
  "outputSchema": {
    object
  },
  "type": enum (Type)
}
Felder
displayName

string

Nur Ausgabe. Ein für Menschen lesbarer Name für den Knoten.
iconUrl

string

Nur Ausgabe. Eine ID oder URL, die auf ein Symbol für diesen Knotentyp verweist.
description

string

Nur Ausgabe. Eine detaillierte Beschreibung der Funktion des Knotens.
parameterSchema

object (Struct format)

Nur Ausgabe. Das Parameterschema des Tools.

Dieses Schema muss dem OpenAPI-Schema-Standard entsprechen (siehe https://spec.openapis.org/oas/v3.0.3.html und AIP-146). Hier wird die erwartete Struktur der Parameter beschrieben, die von diesem Knoten akzeptiert werden.
outputSchema

object (Struct format)

Nur Ausgabe. Das Ausgabeschema des Tools.

Dieses Schema muss dem OpenAPI-Schema-Standard entsprechen (siehe https://spec.openapis.org/oas/v3.0.3.html/ und AIP-146). Sie beschreibt die Struktur der Ausgabe dieses Knotens.
type

enum (Type)

Nur Ausgabe. Der Typ des Knotens.

Typ

Gibt den Typ des Knotens im Agent-Ablauf an.

Enums
TYPE_UNSPECIFIED Nicht definierter Typ.
TRIGGER Triggertyp
FLOW Vorgangstyp.
CONNECTOR Anschlussstecker-Typ.

Methoden

get

 Ruft eine WidgetConfig ab.

patch

 Aktualisiert eine WidgetConfig.