Тип ресурса searchRequest

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Предостережение

Свойства ресурсов, которые использовались в запросах и ответах об API в Microsoft Search были переименованы, удалены или больше не поддерживаются. См. дополнительные сведения о прекращении поддержки. Соответствующее обновление запросов об API в любых вышедших ранее приложениях.

Поисковый запрос, отформатированный в виде большого двоичного объекта JSON.

BLOB-объект JSON содержит типы ресурсов, ожидаемых в отклике, базовые источники, параметры разбиения на страницы, параметры сортировки, запрашиваемые агрегаты и поля, а также фактический поисковый запрос. Примеры поисковых запросов смотрите на различных ресурсах.

Примечание.

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

Свойства

Свойство Тип Описание
aggregations Коллекция aggregationOption Указывает агрегаты (также известные как уточнения), которые должны возвращаться вместе с результатами поиска. Необязательный параметр.
aggregationFilters Коллекция строк Содержит один или несколько фильтров для получения результатов поиска, обобщенных и отфильтрованных по определенному значению поля. Необязательный параметр.
Создайте этот фильтр на основе предыдущего поиска, агрегирующего данные по тому же полю. В ответе предыдущего поиска определите searchBucket , который фильтрует результаты по определенному значению поля, используйте строку в его свойстве aggregationFilterToken и создайте строку фильтра агрегирования в формате "{field}:\"{aggregationFilterToken}\"".
Если для одного поля необходимо указать несколько значений, используйте строки из его свойства aggregationFilterToken и создайте строку фильтра агрегирования в формате "{field}:or(\"{aggregationFilterToken1}\",\"{aggregationFilterToken2}\")".
Например, поиск и агрегирование элементов диска по типам файлов возвращает searchBucket для типа docx файла в ответе. Вы можете удобно использовать aggregationFilterToken, возвращаемый для этого searchBucket , в последующем поисковом запросе и фильтровать совпадения, чтобы управлять элементами docx этого типа файла. Примеры 1 и 2 показывают фактические запросы и ответы.
collapseProperties collapseProperty collection Содержит упорядоченную коллекцию полей и ограничивается свертыванием результатов. Необязательный параметр.
contentSources Коллекция строк Содержит целевое подключение.
Соответствует следующий формат: где connectionid — ConnectionId, /external/connections/connectionid определенный в администрировании соединителей.
Примечание: contentSource применим только в случае, когда entityType=externalItem. Необязательный параметр.
enableTopResults Логический Будет запущена гибридная сортировка сообщений: первые 3 сообщения являются наиболее релевантными. Это свойство применимо только к entityType=message. Необязательный параметр.
entityTypes коллекция entityType В ответе ожидается один или несколько типов ресурсов. Возможные значения: list, site, chatMessagebookmarkacronymexternalItemdriveItemeventpersonlistItemmessagedrive. Сведения о сочетаниях двух или более типов сущностей, поддерживаемых в одном поисковом запросе, см. в разделе "Известные ограничения". Обязательно.
fields Коллекция строк Содержит поля, возвращаемые для каждого объекта ресурса, указанного в entityTypes, что позволяет настраивать поля, возвращаемые по умолчанию, включая дополнительные поля, такие как настраиваемые управляемые свойства из SharePoint и OneDrive, или настраиваемые поля в externalItem из содержимого, которое вносят соединители Microsoft 365 Copilot.
Свойство fields может использовать семантические метки , применяемые к свойствам. Например, если свойство помечено как заголовок, его можно получить, используя следующий синтаксис: label_title.
Необязательный параметр.
from Int32 Указывает смещение для результатов поиска. Смещение 0 возвращает самый первый результат. Необязательный параметр.
Запрос searchQuery Содержит термины запроса. Обязательно.
queryAlterationOptions searchAlterationOptions Предоставляет параметры изменения запроса в формате большого двоичного объекта JSON, который содержит два необязательных флага, связанных с исправлением орфографии. Необязательный параметр.
регион string Требуется для поисковых запросов, использующих разрешения приложений. Представляет географическое положение для поиска. Дополнительные сведения см. в разделе "Получение значения региона".
resultTemplateOptions Коллекция resultTemplateOption Предоставляет шаблоны результатов поиска параметры для отображения результатов поиска соединителей.
sharePointOneDriveOptions sharePointOneDriveOptions Тип содержимого для поиска, выполняемого с использованием разрешений приложения. Необязательный параметр.
size Int32 Размер извлекаемой страницы. Максимальное значение — 500. Необязательный параметр.
sortProperties Коллекция sortProperty Содержит упорядоченный набор полей и направление сортировки результатов. В коллекции может быть не более 5 свойств сортировки. Необязательный параметр.
trimDuplicates Логический Указывает, следует ли удалять дубликаты файлов SharePoint из результатов поиска. Значение по умолчанию — false. Необязательный параметр.
stored_fields (устарело) Коллекция строк Оно заменено свойством fields .

Представление JSON

В следующем представлении JSON показан тип ресурса.

{
  "aggregationFilters": ["String"],
  "aggregations": [{"@odata.type": "microsoft.graph.aggregationOption"}],
  "contentSources": ["String"],
  "enableTopResults": true,
  "entityTypes": ["String"],
  "fields": ["String"],
  "from": 1024,
  "query": {"@odata.type": "microsoft.graph.searchQuery"},
  "queryAlterationOptions": {"@odata.type": "microsoft.graph.searchAlterationOptions"},
  "region": "63128164-cbbf-4db4-896c-a7038417019c",
  "resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
  "sharePointOneDriveOptions": {"@odata.type": "microsoft.graph.sharePointOneDriveOptions"},
  "size": 1024,
  "sortProperties": [{"@odata.type": "microsoft.graph.sortProperty"}],
  "collapseProperties": [{"@odata.type": "microsoft.graph.collapseProperty"}],
  "trimDuplicates": false
}

Связанные материалы

  • Last updated on