tipo de recurso searchRequest

  • Artigo

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, parâmetros de paginação, opções de classificação, agregações e campos solicitados e consulta de pesquisa real. Confira 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
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 esse filtro com base em uma pesquisa anterior que se 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 docx 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 a itens de unidade do docx 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 refinarias) a serem retornadas junto com os resultados da pesquisa. Opcional.
collapseProperties coleção collapseProperty Contém a coleção ordenada de campos e o limite para resultados de colapso. Opcional.
contentSources String collection 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: event, message, driveItem, externalItem, site, list, listItem, drive, chatMessage, person, acronym, bookmark. Observe que você deve usar o Prefer: include-unknown-enum-members cabeçalho de solicitação para obter os seguintes valores neste enumerável em evolução: chatMessage, person, , acronymbookmark. 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 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 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. 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 O local geográfico 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 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 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"}],
  "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