Configurar Autocompletar

En esta página se describe la función básica de autocompletar de Vertex AI Search. Autocompletar genera sugerencias de consulta basadas en los primeros caracteres introducidos en la consulta.

Las sugerencias que genera Autocompletar varían en función del tipo de datos que utilice la aplicación de búsqueda:

  • Datos estructurados y no estructurados. De forma predeterminada, la función de autocompletar genera sugerencias basadas en el contenido de los documentos del almacén de datos. Después de importar un documento, de forma predeterminada, la función de autocompletar no empieza a generar sugerencias hasta que haya suficientes datos de calidad, lo que suele ocurrir en un par de días. Si haces solicitudes de autocompletado a través de la API, esta puede generar sugerencias basadas en el historial de búsqueda o en los eventos de usuario.

  • Datos de sitios web: De forma predeterminada, Autocompletar genera sugerencias a partir del historial de búsqueda. Autocompletar requiere tráfico de búsqueda real. Una vez que empiece a haber tráfico de búsqueda, el autocompletado tardará uno o dos días en generar sugerencias. Las sugerencias se pueden generar a partir de datos rastreados de sitios públicos con el modelo de datos de documentos avanzado experimental.

  • Datos sanitarios. De forma predeterminada, se usa una fuente de datos médicos canónica para generar sugerencias de autocompletado para los almacenes de datos sanitarios.

El modelo de sugerencias de consultas determina qué tipo de datos usa Autocompletar para generar sugerencias. Hay cuatro modelos de sugerencias de consultas:

  • Documento. El modelo de documento genera sugerencias a partir de los documentos importados por el usuario. Este modelo no está disponible para datos de sitios web ni datos sanitarios.

  • Campos rellenables. El modelo de campos completables sugiere texto extraído directamente de campos de datos estructurados. Solo se utilizan para las sugerencias de autocompletado los campos que tienen la anotación completable. Este modelo solo está disponible para datos estructurados.

  • Historial de búsqueda. El modelo de historial de búsqueda genera sugerencias a partir del historial de llamadas a la API SearchService.search. No uses este modelo si no hay tráfico disponible para el método servingConfigs.search. Este modelo no está disponible para datos sanitarios.

  • Evento de usuario. El modelo de eventos de usuario genera sugerencias a partir de eventos importados por el usuario de tipo search. Este modelo no está disponible para datos sanitarios.

Las solicitudes de autocompletado se envían mediante el método dataStores.completeQuery.

Si no quieres usar un modelo de sugerencias de consulta, puedes usar las sugerencias importadas, que proporcionan sugerencias de autocompletado basadas en una lista de sugerencias importada. Para obtener más información, consulta Usar una lista importada de sugerencias de autocompletado.

Tipos de modelos disponibles según el tipo de datos

En la siguiente tabla se muestran los tipos de modelos de sugerencias de consulta disponibles para cada tipo de datos.


Modelo de sugerencias de consultas
Fuente de datos
Datos del sitio web
Datos estructurados
Datos no estructurados
Documento Importado ✔* (predeterminado) ✔ (predeterminado)
Campos rellenables Importado ✔
Historial de búsqueda Recogidos automáticamente ✔ (predeterminado) ✔ ✔
Eventos de usuario Importado o recogido automáticamente por el widget ✔ ✔ ✔
Contenido rastreado en la Web Se ha rastreado contenido de sitios web públicos que especifiques ✔†

* : El esquema del documento debe contener los campos title o description, o bien debe haber campos que se hayan especificado como propiedades de clave title o description. Consulta Actualizar un esquema de datos estructurados.

† : El contenido rastreado en la Web solo se puede usar como fuente de datos si está habilitado el modelo de datos de documento avanzado experimental para la función de autocompletar. Consulta Modelo de datos de documentos avanzado.

Si no quieres usar el modelo predeterminado para tu tipo de datos, puedes especificar otro modelo al enviar tu solicitud de autocompletado. Las solicitudes de Autocomplete se envían mediante el método dataStores.completeQuery. Para obtener más información, consulta las instrucciones de la API para enviar una solicitud de autocompletado y elegir otro modelo.

Funciones de Autocompletar

Vertex AI Search admite las siguientes funciones de autocompletar para mostrar las predicciones más útiles durante la búsqueda:

Función Descripción Ejemplo o más información
Corregir errores ortográficos Corregir la ortografía de las palabras que tengan errores tipográficos. Milc → Milk.
Eliminar términos no seguros
  • Con la tecnología de Búsqueda Segura de Google.
  • Elimina las consultas inapropiadas.
  • Disponible en alemán (de), español (es), francés (fr), inglés (en), italiano (it), polaco (pl), portugués (pt), ruso (ru) y ucraniano (uk).
 Texto ofensivo, como pornografía, contenido subido de tono, vulgar o violento.
Evitar que se muestre información personal identificable (IPI) básica Con la tecnología de Sensitive Data Protection, Vertex AI Search hace un esfuerzo razonable para evitar que se muestren tipos básicos de información personal identificable, como números de teléfono y direcciones de correo electrónico.

Si hay una dirección de correo electrónico jeffersonloveshiking@gmail.com en el almacén de datos, Búsqueda de Vertex AI no devolverá la dirección de correo electrónico como sugerencia de autocompletado si el usuario escribe jef en la barra de búsqueda.

Para protegerte de forma más exhaustiva contra las filtraciones de información personal, Google te recomienda que apliques tu propia solución de prevención de pérdida de datos (DLP) además de los detectores que proporciona Vertex AI Search. Para obtener más información, consulta el artículo Protegerse frente a las filtraciones de IPI.
Lista de no permitidas
  • Elimina los términos que aparecen en la lista de denegación.
 Para obtener más información, consulta Usar una lista de denegación de Autocompletar.
Eliminar términos duplicados
  • Con la tecnología de la comprensión semántica basada en IA.
  • En el caso de los términos casi idénticos, se tiene en cuenta cualquiera de ellos, pero solo se sugiere el más popular.
 Shoes for Women, Womens Shoes y Womans Shoes se desduplican y solo se sugiere la más popular.
Sugerencias de concordancia de cola
  • No está disponible en las multirregiones de EE. UU. y la Unión Europea.
  • Ajuste opcional.
  • Si no hay coincidencias de autocompletado para toda la consulta, sugiere coincidencias solo para la última palabra de la consulta.
  • No disponible para búsquedas relacionadas con la atención sanitaria.
 Para obtener más información, consulta Sugerencias de coincidencia de cola.

Sugerencias de concordancia de cola

Las sugerencias de concordancia de cola se hacen usando la concordancia de prefijo exacta con la última palabra de una cadena de consulta.

Por ejemplo, supongamos que se envía la consulta "canciones con he" en una solicitud de autocompletar. Si la coincidencia final está habilitada, es posible que la función de autocompletar determine que el prefijo completo "canciones con he" no tiene ninguna coincidencia. Sin embargo, la última palabra de la consulta, "he", tiene una concordancia de prefijo exacta con "hello world" y "hello kitty". En ese caso, las sugerencias devueltas son "canciones con hola mundo" y "canciones con hola gatito", ya que no hay sugerencias de coincidencia exacta.

Puede usar esta función para reducir los resultados de sugerencias vacíos y aumentar la diversidad de las sugerencias, lo que resulta especialmente útil en los casos en los que las fuentes de datos (recuento de eventos de usuario, historial de búsqueda y cobertura de temas de documentos) son limitadas. Sin embargo, habilitar las sugerencias de concordancia de cola puede reducir la calidad general de las sugerencias. Como la coincidencia final solo coincide con la última palabra del prefijo, es posible que algunas sugerencias devueltas no tengan sentido. Por ejemplo, una consulta como "canciones con él" podría recibir una sugerencia de coincidencia final como "canciones con ayudantes guías".

Las sugerencias de coincidencia final solo se devuelven si se cumplen las siguientes condiciones:

  1. include_tail_suggestions se define como true en la solicitud dataStores.completeQuery.

  2. No hay sugerencias de coincidencia de prefijo completa para la consulta.

Protegerse frente a las filtraciones de información personal identificable

La definición de IPI es amplia y puede ser difícil de detectar. Por lo tanto, Vertex AI Search no puede garantizar que no se devuelva información personal identificable en las sugerencias de Autocompletar.

Vertex AI Search aplica el servicio de inspección Protección de Datos Sensibles para buscar y bloquear tipos comunes de información personal identificable para que no aparezcan como sugerencias. Sin embargo, si sus almacenes de datos contienen información personal identificable o si usa los modelos de sugerencias de consultas de historial de búsqueda o de eventos de usuario, revise lo siguiente y tome las medidas oportunas:

  1. Si los tipos de IIP que quieres proteger son bastante estándar, como números de teléfono y direcciones de correo electrónico, empieza por probar exhaustivamente las sugerencias de autocompletado de tu aplicación. Vertex AI Search no puede garantizar que no se devuelva IIP en las sugerencias de autocompletado.

  2. Si se detectan filtraciones de IIP durante las pruebas de autocompletado o si ya sabes que tienes IIP no estándar que proteger (por ejemplo, IDs de usuario propietarios), prueba a ajustar el umbral de autocompletado y los parámetros de publicación de contenido. Para obtener más información, consulta Reducir el riesgo de devolver sugerencias que contengan información personal.

  3. Si ajustar los parámetros no es suficiente para evitar las filtraciones de información personal identificable, implementa tu propia solución de protección de datos. Personaliza la solución de DLP para los tipos de información personal identificable que es más probable que se encuentren en tus almacenamientos de datos, eventos de usuario o consultas de búsqueda de los usuarios. Puedes usar Protección de datos sensibles o un servicio de DLP de terceros. Sigue uno de estos procedimientos:

    • Filtra la información de identificación personal antes de importar los documentos y los eventos de usuario en tus almacenes de datos.

    • Revisa las sugerencias de autocompletado antes de mostrárselas al usuario en el momento de la publicación y bloquea las que contengan información personal.

  4. Si usas el modelo de historial de búsquedas o de eventos de usuario, añade texto informativo en la barra de búsqueda para indicar a los usuarios que no incluyan información personal identificable en sus consultas de búsqueda.

  5. Si tienes alguna pregunta o te encuentras con algún problema concreto al bloquear información personal identificable, ponte en contacto con tu ingeniero de atención al cliente o con el equipo de tu cuenta de Google.

Activar o desactivar la función de autocompletar de un widget

Para activar o desactivar la función de autocompletar en un widget, sigue estos pasos:

Consola

  1. En la Google Cloud consola, ve a la página Aplicaciones de IA.

    Aplicaciones de IA

  2. Haz clic en el nombre de la aplicación que quieras editar.

  3. Haz clic en Configurations (Configuraciones).

  4. Haz clic en la pestaña Interfaz de usuario.

  5. Activa o desactiva la opción Mostrar sugerencias de autocompletar para activar o desactivar las sugerencias de autocompletar del widget. Si habilitas esta opción, tendrás que esperar uno o dos días para que empiecen a aparecer las sugerencias.

Actualizar la configuración de Autocompletar

Para configurar los ajustes de autocompletar en la interfaz de usuario, sigue estos pasos:

Consola

  1. En la Google Cloud consola, ve a la página Aplicaciones de IA.

    Aplicaciones de IA

  2. Haz clic en el nombre de la aplicación que quieras editar.

  3. Haz clic en Configurations (Configuraciones).

  4. Haz clic en la pestaña Autocompletar.

  5. Introduce o selecciona valores nuevos para los ajustes de autocompletar que quieras actualizar:

    • Número máximo de sugerencias: número máximo de sugerencias de autocompletado que se pueden ofrecer para una consulta.
    • Longitud mínima para activar: el número mínimo de caracteres que se pueden escribir antes de que se ofrezcan sugerencias de autocompletar.
    • Orden de coincidencia: la ubicación de una cadena de consulta desde la que Autocompletar puede empezar a buscar coincidencias para sus sugerencias.
    • Modelo de sugerencias de consulta: el modelo de sugerencias de consulta que se usa para generar las sugerencias obtenidas. Para anular este valor, usa el parámetro queryModel en dataStores.completeQuery.

    • Habilitar autocompletar: de forma predeterminada, la función Autocompletar no empieza a hacer sugerencias hasta que tiene suficientes datos de calidad, lo que suele ocurrir en un par de días. Si quieres anular este valor predeterminado y empezar a recibir sugerencias de autocompletar antes, selecciona Ahora.

      Aunque selecciones Ahora, las sugerencias pueden tardar un día en generarse y seguirán faltando algunas sugerencias de autocompletar o serán de baja calidad hasta que haya suficientes datos de calidad.

    • Lista de denegación: importa una lista de denegación como archivo JSON en un segmento de Cloud Storage. Para obtener más información sobre las restricciones y especificaciones de la lista de denegación, consulta Usar una lista de denegación de Autocompletar.

  6. Haz clic en Guardar y publicar. Los cambios se aplican en unos minutos en los buscadores en los que ya se ha activado la función de autocompletar.

Reduce el riesgo de devolver sugerencias que contengan información personal

Los usuarios finales tienen todo tipo de información personal identificable, como carnés de conducir y números de teléfono, que deben mantener en privado. Sin embargo, los usuarios pueden escribir en la barra de búsqueda cualquier información personal identificable para encontrar resultados específicos.

Si usas el modelo de historial de búsqueda o de eventos de usuario y es probable que tus usuarios escriban información personal identificable en la barra de búsqueda, puedes reducir las filtraciones de información personal identificable ajustando los siguientes parámetros:

  • queryFrequencyThreshold: para que una consulta se devuelva como sugerencia de autocompletar, debe haberse introducido este número de veces.

  • numUniqueUsersThreshold: para que una consulta se devuelva como sugerencia de autocompletado, debe haberla introducido este número de usuarios únicos. El valor del campo userPseudoId del evento de usuario de búsqueda determina si el usuario es único.

Ejemplo de caso práctico

Por ejemplo, supongamos que los usuarios tienen números de cuenta que deben mantenerse privados.

Si se usa el modelo de sugerencias del historial de búsqueda o de eventos de usuario, estos números de cuenta, junto con todos los demás términos que buscan los usuarios finales, se usan para generar sugerencias. Por lo tanto, si el número de cuenta YZ-46789A del usuario A se ha introducido varias veces en la barra de búsqueda y el usuario B tiene el número de cuenta YZ-42345B, cuando el usuario B escriba YZ-4 en la barra de búsqueda, la sugerencia de Autocompletar que se devuelva podría ser el número de cuenta del usuario A.

Para reducir la probabilidad de que se produzca este tipo de filtración, el administrador de aplicaciones de IA decide hacer lo siguiente:

  • Aumenta el valor del parámetro queryFrequencyThreshold a 30. En este caso, es muy poco probable que se introduzca un número de cuenta con tanta frecuencia. Sin embargo, las consultas de búsqueda populares se introducirán al menos con esa frecuencia.

  • Aumenta el valor del parámetro numUniqueUsersThreshold a 6. El administrador cree que es poco probable que se introduzca el mismo número de cuenta en la barra de búsqueda en seis eventos de búsqueda, cada uno asociado a un userPseudoId diferente.

Procedimiento

Hay dos parámetros de umbral para el autocompletado. Estos parámetros no están disponibles en la consola de Google Cloud , pero se pueden definir con una llamada a la API REST al método updateCompletionConfig.

Para configurar los ajustes del umbral de autocompletar, sigue estos pasos. Cada paso es opcional, en función del parámetro que quieras cambiar.

REST

  1. Actualiza el campo CompletionConfig.queryFrequencyThreshold:

    curl -X PATCH \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  -H "X-Goog-User-Project: PROJECT_ID" \
  https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/completionConfig?updateMask=queryFrequencyThreshold \
  -d '{
    "name": "projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/completionConfig",
    "queryFrequencyThreshold": QUERY_FREQUENCY_THRESHOLD
  }'

    Haz los cambios siguientes:

    • PROJECT_ID: el número o el ID de tu Google Cloud proyecto.

    • DATA_STORE_ID: el ID del almacén de datos asociado a tu aplicación.

    • QUERY_FREQUENCY_THRESHOLD: valor entero que indica el número mínimo de veces que se debe introducir una consulta de búsqueda para que se pueda devolver como sugerencia de autocompletar. El recuento se suma en un periodo de tiempo continuo de varios meses. El valor predeterminado es 8.

  2. Actualiza el campo CompletionConfig.numUniqueUsersThreshold:

    curl -X PATCH \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  -H "X-Goog-User-Project: PROJECT_ID" \
  https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/completionConfig?updateMask=numUniqueUsersThreshold \
  -d '{
    "name": "projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/completionConfig",
    "numUniqueUsersThreshold": UNIQUE_USERS
  }'

    Sustituye UNIQUE_USERS por un valor entero que represente el número mínimo de usuarios únicos que deben introducir una consulta de búsqueda determinada para que se pueda devolver como sugerencia de autocompletado. El recuento se suma en un periodo de tiempo continuo de varios meses. El valor predeterminado es 3.

Actualizar las anotaciones de campos completables en el esquema

Para activar la función de autocompletar en los campos del esquema de datos estructurados, sigue estos pasos:

Consola

  1. En la Google Cloud consola, ve a la página Aplicaciones de IA.

    Aplicaciones de IA

  2. Haz clic en el nombre de la aplicación que quieras editar. Debe usar datos estructurados.

  3. Haz clic en Datos.

  4. Haz clic en la pestaña Esquema.

  5. Haz clic en Editar para seleccionar los campos del esquema que quieras marcar como completable.

  6. Haz clic en Guardar para guardar las configuraciones de campo actualizadas. Estas sugerencias tardan aproximadamente un día en generarse y devolverse.

Enviar solicitudes de autocompletado

En los siguientes ejemplos se muestra cómo enviar solicitudes de autocompletar.

REST

Para enviar una solicitud de autocompletado mediante la API, sigue estos pasos:

  1. Busca el ID de tu almacén de datos. Si ya tiene el ID del almacén de datos, vaya al siguiente paso.

    1. En la Google Cloud consola, ve a la página Aplicaciones de IA y, en el menú de navegación, haz clic en Almacenes de datos.

      Ir a la página Almacenes de datos

    2. Haga clic en el nombre de su almacén de datos.

    3. En la página Datos de su almacén de datos, obtenga el ID del almacén de datos.

  2. Llama al método dataStores.completeQuery.

    curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID:completeQuery?query=QUERY_STRING"

    Haz los cambios siguientes:

    • PROJECT_ID: el número o el ID de tu Google Cloud proyecto.

    • DATA_STORE_ID: el ID del almacén de datos asociado a tu aplicación.

    • QUERY_STRING: la entrada de escritura anticipada que se usa para obtener sugerencias.

Enviar una solicitud de autocompletado a otro modelo

Para enviar una solicitud de Autocompletar con un modelo de sugerencias de consulta diferente, sigue estos pasos:

  1. Busca el ID de tu almacén de datos. Si ya tiene el ID del almacén de datos, vaya al siguiente paso.

    1. En la Google Cloud consola, ve a la página Aplicaciones de IA y, en el menú de navegación, haz clic en Almacenes de datos.

      Ir a la página Almacenes de datos

    2. Haga clic en el nombre de su almacén de datos.

    3. En la página Datos de su almacén de datos, obtenga el ID del almacén de datos.

  2. Llama al método dataStores.completeQuery.

    curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID:completeQuery?query=QUERY_STRING&query_model=QUERY_SUGGESTIONS_MODEL"

    Haz los cambios siguientes:

    • PROJECT_ID: el número o el ID de tu Google Cloud proyecto.

    • DATA_STORE_ID: el ID único del almacén de datos asociado a tu aplicación.

    • QUERY_STRING: la entrada de escritura anticipada que se usa para obtener sugerencias.

    • AUTOCOMPLETE_MODEL: los datos de autocompletar

    • QUERY_SUGGESTIONS_MODEL: el modelo de sugerencias de consulta que se va a usar en la solicitud: document, document-completable, search-history o user-event. En el caso de los datos sanitarios, usa healthcare-default.

C#

Para obtener más información, consulta la documentación de referencia de la API AI Applications C#.

Para autenticarte en las aplicaciones de IA, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local. 

using Google.Cloud.DiscoveryEngine.V1;

public sealed partial class GeneratedCompletionServiceClientSnippets
{
    /// <summary>Snippet for CompleteQuery</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void CompleteQueryRequestObject()
    {
        // Create client
        CompletionServiceClient completionServiceClient = CompletionServiceClient.Create();
        // Initialize request argument(s)
        CompleteQueryRequest request = new CompleteQueryRequest
        {
            DataStoreAsDataStoreName = DataStoreName.FromProjectLocationDataStore("[PROJECT]", "[LOCATION]", "[DATA_STORE]"),
            Query = "",
            QueryModel = "",
            UserPseudoId = "",
            IncludeTailSuggestions = false,
        };
        // Make the request
        CompleteQueryResponse response = completionServiceClient.CompleteQuery(request);
    }
}

Go

Para obtener más información, consulta la documentación de referencia de la API AI Applications Go.

Para autenticarte en las aplicaciones de IA, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local. 


package main

import (
	"context"

	discoveryengine "cloud.google.com/go/discoveryengine/apiv1"
	discoveryenginepb "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := discoveryengine.NewCompletionClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &discoveryenginepb.CompleteQueryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb#CompleteQueryRequest.
	}
	resp, err := c.CompleteQuery(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

Para obtener más información, consulta la documentación de referencia de la API AI Applications Java.

Para autenticarte en las aplicaciones de IA, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local. 

import com.google.cloud.discoveryengine.v1.CompleteQueryRequest;
import com.google.cloud.discoveryengine.v1.CompleteQueryResponse;
import com.google.cloud.discoveryengine.v1.CompletionServiceClient;
import com.google.cloud.discoveryengine.v1.DataStoreName;

public class SyncCompleteQuery {

  public static void main(String[] args) throws Exception {
    syncCompleteQuery();
  }

  public static void syncCompleteQuery() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CompletionServiceClient completionServiceClient = CompletionServiceClient.create()) {
      CompleteQueryRequest request =
          CompleteQueryRequest.newBuilder()
              .setDataStore(
                  DataStoreName.ofProjectLocationDataStoreName(
                          "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                      .toString())
              .setQuery("query107944136")
              .setQueryModel("queryModel-184930495")
              .setUserPseudoId("userPseudoId-1155274652")
              .setIncludeTailSuggestions(true)
              .build();
      CompleteQueryResponse response = completionServiceClient.completeQuery(request);
    }
  }
}

Node.js

Para obtener más información, consulta la documentación de referencia de la API AI Applications Node.js.

Para autenticarte en las aplicaciones de IA, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local. 

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent data store resource name for which the completion is
 *  performed, such as
 *  `projects/* /locations/global/collections/default_collection/dataStores/default_data_store`.
 */
// const dataStore = 'abc123'
/**
 *  Required. The typeahead input used to fetch suggestions. Maximum length is
 *  128 characters.
 */
// const query = 'abc123'
/**
 *  Specifies the autocomplete data model. This overrides any model specified
 *  in the Configuration > Autocomplete section of the Cloud console. Currently
 *  supported values:
 *  * `document` - Using suggestions generated from user-imported documents.
 *  * `search-history` - Using suggestions generated from the past history of
 *  SearchService.Search google.cloud.discoveryengine.v1.SearchService.Search 
 *  API calls. Do not use it when there is no traffic for Search API.
 *  * `user-event` - Using suggestions generated from user-imported search
 *  events.
 *  * `document-completable` - Using suggestions taken directly from
 *  user-imported document fields marked as completable.
 *  Default values:
 *  * `document` is the default model for regular dataStores.
 *  * `search-history` is the default model for site search dataStores.
 */
// const queryModel = 'abc123'
/**
 *  A unique identifier for tracking visitors. For example, this could be
 *  implemented with an HTTP cookie, which should be able to uniquely identify
 *  a visitor on a single device. This unique identifier should not change if
 *  the visitor logs in or out of the website.
 *  This field should NOT have a fixed value such as `unknown_visitor`.
 *  This should be the same identifier as
 *  UserEvent.user_pseudo_id google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id 
 *  and
 *  SearchRequest.user_pseudo_id google.cloud.discoveryengine.v1.SearchRequest.user_pseudo_id.
 *  The field must be a UTF-8 encoded string with a length limit of 128
 *  characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 */
// const userPseudoId = 'abc123'
/**
 *  Indicates if tail suggestions should be returned if there are no
 *  suggestions that match the full query. Even if set to true, if there are
 *  suggestions that match the full query, those are returned and no
 *  tail suggestions are returned.
 */
// const includeTailSuggestions = true

// Imports the Discoveryengine library
const {CompletionServiceClient} = require('@google-cloud/discoveryengine').v1;

// Instantiates a client
const discoveryengineClient = new CompletionServiceClient();

async function callCompleteQuery() {
  // Construct request
  const request = {
    dataStore,
    query,
  };

  // Run request
  const response = await discoveryengineClient.completeQuery(request);
  console.log(response);
}

callCompleteQuery();

Python

Para obtener más información, consulta la documentación de referencia de la API AI Applications Python.

Para autenticarte en las aplicaciones de IA, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local. 

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1


def sample_complete_query():
    # Create a client
    client = discoveryengine_v1.CompletionServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1.CompleteQueryRequest(
        data_store="data_store_value",
        query="query_value",
    )

    # Make the request
    response = client.complete_query(request=request)

    # Handle the response
    print(response)

Ruby

Para obtener más información, consulta la documentación de referencia de la API AI Applications Ruby.

Para autenticarte en las aplicaciones de IA, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local. 

require "google/cloud/discovery_engine/v1"

##
# Snippet for the complete_query call in the CompletionService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#complete_query.
#
def complete_query
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::DiscoveryEngine::V1::CompletionService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::DiscoveryEngine::V1::CompleteQueryRequest.new

  # Call the complete_query method.
  result = client.complete_query request

  # The returned object is of type Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse.
  p result
end

Usar una lista de elementos no permitidos para la función Autocompletar

Puedes usar una lista de denegación para evitar que aparezcan términos específicos como sugerencias de autocompletado.

Por ejemplo, una empresa farmacéutica. Si un medicamento ya no está aprobado por la FDA, pero se menciona en documentos de su almacén de datos, es posible que quieran evitar que aparezca como consulta sugerida. La empresa podría añadir el nombre de ese medicamento a una lista de denegación para evitar que se sugiera.

Se aplican los límites siguientes:

  • Una lista de denegación por almacén de datos
  • Si subes una lista de denegación, se sobrescribirá la que ya haya en ese almacén de datos
  • Hasta 1000 términos por lista de denegación
  • Los términos no distinguen entre mayúsculas y minúsculas
  • Después de importar una lista de denegación, tarda entre 1 y 2 días en aplicarse

Cada entrada de tu lista de denegación consta de un blockPhrase y un matchOperator:

  • blockPhrase: introduce una cadena como término de la lista de denegación. Los términos no distinguen entre mayúsculas y minúsculas.
  • matchOperator: acepta los siguientes valores:
    • EXACT_MATCH: evita que aparezca una coincidencia exacta del término de la lista de denegación como consulta sugerida.
    • CONTAINS: impide que aparezca cualquier sugerencia que contenga el término de la lista de denegación.

A continuación, se muestra un ejemplo de una lista de denegación con cuatro entradas:

{
    "entries": [
        {"blockPhrase":"Oranges","matchOperator":"CONTAINS"},
        {"blockPhrase":"bAd apples","matchOperator":"EXACT_MATCH"},
        {"blockPhrase":"Cool as A Cucumber","matchOperator":"EXACT_MATCH"},
        {"blockPhrase":"cherry pick","matchOperator":"CONTAINS"}
    ]
}

Antes de importar una lista de denegación, comprueba que se hayan definido los controles de acceso necesarios para el acceso de editores de Discovery Engine.

Las listas de denegación se pueden importar desde datos JSON locales o desde Cloud Storage. Para quitar una lista de denegación de un almacén de datos, elimina la lista de denegación.

Importar una lista de denegación a partir de datos JSON locales

Para importar una lista de denegación desde un archivo JSON local que contenga tu lista de denegación, sigue estos pasos:

  1. Crea tu lista de denegación en un archivo JSON local con el siguiente formato. Asegúrate de que cada entrada de la lista de denegación esté en una línea nueva sin saltos de línea.

    {
    "inlineSource": {
        "entries": [
            { "blockPhrase":"TERM_1","matchOperator":"MATCH_OPERATOR_1" },
            { "blockPhrase":"TERM_2","matchOperator":"MATCH_OPERATOR_2" }
        ]
    }
}

  2. Haz una solicitud POST al método suggestionDenyListEntries:import y proporciona el nombre del archivo JSON.

    curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data @DENYLIST_FILE \
  "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/suggestionDenyListEntries:import"

    Haz los cambios siguientes:

    • DENYLIST_FILE: la ruta local del archivo JSON que contiene los términos de la lista de denegación.

    • PROJECT_ID: el número o el ID de tu Google Cloud proyecto.

    • DATA_STORE_ID: el ID del almacén de datos asociado a tu aplicación.

Después de importar tu lista de denegación, se tarda entre 1 y 2 días en empezar a filtrar las sugerencias.

Importar una lista de denegación desde Cloud Storage

Para importar una lista de denegación desde un archivo JSON de Cloud Storage, sigue estos pasos:

  1. Crea tu lista de denegación en un archivo JSON con el siguiente formato e impórtala a un segmento de Cloud Storage. Asegúrate de que cada entrada de la lista de denegación esté en una línea nueva sin saltos de línea.

    { "blockPhrase":"TERM_1","matchOperator":"MATCH_OPERATOR_1" }
{ "blockPhrase":"TERM_2","matchOperator":"MATCH_OPERATOR_2" }

  2. Crea un archivo JSON local que contenga el objeto gcsSource. Úsalo para indicar la ubicación del archivo de lista de denegación en un segmento de Cloud Storage.

    {
    "gcsSource": {
        "inputUris": [ "DENYLIST_STORAGE_LOCATION" ]
    }
}

    Sustituye DENYLIST_STORAGE_LOCATION por la ubicación de tu lista de denegación en Cloud Storage. Solo puedes introducir un URI. El URI debe introducirse con este formato: gs://BUCKET/FILE_PATH.

  3. Haz una solicitud POST al método suggestionDenyListEntries:import, incluido el objeto gcsSource.

    curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data @GCS_SOURCE_FILE \
   "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/suggestionDenyListEntries:import"

    Haz los cambios siguientes:

    • GCS_SOURCE_FILE: la ruta local del archivo que contiene el objeto gcsSource que apunta a tu lista de denegación.

    • PROJECT_ID: el número o el ID de tu Google Cloud proyecto.

    • DATA_STORE_ID: el ID del almacén de datos asociado a tu aplicación.

Después de importar tu lista de denegación, se tarda entre 1 y 2 días en empezar a filtrar las sugerencias.

Purgar una lista de no permitidas

Para purgar una lista de denegación de tu almacén de datos, sigue estos pasos:

  1. Haz una solicitud POST al método suggestionDenyListEntries:purge.

    curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/suggestionDenyListEntries:purge"

    Haz los cambios siguientes:

    • PROJECT_ID: el número o el ID de tu Google Cloud proyecto.

    • DATA_STORE_ID: el ID del almacén de datos asociado a tu aplicación.

Usar una lista importada de sugerencias de autocompletar

Puede proporcionar su propia lista de sugerencias de Autocompletar en lugar de usar las sugerencias generadas a partir de un modelo de datos de Autocompletar.

En la mayoría de las aplicaciones, se obtienen mejores resultados si se usan las sugerencias generadas a partir de uno de los modelos de datos de autocompletar. Sin embargo, puede haber algunas situaciones poco frecuentes en las que las sugerencias del modelo no se ajusten a tus necesidades y en las que ofrecer una lista discreta de sugerencias proporcione a tus usuarios una mejor experiencia de autocompletado.

Por ejemplo, una pequeña librería online importa su lista de títulos de libros como sugerencias de autocompletar. Cuando un cliente empieza a escribir en la barra de búsqueda, la sugerencia de autocompletar siempre será el título de un libro de la lista importada. Cuando cambia la lista de libros, la librería elimina la lista actual e importa la nueva. Un fragmento de la lista podría ser similar al siguiente:

{"suggestion": "Wuthering Heights", "globalScore": "0.52" },
{"suggestion": "The Time Machine", "globalScore": "0.26" },
{"suggestion": "Nicholas Nickleby", "globalScore": "0.38" },
{"suggestion": "A Little Princess", "globalScore": "0.71" },
{"suggestion": "The Scarlet Letter", "globalScore": "0.32" }

globalScore es un número de punto flotante en el intervalo [0, 1] que se usa para clasificar la sugerencia. También puedes usar una puntuación frequency, que es un número entero mayor que uno. La puntuación frequency se usa para clasificar las sugerencias cuando globalScore no está disponible (se define como nulo).

Configurar e importar sugerencias de autocompletado

Para configurar e importar una lista de sugerencias de Autocompletar desde BigQuery, sigue estos pasos:

  1. Crea tu lista de sugerencias y cárgala en una tabla de BigQuery.

    Como mínimo, debe proporcionar cada sugerencia como una cadena y una puntuación global o una frecuencia.

    Usa el siguiente esquema de tabla para tu lista de sugerencias:

    [
  {
    "description": "The suggestion text",
    "mode": "REQUIRED",
    "name": "suggestion",
    "type": "STRING"
  },
  {
    "description": "Global score of this suggestion. Control how this suggestion would be scored and ranked. Set global score or frequency; not both.",
    "mode": "NULLABLE",
    "name": "globalScore",
    "type": "FLOAT"
  },
  {
    "description": "Frequency of this suggestion. Used to rank suggestions when the global score is not available.",
    "mode": "NULLABLE",
    "name": "frequency",
    "type": "INTEGER"
  }
]

    Consulta la documentación de BigQuery para obtener instrucciones sobre cómo crear una tabla de BigQuery y cargarla con tu lista de sugerencias de autocompletar.

  2. Importa la lista de BigQuery.

    Haz una solicitud POST al método completionSuggestions:import, incluido el objeto bigquerySource.

    curl -X POST \
 -H "Authorization: Bearer $(gcloud auth print-access-token)" \
 -H "Content-Type: application/json; charset=utf-8" \
 -H "X-Goog-User-Project: PROJECT_ID" \
 "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/completionSuggestions:import" \
 -d '{
      "bigquery_source": {"project_id": "PROJECT_ID_SOURCE", "dataset_id": "DATASET_ID", "table_id": "TABLE_ID"}
 }'

    Haz los cambios siguientes:

    • PROJECT_ID: el número o el ID de tu Google Cloud proyecto.
    • DATA_STORE_ID: el ID del almacén de datos de Vertex AI Search.
    • PROJECT_ID_SOURCE: el proyecto que contiene el conjunto de datos que quieres importar.
    • DATASET_ID: el ID del conjunto de datos de la lista de sugerencias que quiere importar.
    • TABLE_ID: el ID de la tabla de la lista de sugerencias que quieras importar

  3. Opcional: Anota el valor name devuelto y sigue las instrucciones de Obtener detalles sobre una operación de larga duración para ver cuándo se completa la operación de importación.

  4. Si no has habilitado la función de autocompletar en la aplicación, sigue el procedimiento para actualizar los ajustes de autocompletar. Asegúrate de que la opción Habilitar autocompletar esté activada.

  5. Espera un par de días a que se complete la indexación y las sugerencias importadas estén disponibles.

Enviar una solicitud de autocompletado

Para enviar una solicitud de autocompletado que devuelva una sugerencia importada en lugar de una sugerencia de un modelo de autocompletado, haz lo siguiente:

  1. Sigue el procedimiento para enviar una solicitud de autocompletado a otro modelo y asigna el valor imported-suggestion a AUTOCOMPLETE_MODEL.

Purgar la lista de sugerencias de autocompletado importadas

Antes de importar una nueva lista de sugerencias de Autocompletar, elimina la que ya tengas.

Para purgar una lista de sugerencias de Autocompletar, sigue estos pasos:

  1. Haz una solicitud POST al método completionSuggestions:purge.

    curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/completionSuggestions:purge"

    Haz los cambios siguientes:

    • PROJECT_ID: el número o el ID de tu Google Cloud proyecto.

    • DATA_STORE_ID: el ID del almacén de datos asociado a tu aplicación.

Modelo de datos de documentos avanzado

Aplicaciones de IA proporciona un modelo de datos avanzado para Autocompletar. A partir de los documentos que importes, este modelo de datos genera sugerencias de autocompletado de alta calidad mediante los modelos de lenguaje extensos (LLMs) de Google.

Esta función es experimental. Si te interesa usar esta función, ponte en contacto con el equipo de tu cuenta de Google Cloud y pide que te añadan a la lista de permitidos.

El modelo de datos de documentos avanzado no está disponible para la búsqueda de datos sanitarios ni en las multirregiones de EE. UU. y la UE.