searchRequest, tipo de recurso

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.

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 paginação, as opções de classificação, as agregações e campos solicitados e a consulta de pesquisa real. Veja 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 na classificação ou agregação dos resultados da pesquisa.

Propriedades

Propriedade Tipo Descrição
aggregations coleção aggregationOption Especifica as agregações (também conhecidas como refinadores) a serem retornadas 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 em uma pesquisa anterior que agrega pelo mesmo campo. A partir da resposta da pesquisa anterior, identifique o searchBucket que filtra os resultados para o valor específico do campo, use a string em sua propriedade aggregationFilterToken e crie uma string 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 docx de arquivo na resposta. Você pode usar convenientemente o aggregationFilterToken retornado para esse searchBucket em uma consulta de pesquisa subsequente e filtrar correspondências para itens de unidade do tipo de docx arquivo. O exemplo 1 e o exemplo 2 mostram as solicitações e respostas reais.
collapseProperties coleção collapseProperty Contém a coleção ordenada de campos e limite para recolher resultados. Opcional.
contentSources String collection 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 aciona 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, messagebookmarkeventdriveacronymdriveItempersonexternalItem. chatMessage Para obter detalhes sobre combinações de dois ou mais tipos de entidade com suporte na mesma solicitação de pesquisa, consulte as limitações conhecidas. Obrigatório.
campos String collection 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, incluindo campos adicionais, como propriedades gerenciadas personalizadas do SharePoint e do OneDrive ou campos personalizados em externalItem do conteúdo que os conectores do Microsoft 365 Copilot trazem.
A propriedade fields pode usar 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. O deslocamento 0 retorna 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 à correção ortográfica. Opcional.
região string Necessário para pesquisas que usam permissões de aplicativo. Representa a localização geográfica da pesquisa. Para obter detalhes, consulte Obter o valor da região.
resultTemplateOptions coleção resultTemplateOption Fornece as opções de modelos de resultados da pesquisa para renderizar os resultados da pesquisa de conectores.
sharePointOneDriveOptions sharePointOneDriveOptions Indica o tipo de conteúdo a ser pesquisado quando uma pesquisa é executada usando permissões de aplicativo. Opcional.
size Int32 O tamanho da página a ser recuperada. O valor máximo é 500. Opcional.
sortProperties coleção sortProperty Contém a coleção ordenada de campos e a direção para classificar os resultados. Pode haver no máximo 5 propriedades sort na coleção. Opcional.
trimDuplicates Booliano Indica se os arquivos duplicados do SharePoint devem ser cortados dos resultados da pesquisa. O valor padrão é false. Opcional.
stored_fields (preterido) String collection Isso foi substituído pela propriedade fields .

Representação JSON

A representação JSON a seguir 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

  • Última atualização em