Documents - Get

Hizmet:
Search Service
API Sürümü:
2025-08-01-preview

Dizinden bir belge alır.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2025-08-01-preview
İsteğe bağlı parametrelerle: 
GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2025-08-01-preview

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; İade edilen belgede alınmayan herhangi bir alan 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.
x-ms-query-source-authorization

string

Sorgunun yürütüldüğü kullanıcıyı tanımlayan belirteç. Bu belirteç, belgelerde güvenlik kısıtlamalarını zorlamak için kullanılır.

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

GET https://previewexampleservice.search.windows.net/indexes('preview-test')/docs('1')?$select=id,description,name,category,ownerId&api-version=2025-08-01-preview

Örnek yanıt

Durum kodu:
200 
{
  "id": "1",
  "name": "test",
  "description": "test1 hello",
  "category": "purple",
  "ownerId": "sam"
}

Tanımlar

Name Description
ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.
ErrorDetail

Hata ayrıntısı.
ErrorResponse

Hata yanıtı

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

object

Ek bilgiler.
type

string

Ek bilgi türü.

ErrorDetail

Nesne

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

Nesne

Hata yanıtı

Name Tür Description
error

ErrorDetail

Hata nesnesi.