Documents - Index

Referensi

Service:: Search Service

API Version:: 2023-10-01-Preview

Mengirim batch tindakan penulisan dokumen ke indeks.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	URL titik akhir layanan pencarian.
indexName	path	True	string	Nama indeks.
api-version	query	True	string	Versi Api Klien.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-request-id		string uuid	ID pelacakan yang dikirim dengan permintaan untuk membantu penelusuran kesalahan.

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 tindakan dalam batch.
Other Status Codes	IndexDocumentsResult	Respons yang berisi status operasi untuk semua tindakan dalam batch.
Other Status Codes	SearchError	Respons kesalahan.

Contoh

SearchIndexIndexDocuments

Sample Request

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

Sample Response

Status code:: 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
    }
  ]
}

Status code:: 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
    }
  ]
}

Definisi

Nama	Deskripsi
IndexAction	Mewakili tindakan indeks yang beroperasi pada dokumen.
IndexActionType	Operasi yang akan dilakukan pada dokumen dalam batch pengindeksan.
IndexBatch	Berisi batch tindakan tulis dokumen untuk dikirim ke indeks.
IndexDocumentsResult	Respons yang berisi status operasi untuk semua dokumen dalam permintaan pengindeksan.
IndexingResult	Status operasi pengindeksan untuk satu dokumen.
SearchError	Menjelaskan kondisi kesalahan untuk API.

IndexAction

Mewakili tindakan indeks yang beroperasi pada dokumen.

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

IndexActionType

Operasi yang akan dilakukan pada dokumen dalam batch pengindeksan.

Nama	Jenis	Deskripsi
delete	string	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.
merge	string	Menggabungkan nilai bidang yang ditentukan dengan dokumen yang sudah ada. Jika dokumen tidak ada, penggabungan akan gagal. Bidang apa pun yang Anda tentukan dalam gabungan akan menggantikan bidang yang sudah ada dalam dokumen. Ini juga berlaku untuk koleksi jenis primitif dan kompleks.
mergeOrUpload	string	Berakibat seperti menggabungkan jika dokumen dengan kunci yang diberikan sudah ada dalam indeks. Jika dokumen tidak ada, dokumen ber perilaku seperti mengunggah dengan dokumen baru.
upload	string	Menyisipkan dokumen ke dalam indeks jika baru dan memperbaruinya jika ada. Semua bidang diganti dalam kasus pembaruan.

IndexBatch

Berisi batch tindakan tulis dokumen untuk dikirim ke indeks.

Nama	Jenis	Deskripsi
value	IndexAction[]	Tindakan dalam batch.

IndexDocumentsResult

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

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	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.

SearchError

Menjelaskan kondisi kesalahan untuk API.

Nama	Jenis	Deskripsi
code	string	Salah satu set kode kesalahan yang ditentukan server.
details	SearchError[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
message	string	Representasi kesalahan yang dapat dibaca manusia.

Share via