- Recurso: WidgetConfig
- Representación JSON
- UIComponentField
- DeviceVisibility
- FacetField
- DataStoreType
- ResultDisplayType
- DataStoreUiConfig
- CollectionComponent
- DataStoreComponent
- DataStoreConfigType
- UiSettings
- InteractionType
- GenerativeAnswerConfig
- ImageSource
- FeatureState
- AccessSettings
- UiBrandingSettings
- Imagen
- HomepageSetting
- Atajo
- AssistantSettings
- WebGroundingType
- CustomerProvidedConfig
- CustomerType
- Métodos
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 ( |
Campos | |
---|---|
name |
Inmutable. Es el 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 longitud de 1,024 caracteres. |
displayName |
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 |
Solo salida. Es la marca de tiempo en la que se creó el objeto 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: |
updateTime |
Solo salida. Es la marca de tiempo en la que se actualizó 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: |
enableAutocomplete |
Indica si se debe habilitar la función de autocompletar. |
fieldsUiComponentsMap |
La clave es el componente de la IU. Simulación. Actualmente, se admiten 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. |
facetField[] |
Son la configuración y la apariencia de las facetas en la vista del usuario final. |
dataStoreType |
Solo salida. Es el tipo de almacén de datos principal. |
contentSearchSpec |
Es la especificación de búsqueda de contenido que configura el comportamiento deseado de la búsqueda de contenido. |
enableSummarization |
Activa o desactiva la generación de resúmenes para la respuesta de la búsqueda. |
enableSnippetResultSummary |
Activa o desactiva el resumen para cada resultado de fragmento. |
configId |
Solo salida. Es el identificador único ofuscado de un |
enableQualityFeedback |
Activa o desactiva la recopilación de comentarios sobre la calidad de los resultados de la búsqueda de los usuarios finales. |
solutionType |
Obligatorio. Inmutable. Especifica el tipo de solución para el que se puede usar este WidgetConfig. |
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 |
allowPublicAccess |
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[] |
Son los dominios incluidos en la lista de entidades permitidas que pueden cargar este widget. |
enableSafeSearch |
Indica si se debe habilitar la Búsqueda segura. |
enableConversationalSearch |
Indica si se permite la búsqueda conversacional (LLM, de varios turnos) o no (sin LLM, de un solo turno). |
llmEnabled |
Solo salida. Indica si el LLM está habilitado en el almacén de datos correspondiente. |
enableResultScore |
Indica si se debe mostrar la puntuación del resultado. |
resultDisplayType |
Es el tipo de fragmento que se mostrará en el widget de UCS.
|
minimumDataTermAccepted |
Solo salida. Indica si el cliente aceptó las condiciones de uso de datos. |
enableWebApp |
Indica si se debe habilitar la app web independiente. |
dataStoreUiConfigs[] |
Parámetros de configuración de la IU configurables por almacén de datos. |
collectionComponents[] |
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 |
Indica si se debe habilitar el comportamiento de búsqueda mientras escribes para el widget de búsqueda. |
defaultSearchRequestOrderBy |
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 |
Permite activar o desactivar funciones inestables o experimentales en el widget (o la app web). |
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 |
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 |
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 |
Opcional. Describe la configuración de la página principal del widget. |
assistantSettings |
Opcional. Solo salida. Describe la configuración del asistente del widget. |
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 |
Opcional. Solo salida. Indica si se debe habilitar el gráfico de conocimiento privado. |
UIComponentField
Es el campo de faceta que se asigna a un componente de IU.
Representación JSON |
---|
{
"field": string,
"deviceVisibility": [
enum ( |
Campos | |
---|---|
field |
Obligatorio. Es el nombre del campo registrado. El formato es |
deviceVisibility[] |
Visibilidad del campo en diferentes tipos de dispositivos. |
displayTemplate |
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
Es la visibilidad del campo en diferentes tipos de dispositivos.
Enums | |
---|---|
DEVICE_VISIBILITY_UNSPECIFIED |
Valor predeterminado cuando no se especifica. El servidor devuelve INVALID_ARGUMENT si se usa en las solicitudes. |
MOBILE |
El componente de IU es visible en dispositivos móviles. |
DESKTOP |
El componente de 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 |
Obligatorio. Es el nombre del campo registrado. El formato es |
displayName |
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. |
SITE_SEARCH |
El almacén de datos principal contiene un motor de búsqueda de sitios. |
STRUCTURED |
El almacén de datos principal contiene un motor de búsqueda 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 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 |
Mostrar resultados del campo de respuestas extractivas |
DataStoreUiConfig
Es la configuración del componente de la IU para el almacén de datos.
Representación JSON |
---|
{ "name": string, "id": string, "facetField": [ { object ( |
Campos | |
---|---|
name |
Es el nombre del almacén de datos. Debe ser el formato del nombre del recurso del almacén de datos: |
id |
Es solo de 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[] |
Son 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 IU. Simulación. Actualmente, se admiten 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. |
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 |
Es el nombre de la colección. Debe ser el nombre del recurso de la colección. Formato: |
id |
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. |
displayName |
Es el nombre visible de la colección. |
dataStoreComponents[] |
Es la colección de almacén de datos, lista de los almacenes de datos secundarios. |
dataSource |
Es el nombre de la fuente de datos, recuperado de |
dataSourceDisplayName |
Solo salida. Es el nombre visible de la fuente de datos. |
connectorIconLink |
Solo salida. Es el vínculo al ícono 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 elemento secundario de CollectionComponent
.
Representación JSON |
---|
{ "name": string, "id": string, "displayName": string, "entityName": string, "workspaceType": enum ( |
Campos | |
---|---|
name |
Es el nombre del almacén de datos. Debe ser el formato del nombre del recurso del almacén de datos: |
id |
Es solo de 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 |
Es el nombre visible del almacén de datos. |
entityName |
Nombre de la entidad, recuperado de |
workspaceType |
Solo salida. Son los tipos de fuentes de Workspace para los datos del espacio de trabajo, que se recuperan de |
contentConfig |
Solo salida. Es la configuración del contenido del almacén de datos. |
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. |
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 ( |
Campos | |
---|---|
interactionType |
Describe el tipo de interacción del widget (o la app web). |
generativeAnswerConfig |
Describe la configuración de las respuestas generativas. |
resultDescriptionType |
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 |
Indica si se debe habilitar la función de autocompletar. |
enableSafeSearch |
Indica si se debe habilitar la Búsqueda segura. |
enableQualityFeedback |
Activa o desactiva la recopilación de comentarios sobre la calidad de los resultados de la búsqueda de los usuarios finales. |
enableSearchAsYouType |
Indica si se debe habilitar el comportamiento de búsqueda mientras escribes para el widget de búsqueda. |
defaultSearchRequestOrderBy |
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[] |
Es la configuración por almacén de datos. |
disableUserEventsCollection |
Si se establece como verdadero, el widget no recopilará eventos del usuario. |
enableVisualContentSummary |
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. |
enablePeopleSearch |
Opcional. Si se establece como verdadero, el widget habilitará la búsqueda de personas. |
enableCreateAgentButton |
Opcional. Si se establece como verdadero, el widget habilitará el botón para crear un agente. |
features |
Solo salida. Es la configuración de funciones para que el motor habilite o inhabilite funciones. Claves admitidas:
|
InteractionType
Describe el tipo de interacción.
Enums | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
No especificado. El valor predeterminado es SEARCH_ONLY. |
SEARCH_ONLY |
Buscar 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 de seguimiento. También se conoce como búsqueda de varias preguntas y respuestas. |
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 |
Es la cantidad de resultados principales a partir de los que se generará la respuesta. Hasta 10 |
modelVersion |
Es la versión del modelo que se usó para generar la respuesta. |
modelPromptPreamble |
Es el texto al comienzo de la instrucción que le indica al modelo que genere la respuesta. |
maxRephraseSteps |
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 |
Es el código de idioma del resumen. Usa las 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 búsquedas que no buscan respuestas. El valor predeterminado es 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 |
ignoreAdversarialQuery |
Opcional. Especifica si se deben filtrar las búsquedas adversariales. |
ignoreLowRelevantContent |
Opcional. Especifica si se deben filtrar las búsquedas que no son relevantes para el contenido. |
imageSource |
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 no se pueda acceder a ella. |
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 |
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 app web está habilitado. |
workforceIdentityPoolProvider |
Opcional. Es el proveedor del grupo de identidades de personal que se usa para acceder al widget. |
languageCode |
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 ( |
Campos | |
---|---|
logo |
Es la 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, es decir, como una URL o una cadena codificada en base64. storage_method puede ser solo uno de los siguientes: |
|
url |
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 ( |
Campos | |
---|---|
shortcuts[] |
Opcional. Son 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) |
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 ( |
Campos | |
---|---|
title |
Opcional. Es el título del acceso directo. |
icon |
Opcional. Es la URL del ícono del acceso directo. |
destinationUri |
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 ( |
Campos | |
---|---|
googleSearchGroundingEnabled |
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 |
Opcional. Es el tipo de fundamentación web que se usará. |
defaultWebGroundingToggleOff |
Solo salida. Este campo controla la activación o desactivación predeterminada de la fundamentación web para los usuarios finales si |
disableLocationContext |
Opcional. Solo salida. Indica si se debe inhabilitar el contexto de la 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 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 fundamentación con la Búsqueda web empresarial está habilitada. |
CustomerProvidedConfig
Son los parámetros de configuración que proporciona el cliente.
Representación JSON |
---|
{
"customerType": enum ( |
Campos | |
---|---|
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. |
Métodos |
|
---|---|
|
Obtienes una WidgetConfig . |