Comentários Editar

Tipo de recurso searchRequest

  • Artigo
  • 3 minutos para o fim da leitura

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 de 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.

Uma solicitação de pesquisa formatada em um blob JSON.

O blob JSON contém os tipos de recursos esperados na resposta, as fontes subjacentes, os parâmetros de pajamento, as opções de classificação, as agregaçãos e campos solicitados e a consulta de pesquisa real. Consulte exemplos de solicitações de pesquisa em vários recursos.

Observação

Esteja ciente das limitações conhecidas na pesquisa de combinações específicas de tipos de entidade e classificação ou agregação de resultados de pesquisa.

Propriedades

Propriedade Tipo Descrição
aggregations Coleção aggregationOption Especifica as agregação (também conhecidas como refinadores) a serem retornadas juntamente com os resultados da pesquisa. Opcional.
aggregationFilters Coleção String Contém um ou mais filtros para obter resultados de pesquisa agregados e filtrados para um valor específico de um campo. Opcional.
Crie esse filtro com base em uma 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, use a cadeia de caracteres em sua propriedade aggregationFilterToken e crie uma cadeia de caracteres de filtro de agregação no formato "{field}:\"{aggregationFilterToken}\".
Se vários valores para o mesmo campo precisarem ser fornecidos, use as cadeias de caracteres em sua propriedade aggregationFilterToken e crie uma cadeia de caracteres de filtro de agregação no formato "{field}:or(\"{aggregationFilterToken1}\",\"{aggregationFilterToken2}\")".
Por exemplo, pesquisar e agregar itens de unidade por tipo de arquivo retorna um searchBucket para o tipo de docx arquivo na resposta. Você pode convenientemente usar a docx agregaçãoFilterToken retornada para este searchBucket em uma consulta de pesquisa subsequente e o filtro corresponde aos itens de unidade do tipo de arquivo. O Exemplo 1 e o exemplo 2 mostram as solicitações e respostas reais.
contentSources Coleção String Contém a conexão a ser direcionada.
Respeita o seguinte formato: /external/connections/connectionid onde connectionid é a ConnectionId definida na Administração de Conectores.
Observação: contentSource só é aplicável quando entityType=externalItem. Opcional.
enableTopResults Booliano Isso dispara a classificação híbrida para mensagens: as três primeiras mensagens são as mais relevantes. Essa 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. Consulte limitações conhecidas para essas combinações de dois ou mais tipos de entidade com suporte na mesma solicitação de pesquisa. Obrigatório.
campos Coleção String Contém os campos a serem retornados para cada objeto de recurso especificado em entityTypes, permitindo a personalização dos campos retornados por padrão caso contrário, incluindo campos adicionais, como propriedades gerenciadas personalizadas do SharePoint e OneDrive, ou campos personalizados em externalItem do conteúdo que os conectores do Microsoft Graph trazem.
A propriedade fields pode estar usando os rótulos semânticos aplicados às propriedades. Por exemplo, se uma propriedade for rotulada como título, você poderá recuperá-la usando a seguinte sintaxe : label_title.
Opcional.
from Int32 Especifica o deslocamento para os resultados da pesquisa. Deslocamento 0 retorna o primeiro resultado. Opcional.
consulta searchQuery Contém os termos de 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 à correção ortográfica. Opcional.
resultTemplateOptions coleção resultTemplateOption Fornece as opções de modelos de resultados de pesquisa para resultados de pesquisa de conectores de renderização.
size Int32 O tamanho da página a ser recuperada. Opcional.
sortProperties Coleção sortProperty Contém a coleção ordenada de campos e direção para classificar resultados. Pode haver no máximo 5 propriedades de classificação na coleção. Opcional.
trimDuplicates Booliano Indica se os arquivos de SharePoint duplicados dos resultados da pesquisa. O valor padrão é false. Opcional.
stored_fields (preterido) Coleção String Isso agora é substituído pela propriedade fields .

Representação JSON

Veja a seguir uma representação JSON do 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"},
  "resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
  "size": 1024,
  "sortProperties": [{"@odata.type": "microsoft.graph.sortProperty"}],
  "trimDuplicates": false
}

Confira também