API-Referenz

Vollständige Liste der verfügbaren API-Routen für Communications Mining, geordnet nach Ressourcentyp.

Alle verfügbaren API-Routen sind in den folgenden Tabellen aufgeführt:

Verwalten von Quellen

Method	URL	Beschreibung
Abrufen	/api/v1/sources	Metadaten zu allen zugänglichen Quellen abrufen
Abrufen	/api/v1/sources/<project>	Metadaten zu allen Quellen in einem Projekt abrufen
Abrufen	/api/v1/sources/<project>/<source_name>	Metadaten zu einer Quelle nach Namen abrufen
Abrufen	/api/v1/sources/id:<source_id>	Metadaten zu einer Quelle nach ID abrufen
PUT	/api/v1/sources/<project>/<source_name>	Erstellen Sie eine Quelle
Posten	/api/v1/sources/<project>/<source_name>	Aktualisieren Sie eine Quelle
Löschen	/api/v1/sources/id:<source_id>	Löschen Sie eine Quelle nach ID

Verwalten von Datasets

Method	URL	Beschreibung
Abrufen	/api/v1/datasets	Rufen Sie Metadaten zu allen zugänglichen Datasets ab
Abrufen	/api/v1/datasets/<project>	Rufen Sie Metadaten zu allen Datasets in einem Projekt ab
Abrufen	/api/v1/datasets/<project>/<dataset_name>	Metadaten zu einem Dataset nach Namen abrufen
PUT	/api/v1/datasets/<project>/<dataset_name>	Erstellen Sie ein Dataset
Posten	/api/v1/datasets/<project>/<dataset_name>	Aktualisieren Sie ein Dataset
Löschen	/api/v1/datasets/<project>/<dataset_name>	Löschen Sie ein Dataset nach Namen
Posten	/api/v1/datasets/<project>/<dataset_name>/export	Exportieren Sie ein Dataset nach Namen

Kommentare werden hochgeladen

Method	URL	Beschreibung
Posten	/api/v1/sources/<project>/<source_name>/sync	Erstellen oder aktualisieren Sie Kommentare
Posten	/api/v1/sources/<project>/<source_name>/sync-raw-emails	Erstellen oder aktualisieren Sie Kommentare aus unformatierten E-Mails

Verwalten von Kommentaren

Method	URL	Beschreibung
Abrufen	/api/v1/sources/<project>/<source_name>/comments/<comment_id>	Kommentar nach ID abrufen
Abrufen	/api/v1/sources/<project>/<source_name>/threads?id=<thread_id0>[&id=<thread_id1>...]	Kommentare nach Thread-ID abrufen
Löschen	/api/v1/sources/<project>/<source_name>/comments?id=<comment_id0>[&id=<comment_id1>...]	Kommentare nach ID löschen

Anhänge werden abgerufen

Method	URL	Beschreibung
Abrufen	/api/v1/attachments/<attachment_reference>	Anhangsinhalt durch Verweis abrufen

Abrufen von Vorhersagen und Modellstatistiken

Method	URL	Beschreibung
Abrufen	/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/validation	Rufen Sie Modellstatistiken ab
Posten	/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict	Vorhersagen abrufen
Posten	/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-comments	Rufen Sie Vorhersagen nach Kommentar-ID ab
Posten	/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-raw-emails	Abrufen von Vorhersagen für unformatierte E-Mails

Abrufen von Vorhersagen mit Stream-API

Method	URL	Beschreibung
Abrufen	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>	Rufen Sie einen Stream nach Namen ab
Abrufen	/api/v1/datasets/<project>/<dataset_name>/streams	Rufen Sie alle Streams ab
PUT	/api/v1/datasets/<project>/<dataset_name>/streams	Erstellen Sie einen Stream
PUT	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/exceptions	Kennzeichnen Sie eine Ausnahme
Posten	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>	Aktualisieren Sie einen Stream
Abrufen	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/results	Ergebnisse aus einem Stream abrufen
Posten	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/fetch	Kommentare aus einem Stream abrufen (Legacy)
Posten	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/advance	Bringen Sie einen Stream vor
Posten	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/reset	Einen Stream zurücksetzen
Löschen	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>	Löschen Sie einen Stream
Löschen	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/exceptions	Entfernen Sie das Tag einer Ausnahme

Abfragen von Prüfungsereignissen mit der Prüfungsereignisse-API

Method	URL	Beschreibung
Posten	/api/v1/audit_events/query	Abfrage-Prüfungsereignisse.