Documents - Search Post

Служба:: Search Service

Версия API:: 2024-03-01-Preview

Ищет документы в индексе.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2024-03-01-Preview

Параметры URI

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

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

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

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

Имя	Тип	Описание
answers	QueryAnswerType	Значение, указывающее, следует ли возвращать ответы как часть ответа поиска.
captions	QueryCaptionType	Значение, указывающее, должны ли возвращаться заголовки в ответе на поиск.
count	boolean	Значение, указывающее, следует ли получить общее количество результатов. Значение по умолчанию — false. Если задать значение true, это значение может повлиять на производительность. Обратите внимание, что возвращаемое число является приблизительный.
debug	QueryDebugMode	Включает средство отладки, которое можно использовать для дальнейшего изучения повторных результатов.
facets	string[]	Список выражений аспектов, применяемых к поисковому запросу. Каждое выражение аспектов содержит имя поля, за которым следует список пар name:value, разделенный запятыми.
filter	string	Выражение OData $filter, применяемое к поисковому запросу.
highlight	string	Список имен полей, разделенных запятыми, используемых для выделения попаданий. Для выделения попаданий можно использовать только поля, доступные для поиска.
highlightPostTag	string	Тег строки, добавляемый для выделения попаданий. Необходимо задать с выделенным значениемPreTag. Значение по умолчанию — </em>.
highlightPreTag	string	Тег строки, который предопределен для выделения попаданий. Необходимо задать с помощью highlightPostTag. По умолчанию используется <em>.
minimumCoverage	number (double)	Число от 0 до 100, указывающее процент индекса, который должен охватываться поисковым запросом, чтобы запрос сообщалось успешно. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одной репликой. Значение по умолчанию — 100.
orderby	string	Разделенный запятыми список выражений OData $orderby, по которым выполняется сортировка результатов. Каждое выражение может быть именем поля или вызовом функций geo.distance() или search.score(). За каждым выражением можно следовать какc, чтобы указать возрастание, или desc, чтобы указать убывание. Значение по умолчанию — по возрастанию. Связи будут нарушены с помощью показателей соответствия документов. Если $orderby не указано, порядок сортировки по умолчанию убывает по оценке соответствия документа. Существует не более 32 предложений $orderby.
queryLanguage	QueryLanguage	Значение, указывающее язык поискового запроса.
queryType	QueryType	Значение, указывающее синтаксис поискового запроса. Значение по умолчанию — simple. Используйте значение full, если запрос использует синтаксис запроса Lucene.
scoringParameters	string[]	Список значений параметров, используемых в функциях оценки (например, referencePointParameter) с использованием значений имени формата. Например, если профиль оценки определяет функцию с параметром с именем mylocation, строка параметра будет "mylocation--122.2,44.8" (без кавычки).
scoringProfile	string	Имя профиля оценки для оценки показателей для сопоставления документов для сортировки результатов.
scoringStatistics	ScoringStatistics	Значение, указывающее, требуется ли вычислить статистику оценки (например, частоту документов) глобально для более согласованной оценки или локальной задержки. Значение по умолчанию — local. Используйте "global" для агрегирования статистики оценки глобально перед оценкой. Использование глобальной статистики оценки может увеличить задержку поисковых запросов.
search	string	Выражение запроса полнотекстового поиска; Используйте "*" или опустить этот параметр для сопоставления всех документов.
searchFields	string	Список имен полей, разделенных запятыми, в которых выполняется полнотекстовый поиск. При использовании поля поиска (fieldName:searchExpression) в полном запросе Lucene имена полей каждого поля выражения поиска имеют приоритет над именами полей, перечисленными в этом параметре.
searchMode	SearchMode	Значение, указывающее, должны ли совпадать все или все условия поиска, чтобы подсчитать документ как совпадение.
select	string	Список извлекаемых полей с разделием запятыми. Если не указано, все поля, помеченные как извлекаемые в схеме, включаются.
semanticConfiguration	string	Имя семантической конфигурации, которая будет использоваться при обработке документов для запросов семантики типа.
semanticErrorHandling	SemanticErrorMode	Позволяет пользователю выбрать, должен ли семантический вызов полностью завершиться или возвращать частичные результаты (по умолчанию).
semanticFields	string	Разделенный запятыми список имен полей, используемых для семантического ранжирования.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Позволяет пользователю задать верхнюю границу на время, которое требуется для завершения обработки семантического обогащения до сбоя запроса.
semanticQuery	string	Позволяет задать отдельный поисковый запрос, который будет использоваться исключительно для семантического повторения, семантических подписей и семантических ответов. Полезно для сценариев, когда требуется использовать различные запросы между базовым этапом извлечения и ранжирования, а также семантической фазой L2.
sessionId	string	Значение, используемое для создания липкого сеанса, которое может помочь получить более согласованные результаты. До тех пор, пока используется тот же идентификатор сеанса, будет предпринята попытка попытаться выбрать тот же набор реплик. Будьте осторожны, что повторное использование одних и того же значения sessionID многократно может повлиять на балансировку нагрузки запросов между репликами и негативно повлиять на производительность службы поиска. Значение, используемое в качестве sessionId, не может начинаться с символа "_".
skip	integer (int32)	Количество пропущенных результатов поиска. Это значение не может быть больше 100 000. Если вам нужно сканировать документы в последовательности, но не удается пропустить из-за этого ограничения, рекомендуется использовать orderby на полностью упорядоченном ключе и фильтровать с помощью запроса диапазона.
speller	QuerySpellerType	Значение, указывающее тип орфографии, используемый для исправления отдельных условий запроса поиска.
top	integer (int32)	Количество полученных результатов поиска. Это можно использовать в сочетании с $skip для реализации разбиения по страницам на стороне клиента результатов поиска. Если результаты усечены из-за разбиения на страницы на стороне сервера, ответ будет содержать маркер продолжения, который можно использовать для выдачи другого запроса поиска на следующую страницу результатов.
vectorFilterMode	VectorFilterMode	Определяет, применяются ли фильтры до или после выполнения векторного поиска. Значение по умолчанию — preFilter.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Параметры запроса для векторных и гибридных поисковых запросов.

Ответы

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

Примеры

SearchIndexSearchDocumentsPost

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

HTTP

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

{
  "count": true,
  "facets": [
    "category,count:10,sort:count"
  ],
  "filter": "rating gt 4.0",
  "highlight": "description",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": null,
  "orderby": "rating desc",
  "queryType": "simple",
  "scoringParameters": [
    "currentLocation--122.123,44.77233"
  ],
  "scoringProfile": "sp",
  "search": "nice hotels",
  "searchFields": "category,description",
  "searchMode": "any",
  "sessionId": "mysessionid",
  "scoringStatistics": "global",
  "select": "hotelId,description",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "kind": "vector",
      "vector": [
        0.103,
        0.0712,
        0.0852,
        0.1547,
        0.1183
      ],
      "fields": "descriptionEmbedding",
      "k": 5,
      "exhaustive": true,
      "oversampling": 20
    }
  ],
  "vectorFilterMode": "preFilter"
}

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

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

{
  "@odata.count": 25,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "@search.nextPageParameters": {
    "count": true,
    "facets": [
      "category,count:10,sort:count"
    ],
    "filter": "rating gt 4.0",
    "highlight": "title",
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "minimumCoverage": null,
    "orderby": "search.score() desc,rating desc",
    "queryType": "simple",
    "sessionId": "mysessionid",
    "scoringStatistics": "global",
    "scoringParameters": [
      "currentLocation--122.123,44.77233"
    ],
    "scoringProfile": "sp",
    "search": "nice hotels",
    "searchFields": "title,description",
    "searchMode": "any",
    "select": "docId,title,description",
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 1.5,
      "@search.highlights": {
        "title": [
          "<em>Nice</em> <em>Hotel</em>"
        ]
      },
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.score": 0.7,
      "@search.highlights": {
        "title": [
          "Fancy <em>Hotel</em>"
        ]
      },
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-03-01-Preview"
}

Определения

Имя	Описание
AnswerResult	Ответ — это текст, извлеченный из содержимого наиболее релевантных документов, соответствующих запросу. Ответы извлекаются из лучших результатов поиска. Кандидаты на ответы оцениваются и выбираются лучшие ответы.
CaptionResult	Заголовки являются наиболее репрезентативными фрагментами документа относительно поискового запроса. Они часто используются в качестве сводки документов. Заголовки возвращаются только для запросов типа "семантика".
DocumentDebugInfo	Содержит сведения об отладке, которые можно использовать для дальнейшего изучения результатов поиска.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
QueryAnswerType	Значение, указывающее, следует ли возвращать ответы как часть ответа поиска.
QueryCaptionType	Значение, указывающее, должны ли возвращаться заголовки в ответе на поиск.
QueryDebugMode	Включает средство отладки, которое можно использовать для дальнейшего изучения результатов поиска.
QueryLanguage	Язык запроса.
QueryResultDocumentRerankerInput	Необработанные сцепленные строки, отправленные в процесс семантического обогащения.
QueryResultDocumentSemanticField	Описание полей, отправленных в процесс семантического обогащения, а также способ их использования
QuerySpellerType	Значение, указывающее тип орфографии, используемый для исправления отдельных условий запроса поиска.
QueryType	Указывает синтаксис поискового запроса. Значение по умолчанию — simple. Используйте значение full, если запрос использует синтаксис запроса Lucene и "семантику", если синтаксис запроса не нужен.
RawVectorQuery	Параметры запроса, используемые для поиска векторов при предоставлении необработанного векторного значения.
ScoringStatistics	Значение, указывающее, требуется ли вычислить статистику оценки (например, частоту документов) глобально для более согласованной оценки или локальной задержки. Значение по умолчанию — local. Используйте "global" для агрегирования статистики оценки глобально перед оценкой. Использование глобальной статистики оценки может увеличить задержку поисковых запросов.
SearchDocumentsResult	Ответ, содержащий результаты поиска из индекса.
SearchMode	Указывает, должны ли быть сопоставлены какие-либо или все условия поиска для подсчета документа в качестве совпадения.
SearchRequest	Параметры фильтрации, сортировки, фасетирования, разбиения по страницам и других поведении поисковых запросов.
SearchResult	Содержит документ, найденный поисковым запросом, а также связанные метаданные.
SemanticDebugInfo
SemanticErrorMode	Позволяет пользователю выбрать, должен ли семантический вызов полностью завершиться или возвращать частичные результаты (по умолчанию).
SemanticErrorReason	Причина того, что частичный ответ был возвращен для семантического ранжирования запроса.
SemanticFieldState	Способ использования поля для процесса семантического обогащения (полностью используемый, частично используемый или неиспользуемый)
SemanticSearchResultsType	Тип частичного ответа, возвращаемого для семантического ранжирования запроса.
VectorFilterMode	Определяет, применяются ли фильтры до или после выполнения векторного поиска.
VectorizableTextQuery	Параметры запроса, используемые для векторного поиска, если задано текстовое значение, которое необходимо векторизировать.
VectorQueryKind	Тип выполняемого векторного запроса.

AnswerResult

Объект

Ответ — это текст, извлеченный из содержимого наиболее релевантных документов, соответствующих запросу. Ответы извлекаются из лучших результатов поиска. Кандидаты на ответы оцениваются и выбираются лучшие ответы.

Имя	Тип	Описание
highlights	string	Тот же текст, что и в свойстве Text с выделенными текстовыми фразами, наиболее релевантными для запроса.
key	string	Ключ документа, из который был извлечен ответ.
score	number (double)	Значение оценки представляет, насколько релевантн ответ на запрос относительно других ответов, возвращаемых для запроса.
text	string	Текст, извлеченный из содержимого документа в качестве ответа.

CaptionResult

Объект

Заголовки являются наиболее репрезентативными фрагментами документа относительно поискового запроса. Они часто используются в качестве сводки документов. Заголовки возвращаются только для запросов типа "семантика".

Имя	Тип	Описание
highlights	string	Тот же текст, что и в свойстве Text с выделенными фразами, наиболее релевантными для запроса.
text	string	Репрезентативный текст, извлеченный из документа, наиболее релевантного к поисковому запросу.

DocumentDebugInfo

Объект

Содержит сведения об отладке, которые можно использовать для дальнейшего изучения результатов поиска.

Имя	Тип	Описание
semantic	SemanticDebugInfo	Содержит сведения об отладке, относящиеся к семантической ранжированию запросов.

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

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

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

QueryAnswerType

Перечисление

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

Значение	Описание
none	Не возвращайте ответы на запрос.
extractive	Извлекает кандидатов ответов из содержимого документов, возвращаемых в ответ на запрос, выраженный как вопрос на естественном языке.

QueryCaptionType

Перечисление

Значение, указывающее, должны ли возвращаться заголовки в ответе на поиск.

Значение	Описание
none	Не возвращайте подписи для запроса.
extractive	Извлекает заголовки из соответствующих документов, содержащих фрагменты, относящиеся к поисковому запросу.

QueryDebugMode

Перечисление

Включает средство отладки, которое можно использовать для дальнейшего изучения результатов поиска.

Значение	Описание
disabled	Сведения об отладке запросов не будут возвращены.
semantic	Позволяет пользователю более подробно изучить результаты повторного выполнения.

QueryLanguage

Перечисление

Язык запроса.

Значение	Описание
none	Язык запросов не указан.
en-us	Значение языка запросов для английского языка (США).
en-gb	Значение языка запросов для английского языка (Великобритания).
en-in	Значение языка запросов для английского языка (Индия).
en-ca	Значение языка запросов для английского языка (Канада).
en-au	Значение языка запросов для английского языка (Австралия).
fr-fr	Значение языка запросов для французского языка (Франция).
fr-ca	Значение языка запросов для французского языка (Канада).
de-de	Значение языка запросов для немецкого (Германия).
es-es	Значение языка запросов для испанского языка (Испания).
es-mx	Значение языка запросов для испанского языка (Мексика).
zh-cn	Значение языка запросов для китайского языка (Китай).
zh-tw	Значение языка запросов для китайского (Тайвань).
pt-br	Значение языка запросов для португальского языка (Бразилия).
pt-pt	Значение языка запросов для португальского языка (Португалия).
it-it	Значение языка запросов для итальянского языка (Италия).
ja-jp	Значение языка запросов для японского языка (Япония).
ko-kr	Значение языка запросов для корейского языка (Корея).
ru-ru	Значение языка запросов для российского языка (Россия).
cs-cz	Значение языка запросов для Чешской (Чехия).
nl-be	Значение языка запросов для голландского языка (Бельгия).
nl-nl	Значение языка запросов для голландского языка (Нидерланды).
hu-hu	Значение языка запроса для венгерского (Венгрия).
pl-pl	Значение языка запросов для польского языка (Польша).
sv-se	Значение языка запросов для шведского языка (Швеция).
tr-tr	Значение языка запросов для турецкого (Турция).
hi-in	Значение языка запросов для Хинди (Индия).
ar-sa	Значение языка запроса для арабского языка (Саудовская Аравия).
ar-eg	Значение языка запроса для арабского языка (Египет).
ar-ma	Значение языка запроса для арабского языка (Марокко).
ar-kw	Значение языка запроса для арабского языка (Кувейт).
ar-jo	Значение языка запросов для арабского языка (Иордания).
da-dk	Значение языка запросов для датского языка (Дания).
no-no	Значение языка запросов для норвежского языка (Норвегия).
bg-bg	Значение языка запросов для Болгарии (Болгария).
hr-hr	Значение языка запроса для хорватского языка (Хорватия).
hr-ba	Значение языка запроса для хорватского языка (Босния и Герцеговина).
ms-my	Значение языка запросов для Малай (Малайзия).
ms-bn	Значение языка запроса для Малая (Бруней Даруссалам).
sl-sl	Значение языка запросов для Словенского (Словения).
ta-in	Значение языка запросов для Тамила (Индия).
vi-vn	Значение языка запросов для вьетнамцев (Вьетнам).
el-gr	Значение языка запроса для греческого языка (Греция).
ro-ro	Значение языка запросов для румына (Румыния).
is-is	Значение языка запросов для Исландии (Исландия).
id-id	Значение языка запросов для индонезийского (Индонезия).
th-th	Значение языка запросов для тайского (Таиланда).
lt-lt	Значение языка запроса для Литвы (Литва).
uk-ua	Значение языка запросов для украинца (Украина).
lv-lv	Значение языка запроса для Латышского (Латвия).
et-ee	Значение языка запросов для Эстонии (Эстония).
ca-es	Значение языка запроса для каталонского языка.
fi-fi	Значение языка запросов для финляндии (Финляндия).
sr-ba	Значение языка запросов для сербских (Босния и Герцеговина).
sr-me	Значение языка запроса для сербских (Черногория).
sr-rs	Значение языка запросов для сербских (Сербия).
sk-sk	Значение языка запросов для словацкого языка (Словакия).
nb-no	Значение языка запросов для норвежского языка (Норвегия).
hy-am	Значение языка запросов для армян (Армения).
bn-in	Значение языка запроса для Бенгали (Индия).
eu-es	Значение языка запросов для Баска.
gl-es	Значение языка запроса для Галисияна.
gu-in	Значение языка запроса для Gujarati (Индия).
he-il	Значение языка запросов для иврита (Израиль).
ga-ie	Значение языка запросов для ирландского языка (Ирландия).
kn-in	Значение языка запросов для Kannada (Индия).
ml-in	Значение языка запросов для Малаялам (Индия).
mr-in	Значение языка запросов для Маратхи (Индия).
fa-ae	Значение языка запросов для персидского языка (U.A.E.).
pa-in	Значение языка запросов для Пенджаби (Индия).
te-in	Значение языка запросов для Telugu (Индия).
ur-pk	Значение языка запросов для Urdu (Пакистан).

QueryResultDocumentRerankerInput

Объект

Необработанные сцепленные строки, отправленные в процесс семантического обогащения.

Имя	Тип	Описание
content	string	Необработанные сцепленные строки для полей содержимого, которые использовались для семантического обогащения.
keywords	string	Необработанные сцепленные строки для полей ключевых слов, которые использовались для семантического обогащения.
title	string	Необработанная строка для поля заголовка, используемого для семантического обогащения.

QueryResultDocumentSemanticField

Объект

Описание полей, отправленных в процесс семантического обогащения, а также способ их использования

Имя	Тип	Описание
name	string	Имя поля, отправленного в процесс семантического обогащения
state	SemanticFieldState	Способ использования поля для процесса семантического обогащения (полностью используемый, частично используемый или неиспользуемый)

QuerySpellerType

Перечисление

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

Значение	Описание
none	Орфограф не включен.
lexicon	Средство орфографии исправляет отдельные термины запроса с помощью статического лексикона для языка, заданного параметром queryLanguage.

QueryType

Перечисление

Указывает синтаксис поискового запроса. Значение по умолчанию — simple. Используйте значение full, если запрос использует синтаксис запроса Lucene и "семантику", если синтаксис запроса не нужен.

Значение	Описание
simple	Использует простой синтаксис запроса для поиска. Текст поиска интерпретируется с помощью простого языка запросов, который позволяет использовать такие символы, как +, * и ". Запросы оцениваются по умолчанию во всех полях, доступных для поиска, если не указан параметр searchFields.
full	Использует полный синтаксис запроса Lucene для поиска. Текст поиска интерпретируется с помощью языка запросов Lucene, который позволяет выполнять поиск по полю и весовые значения, а также другие расширенные функции.
semantic	Лучше всего подходит для запросов, выраженных на естественном языке, в отличие от ключевых слов. Повышает точность результатов поиска путем повторного ранжирования лучших результатов поиска с помощью модели ранжирования, обученной в веб-корпусе.

RawVectorQuery

Объект

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

Имя	Тип	Описание
exhaustive	boolean	Если значение true, активирует исчерпывающий поиск ближайших к соседей по всем векторам в индексе векторов. Полезно для сценариев, когда точные совпадения являются критически важными, например определение значений истины на земле.
fields	string	Список имен полей, разделенных запятыми, которые необходимо включить в векторный поиск. Каждое из полей должно быть допустимым типом вектора, например Collection(Edm.Single). Если задано несколько полей, вектор будет использоваться для поиска ближайших совпадений во всех полях.
k	integer (int32)	Число ближайших соседей, возвращаемых в качестве лучших хитов.
kind	string: vector	Тип выполняемого векторного запроса.
oversampling	number (double)	Превышение коэффициента. Минимальное значение равно 1. Он переопределяет параметр defaultOversampling, настроенный в определении индекса. Его можно задать только в том случае, если параметр rerankWithOriginalVectors имеет значение true. Этот параметр допускается только в том случае, если метод сжатия используется в базовом поле вектора.
vector	number[] (float)	Векторное представление поискового запроса.

ScoringStatistics

Перечисление

Значение, указывающее, требуется ли вычислить статистику оценки (например, частоту документов) глобально для более согласованной оценки или локальной задержки. Значение по умолчанию — local. Используйте "global" для агрегирования статистики оценки глобально перед оценкой. Использование глобальной статистики оценки может увеличить задержку поисковых запросов.

Значение	Описание
local	Статистика оценки вычисляется локально для снижения задержки.
global	Статистика оценки будет вычисляться глобально для более согласованной оценки.

SearchDocumentsResult

Объект

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

Имя	Тип	Описание
@odata.count	integer (int64)	Общее количество результатов, найденных операцией поиска, или значение NULL, если число не было запрошено. При наличии число результатов в этом ответе может быть больше числа результатов. Это может произойти, если вы используете параметры $top или $skip или если запрос не может возвращать все запрошенные документы в одном ответе.
@odata.nextLink	string	URL-адрес продолжения, возвращаемый, когда запрос не может возвращать все запрошенные результаты в одном ответе. Этот URL-адрес можно использовать для формирования другого запроса GET или POST Search, чтобы получить следующую часть ответа на поиск. Обязательно используйте ту же команду (GET или POST), что и запрос, создающий этот ответ.
@search.answers	AnswerResult[]	Результаты запроса ответов для операции поиска; Значение NULL, если параметр запроса ответов не указан или задан значение none.
@search.coverage	number (double)	Значение, указывающее процент индекса, который был включен в запрос, или значение NULL, если минимальное значениеCoverage не указано в запросе.
@search.facets	object	Результаты запроса аспектов для операции поиска, упорядоченные как коллекция контейнеров для каждого фасетного поля; Значение NULL, если запрос не включал никаких выражений аспектов.
@search.nextPageParameters	SearchRequest	Полезные данные JSON продолжения возвращаются, когда запрос не может возвращать все запрошенные результаты в одном ответе. Этот код JSON можно использовать вместе с @odata.nextLink, чтобы сформулировать другой запрос поиска POST, чтобы получить следующую часть ответа поиска.
@search.semanticPartialResponseReason	SemanticErrorReason	Причина того, что частичный ответ был возвращен для семантического ранжирования запроса.
@search.semanticPartialResponseType	SemanticSearchResultsType	Тип частичного ответа, возвращаемого для семантического ранжирования запроса.
value	SearchResult[]	Последовательность результатов, возвращаемая запросом.

SearchMode

Перечисление

Указывает, должны ли быть сопоставлены какие-либо или все условия поиска для подсчета документа в качестве совпадения.

Значение	Описание
any	Для подсчета документа в качестве соответствия необходимо сопоставить любой из условий поиска.
all	Все условия поиска должны быть сопоставлены для подсчета документа в качестве совпадения.

SearchRequest

Объект

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

Имя	Тип	Описание
answers	QueryAnswerType	Значение, указывающее, следует ли возвращать ответы как часть ответа поиска.
captions	QueryCaptionType	Значение, указывающее, должны ли возвращаться заголовки в ответе на поиск.
count	boolean	Значение, указывающее, следует ли получить общее количество результатов. Значение по умолчанию — false. Если задать значение true, это значение может повлиять на производительность. Обратите внимание, что возвращаемое число является приблизительный.
debug	QueryDebugMode	Включает средство отладки, которое можно использовать для дальнейшего изучения повторных результатов.
facets	string[]	Список выражений аспектов, применяемых к поисковому запросу. Каждое выражение аспектов содержит имя поля, за которым следует список пар name:value, разделенный запятыми.
filter	string	Выражение OData $filter, применяемое к поисковому запросу.
highlight	string	Список имен полей, разделенных запятыми, используемых для выделения попаданий. Для выделения попаданий можно использовать только поля, доступные для поиска.
highlightPostTag	string	Тег строки, добавляемый для выделения попаданий. Необходимо задать с выделенным значениемPreTag. Значение по умолчанию — </em>.
highlightPreTag	string	Тег строки, который предопределен для выделения попаданий. Необходимо задать с помощью highlightPostTag. По умолчанию используется <em>.
minimumCoverage	number (double)	Число от 0 до 100, указывающее процент индекса, который должен охватываться поисковым запросом, чтобы запрос сообщалось успешно. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одной репликой. Значение по умолчанию — 100.
orderby	string	Разделенный запятыми список выражений OData $orderby, по которым выполняется сортировка результатов. Каждое выражение может быть именем поля или вызовом функций geo.distance() или search.score(). За каждым выражением можно следовать какc, чтобы указать возрастание, или desc, чтобы указать убывание. Значение по умолчанию — по возрастанию. Связи будут нарушены с помощью показателей соответствия документов. Если $orderby не указано, порядок сортировки по умолчанию убывает по оценке соответствия документа. Существует не более 32 предложений $orderby.
queryLanguage	QueryLanguage	Значение, указывающее язык поискового запроса.
queryType	QueryType	Значение, указывающее синтаксис поискового запроса. Значение по умолчанию — simple. Используйте значение full, если запрос использует синтаксис запроса Lucene.
scoringParameters	string[]	Список значений параметров, используемых в функциях оценки (например, referencePointParameter) с использованием значений имени формата. Например, если профиль оценки определяет функцию с параметром с именем mylocation, строка параметра будет "mylocation--122.2,44.8" (без кавычки).
scoringProfile	string	Имя профиля оценки для оценки показателей для сопоставления документов для сортировки результатов.
scoringStatistics	ScoringStatistics	Значение, указывающее, требуется ли вычислить статистику оценки (например, частоту документов) глобально для более согласованной оценки или локальной задержки. Значение по умолчанию — local. Используйте "global" для агрегирования статистики оценки глобально перед оценкой. Использование глобальной статистики оценки может увеличить задержку поисковых запросов.
search	string	Выражение запроса полнотекстового поиска; Используйте "*" или опустить этот параметр для сопоставления всех документов.
searchFields	string	Список имен полей, разделенных запятыми, в которых выполняется полнотекстовый поиск. При использовании поля поиска (fieldName:searchExpression) в полном запросе Lucene имена полей каждого поля выражения поиска имеют приоритет над именами полей, перечисленными в этом параметре.
searchMode	SearchMode	Значение, указывающее, должны ли совпадать все или все условия поиска, чтобы подсчитать документ как совпадение.
select	string	Список извлекаемых полей с разделием запятыми. Если не указано, все поля, помеченные как извлекаемые в схеме, включаются.
semanticConfiguration	string	Имя семантической конфигурации, которая будет использоваться при обработке документов для запросов семантики типа.
semanticErrorHandling	SemanticErrorMode	Позволяет пользователю выбрать, должен ли семантический вызов полностью завершиться или возвращать частичные результаты (по умолчанию).
semanticFields	string	Разделенный запятыми список имен полей, используемых для семантического ранжирования.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Позволяет пользователю задать верхнюю границу на время, которое требуется для завершения обработки семантического обогащения до сбоя запроса.
semanticQuery	string	Позволяет задать отдельный поисковый запрос, который будет использоваться исключительно для семантического повторения, семантических подписей и семантических ответов. Полезно для сценариев, когда требуется использовать различные запросы между базовым этапом извлечения и ранжирования, а также семантической фазой L2.
sessionId	string	Значение, используемое для создания липкого сеанса, которое может помочь получить более согласованные результаты. До тех пор, пока используется тот же идентификатор сеанса, будет предпринята попытка попытаться выбрать тот же набор реплик. Будьте осторожны, что повторное использование одних и того же значения sessionID многократно может повлиять на балансировку нагрузки запросов между репликами и негативно повлиять на производительность службы поиска. Значение, используемое в качестве sessionId, не может начинаться с символа "_".
skip	integer (int32)	Количество пропущенных результатов поиска. Это значение не может быть больше 100 000. Если вам нужно сканировать документы в последовательности, но не удается пропустить из-за этого ограничения, рекомендуется использовать orderby на полностью упорядоченном ключе и фильтровать с помощью запроса диапазона.
speller	QuerySpellerType	Значение, указывающее тип орфографии, используемый для исправления отдельных условий запроса поиска.
top	integer (int32)	Количество полученных результатов поиска. Это можно использовать в сочетании с $skip для реализации разбиения по страницам на стороне клиента результатов поиска. Если результаты усечены из-за разбиения на страницы на стороне сервера, ответ будет содержать маркер продолжения, который можно использовать для выдачи другого запроса поиска на следующую страницу результатов.
vectorFilterMode	VectorFilterMode	Определяет, применяются ли фильтры до или после выполнения векторного поиска. Значение по умолчанию — preFilter.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Параметры запроса для векторных и гибридных поисковых запросов.

SearchResult

Объект

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

Имя	Тип	Описание
@search.captions	CaptionResult[]	Заголовки являются наиболее репрезентативными фрагментами документа относительно поискового запроса. Они часто используются в качестве сводки документов. Заголовки возвращаются только для запросов типа "семантика".
@search.documentDebugInfo	DocumentDebugInfo[]	Содержит сведения об отладке, которые можно использовать для дальнейшего изучения результатов поиска.
@search.highlights	object	Фрагменты текста документа, указывающие соответствующие условия поиска, упорядоченные по каждому применимому полю; Значение NULL, если выделение попаданий не было включено для запроса.
@search.rerankerScore	number (double)	Оценка релевантности, вычисляемая семантической рангером для лучших результатов поиска. Результаты поиска отсортированы по rerankerScore сначала, а затем по оценке. RerankerScore возвращается только для запросов типа "семантика".
@search.score	number (double)	Оценка релевантности документа по сравнению с другими документами, возвращаемыми запросом.

SemanticDebugInfo

Объект

Имя	Тип	Описание
contentFields	QueryResultDocumentSemanticField[]	Поля содержимого, отправленные в процесс семантического обогащения, а также как они использовались
keywordFields	QueryResultDocumentSemanticField[]	Поля ключевых слов, отправленные в процесс семантического обогащения, а также как они использовались
rerankerInput	QueryResultDocumentRerankerInput	Необработанные сцепленные строки, отправленные в процесс семантического обогащения.
titleField	QueryResultDocumentSemanticField	Поле заголовка, отправленное в процесс семантического обогащения, а также как оно было использовано

SemanticErrorMode

Перечисление

Позволяет пользователю выбрать, должен ли семантический вызов полностью завершиться или возвращать частичные результаты (по умолчанию).

Значение	Описание
partial	Если семантическая обработка завершается ошибкой, частичные результаты по-прежнему возвращаются. Определение частичных результатов зависит от того, какой семантический шаг завершился сбоем и что было причиной сбоя.
fail	Если во время семантического этапа обработки существует исключение, запрос завершится ошибкой и возвращает соответствующий HTTP-код в зависимости от ошибки.

SemanticErrorReason

Перечисление

Причина того, что частичный ответ был возвращен для семантического ранжирования запроса.

Значение	Описание
maxWaitExceeded	Если задано значение "semanticMaxWaitInMilliseconds", а длительность семантической обработки превысила это значение. Возвращены только базовые результаты.
capacityOverloaded	Запрос был регулированием. Возвращены только базовые результаты.
transient	Не удалось выполнить хотя бы один шаг семантического процесса.

SemanticFieldState

Перечисление

Способ использования поля для процесса семантического обогащения (полностью используемый, частично используемый или неиспользуемый)

Значение	Описание
used	Поле было полностью использовано для семантического обогащения.
unused	Поле не использовалось для семантического обогащения.
partial	Поле было частично использовано для семантического обогащения.

SemanticSearchResultsType

Перечисление

Тип частичного ответа, возвращаемого для семантического ранжирования запроса.

Значение	Описание
baseResults	Результаты без семантического обогащения или повторного использования.
rerankedResults	Результаты были восстановлены с помощью модели повторного рангера и будут включать семантические субтитры. Они не будут включать какие-либо ответы, выделения ответов или заголовки.

VectorFilterMode

Перечисление

Определяет, применяются ли фильтры до или после выполнения векторного поиска.

Значение	Описание
postFilter	Фильтр будет применен после возврата набора кандидатов результатов вектора. В зависимости от избирательности фильтра это может привести к меньшему значению результатов, чем запрашивается параметром k.
preFilter	Фильтр будет применен перед поисковым запросом.

VectorizableTextQuery

Объект

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

Имя	Тип	Описание
exhaustive	boolean	Если значение true, активирует исчерпывающий поиск ближайших к соседей по всем векторам в индексе векторов. Полезно для сценариев, когда точные совпадения являются критически важными, например определение значений истины на земле.
fields	string	Список имен полей, разделенных запятыми, которые необходимо включить в векторный поиск. Каждое из полей должно быть допустимым типом вектора, например Collection(Edm.Single). Если задано несколько полей, вектор будет использоваться для поиска ближайших совпадений во всех полях.
k	integer (int32)	Число ближайших соседей, возвращаемых в качестве лучших хитов.
kind	string: text	Тип выполняемого векторного запроса.
oversampling	number (double)	Превышение коэффициента. Минимальное значение равно 1. Он переопределяет параметр defaultOversampling, настроенный в определении индекса. Его можно задать только в том случае, если параметр rerankWithOriginalVectors имеет значение true. Этот параметр допускается только в том случае, если метод сжатия используется в базовом поле вектора.
text	string	Векторный текст для выполнения запроса векторного поиска.

VectorQueryKind

Перечисление

Тип выполняемого векторного запроса.

Значение	Описание
vector	Векторный запрос, в котором предоставляется необработанное векторное значение.
text	Векторный запрос, в котором предоставляется текстовое значение, необходимое для векторизации.