Documents - Get

Hizmet:

Search Service

API Sürümü:

2023-11-01

Dizinden bir belge alır.

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string	Arama hizmetinin uç nokta URL'si.
indexName	path	True	string	Dizinin adı.
key	path	True	string	Alınacak belgenin anahtarı.
api-version	query	True	string	İstemci Api Sürümü.
$select	query		string[]	Belge için alınacak alan adlarının listesi; Alınmayan herhangi bir alan, döndürülen belgede eksik olacaktır.

İstek Başlığı

Name	Gerekli	Tür	Description
x-ms-client-request-id		string uuid	Hata ayıklamaya yardımcı olmak için istekle birlikte gönderilen izleme kimliği.

Yanıtlar

Name	Tür	Description
200 OK	LookupDocument	İstenen belgeyi içeren yanıt.
Other Status Codes	SearchError	Hata yanıtı.

Örnekler

SearchIndexGetDocument

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

200

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

Tanımlar

SearchError

API için bir hata koşulu açıklar.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
details	SearchError[]	Bu bildirilen hataya yol açan belirli hatalarla ilgili bir dizi ayrıntı.
message	string	Hatanın insanlar tarafından okunabilir bir gösterimi.