Documents - Index

Layanan:: Search Service

Versi API:: 2026-04-01

Mengirim batch tindakan penulisan dokumen ke indeks.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	URL titik akhir layanan pencarian.
indexName	path	True	string	Nama indeks.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Accept		Accept	Header Terima.
x-ms-client-request-id		string (uuid)	Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
value	True	IndexAction[]	Tindakan dalam batch.

Respons

Nama	Jenis	Deskripsi
200 OK	IndexDocumentsResult	Respons yang berisi status operasi untuk semua dokumen dalam permintaan pengindeksan.
Other Status Codes	IndexDocumentsResult	Respons yang berisi status operasi untuk semua dokumen dalam permintaan pengindeksan.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

api-key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama	Deskripsi
https://search.azure.com/.default

Contoh

SearchIndexIndexDocuments

Permintaan sampel

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

Respon sampel

Kode status:: 200

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

Kode status:: 207

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

Definisi

Nama	Deskripsi
Accept	Header Terima.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).
IndexAction	Mewakili tindakan indeks yang beroperasi pada dokumen.
IndexActionType	Operasi yang akan dilakukan pada dokumen dalam batch pengindeksan.
IndexBatch	Berisi sekumpulan tindakan penulisan dokumen untuk dikirim ke indeks.
IndexDocumentsResult	Respons yang berisi status operasi untuk semua dokumen dalam permintaan pengindeksan.
IndexingResult	Status operasi pengindeksan untuk satu dokumen.

Accept

Enumerasi

Header Terima.

Nilai	Deskripsi
application/json;odata.metadata=none

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info		Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Rincian kesalahan.
message	string	Pesan kesalahan.
target	string	Sasaran kesalahan.

ErrorResponse

Objek

Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

IndexAction

Objek

Mewakili tindakan indeks yang beroperasi pada dokumen.

Nama	Jenis	Deskripsi
@search.action	IndexActionType	Operasi yang akan dilakukan pada dokumen dalam batch pengindeksan.

IndexActionType

Enumerasi

Operasi yang akan dilakukan pada dokumen dalam batch pengindeksan.

Nilai	Deskripsi
upload	Menyisipkan dokumen ke dalam indeks jika baru dan memperbaruinya jika ada. Semua bidang diganti dalam kasus pembaruan.
merge	Menggabungkan nilai bidang yang ditentukan dengan dokumen yang ada. Jika dokumen tidak ada, penggabungan akan gagal. Bidang apa pun yang Anda tentukan dalam penggabungan akan menggantikan bidang yang ada dalam dokumen. Ini juga berlaku untuk koleksi tipe primitif dan kompleks.
mergeOrUpload	Berperilaku seperti penggabungan jika dokumen dengan kunci yang diberikan sudah ada di indeks. Jika dokumen tidak ada, itu berperilaku seperti mengunggah dengan dokumen baru.
delete	Menghapus dokumen yang ditentukan dari indeks. Bidang apa pun yang Anda tentukan dalam operasi penghapusan selain bidang kunci akan diabaikan. Jika Anda ingin menghapus bidang individual dari dokumen, gunakan gabungkan sebagai gantinya dan atur bidang secara eksplisit ke null.

IndexBatch

Objek

Berisi sekumpulan tindakan penulisan dokumen untuk dikirim ke indeks.

Nama	Jenis	Deskripsi
value	IndexAction[]	Tindakan dalam batch.

IndexDocumentsResult

Objek

Respons yang berisi status operasi untuk semua dokumen dalam permintaan pengindeksan.

Nama	Jenis	Deskripsi
value	IndexingResult[]	Daftar informasi status untuk setiap dokumen dalam permintaan pengindeksan.

IndexingResult

Objek

Status operasi pengindeksan untuk satu dokumen.

Nama	Jenis	Deskripsi
errorMessage	string	Pesan kesalahan yang menjelaskan mengapa operasi pengindeksan gagal untuk dokumen yang diidentifikasi oleh kunci; null jika pengindeksan berhasil.
key	string	Kunci dokumen yang ada dalam permintaan pengindeksan.
status	boolean	Nilai yang menunjukkan apakah operasi pengindeksan berhasil untuk dokumen yang diidentifikasi oleh kunci.
statusCode	integer (int32)	Kode status operasi pengindeksan. Nilai yang mungkin termasuk: 200 untuk pembaruan atau penghapusan yang berhasil, 201 untuk pembuatan dokumen yang berhasil, 400 untuk dokumen input cacat, 404 untuk dokumen tidak ditemukan, 409 untuk konflik versi, 422 ketika indeks sementara tidak tersedia, atau 503 saat layanan terlalu sibuk.