次の方法で共有


Documents - Index

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

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

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

ErrorResponse

エラー応答。

SearchIndexIndexDocuments

要求のサンプル

POST https://exampleservice.search.windows.net/indexes('indexdocumentsexample')/docs/search.index?api-version=2024-07-01


{
  "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"
    }
  ]
}

応答のサンプル

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

定義

名前 説明
ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

IndexAction

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

IndexActionType

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

IndexBatch

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

IndexDocumentsResult

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

IndexingResult

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

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

エラー オブジェクト。

IndexAction

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

名前 説明
@search.action

IndexActionType

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

IndexActionType

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

説明
delete

指定したドキュメントをインデックスから削除します。 キー フィールド以外の削除操作で指定したフィールドは無視されます。 文書から個々のフィールドを削除する場合は、代わりに差し込み印刷を使用し、フィールドを明示的に null に設定します。

merge

指定したフィールド値を既存のドキュメントとマージします。 ドキュメントが存在しない場合、マージは失敗します。 差し込み印刷で指定したフィールドは、文書内の既存のフィールドに置き換えられます。 これは、プリミティブ型と複合型のコレクションにも適用されます。

mergeOrUpload

指定したキーを持つドキュメントがインデックスに既に存在する場合、マージと同様に動作します。 ドキュメントが存在しない場合は、新しいドキュメントでのアップロードのように動作します。

upload

ドキュメントが新しい場合はインデックスに挿入し、存在する場合は更新します。 更新ケースでは、すべてのフィールドが置き換えられます。

IndexBatch

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

名前 説明
value

IndexAction[]

バッチ内のアクション。

IndexDocumentsResult

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

名前 説明
value

IndexingResult[]

インデックス作成要求の各ドキュメントの状態情報の一覧。

IndexingResult

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

名前 説明
errorMessage

string

キーによって識別されたドキュメントのインデックス作成操作が失敗した理由を説明するエラー メッセージ。インデックス作成に成功した場合は null。

key

string

インデックス作成要求にあったドキュメントのキー。

status

boolean

キーによって識別されたドキュメントに対してインデックス作成操作が成功したかどうかを示す値。

statusCode

integer (int32)

インデックス作成操作の状態コード。 可能な値は、更新または削除が成功した場合は 200、ドキュメントの作成が成功した場合は 201、形式が正しくない入力ドキュメントの場合は 400、ドキュメントが見つからない場合は 404、バージョンの競合の場合は 409、インデックスが一時的に使用できない場合は 422、サービスがビジー状態の場合は 503 です。