Documents - Search Post
搜尋索引中的檔。
POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2023-11-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
搜尋服務的端點 URL。 |
index
|
path | True |
string |
索引的名稱。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
與要求一起傳送的追蹤標識碼,以協助偵錯。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
answers |
值,指定是否應該在搜尋回應中傳回答案。 |
|
captions |
值,指定是否應該在搜尋回應中傳回標題。 |
|
count |
boolean |
值,指定是否擷取結果總數。 預設值為 false。 將此值設定為 true 可能會造成效能影響。 請注意,傳回的計數是一個近似值。 |
facets |
string[] |
要套用至搜尋查詢的Facet表達式清單。 每個 Facet 運算式都包含功能變數名稱,選擇性地後面接著以逗號分隔的名稱:值組清單。 |
filter |
string |
要套用至搜尋查詢的 OData $filter表示式。 |
highlight |
string |
要用於點擊醒目提示的功能變數名稱逗號分隔清單。 只有可搜尋的欄位可用於點擊醒目提示。 |
highlightPostTag |
string |
附加至點擊醒目提示的字串標籤。 必須以 highlightPreTag 設定。 預設值為 </em>。 |
highlightPreTag |
string |
在點擊醒目提示前面加上的字串標籤。 必須使用 highlightPostTag 來設定。 預設值為 <em>。 |
minimumCoverage |
number |
介於 0 到 100 之間的數位,指出搜尋查詢必須涵蓋的索引百分比,以便讓查詢回報為成功。 此參數有助於確保搜尋可用性,即使只有一個複本的服務也一定有效。 預設值為 100。 |
orderby |
string |
OData 的逗號分隔清單$orderby用來排序結果的表達式。 每個運算式可以是功能變數名稱或對 geo.distance () 或 search.score () 函式的呼叫。 每個表達式後面可以接著 asc 來表示遞增,或 desc 表示遞減。 預設值為遞增排序。 繫結將透過文件的相符分數來中斷。 如果未指定任何$orderby,預設排序順序會依檔比對分數遞減。 最多可以有 32 個$orderby子句。 |
queryType |
值,指定搜尋查詢的語法。 預設值為 『simple』。 如果您的查詢使用 Lucene 查詢語法,請使用 『full』。 |
|
scoringParameters |
string[] |
例如,參考PointParameter) 格式名稱值,用於評分函式的參數值清單 (。 例如,如果評分配置檔使用名為 『mylocation』 的參數定義函式,則參數位符串會是 “mylocation--122.2,44.8” (,但不含引號) 。 |
scoringProfile |
string |
評分設定檔名稱,用以評估相符文件的符合分數,以便排序結果。 |
scoringStatistics |
值,指定我們想要計算評分統計數據 (,例如檔頻率) 全域進行更一致的評分,或在本機計算延遲較低。 預設值為 『local』。 使用「全域」在評分之前,全域匯總評分統計數據。 使用全域評分統計數據可能會增加搜尋查詢的延遲。 |
|
search |
string |
全文搜索查詢表達式;使用 「*」 或省略此參數以符合所有檔。 |
searchFields |
string |
要限定全文搜索範圍的功能變數名稱逗號分隔清單。 在完整的 Lucene 查詢中使用字段搜尋 (fieldName:searchExpression) 時,每個字段搜尋表達式的功能變數名稱優先於此參數所列的任何功能變數名稱。 |
searchMode |
值,指定是否必須比對任何或所有搜尋字詞,才能將檔計算為相符專案。 |
|
select |
string |
要擷取的欄位逗號分隔清單。 若未指定,即會包含結構描述中標記為可抓取的所有欄位。 |
semanticConfiguration |
string |
處理語意類型查詢的檔時,將使用的語意組態名稱。 |
semanticErrorHandling |
允許使用者選擇語意呼叫應該完全失敗, (預設/目前的行為) ,還是傳回部分結果。 |
|
semanticMaxWaitInMilliseconds |
integer |
允許使用者在要求失敗之前,設定語意擴充完成處理所需的時間上限。 |
sessionId |
string |
用來建立黏性會話的值,有助於取得更一致的結果。 只要使用相同的 sessionId,就會嘗試以相同的複本集為目標。 請小心重複重複使用相同的 sessionID 值,可能會干擾跨複本的要求負載平衡,並對搜尋服務的效能造成負面影響。 作為 sessionId 使用的值不能以 ' _ ' 字元開頭。 |
skip |
integer |
要略過的搜尋結果數目。 此值不可大於 100,000。 如果您需要依序掃描檔,但因這項限制而無法使用skip,請考慮改用orderby在完全排序的索引鍵上,並使用範圍查詢進行篩選。 |
top |
integer |
要擷取的搜尋結果數目。 這可以與$skip搭配使用,以實作搜尋結果的用戶端分頁。 如果結果因伺服器端分頁而截斷,回應會包含接續令牌,可用來發出下一頁結果的另一個搜尋要求。 |
vectorFilterMode |
判斷是否在執行向量搜尋之前或之後套用篩選。 新索引的預設值為 『preFilter』。 |
|
vectorQueries | VectorQuery[]: |
向量和混合式搜尋查詢的查詢參數。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
包含符合搜尋準則之文件的回應。 |
|
Other Status Codes |
錯誤回應。 |
範例
Search |
Search |
SearchIndexSearchDocumentsPost
範例要求
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01
{
"count": true,
"facets": [
"category,count:10,sort:count"
],
"filter": "rating gt 4.0",
"highlight": "description",
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"minimumCoverage": null,
"orderby": "rating desc",
"queryType": "simple",
"scoringParameters": [
"currentLocation--122.123,44.77233"
],
"scoringProfile": "sp",
"search": "nice hotels",
"searchFields": "category,description",
"searchMode": "any",
"sessionId": "mysessionid",
"scoringStatistics": "global",
"select": "hotelId,category,description",
"skip": 0,
"top": 10,
"vectorQueries": [
{
"kind": "vector",
"vector": [
0.103,
0.0712,
0.0852,
0.1547,
0.1183
],
"fields": "descriptionEmbedding",
"k": 5,
"exhaustive": true
}
],
"vectorFilterMode": "preFilter"
}
範例回覆
{
"@odata.count": 25,
"@search.facets": {
"category": [
{
"count": 1,
"value": "Economy"
},
{
"count": 1,
"value": "Luxury"
}
]
},
"@search.nextPageParameters": {
"count": true,
"facets": [
"category,count:10,sort:count"
],
"filter": "rating gt 4.0",
"highlight": "title",
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"minimumCoverage": null,
"orderby": "search.score() desc,rating desc",
"queryType": "simple",
"sessionId": "mysessionid",
"scoringStatistics": "global",
"scoringParameters": [
"currentLocation--122.123,44.77233"
],
"scoringProfile": "sp",
"search": "nice hotels",
"searchFields": "title,description",
"searchMode": "any",
"select": "docId,title,description",
"skip": 2,
"top": 8
},
"value": [
{
"@search.score": 1.5,
"@search.highlights": {
"title": [
"<em>Nice</em> <em>Hotel</em>"
]
},
"description": "Cheapest hotel in town",
"docId": "1",
"title": "Nice Hotel"
},
{
"@search.score": 0.7,
"@search.highlights": {
"title": [
"Fancy <em>Hotel</em>"
]
},
"description": "Best hotel in town",
"docId": "2",
"title": "Fancy Hotel"
}
],
"@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01"
}
SearchIndexSearchDocumentsSemanticPost
範例要求
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01
{
"count": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"queryType": "semantic",
"search": "how do clouds form",
"semanticConfiguration": "my-semantic-config",
"answers": "extractive|count-3",
"captions": "extractive|highlight-true",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 780
}
範例回覆
{
"@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=2023-11-01"
}
定義
名稱 | Description |
---|---|
Answer |
答案是從符合查詢之最相關文件的內容中擷取的文字段。 答案會從頂端搜尋結果中擷取。 答案候選項目會進行評分,並選取頂端答案。 |
Caption |
標題是文件相對於搜尋查詢最代表性的一部分。 它們通常用來做為文件摘要。 只有類型的 |
Query |
值,指定是否應該在搜尋回應中傳回答案。 |
Query |
值,指定是否應該在搜尋回應中傳回標題。 |
Query |
指定搜尋查詢的語法。 預設值為 『simple』。 如果您的查詢使用 Lucene 查詢語法,請使用 『full』。 |
Raw |
提供原始向量值時,用於向量搜尋的查詢參數。 |
Scoring |
值,指定我們想要計算評分統計數據 (,例如檔頻率) 全域進行更一致的評分,或在本機計算延遲較低。 預設值為 『local』。 使用「全域」在評分之前,全域匯總評分統計數據。 使用全域評分統計數據可能會增加搜尋查詢的延遲。 |
Search |
包含索引搜尋結果的回應。 |
Search |
描述 API 的錯誤狀況。 |
Search |
指定必須符合任何或所有的搜尋字詞,才能將文件視為相符項目。 |
Search |
篩選、排序、Facet、分頁和其他搜尋查詢行為的參數。 |
Search |
包含搜尋查詢找到的檔,以及相關聯的元數據。 |
Semantic |
允許使用者選擇語意呼叫是否應該完全失敗, (預設/目前的行為) ,或傳回部分結果。 |
Semantic |
語意排名要求傳回部分回應的原因。 |
Semantic |
針對語意排名要求傳回的部分回應類型。 |
Vector |
判斷是否在執行向量搜尋之前或之後套用篩選。 |
Vector |
要執行的向量查詢種類。 |
AnswerResult
答案是從符合查詢之最相關文件的內容中擷取的文字段。 答案會從頂端搜尋結果中擷取。 答案候選項目會進行評分,並選取頂端答案。
名稱 | 類型 | Description |
---|---|---|
highlights |
string |
與 Text 屬性中的文字段落相同,其中醒目提示的文字片語與查詢最相關。 |
key |
string |
從中擷取答案的檔索引鍵。 |
score |
number |
分數值代表與查詢所傳回之其他答案相關的查詢相關程度。 |
text |
string |
從文件內容擷取的文字行行做為答案。 |
CaptionResult
標題是文件相對於搜尋查詢最代表性的一部分。 它們通常用來做為文件摘要。 只有類型的 semantic
查詢才會傳回標題。
名稱 | 類型 | Description |
---|---|---|
highlights |
string |
與 Text 屬性中的文字段落相同,其中醒目提示的片語與查詢最相關。 |
text |
string |
從與搜尋查詢最相關的檔擷取的代表性文字段落。 |
QueryAnswerType
值,指定是否應該在搜尋回應中傳回答案。
名稱 | 類型 | Description |
---|---|---|
extractive |
string |
從傳回的文件內容擷取答案候選專案,以回應以自然語言表示為問題的查詢。 |
none |
string |
請勿傳回查詢的答案。 |
QueryCaptionType
值,指定是否應該在搜尋回應中傳回標題。
名稱 | 類型 | Description |
---|---|---|
extractive |
string |
從相符的檔擷取標題,其中包含與搜尋查詢相關的段落。 |
none |
string |
請勿傳回查詢的標題。 |
QueryType
指定搜尋查詢的語法。 預設值為 『simple』。 如果您的查詢使用 Lucene 查詢語法,請使用 『full』。
名稱 | 類型 | 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 |
要執行的向量查詢種類。 |
vector |
number[] |
搜尋查詢的向量表示。 |
ScoringStatistics
值,指定我們想要計算評分統計數據 (,例如檔頻率) 全域進行更一致的評分,或在本機計算延遲較低。 預設值為 『local』。 使用「全域」在評分之前,全域匯總評分統計數據。 使用全域評分統計數據可能會增加搜尋查詢的延遲。
名稱 | 類型 | Description |
---|---|---|
global |
string |
評分統計數據會以全域方式計算,以取得更一致的評分。 |
local |
string |
評分統計數據會在本機計算,以降低延遲。 |
SearchDocumentsResult
包含索引搜尋結果的回應。
名稱 | 類型 | Description |
---|---|---|
@odata.count |
integer |
搜尋作業找到的結果總數,如果未要求計數,則為 null。 如果存在,計數可能會大於此回應中的結果數目。 如果您使用$top或$skip參數,或者查詢無法在單一回應中傳回所有要求的檔,就會發生這種情況。 |
@odata.nextLink |
string |
當查詢無法傳回所有要求的回應結果時,傳回的接續 URL。 您可以使用此 URL 來制定另一個 GET 或 POST 搜尋要求,以取得搜尋回應的下一個部分。 請務必使用與產生此回應的要求相同的動詞 (GET 或 POST) 。 |
@search.answers |
搜尋作業的答案查詢結果;如果未指定答案查詢參數或設定為 『none』,則為 null。 |
|
@search.coverage |
number |
值,指出查詢中包含的索引百分比,如果要求中未指定 minimumCoverage,則為 null。 |
@search.facets |
object |
搜尋作業的 Facet 查詢結果,會組織為每個 Facet 字段的貯體集合;如果查詢未包含任何 Facet 運算式,則為 null。 |
@search.nextPageParameters |
當查詢無法傳回所有要求的回應結果時,傳回的接續 JSON 承載。 您可以搭配 @odata.nextLink 使用此 JSON 來制定另一個 POST 搜尋要求,以取得搜尋回應的下一個部分。 |
|
@search.semanticPartialResponseReason |
語意排名要求傳回部分回應的原因。 |
|
@search.semanticPartialResponseType |
針對語意排名要求傳回的部分回應類型。 |
|
value |
查詢傳回的結果序列。 |
SearchError
描述 API 的錯誤狀況。
名稱 | 類型 | Description |
---|---|---|
code |
string |
其中一組伺服器定義的錯誤碼。 |
details |
導致此錯誤之特定錯誤的詳細數據陣列。 |
|
message |
string |
人類可讀取的錯誤表示法。 |
SearchMode
指定必須符合任何或所有的搜尋字詞,才能將文件視為相符項目。
名稱 | 類型 | Description |
---|---|---|
all |
string |
所有搜尋字詞都必須相符,才能將檔計算為相符專案。 |
any |
string |
任何搜尋字詞都必須相符,才能將檔計算為相符專案。 |
SearchRequest
篩選、排序、Facet、分頁和其他搜尋查詢行為的參數。
名稱 | 類型 | Description |
---|---|---|
answers |
值,指定是否應該在搜尋回應中傳回答案。 |
|
captions |
值,指定是否應該在搜尋回應中傳回標題。 |
|
count |
boolean |
值,指定是否擷取結果總數。 預設值為 false。 將此值設定為 true 可能會造成效能影響。 請注意,傳回的計數是一個近似值。 |
facets |
string[] |
要套用至搜尋查詢的Facet表達式清單。 每個 Facet 運算式都包含功能變數名稱,選擇性地後面接著以逗號分隔的名稱:值組清單。 |
filter |
string |
要套用至搜尋查詢的 OData $filter表示式。 |
highlight |
string |
要用於點擊醒目提示的功能變數名稱逗號分隔清單。 只有可搜尋的欄位可用於點擊醒目提示。 |
highlightPostTag |
string |
附加至點擊醒目提示的字串標籤。 必須以 highlightPreTag 設定。 預設值為 </em>。 |
highlightPreTag |
string |
在點擊醒目提示前面加上的字串標籤。 必須使用 highlightPostTag 來設定。 預設值為 <em>。 |
minimumCoverage |
number |
介於 0 到 100 之間的數位,指出搜尋查詢必須涵蓋的索引百分比,以便讓查詢回報為成功。 此參數有助於確保搜尋可用性,即使只有一個複本的服務也一定有效。 預設值為 100。 |
orderby |
string |
OData 的逗號分隔清單$orderby用來排序結果的表達式。 每個運算式可以是功能變數名稱或對 geo.distance () 或 search.score () 函式的呼叫。 每個表達式後面可以接著 asc 來表示遞增,或 desc 表示遞減。 預設值為遞增排序。 繫結將透過文件的相符分數來中斷。 如果未指定任何$orderby,預設排序順序會依檔比對分數遞減。 最多可以有 32 個$orderby子句。 |
queryType |
值,指定搜尋查詢的語法。 預設值為 『simple』。 如果您的查詢使用 Lucene 查詢語法,請使用 『full』。 |
|
scoringParameters |
string[] |
例如,參考PointParameter) 格式名稱值,用於評分函式的參數值清單 (。 例如,如果評分配置檔使用名為 『mylocation』 的參數定義函式,則參數位符串會是 “mylocation--122.2,44.8” (,但不含引號) 。 |
scoringProfile |
string |
評分設定檔名稱,用以評估相符文件的符合分數,以便排序結果。 |
scoringStatistics |
值,指定我們想要計算評分統計數據 (,例如檔頻率) 全域進行更一致的評分,或在本機計算延遲較低。 預設值為 『local』。 使用「全域」在評分之前,全域匯總評分統計數據。 使用全域評分統計數據可能會增加搜尋查詢的延遲。 |
|
search |
string |
全文搜索查詢表達式;使用 「*」 或省略此參數以符合所有檔。 |
searchFields |
string |
要限定全文搜索範圍的功能變數名稱逗號分隔清單。 在完整的 Lucene 查詢中使用字段搜尋 (fieldName:searchExpression) 時,每個字段搜尋表達式的功能變數名稱優先於此參數所列的任何功能變數名稱。 |
searchMode |
值,指定是否必須比對任何或所有搜尋字詞,才能將檔計算為相符專案。 |
|
select |
string |
要擷取的欄位逗號分隔清單。 若未指定,即會包含結構描述中標記為可抓取的所有欄位。 |
semanticConfiguration |
string |
處理類型語意查詢的檔時,將使用的語意組態名稱。 |
semanticErrorHandling |
允許使用者選擇語意呼叫是否應該完全失敗, (預設/目前的行為) ,或傳回部分結果。 |
|
semanticMaxWaitInMilliseconds |
integer |
允許使用者在要求失敗之前,設定語意擴充完成處理所需的時間上限。 |
sessionId |
string |
用來建立黏性會話的值,有助於取得更一致的結果。 只要使用相同的 sessionId,就會嘗試以相同的複本集為目標。 請小心重複重複使用相同的 sessionID 值,可能會干擾跨複本的要求負載平衡,並對搜尋服務的效能造成負面影響。 作為 sessionId 使用的值不能以 ' _ ' 字元開頭。 |
skip |
integer |
要略過的搜尋結果數目。 此值不可大於 100,000。 如果您需要依序掃描檔,但因為這項限制而無法使用skip,請考慮改為在完全排序的索引鍵上使用orderby,並使用範圍查詢進行篩選。 |
top |
integer |
要擷取的搜尋結果數目。 這可以與$skip搭配使用,以實作搜尋結果的用戶端分頁。 如果因伺服器端分頁而截斷結果,回應會包含接續令牌,可用來發出下一頁結果的另一個搜尋要求。 |
vectorFilterMode |
判斷是否在執行向量搜尋之前或之後套用篩選。 新索引的預設值為 『preFilter』。 |
|
vectorQueries | VectorQuery[]: |
向量和混合式搜尋查詢的查詢參數。 |
SearchResult
包含搜尋查詢找到的檔,以及相關聯的元數據。
名稱 | 類型 | Description |
---|---|---|
@search.captions |
標題是文件相對於搜尋查詢最代表性的一部分。 它們通常用來做為文件摘要。 只有類型的 |
|
@search.highlights |
object |
檔中指出相符搜尋字詞的文字片段,由每個適用的欄位組織;如果查詢未啟用點擊醒目提示,則為 null。 |
@search.rerankerScore |
number |
由熱門搜尋結果的語意排名器所計算的相關性分數。 搜尋結果會先依 RerankerScore 排序,然後再依分數排序。 只會針對 類型的 |
@search.score |
number |
相較於查詢傳回的其他文件,文件的相關性分數。 |
SemanticErrorMode
允許使用者選擇語意呼叫是否應該完全失敗, (預設/目前的行為) ,或傳回部分結果。
名稱 | 類型 | Description |
---|---|---|
fail |
string |
如果在語意處理步驟期間發生例外狀況,查詢將會失敗,並根據錯誤傳回適當的 HTTP 程式代碼。 |
partial |
string |
如果語意處理失敗,部分結果仍會傳回。 部分結果的定義取決於哪些語意步驟失敗,以及失敗的原因為何。 |
SemanticErrorReason
語意排名要求傳回部分回應的原因。
名稱 | 類型 | Description |
---|---|---|
capacityOverloaded |
string |
要求已節流處理。 只會傳回基底結果。 |
maxWaitExceeded |
string |
如果 |
transient |
string |
語意處理程式至少有一個步驟失敗。 |
SemanticSearchResultsType
針對語意排名要求傳回的部分回應類型。
名稱 | 類型 | Description |
---|---|---|
baseResults |
string |
沒有任何語意擴充或重新執行的結果。 |
rerankedResults |
string |
結果已使用重新排名器模型重新進行,且將包含語意標題。 它們不會包含任何答案、答案醒目提示或 標題 重點。 |
VectorFilterMode
判斷是否在執行向量搜尋之前或之後套用篩選。
名稱 | 類型 | Description |
---|---|---|
postFilter |
string |
傳回候選向量結果集之後,將會套用篩選條件。 根據篩選選取性,這可能會導致比參數 『k』 所要求的結果少。 |
preFilter |
string |
篩選條件會在搜尋查詢之前套用。 |
VectorQueryKind
要執行的向量查詢種類。
名稱 | 類型 | Description |
---|---|---|
vector |
string |
提供原始向量值的向量查詢。 |