API 参考

下表列出了所有可用的 API 路由：

管理来源

方法	URL	描述
获取	/api/v1/sources	检索有关所有可访问来源的元数据
获取	/api/v1/sources/<project>	检索有关项目中所有来源的元数据
获取	/api/v1/sources/<project>/<source_name>	按名称检索有关来源的元数据
获取	/api/v1/sources/id:<source_id>	按 ID 检索有关来源的元数据
放置	/api/v1/sources/<project>/<source_name>	创建来源
发布	/api/v1/sources/<project>/<source_name>	更新来源
删除	/api/v1/sources/id:<source_id>	按 ID 删除来源

管理数据集

方法	URL	描述
获取	/api/v1/datasets	检索有关所有可访问数据集的元数据
获取	/api/v1/datasets/<project>	检索有关项目中所有数据集的元数据
获取	/api/v1/datasets/<project>/<dataset_name>	按名称检索有关数据集的元数据
放置	/api/v1/datasets/<project>/<dataset_name>	创建数据集
发布	/api/v1/datasets/<project>/<dataset_name>	更新数据集
删除	/api/v1/datasets/<project>/<dataset_name>	按名称删除数据集
发布	/api/v1/datasets/<project>/<dataset_name>/export	按名称导出数据集

正在上传注释

方法	URL	描述
发布	/api/v1/sources/<project>/<source_name>/sync	创建或更新注释
发布	/api/v1/sources/<project>/<source_name>/sync-raw-emails	创建或更新原始电子邮件中的注释

管理注释

方法	URL	描述
获取	/api/v1/sources/<project>/<source_name>/comments/<comment_id>	按 ID 检索注释
获取	/api/v1/sources/<project>/<source_name>/threads?id=<thread_id0>[&id=<thread_id1>...]	按会话 ID 检索注释
删除	/api/v1/sources/<project>/<source_name>/comments?id=<comment_id0>[&id=<comment_id1>...]	按 ID 删除注释

获取附件

方法	URL	描述
获取	/api/v1/attachments/<attachment_reference>	通过引用检索附件内容

正在获取预测和模型统计信息

方法	URL	描述
获取	/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/validation	获取模型统计信息
发布	/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict	获取预测
发布	/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-comments	按注释 ID 获取预测
发布	/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-raw-emails	获取原始电子邮件的预测

使用流 API 获取预测

方法	URL	描述
获取	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>	按名称获取流
获取	/api/v1/datasets/<project>/<dataset_name>/streams	获取所有流
放置	/api/v1/datasets/<project>/<dataset_name>/streams	创建流
放置	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/exceptions	标记异常
发布	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>	更新流
获取	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/results	从流中获取结果
发布	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/fetch	从流中获取注释（旧版）
发布	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/advance	推进流
发布	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/reset	重置流
删除	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>	删除流
删除	/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/exceptions	取消异常标记

使用审核事件 API 查询审核事件

方法	URL	描述
发布	/api/v1/audit_events/query	查询审核事件。