Documents - Autocomplete Get

Ссылка

Служба:: Search Service

Версия API:: 2023-10-01-Preview

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

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-10-01-Preview&search={search}&suggesterName={suggesterName}

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

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-10-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	URL-адрес конечной точки службы поиска.
indexName	path	True	string	Имя индекса.
api-version	query	True	string	Версия 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	Строковый тег, который добавляется к выделению нажатия. Должен быть задан с параметром highlightPostTag. Если этот параметр опущен, выделение нажатий отключено.
minimumCoverage	query		number double	Число от 0 до 100, указывающее процент индекса, который должен быть охвачен запросом автозаполнения, чтобы запрос сообщал об успешном выполнении. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одним реплика. Значение по умолчанию — 80.
searchFields	query		string[]	Список имен полей, которые следует учитывать при запросе автоматически заполненных терминов. Целевые поля должны быть включены в указанный средство подбора.

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

Имя	Обязательно	Тип	Описание
x-ms-client-request-id		string uuid	Идентификатор отслеживания, отправленный с запросом для помощи в отладке.

Ответы

Имя	Тип	Описание
200 OK	AutocompleteResult	Ответ, содержащий предлагаемые термины запроса, которые завершают частичные входные данные.
Other Status Codes	SearchError	Ответ об ошибке.

Примеры

SearchIndexAutocompleteDocumentsGet

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

HTTP

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

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

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

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

Определения

Имя	Описание
AutocompleteItem	Результат запросов автозаполнения.
AutocompleteMode	Указывает режим автозавершения. Значение по умолчанию — "oneTerm". Используйте twoTerms для получения черепицы и oneTermWithContext для использования текущего контекста при создании терминов автозаполнения.
AutocompleteResult	Результат запроса автозаполнения.
SearchError	Описывает условие ошибки для API.

AutocompleteItem

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

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

AutocompleteMode

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

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

AutocompleteResult

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

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

SearchError

Описывает условие ошибки для API.

Имя	Тип	Описание
code	string	Один из серверных наборов кодов ошибок.
details	SearchError[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
message	string	Понятное представление ошибки.

Поделиться через