创建自定义代答库
功能介绍
创建自定义代答库
URI
POST /v1/{project_id}/aiguard/custom-answers
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于指定操作所属的项目。 约束限制: 必填,字符串类型。 取值范围: 通过调用IAM服务获取的projectId值。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于身份认证和权限验证,通过调用IAM服务的用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必填,字符串类型,必须为有效的未过期Token。 取值范围: 不涉及。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 请求体内容类型,用于指定本次请求的数据格式。 约束限制: 必填,字符串类型。 取值范围: application/json;charset=utf-8。 默认取值: application/json;charset=utf-8。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 代答库名称,同一项目下唯一。 约束限制: 必填,字符串类型,不能为空白字符,最大长度128个字符。 取值范围: 只能包含字母、数字、中文、下划线、连字符、括号、@、#、/、|、冒号、全角冒号,首尾不能为空格。 默认取值: 不涉及。 |
| description | 否 | String | 参数解释: 代答库描述。 约束限制: 可选,字符串类型,最大长度1024个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| answers | 是 | Array of strings | 参数解释: 答案列表。 约束限制: 必填,数组类型,最多100个元素。 取值范围: 数组元素为字符串类型,每个元素最大长度1000个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 代答库ID。 取值范围: 不涉及。 |
| name | String | 参数解释: 代答库名称。 取值范围: 不涉及。 |
| description | String | 参数解释: 代答库描述。 取值范围: 最大1024个字符。 |
| answers | Array of strings | 参数解释: 答案列表(按seq排序)。 取值范围: 数组元素为字符串类型。 |
| referenced_rules | Array of ReferencedRule objects | 参数解释: 引用的规则列表。 取值范围: 数组元素为ReferencedRule对象。 |
| create_time | Long | 参数解释: 创建时间。 取值范围: 毫秒时间戳,int64格式。 |
| update_time | Long | 参数解释: 更新时间。 取值范围: 毫秒时间戳,int64格式。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| rule_id | String | 参数解释: 规则ID。 取值范围: 不涉及。 |
| rule_name | String | 参数解释: 规则名称。 取值范围: 不涉及。 |
| policy_id | String | 参数解释: 引用该代答库的规则所属策略ID。 取值范围: 不涉及。 |
| policy_name | String | 参数解释: 引用该代答库的规则所属策略名称。 取值范围: 不涉及。 |
| detect_opts_type | String | 参数解释: 规则检测选项类型。 取值范围: supported_language(语言检测), immunity_lexicon(豁免词配置),lexicon(关键词词库检测), compliance(内容合规检测), inject(提示词注入检测), pii(敏感信息检测), abuse(算力消耗检测), topic_detect(话题控制) |
请求示例
无
响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 操作成功 |
错误码
请参见错误码。