Documents - Search Post

參考

服務:: Search Service

API 版本:: 2024-05-01-preview

在索引中搜尋檔。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	搜尋服務的端點 URL。
indexName	path	True	string	索引的名稱。
api-version	query	True	string	用戶端 API 版本。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string uuid	使用要求傳送的追蹤標識碼，以協助偵錯。

要求本文

名稱	類型	Description
answers	QueryAnswerType	值，指定是否應該在搜尋回應中傳回答案。
captions	QueryCaptionType	值，指定是否應該在搜尋回應中傳回標題。
count	boolean	值，指定是否擷取結果總數。預設值為 false。將此值設定為 true 可能會影響效能。請注意，傳回的計數是一個近似值。
debug	QueryDebugMode	啟用偵錯工具，可用來進一步探索您重新建立的結果。
facets	string[]	要套用至搜尋查詢的Facet表達式清單。每個 Facet 運算式都包含功能變數名稱，選擇性地後面接著以逗號分隔的名稱：值組清單。
filter	string	要套用至搜尋查詢的 OData $filter表示式。
highlight	string	要用於點擊醒目提示的功能變數名稱逗號分隔清單。只有可搜尋的欄位可用於點擊醒目提示。
highlightPostTag	string	附加至點擊醒目提示的字串標籤。必須使用 highlightPreTag 進行設定。預設值為 </em>。
highlightPreTag	string	前面加上叫用醒目提示的字串標記。必須使用 highlightPostTag 來設定。預設值為 <em>。
hybridSearch	HybridSearch[]	用來設定混合式搜尋行為的查詢參數。
minimumCoverage	number	介於 0 到 100 之間的數位，表示搜尋查詢必須涵蓋的索引百分比，以便將查詢回報為成功。即使只有一個複本的服務，此參數也有助於確保搜尋可用性。預設值為 100。
orderby	string	OData 的逗號分隔清單$orderby表達式，用來排序結果。每個表達式可以是功能變數名稱或呼叫 geo.distance () 或 search.score () 函式。每個表達式後面可以接著 asc 來表示遞增，或 desc 表示遞減。預設值為遞增排序。繫結將透過文件的相符分數來中斷。如果未指定任何$orderby，預設排序順序會依檔比對分數遞減。最多可以有 32 個$orderby子句。
queryLanguage	QueryLanguage	值，指定搜尋查詢的語言。
queryType	QueryType	值，指定搜尋查詢的語法。預設值為『simple』。如果您的查詢使用 Lucene 查詢語法，請使用『full』。
scoringParameters	string[]	例如，參考PointParameter) 格式名稱值，用於評分函式的參數值清單 (。例如，如果評分配置檔使用名為『mylocation』的參數定義函式，則參數位符串會是 “mylocation--122.2,44.8” (，但不含引號) 。
scoringProfile	string	評分設定檔名稱，用以評估相符文件的符合分數，以便排序結果。
scoringStatistics	ScoringStatistics	值，指定我們想要計算評分統計數據 (，例如檔頻率) 全域進行更一致的評分，或在本機計算延遲較低。預設值為『local』。使用『global』在評分之前全域匯總評分統計數據。使用全域評分統計數據可能會增加搜尋查詢的延遲。
search	string	全文搜索查詢表達式;使用「*」或省略此參數以符合所有檔。
searchFields	string	要限定全文搜索範圍的功能變數名稱逗號分隔清單。在完整的 Lucene 查詢中使用字段搜尋 (fieldName：searchExpression) 時，每個字段搜尋表達式的功能變數名稱優先於此參數所列的任何功能變數名稱。
searchMode	SearchMode	值，指定是否必須比對任何或所有搜尋字詞，才能將檔計算為相符專案。
select	string	要擷取的欄位逗號分隔清單。若未指定，即會包含結構描述中標記為可抓取的所有欄位。
semanticConfiguration	string	處理類型語意查詢的檔時，將使用的語意組態名稱。
semanticErrorHandling	SemanticErrorMode	允許使用者選擇語意呼叫是否應該完全失敗，或傳回部分結果， (預設) 。
semanticFields	string	用於語意排名的功能變數名稱逗號分隔清單。
semanticMaxWaitInMilliseconds	integer	允許使用者在要求失敗之前，設定語意擴充完成處理所需的時間上限。
semanticQuery	string	允許設定個別的搜尋查詢，此查詢將僅用於語意重新調整、語意標題和語意答案。對於需要使用基底擷取和排名階段和 L2 語意階段之間不同查詢的案例很有用。
sessionId	string	用來建立黏性會話的值，有助於取得更一致的結果。只要使用相同的 sessionId，就會嘗試以相同的副本集為目標。請小心重複重複使用相同的 sessionID 值，可能會干擾跨複本的要求負載平衡，並對搜尋服務的效能造成負面影響。作為 sessionId 使用的值不能以 ' _ ' 字元開頭。
skip	integer	要略過的搜尋結果數目。此值不可大於 100,000。如果您需要依序掃描檔，但因為這項限制而無法使用skip，請考慮改為在完全排序的索引鍵上使用orderby，並使用範圍查詢進行篩選。
speller	QuerySpellerType	值，指定用於拼字更正個別搜尋查詢字詞的拼字檢查類型。
top	integer	要擷取的搜尋結果數目。這可以與$skip搭配使用，以實作搜尋結果的用戶端分頁。如果因伺服器端分頁而截斷結果，回應會包含接續令牌，可用來發出下一頁結果的另一個搜尋要求。
vectorFilterMode	VectorFilterMode	判斷是否在執行向量搜尋之前或之後套用篩選。默認值為『preFilter』。
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[] VectorizableImageUrlQuery[] VectorizableImageBinaryQuery[]	向量和混合式搜尋查詢的查詢參數。

回應

名稱	類型	Description
200 OK	SearchDocumentsResult	包含符合搜尋準則的文件回應。
Other Status Codes	ErrorResponse	錯誤回應。

範例

SearchIndexSearchDocumentsPost

範例要求

HTTP

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

{
  "count": true,
  "facets": [
    "category,count:10,sort:count"
  ],
  "filter": "rating gt 4.0",
  "highlight": "description",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "hybridSearch": {
    "maxTextRecallSize": 100,
    "countAndFacetMode": "countAllResults"
  },
  "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,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,
      "threshold": {
        "kind": "vectorSimilarity",
        "value": 0.8
      }
    }
  ],
  "vectorFilterMode": "preFilter"
}

範例回覆

狀態碼:: 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>",
    "hybridSearch": {
      "maxTextRecallSize": 100,
      "countAndFacetMode": "countAllResults"
    },
    "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-05-01-preview"
}

定義

名稱	Description
AnswerResult	答案是從符合查詢的最相關文件內容中擷取的文字段落。答案會從頂端搜尋結果中擷取。答案候選項目會評分，並選取頂端答案。
CaptionResult	標題是相對於搜尋查詢的檔最有代表性的段落。它們通常用來做為文件摘要。標題只會針對類型為『semantic』的查詢傳回。
DocumentDebugInfo	包含可用來進一步探索搜尋結果的偵錯資訊。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
HybridCountAndFacetMode	判斷計數和 Facet 是否應該包含符合搜尋查詢的所有檔，或只包含 'maxTextRecallSize' 視窗中擷取的檔。默認值為『countAllResults』。
HybridSearch	設定混合式搜尋行為的查詢參數。
QueryAnswerType	值，指定是否應該在搜尋回應中傳回答案。
QueryCaptionType	值，指定是否應該在搜尋回應中傳回標題。
QueryDebugMode	啟用可用來進一步探索搜尋結果的偵錯工具。
QueryLanguage	查詢的語言。
QueryResultDocumentRerankerInput	傳送至語意擴充程式的原始串連字串。
QueryResultDocumentSemanticField	傳送至語意擴充程式的字段描述，以及其使用方式
QuerySpellerType	值，指定用於拼字更正個別搜尋查詢字詞的拼字檢查類型。
QueryType	指定搜尋查詢的語法。預設值為『simple』。如果您的查詢使用 Lucene 查詢語法，則使用『full』，如果不需要查詢語法，請使用 'semantic'。
RawVectorQuery	提供原始向量值時，用於向量搜尋的查詢參數。
ScoringStatistics	值，指定我們想要計算評分統計數據 (，例如檔頻率) 全域進行更一致的評分，或在本機計算延遲較低。預設值為『local』。使用『global』在評分之前全域匯總評分統計數據。使用全域評分統計數據可能會增加搜尋查詢的延遲。
SearchDocumentsResult	包含索引搜尋結果的回應。
SearchMode	指定必須符合任何或所有的搜尋字詞，才能將文件視為相符項目。
SearchRequest	篩選、排序、Facet、分頁和其他搜尋查詢行為的參數。
SearchResult	包含搜尋查詢所找到的檔，加上相關聯的元數據。
SearchScoreThreshold	向量查詢的結果會根據『@search.score』值進行篩選。請注意，這是 @search.score 在搜尋回應中傳回的。系統會針對較高的 @search.score選擇臨界值方向。
SemanticDebugInfo
SemanticErrorMode	允許使用者選擇語意呼叫應該完全失敗，或傳回部分結果 (預設) 。
SemanticErrorReason	針對語意排名要求傳回部分回應的原因。
SemanticFieldState	欄位用於語意擴充程式的方式， (完全使用、部分使用或未使用的)
SemanticSearchResultsType	針對語意排名要求傳回的部分回應類型。
VectorFilterMode	判斷是否在執行向量搜尋之前或之後套用篩選。
VectorizableImageBinaryQuery	提供需要向量化之影像的基底 64 編碼二進位檔時，要用於向量搜尋的查詢參數。
VectorizableImageUrlQuery	提供代表需要向量化之影像值的 URL 時，用於向量搜尋的查詢參數。
VectorizableTextQuery	提供需要向量化的文字值時，用於向量搜尋的查詢參數。
VectorQueryKind	正在執行的向量查詢種類。
VectorSimilarityThreshold	系統會根據向量相似度計量來篩選向量查詢的結果。請注意，這是相似度計量標準標準的定義，而不是「距離」版本。系統會根據欄位所使用的計量，自動選擇 (較大或較小) 的臨界值方向。
VectorThresholdKind	正在執行的向量查詢種類。

AnswerResult

答案是從符合查詢的最相關文件內容中擷取的文字段落。答案會從頂端搜尋結果中擷取。答案候選項目會評分，並選取頂端答案。

名稱	類型	Description
highlights	string	與 Text 屬性中的文字段落相同，其中醒目提示的文字片語與查詢最相關。
key	string	擷取答案的檔索引鍵。
score	number	分數值代表與查詢所傳回之其他答案的查詢相關程度。
text	string	從文件內容擷取的文字段落作為答案。

CaptionResult

標題是相對於搜尋查詢的檔最有代表性的段落。它們通常用來做為文件摘要。標題只會針對類型為『semantic』的查詢傳回。

名稱	類型	Description
highlights	string	與 Text 屬性中的文字段落相同，其中醒目提示的片語與查詢最相關。
text	string	從與搜尋查詢最相關的檔擷取的代表性文字段落。

DocumentDebugInfo

包含可用來進一步探索搜尋結果的偵錯資訊。

名稱	類型	Description
semantic	SemanticDebugInfo	包含語意排名要求特有的偵錯資訊。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

HybridCountAndFacetMode

判斷計數和 Facet 是否應該包含符合搜尋查詢的所有檔，或只包含 'maxTextRecallSize' 視窗中擷取的檔。默認值為『countAllResults』。

名稱	類型	Description
countAllResults	string	不論這些檔是否在『maxTextRecallSize』擷取視窗中，計算 'count' 和 'facet' 時，包含搜尋查詢比對的所有檔。
countRetrievableResults	string	只有在計算 'count' 和 'facet' 時，才會在 'maxTextRecallSize' 擷取視窗中包含相符的檔。

HybridSearch

設定混合式搜尋行為的查詢參數。

名稱	類型	Description
countAndFacetMode	HybridCountAndFacetMode	判斷計數和 Facet 是否應該包含符合搜尋查詢的所有檔，或只包含 'maxTextRecallSize' 視窗中擷取的檔。
maxTextRecallSize	integer	決定混合式搜尋要求之文字查詢部分要擷取的文件數目上限。這些檔會與符合向量查詢的檔結合，以產生單一最終的結果清單。選擇較大的 maxTextRecallSize 值可讓擷取和分頁更多檔， (使用頂端和略過參數) ，但代價是資源使用率較高和延遲較高。此值必須介於 1 到 10,000 之間。預設值為 1000。

QueryAnswerType

值，指定是否應該在搜尋回應中傳回答案。

名稱	類型	Description
extractive	string	從傳回的文件內容擷取答案候選專案，以回應以自然語言表示的查詢。
none	string	請勿傳回查詢的答案。

QueryCaptionType

值，指定是否應該在搜尋回應中傳回標題。

名稱	類型	Description
extractive	string	從包含與搜尋查詢相關的段落的相符檔中擷取標題。
none	string	請勿傳回查詢的標題。

QueryDebugMode

啟用可用來進一步探索搜尋結果的偵錯工具。

名稱	類型	Description
disabled	string	不會傳回任何查詢偵錯資訊。
semantic	string	允許用戶進一步探索其重新排名的結果。

QueryLanguage

查詢的語言。

名稱	類型	Description
ar-eg	string	阿拉伯文 (巴) 的查詢語言值。
ar-jo	string	阿拉伯 () 的查詢語言值。
ar-kw	string	阿拉伯文 () 的查詢語言值。
ar-ma	string	阿拉伯文 () 的查詢語言值。
ar-sa	string	阿拉伯文 (阿拉伯文) 的查詢語言值。
bg-bg	string	波蘭文 () 的查詢語言值。
bn-in	string	印度 (的查詢語言值) 。
ca-es	string	卡達尼亞文的查詢語言值。
cs-cz	string	捷克 (捷克文) 的查詢語言值。
da-dk	string	丹麥 (丹麥) 的查詢語言值。
de-de	string	德國 (德國) 的查詢語言值。
el-gr	string	希臘 (希臘) 的查詢語言值。
en-au	string	英文 (澳洲) 的查詢語言值。
en-ca	string	加拿大 (英文) 的查詢語言值。
en-gb	string	英文 (英國) 的查詢語言值。
en-in	string	印度 (英文) 的查詢語言值。
en-us	string	英文 (美國) 的查詢語言值。
es-es	string	西班牙文 (西班牙) 的查詢語言值。
es-mx	string	西班牙文 (墨西哥) 的查詢語言值。
et-ee	string	(愛沙尼亞文) 的查詢語言值。
eu-es	string	Basque 的查詢語言值。
fa-ae	string	查詢 (美式 ) 的語言值。
fi-fi	string	芬蘭文 (芬蘭) 的查詢語言值。
fr-ca	string	加拿大法文 () 的查詢語言值。
fr-fr	string	法文 (法國) 的查詢語言值。
ga-ie	string	愛爾蘭 (愛爾蘭) 的查詢語言值。
gl-es	string	Galician 的查詢語言值。
gu-in	string	) 印度 (的 Gujarati (查詢語言值。
he-il	string	希伯來文 (以色列) 的查詢語言值。
hi-in	string	印度 (印度) 的查詢語言值。
hr-ba	string	波士尼亞和赫塞哥維納 () 的查詢語言值。
hr-hr	string	克羅埃西亞 (克羅埃西亞) 的查詢語言值。
hu-hu	string	匈牙利文 (匈牙利文) 的查詢語言值。
hy-am	string	亞美尼亞文 () 的查詢語言值。
id-id	string	印尼 (印尼 (印尼) 的查詢語言值。
is-is	string	) 的查詢語言值 () 。
it-it	string	義大利文 (義大利) 的查詢語言值。
ja-jp	string	日文 (日本) 的查詢語言值。
kn-in	string	Kannada (印度) 的查詢語言值。
ko-kr	string	韓文 (韓文) 的查詢語言值。
lt-lt	string	立陶宛 (立陶宛) 的查詢語言值。
lv-lv	string	查詢 () 的查詢語言值。
ml-in	string	印度 (馬來亞文) 的查詢語言值。
mr-in	string	Marathi (印度) 的查詢語言值。
ms-bn	string	馬來亞文 (文達斯alam) 的查詢語言值。
ms-my	string	馬來亞 (馬來西亞) 的查詢語言值。
nb-no	string	挪威文 (挪威) 的查詢語言值。
nl-be	string	荷蘭文 (比利時) 的查詢語言值。
nl-nl	string	荷蘭 (荷蘭) 的查詢語言值。
no-no	string	挪威文 (挪威) 的查詢語言值。
none	string	未指定查詢語言。
pa-in	string	印度 (的查詢語言值) 。
pl-pl	string	波蘭 (波蘭) 的查詢語言值。
pt-br	string	巴西) 葡萄牙文 (查詢語言值。
pt-pt	string	葡萄牙 (葡萄牙) 的查詢語言值。
ro-ro	string	羅馬尼亞文 (羅馬尼亞文) 的查詢語言值。
ru-ru	string	俄文 (俄羅斯) 的查詢語言值。
sk-sk	string	斯洛伐克文 () 的查詢語言值。
sl-sl	string	斯洛維尼亞文 (斯洛維尼亞) 的查詢語言值。
sr-ba	string	塞爾維亞文 (波士尼亞和赫塞哥維納) 的查詢語言值。
sr-me	string	塞爾維亞文 (塞爾維亞文) 的查詢語言值。
sr-rs	string	塞爾維亞 (塞爾維亞) 的查詢語言值。
sv-se	string	瑞典文 () 的查詢語言值。
ta-in	string	印度 (Tamil) 的查詢語言值。
te-in	string	印度 (Telugu) 的查詢語言值。
th-th	string	泰文 (泰文) 的查詢語言值。
tr-tr	string	土耳其文 (土耳其) 的查詢語言值。
uk-ua	string	(烏克蘭) 的查詢語言值。
ur-pk	string	Urdu (印度) 的查詢語言值。
vi-vn	string	越南文 (越南) 的查詢語言值。
zh-cn	string	中文 (中國) 的查詢語言值。
zh-tw	string	中文 (臺灣) 的查詢語言值。

QueryResultDocumentRerankerInput

傳送至語意擴充程式的原始串連字串。

名稱	類型	Description
content	string	用於語意擴充之內容字段的原始串連字串。
keywords	string	用於語意擴充之關鍵詞字段的原始串連字串。
title	string	用於語意擴充之標題字段的原始字串。

QueryResultDocumentSemanticField

傳送至語意擴充程式的字段描述，以及其使用方式

名稱	類型	Description
name	string	傳送至語意擴充程式的功能變數名稱
state	SemanticFieldState	欄位用於語意擴充程式的方式， (完全使用、部分使用或未使用的)

QuerySpellerType

值，指定用於拼字更正個別搜尋查詢字詞的拼字檢查類型。

名稱	類型	Description
lexicon	string	拼字檢查會針對 queryLanguage 參數所指定的語言使用靜態語彙更正個別查詢字詞。
none	string	未啟用拼字檢查。

QueryType

指定搜尋查詢的語法。預設值為『simple』。如果您的查詢使用 Lucene 查詢語法，則使用『full』，如果不需要查詢語法，請使用 'semantic'。

名稱	類型	Description
full	string	使用完整的 Lucene 查詢語法進行搜尋。搜尋文字是使用 Lucene 查詢語言來解譯，其允許欄位特定和加權搜尋，以及其他進階功能。
semantic	string	最適合以自然語言表示的查詢，而不是關鍵詞。使用在 Web 主體上定型的排名模型，重新排名前幾名搜尋結果，以改善搜尋結果的精確度。
simple	string	使用簡單的查詢語法進行搜尋。搜尋文字是使用簡單的查詢語言來解譯，允許使用 +、* 和 “” 等符號。除非指定 searchFields 參數，否則預設會評估所有可搜尋字段的查詢。

RawVectorQuery

提供原始向量值時，用於向量搜尋的查詢參數。

名稱	類型	Description
exhaustive	boolean	當為 true 時，會跨向量索引內的所有向量觸發詳盡的 K 近鄰搜尋。適用於完全相符專案很重要的案例，例如判斷基礎真值。
fields	string	集合類型的向量欄位 (Edm.Single) 要包含在搜尋的向量中。
k	integer	要當做前幾個點擊傳回的近鄰數目。
kind	string: vector	正在執行的向量查詢種類。
oversampling	number	過度取樣因數。最小值為 1。它會覆寫索引定義中設定的『defaultOversampling』參數。只有當 'rerankWithOriginalVectors' 為 true 時，才能設定它。只有在基礎向量欄位上使用壓縮方法時，才允許此參數。
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	用於向量查詢的臨界值。請注意，只有在所有 'fields' 都使用相同的相似度計量時，才能設定此設定。
vector	number[]	搜尋查詢的向量表示。
weight	number	相較於其他向量查詢和/或相同搜尋要求內的文字查詢，向量查詢的相對權數。結合不同向量查詢所產生的多個排名清單結果，以及/或透過文字查詢擷取的結果時，會使用這個值。權數越高，符合該查詢的檔就會在最終排名中。默認值為 1.0，且值必須是大於零的正數。

ScoringStatistics

值，指定我們想要計算評分統計數據 (，例如檔頻率) 全域進行更一致的評分，或在本機計算延遲較低。預設值為『local』。使用『global』在評分之前全域匯總評分統計數據。使用全域評分統計數據可能會增加搜尋查詢的延遲。

名稱	類型	Description
global	string	評分統計數據會以全域方式計算，以取得更一致的評分。
local	string	評分統計數據將會在本機計算，以降低延遲。

SearchDocumentsResult

包含索引搜尋結果的回應。

名稱	類型	Description
@odata.count	integer	搜尋作業找到的結果總數，如果未要求計數，則為 null。如果存在，計數可能會大於此回應中的結果數目。如果您使用$top或$skip參數，或查詢無法在單一回應中傳回所有要求的檔，就會發生這種情況。
@odata.nextLink	string	當查詢無法傳回單一回應中所有要求的結果時，傳回的接續 URL。您可以使用此 URL 來制訂另一個 GET 或 POST 搜尋要求，以取得搜尋回應的下一個部分。請務必使用與產生此回應的要求相同的動詞 (GET 或 POST) 。
@search.answers	AnswerResult[]	搜尋作業的答案查詢結果;如果未指定答案查詢參數或設定為『none』，則為 null。
@search.coverage	number	值，指出查詢中包含的索引百分比，如果要求中未指定 minimumCoverage，則為 null。
@search.facets	object	搜尋作業的Facet查詢結果，組織為每個多面向字段的貯體集合;如果查詢未包含任何 Facet 運算式，則為 null。
@search.nextPageParameters	SearchRequest	當查詢無法傳回單一回應中所有要求的結果時，傳回的接續 JSON 承載。您可以使用此 JSON 與 @odata.nextLink 來制訂另一個 POST 搜尋要求，以取得搜尋回應的下一個部分。
@search.semanticPartialResponseReason	SemanticErrorReason	針對語意排名要求傳回部分回應的原因。
@search.semanticPartialResponseType	SemanticSearchResultsType	針對語意排名要求傳回的部分回應類型。
value	SearchResult[]	查詢所傳回的結果序列。

SearchMode

指定必須符合任何或所有的搜尋字詞，才能將文件視為相符項目。

名稱	類型	Description
all	string	所有搜尋字詞都必須相符，才能將檔計算為相符專案。
any	string	任何搜尋字詞都必須相符，才能將檔計算為相符專案。

SearchRequest

篩選、排序、Facet、分頁和其他搜尋查詢行為的參數。

名稱	類型	Description
answers	QueryAnswerType	值，指定是否應該在搜尋回應中傳回答案。
captions	QueryCaptionType	值，指定是否應該在搜尋回應中傳回標題。
count	boolean	值，指定是否擷取結果總數。預設值為 false。將此值設定為 true 可能會影響效能。請注意，傳回的計數是一個近似值。
debug	QueryDebugMode	啟用偵錯工具，可用來進一步探索重新排名的結果。
facets	string[]	要套用至搜尋查詢的Facet表達式清單。每個 Facet 運算式都包含功能變數名稱，選擇性地後面接著以逗號分隔的名稱：值組清單。
filter	string	要套用至搜尋查詢的 OData $filter表示式。
highlight	string	要用於點擊醒目提示的功能變數名稱逗號分隔清單。只有可搜尋的欄位可用於點擊醒目提示。
highlightPostTag	string	附加至點擊醒目提示的字串標籤。必須使用 highlightPreTag 進行設定。預設值為 </em>。
highlightPreTag	string	前面加上叫用醒目提示的字串標記。必須使用 highlightPostTag 來設定。預設值為 <em>。
hybridSearch	HybridSearch[]	設定混合式搜尋行為的查詢參數。
minimumCoverage	number	介於 0 到 100 之間的數位，表示搜尋查詢必須涵蓋的索引百分比，以便將查詢回報為成功。即使只有一個複本的服務，此參數也有助於確保搜尋可用性。預設值為 100。
orderby	string	OData 的逗號分隔清單$orderby表達式，用來排序結果。每個表達式可以是功能變數名稱或呼叫 geo.distance () 或 search.score () 函式。每個表達式後面可以接著 asc 來表示遞增，或 desc 表示遞減。預設值為遞增排序。繫結將透過文件的相符分數來中斷。如果未指定任何$orderby，預設排序順序會依檔比對分數遞減。最多可以有 32 個$orderby子句。
queryLanguage	QueryLanguage	值，指定搜尋查詢的語言。
queryType	QueryType	值，指定搜尋查詢的語法。預設值為『simple』。如果您的查詢使用 Lucene 查詢語法，請使用『full』。
scoringParameters	string[]	例如，referencePointParameter) 格式名稱值，用於評分函式 (的參數值清單。例如，如果評分配置檔使用名為『mylocation』的參數來定義函式，則參數位符串會是 “mylocation--122.2,44.8” (，但不含引號) 。
scoringProfile	string	評分設定檔名稱，用以評估相符文件的符合分數，以便排序結果。
scoringStatistics	ScoringStatistics	值，指定我們想要計算評分統計數據 (，例如檔頻率) 全域進行更一致的評分，或在本機計算延遲較低。預設值為『local』。使用『global』在評分之前全域匯總評分統計數據。使用全域評分統計數據可能會增加搜尋查詢的延遲。
search	string	全文搜索查詢表達式;使用「*」或省略此參數來比對所有檔。
searchFields	string	要設定全文搜索範圍的功能變數名稱逗號分隔清單。在完整的 Lucene 查詢中使用字段搜尋 (fieldName：searchExpression) 時，每個字段搜尋表達式的功能變數名稱會優先於此參數中列出的任何功能變數名稱。
searchMode	SearchMode	值，指定是否必須比對任何或所有搜尋字詞，才能將檔計算為相符專案。
select	string	要擷取的欄位逗號分隔清單。若未指定，即會包含結構描述中標記為可抓取的所有欄位。
semanticConfiguration	string	處理語意類型查詢的檔時，將使用的語意組態名稱。
semanticErrorHandling	SemanticErrorMode	允許使用者選擇語意呼叫應該完全失敗，或傳回部分結果 (預設) 。
semanticFields	string	用於語意排名的功能變數名稱逗號分隔清單。
semanticMaxWaitInMilliseconds	integer	允許使用者在要求失敗之前，設定語意擴充完成處理所需的時間上限。
semanticQuery	string	允許設定單獨用於語意重新調整、語意標題和語意答案的個別搜尋查詢。適用於需要在基底擷取和排名階段和 L2 語意階段之間使用不同的查詢的情況。
sessionId	string	用來建立黏性會話的值，有助於取得更一致的結果。只要使用相同的 sessionId，就會嘗試以相同的副本集為目標。請小心重複重複使用相同的 sessionID 值，可能會干擾跨複本的要求負載平衡，並對搜尋服務的效能造成負面影響。作為 sessionId 使用的值不能以 ' _ ' 字元開頭。
skip	integer	要略過的搜尋結果數目。此值不可大於 100,000。如果您需要依序掃描檔，但因這項限制而無法使用skip，請考慮改用orderby在完全排序的索引鍵上，並使用範圍查詢進行篩選。
speller	QuerySpellerType	值，指定用於拼字更正個別搜尋查詢字詞的拼字檢查類型。
top	integer	要擷取的搜尋結果數目。這可以與$skip搭配使用，以實作搜尋結果的用戶端分頁。如果結果因伺服器端分頁而截斷，回應會包含接續令牌，可用來發出下一頁結果的另一個搜尋要求。
vectorFilterMode	VectorFilterMode	判斷是否在執行向量搜尋之前或之後套用篩選。默認值為『preFilter』。
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[]	向量和混合式搜尋查詢的查詢參數。

SearchResult

包含搜尋查詢所找到的檔，加上相關聯的元數據。

名稱	類型	Description
@search.captions	CaptionResult[]	標題是相對於搜尋查詢的檔最有代表性的段落。它們通常用來做為文件摘要。只有『semantic』類型的查詢才會傳回標題。
@search.documentDebugInfo	DocumentDebugInfo[]	包含可用來進一步探索搜尋結果的偵錯資訊。
@search.highlights	object	檔中指出相符搜尋字詞的文字片段，依每個適用字段組織;如果查詢未啟用點擊醒目提示，則為 null。
@search.rerankerScore	number	由最上層搜尋結果的語意排名器所計算的相關性分數。搜尋結果會先依 RerankerScore 排序，然後再依分數排序。 RerankerScore 只會針對類型為 'semantic' 的查詢傳回。
@search.score	number	相較於查詢傳回的其他文件，文件的相關性分數。

SearchScoreThreshold

向量查詢的結果會根據『@search.score』值進行篩選。請注意，這是 @search.score 在搜尋回應中傳回的。系統會針對較高的 @search.score選擇臨界值方向。

名稱	類型	Description
kind	string: searchScore	用來篩選向量查詢的臨界值種類
value	number	閾值會根據『@search.score』值進行篩選。請注意，這是 @search.score 在搜尋回應中傳回的。系統會針對較高的 @search.score選擇臨界值方向。

SemanticDebugInfo

名稱	類型	Description
contentFields	QueryResultDocumentSemanticField[]	傳送至語意擴充程序的內容欄位，以及其使用方式
keywordFields	QueryResultDocumentSemanticField[]	傳送至語意擴充程序的關鍵詞欄位，以及它們的使用方式
rerankerInput	QueryResultDocumentRerankerInput	傳送至語意擴充程式的原始串連字串。
titleField	QueryResultDocumentSemanticField	傳送至語意擴充程式的標題字段，以及其使用方式

SemanticErrorMode

允許使用者選擇語意呼叫應該完全失敗，或傳回部分結果 (預設) 。

名稱	類型	Description
fail	string	如果在語意處理步驟期間發生例外狀況，查詢將會失敗，並根據錯誤傳回適當的 HTTP 程式代碼。
partial	string	如果語意處理失敗，部分結果仍會傳回。部分結果的定義取決於哪個語意步驟失敗，以及失敗的原因為何。

SemanticErrorReason

針對語意排名要求傳回部分回應的原因。

名稱	類型	Description
capacityOverloaded	string	要求已節流處理。只會傳回基底結果。
maxWaitExceeded	string	如果已設定『semanticMaxWaitInMilliseconds』，且語意處理持續時間超過該值。只會傳回基底結果。
transient	string	至少一個步驟的語意程序失敗。

SemanticFieldState

欄位用於語意擴充程式的方式， (完全使用、部分使用或未使用的)

名稱	類型	Description
partial	string	欄位部分用於語意擴充。
unused	string	欄位未用於語意擴充。
used	string	欄位已完全用於語意擴充。

SemanticSearchResultsType

針對語意排名要求傳回的部分回應類型。

名稱	類型	Description
baseResults	string	沒有任何語意擴充或重新執行的結果。
rerankedResults	string	結果已使用重新排名器模型重新進行，且會包含語意標題。它們不會包含任何答案、答案醒目提示或標題重點。

VectorFilterMode

判斷是否在執行向量搜尋之前或之後套用篩選。

名稱	類型	Description
postFilter	string	傳回候選的向量結果集之後，將會套用篩選。根據篩選選取性，這可能會導致比參數『k』所要求的結果少。
preFilter	string	篩選會在搜尋查詢之前套用。

VectorizableImageBinaryQuery

提供需要向量化之影像的基底 64 編碼二進位檔時，要用於向量搜尋的查詢參數。

名稱	類型	Description
base64Image	string	要向量化之影像的基底 64 編碼二進位檔，以執行向量搜尋查詢。
exhaustive	boolean	當為 true 時，會跨向量索引內的所有向量觸發詳盡的 K 近鄰搜尋。適用於完全相符專案很重要的案例，例如判斷基礎真值。
fields	string	集合類型的向量欄位 (Edm.Single) 要包含在搜尋的向量中。
k	integer	要當做前幾個點擊傳回的近鄰數目。
kind	string: imageBinary	正在執行的向量查詢種類。
oversampling	number	過度取樣因數。最小值為 1。它會覆寫索引定義中設定的『defaultOversampling』參數。只有當 'rerankWithOriginalVectors' 為 true 時，才能設定它。只有在基礎向量欄位上使用壓縮方法時，才允許此參數。
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	用於向量查詢的臨界值。請注意，只有在所有 'fields' 都使用相同的相似度計量時，才能設定此設定。
weight	number	相較於其他向量查詢和/或相同搜尋要求內的文字查詢，向量查詢的相對權數。結合不同向量查詢所產生的多個排名清單結果，以及/或透過文字查詢擷取的結果時，會使用這個值。權數越高，符合該查詢的檔就會在最終排名中。默認值為 1.0，且值必須是大於零的正數。

VectorizableImageUrlQuery

提供代表需要向量化之影像值的 URL 時，用於向量搜尋的查詢參數。

名稱	類型	Description
exhaustive	boolean	當為 true 時，會跨向量索引內的所有向量觸發詳盡的 K 近鄰搜尋。適用於完全相符專案很重要的案例，例如判斷基礎真值。
fields	string	集合類型的向量欄位 (Edm.Single) 要包含在搜尋的向量中。
k	integer	要當做前幾個點擊傳回的近鄰數目。
kind	string: imageUrl	正在執行的向量查詢種類。
oversampling	number	過度取樣因數。最小值為 1。它會覆寫索引定義中設定的『defaultOversampling』參數。只有當 'rerankWithOriginalVectors' 為 true 時，才能設定它。只有在基礎向量欄位上使用壓縮方法時，才允許此參數。
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	用於向量查詢的臨界值。請注意，只有在所有 'fields' 都使用相同的相似度計量時，才能設定此設定。
url	string	要向量化之影像的 URL，以執行向量搜尋查詢。
weight	number	相較於其他向量查詢和/或相同搜尋要求內的文字查詢，向量查詢的相對權數。結合不同向量查詢所產生的多個排名清單結果，以及/或透過文字查詢擷取的結果時，會使用這個值。權數越高，符合該查詢的檔就會在最終排名中。默認值為 1.0，且值必須是大於零的正數。

VectorizableTextQuery

提供需要向量化的文字值時，用於向量搜尋的查詢參數。

名稱	類型	Description
exhaustive	boolean	當為 true 時，會跨向量索引內的所有向量觸發詳盡的 K 近鄰搜尋。適用於完全相符專案很重要的案例，例如判斷基礎真值。
fields	string	集合類型的向量欄位 (Edm.Single) 要包含在搜尋的向量中。
k	integer	要當做前幾個點擊傳回的近鄰數目。
kind	string: text	正在執行的向量查詢種類。
oversampling	number	過度取樣因數。最小值為 1。它會覆寫索引定義中設定的『defaultOversampling』參數。只有當 'rerankWithOriginalVectors' 為 true 時，才能設定它。只有在基礎向量欄位上使用壓縮方法時，才允許此參數。
text	string	要向量化以執行向量搜尋查詢的文字。
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	用於向量查詢的臨界值。請注意，只有在所有 'fields' 都使用相同的相似度計量時，才能設定此設定。
weight	number	相較於其他向量查詢和/或相同搜尋要求內的文字查詢，向量查詢的相對權數。結合不同向量查詢所產生的多個排名清單結果，以及/或透過文字查詢擷取的結果時，會使用這個值。權數越高，符合該查詢的檔就會在最終排名中。默認值為 1.0，且值必須是大於零的正數。

VectorQueryKind

正在執行的向量查詢種類。

名稱	類型	Description
imageBinary	string	向量查詢，其中提供需要向量化之影像的基底 64 編碼二進位檔。
imageUrl	string	向量查詢，其中提供代表需要向量化之影像值的URL。
text	string	向量查詢，其中提供需要向量化的文字值。
vector	string	提供原始向量值的向量查詢。

VectorSimilarityThreshold

系統會根據向量相似度計量來篩選向量查詢的結果。請注意，這是相似度計量標準標準的定義，而不是「距離」版本。系統會根據欄位所使用的計量，自動選擇 (較大或較小) 的臨界值方向。

名稱	類型	Description
kind	string: vectorSimilarity	用來篩選向量查詢的臨界值種類
value	number	閾值會根據相似度計量值進行篩選。請注意，這是相似度計量標準標準的定義，而不是「距離」版本。系統會根據欄位所使用的計量，自動選擇 (較大或較小) 的臨界值方向。

VectorThresholdKind