Utilizar a API de Pesquisa do Microsoft Graph para transmitir vários pedidos de pesquisa
A API de Pesquisa da Microsoft permite-lhe incluir vários pedidos de pesquisa num único corpo de pedido. Esta capacidade está atualmente disponível para o OneDrive e SharePoint, bem como para conteúdos externos ingeridos e indexados por conectores do Microsoft Graph e tipos de recursos de resposta, incluindo marcadores, acrónimos e Q&A.
Tipos de entidade suportados
Os tipos de entidade suportados para incluir vários pedidos de pesquisa num corpo de pedido são: site, unidade, driveItem, list,listItem,externalItem, bookmark, acrónimos e qna. Os tipos de entidade no mesmo bloco de pedidos devem cumprir as relações e combinações de tipo de entidade suportadas definidas no tópico de pesquisa intercalada .
Exemplos
Exemplo 1: procurar com tipos de ficheiro do SharePoint e combinações de marcadores/acrónimos
Solicitação
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
}
]
}
Resposta
Segue-se uma resposta que pesquisa com tipos de ficheiro do SharePoint e combinações de marcadores/acrónimos.
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"
}
}
]
}
]
}
]
}
Exemplos de pedido incorreto
Os exemplos seguintes mostram pedidos que resultam numa resposta de erro de pedido incorreto. Para obter detalhes sobre as limitações com pedidos de pesquisa, veja [Limitações conhecidas(limitações de #known).
Exemplo 1: procurar com os mesmos tipos de entidade em blocos de pedido separados no corpo do pedido
Solicitação
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
}
]
}
Resposta
Segue-se um exemplo de uma resposta de pedido incorreto.
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
}
}
Exemplo 2: procurar com os tipos de entidade de ficheiro em blocos de pedido separados no corpo do pedido
Solicitação
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
}
]
}
Resposta
Segue-se um exemplo de uma resposta de pedido incorreto.
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
}
}
Limitações conhecidas
- Os valores utilizados para as propriedades de e de tamanho em diferentes instâncias searchRequest no corpo do pedido devem ser os mesmos. O valor utilizado para a propriedade queryString em diferentes instâncias searchQuery em diferentes instâncias searchRequest deve ser o mesmo.
- Não são permitidos tipos de entidade duplicados em diferentes pedidos de pesquisa no corpo do pedido. Por exemplo, não pode ter uma pesquisa de marcadoresRequest e outra pesquisa de marcadorEsquest num corpo de pedido.
- Os tipos de entidade de ficheiro (site, unidade, driveItem, lista e listItem) só podem estar presentes no mesmo pedido de pesquisa de um corpo do pedido. Por exemplo, não pode incluir uma entidade de site numa searchRequest e numa entidade de unidade numa pesquisaRequest diferente no corpo do pedido.
- A funcionalidade do corretor ortográfico só pode ser utilizada uma vez e deve ser incluída na primeira pesquisaRequest no corpo do pedido.