Documents - Search Post

Ссылка

Служба:: Search Service

Версия API:: 2024-07-01

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

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

Параметры URI

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

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

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

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

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

Ответы

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

Примеры

SearchIndexSearchDocumentsPost

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

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

HTTP

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

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

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

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

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

SearchIndexSearchDocumentsSemanticPost

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

HTTP

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

{
  "count": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "queryType": "semantic",
  "search": "how do clouds form",
  "semanticConfiguration": "my-semantic-config",
  "answers": "extractive|count-3",
  "captions": "extractive|highlight-true",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 780
}

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

Код состояния:: 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
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "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"
      ]
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-07-01"
}

Определения

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

AnswerResult

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

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

CaptionResult

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

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

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

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

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

QueryAnswerType

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

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

QueryCaptionType

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

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

QueryType

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

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

RawVectorQuery

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

Имя	Тип	Описание
exhaustive	boolean	Если значение true, активирует исчерпывающий поиск ближайших к соседей по всем векторам в индексе векторов. Полезно для сценариев, когда точные совпадения являются критически важными, например определение значений истины на земле.
fields	string	Векторные поля коллекции типов (Edm.Single), которые должны быть включены в векторный поиск.
k	integer	Число ближайших соседей, возвращаемых в качестве лучших хитов.
kind	string: vector	Тип выполняемого векторного запроса.
oversampling	number	Превышение коэффициента. Минимальное значение равно 1. Он переопределяет параметр defaultOversampling, настроенный в определении индекса. Его можно задать только в том случае, если параметр rerankWithOriginalVectors имеет значение true. Этот параметр допускается только в том случае, если метод сжатия используется в базовом поле вектора.
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.facets	object	Результаты запроса аспектов для операции поиска, упорядоченные как коллекция контейнеров для каждого фасетного поля; Значение NULL, если запрос не включал никаких выражений аспектов.
@search.nextPageParameters	SearchRequest	Полезные данные JSON продолжения возвращаются, когда запрос не может возвращать все запрошенные результаты в одном ответе. Этот код JSON можно использовать вместе с @odata.nextLink, чтобы сформулировать другой запрос поиска POST, чтобы получить следующую часть ответа поиска.
@search.semanticPartialResponseReason	SemanticErrorReason	Причина того, что частичный ответ был возвращен для семантического ранжирования запроса.
@search.semanticPartialResponseType	SemanticSearchResultsType	Тип частичного ответа, возвращаемого для семантического ранжирования запроса.
value	SearchResult[]	Последовательность результатов, возвращаемая запросом.

SearchMode

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

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

SearchRequest

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

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

SearchResult

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

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

SemanticErrorMode

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

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

SemanticErrorReason

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

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

SemanticSearchResultsType

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

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

VectorFilterMode

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

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

VectorizableTextQuery

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

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

VectorQueryKind

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

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

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

Documents - Search Post

Параметры URI

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

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

Ответы

Примеры

SearchIndexSearchDocumentsPost

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

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

SearchIndexSearchDocumentsSemanticPost

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

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

Определения

AnswerResult

CaptionResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryAnswerType

QueryCaptionType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

VectorFilterMode

VectorizableTextQuery

VectorQueryKind

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