Opciones de consulta y ordenación

Cuando llamas al método search() usando solo una cadena de consulta, los resultados se devuelven según las opciones de consulta predeterminadas:

• Los documentos se devuelven ordenados de mayor a menor según su rango.
• Los documentos se devuelven en grupos de 20
• Los documentos recuperados contienen todos sus campos originales

Puedes usar una instancia de la clase Query como argumento de search() para cambiar estas opciones.

La clase Query te permite especificar cuántos documentos quieres devolver a la vez. También te permite personalizar el contenido de los documentos recuperados. Puedes solicitar solo los identificadores de los documentos o pedir que los documentos contengan solo un subconjunto de sus campos. También puedes crear campos personalizados en los documentos recuperados: snippets (fragmentos de campos de texto que muestran el texto que rodea a una cadena coincidente) y expresiones de campo (campos con valores derivados de otros campos del documento).

Además de las opciones de consulta, la clase Query también puede incluir una instancia de la clase SortOptions. Con las opciones de ordenación, puedes cambiar el orden y ordenar los resultados por varios criterios.

Buscar con la clase Query

Cuando buscas con una instancia de la clase Query, debes crear una instancia de la clase en varios pasos. Este es el orden general:

1. Crea una cadena de consulta.
2. Crea un SortOptions si es necesario.
3. Crear QueryOptions.
4. Crea un objeto Query que incluya la cadena de consulta y el QueryOptions (opcional).
5. Llama al método de búsqueda en el objeto Query.

Las distintas opciones de consulta y ordenación se especifican llamando a métodos setter en instancias de las clases QueryOptions.Builder y SortOptions.Builder, como en este ejemplo:

try {
  // Build the SortOptions with 2 sort keys
  SortOptions sortOptions =
      SortOptions.newBuilder()
          .addSortExpression(
              SortExpression.newBuilder()
                  .setExpression("price")
                  .setDirection(SortExpression.SortDirection.DESCENDING)
                  .setDefaultValueNumeric(0))
          .addSortExpression(
              SortExpression.newBuilder()
                  .setExpression("brand")
                  .setDirection(SortExpression.SortDirection.DESCENDING)
                  .setDefaultValue(""))
          .setLimit(1000)
          .build();

  // Build the QueryOptions
  QueryOptions options =
      QueryOptions.newBuilder()
          .setLimit(25)
          .setFieldsToReturn("model", "price", "description")
          .setSortOptions(sortOptions)
          .build();

  // A query string
  String queryString = "product: coffee roaster AND price < 500";

  //  Build the Query and run the search
  Query query = Query.newBuilder().setOptions(options).build(queryString);
  IndexSpec indexSpec = IndexSpec.newBuilder().setName(indexName).build();
  Index index = SearchServiceFactory.getSearchService().getIndex(indexSpec);
  Results<ScoredDocument> result = index.search(query);
  return result;
} catch (SearchException e) {
  // handle exception...
}

QueryOptions

Para definir las opciones de consulta, debes usar QueryOptions.Builder. No tienes acceso directo a estas propiedades.

Estas propiedades controlan cuántos resultados se devuelven y en qué orden. Las opciones offset y cursor, que se excluyen mutuamente, admiten la paginación. Especifican qué documentos seleccionados se deben devolver en los resultados.

Estas propiedades controlan qué campos del documento aparecen en los resultados.

SortOptions

Las propiedades de SortOptions controlan el orden y la puntuación de los resultados de búsqueda. Debes usar el SortOptions.Builder para definir las opciones de ordenación. No tienes acceso directo a estas propiedades.

Las propiedades de SortOptions controlan el orden y la puntuación de los resultados de búsqueda.

Ordenar por varias claves

Puedes ordenar los resultados de búsqueda por varias claves de ordenación. Cada clave puede ser un nombre de campo sencillo o un valor que se calcula a partir de varios campos. Ten en cuenta que el término "expresión" se usa con varios significados cuando se habla de opciones de orden: el SortOption en sí tiene un atributo expressions. Este atributo es una lista de objetos SortExpression que corresponden a claves de ordenación. Por último, cada objeto SortExpression contiene un atributo expression que especifica cómo calcular el valor de la clave de ordenación. Esta expresión se crea según las reglas de la sección siguiente.

Un SortExpression también define la dirección de la ordenación y un valor de clave predeterminado que se usará si no se puede calcular la expresión de un documento. Esta es la lista completa de propiedades:

Ordenar por campos con varios valores

Cuando ordenas por un campo de varios valores de un tipo concreto, solo se usa el primer valor asignado al campo. Por ejemplo, supongamos que tienes dos documentos, DocA y DocB, que tienen un campo de texto llamado "color". Se asignan dos valores al campo "color" de DocA en el orden (rojo, azul) y dos valores a DocB en el orden (verde, rojo). Si ordenas los documentos por el campo de texto "color", el documento A se ordenará por el valor "rojo" y el documento B por el valor "verde". Los demás valores de los campos no se usan en la ordenación.

Ordenar o no ordenar

Si no especifica ninguna opción de orden, los resultados de búsqueda se devolverán automáticamente ordenados por rango descendente. En este caso, no hay límite en el número de documentos que se devuelven. Si especifica alguna opción de ordenación, esta se llevará a cabo después de seleccionar todos los documentos coincidentes. Hay una propiedad explícita, `SortOptions.limit`, que controla el tamaño de la ordenación. Nunca podrás ordenar más de 10.000 documentos. El valor predeterminado es 1000. Si hay más documentos que coinciden que el número especificado por `SortOptions.limit`, la búsqueda solo recupera, ordena y devuelve ese número limitado. Selecciona los documentos que se van a ordenar de la lista de todos los documentos coincidentes, que está ordenada de forma descendente según la clasificación. Es posible que una consulta seleccione más documentos coincidentes de los que puedes ordenar. Si usas opciones de ordenación y es importante recuperar todos los documentos coincidentes, debes intentar asegurarte de que tu consulta no devuelva más documentos de los que puedes ordenar.

Escribir expresiones

Las expresiones se usan para definir expresiones de campo (que se definen en `QueryOptions`) y expresiones de orden, que se definen en SortOptions. Se escriben como cadenas:

"price * quantity"
"(men + women)/2"
"min(daily_use, 10) * rate"
"snippet('rose', flower, 120)"

Las expresiones que incluyan campos de número pueden usar los operadores aritméticos (+, -, *, /) y las funciones numéricas integradas que se indican a continuación. Las expresiones que incluyan campos de tipo geopunto pueden usar las funciones geopunto y distancia. Las expresiones de los campos de texto y HTML pueden usar la función de fragmento.

Las expresiones también pueden incluir estos términos especiales:

Funciones numéricas

Las expresiones para definir los valores numéricos de FieldExpressions y SortExpressions pueden usar estas funciones integradas. Los argumentos deben ser números, nombres de campo o expresiones que usen números y nombres de campo.

Funciones de geopunto

Estas funciones se pueden usar en expresiones que incluyan campos de geopunto.

Fragmentos

Un fragmento es un fragmento de un campo de texto que coincide con una cadena de consulta e incluye el texto circundante. Los fragmentos se crean llamando a la función snippet:

snippet(query, body, [max_chars])

query

Cadena de consulta entre comillas que especifica el texto que se va a buscar en el campo.

body

Nombre de un campo de texto, HTML o Atom.

max_chars

Número máximo de caracteres que se devolverán en el fragmento. Este argumento es opcional y su valor predeterminado es 160 caracteres.

La función devuelve una cadena HTML. La cadena contiene un fragmento del valor del campo body, con el texto que ha coincidido con la consulta en negrita.