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 bir yaklaşık değer 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ğlar, belgelerin eşleşme puanlarıyla bozulur. 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. Belirtilmezse, ş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, $orderby tamamen sıralı bir anahtarda kullanmayı ve bunun yerine bir 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. Sunucu tarafı sayfalama nedeniyle sonuçlar kesilirse yanıt, sonraki sonuç sayfası için başka bir Arama isteği göndermek için kullanılabilecek bir devam belirteci içerir.
answers	query		QueryAnswerType	Bu parametre yalnızca sorgu türü `semantic`ise geçerlidir. Ayarlanırsa, sorgu en yüksek dereceli belgelerdeki anahtar geçitlerden ayıklanan yanıtları döndürür. Döndürülen yanıt sayısı, `\|`gibi yanıt parametresi değerinden sonra `count-<number of answers>` seçeneğinin ardından `extractive\|count-3` kanal karakteri eklenerek yapılandırılabilir. Varsayılan sayı 1'dir. Güvenilirlik eşiği, `\|`gibi yanıt parametresi değerinden sonra `threshold-<confidence threshold>` seçeneğinin ardından `extractive\|threshold-0.9` kanal karakteri eklenerek yapılandırılabilir. Varsayılan eşik 0,7'dir.
captions	query		QueryCaptionType	Bu parametre yalnızca sorgu türü `semantic`ise geçerlidir. Ayarlanırsa, sorgu en yüksek dereceli belgelerdeki anahtar geçitlerden ayıklanan açıklamalı alt yazıları döndürür. Resim yazıları `extractive`olarak ayarlandığında, vurgulama varsayılan olarak etkinleştirilir ve `\|`gibi `highlight-<true/false>` seçeneği `extractive\|highlight-true` eklenerek yapılandırılabilir. Varsayılan değer `None` olarak ayarlanır.
debug	query		QueryDebugMode	Arama sonuçlarınızı daha fazla incelemek için kullanılabilecek bir hata ayıklama aracı 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[]	İsabet vurguları için kullanılacak alan adlarının listesi. Yalnızca aranabilir alanlar isabet vurgulama için kullanılabilir.
highlightPostTag	query		string	Vurgulamalara isabet etmek için eklenen bir dize etiketi. HighlightPreTag ile ayarlanmalıdır. Varsayılan değer </em>değeridir.
highlightPreTag	query		string	Vurgulamalara basmak için önceden eklenen bir dize etiketi. highlightPostTag ile ayarlanmalıdır. Varsayılan değer, em<>.
minimumCoverage	query		number (double)	0 ile 100 arasında bir sayı, sorgunun başarılı olarak bildirilebilmesi için bir arama sorgusu tarafından kapsanması gereken dizinin yüzdesini gösterir. 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 değer. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu söz dizimini kullanıyorsa 'full' kullanın.
scoringParameter	query		string[]	Ad-değer 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 maç 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 atlar.
searchFields	query		string[]	Tam metin aramasının kapsamına dahil edilen alan adlarının listesi. Tam Lucene sorgusunda alanlı arama (fieldName:searchExpression) kullanıldığında, 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 terimlerinden herhangi birinin veya tümünün eşleştirilip eşleştirilmeyeceğini belirten bir değer.
semanticConfiguration	query		string	Semantik derecelendirme, 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[]	Anlamsal derecelendirme için kullanılan alan adlarının listesi.
semanticMaxWaitInMilliseconds	query		integer (int32) minimum: 700	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, semantik 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 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 değer. Aynı sessionId kullanıldığı sürece, aynı çoğaltma kümesini hedeflemek için en iyi girişimde 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.
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çeriklerinden 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 bölümlerdir. Bunlar genellikle belge özeti olarak kullanılır. Resim yazıları yalnızca 'semantik' türünde sorgular için döndürülür...
DocumentDebugInfo	Arama sonuçlarınızı daha fazla incelemek 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ülmesi gerekip gerekmediğini belirten bir değer.
QueryDebugMode	Arama sonuçlarınızı daha fazla incelemek için kullanılabilecek bir hata ayıklama aracı 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 terimlerini yazım denetimi yapmak 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 gerekli değilse '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 'genel' 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ştirilip eşleştirilmeyeceğini belirtir.
SearchRequest	Filtreleme, sıralama, yüz tanıma, 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	Anlamsal derecelendirme isteği için kısmi yanıt döndürüldü nedeni.
SemanticFieldState	Alanın anlam 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 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 sorgusu türü.

AnswerResult

Nesne

Yanıt, sorguyla eşleşen en ilgili belgelerin içeriklerinden 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 ifadelerinin vurgulandığı Text özelliğindeki metin metniyle aynı metin metni.
key	string	Yanıtın ayıklandığı belgenin anahtarı.
score	number (double)	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

Nesne

Resim yazıları, belgeden arama sorgusuna göre en temsili bölümlerdir. Bunlar genellikle belge özeti olarak kullanılır. Resim 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ğindeki metin metniyle aynı metin metni.
text	string	Arama sorgusuyla en ilgili belgeden ayıklanan temsili metin metni.

DocumentDebugInfo

Nesne

Arama sonuçlarınızı daha fazla incelemek 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

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.

QueryAnswerType

Numaralandırma

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.

Değer	Description
none	Sorgunun yanıtlarını döndürmeyin.
extractive	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.

QueryCaptionType

Numaralandırma

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

Değer	Description
none	Sorgu için açıklamalı alt yazı döndürmeyin.
extractive	Arama sorgusuyla ilgili bölümleri içeren eşleşen belgelerden resim yazılarını ayıklar.

QueryDebugMode

Numaralandırma

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

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

QueryLanguage

Numaralandırma

Sorgunun dili.

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

QueryResultDocumentRerankerInput

Nesne

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ının ham birleştirilmiş dizeleri.
keywords	string	Anlam zenginleştirmesi için kullanılan anahtar sözcük alanları için ham birleştirilmiş dizeler.
title	string	Anlam zenginleştirme için kullanılan başlık alanının ham dizesi.

QueryResultDocumentSemanticField

Nesne

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 anlam zenginleştirme işlemi için kullanılma biçimi (tamamen kullanılmış, kısmen kullanılmış veya kullanılmamış)

QuerySpellerType

Numaralandırma

Tek tek arama sorgusu terimlerini yazım denetimi yapmak için kullanılacak yazım denetleyicisinin türünü belirten değer.

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

QueryType

Numaralandırma

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 gerekli değilse 'semantik' kullanın.

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

RawVectorQuery

Nesne

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 en yakın k komşu aramasını tetikler. Tam eşleşmelerin kritik olduğu senaryolar için yararlıdır( örneğin, zemin gerçeği değerlerini belirleme).
fields	string	Vektör aramasına eklenecek alan adlarının virgülle ayrılmış listesi. Alanların her biri Collection(Edm.Single) gibi geçerli bir vektör türü olmalıdır. Birden çok alan verilirse, vektör tüm alanlardaki en yakın eşleşmeleri bulmak için kullanılır.
k	integer (int32)	En çok isabet alan olarak döndürülecek en yakın komşu sayısı.
kind	string: vector	Gerçekleştirilen vektör sorgusu türü.
oversampling	number (double)	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[] (float)	Arama sorgusunun vektör gösterimi.

ScoringStatistics

Numaralandırma

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 'genel' kullanın. Genel puanlama istatistiklerinin kullanılması, arama sorgularının gecikme süresini artırabilir.

Değer	Description
local	Puanlama istatistikleri daha düşük gecikme süresi için yerel olarak hesaplanır.
global	Puanlama istatistikleri, daha tutarlı puanlama için genel olarak hesaplanır.

SearchDocumentsResult

Nesne

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

Name	Tür	Description
@odata.count	integer (int64)	Arama işlemi tarafından bulunan toplam sonuç sayısı veya sayı istenmediyse null. Varsa, sayı bu yanıttaki sonuç sayısından büyük olabilir. $top veya $skip parametrelerini kullanırsanız veya sorgu istenen tüm belgeleri tek bir yanıtta döndüremezse bu durum oluşabilir.
@odata.nextLink	string	Sorgu istenen tüm sonuçları tek bir yanıtta döndüremediğinde devam URL'si döndürülür. Arama yanıtının bir 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şleminin yanıt sorgu sonuçları; yanıt sorgu parametresi belirtilmediyse veya 'yok' olarak ayarlandıysa null.
@search.coverage	number (double)	Sorguya dahil edilen dizinin yüzdesini gösteren bir değer veya istekte minimumCoverage belirtilmediyse null.
@search.facets	object	Her modelli alan için demet koleksiyonu olarak düzenlenmiş arama işleminin model sorgusu sonuçları; null değeriyle karşılaşırsanız, sorgu hiçbir model ifadesi içermiyorsa.
@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 bir sonraki bölümünü almak üzere başka bir POST Search isteği formüle etmek için bu JSON ile birlikte @odata.nextLink kullanabilirsiniz.
@search.semanticPartialResponseReason	SemanticErrorReason	Anlamsal 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 türü.
value	SearchResult[]	Sorgu tarafından döndürülen sonuç dizisi.

SearchMode

Numaralandırma

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

Değer	Description
any	Belgeyi eşleşme olarak saymak için arama terimlerinden herhangi birinin eşleşmesi gerekir.
all	Belgeyi eşleşme olarak saymak için tüm arama terimlerinin eşleşmesi gerekir.

SearchRequest

Nesne

Filtreleme, sıralama, yüz tanıma, 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ülmesi gerekip gerekmediğ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 bir yaklaşık değer olduğunu unutmayın.
debug	QueryDebugMode	Yeniden kaydedilen sonuçlarınızı daha fazla incelemek için kullanılabilecek bir hata ayıklama aracı etkinleştirir.
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	Vurgulama vurguları için kullanılacak alan adlarının virgülle ayrılmış listesi. Yalnızca aranabilir alanlar isabet vurgulama için kullanılabilir.
highlightPostTag	string	Vurgulamalara isabet etmek için eklenen bir dize etiketi. HighlightPreTag ile ayarlanmalıdır. Varsayılan değer </em>değeridir.
highlightPreTag	string	Vurgulamalara basmak için önceden eklenen bir dize etiketi. highlightPostTag ile ayarlanmalıdır. Varsayılan değer, em<>.
minimumCoverage	number (double)	0 ile 100 arasında bir sayı, sorgunun başarılı olarak bildirilebilmesi için bir arama sorgusu tarafından kapsanması gereken dizinin yüzdesini gösterir. 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 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ğlar, belgelerin eşleşme puanlarıyla bozulur. $orderby belirtilmezse, varsayılan sıralama düzeni belge eşleşme puanına göre azalan düzendedir. En fazla 32 $orderby yan tümcesi olabilir.
queryLanguage	QueryLanguage	Arama sorgusunun dilini belirten değer.
queryType	QueryType	Arama sorgusunun söz dizimini belirten değer. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu söz dizimini kullanıyorsa 'full' kullanın.
scoringParameters	string[]	Ad-değer 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	string	Sonuçları sıralamak için eşleşen belgeler için maç 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 'genel' 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 atlar.
searchFields	string	Tam metin aramasının kapsamına dahil edilen alan adlarının virgülle ayrılmış listesi. Tam Lucene sorgusunda alanlı arama (fieldName:searchExpression) kullanıldığında, 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 derecelendirmesi için kullanılan alan adlarının virgülle ayrılmış listesi.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	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	string	Yalnızca anlamsal yeniden boyutlandırma, semantik 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 kullanışlıdır.
sessionId	string	Daha tutarlı sonuçlar elde etmeye yardımcı olabilecek yapışkan bir oturum oluşturmak için kullanılacak değer. Aynı sessionId kullanıldığı sürece, aynı çoğaltma kümesini hedeflemek için en iyi girişimde 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 (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 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 terimlerini yazım denetimi yapmak için kullanılacak yazım denetleyicisinin türünü belirten değer.
top	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. Sunucu tarafı sayfalama nedeniyle sonuçlar kesilirse yanıt, sonraki sonuç sayfası için başka bir Arama isteği göndermek için kullanılabilecek bir devam 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

Nesne

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 bölümlerdir. Bunlar genellikle belge özeti olarak kullanılır. Resim yazıları yalnızca 'semantik' türünde sorgular için döndürülür.
@search.documentDebugInfo	DocumentDebugInfo[]	Arama sonuçlarınızı daha fazla incelemek için kullanılabilecek hata ayıklama bilgilerini içerir.
@search.highlights	object	Uygun 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 değeri.
@search.rerankerScore	number (double)	En iyi arama sonuçları için anlamsal dereceleyici tarafından hesaplanan ilgi puanı. Arama sonuçları önce RerankerScore'a ve ardından Puana göre sıralanır. RerankerScore yalnızca 'semantic' türünde sorgular için döndürülür.
@search.score	number (double)	Sorgu tarafından döndürülen diğer belgelerle karşılaştırıldığında, belgenin ilgi puanı.

SemanticDebugInfo

Nesne

Name	Tür	Description
contentFields	QueryResultDocumentSemanticField[]	Anlam zenginleştirme işlemine gönderilen içerik alanları ve 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ıkları
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

Numaralandırma

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.

Değer	Description
partial	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.
fail	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.

SemanticErrorReason

Numaralandırma

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

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

SemanticFieldState

Numaralandırma

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

Değer	Description
used	Alan, anlam zenginleştirmesi için tamamen kullanılmıştır.
unused	Alan semantik zenginleştirme için kullanılmadı.
partial	Bu alan kısmen anlam zenginleştirmesi için kullanılmıştır.

SemanticSearchResultsType

Numaralandırma

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

Değer	Description
baseResults	Herhangi bir anlam zenginleştirme veya yeniden boyutlandırma olmadan sonuçlar.
rerankedResults	Sonuçlar reranker modeliyle yeniden kaydedilmiştir ve anlamsal açıklamalı alt yazılar içerir. Hiçbir yanıt, yanıt vurgusu veya resim yazısı vurgusu içermez.

Speller

Numaralandırma

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

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

VectorFilterMode

Numaralandırma

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

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

VectorizableTextQuery

Nesne

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 en yakın k komşu aramasını tetikler. Tam eşleşmelerin kritik olduğu senaryolar için yararlıdır( örneğin, zemin gerçeği değerlerini belirleme).
fields	string	Vektör aramasına eklenecek alan adlarının virgülle ayrılmış listesi. Alanların her biri Collection(Edm.Single) gibi geçerli bir vektör türü olmalıdır. Birden çok alan verilirse, vektör tüm alanlardaki en yakın eşleşmeleri bulmak için kullanılır.
k	integer (int32)	En çok isabet alan olarak döndürülecek en yakın komşu sayısı.
kind	string: text	Gerçekleştirilen vektör sorgusu türü.
oversampling	number (double)	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

Numaralandırma

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

Değer	Description
vector	Ham vektör değerinin sağlandığı vektör sorgusu.
text	Vektörleştirilmesi gereken bir metin değerinin sağlandığı vektör sorgusu.