查閱檔 (Azure AI 搜尋 REST API)
查閱檔作業會從 Azure AI 搜尋中擷取檔。 當使用者按一下特定的搜尋結果，而您想要查閱有關該文件的特定詳細資料時，這非常實用。 您一次只能取得一份文件。 使用 搜尋檔 在單一要求中取得多個檔。
GET https://[service name].search.windows.net/indexes/[index name]/docs/key?[query parameters]
Content-Type: application/json
api-key: [admin or query key]
或者，您可以使用傳統的 OData 語法來查閱索引鍵：
GET /indexes/[index name]/docs('[key]')?[query parameters]
URI 參數
| 參數 | Description |
|---|---|
| 服務名稱 | 必要。 將此設定為搜尋服務的唯一使用者定義名稱。 |
| 索引名稱 | 必要。 要求 URI 會指定要查詢的索引名稱。 查詢參數是在 GET 要求的查詢字串和 POST 要求的要求本文中指定。 |
| 索引鍵 | 必要。 值，可唯一 Edm.String 識別索引中的每個檔。 索引鍵有時稱為檔識別碼。 索引鍵的值會區分大小寫。 例如，索引鍵 「abc」 的檔與索引鍵 「ABC」 的檔不同。 |
| 查詢參數 (query parameters) | 包含 (選擇性) 和 api-version=2020-06-30 (必要) 的多部分建構 $select 。 在此作業中，api-version 指定為查詢參數。 $select=[string] 是要擷取的逗號分隔欄位清單。 只有標示為可擷取的欄位可以包含在這個子句中。 若未指定或設定 *，即會在預測中包含結構描述中標記為可抓取的所有欄位。 |
要求標頭
下表說明必要及選用的要求標頭。
| 欄位 | Description |
|---|---|
| Content-Type | 必要。 請設為 application/json |
| api-key | 如果您使用 Azure 角色 ，而且要求會提供持有人權杖，則為選擇性，否則需要金鑰。 API 金鑰是唯一的系統產生字串，可驗證對搜尋服務的要求。 取得物件定義的要求必須包含設定為系統管理員金鑰的 api 金鑰欄位， (而不是查詢金鑰) 。 如需詳細資訊 ，請參閱使用金鑰驗證連線到 Azure AI 搜尋 服務。 |
要求本文
無。
回應
狀態碼：傳回 「200 OK」 以取得成功的回應。
{
field_name: field_value (fields matching the default or specified projection)
}
範例
查詢具有索引鍵 '2' 的文件：
GET /indexes/hotels/docs/2?api-version=2020-06-30
使用 OData 語法，查閱索引鍵為 '3' 的文件：
GET /indexes/hotels/docs('3')?api-version=2020-06-30