Visão geral da API de pesquisa do Microsoft 365 Copilot (versão prévia)

As APIs do Microsoft 365 Copilot fornecem acesso a componentes que potencializam as experiências do Copilot. Com essas APIs, você pode aprimorar seus agentes de mecanismo personalizados e soluções de IA generativa com recursos do Copilot. A API de pesquisa do Copilot permite que os desenvolvedores executem pesquisas híbridas (semânticas e lexicais) no OneDrive para conteúdo corporativo ou de estudante usando consultas de linguagem natural que entendem o contexto e a intenção de retornar documentos e arquivos relevantes. Atualmente, outras fontes de dados, como SharePoint, conectores do Copilot e muito mais, não são compatíveis com a API de pesquisa, mas serão adicionadas em versões futuras. Para obter detalhes adicionais sobre a indexação semântica, consulte Índice semântico do Microsoft 365 Copilot.

Importante

As APIs sob a /beta versão estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção.

A API de pesquisa oferece uma solução simplificada para descoberta semântica de documentos sem a necessidade de replicar, indexar ou gerenciar seus dados em uma infraestrutura de pesquisa separada. A API aplica o processamento de linguagem natural para entender a intenção da consulta e executa a classificação inteligente dos resultados para produzir os documentos mais relevantes. Alcançar essa relevância é mais difícil com as abordagens tradicionais de pesquisa baseadas em palavras-chave.

A pesquisa semântica é essencial quando você está criando soluções inteligentes de descoberta de conhecimento e deseja exibir conteúdo do Microsoft 365. Quando você implementa a pesquisa semântica, suas soluções podem fornecer uma descoberta de documentos mais precisa e contextualmente relevante, com base no vasto repositório de seus dados organizacionais. A API de Pesquisa faz isso fornecendo arquivos relevantes, visualizações de arquivos e metadados de arquivos do OneDrive para conteúdo corporativo ou de estudante. A API de Pesquisa mantém seus dados no lugar e mantém seus controles de acesso e governança. A API de pesquisa garante que os resultados da pesquisa sejam informados pelo conteúdo mais recente e relevante. Esse processo aprimora a confiabilidade e a utilidade de seus aplicativos de pesquisa personalizados com tecnologia de IA.

Experimente sua primeira consulta à API de Pesquisa no Graph Explorer.

Por que usar a API de pesquisa?

A API de Pesquisa oferece uma maneira segura e compatível de realizar a pesquisa híbrida (semântica e léxica) no OneDrive para conteúdo corporativo ou de estudante, otimizando a relevância contextual e a compreensão da intenção do usuário. Assim, você não precisa sair de dados, interromper permissões ou comprometer a segurança e a conformidade.

Aplicativos de pesquisa personalizados com tecnologia de IA podem usar a API de Pesquisa para descobrir documentos armazenados no OneDrive. Em vez de criar e manter índices de pesquisa separados, esses aplicativos podem aplicar recursos de pesquisa híbrida ao conteúdo do OneDrive para exibir conteúdo relevante da mesma forma que a Pesquisa do Microsoft 365 Copilot faz.

Aplicativos de conhecimento empresarial que exigem a descoberta inteligente de documentos podem usar os recursos de filtragem da API para definir o escopo de pesquisas para caminhos ou pastas específicos do OneDrive. Essa abordagem garante que os resultados incluam apenas fontes aprovadas, respeitando as barreiras de informações e os controles de acesso.

Aplicativos centrados em documentos podem combinar compreensão semântica com filtragem baseada em caminho para criar experiências de pesquisa intuitivas que ajudam os usuários a encontrar os documentos certos rapidamente com base em descrições de linguagem natural, em vez de correspondências exatas de palavras-chave.

Gerenciar riscos de conformidade e segurança

A API de Pesquisa usa os recursos internos de segurança e conformidade no Microsoft 365 para garantir que as permissões da fonte de dados e as configurações de conformidade sejam preservadas. Ao pesquisar dados no local, ele evita vazamentos de dados e garante que informações confidenciais sejam acessíveis apenas a usuários autorizados. Essa funcionalidade é essencial para manter padrões rígidos de segurança e conformidade. Dentro de uma organização, o modelo de permissões do Microsoft 365 garante que os indivíduos só possam obter resultados do conteúdo que têm permissão para acessar.

Resolva a relevância e o frescor

Como a API de Pesquisa executa a pesquisa híbrida diretamente no conteúdo do OneDrive sem duplicação de dados, seus resultados são mantidos atualizados e relevantes. Ele elimina a necessidade de manter infraestruturas de pesquisa separadas e caras.

Menor custo de propriedade e esforço de desenvolvimento

A API de pesquisa elimina a necessidade de criar um pipeline seguro de exportação de dados e indexação de pesquisa que pode incorrer em custos significativos para as organizações. A API dá suporte aos seguintes recursos necessários, incluindo:

  • Pesquisa híbrida (semântica e lexical)
  • Processamento de linguagem natural
  • Indexação de conteúdo
  • Armazenamento de dados
  • Filtragem baseada em caminho usando a linguagem QL por palavra-chave (KQL)
  • Segurança e conformidade

Use esses recursos internos para evitar despesas e complexidades e manter controles de acesso e conformidade rigorosos no Microsoft 365.

Licenciamento

A API de pesquisa está disponível sem custo adicional para usuários com um complemento de licença do Microsoft 365 Copilot. O suporte para usuários sem uma licença de complemento do Microsoft 365 Copilot não está disponível no momento.

Ao acessar ou usar a API de pesquisa do Microsoft 365 Copilot, você concorda com os Termos de Uso das APIs do Microsoft 365 Copilot (versão prévia).

Práticas recomendadas

As práticas recomendadas a seguir se aplicam a consultas não filtradas (consultas sem um filterExpression) e consultas filtradas (consultas com um filterExpression):

  • A API de Pesquisa retorna resultados ordenados por relevância.
  • Use todos os resultados de pesquisa retornados pela API de Pesquisa para uma descoberta abrangente de documentos.
  • Evite consultas excessivamente genéricas que possam se aplicar a uma ampla variedade de conteúdo.
  • Forneça o máximo de contexto possível na consulta para uma melhor compreensão semântica.
  • Faça o query seu descritivo e baseado em linguagem natural.
  • Evite erros de ortografia em palavras-chave importantes ao criar o arquivo query.

Aplicar a seguinte prática recomendada a consultas filtradas (consultas com um filterExpression):

  • Para o path parâmetro, use o caminho completo do OneDrive, conforme mostrado no painel de detalhes do arquivo ou da pasta (não um link de compartilhamento ou endereço do navegador). Por exemplo: https://contoso-my.sharepoint.com/personal/username_domain_com/Documents/Project/Report.docx.

Escopo e restrições atuais

No momento, as seguintes restrições se aplicam à API de Pesquisa:

  • O query parâmetro de solicitação tem um limite de 1.500 caracteres.
  • Há suporte apenas para o OneDrive corporativo ou de estudante como fonte de dados.
  • Apenas path expressões são suportadas no filterExpression. Mais propriedades de QL por palavra-chave (KQL) podem ter suporte em versões futuras.
  • O pageSize parâmetro de solicitação tem um valor máximo de 100.
  • São suportadas até 200 solicitações por usuário por hora.
  • A pesquisa semântica em conteúdo não textual, incluindo tabelas, imagens e gráficos, não é suportada.
  • Não há suporte para a pesquisa semântica em arquivos com extensões .docx, .pptx e .pdf maiores que 512 MB. A pesquisa semântica em arquivos com qualquer outra extensão maior que 150 MB não é suportada
  • A pesquisa semântica está disponível em um conjunto de dados de trabalho personalizado para conteúdo do OneDrive, que não inclui todo o conteúdo no OneDrive do usuário.
  • A pesquisa semântica está disponível apenas nas seguintes extensões de arquivo: .aspx, .docx, .pptx, .pdf, .onepart, .doc, .html, .eml, .mp4, .loop, .one, .fluid, .png, .jpg, .json, .csv, .xml, .ppt.
  • A API de Pesquisa está sujeita a todas as limitações do índice semântico do Microsoft 365 Copilot.
  • Se searchHits , na resposta, o conteúdo estiver vazio, nenhum resultado relevante foi encontrado.

Próxima etapa