API概览

本产品(RAI/2024-07-01)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

在线数据毒性检测

API标题API概述
ModelInputContentSyncDetect模型输入内容同步检测对模型的输入内容进行同步检测,同步获取检测结果
ModelOutputContentSyncDetect模型输出内容同步检测对模型的输出内容进行同步检测,同步获取检测结果
ModelInputContentAsyncDetect模型输入内容异步检测对模型的输入内容进行异步检测,通过任务标识异步获取检测结果
ModelOutputContentAsyncDetect模型输出内容异步检测对模型的输出内容进行异步检测,通过任务标识异步获取检测结果
GetModelInputContentDetectResult获取模型输入内容检测结果通过任务标识获取模型输入内容异步检测结果
GetModelOutputContentDetectResult获取模型输出内容检测结果通过任务标识获取模型输出内容异步检测结果

在线检测策略管理

API标题API概述
GetPolicyDefaultOptions查询检测策略默认选项查询检测策略默认选项
CreatePolicy创建检测策略创建检测策略
UpdatePolicy更新检测策略更新检测策略
ListPolicy查询检测策略列表查询检测策略列表。
GetPolicyInfo查询检测策略详情查询检测策略详情
DeletePolicy删除检测策略删除检测策略

在线关键词管理

API标题API概述
CreateWordGroup创建关键词策略创建关键词策略
UpdateWordGroup更新关键词策略更新关键词策略。
ListWordGroup查询关键词策略列表查询关键词策略列表。
GetWordGroup查询关键词策略详情查询关键词策略详情。
DeleteWordGroup删除关键词策略删除关键词策略。

离线数据毒性检测

API标题API概述
ContentSyncDetect单条内容同步检测单条内容同步检测。
ContentAsyncDetect单条内容异步检测单条内容异步检测。
GetContentDetectResult查询异步检测结果查询异步检测结果。
BatchContentSyncDetect批量内容同步检测批量内容同步检测。
BatchContentAsyncDetect批量内容异步检测批量内容异步检测。

服务开通

API标题API概述
RegisterAccount账号开通新用户开通服务,如果用户未开通则进行开通。
CheckAccount检查账号状态检查用户是否已开通服务,返回该账户的状态。