Documents - Suggest Get

Служба:: Search Service

Версия API:: 2025-09-01

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

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

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

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}&api-version=2025-09-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	URL-адрес конечной точки службы поиска.
indexName	path	True	string	Имя индекса.
api-version	query	True	string	Версия клиентского API.
search	query	True	string	Текст поиска, используемый для предложения документов. Должно быть не менее 1 символа, и не более 100 символов.
suggesterName	query	True	string	Имя средства подбора, указанное в коллекции средств подбора, которая является частью определения индекса.
$filter	query		string	Выражение OData, которое фильтрует рассмотренные документы на предмет предложений.
$orderby	query		string[]	В списке OData $orderby выражения, по которым можно сортировать результаты. Каждое выражение может быть либо именем поля, либо вызовом функций geo.distance() или search.score(). За каждым выражением может следовать asc для обозначения возрастания, или desc для обозначения убывания. По умолчанию используется порядок возрастания. Ничьи будут разбиты по счету матчей документов. Если $orderby не указан, порядок сортировки по умолчанию — по убыванию по счету совпадения документа. Их может быть не более 32 $orderby пунктов.
$select	query		string[]	Список полей для извлечения. Если не указано, в результаты будет включено только ключевое поле.
$top	query		integer (int32)	Количество предложений для извлечения. Значение должно быть числом от 1 до 100. Значение по умолчанию равно 5.
fuzzy	query		boolean	Значение, указывающее, следует ли использовать нечеткое сопоставление для запроса предложений. По умолчанию — false. Если задано значение true, запрос будет находить термины, даже если в тексте поиска есть замененный или отсутствующий символ. Хотя в некоторых сценариях это обеспечивает более эффективное взаимодействие, это приводит к снижению производительности, так как запросы нечетких предложений выполняются медленнее и потребляют больше ресурсов.
highlightPostTag	query		string	Тег строки, который добавляется к выделениям попадания. Должен быть установлен с помощью highlightPreTag. Если опущено, подсветка предложений будет отключена.
highlightPreTag	query		string	Тег string, который добавляется в начало для выделения попадания. Должен быть установлен с помощью highlightPostTag. Если опущено, подсветка предложений будет отключена.
minimumCoverage	query		number (double)	Число от 0 до 100, указывающее процент индекса, который должен быть покрыт запросом предложений, чтобы запрос был отмечен как успешный. Этот параметр может быть полезен для обеспечения доступности поиска даже для сервисов с одной репликой. Значение по умолчанию — 80.
searchFields	query		string[]	Список имен полей для поиска по указанному искомому тексту. Целевые поля должны быть включены в указанный подборщик.

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

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

Ответы

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

Примеры

SearchIndexSuggestDocumentsGet

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

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?search=hote&suggesterName=sg&$filter=rating gt 10&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&searchFields=title&$select=docId,title,description&$top=10&api-version=2025-09-01

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

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

{
  "value": [
    {
      "@search.text": "Nice <em>Hotel</em>",
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.text": "Fancy <em>Hotel</em>",
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
SuggestDocumentsResult	Ответ, содержащий результаты запроса предложений из индекса.
SuggestResult	Результат, содержащий документ, найденный с помощью запроса предложений, а также связанные метаданные.

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

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

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

SuggestDocumentsResult

Объект

Ответ, содержащий результаты запроса предложений из индекса.

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

SuggestResult

Объект

Результат, содержащий документ, найденный с помощью запроса предложений, а также связанные метаданные.

Имя	Тип	Описание
@search.text	string	Текст результата предложения.