Cómo obtener resultados de búsqueda

Console

Para usar la consola de Google Cloud y obtener una vista previa de los resultados de la búsqueda de una app con datos del sitio web, sigue estos pasos:

1. En la consola de Google Cloud , ve a la página AI Applications.

   Aplicaciones basadas en IA

2. Haz clic en el nombre de la app que deseas editar.

3. Haz clic en Vista previa.

4. Abre la página Preview en la consola.

5. Opcional: Si conectaste varios almacenes de datos a tu app, pero solo quieres obtener resultados de un almacén de datos específico, selecciónalo.

6. Escribe una búsqueda.

   Si habilitaste el autocompletado, aparecerá una lista de sugerencias debajo de la barra de búsqueda a medida que escribas.

7. Presiona Intro para enviar la búsqueda.

   • Debajo de la barra de búsqueda, aparece una lista de resultados.
   • Cada resultado contiene un título, un fragmento y una URL.
   • Si haces clic en un resultado, se abrirá esa URL.
   • Si las funciones avanzadas de LLM están habilitadas para la app, también podría aparecer una respuesta generada.

REST

Para usar la API y obtener resultados de la búsqueda de una app con datos del sitio web, usa el método engines.servingConfigs.search:

1. Busca el ID de tu app. Si ya tienes el ID de tu app, ve al siguiente paso.

   1. En la consola de Google Cloud , ve a la página AI Applications.

      Ve a Apps.

   2. En la página Apps, busca el nombre de tu app y obtén su ID en la columna ID.

2. Obtener resultados de la búsqueda

   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:search" \
   -d '{
   "servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search",
   "query": "QUERY",
   "pageSize": "PAGE_SIZE",
   "offset": "OFFSET",
   "orderBy": "ORDER_BY",
   "params": {"user_country_code": "USER_COUNTRY_CODE",
   "searchType": "SEARCH_TYPE"},
   "filter": "FILTER",
   "boostSpec": "BOOST_SPEC",
   "contentSearchSpec": {
      "searchResultMode": "RESULT_MODE"
    },
    "userPseudoId": "USER_PSEUDO_ID",
    "dataStoreSpecs": [{"DATA_STORE_SPEC"}]
   }'
   

   Reemplaza lo siguiente:

   • PROJECT_ID: Es el ID de tu proyecto de Google Cloud .
   • APP_ID: Es el ID de la app de Agent Search que deseas consultar.
   • QUERY: Es el texto de la búsqueda.

   • PAGE_SIZE: Es la cantidad de resultados que devolvió la búsqueda. El tamaño máximo de página permitido depende del tipo de datos. Los tamaños de página superiores al valor máximo se fuerzan al valor máximo.

     • Sitios web con indexación básica: Predeterminado 10, máximo 25
     • Sitios web con indexación avanzada: Predeterminado 25, máximo 50
     • Otro: Predeterminado 50, Máximo 100

   • OFFSET: Es el índice inicial de los resultados. El valor predeterminado es 0.

     Por ejemplo, si el desplazamiento es 2, el tamaño de la página es 10 y hay 15 resultados para devolver, los resultados del 2 al 12 se devuelven en la primera página.

   • ORDER_BY: Es el orden en el que se organizan los resultados. El atributo según el cual se ordena debe tener una interpretación numérica; por ejemplo, date. Para obtener más información, consulta Cómo ordenar los resultados de la búsqueda web.

   • USER_COUNTRY_CODE: Es la ubicación del usuario. Este par clave-valor es la única entrada admitida para el campo del mapa params. El valor predeterminado es vacío. Para conocer los valores aceptables, consulta Códigos de país en la documentación de referencia de la API de JSON del Motor de Búsqueda Programable.

   • SEARCH_TYPE: Es el tipo de búsqueda que se realizará. El valor predeterminado es 0 para la búsqueda de documentos. El otro valor admitido es 1 para la búsqueda con imágenes.

   • FILTER: Un campo de texto para filtrar tu búsqueda con una expresión de filtro. El valor predeterminado es una string vacía. Para obtener más información sobre el uso del campo filter, consulta Cómo filtrar la búsqueda en el sitio web.

   • BOOST_SPEC: es opcional. Es una especificación para mejorar u ocultar documentos. Valores:

     • BOOST: un número de punto flotante en el rango [-1,1]. Cuando el valor es negativo, los resultados se degradan (aparecen más abajo en los resultados). Cuando el valor es positivo, los resultados se promocionan (aparecen más arriba en los resultados).
     • CONDITION: Es una expresión de filtro de texto para seleccionar los documentos a los que se aplica el refuerzo. El filtro debe evaluarse como un valor booleano. Para ver ejemplos de expresiones de filtro, consulta Sintaxis de las expresiones de filtro y Sintaxis para la indexación avanzada. Para obtener información sobre el aumento de la búsqueda estructurada, consulta Aumenta los resultados de la búsqueda.

   • RESULT_MODE: Determina si los resultados de la búsqueda se muestran como documentos completos o en fragmentos. Para obtener fragmentos, el almacén de datos debe tener activada la fragmentación de documentos. Los valores aceptados son documents y chunks. Cuando la fragmentación está activada para un almacén de datos, el valor predeterminado es chunks. De lo contrario, el valor predeterminado es documents. Para obtener información sobre la división de documentos en fragmentos, consulta Cómo analizar y dividir documentos en fragmentos. Este campo está en versión preliminar pública. Para usarlo, cambia v1 por v1alpha en el comando curl.

   • USER_PSEUDO_ID: Es una cadena codificada en UTF-8 que actúa como un identificador seudonimizado único que hace un seguimiento de los usuarios. Puede tener una longitud máxima de 128 caracteres. Google recomienda usar este campo porque mejora el rendimiento del modelo y la calidad de la personalización. Puedes usar una cookie HTTP para este campo, que identifica de forma única a un visitante en un solo dispositivo. Estas son algunas consideraciones importantes:

     • Este identificador no cambia cuando el visitante accede a un sitio web o sale de él.
     • Este campo no debe establecerse con el mismo identificador para varios usuarios. De lo contrario, usar el mismo ID de usuario para varios usuarios puede combinar los historiales de eventos de diferentes usuarios y degradar la calidad del modelo.
     • Este campo no debe incluir información de identificación personal (PII).
     • Para una búsqueda o solicitud de exploración determinada, este campo debe correlacionarse con el campo userPseudoId correspondiente en los eventos del usuario.

     Para obtener más información, consulta userPseudoId

   • DATA_STORE_SPEC: Filtra un almacén de datos específico en el que se realizará la búsqueda. Usa dataStoreSpecs si tu app de búsqueda está conectada a varios almacenes de datos, pero quieres obtener resultados de un almacén de datos específico. Para obtener más información, consulta DataStoreSpec.

C#

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

Para autenticarte en Agent Search, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.

using Google.Api.Gax;
using Google.Cloud.DiscoveryEngine.V1Beta;
using Google.Protobuf.WellKnownTypes;
using System;

public sealed partial class GeneratedSearchServiceClientSnippets
{
    /// <summary>Snippet for Search</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 SearchRequestObject()
    {
        // Create client
        SearchServiceClient searchServiceClient = SearchServiceClient.Create();
        // Initialize request argument(s)
        SearchRequest request = new SearchRequest
        {
            ServingConfigAsServingConfigName = ServingConfigName.FromProjectLocationDataStoreServingConfig("[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]"),
            BranchAsBranchName = BranchName.FromProjectLocationDataStoreBranch("[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]"),
            Query = "",
            Offset = 0,
            Filter = "",
            OrderBy = "",
            FacetSpecs =
            {
                new SearchRequest.Types.FacetSpec(),
            },
            BoostSpec = new SearchRequest.Types.BoostSpec(),
            Params = { { "", new Value() }, },
            QueryExpansionSpec = new SearchRequest.Types.QueryExpansionSpec(),
            SpellCorrectionSpec = new SearchRequest.Types.SpellCorrectionSpec(),
            UserPseudoId = "",