Тип ресурса searchRequest

  • Статья

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

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

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

Примечание.

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

Свойства

Свойство Тип Описание
aggregationFilters Коллекция строк Содержит один или несколько фильтров для получения результатов поиска, агрегированных и отфильтрованных по определенному значению поля. Необязательный параметр.
Создайте этот фильтр на основе предыдущего поиска, который объединяется по одному и тому же полю. В ответе предыдущего поиска определите searchBucket, который фильтрует результаты по конкретному значению поля, используйте строку в свойстве aggregationFilterToken и создайте строку фильтра агрегирования в формате "{field}:\"{aggregationFilterToken}\"".
Если необходимо указать несколько значений для одного поля, используйте строки в свойстве aggregationFilterToken и создайте строку фильтра агрегирования в формате "{field}:or(\"{aggregationFilterToken1}\",\"{aggregationFilterToken2}\")".
Например, поиск и агрегирование элементов диска по типу файла возвращает searchBucket для типа docx файла в ответе. Вы можете удобно использовать aggregationFilterToken , возвращенный для этого searchBucket , в последующем поисковом запросе и отфильтровать совпадения вниз по элементам docx диска типа файла. В примерах 1 и 2 показаны фактические запросы и ответы.
aggregations коллекция aggregationOption Указывает агрегаты (также называемые уточнениями), возвращаемые вместе с результатами поиска. Необязательный параметр.
collapseProperties коллекция collapseProperty Содержит упорядоченную коллекцию полей и ограничение на свертывание результатов. Необязательный параметр.
contentSources Коллекция строк Содержит целевое подключение.
enableTopResults Логический Это активирует гибридную сортировку для сообщений: первые 3 сообщения являются наиболее актуальными. Это свойство применимо только к entityType=message. Необязательный параметр.
entityTypes Коллекция entityType Один или несколько типов ресурсов, ожидаемых в ответе. Возможные значения: event, message, driveItem, externalItem, site, list, listItem, drive, chatMessage, person, acronym, bookmark. Обратите внимание, что необходимо использовать Prefer: include-unknown-enum-members заголовок запроса, чтобы получить следующие значения в этом развиваемом перечислении: chatMessage, person, acronym, . bookmark Ознакомьтесь с известными ограничениями для тех сочетаний двух или более типов сущностей, которые поддерживаются в одном поисковом запросе. Обязательно.
fields Коллекция строк Содержит поля, возвращаемые для каждого объекта ресурса, указанного в entityTypes, что позволяет настраивать поля, возвращаемые по умолчанию; в противном случае, включая дополнительные поля, такие как пользовательские управляемые свойства из SharePoint и OneDrive, или настраиваемые поля в externalItem из содержимого, которое вносят соединители Microsoft Graph. Свойство fields может использовать семантические метки, применяемые к свойствам. Например, если свойство помечено как заголовок, его можно получить с помощью следующего синтаксиса: label_title. Необязательный параметр.
from Int32 Задает смещение результатов поиска. Смещение 0 возвращает самый первый результат. Необязательный параметр.
Запрос searchQuery Содержит термины запроса. Обязательно.
queryAlterationOptions searchAlterationOptions Параметры изменения запроса, отформатированные в большом двоичном объекте JSON, который содержит два необязательных флага, связанных с исправлением орфографии. Необязательный параметр.
Регионе String Географическое расположение для поиска. Требуется для поиска, использующее разрешения приложения. Дополнительные сведения см. в разделе Получение значения региона.
resultTemplateOptions Коллекция resultTemplateOption Предоставляет параметры шаблона результатов поиска для отображения результатов поиска из соединителей.
sharePointOneDriveOptions sharePointOneDriveOptions Указывает тип содержимого для поиска при выполнении поиска с помощью разрешений приложения. Необязательный параметр.
size Int32 Размер извлекаемой страницы. Максимальное значение — 500. Необязательный параметр.
sortProperties коллекция sortProperty Содержит упорядоченную коллекцию полей и направление для сортировки результатов. В коллекции может быть не более 5 свойств сортировки. Необязательный параметр.

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

Ниже указано представление ресурса в формате JSON.

{
  "aggregationFilters": ["String"],
  "aggregations": [{"@odata.type": "microsoft.graph.aggregationOption"}],
  "collapseProperties": [{"@odata.type": "microsoft.graph.collapseProperty"}],
  "enableTopResults": "Boolean",
  "entityTypes": ["String"],
  "contentSources": ["String"],
  "fields": ["String"],
  "from": "Int32",
  "query": {"@odata.type": "microsoft.graph.searchQuery"},
  "queryAlterationOptions": {"@odata.type": "microsoft.graph.searchAlterationOptions"},
  "region": "String",
  "resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
  "sharePointOneDriveOptions": {"@odata.type": "microsoft.graph.sharePointOneDriveOptions"},
  "size": "Int32"
}

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