Descrição geral da API de Obtenção de Microsoft 365 Copilot

As APIs Microsoft 365 Copilot fornecem acesso a componentes que alimentam experiências do Copilot, desbloqueando a capacidade de melhorar os agentes do motor personalizado e soluções de IA geradoras com capacidades de Microsoft 365 Copilot. A API de Obtenção de Microsoft 365 Copilot permite-lhe criar as suas soluções de IA geradoras com os seus conhecimentos do Microsoft 365 e não da Microsoft ao devolver segmentos de texto relevantes do índice híbrido que alimenta Microsoft 365 Copilot.

A API de Obtenção oferece uma solução simplificada para a Geração Aumentada de Obtenção (RAG) sem a necessidade de replicar, indexar, segmentar e proteger os seus dados num índice separado. A API compreende o contexto e a intenção do utilizador e realiza transformações de consulta para produzir os resultados mais relevantes, o que é mais difícil de alcançar com a pesquisa lexical ou até com o RAG básico de origens alternativas.

O RAG é essencial quando está a criar soluções de IA geradoras e quer utilizar conhecimentos do Microsoft 365. Quando implementa o RAG, as suas soluções podem fornecer respostas mais precisas e contextualmente relevantes fundamentadas no vasto repositório dos dados organizacionais. A API de Obtenção realiza o RAG ao extrair fragmentos de texto atualizados e relevantes dos conectores sharePoint, OneDrive e Copilot. A API de Obtenção mantém os seus dados implementados e mantém os seus controlos de acesso e governação. A API de Obtenção garante que as respostas sintetizadas são informadas pelos dados mais recentes e relevantes. Este processo melhora a fiabilidade e a utilidade das suas soluções de IA geradoras.

Para explorar a API, experimente uma consulta no Graph Explorer.

Porquê utilizar a API de Obtenção?

A API de Obtenção oferece uma forma segura e compatível de obter segmentos de texto relevantes dos conectores sharePoint, OneDrive e Copilot ao otimizar a recuperação de contexto. Assim, não precisa de sair dos dados, interromper as permissões ou comprometer a segurança e a conformidade.

As aplicações de conhecimento personalizadas podem utilizar a API de Obtenção para obter respostas básicas em informações específicas da organização armazenadas nos conectores sharePoint, OneDrive e Copilot. Em vez de criar e manter índices de vetores separados, estas aplicações podem, em vez disso, obter o contexto relevante das origens de dados do Microsoft 365 para obter respostas de modelos de linguagem grandes (LLM) terrestres da mesma forma que Microsoft 365 Copilot.

As aplicações financeiras e legais que exigem uma elevada precisão na obtenção de informações podem utilizar as capacidades de filtragem da API para definir o âmbito de pesquisas para bibliotecas de documentos ou tipos de conteúdo específicos, garantindo que as respostas só incluem origens aprovadas, respeitando as barreiras de informação e os controlos de acesso.

As aplicações de várias origens podem combinar conteúdos do SharePoint e/ou do OneDrive com informações de conectores Microsoft 365 Copilot, criando um base de dados de conhecimento unificado que abrange repositórios do Microsoft 365 e de terceiros, mantendo controlos de segurança e conformidade consistentes.

Imagine uma empresa de consultoria especializada no fornecimento de soluções personalizadas para os seus clientes, com uma parte significativa do seu trabalho focado nos dados armazenados no SharePoint. A empresa está a desenvolver um agente de motor personalizado para ajudar os seus consultores a prepararem-se para reuniões de clientes importantes. Este agente tem de aceder e obter informações precisas e atualizadas do SharePoint. A empresa trabalha com dois grandes clientes que são concorrentes directos no mercado. Por conseguinte, a empresa tem uma necessidade crítica de manter normas rigorosas de segurança e conformidade para garantir que os documentos e os dados de um cliente nunca estão acessíveis aos outros. A API de Obtenção ajuda a empresa a gerir os riscos de conformidade e segurança e a garantir a relevância e a atualização dos dados e, por sua vez, simplifica o esforço de desenvolvimento global.

Gerir riscos de conformidade e segurança

A API de Obtenção utiliza as funcionalidades de segurança e conformidade incorporadas no Microsoft 365 para garantir que as permissões da origem de dados e as definições de conformidade são preservadas. Ao obter dados implementados, impede fugas de dados e garante que as informações confidenciais de um cliente nunca estão acessíveis a outro, o que é essencial para manter normas rigorosas de segurança e conformidade. Dentro de uma organização, o modelo de permissões no Microsoft 365 garante que as pessoas só podem obter resultados do conteúdo a que têm permissão para aceder.

Resolver problemas de relevância e atualização

Uma vez que a API de Obtenção obtém contexto relevante sem duplicação de dados, os resultados são mantidos atualizados e relevantes e elimina a necessidade de manter pipelines de dados separados e dispendiosos.

Menor custo de posse e esforço de desenvolvimento

A API de Obtenção elimina a necessidade de criar um pipeline de exportação e indexação de dados seguro que possa incorrer em custos significativos para as organizações. A API suporta as seguintes capacidades necessárias:

• Gestão de fornecedores de pesquisa
• Crawlers
• Conectores de dados
• Armazenamento de dados
• Analisadores de conteúdo
• Indexação
• Segurança

As organizações podem utilizar estas funcionalidades incorporadas para evitar despesas e complexidades e manter rigorosos controlos de acesso e conformidade no Microsoft 365.

Capacidades da API de Obtenção

A API de Obtenção permite-lhe obter dados das seguintes origens de dados:

• SharePoint
• OneDrive
• Conectores do Copilot

A API suporta consultas de linguagem natural e utiliza a pilha de Microsoft 365 Copilot para obter o contexto de base relevante dentro do limite de fidedignidade do Microsoft 365. Pode utilizar a API para definir o âmbito da obtenção com QL por palavra-chave (KQL) para obter a partir do conteúdo mais importante para o seu caso de utilização. Com o KQL, pode filtrar por URLs, intervalos de datas, tipos de ficheiro e muito mais.

Licenciamento

A API de Obtenção está disponível sem custos adicionais para os utilizadores com uma licença de suplemento Microsoft 365 Copilot. O suporte para utilizadores sem uma licença de suplemento Microsoft 365 Copilot não está atualmente disponível.

Ao aceder ou utilizar a API de Obtenção do Microsoft 365 Copilot, está a concordar com os Termos de Utilização (pré-visualização) das APIs Microsoft 365 Copilot.

Práticas recomendadas

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

• Os resultados e extratos devolvidos pela API de Obtenção não são ordenados. Por este motivo, recomendamos que não limite o maximumNumberOfResults , a menos que tenha requisitos rigorosos para o número de tokens que o LLM pode consumir.
• Envie todos os extratos devolvidos pela API de Obtenção para o LLM/orchestrator para a geração de respostas.
• Evite consultas genéricas que possam aplicar-se a uma grande variedade de conteúdos.
• Forneça o máximo de contexto possível na consulta.
• A sua queryString deve ser uma única frase.
• Evite erros ortográficos em palavras-chave ricas em contexto ao construir a sua queryString.

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

• Se quiser filtrar com o parâmetro path no SharePoint ou no OneDrive, não utilize uma ligação de partilha nem copie o URL da barra de endereço. Em vez disso, aceda à localização da pasta ou ficheiro no SharePoint ou oneDrive online e selecione os três pontos para abrir Mais Ações. Desloque-se para baixo no painel e selecione Detalhes. A partir daí, pode deslocar-se para baixo no painel de navegação esquerdo para localizar e copiar o caminho.

Limitações conhecidas

Seguem-se a limitação atual e outras limitações à API de Obtenção:

• Precisa das permissões Files.Read.All e Sites.Read.All para obter conteúdos do SharePoint com a API de Obtenção.
• Precisa das permissões Files.Read.All e Sites.Read.All para obter conteúdos do OneDrive com a API de Obtenção.
• Precisa da permissão ExternalItem.Read.All para obter o conteúdo dos conectores Copilot com a API de Obtenção.
• A API de Obtenção está otimizada para recuperação de contexto.
• O parâmetro de pedido queryString tem um limite de 1500 carateres.
• Tem de obter a partir de uma origem de dados de cada vez com o parâmetro dataSource request. Os resultados intercalados não são suportados.
• Se o parâmetro de pedido filterExpression tiver uma sintaxe KQL incorreta, a consulta é executada com êxito sem âmbito.
• Nem todas as propriedades do SharePoint e do OneDrive são suportadas no filterExpression. Para obter uma lista das propriedades suportadas, veja a Referência da API.
• O parâmetro de pedido maximumNumberOfResults tem um valor máximo de 25.
• O relevanceScore no payload de resposta mede a semelhança do cosseno entre a queryString e a extração, normalizada para o intervalo 0-1.
• É possível que um extrato seja devolvido sem um relevânciaScore ao obter a partir de conectores Copilot.
• São suportados até 200 pedidos por utilizador por hora.
• A obtenção de texto em tabelas está limitada a ficheiros.doc, .docx e .pptx no OneDrive e no SharePoint.
• A obtenção de conteúdos não textuais, incluindo imagens e gráficos, não é suportada.
• Os resultados de ficheiros com extensões de .docx, .pptx e .pdf superiores a 512 MB não são suportados. Os resultados de ficheiros com qualquer outra extensão com mais de 150 MB não são suportados.
• Se estiver a obter a partir do SharePoint ou do OneDrive, a obtenção semântica e a obtenção híbrida só são suportadas para extensões de ficheiros.doc, .docx, .pptx, .pdf, .aspx e .one . Todas as outras extensões de ficheiro só suportam a obtenção lexical.
• A API de Obtenção está sujeita a todas as limitações do índice semântico Microsoft 365 Copilot.
• Se retrievalHits no payload de resposta estiver vazio, não foram encontrados resultados relevantes.

Próxima etapa