Documents - Get

Dizinden bir belge alır.

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

URI Parametreleri

Veri Akışı Adı İçinde Gerekli Tür Description
endpoint
path True

string (uri)

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

minLength: 1

Bu işlem için kullanılacak 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ığı

Veri Akışı Adı Gerekli Tür Description
x-ms-client-request-id

string (uuid)

İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

Accept

Accept

Accept başlığı.

x-ms-query-source-authorization

string (password)

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.

x-ms-enable-elevated-read

boolean

Sorgu işlemi için belge düzeyi izin denetimlerini atlayan yükseltilmiş okumayı etkinleştiren bir değer.

Yanıtlar

Veri Akışı Adı Tür Description
200 OK

LookupDocument

İstek başarılı oldu.

Other Status Codes

ErrorResponse

Beklenmeyen bir hata yanıtı.

Güvenlik

api-key

Tür: apiKey
İçinde: header

OAuth2Auth

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Kapsamlar

Veri Akışı Adı Description
https://search.azure.com/.default

Örnekler

SearchIndexGetDocument

Örnek isteği

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




Örnek yanıt

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

Tanımlar

Veri Akışı Adı Description
Accept

Accept başlığı.

ErrorAdditionalInfo

Kaynak yönetimi hatasına ilişkin ek bilgiler.

ErrorDetail

Hata ayrıntısı.

ErrorResponse

Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).

Accept

Accept başlığı.

Değer Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Kaynak yönetimi hatasına ilişkin ek bilgiler.

Veri Akışı Adı Tür Description
info

Ek bilgiler.

type

string

Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Veri Akışı Adı Tür Description
additionalInfo

ErrorAdditionalInfo[]

Hata ek bilgisi.

code

string

Hata kodu.

details

ErrorDetail[]

Hata ayrıntıları.

message

string

Hata iletisi.

target

string

Hata hedefi

ErrorResponse

Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).

Veri Akışı Adı Tür Description
error

ErrorDetail

Hata nesnesi.