Documents - Search Get

Служба:

Search Service

Версия API:

2023-10-01-Preview

Выполняет поиск документов в индексе.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2023-10-01-Preview

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

GET {endpoint}/indexes('{indexName}')/docs?search={search}&$count={$count}&facet={facet}&$filter={$filter}&highlight={highlight}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&queryType={queryType}&scoringParameter={scoringParameter}&scoringProfile={scoringProfile}&semanticQuery={semanticQuery}&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&debug={debug}&searchFields={searchFields}&queryLanguage={queryLanguage}&speller={speller}&answers={answers}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&captions={captions}&semanticFields={semanticFields}&api-version=2023-10-01-Preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	URL-адрес конечной точки службы поиска.
indexName	path	True	string	Имя индекса.
api-version	query	True	string	Версия API клиента.
$count	query		boolean	Значение типа , указывающее, следует ли получить общее количество результатов. Значение по умолчанию — false. Установка этого значения в значение true может повлиять на производительность. Обратите внимание на то, что возвращается приблизительное количество результатов.
$filter	query		string	Выражение OData $filter, применяемого к поисковому запросу.
$orderby	query		string[]	Список выражений OData $orderby, по которым сортируются результаты. Каждое выражение может быть именем поля или вызовом функций geo.distance() или search.score(). За каждым выражением может следовать asc для указания по возрастанию, и desc для указания по убыванию. По умолчанию результаты сортируются по возрастанию. При равенстве позиций порядок определяется по показателю совпадения документа. Если orderBy не указан, порядок сортировки по умолчанию убывания по оценке соответствия документа. Может быть не более 32 предложений $orderby.
$select	query		string[]	Список извлекаемых полей. Если этот параметр не указан, возвращаются все поля, помеченные в схеме как подлежащие извлечению.
$skip	query		integer int32	Количество пропускаемых результатов поиска. Значение не должно превышать 100 000. Если вам нужно сканировать документы в последовательности, но не удается использовать $skip из-за этого ограничения, рассмотрите возможность использования $orderby на полностью упорядоченном ключе и $filter с запросом диапазона.
$top	query		integer int32	Количество получаемых результатов поиска. Его можно использовать в сочетании с $skip для реализации разбиения результатов поиска на стороне клиента. Если результаты усечены из-за разбиения по страницам на стороне сервера, ответ будет содержать маркер продолжения, который можно использовать для выдачи другого запроса поиска для следующей страницы результатов.
answers	query		QueryAnswerType	Этот параметр действителен только в том случае, если тип запроса — semantic. Если задано значение , запрос возвращает ответы, извлеченные из ключевых фрагментов в документах с самым высоким рейтингом. Количество возвращаемых ответов можно настроить, добавив символ | канала, за которым следует count-<number of answers> параметр после значения параметра answers, например extractive|count-3. Число по умолчанию — 1. Порог достоверности можно настроить, добавив символ | канала, за которым следует threshold-<confidence threshold> параметр после значения параметра answers, например extractive|threshold-0.9. Пороговое значение по умолчанию — 0,7.
captions	query		QueryCaptionType	Этот параметр действителен только в том случае, если тип запроса — semantic. Если задано значение , запрос возвращает заголовки, извлеченные из ключевых фрагментов в документах с самым высоким рейтингом. Если для параметра Субтитры задано значение extractive, выделение включено по умолчанию и может быть настроено путем добавления символа | канала с последующим параметром highlight-<true/false> , например extractive|highlight-true. По умолчанию — None.
debug	query		QueryDebugMode	Включает средство отладки, которое можно использовать для дальнейшего изучения результатов поиска.
facet	query		string[]	Список выражений аспектов, применяемых к поисковому запросу. Каждое выражение аспекта содержит имя поля, за которым при необходимости следует разделенный запятыми список пар "имя:значение".
highlight	query		string[]	Список имен полей, используемых для выделения попаданий. Для выделения попаданий можно использовать только доступные для поиска поля.
highlightPostTag	query		string	Строковый тег, добавляемый к выделению нажатия. Необходимо задать параметр highlightPreTag. Значение по умолчанию — </em>.
highlightPreTag	query		string	Строковый тег, который добавляется к выделению нажатия. Должен быть задан с параметром highlightPostTag. Значение по умолчанию — <em>.
minimumCoverage	query		number double	Число от 0 до 100, указывающее процент индекса, который должен быть охвачен поисковым запросом, чтобы запрос сообщал об успешном выполнении. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одним реплика. Значение по умолчанию — 100.
queryLanguage	query		QueryLanguage	Язык запроса.
queryType	query		QueryType	Значение типа , указывающее синтаксис поискового запроса. Значение по умолчанию — simple. Используйте "full", если в запросе используется синтаксис запроса Lucene.
scoringParameter	query		string[]	Список значений параметров, используемых в функциях оценки (например, referencePointParameter) с использованием формата name-values. Например, если профиль оценки определяет функцию с параметром mylocation, строкой параметра будет "mylocation--122.2,44.8" (без кавычек).
scoringProfile	query		string	Имя профиля для оценки соответствующих показателей, для сопоставления документов с целью сортировки результатов.
scoringStatistics	query		ScoringStatistics	Значение типа , указывающее, нужно ли вычислить статистику оценки (например, частоту документов) глобально для более согласованной оценки или локально для меньшей задержки.
search	query		string	Выражение запроса полнотекстового поиска; Используйте "*" или опустите этот параметр, чтобы сопоставить все документы.
searchFields	query		string[]	Список имен полей, к которым следует область полнотекстового поиска. При использовании поля поиска (fieldName:searchExpression) в полном запросе Lucene имена полей каждого поля выражения поиска имеют приоритет над именами полей, перечисленными в этом параметре.
searchMode	query		SearchMode	Значение типа , указывающее, должны ли совпадать все условия поиска, чтобы подсчитать документ как совпадение.
semanticConfiguration	query		string	Имя семантической конфигурации, в которой перечислены поля, которые следует использовать для семантического ранжирования, субтитров, выделений и ответов.
semanticErrorHandling	query		SemanticErrorMode	Позволяет пользователю выбрать, должен ли семантический вызов завершиться сбоем или возвратить частичные результаты (по умолчанию).
semanticFields	query		string[]	Список имен полей, используемых для семантического ранжирования.
semanticMaxWaitInMilliseconds	query		integer int32	Позволяет пользователю задать верхнюю границу времени, необходимого для завершения обработки семантического обогащения до сбоя запроса.
semanticQuery	query		string	Позволяет задать отдельный поисковый запрос, который будет использоваться исключительно для семантического повторения, семантических субтитров и семантических ответов. Удобен для сценариев, в которых необходимо использовать различные запросы между базовым этапом извлечения и ранжирования и семантической фазой L2.
sessionId	query		string	Значение, используемое для создания прикрепленного сеанса, которое может помочь получить более согласованные результаты. Если используется один и тот же sessionId, будет предпринята попытка нацелиться на тот же реплика набор. Будьте осторожны, что многократное повторное использовать одни и те же значения sessionID может помешать балансировке нагрузки запросов между репликами и отрицательно повлиять на производительность службы поиска. Значение, используемое в качестве sessionId, не может начинаться с символа "_".
speller	query		Speller	Улучшение отзыва поиска путем исправления орфографии отдельных условий поискового запроса.

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

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

Ответы

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

Примеры

SearchIndexSearchDocumentsGet

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

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=nice hotels&$count=True&facet=category,count:10,sort:count&$filter=rating gt 10&highlight=title&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&queryType=simple&scoringProfile=sp&searchFields=title,description&speller={speller}&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2023-10-01-Preview

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

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

200

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "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"
    }
  ]
}

Определения

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

AnswerResult

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

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

CaptionResult

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

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

DocumentDebugInfo

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

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

QueryAnswerType

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

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

QueryCaptionType

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

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

QueryDebugMode

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

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

QueryLanguage

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

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

QueryResultDocumentRerankerInput

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

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

QueryResultDocumentSemanticField

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

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

QuerySpellerType

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

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

QueryType

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

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

RawVectorQuery

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

Имя	Тип	Описание
exhaustive	boolean	Если задано значение true, запускается исчерпывающий поиск k-ближайших соседей по всем векторам в индексе вектора. Полезно для сценариев, где точные совпадения имеют решающее значение, например для определения значений истинности.
fields	string	Векторные поля типа Collection(Edm.Single) для включения в поиск по вектору.
k	integer	Число ближайших соседей, возвращаемых в качестве первых попаданий.
kind	string: vector	Тип выполняемого векторного запроса.
vector	number[]	Векторное представление поискового запроса.

ScoringStatistics

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

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

SearchDocumentsResult

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

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

SearchError

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

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

SearchMode

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

Имя	Тип	Описание
all	string	Все условия поиска должны быть сопоставлены, чтобы подсчитать документ как совпадение.
any	string	Любое из условий поиска должно быть сопоставлено, чтобы подсчитать документ как совпадение.

SearchRequest

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

Имя	Тип	Описание
answers	QueryAnswerType	Значение типа , указывающее, должны ли возвращаться ответы как часть поискового ответа.
captions	QueryCaptionType	Значение типа , указывающее, должны ли возвращаться субтитры в ответе на поиск.
count	boolean	Значение типа , указывающее, следует ли получить общее количество результатов. Значение по умолчанию — false. Установка значения true может повлиять на производительность. Обратите внимание на то, что возвращается приблизительное количество результатов.
debug	QueryDebugMode	Включает средство отладки, которое можно использовать для дальнейшего изучения повторно отлаживаемых результатов.
facets	string[]	Список выражений аспекта, применяемых к поисковому запросу. Каждое выражение аспекта содержит имя поля, за которым при необходимости следует разделенный запятыми список пар "имя:значение".
filter	string	Выражение OData $filter, применяемого к поисковому запросу.
highlight	string	Разделенный запятыми список имен полей, используемых для выделения попаданий. Для выделения попаданий можно использовать только поля, доступные для поиска.
highlightPostTag	string	Строковый тег, добавляемый к выделенному нажатию. Должно быть задано значение highlightPreTag. Значение по умолчанию — </em>.
highlightPreTag	string	Строковый тег, который добавляется к выделению нажатия. Должен быть задан с параметром highlightPostTag. Значение по умолчанию — <em>.
minimumCoverage	number	Число от 0 до 100, указывающее процент индекса, который должен быть охвачен поисковым запросом, чтобы запрос сообщал об успешном выполнении. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одним реплика. Значение по умолчанию — 100.
orderby	string	Разделенный запятыми список OData $orderby выражений для сортировки результатов. Каждое выражение может быть именем поля или вызовом функций geo.distance() или search.score(). За каждым выражением может следовать asc для указания возрастания, или desc, чтобы обозначить по убыванию. По умолчанию результаты сортируются по возрастанию. При равенстве позиций порядок определяется по показателю совпадения документа. Если $orderby не указан, порядок сортировки по умолчанию убывания по оценке соответствия документа. Может быть не более 32 $orderby предложений.
queryLanguage	QueryLanguage	Значение типа , указывающее язык поискового запроса.
queryType	QueryType	Значение типа , указывающее синтаксис поискового запроса. Значение по умолчанию — simple. Используйте "full", если в запросе используется синтаксис запроса Lucene.
scoringParameters	string[]	Список значений параметров, используемых в функциях оценки (например, referencePointParameter) с использованием формата name-values. Например, если профиль оценки определяет функцию с параметром 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	Позволяет пользователю задать верхнюю границу времени, необходимого для завершения обработки семантического обогащения до сбоя запроса.
semanticQuery	string	Позволяет задать отдельный поисковый запрос, который будет использоваться исключительно для семантического повторения, семантических субтитров и семантических ответов. Удобен для сценариев, в которых необходимо использовать различные запросы между базовым этапом извлечения и ранжирования и семантической фазой L2.
sessionId	string	Значение, используемое для создания прикрепленного сеанса, которое может помочь получить более согласованные результаты. Если используется один и тот же sessionId, будет предпринята попытка нацелиться на тот же реплика набор. Будьте осторожны, что многократное повторное использовать одни и те же значения sessionID может помешать балансировке нагрузки запросов между репликами и отрицательно повлиять на производительность службы поиска. Значение, используемое в качестве sessionId, не может начинаться с символа "_".
skip	integer	Количество пропускаемых результатов поиска. Значение не должно превышать 100 000. Если вам нужно сканировать документы последовательно, но вы не можете использовать skip из-за этого ограничения, рассмотрите возможность использования orderby для полностью упорядоченного ключа и фильтрации с помощью запроса диапазона.
speller	QuerySpellerType	Значение типа , указывающее тип средства проверки орфографии, используемого для исправления орфографии отдельных поисковых запросов.
top	integer	Количество получаемых результатов поиска. Его можно использовать в сочетании с $skip для реализации разбиения результатов поиска на стороне клиента. Если результаты усечены из-за разбиения по страницам на стороне сервера, ответ будет содержать маркер продолжения, который можно использовать для выдачи другого запроса поиска для следующей страницы результатов.
vectorFilterMode	VectorFilterMode	Определяет, применяются ли фильтры до или после выполнения векторного поиска. Значение по умолчанию — preFilter.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Параметры запроса для векторных и гибридных поисковых запросов.

SearchResult

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

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

SemanticDebugInfo

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

SemanticErrorMode

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

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

SemanticErrorReason

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

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

SemanticFieldState

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

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

SemanticSearchResultsType

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

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

Speller

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

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

VectorFilterMode

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

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

VectorizableTextQuery

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

Имя	Тип	Описание
exhaustive	boolean	Если задано значение true, запускается исчерпывающий поиск k-ближайших соседей по всем векторам в индексе вектора. Полезно для сценариев, где точные совпадения имеют решающее значение, например для определения значений истинности.
fields	string	Векторные поля типа Collection(Edm.Single) для включения в поиск по вектору.
k	integer	Число ближайших соседей, возвращаемых в качестве первых попаданий.
kind	string: text	Тип выполняемого векторного запроса.
text	string	Текст, который необходимо векторизировать для выполнения запроса поиска векторов.

VectorQueryKind

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

Имя	Тип	Описание
text	string	Векторный запрос, в котором указано текстовое значение, которое необходимо векторизировать.
vector	string	Векторный запрос, в котором указано необработанное векторное значение.