Documents - Autocomplete Get

Служба:: Search Service

Версия API:: 2025-11-01-preview

Автоматически заполняет неполные термины запроса на основе входного текста и соответствующих терминов в индексе.

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2025-11-01-preview&search={search}&suggesterName={suggesterName}

С использованием необязательных параметров:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2025-11-01-preview&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 (uri)	URL-адрес конечной точки службы поиска.
indexName	path	True	string	Имя индекса.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
search	query	True	string	Неполный триместр, который должен быть автоматически заполнен.
suggesterName	query	True	string	Имя средства предложения, указанное в коллекции предлагаемых элементов, которые входят в определение индекса.
$filter	query		string	Выражение OData, которое фильтрует документы, используемые для создания завершенных терминов, для результата автозаполнения.
$top	query		integer (int32)	Количество автоматически заполненных терминов для извлечения. Это значение должно быть в диапазоне от 1 до 100. Значение по умолчанию равно 5.
autocompleteMode	query		AutocompleteMode	Задает режим автозаполнения. Значение по умолчанию — oneTerm. Используйте 'twoTerms' для получения битумной черепицы и 'oneTermWithContext' для использования текущего контекста при создании автозаполненных терминов.
fuzzy	query		boolean	Значение, указывающее, следует ли использовать нечеткое сопоставление для запроса автозаполнения. По умолчанию — false. Если задано значение true, запрос будет находить термины, даже если в тексте поиска есть замененный или отсутствующий символ. Хотя в некоторых сценариях это обеспечивает более эффективное взаимодействие, это приводит к снижению производительности, так как нечеткие запросы автозаполнения выполняются медленнее и потребляют больше ресурсов.
highlightPostTag	query		string	Тег строки, который добавляется к выделениям попадания. Должен быть установлен с помощью highlightPreTag. Если этот параметр опущен, выделение попаданий будет отключено.
highlightPreTag	query		string	Тег string, который добавляется в начало для выделения попадания. Должен быть установлен с помощью highlightPostTag. Если этот параметр опущен, выделение попаданий будет отключено.
minimumCoverage	query		number (double)	Число от 0 до 100, указывающее процент индекса, который должен быть покрыт автозаполнением, чтобы запрос был признан успешным. Этот параметр может быть полезен для обеспечения доступности поиска даже для сервисов с одной репликой. Значение по умолчанию — 80.
searchFields	query		string[]	Список имен полей, которые следует учитывать при запросе автозаполненных терминов. Целевые поля должны быть включены в указанный подборщик.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Accept		Accept	Заголовок Accept.
x-ms-client-request-id		string (uuid)	Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

Ответы

Имя	Тип	Описание
200 OK	AutocompleteResult	Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

api-key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://search.azure.com/.default

Примеры

SearchIndexAutocompleteDocumentsGet

Образец запроса

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2025-11-01-preview&search=washington medic&suggesterName=sg&autocompleteMode=oneTerm&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&searchFields=title,description

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "text": "medicaid",
      "queryPlusText": "washington medicaid"
    },
    {
      "text": "medicare",
      "queryPlusText": "washington medicare"
    },
    {
      "text": "medicine",
      "queryPlusText": "washington medicine"
    }
  ]
}

Определения

Имя	Описание
Accept	Заголовок Accept.
AutocompleteItem	Результат запросов автозавершения.
AutocompleteMode	Задает режим автозаполнения. Значение по умолчанию — oneTerm. Используйте 'twoTerms' для получения битумной черепицы и 'oneTermWithContext' для использования текущего контекста при создании автозаполнения терминов.
AutocompleteResult	Результат запроса автозаполнения.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Accept

Перечисление

Заголовок Accept.

Значение	Описание
application/json;odata.metadata=none

AutocompleteItem

Объект

Результат запросов автозавершения.

Имя	Тип	Описание
queryPlusText	string	Запрос вместе с завершенным термином.
text	string	Завершенный семестр.

AutocompleteMode

Перечисление

Задает режим автозаполнения. Значение по умолчанию — oneTerm. Используйте 'twoTerms' для получения битумной черепицы и 'oneTermWithContext' для использования текущего контекста при создании автозаполнения терминов.

Значение	Описание
oneTerm	Предлагается только один термин. Если запрос состоит из двух терминов, завершается только последний термин. Например, если входными данными является «вашингтонский медик», предлагаемые термины могут включать «medicaid», «medicare» и «medicine».
twoTerms	Будут предложены соответствующие двухчленные фразы в индексе. Например, если в поле ввода указано «медик», предлагаемые термины могут включать «покрытие медицинской помощи» и «фельдшер».
oneTermWithContext	Завершает последний термин в запросе двумя или более терминами, где последние два термина являются фразой, существующей в индексе. Например, если вводом является «вашингтонский медик», предлагаемые термины могут включать «вашингтон медикейд» и «вашингтон медикал».

AutocompleteResult

Объект

Результат запроса автозаполнения.

Имя	Тип	Описание
@search.coverage	number (double)	Значение, указывающее процент от индекса, который был учтен запросом автозаполнения, или null, если в запросе не был указан minimumCoverage.
value	AutocompleteItem[]	Список возвращенных автозаполненных элементов.

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info		Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Цель ошибки.

ErrorResponse

Объект

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.