Documents - Get

Hizmet:

Search Service

API Sürümü:

2024-07-01

Dizinden bir belge alır.

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

İsteğe bağlı parametrelerle:

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

Örnekler

SearchIndexGetDocument

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

200

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

Tanımlar

Name	Description
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.