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

AutocompleteRequest interface

包:

@azure/search-documents

用于模糊匹配和其他自动完成查询行为的参数。

属性

autocompleteMode	指定自动完成的模式。 默认值为“oneTerm”。 使用“twoTerms”获取带状线，使用“oneTermWithContext”在生成自动完成的术语时使用当前上下文。 可能的值包括：“oneTerm”、“twoTerms”、“oneTermWithContext”
filter	一个 OData 表达式，用于筛选用于为自动完成结果生成已完成字词的文档。
highlightPostTag	追加到命中突出显示的字符串标记。 必须使用 highlightPreTag 进行设置。 如果省略，则禁用命中突出显示。
highlightPreTag	一个字符串标记，在前面追加到命中突出显示。 必须使用 highlightPostTag 进行设置。 如果省略，则禁用命中突出显示。
minimumCoverage	一个介于 0 和 100 之间的数字，指示自动完成查询必须覆盖的索引百分比，以便将查询报告为成功。 即使只有一个副本的服务，此参数也可用于确保搜索可用性。 默认值为“80”。
searchFields	查询自动完成的术语时要考虑的字段名称的逗号分隔列表。 目标字段必须包含在指定的建议器中。
top	要检索的自动完成的术语数。 此值必须是介于 1 和 100 之间的值。 默认值为 5。
useFuzzyMatching	一个 值，该值指示是否对自动完成查询使用模糊匹配。 默认值为 false。 设置为 true 时，即使搜索文本中存在替换字符或缺失字符，查询也会自动完成字词。 虽然这在某些情况下提供更好的体验，但会降低性能，因为模糊的自动完成查询速度较慢，会消耗更多资源。

属性详细信息

autocompleteMode

指定自动完成的模式。 默认值为“oneTerm”。 使用“twoTerms”获取带状线，使用“oneTermWithContext”在生成自动完成的术语时使用当前上下文。 可能的值包括：“oneTerm”、“twoTerms”、“oneTermWithContext”

autocompleteMode?: AutocompleteMode

属性值

AutocompleteMode

filter

一个 OData 表达式，用于筛选用于为自动完成结果生成已完成字词的文档。

filter?: string

属性值

string

highlightPostTag

追加到命中突出显示的字符串标记。 必须使用 highlightPreTag 进行设置。 如果省略，则禁用命中突出显示。

highlightPostTag?: string

属性值

string

highlightPreTag

一个字符串标记，在前面追加到命中突出显示。 必须使用 highlightPostTag 进行设置。 如果省略，则禁用命中突出显示。

highlightPreTag?: string

属性值

string

minimumCoverage

一个介于 0 和 100 之间的数字，指示自动完成查询必须覆盖的索引百分比，以便将查询报告为成功。 即使只有一个副本的服务，此参数也可用于确保搜索可用性。 默认值为“80”。

minimumCoverage?: number

属性值

number

searchFields

查询自动完成的术语时要考虑的字段名称的逗号分隔列表。 目标字段必须包含在指定的建议器中。

searchFields?: SearchFieldArray<TModel>

属性值

SearchFieldArray<TModel>

top

要检索的自动完成的术语数。 此值必须是介于 1 和 100 之间的值。 默认值为 5。

top?: number

属性值

number

useFuzzyMatching

一个 值，该值指示是否对自动完成查询使用模糊匹配。 默认值为 false。 设置为 true 时，即使搜索文本中存在替换字符或缺失字符，查询也会自动完成字词。 虽然这在某些情况下提供更好的体验，但会降低性能，因为模糊的自动完成查询速度较慢，会消耗更多资源。

useFuzzyMatching?: boolean

属性值

boolean