tipo de recurso searchRequest
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, 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 |
---|---|---|
aggregations | coleção aggregationOption | Especifica agregações (também conhecidas como refinarias) a serem retornadas junto 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 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. |
collapseProperties | coleção collapseProperty | Contém a coleção ordenada de campos e o limite para resultados de colapso. Opcional. |
contentSources | Coleção de cadeias de caracteres | Contém a conexão a ser direcionada. Respeita o seguinte formato : /external/connections/connectionid em que connectionid é o ConnectionId definido na Administração de Conectores. Observação: contentSource só é aplicável quando entityType= externalItem . Opcional. |
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 , person , externalItem , acronym , bookmark , chatMessage . Para obter detalhes sobre combinações de dois ou mais tipos de entidade com suporte na mesma solicitação de pesquisa, consulte limitações conhecidas. 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 a partir do conteúdo que os conectores do Microsoft Graph trazem. A propriedade fields pode estar usando 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 | 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 | cadeia de caracteres | Necessário para pesquisas que usam permissões de aplicativo. Representa o local geográfico da pesquisa. Para obter detalhes, consulte Obter o valor da região. |
resultTemplateOptions | coleção resultTemplateOption | Fornece as opções de modelos 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. |
trimDuplicates | Booliano | Indica se é necessário cortar os arquivos duplicados do SharePoint dos resultados da pesquisa. O valor padrão é false . Opcional. |
stored_fields (preterido) | String collection | Isso agora é substituído pela propriedade fields . |
Representação JSON
Veja a seguir uma representação JSON do 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
- Usar modelos de consulta
- Pesquisa mensagens de email
- Pesquisar eventos do calendário
- Pesquisar pessoa
- Pesquisa conteúdo no SharePoint e no OneDrive (arquivos, listas e sites)
- Pesquisar tipos personalizados importados usando conectores
- Classificar resultados de pesquisa
- Resultados da pesquisa de colapso
- Cortar resultados de pesquisa duplicados
- Usar agregações para refinar os resultados da pesquisa
- Usar layout de exibição
- Habilitar correções ortográficas nos resultados da pesquisa
- Pesquisa conteúdo do SharePoint com permissões de aplicativo
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de