Microsoft Syntex unstrukturierten Dokumentverarbeitungsmodell-REST-API
Sie können die SharePoint-REST-Schnittstelle verwenden, um ein unstrukturiertes Dokumentverarbeitungsmodell zu erstellen, das Modell auf eine oder mehrere Bibliotheken anzuwenden oder zu entfernen und Informationen zum Modell abzurufen oder zu aktualisieren.
Der REST-Dienst in SharePoint Online (sowie in lokalen Bereitstellungen von SharePoint 2016 und höher) erlaubt die Zusammenfassung mehrerer Anforderungen in einem einzigen Aufruf an den Service mittels der ODATA-Abfrageoption „$batch“.
Einzelheiten und Links zu Codebeispielen finden Sie unter Durchführen von Batchanforderungen mit den REST-APIs.
Voraussetzungen
Lesen Sie vor der Umsetzung der Beispiele in diesem Artikel zunächst die folgenden Artikel:
- Grundlegendes zum SharePoint-REST-Dienst
- Ausführen grundlegender Vorgänge unter Verwendung von SharePoint-REST-Endpunkten
REST-Befehle
Die folgenden REST-Befehle sind für die Arbeit mit syntex unstrukturierten Dokumentverarbeitungsmodellen verfügbar:
- Modell erstellen – Erstellt ein Modell und den zugehörigen Inhaltstyp.
- GetByUniqueId : Ruft Informationen zu einem unstrukturierten Syntex-Dokumentverarbeitungsmodell ab oder aktualisiert sie.
- GetByTitle : Ruft Informationen zu einem unstrukturierten Syntex-Dokumentverarbeitungsmodell unter Verwendung des Modelltitels ab oder aktualisiert sie.
- Modell anwenden : Wendet ein trainiertes unstrukturiertes Dokumentverarbeitungsmodell auf eine oder mehrere Bibliotheken an (oder synchronisiert es).
- Modell- und Bibliotheksinformationen abrufen – Ruft Informationen ab über das Modell und die Bibliothek, auf die es angewendet wurde.
- UpdateModelSettings: Aktualisierungen verfügbaren Modelleinstellungen (zugehörige Aufbewahrungsbezeichnung und Modellbeschreibung) für ein unstrukturiertes Syntex-Dokumentverarbeitungsmodell.
- BatchDelete : Entfernt ein angewendetes unstrukturiertes Dokumentverarbeitungsmodell aus einer oder mehreren Bibliotheken.
- Erstellen einer Dateiklassifizierungsanforderung – Erstellt eine Anforderung zur Klassifizierung einer bestimmten Datei oder bestimmter Dateien mittels dem angewendeten Modell.
- Erstellen einer Ordnerklassifizierungsanforderung – Erstellt eine Anforderung zum Klassifizieren eines gesamten Ordners mithilfe des angewendeten Modells.
Szenarien
Beachten Sie die folgenden Szenario-Beispiele, die sich nicht intuitiv aus dem Methodennamen ergeben. Weitere Informationen finden Sie im jeweiligen Artikel.
Die Methode „Modell erstellen“ erstellt nur das Modellobjekt und den zugehörigen Inhaltstyp. Sie müssen das Modell zuerst im Inhaltscenter trainieren, bevor es auf eine Bibliothek angewendet werden kann.
Die Methode „Modell anwenden“ wird verwendet, um das Modell auf der Zielbibliothek zu konfigurieren, um Dokumente zu klassifizieren und optional zusätzliche Informationen zu extrahieren. Diese API unterstützt auch die Batch-Anwendung des Modells auf mehrere Bibliotheken.
Die Methode „Modell entfernen“ entfernt das Modell nur von einer oder mehreren Bibliotheken, auf die es zuvor angewendet wurde. Wenn Sie das Modell löschen wollen, müssen Sie es zuerst aus allen Bibliotheken entfernen, auf die es angewendet wurde.