API概览

API标准及多语言预置SDK

本产品(RAI/2024-07-01)的 OpenAPI 采用 RPC 签名机制,具体签名方式请参见签名机制说明我们已为开发者封装了主流编程语言的 SDK,您可通过 下载 SDK 快速调用 API,无需关注签名等底层实现细节,显著降低开发门槛与集成复杂度。

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的 RAM 用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

安全专家模型管理

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检查账号状态检查用户是否已开通服务,返回该账户的状态。