Aracılığıyla paylaş

Documents - Search Post

  • Başvuru
Hizmet:
Search Service
API Sürümü:
2024-07-01

Dizindeki belgeleri arar.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2024-07-01

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ü.

İ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.

İstek Gövdesi

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 (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.
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 (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.
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, yeni dizinler için 'preFilter'dır.
vectorQueries VectorQuery[]:

Vektör ve karma arama sorguları için sorgu parametreleri.

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

SearchIndexSearchDocumentsPost
SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Örnek isteği

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-07-01

{
  "count": true,
  "facets": [
    "category,count:10,sort:count"
  ],
  "filter": "rating gt 4.0",
  "highlight": "description",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": null,
  "orderby": "rating desc",
  "queryType": "simple",
  "scoringParameters": [
    "currentLocation--122.123,44.77233"
  ],
  "scoringProfile": "sp",
  "search": "nice hotels",
  "searchFields": "category,description",
  "searchMode": "any",
  "sessionId": "mysessionid",
  "scoringStatistics": "global",
  "select": "hotelId,category,description",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "kind": "vector",
      "vector": [
        0.103,
        0.0712,
        0.0852,
        0.1547,
        0.1183
      ],
      "fields": "descriptionEmbedding",
      "k": 5,
      "exhaustive": true,
      "oversampling": 20,
      "weight": 2
    }
  ],
  "vectorFilterMode": "preFilter"
}

Örnek yanıt

Durum kodu:
200 
{
  "@odata.count": 25,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "@search.nextPageParameters": {
    "count": true,
    "facets": [
      "category,count:10,sort:count"
    ],
    "filter": "rating gt 4.0",
    "highlight": "title",
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "minimumCoverage": null,
    "orderby": "search.score() desc,rating desc",
    "queryType": "simple",
    "sessionId": "mysessionid",
    "scoringStatistics": "global",
    "scoringParameters": [
      "currentLocation--122.123,44.77233"
    ],
    "scoringProfile": "sp",
    "search": "nice hotels",
    "searchFields": "title,description",
    "searchMode": "any",
    "select": "docId,title,description",
    "skip": 2,
    "top": 8
  },
  "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"
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-07-01"
}

SearchIndexSearchDocumentsSemanticPost

Örnek isteği

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-07-01

{
  "count": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "queryType": "semantic",
  "search": "how do clouds form",
  "semanticConfiguration": "my-semantic-config",
  "answers": "extractive|count-3",
  "captions": "extractive|highlight-true",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 780
}

Ö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
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "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"
      ]
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-07-01"
}

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 semantictü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

Object

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

Object

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

Object

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

object

Ek bilgiler.
type

string

Ek bilgi türü.

ErrorDetail

Object

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

Object

Hata yanıtı

Name Tür Description
error

ErrorDetail

Hata nesnesi.

QueryAnswerType

Listeleme

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
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.
none

Sorgunun yanıtlarını döndürmeyin.

QueryCaptionType

Listeleme

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
extractive

Arama sorgusuyla ilgili bölümleri içeren eşleşen belgelerden resim yazılarını ayıklar.
none

Sorgu için açıklamalı alt yazı döndürmeyin.

QueryType

Listeleme

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

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

RawVectorQuery

Object

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 (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.
weight

number (float)

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

Listeleme

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
global

Puanlama istatistikleri, daha tutarlı puanlama için genel olarak hesaplanır.
local

Puanlama istatistikleri daha düşük gecikme süresi için yerel olarak hesaplanır.

SearchDocumentsResult

Object

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

Listeleme

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
all

Belgeyi eşleşme olarak saymak için tüm arama terimlerinin eşleşmesi gerekir.
any

Belgeyi eşleşme olarak saymak için arama terimlerinden herhangi birinin eşleşmesi gerekir.

SearchRequest

Object

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 (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.
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 (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.
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, yeni dizinler için 'preFilter'dır.
vectorQueries VectorQuery[]:

Vektör ve karma arama sorguları için sorgu parametreleri.

SearchResult

Object

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 (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ı.

SemanticErrorMode

Listeleme

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.

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

SemanticErrorReason

Listeleme

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

Değer Description
capacityOverloaded

İstek kısıtlandı. Yalnızca temel sonuçlar döndürüldü.
maxWaitExceeded

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

Anlamsal işlemin en az bir adımı başarısız oldu.

SemanticSearchResultsType

Listeleme

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.

VectorFilterMode

Listeleme

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

Object

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 (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.
weight

number (float)

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

Listeleme

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

Değer Description
text

Vektörleştirilmesi gereken bir metin değerinin sağlandığı vektör sorgusu.
vector

Ham vektör değerinin sağlandığı vektör sorgusu.