Documents - Autocomplete Post

Ссылка

Служба:: Search Service

Версия API:: 2023-11-01

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2023-11-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	URL-адрес конечной точки службы поиска.
indexName	path	True	string	Имя индекса.
api-version	query	True	string	Версия API клиента.

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

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

Текст запроса

Имя	Обязательно	Тип	Описание
search	True	string	Текст поиска, на основе которого будут основываться результаты автозаполнения.
suggesterName	True	string	Имя средства подбора, указанное в коллекции средств подбора, которая является частью определения индекса.
autocompleteMode		AutocompleteMode	Задает режим автозавершения. Значение по умолчанию — oneTerm. Используйте twoTerms для получения черепицы и oneTermWithContext, чтобы использовать текущий контекст при создании автоматически завершенных терминов.
filter		string	Выражение OData, которое фильтрует документы, используемые для создания завершенных терминов для результата автозаполнения.
fuzzy		boolean	Значение типа , указывающее, следует ли использовать нечеткое сопоставление для запроса автозавершения. Значение по умолчанию — false. Если задано значение true, запрос будет автозавершение терминов, даже если в тексте поиска есть замещающий или отсутствующий символ. Хотя в некоторых сценариях это обеспечивает лучшую работу, это снижает производительность, так как нечеткие запросы автозаполнения выполняются медленнее и потребляют больше ресурсов.
highlightPostTag		string	Строковый тег, добавляемый к выделенному нажатию. Должно быть задано значение highlightPreTag. Если этот параметр опущен, выделение нажатий отключается.
highlightPreTag		string	Строковый тег, который добавляется к выделению нажатия. Должен быть задан с параметром highlightPostTag. Если этот параметр опущен, выделение нажатий отключается.
minimumCoverage		number	Число от 0 до 100, указывающее процент индекса, который должен быть охвачен запросом автозавершения, чтобы запрос сообщал об успешном выполнении. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одним реплика. Значение по умолчанию — 80.
searchFields		string	Разделенный запятыми список имен полей, которые следует учитывать при запросе автоматически завершенных терминов. Целевые поля должны быть включены в указанный средство подбора.
top		integer	Количество автоматически завершенных терминов для извлечения. Это должно быть значение от 1 до 100. Значение по умолчанию — 5.

Ответы

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

Примеры

SearchIndexAutocompleteDocumentsPost

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

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2023-11-01

{
  "autocompleteMode": "oneTerm",
  "search": "washington medic",
  "suggesterName": "sg",
  "filter": "search.in(docId,'101,102,105')",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "title,description",
  "top": 10
}

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

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

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

Определения

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

AutocompleteItem

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

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

AutocompleteMode

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

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

AutocompleteRequest

Параметры для нечеткого сопоставления и других поведений автозавершения запросов.

Имя	Тип	Описание
autocompleteMode	AutocompleteMode	Задает режим автозавершения. Значение по умолчанию — oneTerm. Используйте twoTerms для получения черепицы и oneTermWithContext, чтобы использовать текущий контекст при создании автоматически завершенных терминов.
filter	string	Выражение OData, которое фильтрует документы, используемые для создания завершенных терминов для результата автозаполнения.
fuzzy	boolean	Значение типа , указывающее, следует ли использовать нечеткое сопоставление для запроса автозавершения. Значение по умолчанию — false. Если задано значение true, запрос будет автозавершение терминов, даже если в тексте поиска есть замещающий или отсутствующий символ. Хотя в некоторых сценариях это обеспечивает лучшую работу, это снижает производительность, так как нечеткие запросы автозаполнения выполняются медленнее и потребляют больше ресурсов.
highlightPostTag	string	Строковый тег, добавляемый к выделенному нажатию. Должно быть задано значение highlightPreTag. Если этот параметр опущен, выделение нажатий отключается.
highlightPreTag	string	Строковый тег, который добавляется к выделению нажатия. Должен быть задан с параметром highlightPostTag. Если этот параметр опущен, выделение нажатий отключается.
minimumCoverage	number	Число от 0 до 100, указывающее процент индекса, который должен быть охвачен запросом автозавершения, чтобы запрос сообщал об успешном выполнении. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одним реплика. Значение по умолчанию — 80.
search	string	Текст поиска, на основе которого будут основываться результаты автозаполнения.
searchFields	string	Разделенный запятыми список имен полей, которые следует учитывать при запросе автоматически завершенных терминов. Целевые поля должны быть включены в указанный средство подбора.
suggesterName	string	Имя средства подбора, указанное в коллекции средств подбора, которая является частью определения индекса.
top	integer	Количество автоматически завершенных терминов для извлечения. Это должно быть значение от 1 до 100. Значение по умолчанию — 5.

AutocompleteResult

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

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

SearchError

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

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

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