Establece los parámetros de configuración de los campos

En esta página, se muestra cómo configurar los campos de esquema para configurar una app para datos estructurados, datos no estructurados con metadatos o datos de sitios web con atributos personalizados y estructurados.

La configuración de campos ayuda a determinar cómo Agent Search usa los campos en sus resultados. Puedes usar la pestaña Esquema en la consola deGoogle Cloud para establecer la configuración de los campos.

La configuración de los campos solo está disponible para las apps con almacenes de datos que contienen datos estructurados o no estructurados con metadatos.

Configuración de campo

La siguiente configuración de campo está disponible para muchos tipos de campos en tus datos de búsqueda o recomendaciones, pero no para todos los tipos de datos. Un esquema contiene varios parámetros de configuración para campos individuales, y la siguiente tabla contiene parámetros de configuración que se pueden aplicar a un campo dentro de un esquema. Se recomienda usar datos estructurados para los siguientes parámetros de configuración de campos:

Configuración Definición Objetivo Ejemplo de caso de uso
Indexable

Configurar los campos como indexables permite realizar operaciones como filtrar, aumentar y crear facetas en campos estructurados dentro de un documento.

Los campos de tipo Object no se pueden establecer en Indexable.

Marcar un campo como Indexable permite realizar búsquedas más rápidas.

Ten en cuenta que marcar un campo como Indexable aumenta el tamaño del índice de la Búsqueda y puede ralentizar la indexación.

En un almacén de datos de hoteles, puedes establecer un campo, como hotel_chain, como indexable. Esto te permite aplicar operaciones de clasificación, filtrado y aumento en hotel_chain. Por ejemplo, puedes aplicar un filtro para que la búsqueda solo muestre los resultados que contengan la cadena hotelera filtrada.
Se puede buscar

Los campos que tienen más probabilidades de estar relacionados con las búsquedas se designan como Searchable. Un campo puede ser de búsqueda sin ser indexable ni recuperable.

Solo los campos con valores de texto se pueden marcar como Se puede buscar. Por lo tanto, un campo de precio numérico puede ser indexable (para filtrar o crear facetas), pero no se puede buscar como texto completo.

Establecer un campo como Se puede buscar mejora la recuperación de ese campo en las búsquedas, lo que permite que los usuarios encuentren contenido, como páginas web, consultando el texto de estos campos. Marcar un campo como Se puede buscar permite aplicar la clasificación. Por lo tanto, marcar una cantidad excesiva de campos como aptos para búsquedas puede afectar negativamente la precisión de la búsqueda, ya que se satura el algoritmo de clasificación y se devuelven demasiados resultados. Esto puede generar resultados de búsqueda irrelevantes.

Puedes aplicar una ponderación relativa a los campos de búsqueda; sin embargo, debido a los valores predeterminados sólidos, esto rara vez es necesario. Consulta los campos de peso que se pueden buscar a continuación.

El sistema de tickets de asistencia de un proveedor de servicios de Internet almacena cada ticket como un documento estructurado. Si estos documentos contienen campos de texto que admiten búsquedas, como issue_description o resolution_notes, un agente de asistencia puede realizar una consulta relacionada con el contenido de esos campos, como cómo corregir las velocidades de Internet lentas después de restablecer el módem. Luego, el sistema mostraría los documentos que contienen cualquiera de esos términos de búsqueda, incluidos módem, Internet y velocidad, en uno o ambos campos issue_description o resolution_notes.

Coincidencia de prefijo
(versión preliminar)

Permite que los campos de texto coincidan con el prefijo con el operador STARTS_WITH en las expresiones de filtro. Solo los campos de tipo String o String Array se pueden configurar como Coincidencia de prefijo.

Para obtener más información, consulta Haz que los campos estén disponibles para la coincidencia de prefijos y parcial a continuación.

Configurar un campo para que coincida con el prefijo permite que el motor de búsqueda coincida con las cadenas de consulta que son prefijos del valor del campo. Esto es particularmente útil para hacer coincidir identificadores, rutas de acceso o códigos jerárquicos en los que se conoce el comienzo de la cadena. La coincidencia de prefijos se limita a los primeros 12 caracteres del valor del campo normalizado y aumenta el tamaño del índice de la Búsqueda. No puedes establecer más de 10 campos como coincidentes con prefijos.

Tienes un campo, ticket_id, que usa un formato como <country-code><city-code><number>. Algunos ejemplos son UKLON100, UKMAN100, UKMAN101 y USNY200. Para encontrar todos los boletos de Manchester (Reino Unido), puedes configurar el campo ticket_id como coincidencia de prefijo y, luego, usar el filtro ticket_id: STARTS_WITH("UKMAN"), que devuelve UKMAN100 y UKMAN101.

Coincidencia parcial
(versión preliminar)

Permite la coincidencia parcial de cadenas en campos de texto con el operador CONTAINS en expresiones de filtro. Solo los campos de tipo String o String Array se pueden configurar para que coincidan de forma parcial.

Para obtener más información, consulta Haz que los campos estén disponibles para la coincidencia de prefijos y parcial a continuación.

Si configuras un campo para que coincida parcialmente, se habilita la coincidencia basada en tokens dentro de un campo, lo que permite que los usuarios encuentren contenido cuando solo se conoce una parte del valor del campo. El motor de búsqueda hace coincidir los tokens de consulta con los tokens del valor del campo, independientemente de su orden. Ten en cuenta que marcar un campo como parcialmente coincidente aumenta el tamaño del índice de búsqueda. No puedes establecer más de 10 campos como parcialmente coincidentes.

Quieres filtrar por regiones de Europa. Los nombres de region incluyen Central Europe y Eastern Europe. Si tu filtro es region: ANY("Europe"), no obtendrás ninguna coincidencia. Sin embargo, si el campo region se configura como parcialmente coincidente, puedes filtrar con region: CONTAINS("Europe") y obtener coincidencias para Central Europe y Eastern Europe.

Compatible con la búsqueda mientras escribes
(versión preliminar)

Marca un campo de texto como utilizable por la búsqueda a medida que escribes: a medida que el usuario escribe, se devuelven los documentos si el valor del campo contiene un token que comienza con el texto de la consulta, y el conjunto de resultados se vuelve a clasificar en cada pulsación de tecla.

Solo los campos de tipo String o String Array se pueden configurar para que sean compatibles con la búsqueda a medida que escribes. No puedes configurar más de tres campos por esquema como compatibles con la búsqueda instantánea.

Para obtener más información, consulta Haz que los campos estén disponibles para la búsqueda a medida que escribes a continuación.

Establecer un campo en saytCompatible permite que los usuarios reciban un conjunto actualizado de documentos clasificados con cada pulsación de tecla, antes de que terminen de escribir una consulta completa. Aplica este parámetro de configuración cuando esperes que los usuarios exploren una lista de resultados que se actualiza a medida que escriben, por ejemplo, búsquedas en catálogos o navegación de cola larga en la que el usuario reconoce el resultado correcto a mitad de la búsqueda en lugar de escribirlo por completo. Esto difiere de la función de autocompletar, que sugiere cadenas de consulta. La búsqueda instantánea devuelve documentos clasificados que coinciden con la consulta parcial.

En un almacén de datos de películas, configuras el campo title como saytCompatible. Cuando un usuario escribe b, los resultados de la búsqueda incluyen de forma dinámica Batman inicia, Batman regresa y Murciélagos, clasificados según la búsqueda del usuario. Cuando el usuario extiende la consulta a bat, los mismos tres documentos permanecen en el conjunto de resultados, reclasificados para el prefijo más largo. Extender la consulta a batm descarta Bats porque el primer token de su título no comienza con batm, por lo que solo quedan Batman Begins y Batman Returns, que se vuelven a clasificar.

Faceta dinámica Proporciona filtros adaptados al contexto para segmentar mejor las búsquedas de los usuarios. Configurar un campo como Dynamic Facetable permite que el sistema genere automáticamente filtros interactivos (facetas) según los valores únicos presentes en el campo. Establecer un campo en Dynamic facetable permite que los usuarios definan mejor de forma dinámica los resultados de la búsqueda seleccionando categorías o atributos derivados directamente de tus datos transferidos, sin tener que predefinir manualmente cada opción de filtro posible. Esto permite que el usuario limite su búsqueda a contenido web muy específico.
Usa Dynamic Facetable con Searchable para obtener mejores resultados, lo que mejora tanto la recuperación de tu búsqueda como la calidad de las facetas que se ofrecen al usuario.
Las páginas de una base de conocimiento corporativa interna, como las políticas de RR.HH., se incorporan con datos como department, document_type o last_modified_date. Si estos campos se etiquetan como dynamic facetable, la búsqueda de un empleado de un término como reembolso de gastos genera de forma dinámica filtros interactivos basados en los resultados pertinentes encontrados. En ese caso, la interfaz web podría mostrar facetas para Departamento: Finanzas, Viajes, Tipo de documento: Política, Preguntas frecuentes o Fecha de la última modificación: Este trimestre, el año pasado.
Recuperable Cuando una búsqueda coincide con el contenido, el motor de búsqueda puede extraer los valores de los campos recuperables para mostrarlos o usarlos en la aplicación, lo que significa que la información del documento original se muestra como parte de los resultados de la búsqueda. Los campos clave (identificadores únicos de los documentos) se configuran como recuperables. Los campos recuperables proporcionan contexto de búsqueda, ya que distinguen los campos cuyos valores se pueden mostrar de aquellos que solo se usarán en la lógica de búsqueda, pero cuyos valores sin procesar no se deben mostrar al usuario. Para una búsqueda de productos en un sitio de comercio, product_id, name, price y un image_url son campos típicos que deseas establecer como recuperables. Por otro lado, el internal_tracking_code se puede indexar y filtrar solo con fines administrativos, pero no se puede recuperar en los resultados de la búsqueda pública.
Completable Permite que el contenido de un campo se use para sugerencias de búsquedas. Para obtener más información, consulta Configura la función de autocompletar.

Este parámetro de configuración permite que los valores de ese campo se usen para proporcionar sugerencias de búsqueda en tiempo real a medida que los usuarios escriben. Esta función ayuda a guiar a los usuarios hacia el contenido relevante y acelera el proceso de búsqueda. Ciertos factores, como el uso del filtrado de lenguaje natural, pueden afectar este rendimiento.

Si el campo completable se establece para product_name, brand y category, cuando el usuario escriba Tech, las sugerencias de autocompletar pueden mostrar lo siguiente:
  • TechCo (del campo brand)
  • TechCo UltraBook X1 (del campo product_name)
  • Tecnología GameMaster Pro (otro producto del campo category)
Filtrable Permite que las recomendaciones usen un campo para filtrar los resultados recomendados, lo que determina qué resultados de la búsqueda ven los usuarios. Para obtener información sobre cómo filtrar recomendaciones, consulta Filtra recomendaciones. Establecer un campo en Filterable ayuda a personalizar las recomendaciones para los usuarios. Ten en cuenta que se aplican límites de filtrado. Un parámetro de configuración de filtro por idioma y drama podría verse de la siguiente manera: language_code: ANY("en", "fr") OR categories: ANY("drama").

Diferencias entre los parámetros de configuración de uso frecuente

Existen diferencias clave entre los parámetros de configuración de los campos indexables, que se pueden buscar y recuperar. En la tabla, se resumen estas diferencias.

Función Indexable Se puede buscar Recuperable
Rol principal Hace que el contenido del campo esté disponible para el motor de búsqueda Permite realizar consultas de texto completo en el contenido de los campos. Permite que el valor del campo se devuelva en los resultados de la búsqueda
Análisis El contenido se procesa y se coloca en un índice. Suele someterse a un análisis léxico exhaustivo. El valor se almacena tal como está para mostrarlo.
¿Puede ser…
...Se puede buscar? Sí (a menudo es un requisito previo) N/A No necesariamente (se puede recuperar sin que se pueda buscar)
¿Se puede recuperar? No necesariamente. No necesariamente. N/A
...Filtrable/Ordenable/Facetable? Sí (por lo general, también es un requisito previo para estos). No directamente; estos son atributos independientes que suelen crearse en un campo indexable. No directamente; estos atributos se relacionan con la forma en que se indexa y consulta el campo, no solo con cómo se muestra.

En la práctica, muchos campos que son cruciales para la experiencia del usuario (como los títulos, las descripciones y la información de identificación) suelen configurarse como indexable, searchable y retrievable.

Limitaciones

La configuración de campos tiene las siguientes limitaciones:

  • Puedes configurar hasta 50 campos como indexables, con capacidad de búsqueda, recuperables o con categorización dinámica en facetas.
  • Para configurar un campo como dinámico con atributos, primero se debe configurar como indexable.
  • Para cambiar el parámetro de configuración indexable, es necesario volver a indexar los datos, lo que puede tardar horas, en especial, en el caso de almacenes de datos grandes.

Si configuras campos para una app de búsqueda de contenido multimedia y quieres obtener información detallada sobre los campos del esquema, consulta Acerca de los documentos multimedia y los almacenes de datos.

Actualiza la configuración de los campos

Para actualizar la configuración de los campos, sigue estos pasos:

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

    Aplicaciones de IA

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

  3. Haz clic en Datos (Data).

  4. Haz clic en la pestaña Esquema. En esta pestaña, se muestra la configuración actual de los campos.

    No verás la pestaña Esquema si tu almacén de datos contiene datos básicos del sitio web o datos no estructurados sin metadatos.

  5. Haz clic en Editar.

  6. Selecciona o borra los parámetros de configuración de los campos que necesites actualizar. No se admiten algunos parámetros de configuración de campos. Por ejemplo, los campos numéricos no se pueden establecer en Permite búsquedas.

  7. Haz clic en Guardar para aplicar los cambios.

Si marcas un campo como apto para búsquedas, puedes especificar un peso para indicar su importancia relativa en los resultados de la búsqueda. En la mayoría de las situaciones, no es necesario que especifiques pesos para campos individuales, ya que los pesos predeterminados funcionan bien.

Sin embargo, puede ser necesario ajustar los pesos en algunas situaciones, por ejemplo:

  • Estás migrando datos de una plataforma de búsqueda existente que ya usa campos ponderados.

  • Cuando las ponderaciones predeterminadas no proporcionan resultados de la búsqueda satisfactorios. En particular, esto puede suceder cuando tienes muchos campos de búsqueda y algunos son notablemente más importantes que otros.

    Tal vez, el resumen sea el campo más importante para las búsquedas, por lo que te conviene priorizar ese texto.

    O bien, el esquema tiene un campo que contiene palabras clave muy relevantes que son excelentes predictores para los resultados de la búsqueda, pero, debido a que este campo es mucho más corto que otros, su influencia suele verse opacada por campos más largos. Aumentar su peso garantiza que tenga el impacto previsto.

Niveles de peso

Los pesos se agrupan en los siguientes niveles:

Importancia de los campos Explicación
Muy baja Un valor bajo que el sistema aún considera cuando combina las puntuaciones de todos los campos. Si quieres que tenga aún menos peso para que el efecto sea insignificante, no marques el campo como de búsqueda.
Baja Un peso inferior al predeterminado.
Valor predeterminado Es el peso estándar para los campos de búsqueda. Este peso proporciona un rendimiento razonablemente bueno en la mayoría de los casos.
Alta Un peso que es notablemente más alto que el predeterminado.
Muy alto Un peso dominante. Por lo general, esto se reserva para un campo como máximo.

Actualización del esquema y reindexación

Para agregar pesos a los campos de búsqueda, se requiere una actualización del esquema y una reindexación posterior de los datos en el almacén de datos. La actualización del esquema lleva horas y no hay un indicador confiable que te indique cuándo se completó la indexación, por lo que debes sobreestimar el tiempo de indexación.

Establece niveles de peso en los campos

La tarea de establecer niveles de peso para los campos puede ser tediosa, ya que solo debes realizar pequeños cambios y revisar con cuidado los resultados de la búsqueda para verificar si hay consecuencias no deseadas. Después de cada cambio, debes esperar a que se complete la reindexación antes de evaluar el impacto del cambio.

Solo puedes configurar la ponderación de los campos de búsqueda a través de la API. Esta función no está disponible en la consola de Google Cloud .

Para establecer ponderaciones, debes actualizar el esquema del almacén de datos a través del método projects.locations.dataStores.schemas.patch de la API.

  1. Si aún no tienes tu esquema, sigue las instrucciones para obtenerlo en Visualiza una definición de esquema.

  2. Sigue las instrucciones para actualizar el esquema de forma programática. Agrega pesos a uno o más campos de búsqueda, como en estos ejemplos:

    "summary": {
       "type": "string",
       "searchable": true,
       "weight": "high"
     },
     "uri": {
       "type": "string",
       "searchable": true,
       "weight": "low"
     },
    

    En este ejemplo, el campo summary se establece con un peso mayor que el normal, y el campo uri, con un peso menor. Si quieres devolver un peso al valor predeterminado, establécelo en default.

    Los valores permitidos para el parámetro de peso son los siguientes:

    • very_low
    • low
    • default
    • high
    • very_high
  3. Espera a que se complete la reindexación y prueba el comportamiento de la búsqueda.

Haz que los campos estén disponibles para la coincidencia parcial y de prefijos (versión preliminar)

En el caso de los campos de tipo string, puedes editar el esquema para que estén disponibles para la coincidencia de prefijos o la coincidencia parcial. Esto te permite usar STARTS_WITH o CONTAINS en expresiones de filtro.

Actualización del esquema y reindexación

Para que los campos estén disponibles para la coincidencia de prefijos o parcial, se requiere una actualización del esquema y la posterior reindexación de los datos en el almacén de datos. La actualización del esquema lleva horas y no hay un indicador confiable que te indique cuándo se completó la indexación, por lo que debes sobreestimar el tiempo de indexación.

Actualiza el esquema para la coincidencia de prefijos y parcial

Para especificar los campos disponibles para la coincidencia de prefijos o la coincidencia parcial, debes actualizar el esquema del almacén de datos a través del método de la API projects.locations.dataStores.schemas.patch.

  1. Si aún no tienes tu esquema, sigue las instrucciones para obtenerlo en Visualiza una definición de esquema.

  2. Sigue las instrucciones para actualizar el esquema de forma programática. Establece los parámetros que se pueden hacer coincidir en true en el esquema, como en estos ejemplos:

    "zone": {
       "type": "string",
       "searchable": true,
       "prefixMatchable": true
     },
     "region": {
       "type": "string",
       "searchable": true,
       "partialMatchable": true
     },
     "model": {
       "type": "string",
       "searchable": true,
       "prefixMatchable": true,
       "partialMatchable": true
     },
    

    En este ejemplo, el campo zone se configura para que coincida con el prefijo. En la expresión de filtro, se pueden usar hasta 12 caracteres, sin distinguir mayúsculas de minúsculas, para que coincidan con el valor del campo. El campo region está configurado para que coincida parcialmente.

  3. Espera a que se complete la reindexación.

Detalles sobre la coincidencia de prefijos

La coincidencia de prefijos en Agent Search te permite filtrar los resultados en función de si el valor de un campo comienza con una cadena específica. Esta función se basa en el operador STARTS_WITH y requiere que el campo de texto de destino se configure como prefixMatchable en el esquema.

Lógica de normalización y coincidencia

Para optimizar el rendimiento y garantizar la coherencia, el sistema aplica un proceso de normalización específico al valor del campo (durante la indexación) y a la cadena de consulta (durante la búsqueda).

  1. Minúsculas: Todos los caracteres se convierten en minúsculas. Esto hace que la coincidencia no distinga mayúsculas de minúsculas.

  2. Truncamiento de 12 caracteres: El sistema solo considera los primeros 12 caracteres de la cadena. Los caracteres que superen este límite se ignorarán para la coincidencia de prefijos.

Cómo funciona

En el momento de la indexación, para un campo marcado como prefixMatchable, el sistema genera tokens de prefijo para los primeros 12 caracteres. Para un valor como asia-south1-c, el índice almacena tokens para a, as, asi, asia, asia-, etcétera, hasta el carácter número 12 (asia-south1-).

En el momento de la consulta, la cadena proporcionada al operador STARTS_WITH también se convierte en minúsculas y se trunca a 12 caracteres. Luego, la consulta se compara con los tokens de prefijo almacenados.

Ejemplos

En los siguientes ejemplos, se muestra cómo la normalización de 12 caracteres afecta los resultados de la búsqueda:

  • Coincidencias amplias: STARTS_WITH("A") coincide con cualquier valor que comience con "a" (no distingue mayúsculas de minúsculas), como asia, australia o africa.

  • Prefijos parciales: STARTS_WITH("asia-south") coincide con asia-south1-a y asia-southeast1-b porque ambos comienzan con la cadena de 10 caracteres especificada.

  • Comportamiento de truncamiento: Debido a que solo coinciden los primeros 12 caracteres, STARTS_WITH("asia-south1-a") coincide con un valor de campo de asia-south1-c. Esto se debe a que ambas cadenas se normalizan con el mismo prefijo de 12 caracteres: asia-south1-.

Detalles sobre la coincidencia parcial

La coincidencia parcial en la búsqueda de agentes te permite filtrar los resultados en función de si el valor de un campo contiene palabras o tokens específicos. Esta función se basa en el operador CONTAINS y requiere que el campo de texto de destino se configure como partialMatchable en el esquema.

Lógica de normalización y asignación de token

La búsqueda de agentes normaliza y asigna tokens tanto al valor del campo (durante la indexación) como a la cadena de consulta (durante la búsqueda):

  • Conversión a minúsculas: Agent Search convierte los caracteres en minúsculas. Esto hace que la coincidencia no distinga mayúsculas de minúsculas.

  • Asignación de token: Agent Search divide la cadena en tokens individuales (palabras) con espacios y otros caracteres como delimitadores.

    • Delimitadores estándar: Los espacios y la puntuación común actúan como delimitadores; estos incluyen guiones (-), barras diagonales (/), comas (,), puntos (.), asteriscos (*), llaves ({ }), corchetes ([ ]), paréntesis (( )) y apóstrofos (').

    • No delimitadores: El signo de unión (&) y el guion bajo (_) no actúan como delimitadores. El sistema trata los caracteres unidos por estos símbolos como un solo token.

    • Delimitador de correo electrónico (@): El símbolo @ actúa como un delimitador especial para ayudar a reconocer las direcciones de correo electrónico. El sistema genera tokens para los componentes individuales y las formas combinadas. Por ejemplo, convierte support+tier1@example.com en support, tier1, example, com, support+tier1@example.com y support@example.com.

Cómo funciona

En el momento de la indexación, para un campo marcado como partialMatchable, el sistema normaliza y asigna un token al valor del campo, y almacena los tokens resultantes en el índice. Por ejemplo, asigna un token a un valor de campo de 25-meter, outdoor, swimming pool a [25, meter, outdoor, swimming, pool].

En el momento de la consulta, la cadena proporcionada al operador CONTAINS se somete al mismo proceso de normalización y asignación de token. Luego, el motor de búsqueda verifica que todos los tokens de consulta resultantes coincidan con los tokens almacenados para el campo. El orden de los tokens no tiene ningún efecto.

Ejemplos

En los siguientes ejemplos, se muestra cómo la asignación de token afecta los resultados de coincidencias parciales:

  • Coincidencia de tokens básica: Si el valor del campo es 25-meter, outdoor, swimming pool, un filtro de CONTAINS("Outdoor pool") coincide. El sistema asigna un token a la consulta para [outdoor, pool], que existen en los tokens del campo.

  • Independencia del orden: Un filtro de CONTAINS("pool outdoor") también coincide con el valor del campo 25-meter, outdoor, swimming pool porque el sistema verifica la presencia de cada token independientemente de su orden.

  • Coincidencia de direcciones de correo electrónico: Si un campo almacena el correo electrónico support+tier1@example.com, los filtros como CONTAINS("support"), CONTAINS("example.com") o CONTAINS("support@example.com") coinciden correctamente debido a la asignación de token especial del símbolo @.

Habilita los campos para la búsqueda mientras escribes (versión preliminar)

En el caso de los campos de tipo string, puedes editar el esquema para marcarlos como saytCompatible. Cuando uno o más campos del esquema son saytCompatible y tu aplicación habilita la búsqueda a medida que escribes en la solicitud de búsqueda, Agent Search devuelve documentos cuyos campos saytCompatible contienen un token que comienza con el texto de la consulta y reclasifica esos documentos con cada pulsación de tecla.

Acerca de la búsqueda instantánea de contenido multimedia

La búsqueda mientras escribes es una función de disponibilidad general para las apps de contenido multimedia. Consulta Cómo obtener resultados de búsqueda instantánea para una app multimedia para conocer el campo de solicitud searchAsYouTypeSpec.condition solo para contenido multimedia.

El parámetro de configuración del campo saytCompatible extiende la búsqueda a medida que escribes a cualquier app de búsqueda, ya que te permite marcar los campos de esquema específicos para responder consultas parciales. Las apps de contenido multimedia pueden seguir usando searchAsYouTypeSpec.condition como antes, mientras que las que no son de contenido multimedia necesitan campos saytCompatible en el esquema.

Autocompletar y búsqueda mientras escribes

La búsqueda mientras escribes es diferente de la función de autocompletar:

  • La función de autocompletar predice cadenas de consulta y se controla con el parámetro de configuración del campo completable.
  • La Search-as-you-type devuelve documentos clasificados y se basa en el parámetro de configuración del campo saytCompatible.

Las dos funciones se pueden usar de forma independiente o en conjunto, y no comparten datos.

Límites

La conversión de campos en saytCompatible tiene los siguientes límites:

  • No puedes marcar más de tres campos por esquema como saytCompatible. Si configuras un cuarto, se muestra un error INVALID_ARGUMENT de la API cuando parcheas el esquema.
  • saytCompatible solo es válido en campos de tipo string. Si lo configuras en los campos number, integer, boolean, object o datetime, se muestra un error INVALID_ARGUMENT de la API.
  • Solo se indexan los primeros 12 tokens del valor de un campo, y cada token aporta fragmentos de prefijo de hasta 10 caracteres. Los valores más largos se siguen indexando, pero no se puede acceder al final a través de un prefijo.

Actualización del esquema y reindexación

Configurar los campos como saytCompatible requiere una actualización del esquema y una reindexación posterior de los datos en el almacén de datos. La actualización del esquema tarda horas y no hay un indicador confiable que te indique cuándo se completó la indexación, por lo que debes sobreestimar el tiempo de indexación.

Actualiza el esquema para la búsqueda mientras escribes

Para marcar campos como saytCompatible con el método projects.locations.dataStores.schemas.patch, haz lo siguiente:

  1. Si aún no tienes tu esquema, sigue las instrucciones para obtenerlo en Visualiza una definición de esquema.

  2. Sigue las instrucciones para actualizar el esquema de forma programática. Establece saytCompatible en true en los campos que deseas habilitar para la función, como en este ejemplo:

    "title": {
       "type": "string",
       "retrievable": true,
       "saytCompatible": true
     },
     "channel_name": {
       "type": "string",
       "retrievable": true,
       "saytCompatible": true
     },
    

    En este ejemplo, los campos title y channel_name se marcan como saytCompatible. Si configuras saytCompatible en un campo cuyo tipo no es string, se muestra un error INVALID_ARGUMENT de la API, al igual que si lo configuras en más de tres campos del esquema.

  3. Espera a que se complete la reindexación.

Envía una solicitud de búsqueda mientras escribes

Después de que se complete la reindexación, habilita la búsqueda mientras escribes en cada solicitud de búsqueda. Para ello, envía una solicitud de búsqueda cuyo cuerpo incluya searchAsYouTypeSpec. Los campos marcados como saytCompatible en el esquema solo se consultan cuando se establece searchAsYouTypeSpec en la solicitud, por lo que puedes mantener la misma configuración de entrega para las consultas parciales y completas.

Para enviar una solicitud de búsqueda mientras escribes, haz lo siguiente:

  1. Llama al método de búsqueda en tu configuración de entrega, como se describe en Obtén resultados de la búsqueda.

  2. En el cuerpo de la solicitud, establece searchAsYouTypeSpec.condition en ENABLED. Esto habilita la búsqueda mientras escribes en la solicitud.

  3. Opcional: En el mismo searchAsYouTypeSpec, restringe la búsqueda a medida que escribes a un subconjunto de los campos saytCompatible del esquema, asigna a cada campo un peso relativo y establece un umbral de puntuación mínimo por debajo del cual se descartan los documentos. Todos los valores de este bloque son opcionales. Cuando se omiten, se aplican los valores predeterminados.

    • fields[i].key: un campo de esquema marcado como saytCompatible. Hacer referencia a un campo que no es saytCompatible no devuelve ninguna contribución de búsqueda predictiva de ese campo.
    • fields[i].weight: Es la importancia relativa del campo en la puntuación de búsqueda a medida que escribes. La configuración predeterminada es 1.0.
    • scoreThreshold: Se excluyen los documentos cuya puntuación de búsqueda predictiva es inferior a este valor. La configuración predeterminada es sin umbral.
  4. Envía la solicitud. En el siguiente ejemplo, se muestra la forma de un searchAsYouTypeSpec que habilita la búsqueda a medida que escribes, la limita a dos campos con diferentes ponderaciones y establece una puntuación mínima:

    "searchAsYouTypeSpec": {
      "condition": "ENABLED",
      "fields": [
        { "key": "title", "weight": 1.2 },
        { "key": "channel_name" }
      ],
      "scoreThreshold": 0.5
    }
    

Detalles sobre la búsqueda mientras escribes

La búsqueda mientras escribes en la búsqueda de agentes permite que los usuarios reciban documentos clasificados en cada pulsación de tecla en los campos marcados como saytCompatible en el esquema.

Lógica de normalización y asignación de token

Agent Search normaliza y asigna tokens tanto al valor del campo (durante la indexación) como al texto de la consulta (durante la búsqueda):

  • Conversión a minúsculas: Agent Search convierte los caracteres en minúsculas. Esto hace que la coincidencia no distinga mayúsculas de minúsculas.

  • Asignación de token: Agent Search divide la cadena en tokens individuales (palabras) con espacios y puntuación común como delimitadores, lo que coincide con el comportamiento que se usa para la coincidencia parcial.

  • Límites por campo: Solo se indexan los primeros 12 tokens del valor del campo para la búsqueda instantánea. Cada uno de esos tokens aporta fragmentos de prefijo de hasta sus primeros 10 caracteres.

Ejemplo

Si el campo actor_name está marcado como saytCompatible y un documento tiene el valor Christian Bale, una consulta de chr llega al documento a través del fragmento de prefijo de longitud 3 del token christian, y extender la consulta a chris aún coincide con el fragmento de prefijo de longitud 5. Una consulta de bale también coincide, a través del fragmento de prefijo de longitud 4 del segundo token en el valor del campo. Las actualizaciones de clasificación se realizan en cada pulsación de tecla a medida que el usuario escribe.

¿Qué sigue?