本产品(
RAI/2024-07-01)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
安全专家模型管理
| API | 标题 | API概述 |
|---|---|---|
| ListModelCategory | 查询模型类别列表 | 查询模型类别列表。 |
| CreateModelInstance | 创建模型实例 | 创建模型实例。 |
| UpdateModelInstance | 更新模型实例 | 更新模型实例。 |
| ListModelInstance | 查询模型实例列表 | 查询模型实例列表。 |
| GetModelInstanceInfo | 获取模型实例信息 | 获取模型实例信息。 |
| DeleteModelInstance | 删除模型实例 | 删除模型实例。 |
在线数据毒性检测
| 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概述 |
|---|---|---|
| CreateTopic | 创建敏感主题 | 创建敏感主题 |
| UpdateTopic | 更新敏感主题 | 更新敏感主题 |
| ListTopic | 查询敏感主题列表 | 查询敏感主题列表 |
| GetTopic | 查询敏感主题信息 | 查询敏感主题信息 |
| DeleteTopic | 删除敏感主题 | 删除敏感主题 |
离线数据毒性检测
| API | 标题 | API概述 |
|---|---|---|
| ContentSyncDetect | 单条内容同步检测 | 单条内容同步检测。 |
| ContentAsyncDetect | 单条内容异步检测 | 单条内容异步检测。 |
| GetContentDetectResult | 查询异步检测结果 | 查询异步检测结果。 |
| BatchContentSyncDetect | 批量内容同步检测 | 批量内容同步检测。 |
| BatchContentAsyncDetect | 批量内容异步检测 | 批量内容异步检测。 |
服务开通
| API | 标题 | API概述 |
|---|---|---|
| RegisterAccount | 账号开通 | 新用户开通服务,如果用户未开通则进行开通。 |
| CheckAccount | 检查账号状态 | 检查用户是否已开通服务,返回该账户的状态。 |