SharePoint Syntex-Dokumentverständnismodell-REST-API

Sie können die SharePoint-REST-Schnittstelle verwenden, um eine Dokumentverständnismodell zu erstellen, das Modell auf eine oder mehrere Bibliotheken anzuwenden oder es von diesen zu entfernen, und um Informationen über das Modell zu erhalten 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:

REST-Befehle

Die folgenden REST-Befehle stehen für die Arbeit mit Syntex-Dokumentverständnismodellen zur Verfügung:

  • Modell erstellen – Erstellt ein Modell und den zugehörigen Inhaltstyp.
  • GetByUniqueId – Ruft Informationen zu einem SharePoint Syntex-Dokumentverständnismodell ab oder aktualisiert diese.
  • GetByTitle – Ruft Informationen zu einem SharePoint Syntex-Dokumentverständnismodell mittels dem Modelltitel ab oder aktualisiert diese.
  • Modell anwenden – Wendet ein trainiertes Dokumentverständnismodell 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 – Aktualisiert verfügbare Modelleinstellungen (zugehörige Aufbewahrungsbezeichnung und Modellbeschreibung) für eine SharePoint Syntex-Dokumentverständnismodell.
  • BatchDelete – Entfernt ein angewendetes Dokumentverständnismodell von 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.

Siehe auch

Übersicht über das Dokumentenverständnis