- Recurso: WidgetConfig
- Representación JSON
- UIComponentField
- DeviceVisibility
- FacetField
- DataStoreType
- ResultDisplayType
- DataStoreUiConfig
- CollectionComponent
- DataStoreComponent
- DataStoreConfigType
- UiSettings
- InteractionType
- GenerativeAnswerConfig
- ImageSource
- FeatureState
- AccessSettings
- UiBrandingSettings
- Imagen
- HomepageSetting
- Acceso directo
- AssistantSettings
- WebGroundingType
- CustomerProvidedConfig
- CustomerType
- Métodos
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 ( |
Campos | |
---|---|
name |
Inmutable. Nombre completo del recurso de la configuración del widget. Formato: Este campo debe ser una cadena codificada en UTF-8 con un límite de 1024 caracteres. |
displayName |
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 |
Solo de salida. Marca de tiempo de creación del 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: |
updateTime |
Solo de salida. Marca de tiempo en la que se actualizó 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: |
enableAutocomplete |
Indica si se debe habilitar el autocompletado. |
fieldsUiComponentsMap |
La clave es el componente de la interfaz de usuario. Simulación. Actualmente, se admiten 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. |
facetField[] |
La configuración y el aspecto de las facetas en la vista del usuario final. |
dataStoreType |
Solo de salida. El tipo del almacén de datos superior. |
contentSearchSpec |
La especificación de búsqueda de contenido que configura el comportamiento deseado de la búsqueda de contenido. |
enableSummarization |
Activa o desactiva la función de resumen de la respuesta de búsqueda. |
enableSnippetResultSummary |
Activa o desactiva el resumen de cada resultado de fragmento. |
configId |
Solo de salida. Identificador único ofuscado de un |
enableQualityFeedback |
Activa o desactiva la recogida de comentarios de los usuarios finales sobre la calidad de los resultados de búsqueda. |
solutionType |
Obligatorio. Inmutable. Especifica el tipo de solución para el que se puede usar este WidgetConfig. |
industryVertical |
Solo de salida. El vertical del sector que registra WidgetConfig. El vertical de la industria de WidgetConfig se basa en el |
allowPublicAccess |
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[] |
Dominios incluidos en la lista de permitidos que pueden cargar este widget. |
enableSafeSearch |
Si se debe habilitar la búsqueda segura. |
enableConversationalSearch |
Indica si se permite la búsqueda conversacional (LLM, varias interacciones) o no (sin LLM, una sola interacción). |
llmEnabled |
Solo de salida. Si el LLM está habilitado en el almacén de datos correspondiente. |
enableResultScore |
Si se debe mostrar la puntuación del resultado. |
resultDisplayType |
El tipo de fragmento que se mostrará en el widget de respuesta predefinida.
|
minimumDataTermAccepted |
Solo de salida. Indica si el cliente ha aceptado los términos de uso de los datos. |
enableWebApp |
Indica si se debe habilitar la aplicación web independiente. |
dataStoreUiConfigs[] |
Configuraciones de interfaz de usuario configurables por almacén de datos. |
collectionComponents[] |
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 |
Si se debe habilitar el comportamiento de búsqueda a medida que se escribe en el widget de búsqueda |
defaultSearchRequestOrderBy |
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 |
Permite activar o desactivar funciones inestables o experimentales en el widget (o en la aplicación web). |
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 |
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 |
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 |
Opcional. Describe los ajustes de la página principal del widget. |
assistantSettings |
Opcional. Solo de salida. Describe los ajustes del Asistente del widget. |
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 |
Opcional. Solo de salida. Si quieres habilitar el gráfico de conocimiento privado. |
UIComponentField
Campo de faceta que se asigna a un componente de interfaz de usuario.
Representación JSON |
---|
{
"field": string,
"deviceVisibility": [
enum ( |
Campos | |
---|---|
field |
Obligatorio. Nombre del campo registrado. El formato es |
deviceVisibility[] |
La visibilidad de los campos en diferentes tipos de dispositivos. |
displayTemplate |
Plantilla para personalizar cómo se muestra el campo. Por ejemplo, el valor sería una cadena como "Precio: {value}". |
DeviceVisibility
La visibilidad del campo en diferentes tipos de dispositivos.
Enumeraciones | |
---|---|
DEVICE_VISIBILITY_UNSPECIFIED |
Valor predeterminado cuando no se especifica. El servidor devuelve INVALID_ARGUMENT si se usa en solicitudes. |
MOBILE |
El componente de la interfaz de usuario se muestra en dispositivos móviles. |
DESKTOP |
El componente de interfaz de usuario está visible en el cliente basado en navegador. |
FacetField
Campos de faceta que almacenan la asignación de campos a la apariencia del widget del usuario final.
Representación JSON |
---|
{ "field": string, "displayName": string } |
Campos | |
---|---|
field |
Obligatorio. Nombre del campo registrado. El formato es |
displayName |
Opcional. Nombre del campo que verán los usuarios finales. |
DataStoreType
El tipo del almacén de datos principal del widget.
Enumeraciones | |
---|---|
DATA_STORE_TYPE_UNSPECIFIED |
Tipo de almacén de datos no especificado. |
SITE_SEARCH |
El almacén de datos principal contiene un buscador de sitios. |
STRUCTURED |
El almacén de datos principal contiene un buscador de datos estructurados. |
UNSTRUCTURED |
El almacén de datos principal contiene un motor de búsqueda de datos no estructurados. |
BLENDED |
El almacén de datos principal se usa para la búsqueda combinada con varios almacenes de datos. |
ResultDisplayType
El tipo de resultado que se mostrará en el widget de ucs.
Enumeraciones | |
---|---|
RESULT_DISPLAY_TYPE_UNSPECIFIED |
Tipo de visualización no especificado (se muestra el fragmento de forma predeterminada). |
SNIPPET |
Mostrar los resultados del campo de fragmento. |
EXTRACTIVE_ANSWER |
Mostrar los resultados del campo de respuestas extractivas. |
DataStoreUiConfig
Configuración de componentes de interfaz de usuario para el almacén de datos.
Representación JSON |
---|
{ "name": string, "id": string, "facetField": [ { object ( |
Campos | |
---|---|
name |
Nombre del almacén de datos. Debe tener el formato de nombre de recurso del almacén de datos: |
id |
Solo salida. Es el identificador del almacén de datos, que se usa para el servicio de widget. Por ahora, hace referencia a dataStoreId. En el futuro, migraremos el campo al UUID del nombre del almacén de datos cifrado. |
facetField[] |
Campos de faceta que almacenan la asignación de campos a la apariencia del widget del usuario final. |
fieldsUiComponentsMap |
La clave es el componente de la interfaz de usuario. Simulación. Actualmente, se admiten 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. |
CollectionComponent
Componente de colección de solo lectura que contiene campos de colecciones de almacén de datos que se pueden usar para filtrar.
Representación JSON |
---|
{
"name": string,
"id": string,
"displayName": string,
"dataStoreComponents": [
{
object ( |
Campos | |
---|---|
name |
Nombre de la colección. Debe ser el nombre del recurso de la colección. Formato: |
id |
Solo de salida. Es el identificador de la colección, que se usa para el servicio de widget. Por ahora, hace referencia a collectionId. En el futuro, migraremos el campo al UUID del nombre de la colección cifrado. |
displayName |
Nombre visible de la colección. |
dataStoreComponents[] |
Lista de los almacenes de datos secundarios de la colección de almacenes de datos. |
dataSource |
Nombre de la fuente de datos, obtenido de |
dataSourceDisplayName |
Solo de salida. Nombre visible de la fuente de datos. |
connectorIconLink |
Solo de salida. El enlace del icono de la fuente del conector. |
DataStoreComponent
Componente de almacén de datos de solo lectura que contiene campos de almacenes de datos que se pueden usar para filtrar. Es el elemento secundario de CollectionComponent
.
Representación JSON |
---|
{ "name": string, "id": string, "displayName": string, "entityName": string, "workspaceType": enum ( |
Campos | |
---|---|
name |
Nombre del almacén de datos. Debe tener el formato de nombre de recurso del almacén de datos: |
id |
Solo salida. Es el identificador del almacén de datos, que se usa para el servicio de widget. Por ahora, hace referencia a dataStoreId. En el futuro, migraremos el campo al UUID del nombre del almacén de datos cifrado. |
displayName |
Nombre visible del almacén de datos. |
entityName |
Nombre de la entidad, obtenido de |
workspaceType |
Solo de salida. Tipos de fuentes de Workspace para datos de Workspace, obtenidos de |
contentConfig |
Solo de salida. La configuración de contenido del almacén de datos. |
dataStoreConfigType |
Solo de salida. El tipo de configuración del almacén de datos. |
DataStoreConfigType
El tipo de configuración del almacén de datos.
Enumeraciones | |
---|---|
DATA_STORE_CONFIG_TYPE_UNSPECIFIED |
Valor predeterminado. Este valor no se usa. |
ALLOW_DB_CONFIG |
El almacén de datos está conectado a AlloyDB |
THIRD_PARTY_OAUTH_CONFIG |
El almacén de datos está conectado a una fuente de datos de terceros. |
NOTEBOOKLM_CONFIG |
El almacén de datos está conectado a NotebookLM Enterprise. |
UiSettings
Describe los ajustes generales de la interfaz de usuario de los widgets (o aplicaciones web) tal como se ven en la página de configuración de la interfaz de la consola de Cloud.
Representación JSON |
---|
{ "interactionType": enum ( |
Campos | |
---|---|
interactionType |
Describe el tipo de interacción del widget (o de la aplicación web). |
generativeAnswerConfig |
Describe la configuración de las respuestas generativas. |
resultDescriptionType |
Controla si se muestra el extracto de resultados y cómo (fragmento o respuesta extractiva). Si no se especifica, no se devuelve ningún resultado. |
enableAutocomplete |
Indica si se debe habilitar el autocompletado. |
enableSafeSearch |
Si se debe habilitar la búsqueda segura. |
enableQualityFeedback |
Activa o desactiva la recogida de comentarios de los usuarios finales sobre la calidad de los resultados de búsqueda. |
enableSearchAsYouType |
Indica si se debe habilitar el comportamiento de búsqueda a medida que se escribe en el widget de búsqueda. |
defaultSearchRequestOrderBy |
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 |
dataStoreUiConfigs[] |
Por configuración de almacén de datos. |
disableUserEventsCollection |
Si se le asigna el valor true, el widget no recogerá eventos de usuario. |
enableVisualContentSummary |
Si se le asigna el valor true, el widget habilitará el resumen de contenido visual en las solicitudes de búsqueda aplicables. Solo lo usa la búsqueda de centros sanitarios. |
enablePeopleSearch |
Opcional. Si se le asigna el valor true, el widget habilitará la búsqueda de personas. |
enableCreateAgentButton |
Opcional. Si se le asigna el valor true, el widget habilitará el botón para crear agentes. |
features |
Solo de salida. Configuración de funciones para que el motor habilite o inhabilite funciones. Claves admitidas:
|
InteractionType
Describe el tipo de interacción.
Enumeraciones | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
Sin especificar. El valor predeterminado es SEARCH_ONLY. |
SEARCH_ONLY |
Buscar sin una respuesta generativa. |
SEARCH_WITH_ANSWER |
Busca con la respuesta generativa. |
SEARCH_WITH_FOLLOW_UPS |
Buscar con la respuesta generativa que admite preguntas de seguimiento. También se conoce como búsqueda multirrespuesta. |
GenerativeAnswerConfig
Describe la configuración de la respuesta generativa.
Representación JSON |
---|
{
"resultCount": integer,
"modelVersion": string,
"modelPromptPreamble": string,
"maxRephraseSteps": integer,
"languageCode": string,
"disableRelatedQuestions": boolean,
"ignoreNonAnswerSeekingQuery": boolean,
"ignoreAdversarialQuery": boolean,
"ignoreLowRelevantContent": boolean,
"imageSource": enum ( |
Campos | |
---|---|
resultCount |
Número de resultados principales a partir de los que se generará la respuesta. Hasta 10. |
modelVersion |
Versión del modelo que se ha usado para generar la respuesta. |
modelPromptPreamble |
Texto al principio de la petición que indica al modelo que genera la respuesta. |
maxRephraseSteps |
Número máximo de pasos de reformulación. El número máximo es de 5 pasos. Si no se define o se le asigna un valor inferior a 1, se le asignará el valor 1 de forma predeterminada. |
languageCode |
Código de idioma del resumen. Usa etiquetas de idioma definidas por BCP47. Nota: Esta es una función experimental. |
disableRelatedQuestions |
Indica si la respuesta generada contiene preguntas relacionadas sugeridas. |
ignoreNonAnswerSeekingQuery |
Opcional. Especifica si se deben filtrar las consultas que no buscan respuestas. El valor predeterminado es No se devuelve ninguna respuesta si la consulta de búsqueda se clasifica como una consulta que no busca una respuesta. Si este campo tiene el valor |
ignoreAdversarialQuery |
Opcional. Especifica si se deben filtrar las consultas que sean adversarias. |
ignoreLowRelevantContent |
Opcional. Especifica si se deben filtrar las consultas que no sean relevantes para el contenido. |
imageSource |
Opcional. Fuente de la imagen devuelta en la respuesta. |
ImageSource
Fuente de la imagen devuelta en la respuesta.
Enumeraciones | |
---|---|
IMAGE_SOURCE_UNSPECIFIED |
Fuente de imagen no especificada (la función multimodal está inhabilitada de forma predeterminada) |
ALL_AVAILABLE_SOURCES |
Comportamiento cuando el servicio determina la selección de todas las fuentes disponibles. |
CORPUS_IMAGE_ONLY |
Incluye una imagen del corpus en la respuesta. |
FIGURE_GENERATION_ONLY |
Activa la generación de cifras en la respuesta. |
FeatureState
El estado de la función del motor.
Enumeraciones | |
---|---|
FEATURE_STATE_UNSPECIFIED |
El estado de la función no está especificado. |
FEATURE_STATE_ON |
La función está activada para que sea accesible. |
FEATURE_STATE_OFF |
La función está desactivada para que no se pueda acceder a ella. |
AccessSettings
Describe los ajustes de acceso a los widgets.
Representación JSON |
---|
{ "allowPublicAccess": boolean, "allowlistedDomains": [ string ], "enableWebApp": boolean, "workforceIdentityPoolProvider": string, "languageCode": string } |
Campos | |
---|---|
allowPublicAccess |
Indica si se permite el acceso público sin autenticar. |
allowlistedDomains[] |
Lista de dominios que pueden integrar el widget de búsqueda. |
enableWebApp |
Indica si el acceso a la aplicación web está habilitado. |
workforceIdentityPoolProvider |
Opcional. Proveedor de grupos de identidades de Workforce usado para acceder al widget. |
languageCode |
Opcional. Código de idioma de la interfaz de usuario. Usa etiquetas de idioma definidas por BCP47. Si no se define, el código de idioma predeterminado es "en-US". |
UiBrandingSettings
Describe los ajustes de branding de la interfaz de usuario del widget.
Representación JSON |
---|
{
"logo": {
object ( |
Campos | |
---|---|
logo |
Imagen del logotipo. |
Imagen
Opciones para almacenar una imagen.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión storage_method . Varias formas de almacenar una imagen, por ejemplo, como una URL o una cadena codificada en base64. storage_method solo puede ser una de estas dos opciones: |
|
url |
URL de la imagen. |
HomepageSetting
Describe el ajuste de la página principal del widget. Incluye todos los ajustes y configuraciones relacionados con la página principal, como los accesos directos.
Representación JSON |
---|
{
"shortcuts": [
{
object ( |
Campos | |
---|---|
shortcuts[] |
Opcional. Los accesos directos que se mostrarán en la página principal. LINT.IfChange(max_shortcuts_number) LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number) |
Combinación de teclas
Describe una entidad de acceso directo (también conocido como contenido fijado) en la página principal. La página principal renderizará estos accesos directos en el mismo orden que devuelve la API. Si un cliente quiere reordenar o quitar una combinación de teclas, la interfaz de usuario siempre debe proporcionar la nueva lista completa de combinaciones de teclas.
Representación JSON |
---|
{
"title": string,
"icon": {
object ( |
Campos | |
---|---|
title |
Opcional. Título del acceso directo. |
icon |
Opcional. URL del icono del acceso directo. |
destinationUri |
Opcional. URL de destino del acceso directo. |
AssistantSettings
Describe los ajustes del Asistente del widget.
Representación JSON |
---|
{
"googleSearchGroundingEnabled": boolean,
"webGroundingType": enum ( |
Campos | |
---|---|
googleSearchGroundingEnabled |
Indica si se muestra o no el interruptor de la base de la búsqueda de Google. Obsoleto. En su lugar, usa |
webGroundingType |
Opcional. El tipo de base web que se va a usar. |
defaultWebGroundingToggleOff |
Solo de salida. Este campo controla el interruptor de grounding web predeterminado para los usuarios finales si |
disableLocationContext |
Opcional. Solo de salida. Indica si se debe inhabilitar el contexto de la ubicación del usuario. |
WebGroundingType
El tipo de base web que se va a usar.
Enumeraciones | |
---|---|
WEB_GROUNDING_TYPE_UNSPECIFIED |
Ajuste predeterminado o sin especificar. Es lo mismo que inhabilitado. |
WEB_GROUNDING_TYPE_DISABLED |
La fundamentación web está inhabilitada. |
WEB_GROUNDING_TYPE_GOOGLE_SEARCH |
La fundamentación con la Búsqueda de Google está habilitada. |
WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH |
La función de fundamentación con la búsqueda web para empresas está habilitada. |
CustomerProvidedConfig
Configuraciones proporcionadas por el cliente.
Representación JSON |
---|
{
"customerType": enum ( |
Campos | |
---|---|
customerType |
Tipo de cliente. |
CustomerType
Tipo de cliente.
Enumeraciones | |
---|---|
DEFAULT_CUSTOMER |
Tipo de cliente predeterminado. |
GOVERNMENT_CUSTOMER |
Tipo de cliente público. Algunas funciones están inhabilitadas para los clientes públicos debido a requisitos legales. |
Métodos |
|
---|---|
|
Obtiene un WidgetConfig . |