Documents - Get

Layanan:

Search Service

Versi API:

2024-07-01

Mengambil dokumen dari indeks.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2024-07-01

Dengan parameter opsional:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2024-07-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	ErrorResponse	Respons kesalahan.

Contoh

SearchIndexGetDocument

Permintaan sampel

HTTP

GET https://exampleservice.search.windows.net/indexes('getdocumentexample')/docs('1')?$select=docId,title,description&api-version=2024-07-01

Respon sampel

Kode status:

200

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

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

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

ErrorDetail

Detail kesalahan.

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

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.