Тип ресурса searchRequest

  • Статья

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

Важно!

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

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

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

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

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

Примечание.

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

Свойства

Свойство Тип Описание
aggregations коллекция aggregationOption Указывает агрегаты (также называемые уточнениями), возвращаемые вместе с результатами поиска. Необязательный параметр.
aggregationFilters Коллекция строк Содержит один или несколько фильтров для получения результатов поиска, агрегированных и отфильтрованных по определенному значению поля. Необязательный параметр.
Создайте этот фильтр на основе предыдущего поиска, который объединяется по одному и тому же полю. В ответе предыдущего поиска определите searchBucket, который фильтрует результаты по конкретному значению поля, используйте строку в свойстве aggregationFilterToken и создайте строку фильтра агрегирования в формате "{field}:\"{aggregationFilterToken}\"".
Если необходимо указать несколько значений для одного поля, используйте строки в свойстве aggregationFilterToken и создайте строку фильтра агрегирования в формате "{field}:or(\"{aggregationFilterToken1}\",\"{aggregationFilterToken2}\")".
Например, поиск и агрегирование элементов диска по типу файла возвращает searchBucket для типа docx файла в ответе. Вы можете удобно использовать aggregationFilterToken , возвращенный для этого searchBucket , в последующем поисковом запросе и отфильтровать совпадения вниз по элементам docx диска типа файла. В примерах 1 и 2 показаны фактические запросы и ответы.
collapseProperties коллекция collapseProperty Содержит упорядоченную коллекцию полей и ограничение на свертывание результатов. Необязательный параметр.
contentSources Коллекция строк Содержит целевое подключение.
Учитывает следующий формат: /external/connections/connectionid где connectionid — идентификатор подключения, определенный в администрирование соединителей.
Примечание. ContentSource применяется только в том случае, если entityType=externalItem. Необязательный параметр.
enableTopResults Логический Это активирует гибридную сортировку для сообщений: первые 3 сообщения являются наиболее актуальными. Это свойство применимо только к entityType=message. Необязательный параметр.
entityTypes Коллекция entityType Один или несколько типов ресурсов, ожидаемых в ответе. Возможные значения: list, site, listItem, message, event, drive, driveItem, person, externalItem, acronym, bookmark, chatMessage. Дополнительные сведения о сочетаниях двух или более типов сущностей, поддерживаемых в одном поисковом запросе, см. в разделе Известные ограничения. Обязательно.
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 свойств сортировки. Необязательный параметр.
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
}

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