REST Resource: projects.locations.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,
  "experimentalFeatures": {
    string: string,
    ...
  },
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": 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 Derzeit werden title, thumbnail, url, custom1, custom2 und custom3 unterstützt.

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
experimentalFeatures

map (key: string, value: string)

Ermöglicht das Ein- und Ausschalten instabiler/experimenteller Funktionen im Widget (oder in der Web-App)
uiSettings

object (UiSettings)

Hier werden die allgemeinen Einstellungen für die Suche in Widgets beschrieben, 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. den 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.

Methoden

get

 Erstellt einen WidgetConfig.