REST Resource: projects.locations.collections.dataStores.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,
  "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)
    }
  ]
}
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 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 usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. 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 usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. 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. Mock. 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)

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

enum (DataStoreType)

Solo salida. Es el tipo del 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 el 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 un 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.

En el caso de los motores de SaaS o empresariales, cuando se llama a LookupWidgetConfig con view = WITH_AVAILABLE_CONNECTORS, esta lista también se aumenta con entradas de marcadores de posición sintéticos para los conectores que el llamador puede adjuntar, pero aún no lo ha hecho (consulta CollectionComponent para ver el contrato de marcador de posición). Por lo tanto, el frontend puede renderizar una lista unificada de fuentes ya adjuntas y disponibles para adjuntar iterando este único campo. Para los motores de Enterprise y el view predeterminado, solo se devuelven los conectores ya adjuntos (comportamiento actual).
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
uiSettings

object (UiSettings)

Describe la configuración general de búsqueda de widgets, tal como se ve en la página de configuración de widgets de Cloud Console. 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)

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

object (AssistantSettings)

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

object (CustomerProvidedConfig)

Es 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

Es opcional. Solo salida. Indica si se debe habilitar el gráfico de conocimiento privado.
geminiBundle

boolean

Solo salida. Indica si la suscripción es un paquete de Gemini.
batchAuthStatuses[]

object (BatchAuthStatus)

Solo salida. Son los estados de autorización por lotes para los conectores del widget.
nodes[]

object (Node)

Solo salida. Son los nodos asociados con la configuración del widget.

UIComponentField

Es el campo de faceta que se asigna a un componente de IU.

Representación JSON 
{
  "field": string,
  "deviceVisibility": [
    enum (DeviceVisibility)
  ],
  "displayTemplate": string
}
Campos
field

string

Obligatorio. Es el nombre del campo registrado. El formato es field.abc.
deviceVisibility[]

enum (DeviceVisibility)

Visibilidad del campo en diferentes tipos de dispositivos.
displayTemplate

string

Es la plantilla para personalizar la forma en que se muestra el campo. Un ejemplo de valor sería una cadena que se ve de la siguiente manera: "Precio: {valor}".

DeviceVisibility

Visibilidad del campo en diferentes tipos de dispositivos.

Enums
DEVICE_VISIBILITY_UNSPECIFIED Es el valor predeterminado cuando no se especifica. El servidor devuelve INVALID_ARGUMENT si se usa en las solicitudes.
MOBILE El componente de la IU es visible en dispositivos móviles.
DESKTOP El componente de la IU es visible en el cliente basado en el navegador.

FacetField

Son 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

string

Obligatorio. Es el nombre del campo registrado. El formato es field.abc.
displayName

string

Es opcional. Es el nombre del campo que verán los usuarios finales.

DataStoreType

Es el tipo del almacén de datos principal del widget.

Enums
DATA_STORE_TYPE_UNSPECIFIED Es un tipo de almacén de datos sin especificar.
STRUCTURED El almacén de datos principal contiene un motor de búsqueda para 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 utiliza para la búsqueda combinada con varios almacenes de datos.

ResultDisplayType

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

Enums
RESULT_DISPLAY_TYPE_UNSPECIFIED Tipo de pantalla no especificado (se muestra el resumen de forma predeterminada).
SNIPPET Muestra los resultados del campo de fragmento.
EXTRACTIVE_ANSWER Muestra los resultados del campo de respuestas extractivas.

DataStoreUiConfig

Es la configuración del componente de IU para el almacén de datos.

Representación JSON 
{
  "name": string,
  "id": string,
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  }
}
Campos
name

string

Es el nombre del almacén de datos. Debe ser el formato del nombre del recurso del almacén de datos: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. En el caso de las APIs en WidgetService, como WidgetService.LookupWidgetConfig, se borran el número de proyecto y la parte de la ubicación en este campo.
id

string

Es solo salida. Es el identificador del almacén de datos que se usa para el servicio de widgets. Por el momento, hace referencia a dataStoreId. En el futuro, migraremos el campo al UUID del nombre del almacén de datos encriptado.
facetField[]

object (FacetField)

Son campos de faceta que almacenan la asignación de campos a la apariencia del widget del usuario final.
fieldsUiComponentsMap

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

La clave es el componente de la IU. Mock. 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.

CollectionComponent

Es un componente de colección de solo lectura que contiene campos de colecciones de almacén de datos que se pueden usar para filtrar.

En el caso de los motores de SaaS o empresariales, cuando se llama a LookupWidgetConfig con view = WITH_AVAILABLE_CONNECTORS, también se usan instancias de este mensaje para representar entradas de marcadores de posición sintéticos para los conectores que el llamador puede adjuntar, pero aún no lo ha hecho. Las entradas de marcador de posición tienen connectorAuthState.auth_state == AUTH_STATE_UNSPECIFIED (o NO_AUTH), un connectorAuthState.authorization_uri vacío (el widget llama a WidgetBuildAuthorizationUrl cuando el usuario hace clic en "Conectar") y valores de marcador de posición sintéticos en name / id (consulta los comentarios de los campos). Los campos que solo tienen sentido para los conectores materializados (dataStoreComponents, tenant, actionConnector) no se configuran para las entradas de marcadores de posición.

Representación JSON 
{
  "name": string,
  "id": string,
  "displayName": string,
  "dataStoreComponents": [
    {
      object (DataStoreComponent)
    }
  ],
  "dataSource": string,
  "dataSourceDisplayName": string,
  "connectorIconLink": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  }
}
Campos
name

string

Es el nombre de la colección. Debe ser el nombre del recurso de la colección. Formato: projects/{project}/locations/{location}/collections/{collectionId}. En el caso de las APIs en WidgetService, como WidgetService.LookupWidgetConfig, se borran el número de proyecto y la parte de la ubicación en este campo.

En el caso de las entradas de marcador de posición sintéticas (consulta el comentario a nivel del mensaje), este campo contiene un ID de colección de marcador de posición sintético que no corresponde a una colección real. Los llamadores no deben intentar resolver o GET este recurso hasta que el usuario autorice el conector.
id

string

Solo salida. Es el identificador de la colección, que se usa para el servicio de widgets. Por el momento, hace referencia a collectionId. En el futuro, migraremos el campo al UUID del nombre de la colección encriptado.

Para las entradas de marcadores de posición sintéticos (consulta el comentario a nivel del mensaje), se trata de un ID de marcador de posición sintético, no de un collectionId real.
displayName

string

Es el nombre visible de la colección.
dataStoreComponents[]

object (DataStoreComponent)

Es la colección de almacén de datos, lista de los almacenes de datos secundarios.
dataSource

string

Es el nombre de la fuente de datos, recuperado de Collection.data_connector.data_source.
dataSourceDisplayName

string

Solo salida. Es el nombre visible de la fuente de datos.
connectorAuthState

object (ConnectorAuthState)

Solo salida. Es el URI de autenticación de la fuente del conector.

DataStoreComponent

Es un componente de almacén de datos de solo lectura que contiene campos de almacenes de datos que se pueden usar para filtrar. Es el hijo de CollectionComponent.

Representación JSON 
{
  "name": string,
  "id": string,
  "displayName": string,
  "entityName": string,
  "workspaceType": enum (Type),
  "contentConfig": enum (ContentConfig),
  "dataStoreConfigType": enum (DataStoreConfigType)
}
Campos
name

string

Es el nombre del almacén de datos. Debe ser el formato del nombre del recurso del almacén de datos: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. En el caso de las APIs en WidgetService, como WidgetService.LookupWidgetConfig, se borran el número de proyecto y la parte de la ubicación en este campo.
id

string

Es solo salida. Es el identificador del almacén de datos que se usa para el servicio de widgets. Por el momento, hace referencia a dataStoreId. En el futuro, migraremos el campo al UUID del nombre del almacén de datos encriptado.
displayName

string

Es el nombre visible del almacén de datos.
entityName

string

Nombre de la entidad, recuperado de Collection.data_connector.entities.entityName.
workspaceType

enum (Type)

Solo salida. Son los tipos de fuentes de Workspace para los datos del espacio de trabajo, que se recuperan de DataStore.workspace_config.type.
contentConfig

enum (ContentConfig)

Solo salida. Es la configuración del contenido del almacén de datos.
dataStoreConfigType

enum (DataStoreConfigType)

Solo salida. Es el tipo de configuración del almacén de datos.

DataStoreConfigType

Es el tipo de configuración del almacén de datos.

Enums
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 externa.
NOTEBOOKLM_CONFIG El almacén de datos está conectado a NotebookLM Enterprise.

ConnectorAuthState

Conector de solo lectura en el estado de autenticación de CollectionComponent.

Representación JSON 
{
  "authState": enum (AuthState),
  "authorizationUri": string,
  "updateTime": string
}
Campos
authState

enum (AuthState)

Solo salida. Es el estado de autorización del conector de datos.
authorizationUri

string

Solo salida. Es el URI de autorización del conector de datos.

En el caso de las entradas de marcador de posición sintéticas CollectionComponent (que devuelve LookupWidgetConfig con view = WITH_AVAILABLE_CONNECTORS en los motores de SaaS o de empresas), este campo se deja vacío. El widget debe llamar a WidgetService.WidgetBuildAuthorizationUrl cuando el usuario haga clic en "Conectar" para obtener una URL de autorización recién compilada.
updateTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de la actualización del estado de autorización.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. 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".

AuthState

Es el estado de autorización del conector de datos.

Enums
AUTH_STATE_UNSPECIFIED Valor predeterminado. También se muestra para las entradas de marcadores de posición sintéticos CollectionComponent que muestra LookupWidgetConfig con view = WITH_AVAILABLE_CONNECTORS (solo para SaaS o empresas): Esas entradas representan conectores que el llamador puede adjuntar, pero aún no lo ha hecho.
AUTHORIZED El usuario autorizó el conector de datos.
EXPIRED Venció la autorización del usuario para el conector de datos.
ACTIONS_DISABLED El usuario aún puede realizar solicitudes de búsqueda, pero las acciones deben estar habilitadas.
NO_AUTH El conector de datos no requiere ninguna autorización. También se usa para las entradas de marcadores de posición cuyo conector subyacente no requiere OAuth del usuario.

UiSettings

Describe la configuración general de la IU del widget (o de la app web) tal como se ve en la página de configuración de la IU de Cloud Console.

Representación JSON 
{
  "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
}
Campos
interactionType

enum (InteractionType)

Describe el tipo de interacción del widget (o la app web)
generativeAnswerConfig

object (GenerativeAnswerConfig)

Describe la configuración de las respuestas generativas.
resultDescriptionType

enum (ResultDisplayType)

Controla si se muestra el extracto del resultado y cómo (fragmento o respuesta extractiva). Si no se especifica, el valor predeterminado es sin resultado.
enableAutocomplete

boolean

Indica si se debe habilitar el autocompletado.
enableQualityFeedback

boolean

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

boolean

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

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
dataStoreUiConfigs[]

object (DataStoreUiConfig)

Es la configuración por almacén de datos.
disableUserEventsCollection

boolean

Si se establece como verdadero, el widget no recopilará eventos del usuario.
enableVisualContentSummary

boolean

Si se establece como verdadero, el widget habilitará el resumen de contenido visual en las solicitudes de búsqueda aplicables. Solo se usa en la Búsqueda de atención médica.
enableCreateAgentButton

boolean

Es opcional. Si se establece como verdadero, el widget habilitará el botón para crear un agente.
features

map (key: string, value: enum (FeatureState))

Solo salida. Es la configuración de funciones para que el motor habilite o inhabilite funciones. Claves admitidas:

  • 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))

Solo salida. Asigna un nombre de modelo a su configuración específica para este motor. Esto permite que los usuarios administradores activen o desactiven modelos individuales. Solo se almacenan los modelos cuyos estados anula el administrador.

Cuando el estado no se especifica o modelConfigs está vacío para este modelo, el sistema decidirá si este modelo debe estar disponible o no según la configuración predeterminada. Por ejemplo, un modelo de vista previa debe estar inhabilitado de forma predeterminada si el administrador no eligió habilitarlo.
searchAddonSpec

object (SearchAddonSpec)

Es opcional. SearchAddonSpec se usa para inhabilitar complementos para la búsqueda. Este campo solo se admite para las solicitudes de búsqueda.
modelConfigInfo

object (ModelConfigInfo)

Solo salida. Es la vista resuelta del servidor de la configuración del selector de modelos. Contiene la lista ordenada de modelos que deberían aparecer en el menú desplegable del selector de modelos y el modelo que debería seleccionarse de forma predeterminada.

Los clientes deben renderizar esto directamente sin aplicar sus propios filtros, ordenamientos o localizaciones. El mapa modelConfigs heredado anterior se conserva para la retrocompatibilidad con los clientes que aún no migraron al uso de este campo.
sourceAdminDisplayNameEnabled

boolean

Es opcional. Indica si se debe mostrar el nombre visible configurado por el administrador para los conectores de datos en la IU de fuentes del widget (en lugar del tipo de conector). Es un parámetro opcional que, de forma predeterminada, se establece como falso.
onedrivePickerEnabled

boolean

Solo salida. Indica si el selector de archivos de OneDrive está disponible para los usuarios finales. El backend lo calcula a partir de la habilitación del conector de administrador (edición Business) o los conectores de OneDrive adjuntos (edición Enterprise), en combinación con la función de administrador existente de disable-onedrive-upload.

Se declaró optional para que un false calculado de forma explícita se serialice con la presencia del campo. Un bool simple de proto3 descarta un false predeterminado en la conexión, lo que impide que los clientes distingan entre "selector inhabilitado" (false) y "campo no completado" (sin configurar).
googleDrivePickerEnabled

boolean

Solo salida. Indica si el selector de archivos de Google Drive está disponible para los usuarios finales. Se declaró optional para el mismo motivo de presencia de campo que onedrivePickerEnabled anterior.

InteractionType

Describe el tipo de interacción.

Enums
INTERACTION_TYPE_UNSPECIFIED No especificado. El valor predeterminado es SEARCH_ONLY.
SEARCH_ONLY Realiza una búsqueda sin una respuesta generativa.
SEARCH_WITH_ANSWER Realiza la búsqueda con la respuesta generativa.
SEARCH_WITH_FOLLOW_UPS Búsqueda con la respuesta generativa que admite preguntas adicionales. También se conoce como búsqueda de varios turnos.

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 (ImageSource)
}
Campos
resultCount

integer

Es la cantidad de resultados principales a partir de los que se generará la respuesta. Hasta 10
modelVersion

string

Es la versión del modelo que se usó para generar la respuesta.
modelPromptPreamble

string

Es el texto al comienzo de la instrucción que le indica al modelo que genera la respuesta.
maxRephraseSteps

integer

Cantidad máxima de pasos de reformulación. La cantidad máxima es de 5 pasos. Si no se establece o se establece en un valor inferior a 1, se establecerá en 1 de forma predeterminada.
languageCode

string

Es el código de idioma del resumen. Usa las etiquetas de idioma definidas por BCP47. Nota: Esta es una función experimental.
ignoreNonAnswerSeekingQuery

boolean

Es opcional. Especifica si se deben filtrar las búsquedas que no buscan respuestas. El valor predeterminado es false.

No se devuelve ninguna respuesta si la búsqueda se clasifica como una búsqueda que no busca respuestas. Si este campo se establece en true, omitimos la generación de respuestas para las preguntas que no buscan respuestas y, en su lugar, devolvemos mensajes de resguardo.
ignoreAdversarialQuery

boolean

Es opcional. Especifica si se deben filtrar las búsquedas adversariales.
ignoreLowRelevantContent

boolean

Es opcional. Especifica si se deben filtrar las búsquedas que no son relevantes para el contenido.
imageSource

enum (ImageSource)

Es opcional. Es la fuente de la imagen que se muestra en la respuesta.

ImageSource

Es la fuente de la imagen que se muestra en la respuesta.

Enums
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 figuras en la respuesta.

FeatureState

Es el estado de la función para el motor.

Enums
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 sea inaccesible.

ModelState

Es el estado del modelo para el motor.

Enums
MODEL_STATE_UNSPECIFIED El estado del modelo no está especificado.
MODEL_ENABLED El administrador habilitó el modelo.
MODEL_DISABLED El administrador inhabilitó el modelo.

SearchAddonSpec

SearchAddonSpec se usa para inhabilitar complementos para la búsqueda. De forma predeterminada, si no se especifica este campo, los complementos se habilitan siempre que sea posible.

Representación JSON 
{
  "semanticAddOnDisabled": boolean,
  "kpiPersonalizationAddOnDisabled": boolean,
  "generativeAnswerAddOnDisabled": boolean
}
Campos
semanticAddOnDisabled

boolean

Es opcional. Si es verdadero, se inhabilita el complemento semántico. El complemento semántico incluye embeddings y Jetstream.
kpiPersonalizationAddOnDisabled

boolean

Es opcional. Si es verdadero, inhabilita la clasificación y la personalización de eventos para optimizar los KPI y personalizar los resultados.
generativeAnswerAddOnDisabled

boolean

Es opcional. Si es verdadero, se inhabilita el complemento de respuestas generativas. El complemento de respuestas generativas incluye lenguaje natural para filtros y respuestas simples.

ModelConfigInfo

Es la vista resuelta del servidor de la configuración del selector de modelos para el usuario final. El backend calcula este valor por solicitud aplicando, en orden, la evaluación de marcas de Mendel, las reglas de disponibilidad regional basadas en la ubicación del motor y las anulaciones del panel de administración de modelConfigs.

El backend es la única fuente de información confiable para esta configuración. Los clientes deben renderizar resolvedModels directamente en el menú desplegable del selector de modelos, en el orden proporcionado, sin aplicar su propio filtrado, ordenamiento o localización.

Representación JSON 
{
  "resolvedModels": [
    {
      object (ResolvedModel)
    }
  ],
  "defaultModelId": string
}
Campos
resolvedModels[]

object (ResolvedModel)

Solo salida. Es la lista de modelos disponibles para el usuario final en el selector de modelos, en el orden en que se deben mostrar.
defaultModelId

string

Solo salida. Es el modelId del modelo que se debe seleccionar de forma predeterminada en el selector de modelos cuando el usuario final no haya realizado una elección explícita. El valor siempre es uno de los modelId presentes en resolvedModels.

ResolvedModel

Es un solo modelo que se resuelve para estar disponible para el usuario final en el selector de modelos, con todos sus metadatos visibles localizados.

Representación JSON 
{
  "modelId": string,
  "displayName": string,
  "icon": string,
  "description": string,
  "isPreview": boolean,
  "adminView": {
    object (AdminView)
  }
}
Campos
modelId

string

Solo salida. Identificador único del modelo (p.ej., gemini-2.5-flash, gemini-3.1-pro-preview).

Este es el mismo identificador que los clientes pasan al servicio de asistente para seleccionar este modelo. Los modelos virtuales o "pseudo" (p.ej., gemini-fast) también son valores válidos aquí, ya que se resuelven en el modelo concreto subyacente en el backend.
displayName

string

Solo salida. Es el nombre visible localizado del modelo (p.ej., Gemini 3.1 Pro). Se localiza en el servidor según el LookupWidgetConfigRequest.language_code y el LookupWidgetConfigRequest.region_code de la solicitud.
icon

string

Solo salida. Es el token de ícono compatible con GM3 asociado al modelo (p.ej., rocket_launch, bolt, graph_5).
description

string

Solo salida. Texto de descripción localizado (p.ej., state-of-the-art reasoning). Se localiza con el mismo idioma que displayName.
isPreview

boolean

Solo salida. Indica si el modelo se encuentra actualmente en versión preliminar. Los clientes deben mostrar esto a través de una insignia de "Vista previa" en la IU del selector.
adminView

object (AdminView)

Solo salida. Son los metadatos de la superficie del administrador, que se completan solo para la página de Control de funciones del administrador de la consola (consulta AdminView). No se configuran para las superficies del usuario final.

AdminView

Son los metadatos de la superficie del administrador. Se completa solo cuando la solicitud se origina en la página "Control de funciones" del administrador de Cloud Console; se deja sin configurar para las plataformas de usuarios finales (Web y dispositivos móviles). Permite que la página de administración renderice su tabla de activación directamente desde el backend en lugar de un registro codificado de forma rígida del cliente.

Representación JSON 
{
  "adminOverridable": boolean,
  "enabledByDefault": boolean,
  "regions": [
    string
  ]
}
Campos
adminOverridable

boolean

Solo salida. Indica si el administrador puede activar o desactivar este modelo a través de UiSettings.model_configs. Derivado de MODEL_TAG_ADMIN_OVERRIDABLE. Cuando es falso, el modelo se "fuerza" y su estado se rige por enabledByDefault.
enabledByDefault

boolean

Solo salida. Indica si el modelo está habilitado cuando el administrador no estableció ninguna anulación explícita en UiSettings.model_configs. Derivado de MODEL_TAG_ENABLED_BY_DEFAULT.
regions[]

string

Solo salida. Son las regiones en las que se lanzó este modelo.

AccessSettings

Describe la configuración de acceso a los widgets.

Representación JSON 
{
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableWebApp": boolean,
  "workforceIdentityPoolProvider": string,
  "languageCode": string
}
Campos
allowPublicAccess

boolean

Indica si se permite el acceso público sin autenticar.
allowlistedDomains[]

string

Es la lista de dominios que pueden integrar el widget de búsqueda.
enableWebApp

boolean

Indica si el acceso a la app web está habilitado.
workforceIdentityPoolProvider

string

Es opcional. Es el proveedor del grupo de identidades de personal que se usa para acceder al widget.
languageCode

string

Es opcional. Es el código de idioma de la interfaz de usuario. Usa las etiquetas de idioma definidas por BCP47. Si no se configura, el código de idioma predeterminado es "en-US".

UiBrandingSettings

Describe la configuración de desarrollo de la marca de la IU del widget.

Representación JSON 
{
  "logo": {
    object (Image)
  }
}
Campos

Imagen

Opciones para almacenar una imagen.

Representación JSON 
{

  // Union field storage_method can be only one of the following:
  "url": string
  // End of list of possible types for union field storage_method.
}
Campos
Campo de unión storage_method. Varias formas de almacenar una imagen, es decir, como una URL o una cadena codificada en base64. storage_method puede ser solo uno de los parámetros siguientes:
url

string

Es la URL de la imagen.

HomepageSetting

Describe el parámetro de configuración de la página principal del widget. Incluye todos los parámetros de configuración relacionados con la página principal, como los accesos directos.

Representación JSON 
{
  "shortcuts": [
    {
      object (Shortcut)
    }
  ]
}
Campos
shortcuts[]

object (Shortcut)

Es opcional. Son los accesos directos que se mostrarán en la página principal.

Acceso directo

Describe una entidad de acceso directo (también conocida como contenido fijado) en la página principal. La página principal renderizará estos accesos directos en el mismo orden en que los devuelve la API. Si un cliente quiere reordenar o quitar un acceso directo, la IU siempre debe proporcionar la nueva lista completa de accesos directos.

Representación JSON 
{
  "title": string,
  "icon": {
    object (Image)
  },
  "destinationUri": string
}
Campos
title

string

Es opcional. Título del acceso directo.
icon

object (Image)

Es opcional. Es la URL del ícono del acceso directo.
destinationUri

string

Es opcional. Es la URL de destino del acceso directo.

AssistantSettings

Describe la configuración del asistente del widget.

Representación JSON 
{
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "disableLocationContext": boolean
}
Campos
googleSearchGroundingEnabled
(deprecated)

boolean

Indica si se muestra o no el botón de activación de la fundamentación de la Búsqueda de Google. Obsoleto. Utiliza webGroundingType en lugar de esta función.
webGroundingType

enum (WebGroundingType)

Es opcional. Es el tipo de fundamentación web que se usará.
defaultWebGroundingToggleOff

boolean

Solo salida. Este campo controla la activación o desactivación predeterminada de la fundamentación web para los usuarios finales si webGroundingType se establece en WEB_GROUNDING_TYPE_GOOGLE_SEARCH o WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. De forma predeterminada, este campo se establece como falso. Si webGroundingType es WEB_GROUNDING_TYPE_GOOGLE_SEARCH o WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, los usuarios finales tendrán habilitada la fundamentación web de forma predeterminada en la IU. Si es verdadero, el botón de activación de fundamentación se inhabilitará de forma predeterminada en la IU. Los usuarios finales pueden habilitar la fundamentación web en la IU si esta función está habilitada.
disableLocationContext

boolean

Es opcional. Solo salida. Indica si se debe inhabilitar el contexto de ubicación del usuario.

WebGroundingType

Es el tipo de fundamentación web que se usará.

Enums
WEB_GROUNDING_TYPE_UNSPECIFIED Es el parámetro de configuración predeterminado y no especificado. Es lo mismo que inhabilitado.
WEB_GROUNDING_TYPE_DISABLED La fundamentación web está inhabilitada.

CustomerProvidedConfig

Son los parámetros de configuración proporcionados por el cliente.

Representación JSON 
{
  "customerType": enum (CustomerType)
}
Campos
customerType

enum (CustomerType)

Es el tipo de cliente.

CustomerType

Es el tipo de cliente.

Enums
DEFAULT_CUSTOMER Es el tipo de cliente predeterminado.
GOVERNMENT_CUSTOMER Es el tipo de cliente gubernamental. Algunas funciones están inhabilitadas para los clientes gubernamentales debido a requisitos legales.

BatchAuthStatus

Describe el estado de autorización por lotes para un objeto batchAuthorizationGroup.

Representación JSON 
{
  "placeholder": string,
  "batchAuthorizationGroup": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  }
}
Campos
placeholder

string

Solo salida. Es el nombre completo del recurso de marcador de posición del grupo de autorización por lotes. Este no es un conector de datos real (no existe en la tabla DataConnector en Spanner). Es un nombre de recurso que solo existe en connector_authorization en la tabla de usuarios. p. ej., projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector
batchAuthorizationGroup

string

Solo salida. Es el grupo de autorización por lotes al que pertenece el marcador de posición.
connectorAuthState

object (ConnectorAuthState)

Solo salida. Es el estado de autorización actual de este conector.

Nodo

Representa una sola unidad lógica o de procesamiento reutilizable.

Representación JSON 
{
  "displayName": string,
  "iconUrl": string,
  "description": string,
  "parameterSchema": {
    object
  },
  "outputSchema": {
    object
  },
  "type": enum (Type)
}
Campos
displayName

string

Solo salida. Es un nombre legible para el nodo.
iconUrl

string

Solo salida. Es un identificador o una URL que apunta a un ícono que representa este tipo de nodo.
description

string

Solo salida. Es una descripción detallada de lo que hace el nodo.
parameterSchema

object (Struct format)

Solo salida. Es el esquema de parámetros de la herramienta.

Se espera que este esquema cumpla con el estándar de OpenAPI Schema (consulta https://spec.openapis.org/oas/v3.0.3.html y AIP-146). Describe la estructura esperada de los parámetros que acepta este nodo.
outputSchema

object (Struct format)

Solo salida. Es el esquema de salida de la herramienta.

Se espera que este esquema cumpla con el estándar de OpenAPI Schema (consulta https://spec.openapis.org/oas/v3.0.3.html/ y AIP-146). Describe la estructura del resultado que produce este nodo.
type

enum (Type)

Solo salida. Es el tipo de nodo.

Tipo

Identifica el tipo de nodo en el flujo del agente.

Enums
TYPE_UNSPECIFIED Indica un tipo no especificado.
TRIGGER Tipo de activador.
FLOW tipo de flujo.
CONNECTOR Tipo de conector.

Métodos

get

 Obtienes una WidgetConfig.

patch

 Actualiza un WidgetConfig.