searchRequest, tipo de recurso

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 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
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.
aggregations coleção aggregationOption Especifica as agregações (também conhecidas como refinadores) a serem retornadas juntamente com os resultados da pesquisa. Opcional.
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.
enableTopResults Booliano Isso aciona a classificação híbrida para mensagens: as 3 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: event, message, driveItem, externalItemacronymsitelistpersonlistItemdrivechatMessage. bookmark Use o cabeçalho da Prefer: include-unknown-enum-members solicitação para obter os seguintes membros nesta enumeração evolutiva: chatMessage, person, acronym, bookmark. Veja as limitações conhecidas para as combinações de dois ou mais tipos de entidade com suporte na mesma solicitação de pesquisa. 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; caso contrário, 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 Opções de alteração de consulta formatadas em um blob JSON que contém dois sinalizadores opcionais relacionados à correção ortográfica. Opcional.
região Cadeia de caracteres A localização geográfica da pesquisa. Necessário para pesquisas que usam permissões de aplicativo. Para obter detalhes, consulte Obter o valor da região.
resultTemplateOptions coleção resultTemplateOption Fornece as opções de modelo de resultado da pesquisa para renderizar os resultados da pesquisa dos conectores.
sharePointOneDriveOptions sharePointOneDriveOptions Indica o tipo de conteúdo a ser pesquisado quando uma pesquisa é realizada 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.

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

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

Conteúdo relacionado

  • Last updated on