Indexers - Reset Docs

サービス:

Search Service

API バージョン:

2024-05-01-preview

インデクサーによって選択的に再取り込まれるよう、データソース内の特定のドキュメントをリセットします。

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2024-05-01-preview

省略可能なパラメーターを含む:

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?overwrite={overwrite}&api-version=2024-05-01-preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	検索サービスのエンドポイント URL。
indexerName	path	True	string	ドキュメントをリセットするインデクサーの名前。
api-version	query	True	string	クライアント API のバージョン。
overwrite	query		boolean	false の場合、キーまたは ID が既存のキーまたは ID に追加されます。 true の場合、このペイロード内のキーまたは ID のみがキューに入れ直され、再取り込みされます。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string uuid	デバッグに役立つ要求と共に送信された追跡 ID。

要求本文

名前	型	説明
datasourceDocumentIds	string[]	リセットするデータソースドキュメント識別子
documentKeys	string[]	リセットするドキュメント キー

応答

名前	型	説明
204 No Content
Other Status Codes	ErrorResponse	エラー応答。

例

SearchServiceResetDocs

要求のサンプル

HTTP

POST https://myservice.search.windows.net/indexers('myindexer')/search.resetdocs?overwrite=False&api-version=2024-05-01-preview

{
  "documentKeys": [
    "documentKey1",
    "documentKey2"
  ]
}

応答のサンプル

状態コード:

204

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。