共用方式為


資料平面 REST API 版本(Azure AI 搜尋)

本文列出 Azure AI 搜尋服務的目前和過去版本的搜尋 REST API。

版本設定的 API 檔

REST API 檔現在已建立版本。 當您開啟 API 參考頁面時,版本選取器會出現在目錄上方。 當您從「參考資料平面」>資料夾中選擇頁面時,選取器就會變成可用。

版本選擇器的螢幕截圖。

穩定版本

API 版本 規範 API 更新
2025-09-01 (最新) Swagger 規格 版本資訊
2024-07-01 Swagger 規格 版本資訊
2023-11-01 Swagger 規格 版本資訊
2020-06-30 Swagger 規格 版本資訊
2019-05-06 Swagger 規格 加入複雜型別。

預覽版本

所有新功能都會在預覽 API 中引進,然後再轉換至穩定版本。 預覽版 API 可在 Microsoft Azure Previews的補充使用規定下取得。

API 版本 規範 API 更新
2025-11-01-preview (最新) Swagger 規格 版本資訊
2025-08-01-preview Swagger 規格 版本資訊
2025-05-01-preview Swagger 規格 版本資訊
2025-03-01-preview Swagger 規格 版本資訊
2024-11-01-preview Swagger 規格 版本資訊
2024-09-01-preview Swagger 規格 版本資訊
2024-05-01-preview Swagger 規格 版本資訊
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 規格 版本資訊

版本資訊

2025-11-01-preview

此預覽版基於 並 2025-08-01-preview 包含 當前處於預覽狀態的所有功能

如果您使用 來 2025-08-01-preview 建立知識代理程式,該知識代理程式已重新命名為知識庫,則此預覽會引進重大變更。 如需移轉的說明,請參閱 將客服專員擷取程式碼移轉至最新版本

如需這些更新的詳細資訊,請參閱 Azure AI 搜尋服務的新功能

特徵 / 功能 更新 適用的 REST API
知識庫 (先前為知識代理程式) 知識代理程式已重新命名為知識庫,這會變更多個路由:

  • /agents 現在 /knowledgebases
  • /agents/agent-name 現在 /knowledgebases/knowledge-base-name
  • /agents/agent-name/retrieve 現在 /knowledgebases/knowledge-base-name/retrieve

知識庫現在僅依名稱參考知識來源,所有設定都會移至擷取要求。 outputConfiguration 會取代 outputMode 為 (字串列舉值),而 requestLimits 屬性 (maxRuntimeInSecondsmaxOutputSize) 現在是擷取要求參數。 語意排名器活動記錄會取代為代理程式推理記錄。

知識庫
知識來源 新型知識來源:

  • indexedOneLake
  • indexedSharePoint
  • remoteSharePoint
  • web

索引知識來源現在支援 status 作業和 ingestionParameters 群組身分識別、內嵌模型、聊天完成模型、內容擷取和擷取設定。 搜尋索引知識來源具有新的屬性 (searchFieldssemanticConfigurationName),並重新命名 sourceDataSelectsourceDataFields

知識來源
知識檢索 請求參數 (rerankerThresholdalwaysQuerySourceincludeReferences) 現在會透過 每個知識來源傳遞 knowledgeSourceParams。 支援具有 HTTP 206 狀態碼的部分回應,以及活動記錄中的選用錯誤輸出。 推理模式使用minimalintent物件(直接搜尋查詢)而不是 LLM 進行查詢規劃。 知識擷取
Azure 內容理解技能 將 Azure Content Understanding 包裝在 Foundry 工具中的新功能,可從文字、影像、PDF、Microsoft PowerPoint、Microsoft Word 等擷取結構化 Markdown。 對於索引知識來源,此技能可透過 中的ingestionParameters屬性取得contentExtractionMode 技能集 - 建立或更新
SharePoint 索引子 ACL 支援 擴充 ACL 支援,可將基本 SharePoint 權限流向索引文件,從而實現文件層級存取控制。 索引 - 建立或更新資料來源 - 建立或更新,以及 文件 - 搜尋貼文
ACL 的提高讀取權限 新功能可將提升的讀取權限指派給管理員,以調查文件存取控制中使用的 ACL 組態問題。 文件 - 搜尋帖子
文件層級敏感度標籤索引 與 Microsoft Purview 的新整合,可將文件敏感度標籤同步處理至索引,並在查詢時接受其標籤和保護,以進行資料控管。 索引 - 建立或更新資料來源 - 建立或更新,以及 文件 - 搜尋貼文
SharePoint 索引更新 新的 SharePoint 索引子功能,包括改進的驗證選項、累加式更新,以及文件權限的基本處理。 資料來源 - 建立或更新
評分函數彙總 組合和聚合多個評分函數的新功能,實現更複雜的相關性定制和加權信號組合。 索引 - 建立或更新
Facet 彙總 新的多面向聚合操作,包括最小值、最大值、平均值和基數,可在多面向搜索體驗中提供增強的分析。 索引 - 建立或更新

2025-09-01

此 API 版本是適用於 Azure AI 搜尋服務的最新穩定 REST API。 它以先前的穩定版本 (2024-07-01) 為基礎,並新增下表所列的 API 更新。

其他一些正式發行的功能,例如 邏輯應用程式整合語意評分設定檔支援,不會影響 API 合約,也不會反映在資料表中。 如需公告的完整清單,請參閱 Azure AI 搜尋服務的新功能

特徵 / 功能 更新 適用的 REST API
OneLake 索引子 自動從 Microsoft OneLake Lakehouse 擷取和編製索引。 創建或更新數據源
檔版面配置技能 根據文件結構對文字進行區塊化。 建立或更新技能集
Normalizer 屬性 支援不區分大小寫的篩選、分面和排序。 建立或更新索引
索引描述屬性 描述索引,這有助於 RAG 工作負載中的提示工程。 建立或更新索引
壓縮向量的重新評分選項 使用原始向量而不是壓縮向量重新評分向量搜尋結果。 適用於 HNSW 和詳盡的 KNN 向量演算法,使用二進位和純量壓縮。 建立或更新索引
截斷的維度 適用於 text-embedding-3-small 和 text-embedding-3-large 模型,在 Matryoshka 表示學習 (MRL) 量化上重新訓練。 建立或更新索引
偵錯參數和查詢子分數 混合式搜尋結果分數 解壓縮為其組成部分。 搜尋檔

2025-08-01-preview

此預覽版基於 並 2025-05-01-preview 包含 當前處於預覽狀態的所有功能

如果您使用 來 2025-05-01-preview 建立知識代理程式,此預覽會引進重大變更。 如需移轉的說明,請參閱 將客服專員擷取程式碼移轉至最新版本

如需這些更新的詳細資訊,請參閱 Azure AI 搜尋服務的新功能

特徵 / 功能 更新 適用的 REST API
知識代理 知識代理程式定義的架構變更,現在需要一或多個 knowledgeSourcestargetIndexes 而不是 和 棄用 defaultMaxDocsForReranker

新增多個屬性,以更好地控制查詢規劃和執行,包括 retrievalInstructions、 和 answerSynthesisattemptFastPath

知識代理程式 - 建立或更新
知識來源 用於建立和管理知識來源的新 REST API,支援 searchIndex (一或多個索引) 和 azureBlob 種類。 知識來源
向量查詢的嚴格後置篩選 strictPostFilter的新值vectorFilterMode,會在識別全域頂向k量結果之後套用篩選器。 文件 - 搜尋帖子
增加向量欄位的最大尺寸 每個向量欄位的最大值 dimensions 現在 4096為 。 此更新適用於所有支援向量且不會引進重大變更的穩定和預覽 REST API 版本。 索引 - 建立或更新
改善索引子執行階段追蹤資訊 取得服務統計資料現在 會傳回整個搜尋服務的累積索引子處理資訊。 取得狀態 - 索引子 會為個別索引子提供相同的資訊。 取得服務統計資料取得狀態 - 索引子

2025-05-01-preview

此預覽版基於 並 2025-03-01-preview 包含 當前處於預覽狀態的所有功能。 您只需對代碼進行最少的變更,即可 將 REST API 版本從2025-03-01-preview 升級到 2025-05-01-preview

此預覽版增加了對代理檢索、多模式索引、文檔級別許可權繼承的支援,以及與索引和查詢工作負載中大型語言模型的更深入集成。 有關詳細資訊,請參閱 Azure AI 搜索中的新增功能

特徵 / 功能 更新 適用的 REST API
代理檢索 使用對話語言模型添加查詢擴展,以實現智慧查詢規劃。 它還會生成一個複雜的回應,其中包括下游聊天應用程式的接地數據。 回應包括查詢計劃和基於源文檔的引用數據。 知識代理知識檢索
GenAI 指令技能 允許您指定提示和 LLM 以生成新的欄位內容。 建立或更新技能集
檔版面配置技能 現在支援圖像檢測和上下文保留以進行多模態索引。 建立或更新技能集
Azure 邏輯應用集成 擴展了在工作流中運行的基於索引器的索引支持的數據源類型。 創建或更新數據源
文檔級許可權繼承 支援每用戶許可權搜尋結果。 建立或更新索引(權限篩選器)

建立或更新資料來源(權限選項)

2025-03-01-preview

此預覽版基於 並 2024-11-01-preview 包含 當前處於預覽狀態的所有功能。 您只需對代碼進行最少的變更,即可 將 REST API 版本從2024-11-01-preview 升級到 2025-03-01-preview

此預覽版中只有少量數據平面 API 更新,但當您的代碼調用此預覽版 API 時,搜索服務上會提供更多功能。 有關詳細資訊,請參閱 Azure AI 搜索中的新增功能

更新 適用的 REST API
分面層次結構、聚合和篩選器,用於在分層、聚合和篩選的分面上生成分面導航結構。 搜索文件,請求中的新facet參數。
機上模型的語意排名器選擇加入 創建或更新索引,在語義配置部分中新建 flightingOptIn 布爾屬性。 如果您的搜索服務區域中提供了預發行版語義排名模型,則使用該模型而不是穩定版本進行二級排名。 此屬性適用於希望在非生產代碼上測試最新排名模型的開發人員。

2024-11-01-preview

此預覽版基於 並 2024-09-01-preview 包含 當前處於預覽狀態的所有功能。 您只需對代碼進行最少的變更,即可 將 REST API 版本從2024-09-01-preview 升級到 2024-11-01-preview

更新 適用的 REST API
用於精簡傳送至 L2 順位器之查詢的語意重新撰寫器 搜尋檔,要求中新的 QueryRewritesType 屬性。
檔版面配置技能 用來分析文件的結構。 建立或更新技能集,新的 DocumentIntelligenceLayoutSkill 技能。
連結 Azure AI 多服務資源的受控識別 建立或更新 Skillset、新的 AIServicesAccountIdentity 属性。
Markdown 剖析模式,用於為 Azure 記憶體中的 Markdown 檔案編制索引。 建立或更新索引器,新的 Markdown 剖析模式。
壓縮向量的 Rescoring 選項,用於重新記錄原始向量,而不是壓縮向量。 適用於 HNSW 和詳盡的 KNN 向量演算法,使用二進位和純量壓縮。 建立或更新索引,新的 rescoringOptions 屬性。 新的 enableRescoring 屬性對應至 2024-03-01-preview 中引進的 rerankWithOriginalVectors

2024-09-01-preview

此預覽版基於 並 2024-05-01-preview 包含 當前處於預覽狀態的所有功能。 您可以從 2024-05-01-preview 升級至 2024-09-01-preview,不需要變更程序代碼。 如需詳細資訊,請參閱 升級 REST API

更新 適用的 REST API
在 Matryoshka 表示法學習 (MRL) 量化上重新定型的文字內嵌-3-small 和 text-embedding-3-large 模型的截斷維度 建立或更新索引,新的 截斷Dimension 參數
解除封裝混合式搜尋結果的子分數或評分詳細數據,倒數排名融合 (RRF) 搜尋檔、新的 偵錯 參數和查詢回應中的子核心定義。
混合式搜尋查詢的向量部分目標篩選 Search DocumentsRawVectorQueryVectorizableTextQueryVectorizableImageUrlQueryVectorizableImageBinaryQuery中的 new filterOverride 参数。
文字分割技能中的標記區塊化,而不只是字元。 建立或更新 Skillset、新的 單元 參數和其他令牌相關屬性。

2024-07-01

此版本提供整合向量化(技能和向量化工具)、純量量化和二元量化的正式推出更新。 如需詳細資訊,請參閱 Azure AI 搜尋 的新功能。

更新 適用的 REST API
正式推出 - 向量數據類型 建立或更新索引
正式推出 - 搜尋索引中內建純量或二進位量化的向量量化屬性 建立或更新索引
正式推出 - 預存屬性向量欄位,以判斷是否儲存欄位的額外複本。 額外的複本是該欄位的可擷取內容。 如果您未儲存該欄位,則字段仍會用於查詢中,但無法在搜尋結果中傳回。 您可以設定此屬性來節省搜尋服務的空間,或搜尋索引中的向量配額。 建立或更新索引
正式推出 - VectorizableTextQuery 參數以進行相關性微調。 混合式查詢參數 (MaxTextSizeRecall) 仍處於預覽狀態。 搜尋檔
正式推出 - AzureOpenAIEmbedding 技能,可支援多個模型,而不只是在編製索引期間進行整合向量化的文字內嵌-ada-002。 將模型名稱和維度屬性設定為以特定模型為目標。 建立或更新技能集
正式推出 - Azure OpenAI 內嵌向量化工具,以在查詢期間進行整合向量化。 Vectorizer 屬性支援更多模型。 建立或更新索引
自 2024 年 3 月 29 日生效:GET 回應不再傳回連接字串或密鑰。 如需詳細資訊,請參閱 讀取連線資訊 客戶端程式代碼的重大變更。 所有版本

2024-05-01-preview

此預覽新增對 OneLake 索引編製、相關性微調的支援,以及在編製索引和查詢期間與更多內嵌模型進行更深入的整合。 它基於 並 2024-03-01-preview 包含 當前處於預覽狀態的所有功能

若要從 2024-03-01-preview2023-10-01-preview升級,請更新 AzureOpenAIEmbedding 技能或向量工具,以包含模型名稱和維度。 若要從 2023-07-01-preview 升級(已淘汰),或如需逐步指示,請參閱 升級 REST API

以下是此預覽版中的更新。 我們也建議 Azure AI 搜尋的新功能。

更新 適用的 REST API
OneLake 檔案和快捷方式的索引器數據源。 建立或更新數據源
Collection(Edm.Byte),這是一種二進位數據類型,用於內嵌支援它們的模型。 向量欄位定義支援此資料類型。 建立或更新索引
用於相關性微調的多個向量和混合式查詢參數。 設定臨界值以排除低評分結果。 加權向量查詢。 針對混合式查詢,請設定混合式查詢文字部分中要擷取的最大檔。 搜尋檔
在編製索引期間,適用於多模式整合向量化的新 Azure AI 視覺技能。 此技能會呼叫 Azure AI 視覺的多模式 API。 建立或更新技能集
適用於多模式查詢的新 Azure AI 視覺向量化工具。 向量化程式是在索引定義中指定,但在查詢執行期間使用。 建立或更新索引
已更新 AzureOpenAIEmbedding 技能,以支援多個模型,而不只是在編製索引期間進行整合向量化的文字內嵌-ada-002。 將模型名稱和維度屬性設定為以特定模型為目標。 建立或更新技能集
已更新 Azure OpenAI 內嵌向量化工具,以在查詢期間進行整合向量化。 Vectorizer 屬性支援更多模型。 建立或更新索引
自 2024 年 3 月 29 日生效:GET 回應不再傳回連接字串或密鑰。 如需詳細資訊,請參閱 讀取連線資訊 客戶端程式代碼的重大變更。 所有版本

2024-03-01-preview

此預覽版本是以 2023-10-01-preview 為基礎,新增可改善向量儲存的預覽 API。 如需詳細資訊,請參閱 Azure AI 搜尋 的新功能。

更新 適用的 REST API
如果您已內嵌支援向量字段的模型,或輸出較小向量的量化邏輯,則新的 縮小向量數據類型 建立或更新索引
新的 向量量化屬性 搜尋索引中內建向量壓縮。 建立或更新索引
向量欄位上 儲存屬性的新布爾值 判斷是否儲存了欄位的額外複本。 額外的複本是該欄位的可擷取內容。 如果您未儲存該欄位,則字段仍會用於查詢中,但無法在搜尋結果中傳回。 您可以設定此屬性來節省搜尋服務的空間,或搜尋索引中的向量配額。 建立或更新索引
自 2024 年 3 月 29 日生效:GET 回應不再傳回連接字串或密鑰。 如需詳細資訊,請參閱 讀取連線資訊 客戶端程式代碼的重大變更。 所有版本

2023-11-01

此版本提供正式運作的功能。 如需詳細資訊,請參閱 Azure AI 搜尋 的新功能。

更新 適用的 REST API
搜尋張貼要求中的語意排名。 搜尋檔
索引向量欄位的向量搜尋組態 建立或更新索引
搜尋張貼要求中的向量查詢。 搜尋檔
自 2024 年 3 月 29 日生效:GET 回應不再傳回連接字串或密鑰。 如需詳細資訊,請參閱 讀取連線資訊 客戶端程式代碼的重大變更。 所有版本

2023-10-01-preview

此版本包含先前預覽中引進的所有功能,以及向量搜尋 API 的新增和修改。 向量搜尋 API 的更新是 2023-07-01-Preview 的重大變更。 請參閱 新增向量字段建立向量查詢 以取得移轉說明。

如果您計劃使用新的預篩選功能,則必須使用在 2023-10-01.

建立或更新索引

  • vectorSearch 具有 algorithmsprofilesvectorizers的定義:

    • algorithms 繼續支援 hnsw,現在也支援 eknn,參考階層式導航小世界(HNSW)和詳盡的K近鄰(eKNN)。 在演算法區段中,您可以定義 HNSW 和 eKNN 參數的多個具名組合。 這會取代 2023-07-01-Preview algorithmConfigurations 屬性內的 vectorSearch

    • profiles 是指定演算法組態的新定義。 例如,假設您有名為 HNSW-1、HSNW-2、eKNN-1 的演算法組態。 配置檔可能會指定 HNSW-1。

    • vectorizers 是在索引中定義,但在查詢時間用來內嵌文字查詢字串。 向量化工具會參考內嵌模型。 搜尋服務會呼叫內嵌模型,以向量化文字查詢字串,然後將結果傳遞給向量查詢的搜尋引擎。

  • 在向量欄位上,vectorSearchProfile 會取代 vectorSearchConfigurationvectorSearchProfile 屬性會指定要在欄位上使用的向量搜尋配置檔。

  • 在此 API 版本之前建立的索引上,當您的要求中呼叫 2023-10-01-Preview API 時,您必須變更欄位以指定 vectorSearchProfile,只要設定檔指定先前在 vectorSearchConfiguration中指定的完全相同演算法即可。 例如,如果現有的欄位定義指定 "vectorSearchConfiguration": "myHnsw",則必須將它取代為 "vectorSearchProfile": "your profile name",而且必須定義設定檔以參考相同的 "algorithm": "myHnsw"

搜尋檔

  • vectorQueries 取代 2023-07-01-Preview 中的 vectors
  • vectorQueries.vectors 會取代 2023-07-01-Preview 中的 vectors.values
  • 向量查詢現在是多型結構。 必須指定 kind,以表示所要求的向量查詢類型。 "kind": "vector" 表示查詢是向量,因此呼叫端應該已經將搜尋查詢字元串向量向量內嵌。
  • "exhaustive": "true" 是新的屬性,指定是否要對向量索引內的所有向量執行詳盡的(暴力密碼破解)K 近鄰搜尋。
  • vectorFilterMode 是一個新參數,用於在查詢中指定 prefiltering(對於 after.com 2023-10-01創建的索引的預設值)或 postfiltering(對先前的索引的預設值)。

自 2024 年 3 月 29 日生效:GET 回應不再傳回連接字串或密鑰。 如需詳細資訊,請參閱 讀取連線資訊 客戶端程式代碼的重大變更。

2023-07-01-preview

重要

請勿使用此 API 版本。 已於 2024 年 4 月 15 日宣佈淘汰此預覽版本,並在 2024 年 7 月 8 日之後不再支援。 如需移轉的說明,請參閱在 Azure AI 搜尋服務中 升級 REST API

此版本引進向量支援,並使用與較新的 API 版本不相容的向量組態。

  • 已在包含單精度浮點數陣列的欄位上新增 Collection(Edm.Single) 數據類型。 這是向量的數據型別,用來儲存每個檔欄位產生的內嵌。 搜尋索引也會指定向量組態屬性。
  • 已更新索引編製工作負載以接受向量數據。
  • 已新增向量搜尋的查詢參數。 請參閱搜尋文件以取得這些參數。
  • 取得服務統計資料:傳回服務的向量索引配額和使用量。
  • 取得索引統計資料:傳回搜尋索引的向量索引配額和使用量。
  • 自 2024 年 3 月 29 日生效:GET 回應不再傳回連接字串或密鑰。 如需詳細資訊,請參閱 讀取連線資訊 客戶端程式代碼的重大變更。

2021-04-30-preview

此預覽版本包含 2020-06-30-Preview 中引進的所有功能,以及下列 API 的新增功能:

  • 索引別名會新增次要名稱,用來在查詢和索引請求中參考索引。 別名作業包括建立、更新、刪除、取得和清單。
  • 輸出連線的受控識別。 建立或更新資料來源中連接字串的新值支援使用 Microsoft Entra ID 驗證和角色的連線,而不是硬式編碼的資料庫認證或金鑰。
  • 密鑰保存庫連線也支援受控識別支援,以 客戶管理的加密來補充預設加密的搜尋解決方案
  • 文字翻譯認知技能的更多語言。
  • 更多查詢搜尋文件中語意搜尋和拼字檢查器的語言。
  • captions 參數,可選擇性地從「搜尋文件」中的語意搜尋要求標題。
  • 語意組態 是在建立或更新索引中指定。 語意組態會決定哪些字段應該用於語意排名、標題、醒目提示和答案。
  • 搜尋文件中語意查詢所需的 semanticConfiguration 參數。
  • 自 2024 年 3 月 29 日生效:GET 回應不再傳回連接字串或密鑰。 如需詳細資訊,請參閱 讀取連線資訊 客戶端程式代碼的重大變更。

2020-06-30

此版本提供正式推出的功能,包括:

  • 數據平面作業的 Azure 角色型訪問控制
  • 相關性評分 (BM25)
  • 知識存放區
  • Azure Data Lake Storage 的索引器數據源 (ADLS) Gen2
  • 自定義實體查閱技能
  • 透過 Microsoft Entra 識別碼,在系統或使用者受控識別下執行的索引器
  • 自 2024 年 3 月 29 日生效:GET 回應不再傳回連接字串或密鑰。 如需詳細資訊,請參閱 讀取連線資訊 客戶端程式代碼的重大變更。

2020-06-30-preview

此預覽版本包含 2019-05-06-Preview 中引進的所有功能,以及下列新增功能:

  • 語意搜尋,這是在標準層服務上執行的進階功能,其會叫用語意排名。
  • Power Query 連接器的索引器數據源
  • MySQL 的索引器數據源
  • Cosmos DB Gremlin API 的索引器數據源
  • SharePoint Online 的索引器數據源
  • 文字正規化的 Normalizer 屬性、不區分大小寫的篩選、Facet 和排序
  • 重設索引器索引編製的檔,以依標識元特別重新整理特定檔
  • 實體連結認知技能 (v3)
  • 實體辨識認知技能 (v3)
  • 情感分析認知技能 (v3)
  • 自 2024 年 3 月 29 日生效:GET 回應不再傳回連接字串或密鑰。 如需詳細資訊,請參閱 讀取連線資訊 客戶端程式代碼的重大變更。

2019-05-06-preview

  • Cosmos DB MongoDB API 的索引器數據源支援
  • Blob 記憶體中虛刪除的索引器數據源
  • featuresMode 參數,會傳回相關性分數的詳細資訊
  • Azure Machine Learning (AML) 認知技能
  • 個人識別偵測認知技能
  • 快取擴充檔以保留及重複使用影像處理(以及其他 AI 擴充)
  • 自 2024 年 3 月 29 日生效:GET 回應不再傳回連接字串或密鑰。 如需詳細資訊,請參閱 讀取連線資訊 客戶端程式代碼的重大變更。

另請參閱