Documents - Index

サービス:: Search Service

API バージョン:: 2026-04-01

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

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	検索サービスのエンドポイント URL。
indexName	path	True	string	インデックスの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
Accept		Accept	Acceptヘッダーです。
x-ms-client-request-id		string (uuid)	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

要求本文

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

応答

名前	型	説明
200 OK	IndexDocumentsResult	インデックス作成要求内のすべてのドキュメントの操作の状態を含む応答。
Other Status Codes	IndexDocumentsResult	インデックス作成要求内のすべてのドキュメントの操作の状態を含む応答。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

api-key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://search.azure.com/.default

例

SearchIndexIndexDocuments

要求のサンプル

HTTP

POST https://exampleservice.search.windows.net/indexes('example-index')/docs/search.index?api-version=2026-04-01


{
  "value": [
    {
      "@search.action": "mergeOrUpload",
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "vector1": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19
      ],
      "vector1b": [
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19
      ],
      "vector2": [
        0,
        1,
        2,
        3,
        4
      ],
      "vector3": [
        0,
        1,
        2,
        3,
        4
      ],
      "vector22": [
        20,
        21,
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29
      ],
      "ownerId": "benny",
      "category": "purple",
      "price": 0
    },
    {
      "@search.action": "mergeOrUpload",
      "id": "1",
      "name": "test",
      "description": "test1 hello",
      "vector1": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20
      ],
      "vector1b": [
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20
      ],
      "vector2": [
        1,
        2,
        3,
        4,
        5
      ],
      "vector3": [
        1,
        2,
        3,
        4,
        5
      ],
      "vector22": [
        21,
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29,
        30
      ],
      "ownerId": "sam",
      "category": "purple",
      "price": 1
    },
    {
      "@search.action": "mergeOrUpload",
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "vector1": [
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20,
        21
      ],
      "vector1b": [
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20,
        21
      ],
      "vector2": [
        2,
        3,
        4,
        5,
        6
      ],
      "vector3": [
        2,
        3,
        4,
        5,
        6
      ],
      "vector22": [
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29,
        30,
        31
      ],
      "ownerId": "sam",
      "category": "purple",
      "price": 2
    }
  ]
}

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "key": "0",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "1",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "statusCode": 201
    }
  ]
}

状態コード:: 207

{
  "value": [
    {
      "key": "0",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "1",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "statusCode": 201
    }
  ]
}

定義

名前	説明
Accept	Acceptヘッダーです。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。
IndexAction	ドキュメントに対して動作するインデックスアクションを表します。
IndexActionType	インデックス作成バッチ内のドキュメントに対して実行する操作。
IndexBatch	インデックスに送信するドキュメント書き込みアクションのバッチが含まれます。
IndexDocumentsResult	インデックス作成要求内のすべてのドキュメントの操作の状態を含む応答。
IndexingResult	1 つのドキュメントのインデックス作成操作の状態。

Accept

列挙

Acceptヘッダーです。

値	説明
application/json;odata.metadata=none

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

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

IndexAction

Object

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

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

IndexActionType

列挙

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

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

IndexBatch

Object

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

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

IndexDocumentsResult

Object

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

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

IndexingResult

Object

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

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