BaseSearchRequestOptions interface

套件:

@azure/search-documents

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

屬性

facets	要套用至搜尋查詢的 Facet 運算式清單。 每個 Facet 運算式都包含功能變數名稱，選擇性地後面接著以逗號分隔的名稱：值組清單。
filter	要套用至搜尋查詢的 OData $filter運算式。
highlightFields	要用於點擊醒目提示的功能變數名稱逗號分隔清單。 只有可搜尋的欄位可用於點擊醒目提示。
highlightPostTag	附加至點擊醒目提示的字串標籤。 必須使用 highlightPreTag 進行設定。 預設值為 < /em > 。
highlightPreTag	前面加上叫用醒目提示的字串標記。 必須使用 highlightPostTag 來設定。 預設值為 < em > 。
includeTotalCount	值，指定是否擷取結果總數。 預設值為 false。 將此值設定為 true 可能會影響效能。 請注意，傳回的計數是一個近似值。
minimumCoverage	介於 0 到 100 之間的數位，表示搜尋查詢必須涵蓋的索引百分比，以便將查詢回報為成功。 即使只有一個複本的服務，此參數也有助於確保搜尋可用性。 預設值為 100。
orderBy	要排序結果的 OData $orderby運算式清單。 每個運算式可以是功能變數名稱或 geo.distance () 或 search.score () 函式的呼叫。 每個運算式後面可以接著 asc 來表示遞增，或 desc 表示遞減。 預設值為遞增排序。 繫結將透過文件的相符分數來中斷。 如果未指定任何$orderby，預設排序次序會依檔比對分數遞減。 最多可以有 32 個$orderby子句。
queryType	值，指定搜尋查詢的語法。 預設值為 'simple'。 如果您的查詢使用 Lucene 查詢語法，請使用 'full'。 可能的值包括：'simple'、'full'、'semantic'
scoringParameters	例如，referencePointParameter) 格式名稱值，用於評分函式 (的參數值清單。 例如，如果評分設定檔使用名為 'mylocation' 的參數來定義函式，則參數字串會是 「mylocation--122.2,44.8」 (，但不含引號) 。
scoringProfile	評分設定檔名稱，用以評估相符文件的符合分數，以便排序結果。
scoringStatistics	值，指定我們想要計算評分統計資料 (，例如檔頻率) 全域進行更一致的評分，或在本機計算延遲較低。 可能的值包括：'Local'、'Global'
searchFields	要設定全文搜尋範圍的功能變數名稱逗號分隔清單。 在完整的 Lucene 查詢中使用欄位搜尋 (fieldName：searchExpression) 時，每個欄位搜尋運算式的功能變數名稱會優先于此參數中列出的任何功能變數名稱。
searchMode	值，指定是否必須比對任何或所有搜尋字詞，才能將檔計算為相符專案。 可能的值包括：'any'、'all'
select	要擷取的欄位清單。 若未指定，即會包含結構描述中標記為可抓取的所有欄位。
sessionId	用來建立黏性會話的值，有助於取得更一致的結果。 只要使用相同的 sessionId，就會嘗試以相同的複本集為目標。 請小心重複重複使用相同的 sessionID 值，可能會干擾跨複本的要求負載平衡，並對搜尋服務的效能造成負面影響。 作為 sessionId 使用的值不能以 ' _ ' 字元開頭。
skip	要略過的搜尋結果數目。 此值不可大於 100,000。 如果您需要依序掃描檔，但因這項限制而無法使用 skip，請考慮改用 orderby 在完全排序的索引鍵上，並使用範圍查詢進行篩選。
top	要擷取的搜尋結果數目。 這可以與$skip搭配使用，以實作搜尋結果的用戶端分頁。 如果結果因伺服器端分頁而截斷，回應會包含接續權杖，可用來發出下一頁結果的另一個搜尋要求。
vectorSearchOptions	定義向量搜尋查詢的選項

屬性詳細資料

facets

要套用至搜尋查詢的 Facet 運算式清單。 每個 Facet 運算式都包含功能變數名稱，選擇性地後面接著以逗號分隔的名稱：值組清單。

facets?: string[]

屬性值

string[]

filter

要套用至搜尋查詢的 OData $filter運算式。

filter?: string

屬性值

string

highlightFields

要用於點擊醒目提示的功能變數名稱逗號分隔清單。 只有可搜尋的欄位可用於點擊醒目提示。

highlightFields?: string

屬性值

string

highlightPostTag

附加至點擊醒目提示的字串標籤。 必須使用 highlightPreTag 進行設定。 預設值為 < /em > 。

highlightPostTag?: string

屬性值

string

highlightPreTag

前面加上叫用醒目提示的字串標記。 必須使用 highlightPostTag 來設定。 預設值為 < em > 。

highlightPreTag?: string

屬性值

string

includeTotalCount

值，指定是否擷取結果總數。 預設值為 false。 將此值設定為 true 可能會影響效能。 請注意，傳回的計數是一個近似值。

includeTotalCount?: boolean

屬性值

boolean

minimumCoverage

介於 0 到 100 之間的數位，表示搜尋查詢必須涵蓋的索引百分比，以便將查詢回報為成功。 即使只有一個複本的服務，此參數也有助於確保搜尋可用性。 預設值為 100。

minimumCoverage?: number

屬性值

number

orderBy

要排序結果的 OData $orderby運算式清單。 每個運算式可以是功能變數名稱或 geo.distance () 或 search.score () 函式的呼叫。 每個運算式後面可以接著 asc 來表示遞增，或 desc 表示遞減。 預設值為遞增排序。 繫結將透過文件的相符分數來中斷。 如果未指定任何$orderby，預設排序次序會依檔比對分數遞減。 最多可以有 32 個$orderby子句。

orderBy?: string[]

屬性值

string[]

queryType

值，指定搜尋查詢的語法。 預設值為 'simple'。 如果您的查詢使用 Lucene 查詢語法，請使用 'full'。 可能的值包括：'simple'、'full'、'semantic'

queryType?: QueryType

屬性值

QueryType

scoringParameters

例如，referencePointParameter) 格式名稱值，用於評分函式 (的參數值清單。 例如，如果評分設定檔使用名為 'mylocation' 的參數來定義函式，則參數字串會是 「mylocation--122.2,44.8」 (，但不含引號) 。

scoringParameters?: string[]

屬性值

string[]

scoringProfile

評分設定檔名稱，用以評估相符文件的符合分數，以便排序結果。

scoringProfile?: string

屬性值

string

scoringStatistics

值，指定我們想要計算評分統計資料 (，例如檔頻率) 全域進行更一致的評分，或在本機計算延遲較低。 可能的值包括：'Local'、'Global'

scoringStatistics?: ScoringStatistics

屬性值

ScoringStatistics

searchFields

要設定全文搜尋範圍的功能變數名稱逗號分隔清單。 在完整的 Lucene 查詢中使用欄位搜尋 (fieldName：searchExpression) 時，每個欄位搜尋運算式的功能變數名稱會優先于此參數中列出的任何功能變數名稱。

searchFields?: SearchFieldArray<TModel>

屬性值

SearchFieldArray<TModel>

searchMode

值，指定是否必須比對任何或所有搜尋字詞，才能將檔計算為相符專案。 可能的值包括：'any'、'all'

searchMode?: SearchMode

屬性值

SearchMode

select

要擷取的欄位清單。 若未指定，即會包含結構描述中標記為可抓取的所有欄位。

select?: SelectArray<TFields>

屬性值

SelectArray<TFields>

sessionId

用來建立黏性會話的值，有助於取得更一致的結果。 只要使用相同的 sessionId，就會嘗試以相同的複本集為目標。 請小心重複重複使用相同的 sessionID 值，可能會干擾跨複本的要求負載平衡，並對搜尋服務的效能造成負面影響。 作為 sessionId 使用的值不能以 ' _ ' 字元開頭。

sessionId?: string

屬性值

string

skip

要略過的搜尋結果數目。 此值不可大於 100,000。 如果您需要依序掃描檔，但因這項限制而無法使用 skip，請考慮改用 orderby 在完全排序的索引鍵上，並使用範圍查詢進行篩選。

skip?: number

屬性值

number

top

要擷取的搜尋結果數目。 這可以與$skip搭配使用，以實作搜尋結果的用戶端分頁。 如果結果因伺服器端分頁而截斷，回應會包含接續權杖，可用來發出下一頁結果的另一個搜尋要求。

top?: number

屬性值

number

vectorSearchOptions

定義向量搜尋查詢的選項

vectorSearchOptions?: VectorSearchOptions<TModel>

屬性值

VectorSearchOptions<TModel>