Documents - Get

Layanan:
Search Service
Versi API:
2023-11-01

Mengambil dokumen dari indeks.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2023-11-01
Dengan parameter opsional: 
GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2023-11-01

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
endpoint
 path True

string

URL titik akhir layanan pencarian.
indexName
 path True

string

Nama indeks.
key
 path True

string

Kunci dokumen yang akan diambil.
api-version
 query True

string

Versi Api Klien.
$select
 query

string[]

Daftar nama bidang yang akan diambil untuk dokumen; Bidang apa pun yang tidak diambil akan hilang dari dokumen yang dikembalikan.

Header Permintaan

Nama Diperlukan Jenis Deskripsi
x-ms-client-request-id

string (uuid)

ID pelacakan yang dikirim dengan permintaan untuk membantu penelusuran kesalahan.

Respons

Nama Jenis Deskripsi
200 OK

LookupDocument

Respons yang berisi dokumen yang diminta.
Other Status Codes

SearchError

Respons kesalahan.

Contoh

SearchIndexGetDocument

Permintaan sampel

GET https://myservice.search.windows.net/indexes('myindex')/docs('1')?$select=docId,title,description&api-version=2023-11-01

Respon sampel

Kode status:
200 
{
  "description": "Cheapest hotel in town",
  "docId": "1",
  "title": "Nice Hotel"
}

Definisi

SearchError

Objek

Menjelaskan kondisi kesalahan untuk API.

Nama Jenis Deskripsi
code

string

Salah satu sekumpulan 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.