你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
支持 OData (Azure AI 搜索)
Azure AI 搜索服务 API 使用开放数据协议 (OData) 进行索引查询。 Azure AI 搜索支持 OData 版本 4。
HTTP 请求标头中的 OData 语法
OData 定义了几个 HTTP 请求标头,你可以选择性地设置这些标头。 你可以在 Accept 标头(例如 application/json;odata.metadata=none
)中使用 OData 特定的值,以控制响应中包含的元数据数量。 默认为 odata.metadata=minimal
。 为简洁起见,本文档中的所有示例都假设 odata.metadata=none
。
可以设置的另一个标头是 OData-MaxVersion
。 Azure AI 搜索服务 API 支持 OData V4,因此应设置为 OData-MaxVersion
“4.0”。 这可以告知 API 需要在请求正文中采用 OData V4 格式,并以 OData V4 格式发送响应。 将来,随着我们添加对更新版 OData 协议的支持,你可以将此标头设置为其他值。 Azure AI 搜索服务 API 不支持早于 V4 的 OData 版本。
有关在筛选器和排序表达式中使用 OData 的详细信息,请参阅 Azure AI 搜索 的 OData 表达式语法。 有关替代语法,请参阅 Azure AI 搜索中的简单查询 语法。
使用替代 OData 语法的搜索服务 API
搜索服务 API 支持使用 OData 语法来查找实体。 这适用于索引中的文档,以及索引本身(其中的索引名称就是实体键)。 下面是使用替代 OData 语法的所有 API 的摘要:
更新索引
PUT /indexes('[index name]')?api-version=2015-02-28
获取索引
GET /indexes('[index name]')?api-version=2015-02-28
获取索引统计信息
GET /indexes('[index name]')/stats?api-version=2015-02-28
删除索引
DELETE /indexes('[index name]')?api-version=2015-02-28
在索引中添加和删除数据
POST /indexes('[index name]')/docs/index?api-version=2015-02-28
搜索
GET /indexes('[index name]')/docs?[query parameters]
查找
GET /indexes('[index name]')/docs('[key]')?[query parameters]
计数
GET /indexes('[index name]')/docs/$count?api-version=2015-02-28
建议
GET /indexes('[index name]')/docs/suggest?[query parameters]