Documents - Search Get

Служба:: Search Service

Версия API:: 2025-08-01-preview

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

GET {endpoint}/indexes('{indexName}')/docs?api-version=2025-08-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}&searchFields={searchFields}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&api-version=2025-08-01-preview&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	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. Максимальную длину символов ответов можно настроить, добавив символ вертикальной черты '\|', за которым следует '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[]	Список фасетных выражений, которые должны быть применены к поисковому запросу. Каждое фасетное выражение содержит имя поля, за которым может следовать разделенный запятыми список пар имя:значение.
highlight	query		string[]	Список имен полей, используемых для выделения хитов. Для выделения попаданий можно использовать только поля, доступные для поиска.
highlightPostTag	query		string	Тег строки, который добавляется к выделениям попадания. Должен быть установлен с помощью highlightPreTag. По умолчанию используется / <em>.
highlightPreTag	query		string	Тег 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 может нарушить балансировку нагрузки запросов между репликами и отрицательно сказаться на производительности службы поиска. Значение, используемое в качестве sessionId, не может начинаться с символа "_".
speller	query		QuerySpellerType	Улучшите запоминаемость поисковых запросов за счет исправления орфографии отдельных поисковых запросов.

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

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

Ответы

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

Примеры

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

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&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2025-08-01-preview&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?search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&api-version=2025-08-01-preview&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"
      ]
    }
  ]
}

Определения

Имя	Описание
AnswerResult	Ответ — это фрагмент текста, извлеченный из содержимого наиболее релевантных документов, соответствующих запросу. Ответы извлекаются из верхних результатов поиска. Кандидаты на ответы оцениваются, и отбираются лучшие ответы.
CaptionResult	Подписи – это наиболее репрезентативные отрывки из документа относительно поискового запроса. Они часто используются в качестве резюме документа. Подписи возвращаются только для запросов типа `semantic`.
DebugInfo	Содержит отладочную информацию, которую можно использовать для дальнейшего изучения результатов поиска.
DocumentDebugInfo	Содержит отладочную информацию, которую можно использовать для дальнейшего изучения результатов поиска.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
HybridCountAndFacetMode	Определяет, должны ли счетчики и фасеты включать все документы, соответствующие поисковому запросу, или только документы, полученные в окне maxTextRecallSize. Значение по умолчанию — countAllResults.
HybridSearch	Параметры запроса для настройки поведения гибридного поиска.
QueryAnswerType	Значение, указывающее, должны ли ответы возвращаться в рамках ответа на поисковый запрос.
QueryCaptionType	Значение, указывающее, должны ли заголовки возвращаться как часть ответа на поисковый запрос.
QueryDebugMode	Включает средство отладки, которое можно использовать для дальнейшего изучения результатов поиска. Вы можете включить несколько режимов отладки одновременно, разделив их с помощью \| , например: semantic\|queryRewrites.
QueryLanguage	Язык запроса.
QueryResultDocumentRerankerInput	Необработанные объединенные строки, которые были отправлены в процесс семантического обогащения.
QueryResultDocumentSemanticField	Описание полей, которые были отправлены в процесс семантического обогащения, а также как они были использованы
QueryResultDocumentSubscores	Разбивка промежуточных оценок между текстовым и векторным компонентами поискового запроса для данного документа. Каждый векторный запрос отображается как отдельный объект в том же порядке, в котором они были получены.
QueryRewritesDebugInfo	Содержит отладочную информацию, относящуюся к переписыванию запросов.
QueryRewritesType	Значение, указывающее, следует ли переписывать запрос для дополнения поискового запроса.
QueryRewritesValuesDebugInfo	Содержит отладочную информацию, относящуюся к переписыванию запросов.
QuerySpellerType	Значение, указывающее тип средства проверки орфографии, используемого для исправления отдельных условий поискового запроса.
QueryType	Указывает синтаксис поискового запроса. Значение по умолчанию — 'simple'. Используйте 'full', если в вашем запросе используется синтаксис запроса Lucene, и 'semantic', если синтаксис запроса не нужен.
RawVectorQuery	Параметры запроса, используемые для векторного поиска, когда предоставлено необработанное векторное значение.
ScoringStatistics	Значение, указывающее, хотим ли мы вычислять статистику оценки (например, частоту выпуска документов) глобально для более стабильной оценки или локально для более низкой задержки. Значение по умолчанию — 'local'. Используйте 'global' для агрегирования статистики подсчета очков глобально перед подсчетом очков. Использование глобальной статистики скоринга может увеличить задержку поисковых запросов.
SearchDocumentsResult	Ответ, содержащий результаты поиска из индекса.
SearchMode	Указывает, должны ли быть сопоставлены некоторые или все условия поиска, чтобы документ считался совпадающим.
SearchRequest	Параметры для фильтрации, сортировки, фасетизации, разбиения на страницы и других действий поисковых запросов.
SearchResult	Содержит документ, найденный по поисковому запросу, а также связанные с ним метаданные.
SearchScoreThreshold	Результаты векторного запроса будут отфильтрованы по значению '@search.score'. Обратите внимание, что это @search.score возвращаемое средство в ответе на поиск. Пороговое направление будет выбрано для более высокого @search.score.
SemanticDebugInfo
SemanticErrorMode	Позволяет пользователю выбрать, должен ли семантический вызов завершиться полным сбоем (поведение по умолчанию / текущее) или возвращать частичные результаты.
SemanticErrorReason	Причина, по которой был возвращен частичный ответ на запрос семантического ранжирования.
SemanticFieldState	Способ использования поля для процесса семантического обогащения (полностью использовано, частично использовано или не использовано)
SemanticQueryRewritesResultType	Тип переписывания запроса, который был использован для этого запроса.
SemanticSearchResultsType	Тип частичного ответа, который был возвращен для запроса семантического ранжирования.
SingleVectorFieldResult	Результат с одним векторным полем. Возвращаются оба @search.score значения сходства векторов. Векторное подобие связано с @search.score уравнением.
TextResult	Оценка BM25 или Classic для текстовой части запроса.
VectorFilterMode	Определяет, применяются ли фильтры до или после выполнения векторного поиска.
VectorizableImageBinaryQuery	Параметры запроса, используемые для векторного поиска, когда предоставлен двоичный файл в кодировке по основанию 64 изображения, которое необходимо векторизовать.
VectorizableImageUrlQuery	Параметры запроса, используемые для векторного поиска, когда предоставлен URL-адрес, представляющий значение изображения, которое необходимо векторизовать.
VectorizableTextQuery	Параметры запроса, используемые для векторного поиска, когда предоставлено текстовое значение, которое необходимо векторизовать.
VectorQueryKind	Тип выполняемого векторного запроса.
VectorsDebugInfo
VectorSimilarityThreshold	Результаты векторного запроса будут отфильтрованы на основе метрики векторного сходства. Обратите внимание, что это каноническое определение метрики сходства, а не версия «расстояния». Пороговое направление (большее или меньшее) будет выбрано автоматически в соответствии с метрикой, используемой полем.
VectorThresholdKind	Тип выполняемого векторного запроса.

AnswerResult

Объект

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

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

CaptionResult

Объект

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

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

DebugInfo

Объект

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

Имя	Тип	Описание
queryRewrites	QueryRewritesDebugInfo	Содержит отладочную информацию, относящуюся к переписыванию запросов.

DocumentDebugInfo

Объект

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

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

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

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

Имя	Тип	Описание
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.

QueryAnswerType

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

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

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

QueryCaptionType

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

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

Значение	Описание
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 или Classic для текстовой части запроса.
text	TextResult	Оценка BM25 или Classic для текстовой части запроса.
vectors	<string, SingleVectorFieldResult>	Сходство вектора и @search.score значения для каждого векторного запроса.

QueryRewritesDebugInfo

Объект

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

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

QueryRewritesType

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

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

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

QueryRewritesValuesDebugInfo

Объект

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

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

QuerySpellerType

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

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

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

QueryType

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

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

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

RawVectorQuery

Объект

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

Имя	Тип	Описание
exhaustive	boolean	При значении true инициируется исчерпывающий поиск k-ближайшего соседа по всем векторам в пределах векторного индекса. Полезно для сценариев, в которых точное совпадение имеет решающее значение, например для определения наземных значений достоверной достоверности.
fields	string	Векторные поля типа Collection(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, и значение должно быть положительным числом больше нуля.

ScoringStatistics

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

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

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

SearchDocumentsResult

Объект

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

Имя	Тип	Описание
@odata.count	integer (int64)	Общее количество результатов, найденных операцией поиска, или NULL, если счетчик не был запрошен. Если оно присутствует, количество может быть больше, чем количество результатов в этом ответе. Это может произойти, если вы используете параметры $top или $skip, или если запрос не может вернуть все запрошенные документы в одном ответе.
@odata.nextLink	string	URL-адрес продолжения возвращается, когда запрос не может вернуть все запрошенные результаты в одном ответе. Вы можете использовать этот URL для формулирования другого поискового запроса GET или POST, чтобы получить следующую часть ответа на поиск. Убедитесь, что используется тот же глагол (GET или POST), что и в запросе, который вызвал этот ответ.
@search.answers	AnswerResult[]	Ответы запрашивают результаты операции поиска; null, если параметр запроса ответов не был указан или установлен в значение "None".
@search.coverage	number (double)	Значение, указывающее процент от индекса, который был включен в запрос, или null, если minimumCoverage не был указан в запросе.
@search.debug	DebugInfo	Отладка информации, которая относится к результатам поиска в целом.
@search.facets	object	Результаты фасетного запроса для операции поиска, организованные в виде коллекции контейнеров для каждого фасетного поля; null, если запрос не содержал выражений фасетов.
@search.nextPageParameters	SearchRequest	Полезные данные продолжения JSON возвращаются, когда запрос не может вернуть все запрошенные результаты в одном ответе. Вы можете использовать этот JSON вместе с @odata.nextLink ним для формулирования другого запроса поиска POST, чтобы получить следующую часть ответа на поиск.
@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[]	Список фасетных выражений, которые должны быть применены к поисковому запросу. Каждое фасетное выражение содержит имя поля, за которым может следовать разделенный запятыми список пар имя:значение.
filter	string	Выражение OData $filter для применения к поисковому запросу.
highlight	string	Разделенный запятыми список имен полей, которые будут использоваться для выделения совпадений. Для выделения попаданий можно использовать только поля, доступные для поиска.
highlightPostTag	string	Тег строки, который добавляется к выделениям попадания. Должен быть установлен с помощью highlightPreTag. По умолчанию используется / <em>.
highlightPreTag	string	Тег string, который добавляется в начало для выделения попадания. Должен быть установлен с помощью highlightPostTag. По умолчанию используется em<>.
hybridSearch	HybridSearch	Параметры запроса для настройки поведения гибридного поиска.
minimumCoverage	number (double)	Число от 0 до 100, указывающее процент индекса, который должен быть покрыт поисковым запросом, чтобы запрос был отмечен как успешный. Этот параметр может быть полезен для обеспечения доступности поиска даже для сервисов с одной репликой. Значение по умолчанию равно 100.
orderby	string	Разделенный запятыми список OData $orderby выражения, по которым сортируются результаты. Каждое выражение может быть либо именем поля, либо вызовом функций geo.distance() или search.score(). За каждым выражением может следовать asc для обозначения возрастания, или 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 может нарушить балансировку нагрузки запросов между репликами и отрицательно сказаться на производительности службы поиска. Значение, используемое в качестве sessionId, не может начинаться с символа "_".
skip	integer (int32)	Количество результатов поиска, которые необходимо пропустить. Это значение не может быть больше 100 000. Если вам нужно сканировать документы последовательно, но вы не можете использовать пропуск из-за этого ограничения, рассмотрите возможность использования orderby для полностью упорядоченного ключа и фильтрации с помощью запроса диапазона.
speller	QuerySpellerType	Значение, указывающее тип средства проверки орфографии, используемого для исправления отдельных условий поискового запроса.
top	integer (int32)	Количество результатов поиска для получения. Это можно использовать в сочетании с $skip для реализации разбиения результатов поиска на клиентскую сторону. Если результаты усекаются из-за разбиения на страницы на стороне сервера, ответ будет содержать маркер продолжения, который можно использовать для отправки еще одного запроса поиска для следующей страницы результатов.
vectorFilterMode	VectorFilterMode	Определяет, применяются ли фильтры до или после выполнения векторного поиска. По умолчанию для новых индексов используется 'preFilter'.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[]	Параметры запроса для векторных и гибридных поисковых запросов.

SearchResult

Объект

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

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

SearchScoreThreshold

Объект

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

Имя	Тип	Описание
kind	string: searchScore	Тип порогового значения, используемого для фильтрации векторных запросов
value	number (double)	Пороговое значение будет отфильтровано на основе значения '@search.score'. Обратите внимание, что это @search.score возвращаемое средство в ответе на поиск. Пороговое направление будет выбрано для более высокого @search.score.

SemanticDebugInfo

Объект

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

SemanticErrorMode

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

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

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

SemanticErrorReason

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

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

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

SemanticFieldState

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

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

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

SemanticQueryRewritesResultType

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

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

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

SemanticSearchResultsType

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

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

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

SingleVectorFieldResult

Объект

Результат с одним векторным полем. Возвращаются оба @search.score значения сходства векторов. Векторное подобие связано с @search.score уравнением.

Имя	Тип	Описание
searchScore	number (double)	Значение @search.score , которое вычисляется на основе оценки векторного сходства. Это оценка, которая отображается в чисто однополевом одновекторном запросе.
vectorSimilarity	number (double)	Оценка векторного сходства для этого документа. Обратите внимание, что это каноническое определение метрики сходства, а не версия «расстояния». Например, косинусное сходство вместо косинусного расстояния.

TextResult

Объект

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

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

VectorFilterMode

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

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

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

VectorizableImageBinaryQuery

Объект

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

Имя	Тип	Описание
base64Image	string	Двоичный файл с основанием 64 изображения, который должен быть векторизован для выполнения векторного поискового запроса.
exhaustive	boolean	При значении true инициируется исчерпывающий поиск k-ближайшего соседа по всем векторам в пределах векторного индекса. Полезно для сценариев, в которых точное совпадение имеет решающее значение, например для определения наземных значений достоверной достоверности.
fields	string	Векторные поля типа Collection(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 инициируется исчерпывающий поиск k-ближайшего соседа по всем векторам в пределах векторного индекса. Полезно для сценариев, в которых точное совпадение имеет решающее значение, например для определения наземных значений достоверной достоверности.
fields	string	Векторные поля типа Collection(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 инициируется исчерпывающий поиск k-ближайшего соседа по всем векторам в пределах векторного индекса. Полезно для сценариев, в которых точное совпадение имеет решающее значение, например для определения наземных значений достоверной достоверности.
fields	string	Векторные поля типа Collection(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, и значение должно быть положительным числом больше нуля.

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.

Значение

Описание

vectorSimilarity

searchScore