Übersicht über die Microsoft 365 Copilot Retrieval-API

Die Microsoft 365 Copilot-APIs bieten Zugriff auf Komponenten, die Copilot-Erfahrungen unterstützen, und eröffnen die Möglichkeit, Ihre benutzerdefinierten Engine-Agents und generativen KI-Lösungen mit Microsoft 365 Copilot-Funktionen zu verbessern. Mit der Microsoft 365 Copilot Retrieval-API können Sie Ihre generativen KI-Lösungen mit Ihrem Microsoft 365- und Nicht-Microsoft-Wissen verankern, indem Sie relevante Textblöcke aus dem Hybridindex zurückgeben, der Microsoft 365 Copilot unterstützt.

Die Retrieval API bietet eine optimierte Lösung für Retrieval Augmented Generation (RAG), ohne dass Sie Ihre Daten in einem separaten Index replizieren, indizieren, segmentieren und sichern müssen. Die API versteht den Kontext und die Absicht des Benutzers und führt Abfragetransformationen durch, um die relevantesten Ergebnisse zu liefern, was mit der lexikalischen Suche oder sogar grundlegenden RAG-Dateien aus alternativen Quellen schwieriger zu erreichen ist.

RAG ist unerlässlich, wenn Sie generative KI-Lösungen erstellen und Microsoft 365 Wissen verwenden möchten. Wenn Sie RAG implementieren, können Ihre Lösungen genauere, kontextbezogene Antworten liefern, die auf dem riesigen Repository Ihrer Unternehmensdaten basieren. Die Retrieval-API führt die RAG durch, indem sie aktuelle und relevante Textausschnitte aus SharePoint-, OneDrive- und Copilot-Connectors extrahiert. Die Retrieval-API hält Ihre Daten an Ort und Stelle und unterstützt Ihre Zugriffs- und Governancekontrollen. Die Retrieval-API stellt sicher, dass synthetisierte Antworten auf die neuesten und relevantesten Daten basieren. Dieser Prozess verbessert die Zuverlässigkeit und Nützlichkeit Ihrer generativen KI-Lösungen.

Um die API zu erkunden, probieren Sie eine Abfrage in der interaktiven Demo aus.

Tipp

Möchten Sie die Retrieval-API erkunden, bevor Sie Code schreiben? Probieren Sie die interaktive Demo aus, um eine Liveanforderung und Antwort mit Ihren Microsoft 365-Daten anzuzeigen.

Gründe für die Verwendung der Retrieval-API

Die Retrieval-API bietet eine sichere und konforme Möglichkeit zum Abrufen relevanter Textblöcke aus SharePoint-, OneDrive- und Copilot-Connectors und optimiert gleichzeitig den Kontextabruf. Daher müssen Sie keine Daten abgeben, keine Berechtigungen aufheben oder Kompromisse bei Sicherheit und Compliance eingehen.

Benutzerdefinierte Wissensanwendungen können die Retrieval-API verwenden, um Antworten auf organisationsspezifische Informationen zu stützen, die in SharePoint-, OneDrive- und Copilot-Connectors gespeichert sind. Anstatt separate Vektorindizes zu erstellen und zu verwalten, können diese Anwendungen stattdessen relevanten Kontext aus Microsoft 365-Datenquellen abrufen, um Antworten mit großen Sprachmodellen (LLM) auf die gleiche Weise wie Microsoft 365 Copilot zu stützen.

Finanz- und Rechtsanwendungen, die eine hohe Genauigkeit beim Abrufen von Informationen erfordern, können die Filterfunktionen der API nutzen, um Suchvorgänge auf bestimmte Dokumentbibliotheken oder Inhaltstypen einzugrenzen, um sicherzustellen, dass die Antworten nur genehmigte Quellen umfassen und gleichzeitig Informationsbarrieren und Zugriffskontrollen beachtet werden.

Multi-Source-Anwendungen können SharePoint- und OneDrive-Inhalte mit Informationen aus Microsoft 365 Copilot-Connectors kombinieren und so eine einheitliche Wissensdatenbank schaffen, die sowohl Microsoft 365- als auch Drittanbieter-Repositorys umfasst und gleichzeitig konsistente Sicherheits- und Compliancekontrollen gewährleistet.

Stellen Sie sich ein Beratungsunternehmen vor, das sich darauf spezialisiert hat, seinen Kunden maßgeschneiderte Lösungen anzubieten, wobei sich ein erheblicher Teil seiner Arbeit auf in SharePoint gespeicherte Daten konzentriert. Das Unternehmen entwickelt einen kundenspezifischen Engine-Agenten, der seine Berater bei der Vorbereitung wichtiger Kundengespräche unterstützt. Dieser Agent muss auf genaue und aktuelle Informationen in SharePoint zugreifen und diese abrufen. Die Kanzlei arbeitet mit zwei großen Kunden zusammen, die direkte Konkurrenten auf dem Markt sind. Daher muss das Unternehmen unbedingt strenge Sicherheits- und Compliance-Standards einhalten, um sicherzustellen, dass die Dokumente und Daten eines Kunden für den anderen niemals zugänglich sind. Die Retrieval API hilft dem Unternehmen, Compliance- und Sicherheitsrisiken zu managen und die Relevanz und Aktualität der Daten sicherzustellen, was wiederum den gesamten Entwicklungsaufwand vereinfacht.

Verwalten von Compliance- und Sicherheitsrisiken

Die Retrieval-API verwendet die integrierten Sicherheits- und Compliancefeatures in Microsoft 365, um sicherzustellen, dass die Datenquellenberechtigungen und Konformitätseinstellungen erhalten bleiben. Durch das Abrufen von Daten an Ort und Stelle werden Datenlecks verhindert und sichergestellt, dass vertrauliche Informationen von einem Client niemals für einen anderen zugänglich sind, was für die Einhaltung strenger Sicherheits- und Compliancestandards unerlässlich ist. Innerhalb einer organization stellt das Berechtigungsmodell in Microsoft 365 sicher, dass Einzelpersonen nur Ergebnisse aus den Inhalten erzielen können, auf die sie zugreifen dürfen.

Ermitteln von Relevanz und Aktualität

Da die Retrieval-API relevanten Kontext ohne Datenduplizierung abruft, bleiben die Ergebnisse aktuell und relevant, und es entfällt die Notwendigkeit, separate, kostspielige Datenpipelines zu unterhalten.

Geringere Betriebskosten und geringerer Entwicklungsaufwand

Die Retrieval-API macht den Aufbau einer sicheren Datenexport- und Indizierungspipeline überflüssig, was für Organisationen erhebliche Kosten verursachen kann. Die API unterstützt die folgenden erforderlichen Funktionen:

  • Verwaltung des Suchanbieters
  • Crawlers
  • Datenconnectors
  • Datenspeicher
  • Inhaltsanalysegeräte
  • Indizierung
  • Sicherheit

Organisationen können diese integrierten Features verwenden, um Kosten und Komplexität zu vermeiden und strenge Zugriffskontrollen und Compliance innerhalb von Microsoft 365 aufrechtzuerhalten.

API-Funktionen für den Abruf

Mit der Retrieval-API können Sie Daten aus den folgenden Datenquellen abrufen:

  • SharePoint
  • OneDrive
  • Copilot-Connectors

Die API unterstützt Abfragen in natürlicher Sprache und verwendet den Microsoft 365 Copilot-Stapel, um relevanten Grundlagenkontext innerhalb der Microsoft 365-Vertrauensgrenze abzurufen. Sie können die API verwenden, um Ihren Abruf mithilfe der Keyword Query Language (KQL) zu begrenzen, um die wichtigsten Inhalte für Ihren Anwendungsfall abzurufen. Mit KQL können Sie nach URLs, Datumsbereichen, Dateitypen und mehr filtern.

Lizenzierung

Die Retrieval-API ist für Benutzer mit einer Microsoft 365 Copilot Add-On-Lizenz ohne zusätzliche Kosten verfügbar. Durch den Zugriff auf oder die Verwendung der Microsoft 365 Copilot Retrieval-API stimmen Sie den Nutzungsbedingungen für Microsoft 365 Copilot-APIs (Vorschau) zu.

Für Benutzer ohne zusätzliche Microsoft 365 Copilot-Add-On-Lizenz ist die Retrieval-API über den nutzungsbasierten Verbrauch (Vorschau) für Datenquellen auf Mandantenebene wie SharePoint und Copilot-Connectors verfügbar. Datenquellen auf Benutzerebene wie OneDrive sind nicht verfügbar.

Hinweis

Der Verbrauch der Abruf-API mit nutzungsbasierter Bezahlung ist derzeit ein Vorschaufeature. Wenn Sie auf den Verbrauch der Microsoft 365 Copilot Retrieval API mit nutzungsbasierter Bezahlung zugreifen oder diesen verwenden, stimmen Sie den Nutzungsbedingungen für die Microsoft 365 Copilot Retrieval API mit nutzungsbasierter Bezahlung (Vorschau) zu.

Benutzer ohne Copilot-Lizenz, die die nutzungsbasierte Bezahlung für die Retrieval-API aktiviert haben, können das SharePoint-Tool in Microsoft Foundry über den nutzungsbasierten Verbrauch verwenden.

Weitere Informationen zum Aktivieren und Deaktivieren des nutzungsbasierten Verbrauchs der Retrieval-API sowie zu den Preisen finden Sie unter Übersicht über die nutzungsbasierte Nutzungsbasierte Nutzung der Retrieval-API.

Bewährte Methoden

Die folgenden bewährten Methoden gelten sowohl für ungefilterte Abfragen (Abfragen ohne filterExpression) als auch für gefilterte Abfragen (Abfragen mit einem filterExpression):

  • Die Ergebnisse und Extrakte, die von der Retrieval-API zurückgegeben werden, sind ungeordnet. Aus diesem Grund empfehlen wir, dass Sie die maximale Anzahl der Ergebnisse nicht einschränken, es sei denn, Sie haben strenge Anforderungen daran, wie viele Token Ihr LLM nutzen kann.
  • Senden Sie alle von der Abruf-API zurückgegebenen Auszüge zur Antwortgenerierung an Ihr LLM/Ihren Orchestrator.
  • Vermeiden Sie allgemeine Abfragen, die für eine Vielzahl von Inhalten gelten können.
  • Geben Sie so viel Kontext wie möglich in die Abfrage.
  • Ihr queryString sollte aus einem einzigen Satz bestehen.
  • Vermeiden Sie Rechtschreibfehler in kontextreichen Schlüsselwörtern, wenn Sie Ihre queryString erstellen.

Wenden Sie die folgenden bewährten Methoden auf gefilterte Abfragen (Abfragen mit einem filterExpression) an:

  • Wenn Sie mithilfe des Pfadparameters in SharePoint oder OneDrive filtern möchten, verwenden Sie keinen Freigabelink, und kopieren Sie die URL nicht aus der Adressleiste. Navigieren Sie stattdessen zum Speicherort des Ordners oder der Datei in SharePoint oder OneDrive online, und wählen Sie die drei Punkte aus, um Weitere Aktionen zu öffnen. Scrollen Sie im Bereich nach unten, und wählen Sie "Details" aus. Von dort aus können Sie im linken Navigationsbereich nach unten scrollen, um den Pfad zu suchen und zu kopieren.

Bekannte Einschränkungen

Im Folgenden finden Sie die aktuellen Einschränkungen für die Drosselung und andere Einschränkungen für die Retrieval-API:

  • You need the Files. Berechtigungen "Read.All" und "Sites.Read.All" zum Abrufen von SharePoint-Inhalten mithilfe der Retrieval-API.
  • You need the Files. Read.All und Sites.Read.All zum Abrufen von OneDrive-Inhalten mithilfe der Retrieval-API.
  • Sie benötigen die Berechtigung ExternalItem.Read.All , um Copilot-Connectors-Inhalte mithilfe der Retrieval-API abzurufen.
  • Die Retrieval-API ist für den Kontextabruf optimiert.
  • Der queryString-Anforderungsparameter hat ein Limit von 1.500 Zeichen.
  • Sie müssen jeweils aus einer Datenquelle abrufen, indem Sie den DataSource-Anforderungsparameter verwenden . Verschachtelte Ergebnisse werden nicht unterstützt.
  • Wenn der filterExpression-Anforderungsparameter eine falsche KQL-Syntax aufweist, wird die Abfrage erfolgreich ohne Bereichsdefinition ausgeführt.
  • Nicht alle SharePoint- und OneDrive-Eigenschaften werden in filterExpression unterstützt. Eine Liste der unterstützten Eigenschaften finden Sie in der API-Referenz.
  • Der Anforderungsparameter maximumNumberOfResults hat den Maximalwert 25.
  • Der relevanceScore in der Antwortnutzlast misst die Kosinusähnlichkeit zwischen queryString und Extrakt, normalisiert auf den Bereich 0-1.
  • Es ist möglich, dass ein Extrakt beim Abrufen von Copilot-Connectors ohne relevanceScore zurückgegeben wird.
  • Bis zu 200 Anforderungen pro Benutzer und Stunde werden unterstützt.
  • Das Abrufen von Text in Tabellen ist auf .doc-, .docx- und .pptx Dateien in OneDrive und SharePoint beschränkt.
  • Das Abrufen von nicht textuellen Inhalten, einschließlich Bildern und Diagrammen, wird nicht unterstützt.
  • Ergebnisse von Dateien mit .docx-, .pptx- und .pdf-Erweiterungen, die größer als 512 MB sind, werden nicht unterstützt. Ergebnisse von Dateien mit einer anderen Erweiterung, die größer als 150 MB sind, werden nicht unterstützt.
  • Beim Abrufen von SharePoint oder OneDrive werden das semantische Abrufen und das Hybridabrufen nur für .doc-, .docx-, .pptx-, .pdf-, .aspx- und . one-Dateierweiterungen unterstützt. Alle anderen Dateierweiterungen unterstützen nur lexikalisches Retrieval.
  • Die Retrieval-API unterliegt allen Einschränkungen des semantischen Index von Microsoft 365 Copilot.
  • Wenn retrievalHits in der Antwortnutzlast leer ist, wurden keine relevanten Ergebnisse gefunden.

Nächster Schritt