API リファレンス

利用可能なすべての API ルートを以下の表に示します。

ソースを管理する

メソッド	URL	説明
GET	/api/v1/sources	アクセス可能なすべてのソースに関するメタデータを取得する
GET	/api/v1/sources/<project>	プロジェクト内のすべてのソースに関するメタデータを取得する
GET	/api/v1/sources/<project>/<source_name>	ソースに関するメタデータを名前で取得する
GET	/api/v1/sources/id:<source_id>	ソースに関するメタデータを ID で取得する
PUT	/api/v1/sources/<project>/<source_name>	ソースを作成する
POST	/api/v1/sources/<project>/<source_name>	ソースを更新する
DELETE	/api/v1/sources/id:<source_id>	ID でソースを削除する

データセットを管理する

メソッド	URL	説明
GET	/api/v1/datasets	アクセス可能なすべてのデータセットに関するメタデータを取得する
GET	/api/v1/datasets/<project>	プロジェクト内のすべてのデータセットに関するメタデータを取得する
GET	/api/v1/datasets/<project>/<dataset_name>	データセットに関するメタデータを名前で取得する
PUT	/api/v1/datasets/<project>/<dataset_name>	データセットを作成する
POST	/api/v1/datasets/<project>/<dataset_name>	データセットを更新する
DELETE	/api/v1/datasets/<project>/<dataset_name>	データセットを名前で削除する
POST	/api/v1/datasets/<project>/<dataset_name>/export	データセットを名前でエクスポートする

コメントをアップロードする

メソッド	URL	説明
POST	/api/v1/sources/<project>/<source_name>/sync	コメントを作成または更新する
POST	/api/v1/sources/<project>/<source_name>/sync-raw-emails	未加工のメールからコメントを作成または更新する

コメントを管理する

メソッド	URL	説明
GET	/api/v1/sources/<project>/<source_name>/comments/<comment_id>	ID でコメントを取得する
DELETE	/api/v1/sources/<project>/<source_name>/messages?id=<message_id0>[&id=<message_id1>...]	ID でコメントを削除する

予測とモデルの統計情報を取得する

メソッド	URL	説明
GET	/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/validation	モデルの統計情報を取得する
POST	/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict	予測を取得する
POST	/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-comments	コメント ID で予測を取得する
POST	/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-raw-emails	未加工のメールの予測を取得する

Stream API を使用して予測を取得する

メソッド	URL	説明
GET	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>	名前でストリームを取得する
GET	/api/v1/datasets/<project>/<dataset_name>/streams	すべてのストリームを取得する
PUT	/api/v1/datasets/<project>/<dataset_name>/streams	ストリームを作成する
PUT	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/exceptions	例外にタグを付ける
POST	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>	ストリームを更新する
POST	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/fetch	ストリームからコメントを取得する
POST	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/advance	ストリームを前進させます。
POST	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/reset	ストリームをリセットする
DELETE	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>	ストリームを削除する
DELETE	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/exceptions	例外のタグを解除する

Audit Events API を使用して監査イベントをクエリする

メソッド	URL	説明
POST	/api/v1/audit_events/query	監査イベントを照会する