Documents - Search Get

Ссылка

Служба:: Search Service

Версия API:: 2024-11-01-preview

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

GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-11-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=2024-11-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>` после значения параметра ответа, например `extractive\|count-3`. Число по умолчанию — 1. Порог достоверности можно настроить, добавив символ канала `\|threshold-<confidence threshold>` после значения параметра ответа, например `extractive\|threshold-0.9`. Пороговое значение по умолчанию — 0,7. Максимальная длина ответов может быть настроена путем добавления символа канала "\|", за которым следует "count-", например "extractive\|maxcharlength-600".
captions	query		QueryCaptionType	Этот параметр действителен только в том случае, если тип запроса `semantic`. Если задано, запрос возвращает заголовки, извлеченные из ключевых проходов в документах с наивысшим рейтингом. Если заголовок имеет значение `extractive`, выделение включено по умолчанию и может быть настроено путем добавления символа канала `\|` после параметра `highlight-<true/false>`, например `extractive\|highlight-true`. По умолчанию используется `None`. Максимальная длина подписей может быть настроена путем добавления символа канала "\|", за которым следует "count-", например "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	Если параметр QueryRewrites имеет значение `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	Позволяет пользователю задать верхнюю границу на время, которое требуется для завершения обработки семантического обогащения до сбоя запроса.
semanticQuery	query		string	Позволяет задать отдельный поисковый запрос, который будет использоваться исключительно для семантического повторения, семантических подписей и семантических ответов. Полезно для сценариев, когда требуется использовать различные запросы между базовым этапом извлечения и ранжирования, а также семантической фазой L2.
sessionId	query		string	Значение, используемое для создания липкого сеанса, которое может помочь получить более согласованные результаты. До тех пор, пока используется тот же идентификатор сеанса, будет предпринята попытка попытаться выбрать тот же набор реплик. Будьте осторожны, что повторное использование одних и того же значения sessionID многократно может повлиять на балансировку нагрузки запросов между репликами и негативно повлиять на производительность службы поиска. Значение, используемое в качестве sessionId, не может начинаться с символа "_".
speller	query		QuerySpellerType	Улучшение отзыва поиска путем исправления отдельных терминов запроса поиска.

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

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

Ответы

Имя	Тип	Описание
200 OK	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=2024-11-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"
    }
  ]
}

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=2024-11-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"
      ]
    }
  ]
}

Определения

Имя	Описание
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 и "семантику", если синтаксис запроса не нужен.
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 или Классическая оценка для текстовой части запроса.
VectorFilterMode	Определяет, применяются ли фильтры до или после выполнения векторного поиска.
VectorizableImageBinaryQuery	Параметры запроса, используемые для векторного поиска, когда предоставляется векторный двоичный файл в кодировке base 64 изображения, который необходимо векторизировать.
VectorizableImageUrlQuery	Параметры запроса, используемые для векторного поиска, если указан URL-адрес, представляющий значение изображения, которое должно быть векторизировано.
VectorizableTextQuery	Параметры запроса, используемые для векторного поиска, если задано текстовое значение, которое необходимо векторизировать.
VectorQueryKind	Тип выполняемого векторного запроса.
VectorsDebugInfo
VectorSimilarityThreshold	Результаты векторного запроса будут отфильтрованы на основе метрики сходства векторов. Обратите внимание, что это каноническое определение метрик сходства, а не "расстояние" версии. Направление порога (больше или меньше) будет выбрано автоматически в соответствии с метрикой, используемой полем.
VectorThresholdKind	Тип выполняемого векторного запроса.

AnswerResult

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

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

CaptionResult

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

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

DebugInfo

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

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

DocumentDebugInfo

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

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

Имя	Тип	Описание
countAllResults	string	Включите все документы, которые были сопоставлены поисковым запросом при вычислении счетчиков и аспектов, независимо от того, находятся ли эти документы в окне извлечения maxTextRecallSize.
countRetrievableResults	string	Включают только документы, которые были сопоставлены в окне извлечения maxTextRecallSize при вычислении "count" и "аспекты".

HybridSearch

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

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

QueryAnswerType

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

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

QueryCaptionType

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

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

QueryDebugMode

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

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

QueryLanguage

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

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

QueryResultDocumentRerankerInput

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

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

QueryResultDocumentSemanticField

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

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

QueryResultDocumentSubscores

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

Имя	Тип	Описание
documentBoost	number	Оценка BM25 или Классическая оценка для текстовой части запроса.
text	TextResult	Оценка BM25 или Классическая оценка для текстовой части запроса.
vectors	<string, SingleVectorFieldResult>	Сходство векторов и @search.score значения для каждого векторного запроса.

QueryRewritesDebugInfo

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

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

QueryRewritesType

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

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

QueryRewritesValuesDebugInfo

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

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

QuerySpellerType

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

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

QueryType

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

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

RawVectorQuery

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

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

ScoringStatistics

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

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

SearchDocumentsResult

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

Имя	Тип	Описание
@odata.count	integer	Общее количество результатов, найденных операцией поиска, или значение NULL, если число не было запрошено. При наличии число результатов в этом ответе может быть больше числа результатов. Это может произойти, если вы используете параметры $top или $skip или если запрос не может возвращать все запрошенные документы в одном ответе.
@odata.nextLink	string	URL-адрес продолжения, возвращаемый, когда запрос не может возвращать все запрошенные результаты в одном ответе. Этот URL-адрес можно использовать для формирования другого запроса GET или POST Search, чтобы получить следующую часть ответа на поиск. Обязательно используйте ту же команду (GET или POST), что и запрос, создающий этот ответ.
@search.answers	AnswerResult[]	Результаты запроса ответов для операции поиска; Значение NULL, если параметр запроса ответов не указан или задан значение none.
@search.coverage	number	Значение, указывающее процент индекса, который был включен в запрос, или значение NULL, если минимальное значениеCoverage не указано в запросе.
@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

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

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

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	Число от 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	Позволяет пользователю задать верхнюю границу на время, которое требуется для завершения обработки семантического обогащения до сбоя запроса.
semanticQuery	string	Позволяет задать отдельный поисковый запрос, который будет использоваться исключительно для семантического повторения, семантических подписей и семантических ответов. Полезно для сценариев, когда требуется использовать различные запросы между базовым этапом извлечения и ранжирования, а также семантической фазой L2.
sessionId	string	Значение, используемое для создания липкого сеанса, которое может помочь получить более согласованные результаты. До тех пор, пока используется тот же идентификатор сеанса, будет предпринята попытка попытаться выбрать тот же набор реплик. Будьте осторожны, что повторное использование одних и того же значения sessionID многократно может повлиять на балансировку нагрузки запросов между репликами и негативно повлиять на производительность службы поиска. Значение, используемое в качестве sessionId, не может начинаться с символа "_".
skip	integer	Количество пропущенных результатов поиска. Это значение не может быть больше 100 000. Если вам нужно сканировать документы в последовательности, но не удается пропустить из-за этого ограничения, рекомендуется использовать orderby на полностью упорядоченном ключе и фильтровать с помощью запроса диапазона.
speller	QuerySpellerType	Значение, указывающее тип орфографии, используемый для исправления отдельных условий запроса поиска.
top	integer	Количество полученных результатов поиска. Это можно использовать в сочетании с $skip для реализации разбиения по страницам на стороне клиента результатов поиска. Если результаты усечены из-за разбиения на страницы на стороне сервера, ответ будет содержать маркер продолжения, который можно использовать для выдачи другого запроса поиска на следующую страницу результатов.
vectorFilterMode	VectorFilterMode	Определяет, применяются ли фильтры до или после выполнения векторного поиска. Значение по умолчанию — preFilter для новых индексов.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[]	Параметры запроса для векторных и гибридных поисковых запросов.

SearchResult

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

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

SearchScoreThreshold

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

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

SemanticDebugInfo

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

SemanticErrorMode

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

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

SemanticErrorReason

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

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

SemanticFieldState

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

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

SemanticQueryRewritesResultType

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

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

SemanticSearchResultsType

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

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

SingleVectorFieldResult

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

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

TextResult

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

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

VectorFilterMode

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

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

VectorizableImageBinaryQuery

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

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

VectorizableImageUrlQuery

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

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

VectorizableTextQuery

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

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

VectorQueryKind

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

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

VectorsDebugInfo

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

VectorSimilarityThreshold

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

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

VectorThresholdKind

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

Имя	Тип	Описание
searchScore	string	Результаты векторного запроса будут фильтроваться по значению @search.score. Обратите внимание, что это @search.score, возвращенный в ответе на поиск. Направление порога будет выбрано для более высокого @search.score.
vectorSimilarity	string	Результаты векторного запроса будут отфильтрованы на основе метрики сходства векторов. Обратите внимание, что это каноническое определение метрик сходства, а не "расстояние" версии. Направление порога (больше или меньше) будет выбрано автоматически в соответствии с метрикой, используемой полем.

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

Documents - Search Get

Параметры URI

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

Ответы

Примеры

SearchIndexSearchDocumentsGet

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

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

SearchIndexSearchDocumentsSemanticGet

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

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

Определения

AnswerResult

CaptionResult

DebugInfo

DocumentDebugInfo

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HybridCountAndFacetMode

HybridSearch

QueryAnswerType

QueryCaptionType

QueryDebugMode

QueryLanguage

QueryResultDocumentRerankerInput

QueryResultDocumentSemanticField

QueryResultDocumentSubscores

QueryRewritesDebugInfo

QueryRewritesType

QueryRewritesValuesDebugInfo

QuerySpellerType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SearchScoreThreshold

SemanticDebugInfo

SemanticErrorMode

SemanticErrorReason

SemanticFieldState

SemanticQueryRewritesResultType

SemanticSearchResultsType

SingleVectorFieldResult

TextResult

VectorFilterMode

VectorizableImageBinaryQuery

VectorizableImageUrlQuery

VectorizableTextQuery

VectorQueryKind

VectorsDebugInfo

VectorSimilarityThreshold

VectorThresholdKind

Дополнительные ресурсы