Documents - Search Post
Dizindeki belgeleri arar.
POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2026-08-01-preview
URI Parametreleri
| Name | İçinde | Gerekli | Tür | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Arama hizmetinin uç nokta URL'si. |
|
index
|
path | True |
string |
Dizinin adı. |
|
api-version
|
query | True |
string minLength: 1 |
Bu işlem için kullanılacak API sürümü. |
İstek Başlığı
| Name | Gerekli | Tür | Description |
|---|---|---|---|
| Accept |
Kabul Et başlığı. |
||
| x-ms-query-source-authorization |
string |
Sorgunun yürütüldüğü kullanıcıyı tanımlayan belirteç. Bu belirteç, belgelerde güvenlik kısıtlamalarını zorlamak için kullanılır. |
|
| x-ms-enable-elevated-read |
boolean |
Sorgu işlemi için belge düzeyi izin denetimlerini atlayan yükseltilmiş okumayı etkinleştiren bir değer. |
|
| x-ms-client-request-id |
string (uuid) |
İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı. |
İstek Gövdesi
| Name | Tür | Description |
|---|---|---|
| answers |
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 |
Açıklamalı alt yazıların arama yanıtının bir parçası olarak döndürülmesi gerekip gerekmediğini belirten bir değer. |
|
| count |
boolean |
Toplam sonuç sayısının getirilip getirilmeyeceğini belirten bir değer. Varsayılan değer false'tur. Bu değeri true olarak ayarlamak performansı etkileyebilir. Döndürülen sayın bir yaklaşık değer olduğunu unutmayın. |
| debug |
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, 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<>. |
| hybridSearch |
Karma arama davranışlarını yapılandırmak için sorgu parametreleri. |
|
| 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ıralanacağı ifadeleri $orderby için virgülle ayrılmış OData listesi. Her ifade bir alan adı veya geo.distance() veya search.score() işlevlerine yapılan bir çağrı olabilir. Her ifadeyi artanı belirtmek için asc, azalanı belirtmek için desc takip edebilir. Varsayılan değer artan düzendir. Bağlar, belgelerin eşleşme puanlarıyla bozulur. $orderby belirtilmezse, varsayılan sıralama düzeni belge eşleşme puanına göre azalan düzendedir. En fazla 32 $orderby yan tümcesi olabilir. |
| queryLanguage |
Arama sorgusunun dilini belirten bir değer. |
|
| queryRewrites |
Arama sorgusunu artırmak için sorgu yeniden yazmalarının oluşturulup oluşturulmayacağını belirten bir değer. |
|
| 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 |
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' 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ı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 |
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 |
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. |
|
| semanticFields |
string |
Anlamsal sıralama için kullanılan alan adlarının virgülle ayrılmış listesi. |
| semanticMaxWaitInMilliseconds |
integer (int32) minimum: 700 |
Kullanıcının, istek başarısız olmadan önce anlam zenginleştirme işleminin tamamlanması için gereken süreye göre bir üst sınır ayarlamasına izin verir. |
| semanticQuery |
string |
Yalnızca anlamsal yeniden boyutlandırma, semantik açıklamalı alt yazılar ve anlamsal yanıtlar için kullanılacak ayrı bir arama sorgusu ayarlamaya izin verir. Temel alma ve derecelendirme aşaması ile L2 semantik aşaması arasında farklı sorgular kullanılması gereken senaryolar için kullanışlıdır. |
| sessionId |
string |
Daha tutarlı sonuçlar elde etmeye yardımcı olabilecek yapışkan bir oturum oluşturmak için kullanılacak bir değer. Aynı sessionId kullanıldığı sürece, aynı çoğaltma kümesini hedeflemek için en iyi girişimde bulunulacaktır. Aynı sessionID değerlerini tekrar tekrar yeniden kullanmanın çoğaltmalar arasında isteklerin yük dengelemesini engelleyeceğine ve arama hizmetinin performansını olumsuz etkileyebileceğine dikkat edin. sessionId olarak kullanılan değer '_' karakteriyle başlayamaz. |
| skip |
integer (int32) |
Atlana arama sonuçlarının sayısı. Bu değer 100.000'den büyük olamaz. Belgeleri sırayla taramanız gerekiyorsa ancak bu sınırlama nedeniyle atlamayı kullanamıyorsanız, tamamen sıralı bir anahtarda orderby kullanmayı ve bunun yerine bir aralık sorgusuyla filtrelemeyi göz önünde bulundurun. |
| speller |
Bireysel arama sorgusu terimlerini düzeltmek için kullanılacak yazımcının türünü belirten bir değer. |
|
| top |
integer (int32) |
Alınacak arama sonuçlarının sayısı. Bu, arama sonuçlarının istemci tarafı disk belleğini uygulamak için $skip ile birlikte kullanılabilir. Sunucu tarafı sayfalama nedeniyle sonuçlar kesilirse yanıt, sonraki sonuç sayfası için başka bir Arama isteği göndermek için kullanılabilecek bir devam belirteci içerir. |
| vectorFilterMode |
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[]: |
Vektör ve karma arama sorguları için sorgu parametreleri. |
Yanıtlar
| Name | Tür | Description |
|---|---|---|
| 200 OK |
İstek başarılı oldu. |
|
| Other Status Codes |
Başarılı |
|
| Other Status Codes |
Beklenmeyen bir hata yanıtı. |
Güvenlik
api-key
Tür:
apiKey
İçinde:
header
OAuth2Auth
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Kapsamlar
| Name | Description |
|---|---|
| https://search.azure.com/.default |
Örnekler
|
Search |
|
Search |
|
Search |
SearchIndexSearchDocumentsPost
Örnek isteği
POST https://typespecpreviewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.search?api-version=2026-08-01-preview
{
"count": true,
"facets": [
"ownerId",
"price,metric:sum,default:10"
],
"filter": "category eq 'purple' or category eq 'pink'",
"highlight": "category",
"highlightPostTag": "</em>",
"highlightPreTag": "</em>",
"minimumCoverage": 100,
"orderby": "",
"queryType": "semantic",
"scoringStatistics": "global",
"sessionId": "mysessionid",
"scoringParameters": [
"categoryTag:desiredCategoryValue"
],
"scoringProfile": "stringFieldBoost",
"debug": "vector",
"search": "purple",
"searchFields": "id,name,description,category,ownerId",
"searchMode": "any",
"queryLanguage": "en-us",
"speller": "lexicon",
"select": "id,name,description,category,ownerId",
"skip": 0,
"top": 10,
"semanticConfiguration": "testconfig",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 5000,
"semanticQuery": "find all purple",
"answers": "extractive",
"captions": "extractive",
"queryRewrites": "generative",
"semanticFields": "",
"vectorQueries": [
{
"k": 50,
"fields": "vector22, vector1b",
"oversampling": 20,
"weight": 1,
"threshold": {
"kind": "vectorSimilarity",
"value": 0.984
},
"filterOverride": "ownerId eq 'sam'",
"kind": "vector",
"vector": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
}
],
"vectorFilterMode": "preFilter",
"hybridSearch": {
"maxTextRecallSize": 100,
"countAndFacetMode": "countAllResults"
}
}
Örnek yanıt
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 27.725889205932617
},
"vectors": [
{}
]
}
}
},
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011627906933426857,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011904762126505375,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6990556716918945,
"@search.rerankerBoostedScore": 1.6990556716918945,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6951565742492676,
"@search.rerankerBoostedScore": 1.6951565742492676,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.693029761314392,
"@search.rerankerBoostedScore": 1.693029761314392,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6909029483795166,
"@search.rerankerBoostedScore": 1.6909029483795166,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 39.23316955566406
},
"vectors": [
{}
]
}
}
},
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6777875423431396,
"@search.rerankerBoostedScore": 1.6777875423431396,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6650266647338867,
"@search.rerankerBoostedScore": 1.6650266647338867,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 23.01456642150879
},
"vectors": [
{}
]
}
}
},
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6607730388641357,
"@search.rerankerBoostedScore": 1.6607730388641357,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 27.725889205932617
},
"vectors": [
{}
]
}
}
},
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011627906933426857,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011904762126505375,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6990556716918945,
"@search.rerankerBoostedScore": 1.6990556716918945,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6951565742492676,
"@search.rerankerBoostedScore": 1.6951565742492676,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.693029761314392,
"@search.rerankerBoostedScore": 1.693029761314392,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6909029483795166,
"@search.rerankerBoostedScore": 1.6909029483795166,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 39.23316955566406
},
"vectors": [
{}
]
}
}
},
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6777875423431396,
"@search.rerankerBoostedScore": 1.6777875423431396,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6650266647338867,
"@search.rerankerBoostedScore": 1.6650266647338867,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 23.01456642150879
},
"vectors": [
{}
]
}
}
},
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6607730388641357,
"@search.rerankerBoostedScore": 1.6607730388641357,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}
SearchIndexSearchDocumentsPostOsV2
Örnek isteği
POST https://previewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.search?api-version=2026-08-01-preview
{
"count": true,
"facets": [
"ownerId",
"price,metric:sum,default:10"
],
"filter": "category eq 'purple' or category eq 'pink'",
"highlight": "category",
"highlightPostTag": "</em>",
"highlightPreTag": "</em>",
"minimumCoverage": 100,
"queryType": "semantic",
"scoringStatistics": "global",
"sessionId": "mysessionid",
"scoringParameters": [
"categoryTag:desiredCategoryValue"
],
"scoringProfile": "stringFieldBoost",
"debug": "vector",
"search": "purple",
"searchFields": "id,name,description,category,ownerId",
"searchMode": "any",
"queryLanguage": "en-us",
"speller": "lexicon",
"select": "id,name,description,category,ownerId",
"skip": 0,
"top": 10,
"semanticConfiguration": "testconfig",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 5000,
"semanticQuery": "find all purple",
"answers": "extractive",
"captions": "extractive",
"queryRewrites": "generative",
"vectorQueries": [
{
"vector": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"kind": "vector",
"k": 50,
"fields": "vector22, vector1b",
"oversampling": 20,
"weight": 1,
"threshold": {
"value": 0.984,
"kind": "vectorSimilarity"
},
"filterOverride": "ownerId eq 'sam'"
}
],
"vectorFilterMode": "preFilter",
"hybridSearch": {
"maxTextRecallSize": 100,
"countAndFacetMode": "countAllResults"
}
}
Örnek yanıt
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.012987012974917889,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013333333656191826,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 18.800146102905273
},
"vectors": [
{}
]
}
}
},
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012195121496915817,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6994102001190186,
"@search.rerankerBoostedScore": 1.6994102001190186,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6937386989593506,
"@search.rerankerBoostedScore": 1.6937386989593506,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 11.507283210754395
},
"vectors": [
{}
]
}
}
},
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6923208236694336,
"@search.rerankerBoostedScore": 1.6923208236694336,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013513513840734959,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.691611886024475,
"@search.rerankerBoostedScore": 1.691611886024475,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 18.800146102905273
},
"vectors": [
{}
]
}
}
},
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01315789483487606,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6781420707702637,
"@search.rerankerBoostedScore": 1.6781420707702637,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6653810739517212,
"@search.rerankerBoostedScore": 1.6653810739517212,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 33.067142486572266
},
"vectors": [
{}
]
}
}
},
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.016393441706895828,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6618363857269287,
"@search.rerankerBoostedScore": 1.6618363857269287,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 33.067142486572266
},
"vectors": [
{}
]
}
}
},
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}
{
"value": []
}
SearchIndexSearchDocumentsSemanticPost
Örnek isteği
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2026-08-01-preview
{
"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
{
"@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=2025-05-01-preview"
}
{
"@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=2025-05-01-preview"
}
Tanımlar
| Name | Description |
|---|---|
| Accept |
Kabul Et başlığı. |
|
Debug |
Arama sonuçlarınızı daha fazla incelemek için kullanılabilecek hata ayıklama bilgilerini içerir. |
|
Document |
Arama sonuçlarınızı daha fazla incelemek için kullanılabilecek hata ayıklama bilgilerini içerir. |
|
Error |
Kaynak yönetimi hatasına ilişkin ek bilgiler. |
|
Error |
Hata ayrıntısı. |
|
Error |
Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.). |
|
Hybrid |
Sayım ve modellerin arama sorgusuyla eşleşen tüm belgeleri mi yoksa yalnızca 'maxTextRecallSize' penceresinde alınan belgeleri mi içermesi gerektiğini belirler. Varsayılan değer 'countAllResults' değeridir. |
|
Hybrid |
Karma arama davranışlarını yapılandırmak için sorgu parametreleri. |
|
Query |
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. |
|
Query |
Bu parametre yalnızca sorgu türü . |
|
Query |
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 |
|
Query |
Bu parametre yalnızca sorgu türü . |
|
Query |
Arama sonuçlarınızı daha fazla araştırmak için kullanılabilecek bir hata ayıklama aracı sağlar. Birden çok hata ayıklama modunu aynı anda bir | karakteri, örneğin: semantic|queryRewrites. |
|
Query |
Sorgunun dili. |
|
Query |
Anlam zenginleştirme işlemine gönderilen ham birleştirilmiş dizeler. |
|
Query |
Anlam zenginleştirme işlemine gönderilen alanların açıklaması ve bunların nasıl kullanıldığı |
|
Query |
Bu belge için arama sorgusunun metin ve vektör sorgusu bileşenleri arasındaki alt çekirdeklerin dökümü. Her vektör sorgusu, alındıkları sırayla ayrı bir nesne olarak gösterilir. |
|
Query |
Sorgu yeniden yazmalarına özgü hata ayıklama bilgilerini içerir. |
|
Query |
Bu parametre yalnızca sorgu türü . |
|
Query |
Sorgu yeniden yazmalarına özgü hata ayıklama bilgilerini içerir. |
|
Query |
Tek tek arama sorgusu terimlerini yazım düzelterek arama geri çağırmayı geliştirin. |
|
Query |
Arama sorgusunun sözdizimini belirtir. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu sözdizimini kullanıyorsa 'tam' ve sorgu söz dizimi gerekmiyorsa 'semantic' kullanın. |
|
Scoring |
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' ifadesini kullanın. Genel puanlama istatistiklerinin kullanılması, arama sorgularının gecikme süresini artırabilir. |
|
Search |
Bir dizinden arama sonuçlarını içeren yanıt. |
|
Search |
Belgeyi eşleşme olarak saymak için arama terimlerinden herhangi birinin veya tümünün eşleşmesi gerekip gerekmediğini belirtir. |
|
Search |
Filtreleme, sıralama, yüz tanıma, sayfalama ve diğer arama sorgusu davranışları için parametreler. |
|
Search |
Arama sorgusu tarafından bulunan bir belgeyi ve ilişkili meta verileri içerir. |
|
Search |
Vektör sorgusunun sonuçları, ' |
|
Semantic |
Anlamsal sıralama isteklerine özgü hata ayıklama bilgilerini içerir. |
|
Semantic |
Kullanıcı, 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ürmemesini seçebilir. |
|
Semantic |
Anlamsal sıralama isteği için kısmi bir yanıt döndürülmesinin nedeni. |
|
Semantic |
Alanın anlamsal zenginleştirme süreci için nasıl kullanıldığı. |
|
Semantic |
Bu istek için kullanılan sorgu yeniden yazma türü. |
|
Semantic |
Anlamsal sıralama isteği için döndürülen kısmi yanıtın türü. |
|
Single |
Tek bir vektör alanı sonucu. Both |
|
Text |
Sorgunun metin bölümü için BM25 veya Klasik puanı. |
|
Vector |
Filtrelerin vektör araması yapılmadan önce mi yoksa sonra mı uygulanacağını belirler. |
|
Vectorizable |
Vektörleştirilmesi gereken bir görüntünün temel 64 kodlanmış ikili dosyası sağlandığında vektör araması için kullanılacak sorgu parametreleri. |
|
Vectorizable |
Vektörleştirilmesi gereken bir görüntü değerini temsil eden bir URL sağlandığında vektör araması için kullanılacak sorgu parametreleri. |
|
Vectorizable |
Vektörleştirilmesi gereken bir metin değeri sağlandığında vektör araması için kullanılacak sorgu parametreleri. |
|
Vectorized |
Ham vektör değeri sağlandığında vektör araması için kullanılacak sorgu parametreleri. |
|
Vector |
Gerçekleştirilen vektör sorgusunun türü. |
|
Vectors |
"Vektör ve hibrit arama için özel hata ayıklama bilgisi içerir.") |
|
Vector |
Vektör sorgusunun sonuçları vektör benzerliği ölçümüne göre filtrelenir. Bunun benzerlik ölçümünün kurallı tanımı olduğunu, 'uzaklık' sürümünün olmadığını unutmayın. Eşik yönü (daha büyük veya daha küçük) alan tarafından kullanılan ölçüme göre otomatik olarak seçilir. |
|
Vector |
Vektör sorgularını filtrelemek için kullanılan eşik türü. |
Accept
Kabul Et başlığı.
| Değer | Description |
|---|---|
| application/json;odata.metadata=none |
DebugInfo
Arama sonuçlarınızı daha fazla incelemek için kullanılabilecek hata ayıklama bilgilerini içerir.
| Name | Tür | Description |
|---|---|---|
| queryRewrites |
Sorgu yeniden yazmalarına özgü hata ayıklama bilgilerini içerir. |
DocumentDebugInfo
Arama sonuçlarınızı daha fazla incelemek için kullanılabilecek hata ayıklama bilgilerini içerir.
| Name | Tür | Description |
|---|---|---|
| innerHits |
object |
Karmaşık türlerden oluşan bir koleksiyon içinde eşleşen vektörlere özgü hata ayıklama bilgilerini içerir. |
| semantic |
Anlamsal sıralama isteklerine özgü hata ayıklama bilgilerini içerir. |
|
| vectors |
Vektör ve karma aramaya özgü hata ayıklama bilgilerini içerir. |
ErrorAdditionalInfo
Kaynak yönetimi hatasına ilişkin ek bilgiler.
| Name | Tür | Description |
|---|---|---|
| info |
Ek bilgiler. |
|
| type |
string |
Ek bilgi türü. |
ErrorDetail
Hata ayrıntısı.
| Name | Tür | Description |
|---|---|---|
| additionalInfo |
Hata ek bilgisi. |
|
| code |
string |
Hata kodu. |
| details |
Hata ayrıntıları. |
|
| message |
string |
Hata iletisi. |
| target |
string |
Hata hedefi |
ErrorResponse
Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).
| Name | Tür | Description |
|---|---|---|
| error |
Hata nesnesi. |
HybridCountAndFacetMode
Sayım ve modellerin arama sorgusuyla eşleşen tüm belgeleri mi yoksa yalnızca 'maxTextRecallSize' penceresinde alınan belgeleri mi içermesi gerektiğini belirler. Varsayılan değer 'countAllResults' değeridir.
| Değer | Description |
|---|---|
| countRetrievableResults |
'count' ve 'facets' hesaplanırken yalnızca 'maxTextRecallSize' alma penceresi içinde eşleşen belgeleri dahil edin. |
| countAllResults |
'count' ve 'facets' hesaplanırken arama sorgusuyla eşleşen tüm belgeleri, bu belgelerin 'maxTextRecallSize' alma penceresi içinde olup olmadığına bakılmaksızın dahil edin. |
HybridSearch
Karma arama davranışlarını yapılandırmak için sorgu parametreleri.
| Name | Tür | Description |
|---|---|---|
| countAndFacetMode |
Sayım ve modellerin arama sorgusuyla eşleşen tüm belgeleri mi yoksa yalnızca 'maxTextRecallSize' penceresinde alınan belgeleri mi içermesi gerektiğini belirler. |
|
| maxTextRecallSize |
integer (int32) |
Karma arama isteğinin metin sorgusu bölümü tarafından alınacak en fazla belge sayısını belirler. Bu belgeler, tek bir nihai sonuç listesi oluşturmak için vektör sorgularıyla eşleşen belgelerle birleştirilecektir. Daha büyük bir maxTextRecallSize değeri seçmek, daha yüksek kaynak kullanımı ve daha yüksek gecikme süresi pahasına daha fazla belgenin alınmasına ve sayfalanmasına (top ve skip parametrelerini kullanarak) olanak tanır. Değerin 1 ile 10.000 arasında olması gerekir. Varsayılan değer 1000'dir. |
QueryAnswerResult
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. |
QueryAnswerType
Bu parametre yalnızca sorgu türü .semantic Ayarlanırsa, sorgu en yüksek dereceli belgelerdeki anahtar geçitlerden 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. Yanıtların maksimum karakter uzunluğu, '|' dikey çizgi karakteri ve ardından 'extractive|maxcharlength-600' gibi 'maksimum karakter uzunluğunun< sayı> sayısı' eklenerek yapılandırılabilir.
| 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. |
QueryCaptionResult
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. |
QueryCaptionType
Bu parametre yalnızca sorgu türü .semantic Ayarlanırsa, sorgu en yüksek dereceli belgelerdeki anahtar geçitlerden ayıklanan açıklamalı alt yazıları döndürür. Altyazılar olarak extractiveayarlandığı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 değer None’dır. Altyazıların maksimum karakter uzunluğu, '|' dikey çizgi karakteri ve ardından 'extractive|maxcharlength-600' gibi 'maksimum karakter uzunluğunun< sayı> sayısı' eklenerek yapılandırılabilir.
| Değer | Description |
|---|---|
| none |
Sorgu için resim yazıları döndürmeyin. |
| extractive |
Arama sorgusuyla ilgili bölümleri içeren eşleşen belgelerden resim yazılarını ayıklar. |
QueryDebugMode
Arama sonuçlarınızı daha fazla araştırmak için kullanılabilecek bir hata ayıklama aracı sağlar. Birden çok hata ayıklama modunu aynı anda bir | karakteri, örneğin: semantic|queryRewrites.
| Değer | Description |
|---|---|
| disabled |
Hiçbir sorgu hata ayıklama bilgisi döndürülmeyecek. |
| semantic |
Kullanıcının yeniden kaydedilen sonuçlarını daha fazla keşfetmesine olanak tanır. |
| vector |
Kullanıcının karma ve vektör sorgu sonuçlarını daha fazla keşfetmesine olanak tanır. |
| queryRewrites |
Kullanıcının arama isteği için oluşturulan sorgu yeniden yazma listesini keşfetmesine olanak tanır. |
| innerHits |
Kullanıcının, karmaşık türlerden oluşan bir koleksiyon içinde eşleşen vektörlerle ilgili puanlama bilgilerini almasına izin verir. |
| all |
Tüm hata ayıklama seçeneklerini açın. |
QueryLanguage
Sorgunun dili.
| Değer | Description |
|---|---|
| none |
Sorgu dili belirtilmedi. |
| en-us |
İngilizce için dil değeri sorgu (Birleşik Devletler). |
| en-gb |
İngilizce (Büyük Britanya) için dil değerini sorgulayın. |
| en-in |
İngilizce (Hindistan) için sorgu dili değeri. |
| en-ca |
İngilizce (Kanada) için sorgu dili değeri. |
| en-au |
İngilizce (Avustralya) için sorgu dili değeri. |
| fr-fr |
Fransızca (Fransa) için dil değerini sorgulayın. |
| fr-ca |
Fransızca (Kanada) için dil değerini sorgulayın. |
| de-de |
Almanca (Almanya) için sorgu dili değeri. |
| es-es |
İspanyolca (İspanya) için dil değerini sorgulayın. |
| es-mx |
İspanyolca (Meksika) için sorgu dili değeri. |
| zh-cn |
Çince (Çin) için sorgu dili değeri. |
| zh-tw |
Çince (Tayvan) için sorgu dili değeri. |
| pt-br |
Portekizce (Brezilya) için sorgu dili değeri. |
| pt-pt |
Portekizce (Portekiz) için sorgu dili değeri. |
| it-it |
İtalyanca (İtalya) için sorgu dili değeri. |
| ja-jp |
Japonca (Japonya) için sorgu dili değeri. |
| ko-kr |
Korece (Kore) için sorgu dili değeri. |
| ru-ru |
Rusça (Rusya) için sorgu dili değeri. |
| cs-cz |
Çekçe (Çek Cumhuriyeti) için sorgu dili değeri. |
| nl-be |
Felemenkçe (Belçika) için dil değerini sorgulayın. |
| nl-nl |
Hollandaca (Hollanda) için dil değerini sorgulayın. |
| hu-hu |
Macarca (Macaristan) için sorgu dili değeri. |
| pl-pl |
Lehçe (Polonya) için dil değerini sorgulayın. |
| sv-se |
İsveççe (İsveç) için sorgu dili değeri. |
| tr-tr |
Türkçe (Türkiye) için dil değerini sorgulayın. |
| hi-in |
Hintçe (Hindistan) için sorgu dili değeri. |
| ar-sa |
Arapça (Suudi Arabistan) için sorgu dili değeri. |
| ar-eg |
Arapça (Mısır) için sorgu dili değeri. |
| ar-ma |
Arapça (Fas) için dil değerini sorgulayın. |
| ar-kw |
Arapça (Kuveyt) için sorgu dili değeri. |
| ar-jo |
Arapça (Ürdün) için sorgu dili değeri. |
| da-dk |
Danca (Danimarka) için sorgu dili değeri. |
| no-no |
Norveççe (Norveç) için dil değerini sorgulayın. |
| bg-bg |
Bulgarca (Bulgaristan) için dil değerini sorgulayın. |
| hr-hr |
Hırvatça (Hırvatistan) için sorgu dili değeri. |
| hr-ba |
Hırvatça (Bosna Hersek) için dil değerini sorgulayın. |
| ms-my |
Malay dili (Malezya) için sorgu dili değeri. |
| ms-bn |
Malayca (Brunei Sultanlığı) için sorgu dili değeri. |
| sl-sl |
Slovence (Slovenya) için dil değerini sorgulayın. |
| ta-in |
Tamilce (Hindistan) için sorgu dili değeri. |
| vi-vn |
Vietnamca (Vietnamca) için dil değerini sorgulayın. |
| el-gr |
Yunanca (Yunanistan) için dil değerini sorgulayın. |
| ro-ro |
Rumence (Romanya) için dil değerini sorgulayın. |
| is-is |
İzlandaca (İzlanda) için dil değerini sorgulayın. |
| id-id |
Endonezce (Endonezya) için dil değerini sorgulayın. |
| th-th |
Tay dili (Tayland) için sorgu dili değeri. |
| lt-lt |
Litvanca (Litvanya) için sorgu dili değeri. |
| uk-ua |
Ukraynaca (Ukrayna) için dil değerini sorgulayın. |
| lv-lv |
Letonca (Letonya) için dil değerini sorgulayın. |
| et-ee |
Estonca (Estonya) için dil değerini sorgulayın. |
| ca-es |
Katalanca için sorgu dili değeri. |
| fi-fi |
Fince (Finlandiya) için sorgu dili değeri. |
| sr-ba |
Sırpça (Bosna Hersek) için dil değerini sorgulayın. |
| sr-me |
Sırpça (Karadağ) için sorgu dili değeri. |
| sr-rs |
Sırpça (Sırbistan) için sorgu dili değeri. |
| sk-sk |
Slovakça (Slovakya) için sorgu dili değeri. |
| nb-no |
Norveççe (Norveç) için dil değerini sorgulayın. |
| hy-am |
Ermenice (Ermenistan) için dil değerini sorgulayın. |
| bn-in |
Bengalce (Hindistan) için sorgu dili değeri. |
| eu-es |
Bask için sorgu dili değeri. |
| gl-es |
Galiçyaca için sorgu dili değeri. |
| gu-in |
Gujarati (Hindistan) için sorgu dili değeri. |
| he-il |
İbranice (İsrail) için sorgu dili değeri. |
| ga-ie |
İrlandaca (İrlanda) için dil değerini sorgulayın. |
| kn-in |
Kannada (Hindistan) için sorgu dili değeri. |
| ml-in |
Malayalam (Hindistan) için sorgu dili değeri. |
| mr-in |
Marathi (Hindistan) için sorgu dili değeri. |
| fa-ae |
Farsça (U.A.E.) için dil değerini sorgulayın. |
| pa-in |
Punjabi (Hindistan) için sorgu dili değeri. |
| te-in |
Telugu (Hindistan) için sorgu dili değeri. |
| ur-pk |
Urduca (Pakistan) için sorgu dili değeri. |
QueryResultDocumentRerankerInput
Anlam zenginleştirme işlemine gönderilen ham birleştirilmiş dizeler.
| Name | Tür | Description |
|---|---|---|
| content |
string |
Anlamsal zenginleştirme için kullanılan içerik alanları için ham birleştirilmiş dizeler. |
| keywords |
string |
Anlamsal zenginleştirme için kullanılan anahtar sözcük alanları için ham birleştirilmiş dizeler. |
| title |
string |
Anlamsal zenginleştirme için kullanılan başlık alanının ham dizesi. |
QueryResultDocumentSemanticField
Anlam zenginleştirme işlemine gönderilen alanların açıklaması ve bunların nasıl kullanıldığı
| Name | Tür | Description |
|---|---|---|
| name |
string |
Anlamsal zenginleştirme işlemine gönderilen alanın adı |
| state |
Anlamsal zenginleştirme işlemi için alanın kullanılma şekli (tamamen kullanılmış, kısmen kullanılmış veya kullanılmamış) |
QueryResultDocumentSubscores
Bu belge için arama sorgusunun metin ve vektör sorgusu bileşenleri arasındaki alt çekirdeklerin 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 |
Sorgunun metin bölümü için BM25 veya Klasik puanı. |
|
| vectors |
<string,
Single |
Vektör benzerliği ve |
QueryRewritesDebugInfo
Sorgu yeniden yazmalarına özgü hata ayıklama bilgilerini içerir.
| Name | Tür | Description |
|---|---|---|
| text |
Metin sorgusu için oluşturulan sorgu yeniden yazmalarının listesi. |
|
| vectors |
Vektörleştirilebilir metin sorguları için oluşturulan sorgu yeniden yazmalarının listesi. |
QueryRewritesType
Bu parametre yalnızca sorgu türü .semantic QueryRewrites olarak generativeayarlandığında, sorgu terimleri, isteğin geri çağrılmasını artırmaya yardımcı olmak için 10 (varsayılan) yeniden yazma üretecek bir oluşturma modeline gönderilir. İstenen sayı, kanal karakterinin | sonuna ve ardından gibi count-<number of rewrites>bir generative|count-3 seçenek eklenerek yapılandırılabilir. Varsayılan değer None’dır.
| Değer | Description |
|---|---|
| none |
Bu sorgu için ek sorgu yeniden yazmaları oluşturmayın. |
| generative |
Arama isteğinin geri çağrılmasını artırmak için alternatif sorgu terimleri oluşturun. |
QueryRewritesValuesDebugInfo
Sorgu yeniden yazmalarına özgü hata ayıklama bilgilerini içerir.
| Name | Tür | Description |
|---|---|---|
| inputQuery |
string |
Üretken sorgu yeniden yazma modeline giriş metni. Kullanıcı sorgusunun ve üretken modele yapılan girişin aynı olmadığı durumlar olabilir. |
| rewrites |
string[] |
Sorgu yeniden yazmalarının listesi. |
QuerySpellerType
Tek tek arama sorgusu terimlerini yazım düzelterek arama geri çağırmayı geliştirin.
| Değer | Description |
|---|---|
| none |
Yazım denetimi etkin değil. |
| lexicon |
Yazım Denetleyicisi, queryLanguage parametresi tarafından belirtilen dil için statik bir sözlük kullanarak tek tek sorgu terimlerini düzeltir. |
QueryType
Arama sorgusunun sözdizimini belirtir. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu sözdizimini kullanıyorsa 'tam' ve sorgu söz dizimi gerekmiyorsa 'semantic' 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. |
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' 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
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. 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 |
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.debug |
Arama sonuçlarına bir bütün olarak uygulanan hata ayıklama bilgileri. |
|
| @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 |
Sorgu istenen tüm sonuçları tek bir yanıtta döndüremediğinde döndürülen devam JSON yükü. Bu JSON'u da kullanabilirsiniz. |
|
| @search.semanticPartialResponseReason |
Anlamsal sıralama isteği için kısmi bir yanıt döndürülmesinin nedeni. |
|
| @search.semanticPartialResponseType |
Anlamsal sıralama isteği için döndürülen kısmi yanıtın türü. |
|
| @search.semanticQueryRewritesResultType |
Belgeleri almak için kullanılan sorgu yeniden yazma türü. |
|
| value |
Sorgu tarafından döndürülen sonuç dizisi. |
SearchMode
Belgeyi eşleşme olarak saymak için arama terimlerinden herhangi birinin veya tümünün eşleşmesi gerekip gerekmediğini belirtir.
| 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
Filtreleme, sıralama, yüz tanıma, sayfalama ve diğer arama sorgusu davranışları için parametreler.
| Name | Tür | Description |
|---|---|---|
| answers |
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 |
Açıklamalı alt yazıların arama yanıtının bir parçası olarak döndürülmesi gerekip gerekmediğini belirten bir değer. |
|
| count |
boolean |
Toplam sonuç sayısının getirilip getirilmeyeceğini belirten bir değer. Varsayılan değer false'tur. Bu değeri true olarak ayarlamak performansı etkileyebilir. Döndürülen sayın bir yaklaşık değer olduğunu unutmayın. |
| debug |
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, 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<>. |
| hybridSearch |
Karma arama davranışlarını yapılandırmak için sorgu parametreleri. |
|
| 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ıralanacağı ifadeleri $orderby için virgülle ayrılmış OData listesi. Her ifade bir alan adı veya geo.distance() veya search.score() işlevlerine yapılan bir çağrı olabilir. Her ifadeyi artanı belirtmek için asc, azalanı belirtmek için desc takip edebilir. Varsayılan değer artan düzendir. Bağlar, belgelerin eşleşme puanlarıyla bozulur. $orderby belirtilmezse, varsayılan sıralama düzeni belge eşleşme puanına göre azalan düzendedir. En fazla 32 $orderby yan tümcesi olabilir. |
| queryLanguage |
Arama sorgusunun dilini belirten bir değer. |
|
| queryRewrites |
Arama sorgusunu artırmak için sorgu yeniden yazmalarının oluşturulup oluşturulmayacağını belirten bir değer. |
|
| 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 |
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' 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ı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 |
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 |
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. |
|
| semanticFields |
string |
Anlamsal sıralama için kullanılan alan adlarının virgülle ayrılmış listesi. |
| semanticMaxWaitInMilliseconds |
integer (int32) minimum: 700 |
Kullanıcının, istek başarısız olmadan önce anlam zenginleştirme işleminin tamamlanması için gereken süreye göre bir üst sınır ayarlamasına izin verir. |
| semanticQuery |
string |
Yalnızca anlamsal yeniden boyutlandırma, semantik açıklamalı alt yazılar ve anlamsal yanıtlar için kullanılacak ayrı bir arama sorgusu ayarlamaya izin verir. Temel alma ve derecelendirme aşaması ile L2 semantik aşaması arasında farklı sorgular kullanılması gereken senaryolar için kullanışlıdır. |
| sessionId |
string |
Daha tutarlı sonuçlar elde etmeye yardımcı olabilecek yapışkan bir oturum oluşturmak için kullanılacak bir değer. Aynı sessionId kullanıldığı sürece, aynı çoğaltma kümesini hedeflemek için en iyi girişimde bulunulacaktır. Aynı sessionID değerlerini tekrar tekrar yeniden kullanmanın çoğaltmalar arasında isteklerin yük dengelemesini engelleyeceğine ve arama hizmetinin performansını olumsuz etkileyebileceğine dikkat edin. sessionId olarak kullanılan değer '_' karakteriyle başlayamaz. |
| skip |
integer (int32) |
Atlana arama sonuçlarının sayısı. Bu değer 100.000'den büyük olamaz. Belgeleri sırayla taramanız gerekiyorsa ancak bu sınırlama nedeniyle atlamayı kullanamıyorsanız, tamamen sıralı bir anahtarda orderby kullanmayı ve bunun yerine bir aralık sorgusuyla filtrelemeyi göz önünde bulundurun. |
| speller |
Bireysel arama sorgusu terimlerini düzeltmek için kullanılacak yazımcının türünü belirten bir değer. |
|
| top |
integer (int32) |
Alınacak arama sonuçlarının sayısı. Bu, arama sonuçlarının istemci tarafı disk belleğini uygulamak için $skip ile birlikte kullanılabilir. Sunucu tarafı sayfalama nedeniyle sonuçlar kesilirse yanıt, sonraki sonuç sayfası için başka bir Arama isteği göndermek için kullanılabilecek bir devam belirteci içerir. |
| vectorFilterMode |
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[]: |
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 |
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ündeki sorgular için döndürülür. |
|
| @search.documentDebugInfo |
Arama sonuçlarınızı daha fazla incelemek 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ı, Semantik Konfigürasyondaki useScoringProfileBoostedRanking verilerine göre RerankerScore/RerankerBoostedScore ile sıralanır. RerankerBoostedScore sadece 'semantik' tipindeki sorgularda döner. |
| @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ı. |
SearchScoreThreshold
Vektör sorgusunun sonuçları, '
| Name | Tür | Description |
|---|---|---|
| kind |
string:
search |
Eşik türü. |
| value |
number (double) |
Eşik ' |
SemanticDebugInfo
Anlamsal sıralama isteklerine özgü hata ayıklama bilgilerini içerir.
| Name | Tür | Description |
|---|---|---|
| contentFields |
Anlamsal zenginleştirme işlemine gönderilen içerik alanları ve bunların nasıl kullanıldığı |
|
| keywordFields |
Anlamsal zenginleştirme işlemine gönderilen anahtar sözcük alanları ve bunların nasıl kullanıldıkları |
|
| rerankerInput |
Anlam zenginleştirme işlemine gönderilen ham birleştirilmiş dizeler. |
|
| titleField |
Anlamsal zenginleştirme işlemine gönderilen başlık alanı ve nasıl kullanıldığı |
SemanticErrorMode
Kullanıcı, 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ürmemesini seçebilir.
| Değer | Description |
|---|---|
| partial |
Anlamsal işleme başarısız olursa kısmi sonuçlar yine de döndürüler. Kısmi sonuçların tanımı, hangi semantik adımın başarısız olduğuna ve başarısızlığın nedeninin ne olduğuna bağlıdır. |
| fail |
Anlamsal işleme adımı sırasında bir özel durum varsa, sorgu başarısız olur ve hataya bağlı olarak uygun HTTP kodunu döndürür. |
SemanticErrorReason
Anlamsal sıralama isteği için kısmi bir yanıt döndürülmesinin nedeni.
| Değer | Description |
|---|---|
| maxWaitExceeded |
|
| capacityOverloaded |
İstek kısıtlandı. Yalnızca temel sonuçlar döndürüldü. |
| transient |
Anlamsal işlemin en az bir adımı başarısız oldu. |
SemanticFieldState
Alanın anlamsal zenginleştirme süreci için nasıl kullanıldığı.
| Değer | Description |
|---|---|
| used |
Alan tamamen anlamsal zenginleştirme için kullanıldı. |
| unused |
Alan anlamsal zenginleştirme için kullanılmamıştır. |
| partial |
Alan kısmen anlamsal zenginleştirme için kullanılmıştır. |
SemanticQueryRewritesResultType
Bu istek için kullanılan sorgu yeniden yazma türü.
| Değer | Description |
|---|---|
| originalQueryOnly |
Bu istek için sorgu yeniden yazma işlemleri başarıyla oluşturulmadı. Sonuçları almak için yalnızca özgün sorgu kullanıldı. |
SemanticSearchResultsType
Anlamsal sıralama isteği için döndürülen kısmi yanıtın 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. |
SingleVectorFieldResult
Tek bir vektör alanı sonucu. Both
| Name | Tür | Description |
|---|---|---|
| searchScore |
number (double) |
Bu |
| vectorSimilarity |
number (double) |
Bu belge için vektör benzerlik puanı. Bunun benzerlik ölçümünün kurallı tanımı olduğunu, 'uzaklık' sürümünün olmadığını unutmayın. Örneğin, kosinüs mesafesi yerine kosinüs benzerliği. |
TextResult
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
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 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. |
| strictPostFilter |
Filtre, genel top-k adayı vektör sonuçları kümesi döndürüldükten sonra uygulanacaktır. Bu, 'k' parametresi tarafından istenenden daha az sonuçla sonuçlanacaktır. |
VectorizableImageBinaryQuery
Vektörleştirilmesi gereken bir görüntünün temel 64 kodlanmış ikili dosyası sağlandığında vektör araması için kullanılacak sorgu parametreleri.
| Name | Tür | Description |
|---|---|---|
| base64Image |
string |
Bir vektör arama sorgusu gerçekleştirmek için vektörleştirilecek bir görüntünün 64 tabanlı kodlanmış ikili dosyası. |
| 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ı. |
| filterOverride |
string |
Bu özel vektör sorgusuna uygulanacak OData filtre ifadesi. Vektör düzeyinde hiçbir filtre ifadesi tanımlanmamışsa, bunun yerine en üst düzey filtre parametresinde tanımlanan ifade kullanılır. |
| k |
integer (int32) |
En çok isabet alan olarak döndürülecek en yakın komşu sayısı. |
| kind |
string:
image |
Sorgu 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. |
| perDocumentVectorLimit |
integer (int32) |
Bir vektör arama sorgusunda her belgeden kaç vektörün eşleştirilebileceğini kontrol eder. Bunu 1 olarak ayarlamak, belge başına en fazla bir vektörün eşleşmesini sağlayarak sonuçların farklı belgelerden gelmesini garanti eder. 0 (sınırsız) olarak ayarlamak, aynı belgeden birden çok ilgili vektörün eşleştirilmesine izin verir. Varsayılan değer 0'dır. |
| threshold | VectorThreshold: |
Vektör sorguları için kullanılan eşik. Bunun yalnızca tüm 'alanlar' aynı benzerlik ölçümünü kullandığında ayarlanabileceğini unutmayın. |
| 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. |
VectorizableImageUrlQuery
Vektörleştirilmesi gereken bir görüntü değerini temsil eden bir URL 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ı. |
| filterOverride |
string |
Bu özel vektör sorgusuna uygulanacak OData filtre ifadesi. Vektör düzeyinde hiçbir filtre ifadesi tanımlanmamışsa, bunun yerine en üst düzey filtre parametresinde tanımlanan ifade kullanılır. |
| k |
integer (int32) |
En çok isabet alan olarak döndürülecek en yakın komşu sayısı. |
| kind |
string:
image |
Sorgu 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. |
| perDocumentVectorLimit |
integer (int32) |
Bir vektör arama sorgusunda her belgeden kaç vektörün eşleştirilebileceğini kontrol eder. Bunu 1 olarak ayarlamak, belge başına en fazla bir vektörün eşleşmesini sağlayarak sonuçların farklı belgelerden gelmesini garanti eder. 0 (sınırsız) olarak ayarlamak, aynı belgeden birden çok ilgili vektörün eşleştirilmesine izin verir. Varsayılan değer 0'dır. |
| threshold | VectorThreshold: |
Vektör sorguları için kullanılan eşik. Bunun yalnızca tüm 'alanlar' aynı benzerlik ölçümünü kullandığında ayarlanabileceğini unutmayın. |
| url |
string |
Vektör arama sorgusu gerçekleştirmek için vektörleştirilecek görüntünün URL'si. |
| 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. |
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ı. |
| filterOverride |
string |
Bu özel vektör sorgusuna uygulanacak OData filtre ifadesi. Vektör düzeyinde hiçbir filtre ifadesi tanımlanmamışsa, bunun yerine en üst düzey filtre parametresinde tanımlanan ifade kullanılır. |
| k |
integer (int32) |
En çok isabet alan olarak döndürülecek en yakın komşu sayısı. |
| kind |
string:
text |
Sorgu 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. |
| perDocumentVectorLimit |
integer (int32) |
Bir vektör arama sorgusunda her belgeden kaç vektörün eşleştirilebileceğini kontrol eder. Bunu 1 olarak ayarlamak, belge başına en fazla bir vektörün eşleşmesini sağlayarak sonuçların farklı belgelerden gelmesini garanti eder. 0 (sınırsız) olarak ayarlamak, aynı belgeden birden çok ilgili vektörün eşleştirilmesine izin verir. Varsayılan değer 0'dır. |
| queryRewrites |
Oluşturucu modelin sorguyu vektörleştirilmeye göndermeden önce yeniden yazmasına izin verecek şekilde yapılandırılabilir. |
|
| text |
string |
Vektör arama sorgusu gerçekleştirmek için vektörleştirilecek metin. |
| threshold | VectorThreshold: |
Vektör sorguları için kullanılan eşik. Bunun yalnızca tüm 'alanlar' aynı benzerlik ölçümünü kullandığında ayarlanabileceğini unutmayın. |
| 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. |
VectorizedQuery
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ı. |
| filterOverride |
string |
Bu özel vektör sorgusuna uygulanacak OData filtre ifadesi. Vektör düzeyinde hiçbir filtre ifadesi tanımlanmamışsa, bunun yerine en üst düzey filtre parametresinde tanımlanan ifade kullanılır. |
| k |
integer (int32) |
En çok isabet alan olarak döndürülecek en yakın komşu sayısı. |
| kind |
string:
vector |
Sorgu 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. |
| perDocumentVectorLimit |
integer (int32) |
Bir vektör arama sorgusunda her belgeden kaç vektörün eşleştirilebileceğini kontrol eder. Bunu 1 olarak ayarlamak, belge başına en fazla bir vektörün eşleşmesini sağlayarak sonuçların farklı belgelerden gelmesini garanti eder. 0 (sınırsız) olarak ayarlamak, aynı belgeden birden çok ilgili vektörün eşleştirilmesine izin verir. Varsayılan değer 0'dır. |
| threshold | VectorThreshold: |
Vektör sorguları için kullanılan eşik. Bunun yalnızca tüm 'alanlar' aynı benzerlik ölçümünü kullandığında ayarlanabileceğini unutmayın. |
| 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. |
VectorQueryKind
Gerçekleştirilen vektör sorgusunun türü.
| Değer | Description |
|---|---|
| vector |
Ham vektör değerinin sağlandığı vektör sorgusu. |
| text |
Vektörleştirilmesi gereken bir metin değerinin sağlandığı vektör sorgusu. |
| imageUrl |
Vektörleştirilmesi gereken bir görüntü değerini temsil eden bir url'nin sağlandığı vektör sorgusu. |
| imageBinary |
Vektörleştirilmesi gereken bir görüntünün 64 tabanlı kodlanmış ikili dosyasının sağlandığı vektör sorgusu. |
VectorsDebugInfo
"Vektör ve hibrit arama için özel hata ayıklama bilgisi içerir.")
| Name | Tür | Description |
|---|---|---|
| subscores |
RRF gibi seçilen sonuç kümesi füzyon/kombinasyon yönteminden önce belgenin alt puanlarının dökümü. |
VectorSimilarityThreshold
Vektör sorgusunun sonuçları vektör benzerliği ölçümüne göre filtrelenir. Bunun benzerlik ölçümünün kurallı tanımı olduğunu, 'uzaklık' sürümünün olmadığını unutmayın. Eşik yönü (daha büyük veya daha küçük) alan tarafından kullanılan ölçüme göre otomatik olarak seçilir.
| Name | Tür | Description |
|---|---|---|
| kind |
string:
vector |
Eşik türü. |
| value |
number (double) |
Eşik, benzerlik metriği değerine göre filtrelenir. Bunun benzerlik ölçümünün kurallı tanımı olduğunu, 'uzaklık' sürümünün olmadığını unutmayın. Eşik yönü (daha büyük veya daha küçük) alan tarafından kullanılan ölçüme göre otomatik olarak seçilir. |
VectorThresholdKind
Vektör sorgularını filtrelemek için kullanılan eşik türü.
| Değer | Description |
|---|---|
| vectorSimilarity |
Vektör sorgusunun sonuçları vektör benzerliği ölçümüne göre filtrelenir. Bunun benzerlik ölçümünün kurallı tanımı olduğunu, 'uzaklık' sürümünün olmadığını unutmayın. Eşik yönü (daha büyük veya daha küçük) alan tarafından kullanılan ölçüme göre otomatik olarak seçilir. |
| searchScore |
Vektör sorgusunun sonuçları '@search.score' değerine göre filtrelenir. Bunun, arama yanıtının bir parçası olarak döndürülen @search.score olduğunu unutmayın. Eşik yönü daha yüksek @search.scoreiçin seçilir. |