Documents - Index

服務:: Search Service

API 版本:: 2026-04-01

將一批文件寫入動作傳送至索引。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string (uri)	搜尋服務的端點 URL。
indexName	path	True	string	索引的名稱。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求標頭

名稱	必要	類型	Description
Accept		Accept	接受標頭。
x-ms-client-request-id		string (uuid)	一個不透明、全域唯一、由客戶端產生的請求字串識別碼。

要求本文

名稱	必要	類型	Description
value	True	IndexAction[]	批次中的動作。

回應

名稱	類型	Description
200 OK	IndexDocumentsResult	回應，其中包含索引要求中所有文件的作業狀態。
Other Status Codes	IndexDocumentsResult	回應，其中包含索引要求中所有文件的作業狀態。
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

api-key

類型: apiKey
位於: header

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

範圍

名稱	Description
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
    }
  ]
}

定義

名稱	Description
Accept	接受標頭。
ErrorAdditionalInfo	資源管理錯誤附加資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	所有 Azure Resource Manager API 的常見錯誤回應，用於回傳失敗操作的錯誤細節。（這也遵循 OData 錯誤回應格式。）。
IndexAction	表示在文件上運作的索引動作。
IndexActionType	要對索引批次中的文件執行的作業。
IndexBatch	包含要傳送至索引的批次文件寫入動作。
IndexDocumentsResult	回應，其中包含索引要求中所有文件的作業狀態。
IndexingResult	單一檔的索引作業狀態。

Accept

列舉型別

接受標頭。

值	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Object

資源管理錯誤附加資訊。

名稱	類型	Description
info		附加資訊。
type	string	其他資訊類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤附加資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

所有 Azure Resource Manager API 的常見錯誤回應，用於回傳失敗操作的錯誤細節。（這也遵循 OData 錯誤回應格式。）。

名稱	類型	Description
error	ErrorDetail	錯誤物件。

IndexAction

Object

表示在文件上運作的索引動作。

名稱	類型	Description
@search.action	IndexActionType	要對索引批次中的文件執行的作業。

IndexActionType

列舉型別

要對索引批次中的文件執行的作業。

值	Description
upload	將文件插入索引（如果是新的），如果文件存在，則將其插入索引。所有欄位都會在更新案例中取代。
merge	將指定的欄位值與現有文件合併。如果文件不存在，合併將會失敗。您在合併中指定的任何欄位都會取代文件中的現有欄位。這也適用於基本類型和複雜類型的集合。
mergeOrUpload	如果索引中已存在具有指定索引鍵的文件，則其行為類似於合併。如果文件不存在，則其行為類似於上傳新文件。
delete	從索引中移除指定的文件。您在刪除作業中指定索引鍵欄位以外的任何欄位都會被忽略。如果您想要從文件中移除個別欄位，請改用合併，並將欄位明確設為 null。

IndexBatch

Object

包含要傳送至索引的批次文件寫入動作。

名稱	類型	Description
value	IndexAction[]	批次中的動作。

IndexDocumentsResult

Object

回應，其中包含索引要求中所有文件的作業狀態。

名稱	類型	Description
value	IndexingResult[]	索引要求中每個檔案的狀態信息清單。

IndexingResult

Object

單一檔的索引作業狀態。

名稱	類型	Description
errorMessage	string	錯誤訊息，說明索引鍵所識別檔索引作業失敗的原因;如果索引編製成功，則為 null。
key	string	索引要求中檔索引鍵。
status	boolean	值，指出索引鍵所識別檔索引作業是否成功。
statusCode	integer (int32)	索引作業的狀態代碼。可能的值包括：200 用於成功更新或刪除、201 表示成功建立檔、400 表示格式錯誤的輸入檔、找不到檔的 404、版本衝突的 409、索引暫時無法使用時為 422，或服務忙碌時為 503。