你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

BaseSearchRequestOptions interface

包:

@azure/search-documents

用于筛选、排序、分面、分页和其他搜索查询行为的参数。

属性

facets	要应用于搜索查询的分面表达式的列表。 每个分面表达式都包含一个字段名称，后跟一个逗号分隔的 name：value 对列表。
filter	要应用于搜索查询的 OData $filter表达式。
highlightFields	用于命中突出显示的字段名称的逗号分隔列表。 仅可搜索字段可用于命中突出显示。
highlightPostTag	追加到命中突出显示的字符串标记。 必须使用 highlightPreTag 进行设置。 默认值为 </em>。
highlightPreTag	一个字符串标记，在前面附加以命中突出显示。 必须使用 highlightPostTag 进行设置。 默认值为 <em>。
includeTotalCount	一个 值，该值指定是否提取结果的总计数。 默认值为 false。 将此值设置为 true 可能会影响性能。 请注意，返回的计数是一个近似值。
minimumCoverage	介于 0 和 100 之间的数字，指示搜索查询必须涵盖的索引百分比才能将查询报告为成功。 此参数可用于确保搜索可用性，即使只有一个副本 (replica) 的服务也是如此。 默认值为 100。
orderBy	OData 列表$orderby表达式，用于对结果进行排序。 每个表达式可以是字段名称，也可以是对 geo.distance () 或 search.score () 函数的调用。 每个表达式后跟 asc 表示升序，或 desc 表示降序。 默认值为升序。 排序的依据将是文档的匹配分数。 如果未指定$orderby，则默认排序顺序为按文档匹配分数降序。 最多可以有 32 个$orderby子句。
queryType	一个 值，该值指定搜索查询的语法。 默认值为“simple”。 如果查询使用 Lucene 查询语法，请使用“full”。 可能的值包括：“simple”、“full”、“semantic”
scoringParameters	要用于评分函数的参数值列表 (例如，referencePointParameter) 使用格式 name-values。 例如，如果评分配置文件定义了一个具有名为“mylocation”的参数的函数，则参数字符串将为“mylocation--122.2,44.8” (不带引号) 。
scoringProfile	用于为匹配的文档评估匹配分数以便对结果进行排序的评分配置文件的名称。
scoringStatistics	一个 值，该值指定我们是要计算评分统计信息 (（例如全局) 文档频率）以提高评分的一致性，还是在本地计算以降低延迟。 可能的值包括：“Local”、“Global”
searchFields	要确定全文搜索的范围的字段名称的逗号分隔列表。 在完整的 Lucene 查询中使用字段搜索 (fieldName：searchExpression) 时，每个字段搜索表达式的字段名称优先于此参数中列出的任何字段名称。
searchMode	一个 值，该值指定是否必须匹配任何或所有搜索词才能将文档计数为匹配项。 可能的值包括：“any”、“all”
select	要检索的字段列表。 如果未指定，将包含架构中标记为可检索的所有字段。
sessionId	用于创建粘滞会话的值，这有助于获得更一致的结果。 只要使用相同的 sessionId，就会尽力尝试以相同的副本 (replica) 集为目标。 请注意，重复重复使用相同的 sessionID 值可能会干扰跨副本的请求负载均衡，并会对搜索服务的性能产生负面影响。 用作 sessionId 的值不能以“_”字符开头。
skip	要跳过的搜索结果数。 此值不能大于 100,000。 如果需要按顺序扫描文档，但由于此限制而无法使用 skip，请考虑对完全有序的键使用 orderby，并改为使用范围查询进行筛选。
top	要检索的搜索结果数。 这可以与$skip结合使用，以实现搜索结果的客户端分页。 如果结果由于服务器端分页而被截断，响应将包含一个可用于对下一页结果发出另一个搜索请求的延续标记。
vectorSearchOptions	定义矢量搜索查询的选项

属性详细信息

facets

要应用于搜索查询的分面表达式的列表。 每个分面表达式都包含一个字段名称，后跟一个逗号分隔的 name：value 对列表。

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 之间的数字，指示搜索查询必须涵盖的索引百分比才能将查询报告为成功。 此参数可用于确保搜索可用性，即使只有一个副本 (replica) 的服务也是如此。 默认值为 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) 使用格式 name-values。 例如，如果评分配置文件定义了一个具有名为“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，就会尽力尝试以相同的副本 (replica) 集为目标。 请注意，重复重复使用相同的 sessionID 值可能会干扰跨副本的请求负载均衡，并会对搜索服务的性能产生负面影响。 用作 sessionId 的值不能以“_”字符开头。

sessionId?: string

属性值

string

skip

要跳过的搜索结果数。 此值不能大于 100,000。 如果需要按顺序扫描文档，但由于此限制而无法使用 skip，请考虑对完全有序的键使用 orderby，并改为使用范围查询进行筛选。

skip?: number

属性值

number

top

要检索的搜索结果数。 这可以与$skip结合使用，以实现搜索结果的客户端分页。 如果结果由于服务器端分页而被截断，响应将包含一个可用于对下一页结果发出另一个搜索请求的延续标记。

top?: number

属性值

number

vectorSearchOptions

定义矢量搜索查询的选项

vectorSearchOptions?: VectorSearchOptions<TModel>

属性值

VectorSearchOptions<TModel>