Documents - Search Get

Служба:: Search Service

Версия API:: 2026-05-01-preview

Поиск документов в индексе.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2026-05-01-preview

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	URL-адрес конечной точки службы поиска.
indexName	path	True	string	Имя индекса.
api-version	query	True	string minLength: 1	Версия 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. Максимальную длину символов ответов можно настроить, добавив символ вертикальной черты '\|', за которым следует 'count-number< of maximum character length>', например 'extractive\|maxcharlength-600'.
captions	query		QueryCaptionType	Этот параметр действителен только в том случае, если тип запроса равен `semantic`. Если задано, запрос возвращает заголовки, извлеченные из ключевых проходов в документах с наивысшим рейтингом. Если для параметра Captions задано значение `extractive`, выделение включено по умолчанию, и его можно настроить, добавив символ `\|` вертикальной черты, за которым следует параметр, `highlight-<true/false>` например `extractive\|highlight-true`. По умолчанию — `None`. Максимальную длину символов заголовков можно настроить, добавив символ вертикальной черты '\|', за которым следует 'count-number< of maximum character length>', например 'extractive\|maxcharlength-600'.
debug	query		QueryDebugMode	Включает средство отладки, которое можно использовать для дальнейшего изучения результатов поиска.
facet	query		string[]	Список выражений аспектов, применяемых к поисковому запросу. Каждое выражение аспектов содержит имя поля, за которым следует список пар name:value, разделенный запятыми.
highlight	query		string[]	Список имен полей, используемых для выделения хитов. Для выделения попаданий можно использовать только поля, доступные для поиска.
highlightPostTag	query		string	Тег строки, добавляемый для выделения попаданий. Необходимо задать с выделенным значениемPreTag. Значение по умолчанию — </em>.
highlightPreTag	query		string	Тег строки, который предопределен для выделения попаданий. Необходимо задать с помощью highlightPostTag. По умолчанию используется <em>.
minimumCoverage	query		number (double)	Число от 0 до 100, указывающее процент индекса, который должен охватываться поисковым запросом, чтобы запрос сообщалось успешно. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одной репликой. Значение по умолчанию равно 100.
queryLanguage	query		QueryLanguage	Язык запроса.
queryRewrites	query		QueryRewritesType	Если для параметра QueryRewrite задано значение `generative`, условия запроса отправляются в созданную модель, которая выполнит 10 (по умолчанию) перезаписей, чтобы увеличить отзыв запроса. Запрашиваемое количество можно настроить, добавив символ `\|` вертикальной черты, за которым следует `count-<number of rewrites>` опция, например `generative\|count-3`. По умолчанию — `None`. Этот параметр действителен только в том случае, если тип запроса равен `semantic`.
queryType	query		QueryType	Значение, указывающее синтаксис поискового запроса. Значение по умолчанию — 'simple'. Используйте значение full, если запрос использует синтаксис запроса Lucene.
scoringParameter	query		string[]	Список значений параметров, используемых в функциях оценки (например, referencePointParameter) с использованием значений имени формата. Например, если профиль оценки определяет функцию с параметром с именем 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) minimum: 700	Позволяет пользователю задать верхнюю границу на время, которое требуется для завершения обработки семантического обогащения до сбоя запроса.
semanticQuery	query		string	Позволяет задать отдельный поисковый запрос, который будет использоваться исключительно для семантического повторения, семантических подписей и семантических ответов. Полезно для сценариев, когда требуется использовать различные запросы между базовым этапом извлечения и ранжирования, а также семантической фазой L2.
sessionId	query		string	Значение, используемое для создания липкого сеанса, которое может помочь получить более согласованные результаты. До тех пор, пока используется тот же идентификатор сеанса, будет предпринята попытка попытаться выбрать тот же набор реплик. Будьте осторожны, что повторное использование одних и того же значения sessionID многократно может повлиять на балансировку нагрузки запросов между репликами и негативно повлиять на производительность службы поиска. Значение, используемое в качестве sessionId, не может начинаться с символа "_".
speller	query		QuerySpellerType	Улучшите запоминаемость поисковых запросов за счет исправления орфографии отдельных поисковых запросов.

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

Имя	Тип	Описание
Accept	Accept	Заголовок Accept.
x-ms-query-source-authorization	string	Маркер, идентифицирующий пользователя, для которого выполняется запрос. Этот маркер используется для применения ограничений безопасности к документам.
x-ms-enable-elevated-read	boolean	Значение, которое разрешает чтение с повышенными привилегиями и обход проверок разрешений на уровне документа для операции запроса.
x-ms-client-request-id	string (uuid)	Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

Ответы

Имя	Тип	Описание
200 OK	SearchDocumentsResult	Запрос выполнен успешно.
Other Status Codes	SearchDocumentsResult	Успешно
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

api-key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://search.azure.com/.default

Примеры

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

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

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?api-version=2026-05-01-preview&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&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&speller={speller}

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

Код состояния:: 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"
    }
  ]
}

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

{
  "@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"
    }
  ]
}

SearchIndexSearchDocumentsSemanticGet

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

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?api-version=2026-05-01-preview&search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}&semanticFields={semanticFields}

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

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

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ]
}

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

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ]
}

Определения

Имя	Описание
Accept	Заголовок Accept.
DebugInfo	Содержит сведения об отладке, которые можно использовать для дальнейшего изучения результатов поиска.
DocumentDebugInfo	Содержит сведения об отладке, которые можно использовать для дальнейшего изучения результатов поиска.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Подробности ошибки.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
HybridCountAndFacetMode	Определяет, должны ли счетчики и фасеты включать все документы, соответствующие поисковому запросу, или только документы, полученные в окне maxTextRecallSize. Значение по умолчанию — countAllResults.
HybridSearch	Параметры запроса для настройки поведения гибридного поиска.
QueryAnswerResult	Ответ — это текст, извлеченный из содержимого наиболее релевантных документов, соответствующих запросу. Ответы извлекаются из лучших результатов поиска. Кандидаты на ответы оцениваются и выбираются лучшие ответы.
QueryAnswerType	Этот параметр действителен только в том случае, если тип запроса равен `semantic`. Если задано, запрос возвращает ответы, извлеченные из ключевых фрагментов в документах с наивысшим рейтингом. Количество возвращаемых ответов можно настроить, добавив символ `\|` вертикальной черты `count-<number of answers>` , за которым следует опция после значения параметра answers, например `extractive\|count-3`, . По умолчанию счетчик — 1. Порог достоверности можно настроить, добавив символ `\|` вертикальной черты, за которым следует `threshold-<confidence threshold>` опция после значения параметра answers, например `extractive\|threshold-0.9`, . Порог по умолчанию равен 0,7. Максимальную длину символов ответов можно настроить, добавив символ вертикальной черты '\|', за которым следует 'count-number< of maximum character length>', например 'extractive\|maxcharlength-600'.
QueryCaptionResult	Заголовки являются наиболее репрезентативными фрагментами документа относительно поискового запроса. Они часто используются в качестве сводки документов. Заголовки возвращаются только для запросов типа `semantic`.
QueryCaptionType	Этот параметр действителен только в том случае, если тип запроса равен `semantic`. Если задано, запрос возвращает заголовки, извлеченные из ключевых проходов в документах с наивысшим рейтингом. Если для параметра Captions задано значение `extractive`, выделение включено по умолчанию, и его можно настроить, добавив символ `\|` вертикальной черты, за которым следует параметр, `highlight-<true/false>` например `extractive\|highlight-true`. По умолчанию — `None`. Максимальную длину символов заголовков можно настроить, добавив символ вертикальной черты '\|', за которым следует 'count-number< of maximum character length>', например 'extractive\|maxcharlength-600'.
QueryDebugMode	Включает средство отладки, которое можно использовать для дальнейшего изучения результатов поиска. Вы можете включить несколько режимов отладки одновременно, разделив их с помощью \| , например: semantic\|queryRewrites.
QueryLanguage	Язык запроса.
QueryResultDocumentRerankerInput	Необработанные сцепленные строки, отправленные в процесс семантического обогащения.
QueryResultDocumentSemanticField	Описание полей, отправленных в процесс семантического обогащения, а также способ их использования
QueryResultDocumentSubscores	Разбивка подкордер между компонентами текстовых и векторных запросов для этого документа. Каждый векторный запрос отображается как отдельный объект в том же порядке, что и они были получены.
QueryRewritesDebugInfo	Содержит сведения об отладке, относящиеся к перезаписи запросов.
QueryRewritesType	Этот параметр действителен только в том случае, если тип запроса равен `semantic`. Если для параметра QueryRewrite задано значение `generative`, условия запроса отправляются в созданную модель, которая выполнит 10 (по умолчанию) перезаписей, чтобы увеличить отзыв запроса. Запрашиваемое количество можно настроить, добавив символ `\|` вертикальной черты, за которым следует `count-<number of rewrites>` опция, например `generative\|count-3`. По умолчанию — `None`.
QueryRewritesValuesDebugInfo	Содержит сведения об отладке, относящиеся к перезаписи запросов.
QuerySpellerType	Улучшите запоминаемость поисковых запросов за счет исправления орфографии отдельных поисковых запросов.
QueryType	Указывает синтаксис поискового запроса. Значение по умолчанию — 'simple'. Используйте 'full', если в вашем запросе используется синтаксис запроса Lucene, и 'semantic', если синтаксис запроса не нужен.
ScoringStatistics	Значение, указывающее, хотим ли мы вычислять статистику оценки (например, частоту выпуска документов) глобально для более стабильной оценки или локально для более низкой задержки. Значение по умолчанию — 'local'. Используйте 'global' для агрегирования статистики подсчета очков глобально перед подсчетом очков. Использование глобальной статистики скоринга может увеличить задержку поисковых запросов.
SearchDocumentsResult	Ответ, содержащий результаты поиска из индекса.
SearchMode	Указывает, должны ли быть сопоставлены некоторые или все условия поиска, чтобы документ считался совпадающим.
SearchRequest	Параметры фильтрации, сортировки, фасетирования, разбиения по страницам и других поведении поисковых запросов.
SearchResult	Содержит документ, найденный поисковым запросом, а также связанные метаданные.
SearchScoreThreshold	Результаты векторного запроса будут фильтрованы на основе '
SemanticDebugInfo	Содержит отладочную информацию, относящуюся к запросам семантического ранжирования.
SemanticErrorMode	Позволяет пользователю выбирать, должен ли семантический вызов полностью провалиться или вернуть частичные результаты.
SemanticErrorReason	Причина, по которой был возвращен частичный ответ на запрос семантического ранжирования.
SemanticFieldState	То, как это поле использовалось для процесса семантического обогащения.
SemanticQueryRewritesResultType	Тип переписывания запроса, который был использован для этого запроса.
SemanticSearchResultsType	Тип частичного ответа, который был возвращен для запроса семантического ранжирования.
SingleVectorFieldResult	Результат одного векторного поля. Both
TextResult	Оценка BM25 или Классическая оценка для текстовой части запроса.
VectorFilterMode	Определяет, применяются ли фильтры до или после выполнения векторного поиска.
VectorizableImageBinaryQuery	Параметры запроса, используемые для векторного поиска, когда предоставляется векторный двоичный файл в кодировке base 64 изображения, который необходимо векторизировать.
VectorizableImageUrlQuery	Параметры запроса, используемые для векторного поиска, если указан URL-адрес, представляющий значение изображения, которое должно быть векторизировано.
VectorizableTextQuery	Параметры запроса, используемые для векторного поиска, если задано текстовое значение, которое необходимо векторизировать.
VectorizedQuery	Параметры запроса, используемые для поиска векторов при предоставлении необработанного векторного значения.
VectorQueryKind	Тип выполняемого векторного запроса.
VectorsDebugInfo	«Содержит отладочную информацию, специфичную для векторного и гибридного поиска.»)
VectorSimilarityThreshold	Результаты векторного запроса будут отфильтрованы на основе метрики сходства векторов. Обратите внимание, что это каноническое определение метрик сходства, а не "расстояние" версии. Направление порога (больше или меньше) будет выбрано автоматически в соответствии с метрикой, используемой полем.
VectorThresholdKind	Такой порог, который используется для фильтрации векторных запросов.

Accept

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

Заголовок Accept.

Значение	Описание
application/json;odata.metadata=none

DebugInfo

Объект

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

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

DocumentDebugInfo

Объект

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

Имя	Тип	Описание
innerHits	object	Содержит отладочную информацию, относящуюся к векторам, сопоставленным в коллекции сложных типов.
semantic	SemanticDebugInfo	Содержит отладочную информацию, относящуюся к запросам семантического ранжирования.
vectors	VectorsDebugInfo	Содержит сведения об отладке, относящиеся к вектору и гибридному поиску.

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

Подробности ошибки.

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

ErrorResponse

Объект

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

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

HybridCountAndFacetMode

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

Определяет, должны ли счетчики и фасеты включать все документы, соответствующие поисковому запросу, или только документы, полученные в окне maxTextRecallSize. Значение по умолчанию — countAllResults.

Значение	Описание
countRetrievableResults	Включайте только те документы, которые были сопоставлены в окне извлечения maxTextRecallSize при вычислении количества и фасетов.
countAllResults	Включайте все документы, которые были сопоставлены с поисковым запросом, при вычислении 'count' и 'facets', независимо от того, находятся ли эти документы в окне извлечения 'maxTextRecallSize'.

HybridSearch

Объект

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

Имя	Тип	Описание
countAndFacetMode	HybridCountAndFacetMode	Определяет, должны ли счетчики и фасеты включать все документы, соответствующие поисковому запросу, или только документы, полученные в окне maxTextRecallSize.
maxTextRecallSize	integer (int32)	Определяет максимальное количество документов, которые должны быть извлечены текстовой частью запроса гибридного поиска. Эти документы будут объединены с документами, соответствующими векторным запросам, чтобы получить единый окончательный список результатов. Выбор большего значения maxTextRecallSize позволит извлекать и просматривать больше документов (с использованием параметров top и skip) за счет более высокого использования ресурсов и большей задержки. Значение должно быть в диапазоне от 1 до 10 000. Значение по умолчанию — 1000.

QueryAnswerResult

Объект

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

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

QueryAnswerType

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

Этот параметр действителен только в том случае, если тип запроса равен semantic. Если задано, запрос возвращает ответы, извлеченные из ключевых фрагментов в документах с наивысшим рейтингом. Количество возвращаемых ответов можно настроить, добавив символ | вертикальной черты count-<number of answers> , за которым следует опция после значения параметра answers, например extractive|count-3, . По умолчанию счетчик — 1. Порог достоверности можно настроить, добавив символ | вертикальной черты, за которым следует threshold-<confidence threshold> опция после значения параметра answers, например extractive|threshold-0.9, . Порог по умолчанию равен 0,7. Максимальную длину символов ответов можно настроить, добавив символ вертикальной черты '|', за которым следует 'count-number< of maximum character length>', например 'extractive|maxcharlength-600'.

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

QueryCaptionResult

Объект

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

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

QueryCaptionType

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

Этот параметр действителен только в том случае, если тип запроса равен semantic. Если задано, запрос возвращает заголовки, извлеченные из ключевых проходов в документах с наивысшим рейтингом. Если для параметра Captions задано значение extractive, выделение включено по умолчанию, и его можно настроить, добавив символ | вертикальной черты, за которым следует параметр, highlight-<true/false> например extractive|highlight-true. По умолчанию — None. Максимальную длину символов заголовков можно настроить, добавив символ вертикальной черты '|', за которым следует 'count-number< of maximum character length>', например 'extractive|maxcharlength-600'.

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

QueryDebugMode

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

Включает средство отладки, которое можно использовать для дальнейшего изучения результатов поиска. Вы можете включить несколько режимов отладки одновременно, разделив их с помощью | , например: semantic|queryRewrites.

Значение	Описание
disabled	Сведения об отладке запросов не будут возвращены.
semantic	Позволяет пользователю более подробно изучить результаты повторного выполнения.
vector	Позволяет пользователю более подробно изучить результаты гибридных и векторных запросов.
queryRewrites	Позволяет пользователю просматривать список перезаписей запросов, созданных для запроса поиска.
innerHits	Позволяет пользователю получать информацию об оценке векторов, сопоставленных в коллекции сложных типов.
all	Включите все параметры отладки.

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	Запрос значения языка для корейского (Korea).
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	Запрос значения языка для болгарского (Bulgaria).
hr-hr	Запрос значения языка для хорватского языка (Хорватия).
hr-ba	Запрос значения языка для хорватского языка (Босния и Герцеговина).
ms-my	Запрос значения языка для малайского языка (Малайзия).
ms-bn	Запрос значения языка для малайского языка (Бруней-Даруссалам).
sl-sl	Значение языка запроса для словенского языка (Словения).
ta-in	Значение языка запроса для тамильского языка (Индия).
vi-vn	Запрос значения языка для вьетнамского языка (Вьетнам).
el-gr	Запрос значения языка для греческого языка (Греция).
ro-ro	Запрос значения языка для румынского (Romania).
is-is	Значение языка запроса для исландского языка (Iceland).
id-id	Значение языка запроса для индонезийского (Indonesia).
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	Запрос значения языка для гуджарати (Индия).
he-il	Запрос значения языка для иврита (Израиль).
ga-ie	Значение языка запроса для ирландского (Ирландия).
kn-in	Значение языка запроса для каннада (Индия).
ml-in	Значение языка запроса для малаялам (Индия).
mr-in	Значение языка запроса для маратхи (Индия).
fa-ae	Запрос значения языка для персидского языка (ОАЭ).
pa-in	Значение языка запроса для пенджаби (Индия).
te-in	Значение языка запроса для телугу (Индия).
ur-pk	Значение языка запроса для урду (Пакистан).

QueryResultDocumentRerankerInput

Объект

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

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

QueryResultDocumentSemanticField

Объект

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

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

QueryResultDocumentSubscores

Объект

Разбивка подкордер между компонентами текстовых и векторных запросов для этого документа. Каждый векторный запрос отображается как отдельный объект в том же порядке, что и они были получены.

Имя	Тип	Описание
documentBoost	number (double)	Оценка BM25 или Классическая оценка для текстовой части запроса.
text	TextResult	Оценка BM25 или Классическая оценка для текстовой части запроса.
vectors	<string, SingleVectorFieldResult>	Векторное сходство и

QueryRewritesDebugInfo

Объект

Содержит сведения об отладке, относящиеся к перезаписи запросов.

Имя	Тип	Описание
text	QueryRewritesValuesDebugInfo	Список переписанных запросов, созданных для текстового запроса.
vectors	QueryRewritesValuesDebugInfo[]	Список переписанных запросов, созданных для векторизуемых текстовых запросов.

QueryRewritesType

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

Этот параметр действителен только в том случае, если тип запроса равен semantic. Если для параметра QueryRewrite задано значение generative, условия запроса отправляются в созданную модель, которая выполнит 10 (по умолчанию) перезаписей, чтобы увеличить отзыв запроса. Запрашиваемое количество можно настроить, добавив символ | вертикальной черты, за которым следует count-<number of rewrites> опция, например generative|count-3. По умолчанию — None.

Значение	Описание
none	Не создавайте дополнительные перезаписи запроса для этого запроса.
generative	Создайте альтернативные термины запроса, чтобы увеличить отзыв поискового запроса.

QueryRewritesValuesDebugInfo

Объект

Содержит сведения об отладке, относящиеся к перезаписи запросов.

Имя	Тип	Описание
inputQuery	string	Входной текст для модели переписывания генеративного запроса. Могут быть случаи, когда пользовательский запрос и входные данные для генеративной модели не идентичны.
rewrites	string[]	Список переписываемых запросов.

QuerySpellerType

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

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

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

QueryType

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

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

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

ScoringStatistics

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

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

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

SearchDocumentsResult

Объект

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

Имя	Тип	Описание
@odata.count	integer (int64)	Общее количество результатов, найденных операцией поиска, или значение NULL, если число не было запрошено. При наличии число результатов в этом ответе может быть больше числа результатов. Это может произойти, если вы используете параметры $top или $skip, или если запрос не может вернуть все запрошенные документы в одном ответе.
@odata.nextLink	string	URL-адрес продолжения возвращается, когда запрос не может вернуть все запрошенные результаты в одном ответе. Вы можете использовать этот URL для формулирования другого поискового запроса GET или POST, чтобы получить следующую часть ответа на поиск. Убедитесь, что используется тот же глагол (GET или POST), что и в запросе, который вызвал этот ответ.
@search.answers	QueryAnswerResult[]	Результаты запроса ответов для операции поиска; Значение NULL, если параметр запроса ответов не указан или задан значение none.
@search.coverage	number (double)	Значение, указывающее процент индекса, который был включен в запрос, или значение NULL, если минимальное значениеCoverage не указано в запросе.
@search.debug	DebugInfo	Отладочная информация, которая применяется к результатам поиска в целом.
@search.facets	object	Результаты запроса аспектов для операции поиска, упорядоченные как коллекция контейнеров для каждого фасетного поля; Значение NULL, если запрос не включал никаких выражений аспектов.
@search.nextPageParameters	SearchRequest	Полезные данные продолжения JSON возвращаются, когда запрос не может вернуть все запрошенные результаты в одном ответе. Вы можете использовать этот JSON вместе с
@search.semanticPartialResponseReason	SemanticErrorReason	Причина, по которой был возвращен частичный ответ на запрос семантического ранжирования.
@search.semanticPartialResponseType	SemanticSearchResultsType	Тип частичного ответа, который был возвращен для запроса семантического ранжирования.
@search.semanticQueryRewritesResultType	SemanticQueryRewritesResultType	Тип перезаписи запроса, который использовался для извлечения документов.
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>.
hybridSearch	HybridSearch	Параметры запроса для настройки поведения гибридного поиска.
minimumCoverage	number (double)	Число от 0 до 100, указывающее процент индекса, который должен охватываться поисковым запросом, чтобы запрос сообщалось успешно. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одной репликой. Значение по умолчанию равно 100.
orderby	string	Разделенный запятыми список OData $orderby выражения, по которым сортируются результаты. Каждое выражение может быть именем поля или вызовом функций geo.distance() или search.score(). За каждым выражением можно следовать какc, чтобы указать возрастание, или desc, чтобы указать убывание. Значение по умолчанию — по возрастанию. Связи будут нарушены с помощью показателей соответствия документов. Если $orderby не указано, порядок сортировки по умолчанию убывает по оценке соответствия документа. Существует не более 32 предложений $orderby.
queryLanguage	QueryLanguage	Значение, указывающее язык поискового запроса.
queryRewrites	QueryRewritesType	Значение, указывающее, следует ли переписывать запрос для дополнения поискового запроса.
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[]: VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[] VectorizedQuery[]	Параметры запроса для векторных и гибридных поисковых запросов.

SearchResult

Объект

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

Имя	Тип	Описание
@search.captions	QueryCaptionResult[]	Заголовки являются наиболее репрезентативными фрагментами документа относительно поискового запроса. Они часто используются в качестве сводки документов. Подписи возвращаются только для запросов типа 'semantic'.
@search.documentDebugInfo	DocumentDebugInfo	Содержит сведения об отладке, которые можно использовать для дальнейшего изучения результатов поиска.
@search.highlights	object	Текстовые фрагменты из документа, указывающие на соответствующие условия поиска, организованные по каждому применимому полю; null, если для запроса не было включено выделение хитов.
@search.rerankerBoostedScore	number (double)	Оценка релевантности, рассчитанная путем повышения Reranker Score. Результаты поиска сортируются по RerankerScore/RerankerBoostedScore на основе useScoringProfileBoostedRanking в Семантической конфигурации. RerankerBoostedScore возвращается только для запросов типа «семантическая».
@search.rerankerScore	number (double)	Оценка релевантности, рассчитанная семантическим ранжированием для первых результатов поиска. Результаты поиска сначала сортируются по RerankerScore, а затем по Score. RerankerScore возвращается только для запросов типа 'semantic'.
@search.score	number (double)	Оценка релевантности документа по сравнению с другими документами, возвращенными запросом.

SearchScoreThreshold

Объект

Результаты векторного запроса будут фильтрованы на основе '

Имя	Тип	Описание
kind	string: searchScore	Тип порога.
value	number (double)	Порог будет фильтровать на основе '

SemanticDebugInfo

Объект

Содержит отладочную информацию, относящуюся к запросам семантического ранжирования.

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

SemanticErrorMode

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

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

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

SemanticErrorReason

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

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

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

SemanticFieldState

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

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

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

SemanticQueryRewritesResultType

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

Тип переписывания запроса, который был использован для этого запроса.

Значение	Описание
originalQueryOnly	Для этого запроса не удалось успешно переписать запрос. Для получения результатов использовался только исходный запрос.

SemanticSearchResultsType

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

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

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

SingleVectorFieldResult

Объект

Результат одного векторного поля. Both

Имя	Тип	Описание
searchScore	number (double)	Компонент
vectorSimilarity	number (double)	Оценка векторного сходства для этого документа. Обратите внимание, что это каноническое определение метрик сходства, а не "расстояние" версии. Например, косинусное сходство вместо косинусного расстояния.

TextResult

Объект

Оценка BM25 или Классическая оценка для текстовой части запроса.

Имя	Тип	Описание
searchScore	number (double)	Оценка BM25 или Классическая оценка для текстовой части запроса.

VectorFilterMode

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

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

Значение	Описание
postFilter	Фильтр будет применен после возврата набора кандидатов результатов вектора. В зависимости от избирательности фильтра это может привести к меньшему значению результатов, чем запрашивается параметром k.
preFilter	Фильтр будет применен перед поисковым запросом.
strictPostFilter	Фильтр будет применен после того, как будет возвращен глобальный набор векторных результатов top-k candidates. Это приведет к меньшему количеству результатов, чем запрашивает параметр 'k'.

VectorizableImageBinaryQuery

Объект

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

Имя	Тип	Описание
base64Image	string	Двоичный файл с основанием 64 изображения, который должен быть векторизован для выполнения векторного поискового запроса.
exhaustive	boolean	Если значение true, активирует исчерпывающий поиск ближайших к соседей по всем векторам в индексе векторов. Полезно для сценариев, когда точные совпадения являются критически важными, например определение значений истины на земле.
fields	string	Векторные поля коллекции типов (Edm.Single), которые должны быть включены в векторный поиск.
filterOverride	string	Выражение фильтра OData, применяемое к этому конкретному вектору запроса. Если выражение фильтра не определено на уровне вектора, вместо этого используется выражение, определенное в параметре фильтра верхнего уровня.
k	integer (int32)	Число ближайших соседей, возвращаемых в качестве лучших хитов.
kind	string: imageBinary	Тип запроса.
oversampling	number (double)	Превышение коэффициента. Минимальное значение — 1. Он переопределяет параметр defaultOversampling, настроенный в определении индекса. Его можно задать только в том случае, если параметр rerankWithOriginalVectors имеет значение true. Этот параметр допускается только в том случае, если метод сжатия используется в базовом поле вектора.
perDocumentVectorLimit	integer (int32)	Определяет, сколько векторов может быть сопоставлено из каждого документа в запросе векторного поиска. Установка значения 1 гарантирует, что будет сопоставлен не более одного вектора для каждого документа, что гарантирует получение результатов из разных документов. Установка значения 0 (неограниченно) позволяет сопоставлять несколько релевантных векторов из одного документа. Значение по умолчанию — 0.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Пороговое значение, используемое для векторных запросов. Обратите внимание, что это можно задать только в том случае, если все поля используют одну и ту же метрику сходства.
weight	number (float)	Относительный вес векторного запроса при сравнении с другими векторными запросами и/или текстовым запросом в том же запросе поиска. Это значение используется при объединении результатов нескольких списков ранжирования, созданных различными векторными запросами и (или) результатов, полученных с помощью текстового запроса. Чем выше вес, тем выше документы, соответствующие запросу, будут находиться в окончательном рейтинге. Значение по умолчанию равно 1.0, а значение должно быть положительным числом, превышающим нулю.

VectorizableImageUrlQuery

Объект

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

Имя	Тип	Описание
exhaustive	boolean	Если значение true, активирует исчерпывающий поиск ближайших к соседей по всем векторам в индексе векторов. Полезно для сценариев, когда точные совпадения являются критически важными, например определение значений истины на земле.
fields	string	Векторные поля коллекции типов (Edm.Single), которые должны быть включены в векторный поиск.
filterOverride	string	Выражение фильтра OData, применяемое к этому конкретному вектору запроса. Если выражение фильтра не определено на уровне вектора, вместо этого используется выражение, определенное в параметре фильтра верхнего уровня.
k	integer (int32)	Число ближайших соседей, возвращаемых в качестве лучших хитов.
kind	string: imageUrl	Тип запроса.
oversampling	number (double)	Превышение коэффициента. Минимальное значение — 1. Он переопределяет параметр defaultOversampling, настроенный в определении индекса. Его можно задать только в том случае, если параметр rerankWithOriginalVectors имеет значение true. Этот параметр допускается только в том случае, если метод сжатия используется в базовом поле вектора.
perDocumentVectorLimit	integer (int32)	Определяет, сколько векторов может быть сопоставлено из каждого документа в запросе векторного поиска. Установка значения 1 гарантирует, что будет сопоставлен не более одного вектора для каждого документа, что гарантирует получение результатов из разных документов. Установка значения 0 (неограниченно) позволяет сопоставлять несколько релевантных векторов из одного документа. Значение по умолчанию — 0.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Пороговое значение, используемое для векторных запросов. Обратите внимание, что это можно задать только в том случае, если все поля используют одну и ту же метрику сходства.
url	string	URL-адрес изображения, которое должно быть векторизовано для выполнения векторного поискового запроса.
weight	number (float)	Относительный вес векторного запроса при сравнении с другими векторными запросами и/или текстовым запросом в том же запросе поиска. Это значение используется при объединении результатов нескольких списков ранжирования, созданных различными векторными запросами и (или) результатов, полученных с помощью текстового запроса. Чем выше вес, тем выше документы, соответствующие запросу, будут находиться в окончательном рейтинге. Значение по умолчанию равно 1.0, а значение должно быть положительным числом, превышающим нулю.

VectorizableTextQuery

Объект

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

Имя	Тип	Описание
exhaustive	boolean	Если значение true, активирует исчерпывающий поиск ближайших к соседей по всем векторам в индексе векторов. Полезно для сценариев, когда точные совпадения являются критически важными, например определение значений истины на земле.
fields	string	Векторные поля коллекции типов (Edm.Single), которые должны быть включены в векторный поиск.
filterOverride	string	Выражение фильтра OData, применяемое к этому конкретному вектору запроса. Если выражение фильтра не определено на уровне вектора, вместо этого используется выражение, определенное в параметре фильтра верхнего уровня.
k	integer (int32)	Число ближайших соседей, возвращаемых в качестве лучших хитов.
kind	string: text	Тип запроса.
oversampling	number (double)	Превышение коэффициента. Минимальное значение — 1. Он переопределяет параметр defaultOversampling, настроенный в определении индекса. Его можно задать только в том случае, если параметр rerankWithOriginalVectors имеет значение true. Этот параметр допускается только в том случае, если метод сжатия используется в базовом поле вектора.
perDocumentVectorLimit	integer (int32)	Определяет, сколько векторов может быть сопоставлено из каждого документа в запросе векторного поиска. Установка значения 1 гарантирует, что будет сопоставлен не более одного вектора для каждого документа, что гарантирует получение результатов из разных документов. Установка значения 0 (неограниченно) позволяет сопоставлять несколько релевантных векторов из одного документа. Значение по умолчанию — 0.
queryRewrites	QueryRewritesType	Можно настроить настройку, чтобы разрешить генерирующей модели переписать запрос перед отправкой его векторизации.
text	string	Векторный текст для выполнения запроса векторного поиска.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Пороговое значение, используемое для векторных запросов. Обратите внимание, что это можно задать только в том случае, если все поля используют одну и ту же метрику сходства.
weight	number (float)	Относительный вес векторного запроса при сравнении с другими векторными запросами и/или текстовым запросом в том же запросе поиска. Это значение используется при объединении результатов нескольких списков ранжирования, созданных различными векторными запросами и (или) результатов, полученных с помощью текстового запроса. Чем выше вес, тем выше документы, соответствующие запросу, будут находиться в окончательном рейтинге. Значение по умолчанию равно 1.0, а значение должно быть положительным числом, превышающим нулю.

VectorizedQuery

Объект

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

Имя	Тип	Описание
exhaustive	boolean	Если значение true, активирует исчерпывающий поиск ближайших к соседей по всем векторам в индексе векторов. Полезно для сценариев, когда точные совпадения являются критически важными, например определение значений истины на земле.
fields	string	Векторные поля коллекции типов (Edm.Single), которые должны быть включены в векторный поиск.
filterOverride	string	Выражение фильтра OData, применяемое к этому конкретному вектору запроса. Если выражение фильтра не определено на уровне вектора, вместо этого используется выражение, определенное в параметре фильтра верхнего уровня.
k	integer (int32)	Число ближайших соседей, возвращаемых в качестве лучших хитов.
kind	string: vector	Тип запроса.
oversampling	number (double)	Превышение коэффициента. Минимальное значение — 1. Он переопределяет параметр defaultOversampling, настроенный в определении индекса. Его можно задать только в том случае, если параметр rerankWithOriginalVectors имеет значение true. Этот параметр допускается только в том случае, если метод сжатия используется в базовом поле вектора.
perDocumentVectorLimit	integer (int32)	Определяет, сколько векторов может быть сопоставлено из каждого документа в запросе векторного поиска. Установка значения 1 гарантирует, что будет сопоставлен не более одного вектора для каждого документа, что гарантирует получение результатов из разных документов. Установка значения 0 (неограниченно) позволяет сопоставлять несколько релевантных векторов из одного документа. Значение по умолчанию — 0.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Пороговое значение, используемое для векторных запросов. Обратите внимание, что это можно задать только в том случае, если все поля используют одну и ту же метрику сходства.
vector	number[] (float)	Векторное представление поискового запроса.
weight	number (float)	Относительный вес векторного запроса при сравнении с другими векторными запросами и/или текстовым запросом в том же запросе поиска. Это значение используется при объединении результатов нескольких списков ранжирования, созданных различными векторными запросами и (или) результатов, полученных с помощью текстового запроса. Чем выше вес, тем выше документы, соответствующие запросу, будут находиться в окончательном рейтинге. Значение по умолчанию равно 1.0, а значение должно быть положительным числом, превышающим нулю.

VectorQueryKind

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

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

Значение	Описание
vector	Векторный запрос, в котором предоставляется необработанное векторное значение.
text	Векторный запрос, в котором предоставляется текстовое значение, необходимое для векторизации.
imageUrl	Векторный запрос, в котором предоставляется URL-адрес, представляющий значение изображения, которое необходимо векторизовать.
imageBinary	Векторный запрос, в котором предоставляется двоичный файл в кодировке по основанию 64 изображения, которое необходимо векторизовать.

VectorsDebugInfo

Объект

«Содержит отладочную информацию, специфичную для векторного и гибридного поиска.»)

Имя	Тип	Описание
subscores	QueryResultDocumentSubscores	Разбивка промежуточных оценок документа перед выбранным методом слияния/комбинирования наборов результатов, таким как RRF.

VectorSimilarityThreshold

Объект

Результаты векторного запроса будут отфильтрованы на основе метрики сходства векторов. Обратите внимание, что это каноническое определение метрик сходства, а не "расстояние" версии. Направление порога (больше или меньше) будет выбрано автоматически в соответствии с метрикой, используемой полем.

Имя	Тип	Описание
kind	string: vectorSimilarity	Тип порога.
value	number (double)	Пороговое значение будет отфильтровано на основе значения метрики сходства. Обратите внимание, что это каноническое определение метрик сходства, а не "расстояние" версии. Направление порога (больше или меньше) будет выбрано автоматически в соответствии с метрикой, используемой полем.

VectorThresholdKind

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

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

Значение

Описание

vectorSimilarity

searchScore

Результаты векторного запроса будут фильтроваться по значению @search.score. Обратите внимание, что это @search.score, возвращенный в ответе на поиск. Направление порога будет выбрано для более высокого @search.score.