Documents - Autocomplete Get
根据索引中的输入文本和匹配词自动完成不完整的查询词。
GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2025-09-01&search={search}&suggesterName={suggesterName}GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2025-09-01&search={search}&suggesterName={suggesterName}&autocompleteMode={autocompleteMode}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&searchFields={searchFields}&$top={$top}URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
搜索服务的终结点 URL。 |
|
index
|
path | True |
string |
索引的名称。 |
|
api-version
|
query | True |
string |
客户端 API 版本。 |
|
search
|
query | True |
string |
应自动完成的不完整术语。 |
|
suggester
|
query | True |
string |
建议器集合中指定的建议器的名称，该集合是索引定义的一部分。 |
|
$filter
|
query |
string |
一个 OData 表达式，用于筛选用于为自动完成结果生成完整术语的文档。 |
|
|
$top
|
query |
integer (int32) |
要检索的自动完成术语数。 这必须是介于 1 和 100 之间的值。 默认值为 5。 |
|
|
autocomplete
|
query |
指定自动完成的模式。 默认值为“oneTerm”。 使用“twoTerms”获取带状疱疹，使用“oneTermWithContext”在生成自动完成的术语时使用当前上下文。 |
||
|
fuzzy
|
query |
boolean |
指示是否对自动完成查询使用模糊匹配的值。 默认值为 false。 当设置为 true 时，即使搜索文本中存在替换或缺失的字符，查询也会查找术语。 虽然这在某些情况下提供了更好的体验，但会产生性能成本，因为模糊自动完成查询速度较慢且消耗更多资源。 |
|
|
highlight
|
query |
string |
附加到命中突出显示的字符串标记。 必须使用 highlightPreTag 进行设置。 如果省略，则禁用点击突出显示。 |
|
|
highlight
|
query |
string |
在点击突出显示之前添加的字符串标记。 必须使用 highlightPostTag 进行设置。 如果省略，则禁用点击突出显示。 |
|
|
minimum
|
query |
number (double) |
介于 0 和 100 之间的数字，指示自动完成查询必须覆盖的索引百分比，以便将查询报告为成功。 此参数可用于确保搜索可用性，即使对于只有一个副本的服务也是如此。 默认值为 80。 |
|
|
search
|
query |
string[] |
查询自动完成字词时要考虑的字段名称列表。 目标字段必须包含在指定的建议器中。 |
请求头
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
随请求一起发送的跟踪 ID，以帮助调试。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
包含完成部分输入的建议查询词的响应。 |
|
| Other Status Codes |
错误响应。 |
示例
SearchIndexAutocompleteDocumentsGet
示例请求
GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2025-09-01&search=washington medic&suggesterName=sg&autocompleteMode=oneTerm&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&searchFields=title,description
示例响应
[
{
"text": "medicaid",
"queryPlusText": "washington medicaid"
},
{
"text": "medicare",
"queryPlusText": "washington medicare"
},
{
"text": "medicine",
"queryPlusText": "washington medicine"
}
]定义
| 名称 | 说明 |
|---|---|
|
Autocomplete |
自动完成请求的结果。 |
|
Autocomplete |
指定自动完成的模式。 默认值为“oneTerm”。 使用“twoTerms”获取带状疱疹，使用“oneTermWithContext”使用当前上下文生成自动完成术语。 |
|
Autocomplete |
自动完成查询的结果。 |
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详细信息。 |
|
Error |
错误响应 |
AutocompleteItem
自动完成请求的结果。
| 名称 | 类型 | 说明 |
|---|---|---|
| queryPlusText |
string |
查询以及已完成的术语。 |
| text |
string |
已完成的学期。 |
AutocompleteMode
指定自动完成的模式。 默认值为“oneTerm”。 使用“twoTerms”获取带状疱疹，使用“oneTermWithContext”使用当前上下文生成自动完成术语。
| 值 | 说明 |
|---|---|
| oneTerm |
只建议一个术语。 如果查询有两个术语，则仅完成最后一个术语。 例如，如果输入是“华盛顿医生”，则建议的术语可能包括“医疗补助”、“医疗保险”和“医学”。 |
| twoTerms |
将建议匹配索引中的两项短语。 例如，如果输入是“medic”，则建议的术语可能包括“medicare coverage”和“medical assistant”。 |
| oneTermWithContext |
完成具有两个或多个术语的查询中的最后一个术语，其中最后两个术语是索引中存在的短语。 例如，如果输入是“华盛顿医疗”，则建议的术语可能包括“华盛顿医疗补助”和“华盛顿医疗”。 |
AutocompleteResult
自动完成查询的结果。
| 名称 | 类型 | 说明 |
|---|---|---|
| @search.coverage |
number (double) |
一个值，指示自动完成请求考虑的索引百分比，如果请求中未指定 minimumCoverage，则为 null。 |
| value |
返回的自动完成项的列表。 |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
其他信息。 |
| type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
错误附加信息。 |
|
| code |
string |
错误代码。 |
| details |
错误详细信息。 |
|
| message |
string |
错误消息。 |
| target |
string |
错误目标。 |
ErrorResponse
错误响应
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |