Documents - Index

リファレンス

サービス:: Search Service

API バージョン:: 2023-10-01-Preview

ドキュメント書き込みアクションのバッチをインデックスに送信します。

POST {endpoint}/indexes('{indexName}')/docs/search.index?api-version=2023-10-01-Preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	検索サービスのエンドポイント URL。
indexName	path	True	string	インデックスの名前です。
api-version	query	True	string	クライアント API のバージョン。

要求ヘッダー

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

要求本文

名前	必須	型	説明
value	True	IndexAction[]	バッチ内のアクション。

応答

名前	型	説明
200 OK	IndexDocumentsResult	バッチ内のすべてのアクションの操作の状態を含む応答。
Other Status Codes	IndexDocumentsResult	バッチ内のすべてのアクションの操作の状態を含む応答。
Other Status Codes	SearchError	エラー応答。

例

SearchIndexIndexDocuments

要求のサンプル

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.index?api-version=2023-10-01-Preview

{
  "value": [
    {
      "@search.action": "upload",
      "docId": "1",
      "title": "Fancy Stay",
      "description": "Best hotel in town"
    },
    {
      "@search.action": "merge",
      "docId": "2",
      "title": "Roach Motel"
    },
    {
      "@search.action": "mergeOrUpload",
      "docId": "3",
      "title": "Econo Motel"
    },
    {
      "@search.action": "delete",
      "docId": "4"
    }
  ]
}

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "key": "1",
      "status": true,
      "errorMessage": null,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "3",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "4",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    }
  ]
}

状態コード:: 207

{
  "value": [
    {
      "key": "1",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "2",
      "status": false,
      "errorMessage": "Document not found.",
      "statusCode": 404
    },
    {
      "key": "3",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "4",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    }
  ]
}

定義

名前	説明
IndexAction	ドキュメントに対して動作するインデックスアクションを表します。
IndexActionType	インデックス作成バッチ内のドキュメントに対して実行する操作。
IndexBatch	インデックスに送信するドキュメント書き込みアクションのバッチが含まれます。
IndexDocumentsResult	インデックス作成要求内のすべてのドキュメントの操作の状態を含む応答。
IndexingResult	1 つのドキュメントのインデックス作成操作の状態。
SearchError	API のエラー条件について説明します。

IndexAction

ドキュメントに対して動作するインデックスアクションを表します。

名前	型	説明
@search.action	IndexActionType	インデックス作成バッチ内のドキュメントに対して実行する操作。

IndexActionType

インデックス作成バッチ内のドキュメントに対して実行する操作。

名前	型	説明
delete	string	インデックスから指定したドキュメントを削除します。キーフィールド以外の削除操作で指定したフィールドは無視されます。ドキュメントから個々のフィールドを削除する場合は、代わりにマージを使用し、フィールドを明示的に null に設定します。
merge	string	指定したフィールド値を既存のドキュメントとマージします。ドキュメントが存在しない場合、差し込み印刷は失敗します。マージで指定したすべてのフィールドは、ドキュメント内の既存のフィールドを置き換えます。これは、プリミティブ型と複合型のコレクションにも適用されます。
mergeOrUpload	string	指定したキーを持つドキュメントがインデックスに既に存在する場合は、マージのように動作します。ドキュメントが存在しない場合は、新しいドキュメントでのアップロードのように動作します。
upload	string	ドキュメントが新しい場合はインデックスに挿入し、存在する場合は更新します。更新ケースでは、すべてのフィールドが置き換えられます。

IndexBatch

インデックスに送信するドキュメント書き込みアクションのバッチが含まれます。

名前	型	説明
value	IndexAction[]	バッチ内のアクション。

IndexDocumentsResult

インデックス作成要求内のすべてのドキュメントの操作の状態を含む応答。

名前	型	説明
value	IndexingResult[]	インデックス作成要求の各ドキュメントの状態情報の一覧。

IndexingResult

1 つのドキュメントのインデックス作成操作の状態。

名前	型	説明
errorMessage	string	キーで識別されたドキュメントのインデックス作成操作が失敗した理由を説明するエラーメッセージ。インデックス作成に成功した場合は null。
key	string	インデックス作成要求にあったドキュメントのキー。
status	boolean	キーで識別されたドキュメントに対してインデックス作成操作が成功したかどうかを示す値。
statusCode	integer	インデックス作成操作の状態コード。使用できる値は、更新または削除が成功した場合は 200、ドキュメントの作成が成功した場合は 201、形式が正しくない入力ドキュメントの場合は 400、ドキュメントが見つからない場合は 404、バージョンの競合の場合は 409、インデックスが一時的に使用できない場合は 422、サービスがビジー状態の場合は 503 です。

SearchError

API のエラー条件について説明します。

名前	型	説明
code	string	サーバー定義のエラーコードのセットの 1 つ。
details	SearchError[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
message	string	エラーの人間が判読できる表現。

次の方法で共有