Documents - Suggest Get

Ссылка

Служба:: Search Service

Версия API:: 2024-07-01

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

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&api-version=2024-07-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=2024-07-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(). За каждым выражением можно следовать какc, чтобы указать возрастание, или desc, чтобы указать убывание. Значение по умолчанию — по возрастанию. Связи будут нарушены с помощью показателей соответствия документов. Если $orderby не указано, порядок сортировки по умолчанию убывает по оценке соответствия документа. Существует не более 32 предложений $orderby.
$select	query		string[]	Список полей для извлечения. Если не указано, в результаты будут включены только ключевое поле.
$top	query		integer int32	Количество предложений для получения. Значение должно быть числом от 1 до 100. Значение по умолчанию — 5.
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	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=2024-07-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	Значение, указывающее процент индекса, который был включен в запрос, или значение NULL, если минимальное значениеCoverage не было задано в запросе.
value	SuggestResult[]	Последовательность результатов, возвращаемая запросом.

SuggestResult

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

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

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