Documents - Autocomplete Get

Ссылка

Служба:: Search Service

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

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

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

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

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2024-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	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	Тег строки, добавляемый для выделения попаданий. Необходимо задать с выделенным значениемPreTag. Если опущено, выделение попаданий отключено.
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	ErrorResponse	Ответ на ошибку.

Примеры

SearchIndexAutocompleteDocumentsGet

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

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2024-11-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	Результат запроса автозаполнения.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку

AutocompleteItem

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

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

AutocompleteMode

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

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

AutocompleteResult

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

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

ErrorAdditionalInfo

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

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

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

ErrorResponse

Ответ на ошибку

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

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