(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`	10-10-2020 之後不支援	第一個正式發行。

預覽版本

預覽版本已發行以測試新功能、收集意見反應，以及探索並修正問題。預覽 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` (已淘汰的)	10-10-2020 之後不支援	與穩定版本相關聯的預覽版本。
`2014-10-20-Preview` (已淘汰的)	10-10-2020 之後不支援	第二個公開預覽。
`2014-07-31-Preview` (已淘汰的)	10-10-2020 之後不支援	第一個公開預覽。

版本資訊

2024-03-01-Preview

此預覽版本會藉由新增下列可協助您節省空間的預覽 API 來建 2023-10-01-preview 置：

如果您已內嵌支援向量欄位的模型，或輸出較小向量的量化邏輯，則為向量字段新增窄數據類型。
搜尋索引中內建向量壓縮的新向量量化屬性。
量欄位的新布爾值預存屬性，可判斷是否儲存欄位的額外複本。額外的複本是該欄位的可擷取內容。如果您未儲存，欄位仍會用於查詢中，但無法在搜尋結果中傳回。您可以設定此屬性，以節省搜尋服務的空間或搜尋索引中的向量配額。
自 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，參考階層式導覽 Small World (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 驗證和角色，而不是硬式編碼的資料庫認證或密鑰。
密鑰保存庫連線也支援受控識別支援，以使用客戶管理的加密來補充預設加密的搜尋解決方案。
文字翻譯認知技能的更多語言。
搜尋 Documents (preview) 中更多適用於語意搜尋和拼字檢查的 queryLanguages。
在搜尋 Documents (preview) 中，選擇性地從語意搜尋要求標題的 captions 參數。
語意設定是在 Create 或更新索引中指定。語意設定會決定哪些欄位應該用於語意排名、標題、醒目提示和答案。
搜尋 Documents (preview) 中語意查詢所需的 semanticConfiguration 參數。
生效於 2024 年 3 月 29 日：GET 回應不再傳回連接字串或密鑰。如需詳細資訊，請參閱客戶端程式代碼的重大變更，以讀取連線資訊。

2020-06-30