Documents - Search Get

Hizmet:: Search Service

API Sürümü:: 2025-09-01

Dizindeki belgeleri arar.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2025-09-01

İ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}&searchFields={searchFields}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&api-version=2025-09-01&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}&debug={debug}

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ğerin true olarak ayarlanması performansı etkileyebilir. Döndürülen sayının yaklaşık bir değer olduğunu unutmayın.
$filter	query		string	Arama sorgusuna uygulanacak OData $filter ifadesi.
$orderby	query		string[]	Sonuçların sıralanacağı OData $orderby ifadeleri listesi. Her ifade bir alan adı veya geo.distance() ya da search.score() işlevlerine yapılan bir çağrı olabilir. Her ifadenin ardından artanı belirtmek için asc ve azalanı belirtmek için desc takip edilebilir. Varsayılan değer artan düzendir. Beraberlikler maç skorları ile bozulacaktır. OrderBy belirtilmezse, varsayılan sıralama düzeni belge eşleşme puanına göre azalan düzendir. En fazla 32 $orderby cümle olabilir.
$select	query		string[]	Alınacak alanların listesi. Belirtilmezse, şemada alınabilir olarak işaretlenen tüm alanlar dahil edilir.
$skip	query		integer (int32)	Atlanacak 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 tam olarak sıralanmış bir anahtarda kullanmayı ve bunun yerine bir aralık sorgusuyla $filter etmeyi düşünün.
$top	query		integer (int32)	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. 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 devamlılık belirteci içerir.
answers	query		QueryAnswerType	Bu parametre yalnızca sorgu türü .`semantic` Ayarlanırsa, sorgu en üst sıradaki belgelerdeki önemli pasajlardan ayıklanan yanıtları döndürür. Döndürülen yanıtların sayısı, kanal karakteri `\|` ve ardından yanıtlar parametre değerinden sonra gelen `count-<number of answers>` seçenek eklenerek yapılandırılabilir, örneğin `extractive\|count-3`. Varsayılan sayı 1'dir. Güven eşiği, boru karakteri `\|` ve ardından yanıtlar parametre değerinden sonra gelen `threshold-<confidence threshold>` seçenek eklenerek yapılandırılabilir, örneğin `extractive\|threshold-0.9`. Varsayılan eşik 0,7'dir.
captions	query		QueryCaptionType	Bu parametre yalnızca sorgu türü .`semantic` Ayarlanırsa, sorgu en yüksek dereceli belgelerdeki önemli pasajlardan ayıklanan resim yazılarını döndürür. Altyazılar olarak `extractive`ayarlandığında, vurgulama varsayılan olarak etkindir ve dikey çizgi karakterinin `\|` ardından aşağıdaki gibi `highlight-<true/false>`bir seçenek eklenerek `extractive\|highlight-true` yapılandırılabilir. Varsayılan olarak `None` değerini alır.
debug	query		QueryDebugMode	Arama sonuçlarınızı daha fazla araştırmak için kullanılabilecek bir hata ayıklama aracı sağlar.
facet	query		string[]	Arama sorgusuna uygulanacak model ifadelerinin listesi. Her model ifadesi bir alan adı içerir ve isteğe bağlı olarak virgülle ayrılmış bir ad:değer çiftleri listesi izler.
highlight	query		string[]	İsabet vurguları için kullanılacak alan adlarının listesi. İsabet vurgulama için yalnızca aranabilir alanlar kullanılabilir.
highlightPostTag	query		string	Vurguları vurmak için eklenen bir dize etiketi. highlightPreTag ile ayarlanmalıdır. Varsayılan değer /em'dir<>.
highlightPreTag	query		string	Öne çıkan noktalara basmak için başa eklenen bir dize etiketi. highlightPostTag ile ayarlanmalıdır. Varsayılan değer em'dir<>.
minimumCoverage	query		number (double)	0 ile 100 arasında, sorgunun başarılı olarak raporlanması için bir arama sorgusu tarafından kapsanması gereken dizin yüzdesini gösteren bir sayı. 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.
queryType	query		QueryType	Arama sorgusunun sözdizimini belirten bir değer. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu sözdizimini kullanıyorsa 'tam' kullanın.
scoringParameter	query		string[]	Puanlama işlevlerinde kullanılacak parametre değerlerinin listesi (örneğin, referencePointParameter) biçim name-values kullanılarak. Örneğin, puanlama profili 'mylocation' adlı bir parametreye sahip bir işlevi tanımlıyorsa, parametre dizesi "mylocation--122.2,44.8" (tırnak işaretleri olmadan) olur.
scoringProfile	query		string	Sonuçları sıralamak amacıyla eşleşen belgeler için eşleşme puanlarını değerlendirmek üzere bir puanlama profilinin adı.
scoringStatistics	query		ScoringStatistics	Puanlama istatistiklerini (belge sıklığı gibi) daha tutarlı puanlama için 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şmesi için "*" kullanın veya bu parametreyi atlayın.
searchFields	query		string[]	Tam metin aramasının kapsamının oluşturulacağı alan adlarının listesi. Tam bir Lucene sorgusunda alanlı arama (fieldName:searchExpression) kullanılırken, her alanlı arama ifadesinin alan adları, bu parametrede listelenen tüm 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şmesi gerekip gerekmediğini belirten bir değer.
semanticConfiguration	query		string	Anlamsal sıralama, resim 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ıya, bir anlamsal çağrının tamamen başarısız olup olmayacağını veya kısmi sonuçlar döndürüp döndürmeyeceğini (varsayılan) seçmesine izin verir.
semanticMaxWaitInMilliseconds	query		integer (int32) minimum: 700	Kullanıcının, istek başarısız olmadan önce anlamsal zenginleştirmenin işlemeyi tamamlaması için geçen süre için bir üst sınır ayarlamasına olanak tanır.
semanticQuery	query		string	Yalnızca anlamsal yeniden sıralama, anlamsal altyazılar ve anlamsal yanıtlar için kullanılacak ayrı bir arama sorgusu ayarlamaya izin verir. Temel alma ve sıralama aşaması ile L2 anlam aşaması arasında farklı sorgular kullanmanın gerekli olduğu 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 çaba denemesi yapılır. Aynı sessionID değerlerini tekrar tekrar kullanmanın, çoğaltmalar arasında isteklerin yük dengelemesini engelleyebileceğine ve arama hizmetinin performansını olumsuz etkileyebileceğine dikkat edin. sessionId olarak kullanılan değer '_' karakteriyle başlayamaz.

İ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 kriterlerine uyan belgeleri içeren yanıt.
Other Status Codes	SearchDocumentsResult	Arama kriterlerine uyan kısmi belgeler içeren yanıt.
Other Status Codes	ErrorResponse	Hata yanıtı.

Örnekler

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

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&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2025-09-01

Ö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"
    }
  ]
}

Durum kodu:: 206

{
  "@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"
    }
  ]
}

SearchIndexSearchDocumentsSemanticGet

Örnek isteği

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&api-version=2025-09-01&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}

Örnek yanıt

Durum kodu:: 200

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ]
}

Durum kodu:: 206

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ]
}

Tanımlar

Name	Description
AnswerResult	Yanıt, sorguyla eşleşen en ilgili belgelerin içeriğinden çıkarılan bir metin pasajıdır. Yanıtlar en iyi arama sonuçlarından çıkarılır. Cevap adayları puanlanır ve en iyi cevaplar seçilir.
CaptionResult	Altyazılar, belgeden arama sorgusuna göre en temsili pasajlardır. Genellikle belge özeti olarak kullanılırlar. Resim yazıları yalnızca şu türdeki `semantic`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ülüp döndürülmeyeceğini belirten bir değer.
QueryCaptionType	Resim yazılarının arama yanıtının bir parçası olarak döndürülüp 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ı sağlar.
QueryResultDocumentSubscores	Bu belge için arama sorgusunun metin ve vektör sorgusu bileşenleri arasındaki alt puanların dökümü. Her vektör sorgusu, alındıkları sırayla ayrı bir nesne olarak gösterilir.
QueryType	Arama sorgusunun sözdizimini belirtir. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu sözdizimini kullanıyorsa 'tam' kullanın.
RawVectorQuery	Ham bir vektör değeri sağlandığında vektör araması için kullanılacak sorgu parametreleri.
ScoringStatistics	Puanlama istatistiklerini (belge sıklığı gibi) daha tutarlı puanlama için 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' ifadesini kullanın. Genel puanlama istatistiklerinin kullanılması, arama sorgularının gecikme süresini artırabilir.
SearchDocumentsResult	Bir dizinden alınan 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, çok yönlülük, sayfalama ve diğer arama sorgusu davranışları için parametreler.
SearchResult	Bir arama sorgusu tarafından bulunan bir belgeyi ve ilişkili meta verileri içerir.
SemanticErrorMode	Kullanıcıya, bir anlamsal çağrının tamamen başarısız olup olmayacağını (varsayılan / geçerli davranış) veya kısmi sonuçlar döndürüp döndürmeyeceğini seçmesine izin verir.
SemanticErrorReason	Anlamsal sıralama isteği için kısmi bir yanıt döndürülmesinin nedeni.
SemanticSearchResultsType	Anlamsal sıralama isteği için döndürülen kısmi yanıtın türü.
SingleVectorFieldResult	Tek bir vektör alanı sonucu. Her ikisi de @search.score ve vektör benzerlik değerleri döndürülür. Vektör benzerliği bir denklem ile ilişkilidir @search.score .
TextResult	Sorgunun metin bölümü için BM25 veya Klasik puanı.
VectorFilterMode	Filtrelerin vektör araması yapılmadan önce mi yoksa sonra mı uygulanacağı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ü.
VectorsDebugInfo

AnswerResult

Nesne

Yanıt, sorguyla eşleşen en ilgili belgelerin içeriğinden çıkarılan bir metin pasajıdır. Yanıtlar en iyi arama sonuçlarından çıkarılır. Cevap adayları puanlanır ve en iyi cevaplar seçilir.

Name	Tür	Description
highlights	string	Text özelliğindekiyle aynı metin geçişi, sorguyla en ilgili vurgulanmış metin ifadeleriyle.
key	string	Cevabın çıkarıldığı 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 temsil eder.
text	string	Cevap olarak belge içeriğinden çıkarılan metin pasajı.

CaptionResult

Nesne

Altyazılar, belgeden arama sorgusuna göre en temsili pasajlardır. Genellikle belge özeti olarak kullanılırlar. Resim yazıları yalnızca şu türdeki semanticsorgular için döndürülür: .

Name	Tür	Description
highlights	string	Text özelliğindekiyle aynı metin geçişi, sorguyla en ilgili vurgulanmış tümceciklerle.
text	string	Arama sorgusuyla en alakalı belgeden çıkarılan temsili bir metin pasajı.

DocumentDebugInfo

Nesne

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

Name	Tür	Description
vectors	VectorsDebugInfo	Vektör ve karma aramaya ö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ülüp döndürülmeyeceğini belirten bir değer.

Değer	Description
none	Sorgu için yanıtlar döndürme.
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

Resim yazılarının arama yanıtının bir parçası olarak döndürülüp döndürülmeyeceğini belirten bir değer.

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

QueryDebugMode

Numaralandırma

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

Değer	Description
disabled	Hiçbir sorgu hata ayıklama bilgisi döndürülmez.
vector	Kullanıcının hibrit ve vektör sorgu sonuçlarını daha fazla keşfetmesine olanak tanır.

QueryResultDocumentSubscores

Nesne

Bu belge için arama sorgusunun metin ve vektör sorgusu bileşenleri arasındaki alt puanların dökümü. Her vektör sorgusu, alındıkları sırayla ayrı bir nesne olarak gösterilir.

Name	Tür	Description
documentBoost	number (double)	Sorgunun metin bölümü için BM25 veya Klasik puanı.
text	TextResult	Sorgunun metin bölümü için BM25 veya Klasik puanı.
vectors	<string, SingleVectorFieldResult>	Her vektör sorgusu için vektör benzerliği ve @search.score değerleri.

QueryType

Numaralandırma

Arama sorgusunun sözdizimini belirtir. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu sözdizimini kullanıyorsa 'tam' kullanın.

Değer	Description
simple	Aramalar için basit sorgu sözdizimini kullanır. Arama metni, +, * ve "" gibi sembollere izin veren basit bir sorgu dili kullanılarak yorumlanır. Sorgular, searchFields parametresi belirtilmediği sürece varsayılan olarak tüm aranabilir alanlarda değerlendirilir.
full	Aramalar için tam Lucene sorgu sözdizimini kullanır. Arama metni, alana özgü ve ağırlıklı aramaların yanı sıra diğer gelişmiş özelliklere izin veren Lucene sorgu dili kullanılarak yorumlanır.
semantic	Anahtar kelimelerin aksine doğal dilde ifade edilen sorgular için en uygunudur. Web külliyatı üzerinde eğitilmiş bir sıralama modeli kullanarak en iyi arama sonuçlarını yeniden sıralayarak arama sonuçlarının kesinliğini artırır.

RawVectorQuery

Nesne

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

Name	Tür	Description
exhaustive	boolean	Doğru olduğunda, vektör indeksindeki tüm vektörler arasında kapsamlı bir k-en yakın komşu aramasını tetikler. Temel doğruluk değerlerini belirleme gibi tam eşleşmelerin kritik olduğu senaryolar için kullanışlıdır.
fields	string	Aranan vektöre dahil edilecek Collection(Edm.Single) türündeki Vektör Alanları.
k	integer (int32)	En çok isabet alan olarak geri dönülecek en yakın komşu sayısı.
kind	string: vector	Gerçekleştirilen vektör sorgusunun türü.
oversampling	number (double)	Aşırı ö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' doğru olduğunda ayarlanabilir. Bu parametreye yalnızca alttaki vektör alanında bir sıkıştırma yöntemi kullanıldığında izin verilir.
vector	number[] (float)	Bir arama sorgusunun vektör gösterimi.
weight	number (float)	Vektör sorgusunun, diğer vektör sorgusuyla ve/veya aynı arama isteğindeki metin sorgusuyla karşılaştırıldığında göreli ağırlığı. Bu değer, farklı vektör sorguları tarafından üretilen birden çok sıralama listesinin sonuçları ve/veya metin sorgusu aracılığıyla alınan sonuçlar birleştirilirken kullanılır. Ağırlık ne kadar yüksek olursa, o sorguyla eşleşen belgeler son sıralamada o kadar yüksek olur. Varsayılan değer 1.0'dır ve değerin sıfırdan büyük pozitif bir sayı olması gerekir.

ScoringStatistics

Numaralandırma

Puanlama istatistiklerini (belge sıklığı gibi) daha tutarlı puanlama için 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' ifadesini 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 küresel olarak hesaplanacaktır.

SearchDocumentsResult

Nesne

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

Name	Tür	Description
@odata.count	integer (int64)	Arama işlemi tarafından bulunan sonuçların toplam sayısı veya sayım istenmediyse null olur. Varsa, sayı bu yanıttaki sonuç sayısından daha büyük olabilir. Bu durum, $top veya $skip parametrelerini kullanırsanız veya 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üremediğinde döndürülen devamlılık URL'si. Arama yanıtının sonraki bölümünü almak üzere başka bir GET veya POST Search 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 yanıtlar sorgu sonuçları; Yanıtlar sorgu parametresi belirtilmemişse veya 'none' olarak ayarlanmışsa null.
@search.coverage	number (double)	Sorguya dahil edilen dizinin yüzdesini gösteren bir değer veya istekte minimumCoverage belirtilmemişse null değer.
@search.facets	object	Arama işlemi için model sorgusu sonuçları, her yönlü alan için bir demet koleksiyonu olarak düzenlenir; Sorgu herhangi bir model ifadesi içermiyorsa null.
@search.nextPageParameters	SearchRequest	Sorgu istenen tüm sonuçları tek bir yanıtta döndüremediğinde döndürülen devam JSON yükü. Arama yanıtının sonraki bölümünü almak için başka bir POST Arama isteği formüle etmek için bu JSON'u @odata.nextLink kullanabilirsiniz.
@search.semanticPartialResponseReason	SemanticErrorReason	Anlamsal sıralama isteği için kısmi bir yanıt döndürülmesinin nedeni.
@search.semanticPartialResponseType	SemanticSearchResultsType	Anlamsal sıralama 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çların sırası.

SearchMode

Numaralandırma

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

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

SearchRequest

Nesne

Filtreleme, sıralama, çok yönlülük, 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ülüp döndürülmeyeceğini belirten bir değer.
captions	QueryCaptionType	Resim yazılarının arama yanıtının bir parçası olarak döndürülüp 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ğerin true olarak ayarlanması performansı etkileyebilir. Döndürülen sayının yaklaşık bir değer olduğunu unutmayın.
debug	QueryDebugMode	Yeniden sıralanan sonuçlarınızı daha fazla keşfetmek için kullanılabilecek bir hata ayıklama aracını etkinleştirir.
facets	string[]	Arama sorgusuna uygulanacak model ifadelerinin listesi. Her model ifadesi bir alan adı içerir ve isteğe bağlı olarak virgülle ayrılmış bir ad:değer çiftleri listesi izler.
filter	string	Arama sorgusuna uygulanacak OData $filter ifadesi.
highlight	string	İsabet vurguları için kullanılacak alan adlarının virgülle ayrılmış listesi. İsabet vurgulama için yalnızca aranabilir alanlar kullanılabilir.
highlightPostTag	string	Vurguları vurmak için eklenen bir dize etiketi. highlightPreTag ile ayarlanmalıdır. Varsayılan değer /em'dir<>.
highlightPreTag	string	Öne çıkan noktalara basmak için başa eklenen bir dize etiketi. highlightPostTag ile ayarlanmalıdır. Varsayılan değer em'dir<>.
minimumCoverage	number (double)	0 ile 100 arasında, sorgunun başarılı olarak raporlanması için bir arama sorgusu tarafından kapsanması gereken dizin yüzdesini gösteren bir sayı. 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ıralanacağı ifadeleri $orderby için virgülle ayrılmış OData listesi. Her ifade bir alan adı veya geo.distance() ya da search.score() işlevlerine yapılan bir çağrı olabilir. Her ifadenin ardından artanı belirtmek için asc veya azalan ifadeyi belirtmek için desc takip edebilir. Varsayılan değer artan düzendir. Beraberlikler maç skorları ile bozulacaktır. Herhangi bir $orderby belirtilmezse, varsayılan sıralama düzeni belge eşleşme puanına göre azalan düzendir. En fazla 32 $orderby cümle olabilir.
queryType	QueryType	Arama sorgusunun sözdizimini belirten bir değer. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu sözdizimini kullanıyorsa 'tam' kullanın.
scoringParameters	string[]	Puanlama işlevlerinde kullanılacak parametre değerlerinin listesi (örneğin, referencePointParameter) biçim name-values kullanılarak. Örneğin, puanlama profili 'mylocation' adlı bir parametreye sahip bir işlevi tanımlıyorsa, parametre dizesi "mylocation--122.2,44.8" (tırnak işaretleri olmadan) olur.
scoringProfile	string	Sonuçları sıralamak amacıyla eşleşen belgeler için eşleşme puanlarını değerlendirmek üzere bir puanlama profilinin adı.
scoringStatistics	ScoringStatistics	Puanlama istatistiklerini (belge sıklığı gibi) daha tutarlı puanlama için 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' ifadesini 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şmesi için "*" kullanın veya bu parametreyi atlayın.
searchFields	string	Tam metin aramasının kapsamının oluşturulacağı alan adlarının virgülle ayrılmış listesi. Tam bir Lucene sorgusunda alanlı arama (fieldName:searchExpression) kullanılırken, her alanlı arama ifadesinin alan adları, bu parametrede listelenen tüm 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şmesi gerekip gerekmediğini belirten bir değer.
select	string	Alınacak alanların virgülle ayrılmış listesi. Belirtilmezse, şemada alınabilir olarak işaretlenen tüm alanlar dahil edilir.
semanticConfiguration	string	Semantik türündeki sorgular için belgeler işlenirken kullanılacak anlamsal yapılandırmanın adı.
semanticErrorHandling	SemanticErrorMode	Kullanıcıya, bir anlamsal çağrının tamamen başarısız olup olmayacağını (varsayılan / geçerli davranış) veya kısmi sonuçlar döndürüp döndürmeyeceğini seçmesine izin verir.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Kullanıcının, istek başarısız olmadan önce anlamsal zenginleştirmenin işlemeyi tamamlaması için geçen süre için bir üst sınır ayarlamasına olanak tanır.
semanticQuery	string	Yalnızca anlamsal yeniden sıralama, anlamsal altyazılar ve anlamsal yanıtlar için kullanılacak ayrı bir arama sorgusu ayarlamaya izin verir. Temel alma ve sıralama aşaması ile L2 anlam aşaması arasında farklı sorgular kullanmanın gerekli olduğu 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 bir değer. Aynı sessionId kullanıldığı sürece, aynı çoğaltma kümesini hedeflemek için en iyi çaba denemesi yapılır. Aynı sessionID değerlerini tekrar tekrar kullanmanın, çoğaltmalar arasında isteklerin yük dengelemesini engelleyebileceğine ve arama hizmetinin performansını olumsuz etkileyebileceğine dikkat edin. sessionId olarak kullanılan değer '_' karakteriyle başlayamaz.
skip	integer (int32)	Atlanacak 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.
top	integer (int32)	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. 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 devamlılık belirteci içerir.
vectorFilterMode	VectorFilterMode	Filtrelerin vektör araması yapılmadan önce mi yoksa sonra mı uygulanacağını belirler. Yeni dizinler için varsayılan değer 'preFilter'dır.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Vektör ve karma arama sorguları için sorgu parametreleri.

SearchResult

Nesne

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

Name	Tür	Description
@search.captions	CaptionResult[]	Altyazılar, belgeden arama sorgusuna göre en temsili pasajlardır. Genellikle belge özeti olarak kullanılırlar. Resim yazıları yalnızca 'semantic' türündeki 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	Belgeden, eşleşen arama terimlerini gösteren, her bir geçerli alana göre düzenlenmiş metin parçaları; Sorgu için isabet vurgulama etkinleştirilmemişse null.
@search.rerankerBoostedScore	number (double)	Yeniden Sıralayıcı Puanı artırılarak hesaplanan alaka düzeyi puanı. Arama sonuçları, Semantic Config'deki useScoringProfileBoostedRanking'e göre RerankerScore/RerankerBoostedScore'a göre sıralanır. RerankerBoostedScore yalnızca 'semantic' türündeki sorgular için döndürülür
@search.rerankerScore	number (double)	En iyi arama sonuçları için anlamsal sıralayıcı tarafından hesaplanan alaka düzeyi puanı. Arama sonuçları önce RerankerScore'a ve ardından Score'a göre sıralanır. RerankerScore yalnızca 'semantic' türündeki 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 alaka puanı.

SemanticErrorMode

Numaralandırma

Kullanıcıya, bir anlamsal çağrının tamamen başarısız olup olmayacağını (varsayılan / geçerli davranış) veya kısmi sonuçlar döndürüp döndürmeyeceğini 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ülür. Kısmi sonuçların tanımı, hangi anlamsal 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 sıralama isteği için kısmi bir yanıt döndürülmesinin nedeni.

Değer	Description
maxWaitExceeded	ayarlandıysa ve anlamsal işleme süresi bu değeri aştıysa `semanticMaxWaitInMilliseconds` . 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 sürecin en az bir adımı başarısız oldu.

SemanticSearchResultsType

Numaralandırma

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

Değer	Description
baseResults	Herhangi bir anlamsal zenginleştirme veya yeniden sıralama olmadan sonuçlar.
rerankedResults	Sonuçlar, yeniden sıralayıcı modeliyle yeniden sıralandı ve anlamsal altyazıları içerecek. Herhangi bir yanıt, yanıt vurgusu veya altyazı vurgusu içermezler.

SingleVectorFieldResult

Nesne

Tek bir vektör alanı sonucu. Her ikisi de @search.score ve vektör benzerlik değerleri döndürülür. Vektör benzerliği bir denklem ile ilişkilidir @search.score .

Name	Tür	Description
searchScore	number (double)	Vektör @search.score benzerlik puanından hesaplanan değer. Bu, saf tek alanlı tek vektörlü bir sorguda görünen puandır.
vectorSimilarity	number (double)	Bu belge için vektör benzerlik puanı. Bunun, benzerlik metriğinin kurallı tanımı olduğunu, 'mesafe' sürümü olmadığını unutmayın. Örneğin, kosinüs mesafesi yerine kosinüs benzerliği.

TextResult

Nesne

Sorgunun metin bölümü için BM25 veya Klasik puanı.

Name	Tür	Description
searchScore	number (double)	Sorgunun metin bölümü için BM25 veya Klasik puanı.

VectorFilterMode

Numaralandırma

Filtrelerin vektör araması yapılmadan önce mi yoksa sonra mı uygulanacağını belirler.

Değer	Description
postFilter	Filtre, vektör sonuçları aday kümesi döndürüldükten sonra uygulanacaktır. Filtre seçiciliğine bağlı olarak bu, 'k' parametresi tarafından istenenden daha az sonuçla sonuçlanabilir.
preFilter	Filtre, arama sorgusundan önce uygulanacaktı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	Doğru olduğunda, vektör indeksindeki tüm vektörler arasında kapsamlı bir k-en yakın komşu aramasını tetikler. Temel doğruluk değerlerini belirleme gibi tam eşleşmelerin kritik olduğu senaryolar için kullanışlıdır.
fields	string	Aranan vektöre dahil edilecek Collection(Edm.Single) türündeki Vektör Alanları.
k	integer (int32)	En çok isabet alan olarak geri dönülecek en yakın komşu sayısı.
kind	string: text	Gerçekleştirilen vektör sorgusunun türü.
oversampling	number (double)	Aşırı ö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' doğru olduğunda ayarlanabilir. Bu parametreye yalnızca alttaki vektör alanında bir sıkıştırma yöntemi kullanıldığında izin verilir.
text	string	Bir vektör arama sorgusu gerçekleştirmek için vektörleştirilecek metin.
weight	number (float)	Vektör sorgusunun, diğer vektör sorgusuyla ve/veya aynı arama isteğindeki metin sorgusuyla karşılaştırıldığında göreli ağırlığı. Bu değer, farklı vektör sorguları tarafından üretilen birden çok sıralama listesinin sonuçları ve/veya metin sorgusu aracılığıyla alınan sonuçlar birleştirilirken kullanılır. Ağırlık ne kadar yüksek olursa, o sorguyla eşleşen belgeler son sıralamada o kadar yüksek olur. Varsayılan değer 1.0'dır ve değerin sıfırdan büyük pozitif bir sayı olması gerekir.

VectorQueryKind

Numaralandırma

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

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

VectorsDebugInfo

Nesne

Name	Tür	Description
subscores	QueryResultDocumentSubscores	RRF gibi seçilen sonuç kümesi füzyon/kombinasyon yönteminden önce belgenin alt puanlarının dökümü.