ドキュメントのリセット (プレビュー REST API)

  • [アーティクル]

: 2023-07-01-Preview に適用されます。 このバージョンはサポートされなくなりました。 新しいバージョンにすぐに アップグレードします。

大事な

2023-07-01-Preview (変更なし)。

2021-04-30-Preview (変更なし)。

2020-06-30-Preview (変更なし)。

2019-05-06-Preview では、リセット シナリオのサポートが追加されました。

ドキュメントのリセットは非同期 API です。 これにより、データ ソースからドキュメントを選択的に再処理できます。

API は、2 種類のドキュメント識別子を入力として受け入れます。 ドキュメント キー (検索インデックス内のドキュメントを一意に識別するキー) とデータソース ドキュメント識別子 (データ ソース内のドキュメントを一意に識別するキー) です。 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 キーは、検索サービスに対する要求を認証する一意のシステム生成文字列です。 リセット要求には、(クエリ キーではなく) 管理者キーに設定された api-key ヘッダーが含まれている必要があります。 詳細については、「キー認証 を使用して Azure AI Search に接続する」を参照してください。

要求本文

本文には、ドキュメント キーの一覧またはインデクサーがデータ ソースで検索するデータ ソース ドキュメント識別子の一覧が含まれている必要があります。

次の JSON は、定義の主要部分の概要を表しています。

{
    "documentKeys" : [
        "key1",
        "key2",
        "key3"
    ],
    "datasourceDocumentIds" : [
        "key1",
        "key2",
        "key3"
    ],
}

要求には次のプロパティが含まれており、"documentKeys" と "datasourceDocumentIds" の 1 つだけを指定する必要があることに注意してください。

財産 形容
documentKeys これは、インデクサーがデータ ソースから選択的に再処理するドキュメント キーのセットです。 既定では、このアクションを複数回呼び出すと、ドキュメント キー セットが追加されます。 この動作は、上書き URI パラメーターを使用して追加するのではなく、上書きするように変更できます (上記を参照)。 インデクサーでリセット ドキュメントの処理を停止する場合は、"documentKeys" を空のリスト "[]" に設定できます。 これにより、インデクサーは高い基準に基づいて通常のインデックス作成を再開します。 無効なドキュメント キーまたは存在しないドキュメント キーは無視されます。
datasourceDocumentIds これは、インデクサーがデータ ソースから選択的に再処理するデータ ソース ドキュメント識別子のセットです。 既定では、このアクションを複数回呼び出すと、データ ソース ドキュメント識別子セットが一緒に追加されます。 この動作は、上書き URI パラメーターを使用して追加するのではなく、上書きするように変更できます (上記を参照)。 インデクサーでリセット ドキュメントの処理を停止する場合は、"datasourceDocumentIds" を空のリスト "[]" に設定できます。 これにより、インデクサーは高い基準に基づいて通常のインデックス作成を再開します。 無効なデータ ソース ドキュメント識別子または存在しないデータ ソース ドキュメント識別子は無視されます。

応答

204 要求が成功した場合はコンテンツがありません。

関連項目