Compatibilidad con OData (Azure AI Search)

Azure AI servicio Search API usa Open Data Protocol (OData) para las consultas de índice. Azure AI Search admite la versión 4 de OData.

Sintaxis de OData en encabezados de solicitud HTTP

OData define algunos encabezados de solicitud HTTP que se pueden configurar opcionalmente. Puede utilizar los valores específicos de OData para el encabezado Accept como application/json;odata.metadata=none para controlar la cantidad de metadatos que se incluye en la respuesta. El valor predeterminado es odata.metadata=minimal. Para mayor brevedad, todos los ejemplos de este documento suponen que odata.metadata=none.

Otro encabezado que puede establecer es OData-MaxVersion. Azure AI Search Service API admite OData V4, por lo que debe establecer en OData-MaxVersion "4.0". Esto indica a la API que espere el formato OData V4 en el cuerpo de solicitud y envíe respuestas en el formato OData V4. En el futuro, cuando agreguemos compatibilidad para las versiones más recientes del protocolo de OData, podrá establecer este encabezado en un valor diferente. Azure AI servicio Search API no admite versiones de OData anteriores a V4.

Consulte Sintaxis de expresiones de OData para Azure AI Search para más información sobre el uso de OData en filtros y expresiones de ordenación. Consulte Sintaxis de consulta simple en Azure AI Search para obtener una sintaxis alternativa.

API del servicio Búsqueda con la sintaxis de OData alternativa

La API del servicio Search admite una sintaxis OData para la búsqueda de entidad. Esto se aplica tanto a ambos documentos en un índice, como a los índices en sí mismos (donde el nombre del índice es la clave de entidad). Este es un resumen de todas las API que tienen sintaxis alternativa de OData:

Actualización de un índice

PUT /indexes('[index name]')?api-version=2015-02-28  

Obtención de un índice

GET /indexes('[index name]')?api-version=2015-02-28  

Obtención de estadísticas de índice

GET /indexes('[index name]')/stats?api-version=2015-02-28  

Eliminación de un índice

DELETE /indexes('[index name]')?api-version=2015-02-28  

Incorporación y eliminación de datos dentro de un índice

POST /indexes('[index name]')/docs/index?api-version=2015-02-28  

Búsqueda

GET /indexes('[index name]')/docs?[query parameters]  

Lookup

GET /indexes('[index name]')/docs('[key]')?[query parameters]  

Recuento

GET /indexes('[index name]')/docs/$count?api-version=2015-02-28  

Sugerencias

GET /indexes('[index name]')/docs/suggest?[query parameters]  

Consulte también