Arama Belgesi (Azure AI Arama REST API'si)

  • Makale

Arama Belgesi işlemi, Azure AI Search'ten bir belge alır. Bu, kullanıcı belirli bir arama sonucuna tıkladığında ve bu belgeyle ilgili belirli ayrıntıları aramak istediğinizde kullanışlıdır. Bir kerede yalnızca bir belge alabilirsiniz. Tek bir istekte birden çok belge almak için Belgeleri Ara'yı kullanın.

GET https://[service name].search.windows.net/indexes/[index name]/docs/key?[query parameters]  
  Content-Type: application/json   
  api-key: [admin or query key]

Alternatif olarak, anahtar arama için geleneksel OData söz dizimini kullanabilirsiniz:

GET /indexes/[index name]/docs('[key]')?[query parameters]

URI Parametreleri

Parametre Açıklama
hizmet adı Gereklidir. Bunu arama hizmetinizin benzersiz, kullanıcı tanımlı adı olarak ayarlayın.
dizin adı Gereklidir. İstek URI'si sorguya eklenecek dizinin adını belirtir. Sorgu parametreleri GET istekleri için sorgu dizesinde ve POST istekleri için istek gövdesinde belirtilir.
anahtar Gereklidir. Edm.String Dizindeki her belgeyi benzersiz olarak tanımlayan bir değer. Anahtar bazen belge kimliği olarak adlandırılır. Anahtarın değeri büyük/küçük harfe duyarlıdır. Örneğin, "abc" anahtarına sahip bir belge, "ABC" anahtarına sahip bir belgeden farklıdır.
sorgu parametreleri (isteğe bağlı) ve api-version=2020-06-30 (gerekli) içeren çok parçalı yapı $select . Bu işlem için api sürümü sorgu parametresi olarak belirtilir.
$select=[string] , alınacak virgülle ayrılmış alanların listesidir. Bu yan tümceye yalnızca alınabilir olarak işaretlenmiş alanlar eklenebilir. Belirtilmemişse veya olarak *ayarlanırsa, şemada alınabilir olarak işaretlenmiş tüm alanlar projeksiyona eklenir.

İstek Üst Bilgileri

Aşağıdaki tabloda gerekli ve isteğe bağlı istek üst bilgileri açıklanmaktadır.

Alanlar Description
İçerik Türü Gereklidir. Bunu olarak ayarlayın application/json
api-key İsteğe bağlı olarak Azure rollerini kullanıyorsanız ve istekte taşıyıcı belirteci sağlanıyorsa bir anahtar gereklidir. Api anahtarı, arama hizmetinizde isteğin kimliğini doğrulayan benzersiz, sistem tarafından oluşturulan bir dizedir. Nesne tanımına yönelik alma istekleri, yönetici anahtarınıza ayarlanmış bir api-key alanı içermelidir (sorgu anahtarı yerine). Ayrıntılar için bkz. Anahtar kimlik doğrulamasını kullanarak Azure AI Search'e bağlanma .

İstek Gövdesi

Yok.

Yanıt

Durum Kodu: Başarılı bir yanıt için "200 Tamam" döndürülür.

{   
   field_name: field_value (fields matching the default or specified projection)   
}

Örnekler

'2' anahtarına sahip belgeyi ara:

GET /indexes/hotels/docs/2?api-version=2020-06-30

OData söz dizimini kullanarak '3' anahtarına sahip belgede arama yapma:

GET /indexes/hotels/docs('3')?api-version=2020-06-30

Ayrıca bkz.