Compartilhar via

searchRequest resource type (Tipo de recurso searchRequest)

  • Artigo

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Cuidado

Os recursos usados em uma solicitação e resposta da API Pesquisa da Microsoft têm propriedades renomeadas ou removidas ou estão sendo preteridas. Encontre mais detalhes sobre a substituição. Atualize as consultas da API de pesquisa em todos os aplicativos anteriores.

Um pedido de pesquisa formatado num blob JSON.

O blob JSON contém os tipos de recursos esperados na resposta, as origens subjacentes, os parâmetros de paginação, as opções de ordenação, as agregações e os campos pedidos e a consulta de pesquisa real. Veja exemplos de pedidos de pesquisa em vários recursos.

Observação

Tenha em atenção as limitações conhecidas na pesquisa de combinações específicas de tipos de entidade e na ordenação ou agregação de resultados de pesquisa.

Propriedades

Propriedade Tipo Descrição
aggregations coleção aggregationOption Especifica agregações (também conhecidas como refinadores) a serem devolvidas juntamente com os resultados da pesquisa. Opcional.
aggregationFilters String collection Contém um ou mais filtros para obter resultados de pesquisa agregados e filtrados para um valor específico de um campo. Opcional.
Crie este filtro com base numa pesquisa anterior que agrega pelo mesmo campo. Na resposta da pesquisa anterior, identifique o searchBucket que filtra os resultados para o valor específico do campo, utilize a cadeia na propriedade aggregationFilterToken e crie uma cadeia de filtro de agregação no formato "{field}:\"{aggregationFilterToken}\".
Se forem necessários vários valores para o mesmo campo, utilize as cadeias na propriedade aggregationFilterToken e crie uma cadeia de filtro de agregação no formato "{field}:or(\"{aggregationFilterToken1}\",\"{aggregationFilterToken2}\")".
Por exemplo, procurar e agregar itens de unidade por tipo de ficheiro devolve um searchBucket para o tipo docx de ficheiro na resposta. Pode utilizar convenientemente a agregaçãoFilterToken devolvido para este searchBucket numa consulta de pesquisa subsequente e filtrar correspondências para itens de unidade do docx tipo de ficheiro. O exemplo 1 e o exemplo 2 mostram os pedidos e respostas reais.
collapseProperties coleção collapseProperty Contém a coleção ordenada de campos e o limite para fechar os resultados. Opcional.
contentSources Coleção de cadeias de caracteres Contém a ligação a ser direcionada.
Respeita o seguinte formato: /external/connections/connectionid em connectionid que é o ConnectionId definido na Administração de Conectores.
Nota: contentSource só é aplicável quando entityType=externalItem. Opcional.
enableTopResults Booliano Isto aciona a ordenação híbrida para mensagens: as três primeiras mensagens são as mais relevantes. Esta propriedade só é aplicável a entityType=message. Opcional.
entityTypes coleção entityType Um ou mais tipos de recursos esperados na resposta. Os valores possíveis são: list, site, listItem, message, event, drive, driveItem, person, externalItem, acronym, bookmark, chatMessage. Para obter detalhes sobre combinações de dois ou mais tipos de entidade suportados no mesmo pedido de pesquisa, veja limitações conhecidas. Obrigatório.
campos String collection Contém os campos a serem devolvidos para cada objeto de recurso especificado em entityTypes, permitindo a personalização dos campos devolvidos por predefinição, caso contrário, incluindo campos adicionais, como propriedades geridas personalizadas do SharePoint e oneDrive, ou campos personalizados em externalItem a partir do conteúdo que os conectores do Microsoft Graph trazem.
A propriedade campos pode estar a utilizar as etiquetas semânticas aplicadas às propriedades. Por exemplo, se uma propriedade for etiqueta como título, pode obtê-la com a seguinte sintaxe: label_title.
Opcional.
from Int32 Especifica o desvio para os resultados da pesquisa. Desvio 0 devolve o primeiro resultado. Opcional.
consulta searchQuery Contém os termos da consulta. Obrigatório.
queryAlterationOptions searchAlterationOptions Fornece opções de alteração de consulta formatadas como um blob JSON que contém dois sinalizadores opcionais relacionados com a correção ortográfica. Opcional.
região cadeia de caracteres Necessário para pesquisas que utilizem permissões de aplicação. Representa a localização geográfica da pesquisa. Para obter detalhes, veja Obter o valor da região.
resultTemplateOptions coleção resultTemplateOption Fornece as opções de modelos de resultados de pesquisa para compor resultados de pesquisa de conectores.
sharePointOneDriveOptions sharePointOneDriveOptions Indica o tipo de conteúdo a procurar quando uma pesquisa é efetuada com permissões de aplicação. Opcional.
size Int32 O tamanho da página a obter. O valor máximo é 500. Opcional.
sortProperties sortProperty collection Contém a coleção ordenada de campos e direção para ordenar os resultados. Pode haver, no máximo, 5 propriedades de ordenação na coleção. Opcional.
trimDuplicates Booliano Indica se pretende cortar os ficheiros duplicados do SharePoint dos resultados da pesquisa. O valor padrão é false. Opcional.
stored_fields (preterido) String collection Esta opção é agora substituída pela propriedade campos .

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

{
  "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
}

Conteúdo relacionado