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

Recurso: WidgetConfig

WidgetConfig captura la configuración a nivel del widget.

Representación 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,
  "experimentalFeatures": {
    string: string,
    ...
  },
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": boolean
}
Campos
name

string

Inmutable. Es el nombre completo del recurso de la configuración del widget. Formato: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}.

Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.
displayName

string

Obligatorio. Es el nombre visible de la configuración del widget legible por humanos. Se usa en la IU de Discovery.

Este campo debe ser una cadena codificada en UTF-8 con un límite de 128 caracteres. De lo contrario, se muestra un error INVALID_ARGUMENT.
createTime

string (Timestamp format)

Solo salida. Es la marca de tiempo en la que se creó el objeto WidgetConfig.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo salida. Es la marca de tiempo en la que se actualizó WidgetConfig.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
enableAutocomplete
(deprecated)

boolean

Indica si se debe habilitar la función de autocompletar.
fieldsUiComponentsMap
(deprecated)

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

La clave es el componente de la IU. Simulación. Actualmente, se admiten title, thumbnail, url, custom1, custom2 y custom3.

El valor es el nombre del campo junto con su visibilidad del dispositivo.

Los 3 campos personalizados son opcionales y se pueden agregar o quitar. title, thumbnail y url son componentes de la IU obligatorios que no se pueden quitar.
facetField[]
(deprecated)

object (FacetField)

Son la configuración y la apariencia de las facetas en la vista del usuario final.
dataStoreType

enum (DataStoreType)

Solo salida. Es el tipo de almacén de datos principal.
contentSearchSpec
(deprecated)

object (ContentSearchSpec)

Es la especificación de búsqueda de contenido que configura el comportamiento deseado de la búsqueda de contenido.
enableSummarization
(deprecated)

boolean

Activa o desactiva la generación de resúmenes para la respuesta de la búsqueda.
enableSnippetResultSummary
(deprecated)

boolean

Activa o desactiva el resumen para cada resultado de fragmento.
configId

string

Solo salida. Es el identificador único ofuscado de un WidgetConfig.
enableQualityFeedback
(deprecated)

boolean

Activa o desactiva la recopilación de comentarios sobre la calidad de los resultados de la búsqueda de los usuarios finales.
solutionType

enum (SolutionType)

Obligatorio. Inmutable. Especifica el tipo de solución para el que se puede usar este WidgetConfig.
industryVertical

enum (IndustryVertical)

Solo salida. Es el sector vertical de la industria que registra WidgetConfig. La vertical de la industria de WidgetConfig se basa en el objeto Engine asociado.
allowPublicAccess
(deprecated)

boolean

Indica si se permite la integración sin autenticación con el widget. Si se establece como verdadero, se permite el acceso público a la búsqueda o a otras soluciones desde el widget sin el token de autenticación proporcionado por el servidor de backend alojado por el cliente.
allowlistedDomains[]
(deprecated)

string

Son los dominios incluidos en la lista de entidades permitidas que pueden cargar este widget.
llmEnabled

boolean

Solo salida. Indica si el LLM está habilitado en el almacén de datos correspondiente.
enableResultScore

boolean

Indica si se debe mostrar la puntuación del resultado.
resultDisplayType
(deprecated)

enum (ResultDisplayType)

Es el tipo de fragmento que se mostrará en el widget de UCS.

  • RESULT_DISPLAY_TYPE_UNSPECIFIED para usuarios existentes.
  • Es el fragmento para los usuarios nuevos de la Búsqueda que no son empresariales.
  • EXTRACTIVE_ANSWER para usuarios nuevos de la búsqueda empresarial.
minimumDataTermAccepted

boolean

Solo salida. Indica si el cliente aceptó las condiciones de uso de datos.
enableWebApp
(deprecated)

boolean

Indica si se debe habilitar la app web independiente.
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

Parámetros de configuración de la IU configurables por almacén de datos.
collectionComponents[]

object (CollectionComponent)

Solo salida. Componentes de recopilación que enumeran todas las colecciones y los almacenes de datos secundarios asociados con la configuración del widget. Esas fuentes de datos se pueden usar para filtrar en las APIs del servicio de widgets. Los usuarios pueden devolver resultados de las fuentes de datos seleccionadas.
enableSearchAsYouType
(deprecated)

boolean

Indica si se debe habilitar el comportamiento de búsqueda mientras escribes para el widget de búsqueda.
defaultSearchRequestOrderBy
(deprecated)

string

Es el orden predeterminado de los resultados de la búsqueda si se especifica.

Se usa para establecer SearchRequest#orderBy en las solicitudes aplicables. 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)

Permite activar o desactivar funciones inestables o experimentales en el widget (o la app web).
uiSettings

object (UiSettings)

Describe la configuración general de la búsqueda de widgets, como se ve en la página de configuración de widgets de la consola de Cloud. Reemplaza las propiedades de nivel superior principales que dejaron de estar disponibles.
accessSettings

object (AccessSettings)

Se usará para todos los parámetros de configuración de acceso a widgets que se vean en la página de integración de la consola de Cloud. Reemplaza las propiedades de nivel superior principales que dejaron de estar disponibles.
uiBranding

object (UiBrandingSettings)

Describe la configuración de desarrollo de la marca de la IU del widget de búsqueda, como el título, el logotipo, los favicons y los colores del widget.
homepageSetting

object (HomepageSetting)

Opcional. Describe la configuración de la página principal del widget.
assistantSettings

object (AssistantSettings)

Opcional. Solo salida. Describe la configuración del asistente del widget.
customerProvidedConfig

object (CustomerProvidedConfig)

Opcional. Solo salida. Describe la configuración relacionada con el cliente, que actualmente solo se usa para los clientes gubernamentales. Este campo no se puede modificar después de la incorporación del proyecto.
enablePrivateKnowledgeGraph

boolean

Opcional. Solo salida. Indica si se debe habilitar el gráfico de conocimiento privado.

Métodos

get

 Obtienes una WidgetConfig.