Использование API поиска Microsoft Graph для передачи нескольких поисковых запросов
API поиска (Майкрософт) позволяет включить несколько поисковых запросов в один текст запроса. В настоящее время эта возможность доступна для OneDrive и SharePoint, а также для внешнего содержимого, которое поглощается и индексируется соединителями Microsoft Graph и типами ресурсов ответов , включая закладки, аббревиатуры и Q&A.
Поддерживаемые типы сущностей
Поддерживаемые типы сущностей для включения нескольких поисковых запросов в текст запроса: site, drive, driveItem, list, listItem, externalItem, bookmark, aкроним и qna. Типы сущностей в одном блоке запросов должны соответствовать поддерживаемым отношениям типов сущностей и сочетаниям, определенным в разделе поиска чередующегося поиска .
Примеры
Пример 1. Поиск с помощью типов файлов SharePoint и сочетаний закладок и аббревиатур
Запрос
POST https://graph.microsoft.com/beta/search/query
Content-Type: application/json
{
"requests": [
{
"entityTypes": [
"bookmark", "acronym"
],
"query": {
"queryString": "POC"
},
"from": 0,
"size": 25
},
{
"entityTypes": [
"listItem",
"site"
],
"query": {
"queryString": "POC"
},
"from": 0,
"size": 25
}
]
}
Отклик
Ниже показан ответ, который выполняет поиск по типам файлов SharePoint и сочетаниям закладки и аббревиатуры.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#search",
"value": [
{
"searchTerms": [
"POC"
],
"hitsContainers": [
{
"total": 1,
"moreResultsAvailable": false,
"hits": [
{
"hitId": "adce5789-c324-485a-a8bf-66bb809527ff",
"rank": 1,
"summary": "",
"resource": {
"@odata.type": "#microsoft.graph.search.acronym",
"id": "adce5789-c324-485a-a8bf-66bb809527ff",
"displayName": "POC",
"description": "Acronym in Spanish",
"webUrl": "",
"standsFor": "prueba de concepto"
}
},
{
"hitId": "1c0599db-2e89-4327-827a-3935c999f6cc",
"rank": 2,
"summary": "",
"resource": {
"@odata.type": "#microsoft.graph.search.bookmark",
"id": "1c0599db-2e89-4327-827a-3935c999f6cc",
"displayName": "POC",
"description": "A proof of concept (POC) is an exercise in which work is focused on determining whether an idea can be turned into a reality. ",
"webUrl": "https://en.wikipedia.org/wiki/POC"
}
}
]
}
]
},
{
"searchTerms": [
"POC"
],
"hitsContainers": [
{
"total": 2,
"moreResultsAvailable": false,
"hits": [
{
"hitId": "adce5789-c324-485a-a8bf-66bb809527ff",
"rank": 3,
"summary": "Test listItem 1",
"resource": {
"@odata.type": "#microsoft.graph.listItem",
"createdDateTime": "2019-10-07T10:00:08Z",
"lastModifiedDateTime": "2019-10-07T10:00:11Z",
"title": "Here is a summary of your messages from last week - New Feature: Live captions in English-US a POC"
}
},
{
"hitId": "microsoft.sharepoint.com,9fb3f597-167e-4c3d-b5e6-1ddc18d22d48,c53cd46e-9033-4b42-af94-0ad76ab75fd0",
"rank": 4,
"summary": "Test site",
"resource": {
"@odata.type": "#microsoft.graph.site",
"createdDateTime": "2019-10-07T10:00:08Z",
"lastModifiedDateTime": "2019-10-07T10:00:11Z",
"title": "Test site summary POC"
}
}
]
}
]
}
]
}
Примеры недопустимых запросов
В следующих примерах показаны запросы, которые приводят к неправильному ответу на ошибку. Дополнительные сведения об ограничениях поисковых запросов см. в разделе [Известные ограничения(#known-ограничения).
Пример 1. Поиск с одинаковыми типами сущностей в отдельных блоках запросов в тексте запроса
Запрос
POST https://graph.microsoft.com/beta/search/query
Content-Type: application/json
{
"requests": [
{
"entityTypes": [
"bookmark"
],
"query": {
"queryString": "POC"
},
"from": 0,
"size": 25
},
{
"entityTypes": [
"bookmark",
],
"query": {
"queryString": "POC"
},
"from": 0,
"size": 25
}
]
}
Отклик
Ниже приведен пример неправильного ответа на запрос.
HTTP/1.1 200 OK
Content-type: application/json
{
"error": {
"code": "BadRequest",
"message": "SearchRequest Invalid (Entity types must not be duplicates in multiple entity requests)",
"target": "",
"details": [
{
"code": "Microsoft.SubstrateSearch.Api.ErrorReporting.ResourceBasedExceptions.BadRequestException",
"message": "Entity types must not be duplicates in multiple entity requests",
"target": "",
"httpCode": 400
}
],
"httpCode": 400
}
}
Пример 2. Поиск по типам сущностей файлов в отдельных блоках запросов в тексте запроса
Запрос
POST https://graph.microsoft.com/beta/search/query
Content-Type: application/json
{
"requests": [
{
"entityTypes": [
"site"
],
"query": {
"queryString": "POC"
},
"from": 0,
"size": 25
},
{
"entityTypes": [
"drive",
],
"query": {
"queryString": "POC"
},
"from": 0,
"size": 25
}
]
}
Отклик
Ниже приведен пример неправильного ответа на запрос.
HTTP/1.1 200 OK
Content-type: application/json
{
"error": {
"code": "BadRequest",
"message": "SearchRequest Invalid (Entity types must not be duplicates in multiple entity requests)",
"target": "",
"details": [
{
"code": "Microsoft.SubstrateSearch.Api.ErrorReporting.ResourceBasedExceptions.BadRequestException",
"message": "File entity types can only appear in one entity request",
"target": "",
"httpCode": 400
}
],
"httpCode": 400
}
}
Известные ограничения
- Значения, используемые для свойств from и size в разных экземплярах searchRequest в тексте запроса, должны быть одинаковыми. Значение, используемое для свойства queryString в разных экземплярах searchQuery в разных экземплярах searchRequest , должно быть одинаковым.
- Повторяющиеся типы сущностей в разных поисковых запросах в тексте запроса не допускаются. Например, невозможно создать закладкуsearchRequest и другую закладкуsearchRequest в тексте запроса.
- Типы сущностей файлов (site, drive, driveItem, list и listItem) могут присутствовать только в одном поисковом запросе текста запроса. Например, нельзя включить сущность сайта в один searchRequest и сущность диска в другом searchRequest в тексте запроса.
- Функциональность средства проверки орфографии может использоваться только один раз, и она должна быть включена в первый searchRequest в тексте запроса.