Documents - Search Post

Ссылка

Служба:: Search Service

Версия API:: 2023-11-01

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2023-11-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[]	Список выражений аспектов, применяемых к поисковому запросу. Каждое выражение аспекта содержит имя поля, за которым при необходимости следует разделенный запятыми список пар "имя:значение".
filter	string	Выражение OData $filter, применяемого к поисковому запросу.
highlight	string	Разделенный запятыми список имен полей, используемых для выделения нажатия. Для выделения попаданий можно использовать только доступные для поиска поля.
highlightPostTag	string	Строковый тег, добавляемый к выделению нажатия. Необходимо задать параметр highlightPreTag. Значение по умолчанию — </em>.
highlightPreTag	string	Строковый тег, который добавляется к выделению нажатия. Должен быть задан с параметром highlightPostTag. Значение по умолчанию — <em>.
minimumCoverage	number	Число от 0 до 100, указывающее процент индекса, который должен быть охвачен поисковым запросом, чтобы запрос сообщал об успешном выполнении. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одним реплика. Значение по умолчанию — 100.
orderby	string	Разделенный запятыми список OData $orderby выражения для сортировки результатов. Каждое выражение может быть именем поля или вызовом функций geo.distance() или search.score(). За каждым выражением может следовать asc для указания по возрастанию, или desc для указания по убыванию. По умолчанию результаты сортируются по возрастанию. При равенстве позиций порядок определяется по показателю совпадения документа. Если $orderby не указан, порядок сортировки по умолчанию убывания по оценке соответствия документа. Может быть не более 32 предложений $orderby.
queryType	QueryType	Значение типа , указывающее синтаксис поискового запроса. Значение по умолчанию — simple. Используйте "full", если в запросе используется синтаксис запроса Lucene.
scoringParameters	string[]	Список значений параметров, используемых в функциях оценки (например, referencePointParameter), используя формат name-values. Например, если профиль оценки определяет функцию с параметром mylocation, строка параметра будет иметь значение "mylocation--122.2,44.8" (без кавычек).
scoringProfile	string	Имя профиля для оценки соответствующих показателей, для сопоставления документов с целью сортировки результатов.
scoringStatistics	ScoringStatistics	Значение типа , указывающее, нужно ли вычислить статистику оценки (например, частоту документов) глобально для более согласованной оценки или локально для меньшей задержки. Значение по умолчанию — local. Используйте "global" для агрегирования статистики оценки глобально перед оценкой. Использование глобальной статистики оценки может увеличить задержку поисковых запросов.
search	string	Выражение запроса полнотекстового поиска; Используйте "*" или опустите этот параметр, чтобы сопоставить все документы.
searchFields	string	Разделенный запятыми список имен полей, к которым область полнотекстовый поиск. При использовании поля поиска (fieldName:searchExpression) в полном запросе Lucene имена полей каждого поля выражения поиска имеют приоритет над именами полей, перечисленными в этом параметре.
searchMode	SearchMode	Значение типа , указывающее, нужно ли сопоставлять все условия поиска, чтобы подсчитать документ как совпадение.
select	string	Список полей, разделенных запятыми. Если этот параметр не указан, возвращаются все поля, помеченные в схеме как подлежащие извлечению.
semanticConfiguration	string	Имя семантической конфигурации, которая будет использоваться при обработке документов для запросов семантики типа.
semanticErrorHandling	SemanticErrorMode	Позволяет пользователю выбрать, должен ли семантический вызов завершиться сбоем (по умолчанию или текущему поведению) или возвращать частичные результаты.
semanticMaxWaitInMilliseconds	integer	Позволяет пользователю задать верхнюю границу времени, необходимого для завершения обработки семантического обогащения до сбоя запроса.
sessionId	string	Значение, используемое для создания залипания сеанса, который может помочь получить более согласованные результаты. Если используется один и тот же sessionId, будет предпринята попытка нацелить на тот же реплика набор. Будьте осторожны, что многократное повторное использовать одни и те же значения sessionID может помешать балансировке нагрузки запросов между репликами и негативно повлиять на производительность службы поиска. Значение, используемое в качестве sessionId, не может начинаться с символа "_".
skip	integer	Количество пропускаемых результатов поиска. Значение не должно превышать 100 000. Если вам нужно сканировать документы последовательно, но вы не можете использовать skip из-за этого ограничения, рассмотрите возможность использования orderby для полностью упорядоченного ключа и фильтра с запросом диапазона.
top	integer	Количество получаемых результатов поиска. Его можно использовать в сочетании с $skip для реализации разбиения результатов поиска на стороне клиента. Если результаты усечены из-за разбиения по страницам на стороне сервера, ответ будет содержать маркер продолжения, который можно использовать для выдачи другого запроса поиска для следующей страницы результатов.
vectorFilterMode	VectorFilterMode	Определяет, применяются ли фильтры до или после выполнения поиска векторов. Значение по умолчанию — preFilter для новых индексов.
vectorQueries	VectorQuery[]: RawVectorQuery[]	Параметры запроса для векторных и гибридных поисковых запросов.

Ответы

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

Примеры

SearchIndexSearchDocumentsPost

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

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

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-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
    }
  ],
  "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=2023-11-01"
}

SearchIndexSearchDocumentsSemanticPost

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

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-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=2023-11-01"
}

Определения

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

AnswerResult

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

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

CaptionResult

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

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

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, запускается исчерпывающий поиск k-ближайших соседей по всем векторам в индексе вектора. Полезно для сценариев, где точные совпадения имеют решающее значение, например для определения значений истинности.
fields	string	Векторные поля типа Collection(Edm.Single) для включения в поиск по вектору.
k	integer	Число ближайших соседей, возвращаемых в качестве первых попаданий.
kind	string: vector	Тип выполняемого векторного запроса.
vector	number[]	Векторное представление поискового запроса.

ScoringStatistics

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

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

SearchDocumentsResult

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

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

SearchError

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

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

SearchMode

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

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

SearchRequest

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

Имя	Тип	Описание
answers	QueryAnswerType	Значение типа , указывающее, следует ли возвращать ответы как часть поискового ответа.
captions	QueryCaptionType	Значение типа , указывающее, следует ли возвращать субтитры в ответе на поиск.
count	boolean	Значение типа , указывающее, следует ли получить общее количество результатов. Значение по умолчанию — false. Установка этого значения в значение true может повлиять на производительность. Обратите внимание на то, что возвращается приблизительное количество результатов.
facets	string[]	Список выражений аспектов, применяемых к поисковому запросу. Каждое выражение аспекта содержит имя поля, за которым при необходимости следует разделенный запятыми список пар "имя:значение".
filter	string	Выражение OData $filter, применяемого к поисковому запросу.
highlight	string	Разделенный запятыми список имен полей, используемых для выделения нажатия. Для выделения попаданий можно использовать только доступные для поиска поля.
highlightPostTag	string	Строковый тег, добавляемый к выделению нажатия. Необходимо задать параметр highlightPreTag. Значение по умолчанию — </em>.
highlightPreTag	string	Строковый тег, который добавляется к выделению нажатия. Должен быть задан с параметром highlightPostTag. Значение по умолчанию — <em>.
minimumCoverage	number	Число от 0 до 100, указывающее процент индекса, который должен быть охвачен поисковым запросом, чтобы запрос сообщал об успешном выполнении. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одним реплика. Значение по умолчанию — 100.
orderby	string	Разделенный запятыми список OData $orderby выражения для сортировки результатов. Каждое выражение может быть именем поля или вызовом функций geo.distance() или search.score(). За каждым выражением может следовать asc для указания по возрастанию, или desc для указания по убыванию. По умолчанию результаты сортируются по возрастанию. При равенстве позиций порядок определяется по показателю совпадения документа. Если $orderby не указан, порядок сортировки по умолчанию убывания по оценке соответствия документа. Может быть не более 32 предложений $orderby.
queryType	QueryType	Значение типа , указывающее синтаксис поискового запроса. Значение по умолчанию — simple. Используйте "full", если в запросе используется синтаксис запроса Lucene.
scoringParameters	string[]	Список значений параметров, используемых в функциях оценки (например, referencePointParameter), используя формат name-values. Например, если профиль оценки определяет функцию с параметром mylocation, строка параметра будет иметь значение "mylocation--122.2,44.8" (без кавычек).
scoringProfile	string	Имя профиля для оценки соответствующих показателей, для сопоставления документов с целью сортировки результатов.
scoringStatistics	ScoringStatistics	Значение типа , указывающее, нужно ли вычислить статистику оценки (например, частоту документов) глобально для более согласованной оценки или локально для меньшей задержки. Значение по умолчанию — local. Используйте "global" для агрегирования статистики оценки глобально перед оценкой. Использование глобальной статистики оценки может увеличить задержку поисковых запросов.
search	string	Выражение запроса полнотекстового поиска; Используйте "*" или опустите этот параметр, чтобы сопоставить все документы.
searchFields	string	Разделенный запятыми список имен полей, к которым область полнотекстовый поиск. При использовании поля поиска (fieldName:searchExpression) в полном запросе Lucene имена полей каждого поля выражения поиска имеют приоритет над именами полей, перечисленными в этом параметре.
searchMode	SearchMode	Значение типа , указывающее, нужно ли сопоставлять все условия поиска, чтобы подсчитать документ как совпадение.
select	string	Список полей, разделенных запятыми. Если этот параметр не указан, возвращаются все поля, помеченные в схеме как подлежащие извлечению.
semanticConfiguration	string	Имя семантической конфигурации, которая будет использоваться при обработке документов для запросов семантики типа.
semanticErrorHandling	SemanticErrorMode	Позволяет пользователю выбрать, должен ли семантический вызов завершиться сбоем (по умолчанию или текущему поведению) или возвращать частичные результаты.
semanticMaxWaitInMilliseconds	integer	Позволяет пользователю задать верхнюю границу времени, необходимого для завершения обработки семантического обогащения до сбоя запроса.
sessionId	string	Значение, используемое для создания залипания сеанса, который может помочь получить более согласованные результаты. Если используется один и тот же sessionId, будет предпринята попытка нацелить на тот же реплика набор. Будьте осторожны, что многократное повторное использовать одни и те же значения sessionID может помешать балансировке нагрузки запросов между репликами и негативно повлиять на производительность службы поиска. Значение, используемое в качестве sessionId, не может начинаться с символа "_".
skip	integer	Количество пропускаемых результатов поиска. Значение не должно превышать 100 000. Если вам нужно сканировать документы последовательно, но вы не можете использовать skip из-за этого ограничения, рассмотрите возможность использования orderby для полностью упорядоченного ключа и фильтра с запросом диапазона.
top	integer	Количество получаемых результатов поиска. Его можно использовать в сочетании с $skip для реализации разбиения результатов поиска на стороне клиента. Если результаты усечены из-за разбиения по страницам на стороне сервера, ответ будет содержать маркер продолжения, который можно использовать для выдачи другого запроса поиска для следующей страницы результатов.
vectorFilterMode	VectorFilterMode	Определяет, применяются ли фильтры до или после выполнения поиска векторов. Значение по умолчанию — preFilter для новых индексов.
vectorQueries	VectorQuery[]: RawVectorQuery[]	Параметры запроса для векторных и гибридных поисковых запросов.

SearchResult

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

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

SemanticErrorMode

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

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

SemanticErrorReason

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

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

SemanticSearchResultsType

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

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

VectorFilterMode

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

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

VectorQueryKind

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

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

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

Documents - Search Post

Параметры URI

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

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

Ответы

Примеры

SearchIndexSearchDocumentsPost

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

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

SearchIndexSearchDocumentsSemanticPost

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

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

Определения

AnswerResult

CaptionResult

QueryAnswerType

QueryCaptionType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchError

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

VectorFilterMode

VectorQueryKind

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