支援 OData (Azure AI 搜尋)

Azure AI 搜尋服務 API 會使用開放資料通訊協定 (OData) 進行索引查詢。 Azure AI 搜尋服務支援 OData 第 4 版。

HTTP 要求標頭中的 OData 語法

OData 會定義幾個 HTTP 要求標頭,供您選擇性地設定。 您可以將 OData 特定值用於 Accept 標頭 (例如 application/json;odata.metadata=none),以控制回應中包含的中繼資料數量。 預設值為 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]  

Count

GET /indexes('[index name]')/docs/$count?api-version=2015-02-28  

建議

GET /indexes('[index name]')/docs/suggest?[query parameters]  

另請參閱