Documents - Search Get

Hizmet:

Search Service

API Sürümü:

2024-03-01-Preview

Dizindeki belgeleri arar.

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

İsteğe bağlı parametrelerle:

GET {endpoint}/indexes('{indexName}')/docs?search={search}&$count={$count}&facet={facet}&$filter={$filter}&highlight={highlight}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&queryType={queryType}&scoringParameter={scoringParameter}&scoringProfile={scoringProfile}&semanticQuery={semanticQuery}&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&debug={debug}&searchFields={searchFields}&queryLanguage={queryLanguage}&speller={speller}&answers={answers}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&captions={captions}&semanticFields={semanticFields}&api-version=2024-03-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ı.
api-version	query	True	string	İstemci Api Sürümü.
$count	query		boolean	Toplam sonuç sayısının getirilip getirilmeyeceğini belirten bir değer. Varsayılan değer false’tur. Bu değeri true olarak ayarlamak performansı etkileyebilir. Döndürülen sayın yaklaşık olduğunu unutmayın.
$filter	query		string	Arama sorgusuna uygulanacak OData $filter ifadesi.
$orderby	query		string[]	Sonuçların sıralandığı OData $orderby ifadelerinin listesi. Her ifade bir alan adı veya geo.distance() veya search.score() işlevlerine yapılan bir çağrı olabilir. Her ifadeyi artanı belirtmek için asc, azalanı belirtmek için desc takip edebilir. Varsayılan değer artan düzendir. Bağlantılar, belgelerin eşleşme puanları tarafından kırılır. OrderBy belirtilmezse, varsayılan sıralama düzeni belge eşleştirme puanına göre azalan düzendedir. En fazla 32 $orderby yan tümcesi olabilir.
$select	query		string[]	Alınacak alanların listesi. Belirtilmemişse, şemada alınabilir olarak işaretlenmiş tüm alanlar eklenir.
$skip	query		integer int32	Atlana arama sonuçlarının sayısı. Bu değer 100.000'den büyük olamaz. Belgeleri sırayla taramanız gerekiyorsa ancak bu sınırlama nedeniyle $skip kullanamıyorsanız, tamamen sıralı bir anahtarda $orderby kullanmayı ve bunun yerine aralık sorgusuyla $filter düşünün.
$top	query		integer int32	Alınacak arama sonuçlarının sayısı. Bu, arama sonuçlarının istemci tarafı disk belleğini uygulamak için $skip ile birlikte kullanılabilir. Sonuçlar sunucu tarafı sayfalama nedeniyle kesilirse, yanıt bir sonraki sonuç sayfası için başka bir Arama isteği göndermek için kullanılabilecek bir devamlılık belirteci içerir.
answers	query		QueryAnswerType	Bu parametre yalnızca sorgu türü olduğunda semanticgeçerlidir. Ayarlanırsa, sorgu en yüksek dereceli belgelerdeki anahtar metinlerden ayıklanan yanıtları döndürür. Döndürülen yanıt sayısı, kanal karakteri | eklenerek yapılandırılabilir ve ardından answers parametresi değerinden count-<number of answers> sonra gelen seçenek (örneğin extractive|count-3, ) kullanılabilir. Varsayılan sayı 1'dir. Güvenilirlik eşiği, gibi yanıt parametresi değerinden extractive|threshold-0.9sonra gelen seçeneğin ardından threshold-<confidence threshold> kanal karakteri | eklenerek yapılandırılabilir. Varsayılan eşik 0,7'dir.
captions	query		QueryCaptionType	Bu parametre yalnızca sorgu türü olduğunda semanticgeçerlidir. Ayarlanırsa, sorgu en yüksek dereceli belgelerdeki anahtar metinlerden ayıklanan resim yazılarını döndürür. Açıklamalı alt yazılar olarak ayarlandığında extractivevurgulama varsayılan olarak etkindir ve dikey çizgi karakteri | eklenerek yapılandırılabilir ve bunun extractive|highlight-trueardından highlight-<true/false> gibi bir seçenek eklenebilir. Varsayılan olarak olarak Nonegösterilir.
debug	query		QueryDebugMode	Arama sonuçlarınızı daha fazla araştırmak için kullanılabilecek bir hata ayıklama aracını etkinleştirir.
facet	query		string[]	Arama sorgusuna uygulanacak model ifadelerinin listesi. Her model ifadesi, isteğe bağlı olarak virgülle ayrılmış ad:değer çiftleri listesi içeren bir alan adı içerir.
highlight	query		string[]	Isabet vurgulamaları için kullanılacak alan adlarının listesi. Yalnızca isabet vurgulama için aranabilir alanlar kullanılabilir.
highlightPostTag	query		string	Vurgulananlara isabet etmek için eklenen bir dize etiketi. highlightPreTag ile ayarlanmalıdır. Varsayılan değer /em'dir<>.
highlightPreTag	query		string	Vurgulamalara basmak için önceden eklenen bir dize etiketi. highlightPostTag ile ayarlanmalıdır. Varsayılan değer em'dir<>.
minimumCoverage	query		number double	0 ile 100 arasında bir sayı, sorgunun başarılı olarak bildirilebilmesi için bir arama sorgusunun kapsamına alınması gereken dizinin yüzdesini belirtir. Bu parametre, yalnızca bir çoğaltması olan hizmetler için bile arama kullanılabilirliğini sağlamak için yararlı olabilir. Varsayılan değer 100'dür.
queryLanguage	query		QueryLanguage	Sorgunun dili.
queryType	query		QueryType	Arama sorgusunun söz dizimini belirten bir değer. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu söz dizimini kullanıyorsa 'tam' kullanın.
scoringParameter	query		string[]	Ad-değerleri biçimi kullanılarak puanlama işlevlerinde (örneğin, referencePointParameter) kullanılacak parametre değerlerinin listesi. Örneğin, puanlama profili 'mylocation' adlı bir parametreye sahip bir işlev tanımlarsa, parametre dizesi "mylocation--122.2,44.8" (tırnak işaretleri olmadan) olur.
scoringProfile	query		string	Sonuçları sıralamak için eşleşen belgeler için eşleşme puanlarını değerlendirmek için bir puanlama profilinin adı.
scoringStatistics	query		ScoringStatistics	Daha tutarlı puanlama için puanlama istatistiklerini (belge sıklığı gibi) genel olarak mı yoksa daha düşük gecikme süresi için yerel olarak mı hesaplamak istediğimizi belirten bir değer.
search	query		string	Tam metin arama sorgusu ifadesi; Tüm belgelerle eşleştirmek için "*" kullanın veya bu parametreyi atla.
searchFields	query		string[]	Tam metin aramasının kapsamının ne olduğu alan adlarının listesi. Tam Lucene sorgusunda alanlı arama (fieldName:searchExpression) kullanılırken, her alanlı arama ifadesinin alan adları bu parametrede listelenen alan adlarından önceliklidir.
searchMode	query		SearchMode	Belgeyi eşleşme olarak saymak için arama terimlerinin herhangi birinin veya tümünün eşleştirilip eşleştirilmeyeceğini belirten bir değer.
semanticConfiguration	query		string	Anlam sıralaması, açıklamalı alt yazılar, vurgular ve yanıtlar için hangi alanların kullanılması gerektiğini listeleyen anlamsal yapılandırmanın adı
semanticErrorHandling	query		SemanticErrorMode	Kullanıcının bir semantik çağrının tamamen başarısız olup olmayacağını veya kısmi sonuçlar döndürmesini (varsayılan) seçmesine izin verir.
semanticFields	query		string[]	Anlam derecelendirmesi için kullanılan alan adlarının listesi.
semanticMaxWaitInMilliseconds	query		integer int32	Kullanıcının istek başarısız olmadan önce anlam zenginleştirme işleminin tamamlanması için gereken süreye göre bir üst sınır ayarlamasına izin verir.
semanticQuery	query		string	Yalnızca anlamsal yeniden boyutlandırma, anlamsal açıklamalı alt yazılar ve anlamsal yanıtlar için kullanılacak ayrı bir arama sorgusu ayarlamaya olanak tanır. Temel alma ve derecelendirme aşaması ile L2 semantik aşaması arasında farklı sorgular kullanılması gereken senaryolar için kullanışlıdır.
sessionId	query		string	Daha tutarlı sonuçlar elde etmeye yardımcı olabilecek, yapışkan bir oturum oluşturmak için kullanılacak bir değer. Aynı sessionId kullanıldığı sürece, aynı çoğaltma kümesini hedeflemek için en iyi çabayı gösterilecektir. Aynı sessionID değerlerini tekrar tekrar yeniden kullanmanın çoğaltmalar arasında isteklerin yük dengelemesini engelleyeceğine ve arama hizmetinin performansını olumsuz etkileyebileceğine dikkat edin. sessionId olarak kullanılan değer '_' karakteriyle başlayamaz.
speller	query		Speller	Tek tek arama sorgusu terimlerini yazım düzelterek arama geri çağırmayı geliştirin.

İ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	SearchDocumentsResult	Arama ölçütleriyle eşleşen belgeleri içeren yanıt.
Other Status Codes	ErrorResponse	Hata yanıtı.

Örnekler

SearchIndexSearchDocumentsGet

Örnek isteği

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=nice hotels&$count=True&facet=category,count:10,sort:count&$filter=rating gt 10&highlight=title&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&queryType=simple&scoringProfile=sp&searchFields=title,description&speller={speller}&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2024-03-01-Preview

Örnek yanıt

Durum kodu:

200

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "value": [
    {
      "@search.score": 1.5,
      "@search.highlights": {
        "title": [
          "<em>Nice</em> <em>Hotel</em>"
        ]
      },
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.score": 0.7,
      "@search.highlights": {
        "title": [
          "Fancy <em>Hotel</em>"
        ]
      },
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

Tanımlar

Name	Description
AnswerResult	Yanıt, sorguyla eşleşen en ilgili belgelerin içeriğinden ayıklanan metin metnidir. Yanıtlar en üstteki arama sonuçlarından ayıklanır. Yanıt adayları puanlanmış ve en iyi yanıtlar seçilmiştir.
CaptionResult	Resim yazıları, belgeden arama sorgusuna göre en temsili metinlerdir. Bunlar genellikle belge özeti olarak kullanılır. Açıklamalı alt yazılar yalnızca 'semantik' türünde sorgular için döndürülür...
DocumentDebugInfo	Arama sonuçlarınızı daha fazla araştırmak için kullanılabilecek hata ayıklama bilgilerini içerir.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
QueryAnswerType	Yanıtların arama yanıtının bir parçası olarak döndürülip döndürülmeyeceğini belirten bir değer.
QueryCaptionType	Açıklamalı alt yazıların arama yanıtının bir parçası olarak döndürülip döndürülmeyeceğini belirten bir değer.
QueryDebugMode	Arama sonuçlarınızı daha fazla araştırmak için kullanılabilecek bir hata ayıklama aracını etkinleştirir.
QueryLanguage	Sorgunun dili.
QueryResultDocumentRerankerInput	Anlam zenginleştirme işlemine gönderilen ham birleştirilmiş dizeler.
QueryResultDocumentSemanticField	Anlam zenginleştirme işlemine gönderilen alanların açıklaması ve bunların nasıl kullanıldığı
QuerySpellerType	Tek tek arama sorgusu terimlerinin yazımını düzeltmek için kullanılacak yazım denetleyicisinin türünü belirten değer.
QueryType	Arama sorgusunun söz dizimini belirtir. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu söz dizimini kullanıyorsa 'full' ve sorgu söz dizimi gerekmiyorsa 'semantik' kullanın.
RawVectorQuery	Ham vektör değeri sağlandığında vektör araması için kullanılacak sorgu parametreleri.
ScoringStatistics	Daha tutarlı puanlama için puanlama istatistiklerini (belge sıklığı gibi) genel olarak mı yoksa daha düşük gecikme süresi için yerel olarak mı hesaplamak istediğimizi belirten bir değer. Varsayılan değer 'yerel'dir. Puanlamadan önce puanlama istatistiklerini genel olarak toplamak için 'global' kullanın. Genel puanlama istatistiklerinin kullanılması, arama sorgularının gecikme süresini artırabilir.
SearchDocumentsResult	Bir dizinden arama sonuçlarını içeren yanıt.
SearchMode	Belgeyi eşleşme olarak saymak için arama terimlerinden herhangi birinin veya tümünün eşleşmesi gerekip gerekmediğini belirtir.
SearchRequest	Filtreleme, sıralama, model oluşturma, sayfalama ve diğer arama sorgusu davranışları için parametreler.
SearchResult	Arama sorgusu tarafından bulunan bir belgeyi ve ilişkili meta verileri içerir.
SemanticDebugInfo
SemanticErrorMode	Kullanıcının bir semantik çağrının tamamen başarısız olup olmayacağını veya kısmi sonuçlar döndürmesini (varsayılan) seçmesine izin verir.
SemanticErrorReason	Semantik derecelendirme isteği için kısmi yanıt döndürüldü nedeni.
SemanticFieldState	Alanın semantik zenginleştirme işlemi için kullanılma biçimi (tamamen kullanılmış, kısmen kullanılmış veya kullanılmamış)
SemanticSearchResultsType	Anlamsal derecelendirme isteği için döndürülen kısmi yanıtın türü.
Speller	Tek tek arama sorgusu terimlerini yazım düzelterek arama geri çağırmayı geliştirin.
VectorFilterMode	Vektör araması gerçekleştirilmeden önce veya sonra filtrelerin uygulanıp uygulanmayacağını belirler.
VectorizableTextQuery	Vektörleştirilmesi gereken bir metin değeri sağlandığında vektör araması için kullanılacak sorgu parametreleri.
VectorQueryKind	Gerçekleştirilen vektör sorgusunun türü.

AnswerResult

Yanıt, sorguyla eşleşen en ilgili belgelerin içeriğinden ayıklanan metin metnidir. Yanıtlar en üstteki arama sonuçlarından ayıklanır. Yanıt adayları puanlanmış ve en iyi yanıtlar seçilmiştir.

Name	Tür	Description
highlights	string	Sorguyla en ilgili metin tümceciklerinin vurgulandığı Text özelliğindekiyle aynı metin metni.
key	string	Yanıtın ayıklandığı belgenin anahtarı.
score	number	Puan değeri, yanıtın sorgu için döndürülen diğer yanıtlara göre sorguyla ne kadar ilgili olduğunu gösterir.
text	string	Yanıt olarak belge içeriğinden ayıklanan metin metni.

CaptionResult

Resim yazıları, belgeden arama sorgusuna göre en temsili metinlerdir. Bunlar genellikle belge özeti olarak kullanılır. Açıklamalı alt yazılar yalnızca 'semantik' türünde sorgular için döndürülür...

Name	Tür	Description
highlights	string	Sorguyla en ilgili vurgulanmış tümcecikleri içeren Text özelliğindekiyle aynı metin metni.
text	string	Arama sorgusuyla en ilgili belgeden ayıklanan temsili metin metni.

DocumentDebugInfo

Arama sonuçlarınızı daha fazla araştırmak için kullanılabilecek hata ayıklama bilgilerini içerir.

Name	Tür	Description
semantic	SemanticDebugInfo	Anlamsal derecelendirme isteklerine özgü hata ayıklama bilgilerini içerir.

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.

QueryAnswerType

Yanıtların arama yanıtının bir parçası olarak döndürülip döndürülmeyeceğini belirten bir değer.

Name	Tür	Description
extractive	string	Doğal dilde soru olarak ifade edilen bir sorguya yanıt olarak döndürülen belgelerin içeriğinden yanıt adaylarını ayıklar.
none	string	Sorgunun yanıtlarını döndürmeyin.

QueryCaptionType

Açıklamalı alt yazıların arama yanıtının bir parçası olarak döndürülip döndürülmeyeceğini belirten bir değer.

Name	Tür	Description
extractive	string	Eşleşen belgelerden arama sorgusuyla ilgili metinler içeren resim yazılarını ayıklar.
none	string	Sorgu için açıklamalı alt yazı döndürmeyin.

QueryDebugMode

Arama sonuçlarınızı daha fazla araştırmak için kullanılabilecek bir hata ayıklama aracını etkinleştirir.

Name	Tür	Description
disabled	string	Hiçbir sorgu hata ayıklama bilgisi döndürülmeyecek.
semantic	string	Kullanıcının yeniden kaydedilen sonuçlarını daha fazla keşfetmesine olanak tanır.

QueryLanguage

Sorgunun dili.

Name	Tür	Description
ar-eg	string	Arapça (Mısır) için sorgu dili değeri.
ar-jo	string	Arapça (Ürdün) için sorgu dili değeri.
ar-kw	string	Arapça (Kuveyt) için sorgu dili değeri.
ar-ma	string	Arapça (Fas) için sorgu dili değeri.
ar-sa	string	Arapça (Suudi Arabistan) için sorgu dili değeri.
bg-bg	string	Bulgarca (Bulgaristan) için sorgu dili değeri.
bn-in	string	Bengali (Hindistan) için sorgu dili değeri.
ca-es	string	Katala dili için sorgu dili değeri.
cs-cz	string	Çekçe (Çek Cumhuriyeti) için sorgu dili değeri.
da-dk	string	Danca (Danimarka) için sorgu dili değeri.
de-de	string	Almanca (Almanya) için sorgu dili değeri.
el-gr	string	Yunanca (Yunanistan) için sorgu dili değeri.
en-au	string	İngilizce (Avustralya) için sorgu dili değeri.
en-ca	string	İngilizce (Kanada) için sorgu dili değeri.
en-gb	string	İngilizce (Büyük Britanya) için sorgu dili değeri.
en-in	string	İngilizce (Hindistan) için sorgu dili değeri.
en-us	string	İngilizce (Birleşik Devletler) için sorgu dili değeri.
es-es	string	İspanyolca (İspanya) için sorgu dili değeri.
es-mx	string	İspanyolca (Meksika) için sorgu dili değeri.
et-ee	string	Estonca (Estonya) için sorgu dili değeri.
eu-es	string	Bask dili için sorgu dili değeri.
fa-ae	string	Farsça (U.A.E.) için sorgu dili değeri.
fi-fi	string	Fince (Finlandiya) için sorgu dili değeri.
fr-ca	string	Fransızca (Kanada) için sorgu dili değeri.
fr-fr	string	Fransızca (Fransa) için sorgu dili değeri.
ga-ie	string	İrlanda dili (İrlanda) için sorgu dili değeri.
gl-es	string	Galiçya dili için sorgu dili değeri.
gu-in	string	Gujarati (Hindistan) için sorgu dili değeri.
he-il	string	İbranice (İsrail) için sorgu dili değeri.
hi-in	string	Hintçe (Hindistan) için sorgu dili değeri.
hr-ba	string	Hırvatça (Bosna-Hersek) için sorgu dili değeri.
hr-hr	string	Hırvatçe (Hırvatistan) için sorgu dili değeri.
hu-hu	string	Macarca (Macaristan) için sorgu dili değeri.
hy-am	string	Ermenice (Ermenistan) için sorgu dili değeri.
id-id	string	Endonezya dili (Endonezya) için sorgu dili değeri.
is-is	string	İzlanda dili (İzlanda) için sorgu dili değeri.
it-it	string	İtalyanca (İtalya) için sorgu dili değeri.
ja-jp	string	Japonca (Japonya) için sorgu dili değeri.
kn-in	string	Kannada (Hindistan) için sorgu dili değeri.
ko-kr	string	Korece (Kore) için sorgu dili değeri.
lt-lt	string	Litvanca (Litvanya) için sorgu dili değeri.
lv-lv	string	Letonca (Letonya) için sorgu dili değeri.
ml-in	string	Malayalam (Hindistan) için sorgu dili değeri.
mr-in	string	Marathi (Hindistan) için sorgu dili değeri.
ms-bn	string	Malay dili (Brunei Darussalam) için sorgu dili değeri.
ms-my	string	Malay dili (Malezya) için sorgu dili değeri.
nb-no	string	Norveççe (Norveç) için sorgu dili değeri.
nl-be	string	Felemenkçe (Belçika) için sorgu dili değeri.
nl-nl	string	Felemenkçe (Hollanda) için sorgu dili değeri.
no-no	string	Norveççe (Norveç) için sorgu dili değeri.
none	string	Sorgu dili belirtilmedi.
pa-in	string	Pencap dili (Hindistan) için sorgu dili değeri.
pl-pl	string	Lehçe (Polonya) için sorgu dili değeri.
pt-br	string	Portekizce (Brezilya) için sorgu dili değeri.
pt-pt	string	Portekizce (Portekiz) için sorgu dili değeri.
ro-ro	string	Rumence (Romanya) için sorgu dili değeri.
ru-ru	string	Rusça (Rusya) için sorgu dili değeri.
sk-sk	string	Slovakça (Slovakya) için sorgu dili değeri.
sl-sl	string	Slovence (Slovenya) için sorgu dili değeri.
sr-ba	string	Sırpça (Bosna-Hersek) için sorgu dili değeri.
sr-me	string	Sırpçe (Karadağ) için sorgu dili değeri.
sr-rs	string	Sırpça (Sırbistan) için sorgu dili değeri.
sv-se	string	İsveççe (İsveç) için sorgu dili değeri.
ta-in	string	Tamil dili (Hindistan) için sorgu dili değeri.
te-in	string	Telugu dili (Hindistan) için sorgu dili değeri.
th-th	string	Tay dili (Tayland) için sorgu dili değeri.
tr-tr	string	Türkçe (Türkiye) için sorgu dili değeri.
uk-ua	string	Ukrayna dili (Ukrayna) için sorgu dili değeri.
ur-pk	string	Urduca (Pakistan) için sorgu dili değeri.
vi-vn	string	Vietnam dili (Viet Nam) için sorgu dili değeri.
zh-cn	string	Çince (Çin) için sorgu dili değeri.
zh-tw	string	Çince (Tayvan) için sorgu dili değeri.

QueryResultDocumentRerankerInput

Anlam zenginleştirme işlemine gönderilen ham birleştirilmiş dizeler.

Name	Tür	Description
content	string	Anlam zenginleştirme için kullanılan içerik alanları için ham birleştirilmiş dizeler.
keywords	string	Anlam zenginleştirme için kullanılan anahtar sözcük alanları için ham birleştirilmiş dizeler.
title	string	Anlam zenginleştirmesi için kullanılan başlık alanının ham dizesi.

QueryResultDocumentSemanticField

Anlam zenginleştirme işlemine gönderilen alanların açıklaması ve bunların nasıl kullanıldığı

Name	Tür	Description
name	string	Anlam zenginleştirme işlemine gönderilen alanın adı
state	SemanticFieldState	Alanın semantik zenginleştirme işlemi için kullanılma biçimi (tamamen kullanılmış, kısmen kullanılmış veya kullanılmamış)

QuerySpellerType

Tek tek arama sorgusu terimlerinin yazımını düzeltmek için kullanılacak yazım denetleyicisinin türünü belirten değer.

Name	Tür	Description
lexicon	string	Yazım denetleyicisi queryLanguage parametresi tarafından belirtilen dil için statik bir sözlük kullanarak tek tek sorgu terimlerini düzeltir.
none	string	Yazım denetleyicisi etkinleştirilmedi.

QueryType

Arama sorgusunun söz dizimini belirtir. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu söz dizimini kullanıyorsa 'full' ve sorgu söz dizimi gerekmiyorsa 'semantik' kullanın.

Name	Tür	Description
full	string	Aramalar için tam Lucene sorgu söz dizimini kullanır. Arama metin, alana özgü ve ağırlıklı aramalara ve diğer gelişmiş özelliklere olanak tanıyan Lucene sorgu dili kullanılarak yorumlanır.
semantic	string	Anahtar sözcüklerin aksine doğal dilde ifade edilen sorgular için idealdir. Web corpus'ta eğitilen bir derecelendirme modelini kullanarak en üstteki arama sonuçlarını yeniden derecelendirerek arama sonuçlarının duyarlığını artırır.
simple	string	Aramalar için basit sorgu söz dizimini kullanır. Arama metin , +, * ve "" gibi simgelere izin veren basit bir sorgu dili kullanılarak yorumlanır. searchFields parametresi belirtilmediği sürece, sorgular tüm aranabilir alanlarda varsayılan olarak değerlendirilir.

RawVectorQuery

Ham vektör değeri sağlandığında vektör araması için kullanılacak sorgu parametreleri.

Name	Tür	Description
exhaustive	boolean	True olduğunda, vektör dizinindeki tüm vektörlerde kapsamlı bir k-en yakın komşu aramasını tetikler. Kesin eşleşmelerin kritik olduğu senaryolar için yararlıdır( örneğin, temel gerçeklik değerlerini belirleme).
fields	string	Aranan vektöre dahil edilecek Collection(Edm.Single) türünde Vektör Alanları.
k	integer	En çok isabet alan olarak döndürülecek en yakın komşu sayısı.
kind	string: vector	Gerçekleştirilen vektör sorgusunun türü.
oversampling	number	Fazla örnekleme faktörü. En düşük değer 1'dir. Dizin tanımında yapılandırılan 'defaultOversampling' parametresini geçersiz kılar. Yalnızca 'rerankWithOriginalVectors' true olduğunda ayarlanabilir. Bu parametreye yalnızca temel alınan vektör alanında bir sıkıştırma yöntemi kullanıldığında izin verilir.
vector	number[]	Arama sorgusunun vektör gösterimi.

ScoringStatistics

Daha tutarlı puanlama için puanlama istatistiklerini (belge sıklığı gibi) genel olarak mı yoksa daha düşük gecikme süresi için yerel olarak mı hesaplamak istediğimizi belirten bir değer. Varsayılan değer 'yerel'dir. Puanlamadan önce puanlama istatistiklerini genel olarak toplamak için 'global' kullanın. Genel puanlama istatistiklerinin kullanılması, arama sorgularının gecikme süresini artırabilir.

Name	Tür	Description
global	string	Daha tutarlı puanlama için puanlama istatistikleri genel olarak hesaplanır.
local	string	Puanlama istatistikleri daha düşük gecikme süresi için yerel olarak hesaplanır.

SearchDocumentsResult

Bir dizinden arama sonuçlarını içeren yanıt.

Name	Tür	Description
@odata.count	integer	Arama işlemi tarafından bulunan sonuçların toplam sayısı veya sayı istenmediyse null. Varsa, sayı bu yanıttaki sonuç sayısından büyük olabilir. bu durum, $top veya $skip parametrelerini kullanırsanız ya da sorgu istenen tüm belgeleri tek bir yanıtta döndüremezse oluşabilir.
@odata.nextLink	string	Sorgu istenen tüm sonuçları tek bir yanıtta döndüremiyorsa devam URL'si döndürülür. Arama yanıtının sonraki bölümünü almak üzere başka bir GET veya POST Arama isteği formüle etmek için bu URL'yi kullanabilirsiniz. Bu yanıtı oluşturan istekle aynı fiili (GET veya POST) kullandığınızdan emin olun.
@search.answers	AnswerResult[]	Arama işlemi için sorgu sonuçlarını yanıtlar; yanıt sorgu parametresi belirtilmediyse veya 'none' olarak ayarlandıysa null.
@search.coverage	number	Sorguya dahil edilen dizinin yüzdesini gösteren bir değer veya istekte minimumCoverage belirtilmediyse null.
@search.facets	object	Her yönlü alan için bir demet koleksiyonu olarak düzenlenmiş arama işleminin model sorgusu sonuçları; null değerini alır.
@search.nextPageParameters	SearchRequest	Sorgu tüm istenen sonuçları tek bir yanıtta döndüremediğinde devamlılık JSON yükü döndürülür. Arama yanıtının sonraki bölümünü almak üzere başka bir POST Arama isteği formüle etmek için bu JSON ile birlikte @odata.nextLink kullanabilirsiniz.
@search.semanticPartialResponseReason	SemanticErrorReason	Semantik derecelendirme isteği için kısmi yanıt döndürüldü nedeni.
@search.semanticPartialResponseType	SemanticSearchResultsType	Anlamsal derecelendirme isteği için döndürülen kısmi yanıtın türü.
value	SearchResult[]	Sorgu tarafından döndürülen sonuç dizisi.

SearchMode

Belgeyi eşleşme olarak saymak için arama terimlerinden herhangi birinin veya tümünün eşleşmesi gerekip gerekmediğini belirtir.

Name	Tür	Description
all	string	Belgeyi eşleşme olarak saymak için tüm arama terimlerinin eşleşmesi gerekir.
any	string	Belgeyi eşleşme olarak saymak için arama terimlerinden herhangi birinin eşleşmesi gerekir.

SearchRequest

Filtreleme, sıralama, model oluşturma, sayfalama ve diğer arama sorgusu davranışları için parametreler.

Name	Tür	Description
answers	QueryAnswerType	Yanıtların arama yanıtının bir parçası olarak döndürülip döndürülmeyeceğini belirten bir değer.
captions	QueryCaptionType	Açıklamalı alt yazıların arama yanıtının bir parçası olarak döndürülip döndürülmeyeceğini belirten bir değer.
count	boolean	Toplam sonuç sayısının getirilip getirilmeyeceğini belirten bir değer. Varsayılan değer false’tur. Bu değeri true olarak ayarlamak performansı etkileyebilir. Döndürülen sayın yaklaşık olduğunu unutmayın.
debug	QueryDebugMode	Yeniden kaydedilen sonuçlarınızı daha fazla keşfetmek için kullanılabilecek bir hata ayıklama aracı sağlar.
facets	string[]	Arama sorgusuna uygulanacak model ifadelerinin listesi. Her model ifadesi, isteğe bağlı olarak virgülle ayrılmış ad:değer çiftleri listesi içeren bir alan adı içerir.
filter	string	Arama sorgusuna uygulanacak OData $filter ifadesi.
highlight	string	Isabet vurgulamaları için kullanılacak alan adlarının virgülle ayrılmış listesi. Yalnızca isabet vurgulama için aranabilir alanlar kullanılabilir.
highlightPostTag	string	Vurgulamalara isabet etmek için eklenen bir dize etiketi. highlightPreTag ile ayarlanmalıdır. Varsayılan değer /em'dir<>.
highlightPreTag	string	Vurgulamalara basmak için önceden eklenen bir dize etiketi. highlightPostTag ile ayarlanmalıdır. Varsayılan değer em'dir<>.
minimumCoverage	number	0 ile 100 arasında bir sayı, sorgunun başarılı olarak bildirilebilmesi için bir arama sorgusunun kapsamına alınması gereken dizinin yüzdesini belirtir. Bu parametre, yalnızca bir çoğaltması olan hizmetler için bile arama kullanılabilirliğini sağlamak için yararlı olabilir. Varsayılan değer 100'dür.
orderby	string	Sonuçların sıralandığı OData $orderby ifadelerinin virgülle ayrılmış listesi. Her ifade bir alan adı veya geo.distance() veya search.score() işlevlerine yapılan çağrı olabilir. Her ifadenin ardından artanı belirtmek için asc veya azalanı belirtmek için desc kullanılabilir. Varsayılan değer artan düzendir. Bağlar, belgelerin maç skorlarıyla bozulur. Hiçbir $orderby belirtilmezse, varsayılan sıralama düzeni belge eşleştirme puanına göre azalan düzendedir. En fazla 32 $orderby yan tümcesi olabilir.
queryLanguage	QueryLanguage	Arama sorgusunun dilini belirten bir değer.
queryType	QueryType	Arama sorgusunun söz dizimini belirten bir değer. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu söz dizimini kullanıyorsa 'full' kullanın.
scoringParameters	string[]	Ad-değerler biçimini kullanarak puanlama işlevlerinde (örneğin, referencePointParameter) kullanılacak parametre değerlerinin listesi. Örneğin, puanlama profili 'mylocation' adlı bir parametreye sahip bir işlev tanımlarsa, parametre dizesi "mylocation--122.2,44.8" (tırnak işaretleri olmadan) olur.
scoringProfile	string	Sonuçları sıralamak için eşleşen belgeler için eşleşme puanlarını değerlendirmek için bir puanlama profilinin adı.
scoringStatistics	ScoringStatistics	Daha tutarlı puanlama için puanlama istatistiklerini (belge sıklığı gibi) genel olarak mı yoksa daha düşük gecikme süresi için yerel olarak mı hesaplamak istediğimizi belirten bir değer. Varsayılan değer 'yerel'dir. Puanlamadan önce puanlama istatistiklerini genel olarak toplamak için 'global' kullanın. Genel puanlama istatistiklerinin kullanılması, arama sorgularının gecikme süresini artırabilir.
search	string	Tam metin arama sorgusu ifadesi; Tüm belgelerle eşleştirmek için "*" kullanın veya bu parametreyi atla.
searchFields	string	Tam metin aramasının kapsamına ekleyebileceğiniz alan adlarının virgülle ayrılmış listesi. Tam Lucene sorgusunda alanlı aramayı (fieldName:searchExpression) kullanırken, her alanlı arama ifadesinin alan adları bu parametrede listelenen alan adlarından önceliklidir.
searchMode	SearchMode	Belgeyi eşleşme olarak saymak için arama terimlerinden herhangi birinin veya tümünün eşleştirilip eşleştirilmeyeceğini belirten bir değer.
select	string	Alınacak alanların virgülle ayrılmış listesi. Belirtilmezse, şemada alınabilir olarak işaretlenmiş tüm alanlar eklenir.
semanticConfiguration	string	Semantik türdeki sorgular için belgeler işlenirken kullanılacak anlamsal yapılandırmanın adı.
semanticErrorHandling	SemanticErrorMode	Kullanıcının bir semantik çağrının tamamen başarısız olup olmayacağını veya kısmi sonuçlar döndürmesini (varsayılan) seçmesine izin verir.
semanticFields	string	Anlam sıralaması için kullanılan alan adlarının virgülle ayrılmış listesi.
semanticMaxWaitInMilliseconds	integer	Kullanıcının istek başarısız olmadan önce anlam zenginleştirme işleminin tamamlanması için gereken süre boyunca üst sınır ayarlamasına izin verir.
semanticQuery	string	Yalnızca anlamsal yeniden boyutlandırma, anlamsal açıklamalı alt yazılar ve anlamsal yanıtlar için kullanılacak ayrı bir arama sorgusu ayarlamaya izin verir. Temel alma ve derecelendirme aşaması ile L2 semantik aşaması arasında farklı sorgular kullanılması gereken senaryolar için yararlıdır.
sessionId	string	Daha tutarlı sonuçlar elde etmeye yardımcı olabilecek, yapışkan bir oturum oluşturmak için kullanılacak bir değer. Aynı sessionId kullanıldığı sürece, aynı çoğaltma kümesini hedeflemek için en iyi çabayı gösterme girişiminde bulunulacaktır. Aynı sessionID değerlerini tekrar tekrar yeniden kullanmanın çoğaltmalar arasında isteklerin yük dengelemesini engelleyeceğine ve arama hizmetinin performansını olumsuz etkileyebileceğine dikkat edin. sessionId olarak kullanılan değer '_' karakteriyle başlayamaz.
skip	integer	Atlana arama sonuçlarının sayısı. Bu değer 100.000'den büyük olamaz. Belgeleri sırayla taramanız gerekiyorsa ancak bu sınırlama nedeniyle atlamayı kullanamıyorsanız, tamamen sıralı bir anahtarda orderby kullanmayı ve bunun yerine bir aralık sorgusuyla filtrelemeyi göz önünde bulundurun.
speller	QuerySpellerType	Tek tek arama sorgusu terimlerinin yazımını düzeltmek için kullanılacak yazım denetleyicisinin türünü belirten değer.
top	integer	Alınacak arama sonuçlarının sayısı. Bu, arama sonuçlarının istemci tarafı sayfalamasını uygulamak için $skip ile birlikte kullanılabilir. Sonuçlar sunucu tarafı sayfalama nedeniyle kesilirse, yanıt bir sonraki sonuç sayfası için başka bir Arama isteği göndermek için kullanılabilecek bir devamlılık belirteci içerir.
vectorFilterMode	VectorFilterMode	Vektör araması gerçekleştirilmeden önce veya sonra filtrelerin uygulanıp uygulanmayacağını belirler. Varsayılan değer 'preFilter'dır.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Vektör ve karma arama sorguları için sorgu parametreleri.

SearchResult

Arama sorgusu tarafından bulunan bir belgeyi ve ilişkili meta verileri içerir.

Name	Tür	Description
@search.captions	CaptionResult[]	Resim yazıları, belgeden arama sorgusuna göre en temsili metinlerdir. Bunlar genellikle belge özeti olarak kullanılır. Açıklamalı alt yazılar yalnızca 'semantik' türü sorgular için döndürülür.
@search.documentDebugInfo	DocumentDebugInfo[]	Arama sonuçlarınızı daha fazla araştırmak için kullanılabilecek hata ayıklama bilgilerini içerir.
@search.highlights	object	Geçerli her alana göre düzenlenmiş eşleşen arama terimlerini gösteren belgedeki metin parçaları; sorgu için isabet vurgulama etkinleştirilmediyse null.
@search.rerankerScore	number	En iyi arama sonuçları için anlamsal dereceleyici tarafından hesaplanan ilgi puanı. Arama sonuçlar önce RerankerScore ve ardından Puana göre sıralanır. RerankerScore yalnızca 'semantik' türünde sorgular için döndürülür.
@search.score	number	Sorgu tarafından döndürülen diğer belgelerle karşılaştırıldığında, belgenin ilgi puanı.

SemanticDebugInfo

Name	Tür	Description
contentFields	QueryResultDocumentSemanticField[]	Anlam zenginleştirme işlemine gönderilen içerik alanlarının yanı sıra bunların nasıl kullanıldığı
keywordFields	QueryResultDocumentSemanticField[]	Anlam zenginleştirme işlemine gönderilen anahtar sözcük alanları ve bunların nasıl kullanıldığı
rerankerInput	QueryResultDocumentRerankerInput	Anlam zenginleştirme işlemine gönderilen ham birleştirilmiş dizeler.
titleField	QueryResultDocumentSemanticField	Anlam zenginleştirme işlemine gönderilen başlık alanı ve nasıl kullanıldığı

SemanticErrorMode

Kullanıcının bir semantik çağrının tamamen başarısız olup olmayacağını veya kısmi sonuçlar döndürmesini (varsayılan) seçmesine izin verir.

Name	Tür	Description
fail	string	Anlamsal işleme adımı sırasında bir özel durum varsa, sorgu başarısız olur ve hataya bağlı olarak uygun HTTP kodunu döndürür.
partial	string	Anlamsal işleme başarısız olursa kısmi sonuçlar yine de döndürüler. Kısmi sonuçların tanımı, hangi semantik adımın başarısız olduğuna ve başarısızlığın nedeninin ne olduğuna bağlıdır.

SemanticErrorReason

Semantik derecelendirme isteği için kısmi yanıt döndürüldü nedeni.

Name	Tür	Description
capacityOverloaded	string	İstek kısıtlandı. Yalnızca temel sonuçlar döndürüldü.
maxWaitExceeded	string	'semanticMaxWaitInMilliseconds' ayarlandıysa ve semantik işleme süresi bu değeri aştıysa. Yalnızca temel sonuçlar döndürüldü.
transient	string	Anlamsal işlemin en az bir adımı başarısız oldu.

SemanticFieldState

Alanın semantik zenginleştirme işlemi için kullanılma biçimi (tamamen kullanılmış, kısmen kullanılmış veya kullanılmamış)

Name	Tür	Description
partial	string	Alan kısmen anlamsal zenginleştirme için kullanılmıştır.
unused	string	Alan anlam zenginleştirmesi için kullanılmadı.
used	string	Alan, anlam zenginleştirmesi için tamamen kullanılmıştır.

SemanticSearchResultsType

Anlamsal derecelendirme isteği için döndürülen kısmi yanıtın türü.

Name	Tür	Description
baseResults	string	Anlam zenginleştirmesi veya yeniden boyutlandırması olmayan sonuçlar.
rerankedResults	string	Sonuçlar, reranker modeliyle yeniden kaydedilmiştir ve anlamsal açıklamalı alt yazılar içerir. Bunlar hiçbir yanıt, yanıt vurgusu veya başlık vurgulama içermez.

Speller

Tek tek arama sorgusu terimlerini yazım düzelterek arama geri çağırmayı geliştirin.

Name	Tür	Description
lexicon	string	Yazım denetleyicisi queryLanguage parametresi tarafından belirtilen dil için statik bir sözlük kullanarak tek tek sorgu terimlerini düzeltir.
none	string	Yazım denetleyicisi etkinleştirilmedi.

VectorFilterMode

Vektör araması gerçekleştirilmeden önce veya sonra filtrelerin uygulanıp uygulanmayacağını belirler.

Name	Tür	Description
postFilter	string	Filtre, vektör sonuçları aday kümesi döndürüldükten sonra uygulanır. Filtre seçiciliğe bağlı olarak, bu durum 'k' parametresi tarafından istenenden daha az sonuç verebilir.
preFilter	string	Filtre, arama sorgusundan önce uygulanır.

VectorizableTextQuery

Vektörleştirilmesi gereken bir metin değeri sağlandığında vektör araması için kullanılacak sorgu parametreleri.

Name	Tür	Description
exhaustive	boolean	True olduğunda, vektör dizinindeki tüm vektörlerde kapsamlı bir k-en yakın komşu aramasını tetikler. Kesin eşleşmelerin kritik olduğu senaryolar için yararlıdır( örneğin, temel gerçeklik değerlerini belirleme).
fields	string	Aranan vektöre dahil edilecek Collection(Edm.Single) türünde Vektör Alanları.
k	integer	En çok isabet alan olarak döndürülecek en yakın komşu sayısı.
kind	string: text	Gerçekleştirilen vektör sorgusunun türü.
oversampling	number	Fazla örnekleme faktörü. En düşük değer 1'dir. Dizin tanımında yapılandırılan 'defaultOversampling' parametresini geçersiz kılar. Yalnızca 'rerankWithOriginalVectors' true olduğunda ayarlanabilir. Bu parametreye yalnızca temel alınan vektör alanında bir sıkıştırma yöntemi kullanıldığında izin verilir.
text	string	Vektör arama sorgusu gerçekleştirmek için vektörleştirilecek metin.

VectorQueryKind

Gerçekleştirilen vektör sorgusunun türü.

Name	Tür	Description
text	string	Vektörleştirilmesi gereken bir metin değerinin sağlandığı vektör sorgusu.
vector	string	Ham vektör değerinin sağlandığı vektör sorgusu.