Función search.in de OData en Azure AI Search
Un escenario común en las expresiones de filtro de OData consiste en comprobar si un solo campo de cada documento es igual a uno de muchos valores posibles. Por ejemplo, para implementar el recorte de seguridad, algunas aplicaciones realizan una comparación entre un campo que contiene uno o varios identificadores de entidad de seguridad y una lista de identificadores de entidad de seguridad que representa al usuario que emite la consulta. Una manera de escribir una consulta como esta consiste en usar los operadores eq y or:
group_ids/any(g: g eq '123' or g eq '456' or g eq '789')
También hay una forma más corta de escribirla mediante la función search.in:
group_ids/any(g: search.in(g, '123, 456, 789'))
Importante
Además de ser más corta y más fácil de leer, la función search.in también conlleva ventajas de rendimiento y evita determinadas limitaciones en el tamaño de los filtros cuando hay que incluir en el filtro cientos o incluso miles de valores. Por este motivo, se recomienda encarecidamente usar search.in en lugar de una disyunción más compleja de expresiones de igualdad.
Nota:
Recientemente se ha incluido en la versión 4.01 del estándar OData el inoperador , que tiene un comportamiento similar al de la función search.in en Azure AI Search. Aun así, Azure AI Search no admite este operador, por lo que debe usar la función search.in en su lugar.
Sintaxis
La siguiente EBNF (notación de Backus-Naur extendida) define la gramática de la función search.in:
search_in_call ::=
'search.in(' variable ',' string_literal(',' string_literal)? ')'
También está disponible un diagrama de sintaxis interactivo:
Nota:
Consulta Referencia de sintaxis de expresiones OData para Azure AI Search para obtener la EBNF completa.
La función search.in prueba si un determinado campo de cadena o variable de rango es igual a uno de una lista de valores dada. La igualdad entre la variable y cada valor de la lista se determina distinguiendo entre mayúsculas y minúsculas, del mismo modo que para el operador eq. Por lo tanto, una expresión como search.in(myfield, 'a, b, c') es equivalente a myfield eq 'a' or myfield eq 'b' or myfield eq 'c', salvo que search.in ofrecerá un rendimiento mucho mejor.
Hay dos sobrecargas de la función search.in:
search.in(variable, valueList)search.in(variable, valueList, delimiters)
Los parámetros se definen en la tabla siguiente:
| Nombre de parámetro | Type | Descripción |
|---|---|---|
variable |
Edm.String |
Referencia de campo de cadena (o variable de rango en un campo de colección de cadenas en el caso de que search.in se use en una expresión any o all). |
valueList |
Edm.String |
Cadena que contiene una lista delimitada de valores que deben coincidir con el parámetro variable. Si no se especifica el parámetro delimiters, los delimitadores predeterminados son espacio y coma. |
delimiters |
Edm.String |
Cadena en la que cada carácter se trata como separador al analizar el parámetro valueList. El valor predeterminado de este parámetro es ' ,', lo que significa que todos los valores con espacios o comas entre ellos se separarán. Si tiene que usar separadores que no sean espacios y comas porque sus valores incluyen dichos caracteres, puede especificar delimitadores alternativos, como '|' en este parámetro. |
Rendimiento de search.in
Si usa search.in, puede esperar un tiempo de respuesta de fracciones de segundo cuando el segundo parámetro contiene una lista de cientos o miles de valores. No hay ningún límite explícito en el número de elementos que puede pasar a search.in, aunque sigue estando limitado por el tamaño máximo de la solicitud. Sin embargo, la latencia aumentará a medida que crece el número de valores.
Ejemplos
Busque todos los hoteles cuyo nombre sea "Sea View motel" o "Budget hotel". Las frases contienen espacios, que es un delimitador predeterminado. Puede especificar un delimitador alternativo entre comillas simples como tercer parámetro de cadena:
search.in(HotelName, 'Sea View motel,Budget hotel', ',')
Buscar todos los hoteles cuyo nombre sea "Sea View motel" o "Budget hotel" separados por "|"):
search.in(HotelName, 'Sea View motel|Budget hotel', '|')
Busque todos los hoteles con habitaciones que tengan la etiqueta "wifi" o "tub":
Rooms/any(room: room/Tags/any(tag: search.in(tag, 'wifi, tub')))
Buscar una coincidencia en las frases de una colección, como "heated towel racks" o "hairdryer included" en las etiquetas.
Rooms/any(room: room/Tags/any(tag: search.in(tag, 'heated towel racks,hairdryer included', ','))
Busque todos los hoteles sin la etiqueta "motel" o "cabin":
Tags/all(tag: not search.in(tag, 'motel, cabin'))