Documents - Suggest Post

Ссылка

Служба:: Search Service

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

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?api-version=2024-07-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	Текст поиска, используемый для предложения документов. Должно быть не менее 1 символов и не более 100 символов.
suggesterName	True	string	Имя средства предложения, указанное в коллекции предлагаемых элементов, которые входят в определение индекса.
filter		string	Выражение OData, которое фильтрует документы, которые рассматриваются для предложений.
fuzzy		boolean	Значение, указывающее, следует ли использовать нечеткое сопоставление для запроса предложения. Значение по умолчанию — false. Если задано значение true, запрос найдет предложения, даже если в тексте поиска есть замещающий или отсутствующий символ. Хотя это обеспечивает более широкий опыт в некоторых сценариях, он приходится на производительность, так как поиск нечетких предложений медленнее и потребляет больше ресурсов.
highlightPostTag		string	Тег строки, добавляемый для выделения попаданий. Необходимо задать с выделенным значениемPreTag. Если опущено, выделение предложений отключено.
highlightPreTag		string	Тег строки, который предопределен для выделения попаданий. Необходимо задать с помощью highlightPostTag. Если опущено, выделение предложений отключено.
minimumCoverage		number	Число от 0 до 100, указывающее процент индекса, который должен охватываться запросом предложения, чтобы запрос сообщалось как успешный. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одной репликой. Значение по умолчанию — 80.
orderby		string	Разделенный запятыми список выражений OData $orderby, по которым выполняется сортировка результатов. Каждое выражение может быть именем поля или вызовом функций geo.distance() или search.score(). За каждым выражением можно следовать какc, чтобы указать возрастание, или desc, чтобы указать убывание. Значение по умолчанию — по возрастанию. Связи будут нарушены с помощью показателей соответствия документов. Если $orderby не указано, порядок сортировки по умолчанию убывает по оценке соответствия документа. Существует не более 32 предложений $orderby.
searchFields		string	Разделенный запятыми список имен полей для поиска указанного текста поиска. Целевые поля должны быть включены в указанный средство предложения.
select		string	Список извлекаемых полей с разделием запятыми. Если не указано, в результаты будут включены только ключевое поле.
top		integer	Количество предложений для получения. Это должно быть значение от 1 до 100. Значение по умолчанию — 5.

Ответы

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

Примеры

SearchIndexSuggestDocumentsPost

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

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2024-07-01

{
  "filter": "rating gt 4.0",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "rating desc",
  "search": "hote",
  "searchFields": "title",
  "select": "docId,title,description",
  "suggesterName": "sg",
  "top": 10
}

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

Код состояния:: 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	Ответ, содержащий результаты запроса предложения из индекса.
SuggestRequest	Параметры для фильтрации, сортировки, нечеткого сопоставления и других вариантов поведения запросов.
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[]	Последовательность результатов, возвращаемая запросом.

SuggestRequest

Параметры для фильтрации, сортировки, нечеткого сопоставления и других вариантов поведения запросов.

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

SuggestResult

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

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

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