Documents - Search Get

Başvuru

Hizmet:: Search Service

API Sürümü:: 2024-07-01

Dizindeki belgeleri arar.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-07-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=2024-07-01&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}

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ı, `extractive\|count-3`gibi yanıt parametresi değerinden sonra `count-<number of answers>` seçeneğinin ardından `\|` kanal karakteri eklenerek yapılandırılabilir. Varsayılan sayı 1'dir. Güvenilirlik eşiği, `extractive\|threshold-0.9`gibi yanıt parametresi değerinden sonra `threshold-<confidence threshold>` seçeneğinin ardından `\|` 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 `extractive\|highlight-true`gibi `highlight-<true/false>` seçeneği `\|` eklenerek yapılandırılabilir. varsayılan olarak `None`.
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.
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.
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, 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.

İ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

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=2024-07-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"
    }
  ]
}

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=2024-07-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"
      ]
    }
  ]
}

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 `semantic`türünde sorgular için döndürülür.
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.
QueryType	Arama sorgusunun söz dizimini belirtir. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu söz dizimini kullanıyorsa 'full' 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.
SemanticErrorMode	Kullanıcının bir semantik çağrının tamamen başarısız olup olmayacağını (varsayılan/ geçerli davranış) veya kısmi sonuçlar döndürmeyi seçmesine izin verir.
SemanticErrorReason	Anlamsal derecelendirme isteği için kısmi yanıt döndürüldü nedeni.
SemanticSearchResultsType	Anlamsal derecelendirme isteği için döndürülen kısmi yanıt türü.
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

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	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 bölümlerdir. Bunlar genellikle belge özeti olarak kullanılır. Resim yazıları yalnızca semantictü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.

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ülmesi gerekip gerekmediğini belirten bir değer.

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

QueryType

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

Name	Tür	Description
full	string	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	string	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.
simple	string	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.

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 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	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 sorgusu 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.
weight	number	Aynı arama isteğindeki diğer vektör sorgusu ve/veya metin sorgusuyla karşılaştırıldığında vektör sorgusunun göreli ağırlığı. Bu değer, farklı vektör sorguları ve/veya metin sorgusu aracılığıyla alınan sonuçlar tarafından üretilen birden çok derecelendirme listesinin sonuçları birleştirildiğinde kullanılır. Ağırlık ne kadar yüksek olursa, bu sorguyla eşleşen belgeler son derecelendirmede 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

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.

Name	Tür	Description
global	string	Puanlama istatistikleri, daha tutarlı puanlama için 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 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	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

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.

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, 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.
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	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.
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ı (varsayılan/ geçerli davranış) veya kısmi sonuçlar döndürmeyi seçmesine izin verir.
semanticMaxWaitInMilliseconds	integer	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	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.
top	integer	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, yeni dizinler için '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 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.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	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	Sorgu tarafından döndürülen diğer belgelerle karşılaştırıldığında, belgenin ilgi puanı.

SemanticErrorMode

Kullanıcının bir semantik çağrının tamamen başarısız olup olmayacağını (varsayılan/ geçerli davranış) veya kısmi sonuçlar döndürmeyi 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

Anlamsal 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 anlamsal 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.

SemanticSearchResultsType

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

Name	Tür	Description
baseResults	string	Herhangi bir anlam zenginleştirme veya yeniden boyutlandırma olmadan sonuçlar.
rerankedResults	string	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.

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, 'k' parametresi tarafından istenenden daha az sonuçla sonuçlanabilir.
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 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	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 sorgusu 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.
weight	number	Aynı arama isteğindeki diğer vektör sorgusu ve/veya metin sorgusuyla karşılaştırıldığında vektör sorgusunun göreli ağırlığı. Bu değer, farklı vektör sorguları ve/veya metin sorgusu aracılığıyla alınan sonuçlar tarafından üretilen birden çok derecelendirme listesinin sonuçları birleştirildiğinde kullanılır. Ağırlık ne kadar yüksek olursa, bu sorguyla eşleşen belgeler son derecelendirmede 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

Gerçekleştirilen vektör sorgusu 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.

Aracılığıyla paylaş

Documents - Search Get

URI Parametreleri

İstek Başlığı

Yanıtlar

Örnekler

SearchIndexSearchDocumentsGet

Örnek isteği

Örnek yanıt

SearchIndexSearchDocumentsSemanticGet

Örnek isteği

Örnek yanıt

Tanımlar

AnswerResult

CaptionResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryAnswerType

QueryCaptionType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

VectorFilterMode

VectorizableTextQuery

VectorQueryKind

Ek kaynaklar