Compartilhar via

searchRequest resource type (Tipo de recurso searchRequest)

  • Artigo

Namespace: microsoft.graph

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
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.
aggregations coleção aggregationOption Especifica agregações (também conhecidas como refinadores) a serem devolvidas juntamente com os resultados da pesquisa. Opcional.
collapseProperties coleção collapseProperty Contém a coleção ordenada de campos e o limite para fechar os resultados. Opcional.
contentSources String collection Contém a ligação a ser direcionada.
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: event, message, driveItem, externalItem, site, list, listItem, drive, chatMessage, person, acronym, bookmark. Utilize o cabeçalho do Prefer: include-unknown-enum-members pedido para obter os seguintes valores nesta enumeração evoluível: chatMessage, person, acronym, bookmark. Veja as limitações conhecidas para essas combinações de dois ou mais tipos de entidade que são suportados no mesmo pedido de pesquisa. 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 utilizar as etiquetas semânticas aplicadas às propriedades. Por exemplo, se uma propriedade estiver etiquetada 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 Opções de alteração de consulta formatadas num blob JSON que contém dois sinalizadores opcionais relacionados com a correção ortográfica. Opcional.
região Cadeia de caracteres A localização geográfica da pesquisa. Necessário para pesquisas que utilizem permissões de aplicação. Para obter detalhes, veja Obter o valor da região.
resultTemplateOptions coleção resultTemplateOption Fornece as opções de modelo 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.

Representação JSON

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