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

Recurso: WidgetConfig

WidgetConfig captura las configuraciones a nivel de 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. 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 1024 caracteres.
displayName

string

Obligatorio. Nombre visible de la configuración del widget legible por humanos. Se usa en la interfaz de usuario de Discovery.

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

string (Timestamp format)

Solo de salida. Marca de tiempo de creación del WidgetConfig.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "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 de salida. Marca de tiempo en la que se actualizó WidgetConfig.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "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 el autocompletado.
fieldsUiComponentsMap
(deprecated)

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

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

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

Los tres campos personalizados son opcionales y se pueden añadir o quitar. title, thumbnail y url son componentes de la interfaz de usuario obligatorios que no se pueden quitar.
facetField[]
(deprecated)

object (FacetField)

La configuración y el aspecto de las facetas en la vista del usuario final.
dataStoreType

enum (DataStoreType)

Solo de salida. El tipo del almacén de datos superior.
contentSearchSpec
(deprecated)

object (ContentSearchSpec)

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 función de resumen de la respuesta de búsqueda.
enableSnippetResultSummary
(deprecated)

boolean

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

string

Solo de salida. Identificador único ofuscado de un WidgetConfig.
enableQualityFeedback
(deprecated)

boolean

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

enum (SolutionType)

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

enum (IndustryVertical)

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

boolean

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

string

Dominios incluidos en la lista de permitidos que pueden cargar este widget.
llmEnabled

boolean

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

boolean

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

enum (ResultDisplayType)

El tipo de fragmento que se mostrará en el widget de respuesta predefinida.

  • RESULT_DISPLAY_TYPE_UNSPECIFIED para los usuarios actuales.
  • SNIPPET para nuevos usuarios de búsqueda que no sean de empresa.
  • EXTRACTIVE_ANSWER para nuevos usuarios de la búsqueda empresarial.
minimumDataTermAccepted

boolean

Solo de salida. Indica si el cliente ha aceptado los términos de uso de los datos.
enableWebApp
(deprecated)

boolean

Indica si se debe habilitar la aplicación web independiente.
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

Configuraciones de interfaz de usuario configurables por almacén de datos.
collectionComponents[]

object (CollectionComponent)

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

boolean

Si se debe habilitar el comportamiento de búsqueda a medida que se escribe en el widget de búsqueda
defaultSearchRequestOrderBy
(deprecated)

string

El orden predeterminado de los resultados de búsqueda, si se especifica.

Se usa para definir 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 en la aplicación web).
uiSettings

object (UiSettings)

Describe los ajustes generales de búsqueda de widgets tal como se ven en la página de configuración de widgets de la consola de Cloud. Sustituye las propiedades de nivel superior obsoletas.
accessSettings

object (AccessSettings)

Se usará para todos los ajustes de acceso a widgets que se vean en la página de integración de la consola de Cloud. Sustituye las propiedades de nivel superior obsoletas.
uiBranding

object (UiBrandingSettings)

Describe los ajustes de marca de la interfaz de usuario del widget de búsqueda, como el título, el logotipo, los favicons y los colores del widget.
homepageSetting

object (HomepageSetting)

Opcional. Describe los ajustes de la página principal del widget.
assistantSettings

object (AssistantSettings)

Opcional. Solo de salida. Describe los ajustes del Asistente del widget.
customerProvidedConfig

object (CustomerProvidedConfig)

Opcional. Solo de salida. Describe las configuraciones relacionadas con el cliente. Actualmente, solo se usa para clientes públicos. Este campo no se puede modificar después de incorporar el proyecto.
enablePrivateKnowledgeGraph

boolean

Opcional. Solo de salida. Si quieres habilitar el gráfico de conocimiento privado.

Métodos

get

 Obtiene un WidgetConfig.