重設檔案 （預覽 REST API）
適用於：2023-07-01-Preview。 不再支援此版本。 立即 升級至較新版本。
重要
2023-07-01-Preview （無變更）。
2021-04-30-Preview （無變更）。
2020-06-30-Preview （無變更）。
2019-05-06-Preview 新增 重設案例的支援。
重設檔是異步 API。 它可讓您選擇性地重新處理數據源中的檔。
API 接受兩種類型的文件識別碼做為輸入。 它們是檔索引鍵（可唯一識別搜尋索引中的檔的索引鍵）和數據源檔識別碼（可唯一識別數據源中的檔的索引鍵）。 叫用 API 會新增要重設為索引器元數據的檔索引鍵或數據源檔識別碼。 在索引器下一次排程或隨選執行時，索引器只會處理重設檔。
- 針對已啟用技能集和累加擴充的索引器，API 會清除快取，並只針對指定的檔重新執行完整的技能集。
- 對於沒有技能集的索引器，API 會從數據源讀取源檔，並將內容更新/插入索引中。
如果您使用檔索引鍵來重設檔，而且索引器會在索引器字段對應中參考您的檔索引鍵，索引器會使用字段對應來找出基礎數據源中的適當欄位。
API 適用於所有索引器（具有或不含技能集）。 您可以使用 HTTP POST 要求來叫用它。 如果呼叫成功，您會收到 204 NoContent 回應。 指定要在要求 URI 上更新的索引器名稱：
POST https://[service name].search.windows.net/indexers/[indexer name]/resetdocs?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
URI 參數
| 參數 | 描述 |
|---|---|
| 服務名稱 | 必填。 將此設定為搜尋服務的唯一用戶定義名稱。 |
| 索引器名稱 | 必填。 要求 URI 指定要更新的索引器名稱。 |
| api-version | 必填。 如需更多版本，請參閱 API 版本。 |
| 改寫 | 自選。 此參數會決定連續重設文件作業是合併還是覆寫。 默認值為 false。 若為 false，則會將呼叫的文件金鑰或數據源檔標識元承載新增至已排入佇列以供重新處理的索引鍵清單。 如果為 true，則呼叫的檔索引鍵或數據源檔標識碼承載會覆寫現有的清單，包括如果您將索引鍵設定為 Null，請清除重設檔清單。 |
要求標頭
下表描述必要和選擇性的要求標頭。
| 領域 | 描述 |
|---|---|
| Content-Type | 必填。 將此設定為 application/json |
| api-key | 如果您使用 Azure 角色，而且要求會提供持有人令牌，則為選擇性，否則需要密鑰。 api-key 是唯一的系統產生字串，可驗證對搜尋服務的要求。 重設要求必須包含設定為系統管理密鑰的 api-key 標頭（而不是查詢密鑰）。 如需詳細資訊，請參閱使用密鑰驗證 連線到 Azure AI 搜尋服務 |
要求本文
本文應包含檔案索引鍵清單或索引器在數據源中尋找的數據源檔標識子清單。
下列 JSON 是定義主要部分的高階表示法。
{
"documentKeys" : [
"key1",
"key2",
"key3"
],
"datasourceDocumentIds" : [
"key1",
"key2",
"key3"
],
}
要求包含下列屬性，並請注意，應該提供一個和只有一個 “documentKeys” 和 “datasourceDocumentIds” ：
| 財產 | 描述 |
|---|---|
| documentKeys | 這是索引器選擇性地從其數據源重新處理的檔索引鍵集合。 根據預設，呼叫此動作多次會將檔索引鍵集附加在一起。 此行為可以變更為覆寫，而不是透過覆寫 URI 參數附加 （請參閱上圖）。 如果您想要索引器停止嘗試處理重設檔，您可以將 “documentKeys” 設定為空白清單 “[]”。 這會導致索引器根據高水位標記繼續定期編製索引。 忽略不存在的檔索引鍵或檔索引鍵無效。 |
| datasourceDocumentIds | 這是索引器選擇性地從其數據源重新處理的數據源檔標識碼集合。 根據預設，呼叫此動作多次會將數據源文檔標識元集合附加在一起。 此行為可以變更為覆寫，而不是透過覆寫 URI 參數附加 （請參閱上圖）。 如果您想要索引器停止嘗試處理重設檔，您可以將 “datasourceDocumentIds” 設定為空白清單 “[]”。 這會導致索引器根據高水位標記繼續定期編製索引。 忽略不存在的數據源檔識別碼或數據源檔標識碼無效。 |
回應
204 成功要求沒有內容。