Comentários Editar

Tipo de recurso searchRequest

  • Artigo
  • 3 minutos para o fim da leitura

Namespace: microsoft.graph

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 os 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 na agregação de resultados da pesquisa.

Propriedades

Propriedade Tipo Descrição
aggregationFilters Coleção de cadeias de caracteres 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 for necessário fornecer vários valores para o mesmo campo, 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 docx tipo de arquivo na resposta. Você pode usar convenientemente a agregaçãoFilterToken retornada para este searchBucket em uma consulta de pesquisa subsequente e o filtro corresponde aos docx itens de unidade do tipo de arquivo. O exemplo 1 e o exemplo 2 mostram as solicitações e respostas reais.
aggregations coleção aggregationOption Especifica agregações (também conhecidas como refinadores) a serem retornadas junto com os resultados da pesquisa. Opcional.
contentSources Coleção de cadeias de caracteres Contém a conexão a ser direcionada.
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, externalItem. Veja as 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 de cadeias de caracteres 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 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 de consulta. Obrigatório.
queryAlterationOptions searchAlterationOptions Opções de alteração de consulta formatadas em um blob JSON que contém dois sinalizadores opcionais relacionados à correção ortográfica. Opcional.
resultTemplateOptions coleção resultTemplateOption Fornece as opções de modelo de resultado de pesquisa para renderizar os resultados da pesquisa de conectores.
size Int32 O tamanho da página a ser recuperada. O valor máximo é 1000. 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 de classificação na coleção. Opcional.

Representação JSON

Veja a seguir uma representação JSON do recurso.

{
  "aggregationFilters": ["String"],
  "aggregations": {"@odata.type": "microsoft.graph.aggregationOption"},
  "enableTopResults": "Boolean",
  "entityTypes": ["String"],
  "contentSources": ["String"],
  "fields": ["String"],
  "from": "Int32",
  "query": {"@odata.type": "microsoft.graph.searchQuery"},
  "queryAlterationOptions": {"@odata.type": "microsoft.graph.searchAlterationOptions"},
  "resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
  "size": "Int32"
}

Confira também