你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Azure AI 搜索) (REST API 版本

项目
05/01/2024

本文列出了适用于 Azure AI 搜索的搜索 REST API 的当前版本和过去版本。

版本控制 API 文档

REST API 文档现已进行版本控制。打开 API 参考页时，目录上方会显示版本选择器。确保 API 引用来自“ 引用>数据平面 ”文件夹。

版本选择器的屏幕截图。

稳定版本

API 版本	规格	API 更新
`2023-11-01` (最新)	Swagger 规范	发行说明
`2020-06-30`	Swagger 规范	发行说明
`2019-05-06`	Swagger 规范	添加复杂类型。
`2017-11-11`	Swagger 规范	添加技能集和 AI 扩充。
`2016-09-01`	Swagger 规范	添加了索引器。
`2015-02-28`	在 2020 年 10 月 10 日之后不再受支持	第一个正式发布版本。

预览版

发布预览版的目的是为了测试新功能、收集反馈以及发现和修复问题。预览版 API 在 Microsoft Azure 预览版补充使用条款下提供。

API 版本	规格	API 更新
`2024-03-01-Preview` (最新)	Swagger 规范	发行说明
`2023-10-01-Preview`	Swagger 规范	发行说明
`2023-07-01-Preview`（已弃用）	Swagger 规范	发行说明
`2021-04-30-Preview`	Swagger 规范	发行说明
`2020-06-30-Preview`	Swagger 规范	发行说明
`2019-05-06-Preview`	Swagger 规范	发行说明
`2017-11-11-Preview`	Swagger 规范	与稳定版本关联的预览版本。
`2016-09-01-Preview`	Swagger 规范	与稳定版本关联的预览版本。
`2015-02-28-Preview` (已停用)	在 2020 年 10 月 10 日之后不再受支持	与稳定版本关联的预览版本。
`2014-10-20-Preview` (已停用)	在 2020 年 10 月 10 日之后不再受支持	第二个公共预览版。
`2014-07-31-Preview` (已停用)	在 2020 年 10 月 10 日之后不再受支持	第一个公共预览版。

发行说明

2024-03-01-Preview

此预览版 2023-10-01-preview 通过添加以下预览 API 构建，可帮助你节省空间：

如果嵌入了支持矢量字段的模型或输出较小向量的量化逻辑，则为矢量字段提供了新的窄数据类型。
搜索索引中内置矢量压缩的新矢量量化属性。
矢量字段上的新布尔存储属性，用于确定是否存储字段的额外副本。额外副本是该字段的可检索内容。如果不存储该字段，该字段仍用于查询，但无法在搜索结果中返回。可以设置此属性，以节省搜索服务的空间或搜索索引中的矢量配额。
自 2024 年 3 月 29 日起生效：GET 响应不再返回连接字符串或密钥。有关详细信息，请参阅读取连接信息的客户端代码的中断性变更。

2023-11-01

此版本提供正式版功能，包括：

搜索 Post 请求中的语义排名。
Create或更新索引请求中的矢量搜索索引，以及搜索 Post 请求中的矢量查询。
自 2024 年 3 月 29 日起生效：GET 响应不再返回连接字符串或密钥。有关详细信息，请参阅读取连接信息的客户端代码的中断性变更。

2023-10-01-Preview

此版本包括先前预览版中引入的所有功能，以及向量搜索 API 的添加和修改。汇报矢量搜索 API 是 2023-07-01-Preview 中的一项重大更改。有关迁移帮助，请参阅添加矢量字段和Create向量查询。

如果计划使用新的预筛选功能，则必须使用在 2023-10-01 之后创建的索引。

Create或更新索引：

vectorSearch具有、 profiles和 vectorizers的定义algorithms：
- algorithms 继续支持 hnsw ，现在也支持 eknn，参考分层导航小世界 (HNSW) 和详尽的 K 最近邻 (eKNN) 。在算法部分中，可以定义 HNSW 和 eKNN 参数的多个命名组合。这将替换 algorithmConfigurationsvectorSearch 2023-07-01-Preview 中的属性。
- profiles 是指定算法配置的新定义。例如，假设你有名为 HNSW-1、HSNW-2、eKNN-1 的算法配置。配置文件可以指定 HNSW-1。
- vectorizers 在索引中定义，但在查询时用于嵌入文本查询字符串。矢量化器引用嵌入模型。搜索服务调用嵌入模型以向量化文本查询字符串，然后将结果传递给搜索引擎进行矢量查询。
在向量字段上， vectorSearchProfile 替换 vectorSearchConfiguration。属性 vectorSearchProfile 指定要在字段上使用哪个矢量搜索配置文件。
在此 API 版本之前创建的索引上，在调用 2023-10-01-Preview API 时，必须在请求中更改字段以指定， vectorSearchProfile 前提是配置文件指定之前在中指定的 vectorSearchConfiguration算法。例如，如果现有字段定义指定 "vectorSearchConfiguration": "myHnsw"，则必须将其 "vectorSearchProfile": "your profile name"替换为，并且必须定义配置文件以引用相同的 "algorithm": "myHnsw"。

搜索文档：

vectorQueriesvectors替换 2023-07-01-Preview
vectorQueries.vectorsvectors.values在 2023-07-01-Preview 中替换。
矢量查询现在是多态结构。 kind 必须指定以表示所请求的向量查询的类型。 "kind": "vector" 表示查询是一个向量，因此调用方应已将搜索查询字符串矢量化为矢量嵌入。
"exhaustive": "true" 是一个新属性，指定是否对向量索引中的所有向量执行详尽 (暴力) k 个最接近的邻居搜索。
vectorFilterMode 是一个新参数，用于指定在 2023-10-01) 之后创建的索引的预筛选 (默认值，或在查询中) 以前的索引上 (默认筛选后筛选。

自 2024 年 3 月 29 日起：GET 响应不再返回连接字符串或密钥。有关详细信息，请参阅读取连接信息的客户端代码的中断性变更。

2023-07-01-Preview

重要

已于 2024 年 4 月 15 日宣布弃用此预览版本，将于 2024 年 7 月 8 日停用。有关迁移的帮助，请参阅升级 Azure AI 搜索中的 REST API。

此版本具有以前预览版的功能，以及矢量搜索支持：

在搜索索引中，为包含单精度浮点数数组的字段分配 Collection(Edm.Single) 数据类型。这是新矢量搜索功能的数据类型，用于存储每个文档字段生成的一个嵌入。此外，在搜索索引中指定矢量配置属性。有关这些 API，请参阅Create或更新索引。
索引工作负载将更新为接受矢量数据。请参阅添加、更新或删除文档。
矢量搜索的查询参数。有关这些参数，请参阅搜索文档。
获取服务统计信息：返回服务的矢量索引配额和使用情况。
获取索引统计信息：返回搜索索引的矢量索引配额和使用情况。
自 2024 年 3 月 29 日起：GET 响应不再返回连接字符串或密钥。有关详细信息，请参阅读取连接信息的客户端代码的中断性变更。

2021-04-30-Preview

此预览版包括 2020-06-30-Preview 中引入的所有功能，以及以下 API 的新增功能：

索引别名添加用于引用查询和索引请求中的索引的辅助名称。别名操作包括创建、更新、删除、获取和列出。
出站连接的托管标识。 Create或更新数据源中连接字符串的新值支持使用Microsoft Entra ID身份验证和角色而不是硬编码的数据库凭据或密钥进行连接。
对于使用客户托管加密补充默认加密的搜索解决方案，密钥保管库连接也支持托管标识支持。
文本翻译认知技能的更多语言。
搜索文档中语义搜索和拼写检查的更多查询语言 (预览) 。
一个 captions 参数，用于选择从搜索文档 (预览) 中的语义搜索请求字幕。
语义配置在 Create 或更新索引中指定。语义配置确定哪些字段应用于语义排名、字幕、突出显示和答案。
搜索文档 (预览版) 中语义查询所需的 semanticConfiguration 参数。
自 2024 年 3 月 29 日起：GET 响应不再返回连接字符串或密钥。有关详细信息，请参阅读取连接信息的客户端代码的中断性变更。

2020-06-30