Visão geral da API de recuperação do Microsoft 365 Copilot

As APIs do Microsoft 365 Copilot fornecem acesso a componentes que potencializam as experiências do Copilot, desbloqueando a capacidade de aprimorar seus agentes de mecanismo personalizados e soluções de IA generativa com os recursos do Microsoft 365 Copilot. A API de recuperação do Microsoft 365 Copilot permite fundamentar suas soluções de IA generativa com seu conhecimento do Microsoft 365 e de que não é da Microsoft, retornando partes de texto relevantes do índice híbrido que alimenta o Microsoft 365 Copilot.

A API de recuperação oferece uma solução simplificada para RAN (Retrieval Augmented Generation) sem a necessidade de replicar, indexar, fragmentar e proteger seus dados em um índice separado. A API entende o contexto e a intenção do usuário e executa transformações de consulta para produzir os resultados mais relevantes, o que é mais difícil de obter com pesquisa léxica ou mesmo RAG básico de fontes alternativas.

O RAG é essencial quando você está criando soluções de IA generativa e deseja usar o conhecimento do Microsoft 365. Quando você implementa o RAG, suas soluções podem fornecer respostas mais precisas e contextualmente relevantes, baseadas no vasto repositório de seus dados organizacionais. A API de recuperação realiza o RAG extraindo trechos de texto relevantes e atualizados dos conectores do SharePoint, OneDrive e Copilot. A API de recuperação mantém seus dados no local e mantém seus controles de acesso e governança. A API de recuperação garante que as respostas sintetizadas sejam informadas pelos dados mais recentes e relevantes. Esse processo aprimora a confiabilidade e a utilidade de suas soluções de IA generativa.

Para explorar a API, experimente uma consulta na Demonstração Interativa.

Por que usar a API de recuperação?

A API de recuperação oferece uma maneira segura e compatível de recuperar partes de texto relevantes dos conectores do SharePoint, OneDrive e Copilot e, ao mesmo tempo, otimizar a recuperação de contexto. Assim, você não precisa sair de dados, interromper permissões ou comprometer a segurança e a conformidade.

Aplicativos de conhecimento personalizado podem usar a API de recuperação para fundamentar respostas em informações específicas da organização armazenadas nos conectores do SharePoint, OneDrive e Copilot. Em vez de criar e manter índices de vetor separados, esses aplicativos podem recuperar o contexto relevante das fontes de dados do Microsoft 365 para fundamentar as respostas do modelo de linguagem grande (LLM) da mesma forma que o Microsoft 365 Copilot faz.

Aplicativos financeiros e jurídicos que exigem alta precisão na recuperação de informações podem usar os recursos de filtragem da API para criar pesquisas de escopo para bibliotecas de documentos ou tipos de conteúdo específicos, garantindo que as respostas incluam apenas fontes aprovadas, respeitando as barreiras de informações e os controles de acesso.

Os aplicativos de várias fontes podem combinar o conteúdo do SharePoint e do OneDrive com informações dos conectores do Microsoft 365 Copilot, criando uma base de dados de conhecimento unificada que abrange repositórios do Microsoft 365 e de terceiros, mantendo controles consistentes de segurança e conformidade.

Imagine uma empresa de consultoria especializada em fornecer soluções personalizadas para seus clientes, com uma parte significativa de seu trabalho focada em dados armazenados no SharePoint. A empresa está desenvolvendo um agente de motor personalizado para ajudar seus consultores a se prepararem para reuniões importantes com clientes. Esse agente deve acessar e recuperar informações precisas e atualizadas do SharePoint. A empresa trabalha com dois grandes clientes que são concorrentes diretos no mercado. Portanto, a empresa tem uma necessidade crítica de manter padrões rigorosos de segurança e conformidade para garantir que os documentos e dados de um cliente nunca sejam acessíveis ao outro. A API de recuperação ajuda a empresa a gerenciar riscos de conformidade e segurança e garantir a relevância e a atualização dos dados e, por sua vez, simplifica o esforço geral de desenvolvimento.

Gerenciar riscos de conformidade e segurança

A API de recuperação 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 recuperar dados no local, evita vazamentos de dados e garante que informações confidenciais de um cliente nunca sejam acessíveis a outro, o que é essencial para manter padrões rígidos de segurança e conformidade. Dentro de uma organização, o modelo de permissões no 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 recuperação recupera contexto relevante sem duplicação de dados, seus resultados são mantidos atualizados e relevantes e elimina a necessidade de manter pipelines de dados separados e caros.

Menor custo de propriedade e esforço de desenvolvimento

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

• Gerenciamento de provedores de pesquisa
• Rastreadores
• Conectores de dados
• Armazenamento de dados
• Analisadores de conteúdo
• Indexação
• Segurança

As organizações podem usar esses recursos internos para evitar despesas e complexidades e manter controles de acesso rigorosos e conformidade no Microsoft 365.

Recursos da API de recuperação

A API de recuperação permite recuperar dados das seguintes fontes de dados:

• SharePoint
• OneDrive
• Conectores do Copilot

A API dá suporte a consultas de linguagem natural e usa a pilha do Microsoft 365 Copilot para recuperar o contexto de base relevante dentro do limite de confiança do Microsoft 365. Você pode usar a API para definir o escopo da recuperação usando QL por palavra-chave (KQL) para recuperar o conteúdo mais importante para seu caso de uso. Com o KQL, você pode filtrar por URLs, intervalos de datas, tipos de arquivo e muito mais.

Licenciamento

A API de recuperação está disponível sem custo adicional para usuários com uma licença de complemento do Microsoft 365 Copilot. Ao acessar ou usar a API de recuperação do Microsoft 365 Copilot, você concorda com os Termos de Uso das APIs do Microsoft 365 Copilot (versão prévia).

Para usuários sem uma licença de complemento do Microsoft 365 Copilot, a API de recuperação está disponível por meio do consumo pago conforme o uso (versão prévia) para fontes de dados no nível do locatário, como conectores do SharePoint e do Copilot. Fontes de dados no nível do usuário, como o OneDrive, não estão disponíveis.

Os usuários licenciados não Copilot que têm o pagamento conforme o uso habilitado para a API de recuperação podem usar a ferramenta do SharePoint no Microsoft Foundry por meio do consumo pago conforme o uso.

Para obter mais informações sobre como ativar e desativar o consumo pago conforme o uso da API de recuperação, bem como preços, consulte Visão geral da API de recuperação paga conforme o uso.

Práticas recomendadas

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

• Os resultados e as extrações retornados pela API de recuperação não estão ordenados. Por esse motivo, recomendamos que você não limite o maximumNumberOfResults , a menos que tenha requisitos rígidos de quantos tokens seu LLM pode consumir.
• Envie todas as extrações retornadas pela API de recuperação para seu LLM/orquestrador para geração de respostas.
• Evite consultas genéricas que possam se aplicar a uma ampla variedade de conteúdo.
• Forneça o máximo de contexto possível na consulta.
• Seu queryString deve ser uma única frase.
• Evite erros de ortografia em palavras-chave ricas em contexto ao construir seu queryString.

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

• Se você quiser filtrar usando o parâmetro path no SharePoint ou no OneDrive, não use um link de compartilhamento nem copie a URL da barra de endereços. Em vez disso, vá para o local da pasta ou arquivo no SharePoint ou OneDrive online e escolha os três pontos para abrir Mais Ações. Role para baixo no painel e escolha Detalhes. A partir daí, você pode rolar para baixo no painel de navegação esquerdo para localizar e copiar o caminho.

Limitações conhecidas

A seguir estão a limitação atual e outras limitações para a API de recuperação:

• Você precisa dos Files. Read.All e Sites.Read.All para recuperar o conteúdo do SharePoint usando a API de recuperação.
• Você precisa dos Files. Permissões Read.All e Sites.Read.All para recuperar o conteúdo do OneDrive usando a API de recuperação.
• Você precisa da permissão ExternalItem.Read.All para recuperar o conteúdo dos conectores do Copilot usando a API de recuperação.
• A API de recuperação é otimizada para recuperação de contexto.
• O parâmetro de solicitação queryString tem um limite de 1.500 caracteres.
• Você deve recuperar de uma fonte de dados por vez usando o parâmetro de solicitação dataSource . Não há suporte para resultados intercalados.
• Se o parâmetro de solicitação filterExpression tiver sintaxe KQL incorreta, a consulta será executada com êxito sem escopo.
• Nem todas as propriedades do SharePoint e do OneDrive têm suporte no filterExpression. Para obter uma lista de propriedades com suporte, consulte a referência da API.
• O parâmetro de solicitação maximumNumberOfResults tem um valor máximo de 25.
• O relevanceScore no conteúdo da resposta mede a semelhança de cosseno entre o queryString e a extração, normalizada para o intervalo 0-1.
• É possível que uma extração seja retornada sem um relevanceScore ao recuperar de conectores do Copilot.
• São suportadas até 200 solicitações por usuário por hora.
• A recuperação de texto em tabelas é limitada a arquivos.doc, .docx e .pptx no OneDrive e no SharePoint.
• Não há suporte para a recuperação de conteúdo não textual, incluindo imagens e gráficos.
• Não há suporte para resultados de arquivos com extensões .docx, .pptx e .pdf maiores que 512 MB. Os resultados de arquivos com qualquer outra extensão maior que 150 MB não têm suporte.
• Se estiver recuperando do SharePoint ou OneDrive, a recuperação semântica e a recuperação híbrida só terão suporte para as extensões de arquivo .doc, .docx, .pptx, .pdf, .aspx e .one . Todas as outras extensões de arquivo dão suporte apenas à recuperação lexical.
• A API de recuperação está sujeita a todas as limitações do índice semântico do Microsoft 365 Copilot.
• Se retrievalHits no conteúdo de resposta estiver vazio, nenhum resultado relevante foi encontrado.

Próxima etapa