Suporte para OData (Azure AI Search)
A API do Azure AI Serviço de pesquisa utiliza o Protocolo OData (Open Data Protocol) para consultas de índice. O Azure AI Search suporta a versão 4 do OData.
Sintaxe OData nos cabeçalhos de pedido HTTP
O OData define alguns cabeçalhos de pedido HTTP que pode definir opcionalmente. Pode utilizar valores específicos de OData para o cabeçalho Aceitar, como application/json;odata.metadata=none
para controlar a quantidade de metadados incluídos na resposta. A predefinição é odata.metadata=minimal
. Por questões de brevidade, todos os exemplos neste documento assumem odata.metadata=none
.
Outro cabeçalho que pode definir é OData-MaxVersion
. A API do Serviço de Pesquisa de IA do Azure suporta OData V4, pelo que deve definir OData-MaxVersion
como "4.0". Isto indica à API para esperar o formato OData V4 no corpo do pedido e para enviar respostas no formato OData V4. No futuro, à medida que adicionamos suporte para versões mais recentes do protocolo OData, pode definir este cabeçalho para um valor diferente. A API Serviço de pesquisa ia do Azure não suporta versões de OData anteriores à V4.
Veja Sintaxe de Expressão OData para a Pesquisa de IA do Azure para obter detalhes sobre como utilizar o OData em filtros e expressões de ordenação. Veja Sintaxe de consulta simples na Pesquisa de IA do Azure para obter sintaxe alternativa.
Serviço de pesquisa API com sintaxe OData Alternativa
A API de Serviço de pesquisa suporta a sintaxe OData para pesquisa de entidades. Isto aplica-se a ambos os documentos num índice, bem como aos próprios índices (em que o nome do índice é a chave da entidade). Eis um resumo de todas as APIs que têm sintaxe OData alternativa:
Atualizar um Índice
PUT /indexes('[index name]')?api-version=2015-02-28
Obter um Índice
GET /indexes('[index name]')?api-version=2015-02-28
Obter Estatísticas de Índice
GET /indexes('[index name]')/stats?api-version=2015-02-28
Eliminar um Índice
DELETE /indexes('[index name]')?api-version=2015-02-28
Adicionar e Eliminar Dados num Índice
POST /indexes('[index name]')/docs/index?api-version=2015-02-28
Pesquisa
GET /indexes('[index name]')/docs?[query parameters]
Pesquisa
GET /indexes('[index name]')/docs('[key]')?[query parameters]
Count
GET /indexes('[index name]')/docs/$count?api-version=2015-02-28
Sugestões
GET /indexes('[index name]')/docs/suggest?[query parameters]