Udostępnij za pośrednictwem

Dokumentacja składni wyrażeń OData dla usługi Azure AI Search

  • Artykuł

Usługa Azure AI Search używa wyrażeń OData jako parametrów w całym interfejsie API. Najczęściej wyrażenia OData są używane dla $orderby parametrów i $filter . Te wyrażenia mogą być złożone, zawierające wiele klauzul, funkcji i operatorów. Jednak nawet proste wyrażenia OData, takie jak ścieżki właściwości, są używane w wielu częściach interfejsu API REST usługi Azure AI Search. Na przykład wyrażenia ścieżki służą do odwoływania się do pól podrzędnych złożonych pól wszędzie w interfejsie API, takich jak w przypadku wyświetlania podpole w sugestorze, funkcji oceniania, $select parametru, a nawet wyszukiwania pól w zapytaniach Lucene.

W tym artykule opisano wszystkie te formy wyrażeń OData przy użyciu formalnej gramatyki. Istnieje również interaktywny diagram , który ułatwia wizualne eksplorowanie gramatyki.

Gramatyka formalna

Możemy opisać podzbiór języka OData obsługiwanego przez usługę Azure AI Search przy użyciu gramatyki rozszerzonego formularza Backus-Naur (EBNF). Reguły są wyświetlane jako "od góry do dołu", począwszy od najbardziej złożonych wyrażeń i dzieląc je na bardziej pierwotne wyrażenia. U góry znajdują się reguły gramatyczne, które odpowiadają określonym parametrom interfejsu API REST usługi Azure AI Search:

  • $filter, zdefiniowany przez regułę filter_expression .
  • $orderby, zdefiniowany przez regułę order_by_expression .
  • $select, zdefiniowany przez regułę select_expression .
  • Ścieżki pól zdefiniowane przez regułę field_path . Ścieżki pól są używane w całym interfejsie API. Mogą odwoływać się do pól najwyższego poziomu indeksu lub podpola z co najmniej jednym złożonymi elementami głównymi pól .

Po pliku EBNF jest diagramem składni z możliwością przeglądania, który umożliwia interaktywne eksplorowanie gramatyki i relacji między regułami.

/* Top-level rules */

filter_expression ::= boolean_expression

order_by_expression ::= order_by_clause(',' order_by_clause)*

select_expression ::= '*' | field_path(',' field_path)*

field_path ::= identifier('/'identifier)*


/* Shared base rules */

identifier ::= [a-zA-Z_][a-zA-Z_0-9]*


/* Rules for $orderby */

order_by_clause ::= (field_path | sortable_function) ('asc' | 'desc')?

sortable_function ::= geo_distance_call | 'search.score()'


/* Rules for $filter */

boolean_expression ::=
    collection_filter_expression
    | logical_expression
    | comparison_expression
    | boolean_literal
    | boolean_function_call
    | '(' boolean_expression ')'
    | variable

/* This can be a range variable in the case of a lambda, or a field path. */
variable ::= identifier | field_path

collection_filter_expression ::=
    field_path'/all(' lambda_expression ')'
    | field_path'/any(' lambda_expression ')'
    | field_path'/any()'

lambda_expression ::= identifier ':' boolean_expression

logical_expression ::=
    boolean_expression ('and' | 'or') boolean_expression
    | 'not' boolean_expression

comparison_expression ::= 
    variable_or_function comparison_operator constant | 
    constant comparison_operator variable_or_function

variable_or_function ::= variable | function_call

comparison_operator ::= 'gt' | 'lt' | 'ge' | 'le' | 'eq' | 'ne'


/* Rules for constants and literals */

constant ::=
    string_literal
    | date_time_offset_literal
    | integer_literal
    | float_literal
    | boolean_literal
    | 'null'

string_literal ::= "'"([^'] | "''")*"'"

date_time_offset_literal ::= date_part'T'time_part time_zone

date_part ::= year'-'month'-'day

time_part ::= hour':'minute(':'second('.'fractional_seconds)?)?

zero_to_fifty_nine ::= [0-5]digit

digit ::= [0-9]

year ::= digit digit digit digit

month ::= '0'[1-9] | '1'[0-2]

day ::= '0'[1-9] | [1-2]digit | '3'[0-1]

hour ::= [0-1]digit | '2'[0-3]

minute ::= zero_to_fifty_nine

second ::= zero_to_fifty_nine

fractional_seconds ::= integer_literal

time_zone ::= 'Z' | sign hour':'minute

sign ::= '+' | '-'

/* In practice integer literals are limited in length to the precision of
the corresponding EDM data type. */
integer_literal ::= sign? digit+

float_literal ::=
    sign? whole_part fractional_part? exponent?
    | 'NaN'
    | '-INF'
    | 'INF'

whole_part ::= integer_literal

fractional_part ::= '.'integer_literal

exponent ::= 'e' sign? integer_literal

boolean_literal ::= 'true' | 'false'


/* Rules for functions */

function_call ::=
    geo_distance_call |
    boolean_function_call

geo_distance_call ::=
    'geo.distance(' variable ',' geo_point ')'
    | 'geo.distance(' geo_point ',' variable ')'

geo_point ::= "geography'POINT(" lon_lat ")'"

lon_lat ::= float_literal ' ' float_literal

boolean_function_call ::=
    geo_intersects_call |
    search_in_call |
    search_is_match_call

geo_intersects_call ::=
    'geo.intersects(' variable ',' geo_polygon ')'

/* You need at least four points to form a polygon, where the first and
last points are the same. */
geo_polygon ::=
    "geography'POLYGON((" lon_lat ',' lon_lat ',' lon_lat ',' lon_lat_list "))'"

lon_lat_list ::= lon_lat(',' lon_lat)*

search_in_call ::=
    'search.in(' variable ',' string_literal(',' string_literal)? ')'

/* Note that it is illegal to call search.ismatch or search.ismatchscoring
from inside a lambda expression. */
search_is_match_call ::=
    'search.ismatch'('scoring')?'(' search_is_match_parameters ')'

search_is_match_parameters ::=
    string_literal(',' string_literal(',' query_type ',' search_mode)?)?

query_type ::= "'full'" | "'simple'"

search_mode ::= "'any'" | "'all'"

Diagram składniowy

Aby wizualnie zapoznać się z gramatyką języka OData obsługiwaną przez usługę Azure AI Search, wypróbuj interaktywny diagram składni:

Diagram składni OData dla usługi Azure AI Search

Zobacz też