GetAgentProfileTemplate - 获取智能体配置模版

更新时间:2025-03-12 08:26:43

获取智能体配置模版。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
outboundbot:GetAgentProfileTemplateget
*全部资源
*

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
AgentProfileTemplateIdstring

智能体模板 ID

default-survey
AppIpstring

app_ip (系统字段,可不填)

127.0.0.1

返回参数

名称类型描述示例值
名称类型描述示例值
object

BaseResponse

Successboolean

是否成功

true
Codestring

接口状态码

OK
Messagestring

接口提示信息

Success
Dataobject

返回数据。

CreateTimestring

创建时间

1720766491000
UpdateTimestring

修改时间

1720766491000
AgentProfileTemplateIdstring

智能体模版 id

default-survey
Namestring

智能体配置模版名称

问卷调查
Descriptionstring

智能体配置模版描述

说明
PromptSchemastring

智能体模版配置

{ "name": "promptSchema", "properties": { "name": { "displayOrder": 1, "displayName": "名称", "dataType": "TEXT", "editorType": "MENTIONS_TEXTAREA", "attributes": { "placeholder": "如:云小宝", "rows": 1 }, "group": "人物与风格", "maxLength": 100 }, "gender": { "displayOrder": 2, "displayName": "性别", "description": "此选项不会改变男女声音色,如需修改,请在【语音&VUI】中的TTS音色模版中修改", "dataType": "TEXT", "editorType": "SELECT", "attributes": { "dataSource": [ "男", "女", "不指定" ] }, "group": "人物与风格", "maxLength": 100 }, "age": { "displayOrder": 3, "displayName": "年龄", "dataType": "LONG", "editorType": "NUMBER", "attributes": { "innerAfter": "岁" }, "group": "人物与风格", "maximum": 60, "minimum": 18 }, "role": { "displayOrder": 3, "displayName": "身份", "dataType": "TEXT", "editorType": "SELECTABLE_TAGS", "attributes": { "mode": "single", "dataSource": [ "游戏推广员", "活动运营员", "医疗助理", "审计专员", "保险专员", "行政助理" ] }, "group": "人物与风格", "maxLength": 100 }, "communicationStyle": { "displayOrder": 4, "displayName": "沟通风格", "dataType": "TEXT", "editorType": "SELECTABLE_TAGS", "attributes": { "mode": "multiple", "dataSource": [ "亲切", "自然", "口语化", "专业", "活泼", "严肃" ] }, "group": "人物与风格", "maxLength": 100 }, "goals": { "displayOrder": 5, "displayName": "目标", "dataType": "TEXT", "editorType": "MENTIONS_TEXTAREA", "attributes": { "placeholder": "描述此次呼叫的目的。例如,调研上次服务的满意度情况", "rows": 5 }, "group": "业务描述", "maxLength": 1000 }, "background": { "displayOrder": 7, "displayName": "背景", "dataType": "TEXT", "editorType": "MENTIONS_TEXTAREA", "attributes": { "placeholder": "描述此次呼叫的背景,比如活动信息、FAQ等", "rows": 10 }, "group": "业务描述", "maxLength": 2000 }, "openingPrompt": { "displayOrder": 100, "displayName": "开场白", "dataType": "TEXT", "editorType": "MENTIONS_TEXTAREA", "attributes": { "placeholder": "请输入开场白,支持变量", "rows": 3, "isAutoOptimizePrompt": true }, "group": "业务描述", "maxLength": 100, "required": true }, "skills": { "displayOrder": 9, "displayName": "技能", "description": "描述机器人能够执行的具体事项。例如\n<copy>技能1:核验用户身份\n技能2:进行活动推荐\n技能3:确认用户参与意向并礼貌挂机<copy>", "dataType": "TEXT", "editorType": "MENTIONS_TEXTAREA", "attributes": { "placeholder": "描述机器人包含的能力\n例如:\n1.使用客服语气询问客户的产品满意度情况\n2.需要针对产品的易用性、性能、功能完善度、商品价格这4个纬度进行打分调研", "rows": 5, "isAutoOptimizePrompt": true, "quickOptionsEnabled": true, "apiPluginsEnabled": true }, "group": "业务描述", "maxLength": 1000 }, "workflow": { "displayOrder": 10, "displayName": "流程", "description": "描述机器人执行任务时,与客户交流的过程。例如\n<copy>根据预先设定的问题逻辑推进调研:\n1. 总体满意度:“首先,请问您对我们服务的整体满意度如何评价?非常满意、满意、一般、不满意还是非常不满意?”\n2. 服务亮点(若上一题为正面评价):“很高兴听到您的满意!请问哪些方面让您感到特别满意呢?”\n3. 改进建议(若上一题为负面评价):“非常抱歉给您带来了不便。您认为我们在哪方面可以做得更好?”\n4. 服务效率:“在服务响应速度和服务完成的时效性上,您的感受是怎样的?”\n5. 员工态度:“对于服务人员的专业度和态度,您有何评价?”\n6. 再次选择意愿:“基于此次体验,您未来是否会考虑再次使用我们的服务?”</copy>", "dataType": "TEXT", "editorType": "MENTIONS_TEXTAREA", "attributes": { "placeholder": "描述工作流程", "rows": 10, "isAutoOptimizePrompt": true, "quickOptionsEnabled": true, "apiPluginsEnabled": true }, "group": "业务描述", "maxLength": 4000 }, "constraint": { "displayOrder": 11, "displayName": "约束", "description": "描述对话的约束或整体要求,例如\n<copy>你需要记住你的角色信息,并始终遵循。\n- 在整个通话过程中,保持语气的中立性和友好性,避免对受访者产生引导性影响。\n- 每轮对话不超过50个字,确保信息传达的高效性。\n- 严格遵守调研伦理,保证受访者信息的匿名性和隐私安全。\n- 避免在电话中深入讨论涉及个人隐私或具体服务细节的问题。\n- 用户询问的问题与目标或流程无关时, 请礼貌拒绝,并引导到目标问题上。\n- 只回复与本次任务相关的问题;对于不知道的问题,请不要胡乱回复,需要礼貌回复“不清楚”,并引导到目标问题上。</copy>", "dataType": "TEXT", "editorType": "MENTIONS_TEXTAREA", "attributes": { "placeholder": "描述机器人交流过程中需要注意的问题,或异常情况下的回复参考\n例如:\n1.保持对话的专业客服行业专业术语和礼貌性,维护公司形象\n2.针对客服的情绪如不耐烦、生气等能够精准识别并及时停止调研", "rows": 5, "isAutoOptimizePrompt": true }, "group": "业务描述", "maxLength": 1000, "defaultValue": "- 当前时间:${currentTimeWithDayOfWeek}。\n- 星期和日期转换时,请用北京时间。\n- 如果不知道目标用户(客户)性别,则直接称呼目标用户(客户)姓名,不要尊称xx先生/女士。例如:不知道张三的性别,请直接称呼张三,不要称呼张三先生/女士。\n- 如果知道目标用户(客户)性别,直接称呼xx先生/女士。\n- 请严格按照流程步骤逐步执行,并确保所有步骤都已经执行,如果还存在没有执行的步骤,则需要再执行一次。" }, "output": { "displayOrder": 1000, "displayName": "输出", "description": "输出", "dataType": "TEXT", "editorType": "MENTIONS_TEXTAREA", "attributes": { "placeholder": "- 无格式\n", "rows": 10, "isAutoOptimizePrompt": false }, "group": "业务描述", "maxLength": 2000, "defaultValue": "- 无格式\n", "hidden": true }, "aiHangupOutput": { "displayOrder": 1001, "displayName": "aiHangupOutput", "description": "aiHangupOutput", "dataType": "TEXT", "editorType": "MENTIONS_TEXTAREA", "attributes": { "placeholder": "- 如果判断会话结束,则礼貌回复并追加#[HangUp]\n- 如果流程已执行完成,则礼貌回复并追加#[HangUp]\n- 如果大模型(机器人或者Bot)输出了再见,并且表示希望结束会话,则追加#[HangUp]", "rows": 10, "isAutoOptimizePrompt": false }, "group": "业务描述", "maxLength": 2000, "defaultValue": "- 如果判断会话结束,则礼貌回复并追加#[HangUp]\n- 如果流程已执行完成,则礼貌回复并追加#[HangUp]\n- 如果大模型(机器人或者Bot)输出了再见,并且表示希望结束会话,则追加#[HangUp]", "hidden": true }, "aiSilenceTimeoutOutput": { "displayOrder": 1002, "displayName": "aiSilenceTimeoutOutput", "description": "aiSilenceTimeoutOutput", "dataType": "TEXT", "editorType": "MENTIONS_TEXTAREA", "attributes": { "placeholder": "- 如果用户没有说话,则礼貌回复用户。比如“抱歉,我听不到您讲话,请您再说一遍?“\n- 如果用户没有说话没有达到${aiSilenceTimeoutMaxCount}次,请不要结束会话,但需要进行礼貌回复。\n-如果用户没有说话达到${aiSilenceTimeoutMaxCount}次,则礼貌回复结束会话并追加#[HangUp]", "rows": 10, "isAutoOptimizePrompt": false }, "group": "业务描述", "maxLength": 2000, "defaultValue": "- 如果用户没有说话,则礼貌回复用户。比如“抱歉,我听不到您讲话,请您再说一遍?“\n- 如果用户没有说话没有达到${aiSilenceTimeoutMaxCount}次,请不要结束会话,但需要进行礼貌回复。\n-如果用户没有说话达到${aiSilenceTimeoutMaxCount}次,则礼貌回复结束会话并追加#[HangUp]", "hidden": true } } }
HttpStatusCodeinteger

http 状态码

200
RequestIdstring

请求 id

254EB995-DEDF-48A4-9101-9CA5B72FFBCC

示例

正常返回示例

JSON格式

{
  "Success": true,
  "Code": "OK",
  "Message": "Success",
  "Data": {
    "CreateTime": "1720766491000",
    "UpdateTime": "1720766491000",
    "AgentProfileTemplateId": "default-survey",
    "Name": "问卷调查",
    "Description": "说明",
    "PromptSchema": "{\n  \"name\": \"promptSchema\",\n  \"properties\": {\n    \"name\": {\n      \"displayOrder\": 1,\n      \"displayName\": \"名称\",\n      \"dataType\": \"TEXT\",\n      \"editorType\": \"MENTIONS_TEXTAREA\",\n      \"attributes\": {\n        \"placeholder\": \"如:云小宝\",\n        \"rows\": 1\n      },\n      \"group\": \"人物与风格\",\n      \"maxLength\": 100\n    },\n    \"gender\": {\n      \"displayOrder\": 2,\n      \"displayName\": \"性别\",\n      \"description\": \"此选项不会改变男女声音色,如需修改,请在【语音&VUI】中的TTS音色模版中修改\",\n      \"dataType\": \"TEXT\",\n      \"editorType\": \"SELECT\",\n      \"attributes\": {\n        \"dataSource\": [\n          \"\",\n          \"\",\n          \"不指定\"\n        ]\n      },\n      \"group\": \"人物与风格\",\n      \"maxLength\": 100\n    },\n    \"age\": {\n      \"displayOrder\": 3,\n      \"displayName\": \"年龄\",\n      \"dataType\": \"LONG\",\n      \"editorType\": \"NUMBER\",\n      \"attributes\": {\n        \"innerAfter\": \"\"\n      },\n      \"group\": \"人物与风格\",\n      \"maximum\": 60,\n      \"minimum\": 18\n    },\n    \"role\": {\n      \"displayOrder\": 3,\n      \"displayName\": \"身份\",\n      \"dataType\": \"TEXT\",\n      \"editorType\": \"SELECTABLE_TAGS\",\n      \"attributes\": {\n        \"mode\": \"single\",\n        \"dataSource\": [\n          \"游戏推广员\",\n          \"活动运营员\",\n          \"医疗助理\",\n          \"审计专员\",\n          \"保险专员\",\n          \"行政助理\"\n        ]\n      },\n      \"group\": \"人物与风格\",\n      \"maxLength\": 100\n    },\n    \"communicationStyle\": {\n      \"displayOrder\": 4,\n      \"displayName\": \"沟通风格\",\n      \"dataType\": \"TEXT\",\n      \"editorType\": \"SELECTABLE_TAGS\",\n      \"attributes\": {\n        \"mode\": \"multiple\",\n        \"dataSource\": [\n          \"亲切\",\n          \"自然\",\n          \"口语化\",\n          \"专业\",\n          \"活泼\",\n          \"严肃\"\n        ]\n      },\n      \"group\": \"人物与风格\",\n      \"maxLength\": 100\n    },\n    \"goals\": {\n      \"displayOrder\": 5,\n      \"displayName\": \"目标\",\n      \"dataType\": \"TEXT\",\n      \"editorType\": \"MENTIONS_TEXTAREA\",\n      \"attributes\": {\n        \"placeholder\": \"描述此次呼叫的目的。例如,调研上次服务的满意度情况\",\n        \"rows\": 5\n      },\n      \"group\": \"业务描述\",\n      \"maxLength\": 1000\n    },\n    \"background\": {\n      \"displayOrder\": 7,\n      \"displayName\": \"背景\",\n      \"dataType\": \"TEXT\",\n      \"editorType\": \"MENTIONS_TEXTAREA\",\n      \"attributes\": {\n        \"placeholder\": \"描述此次呼叫的背景,比如活动信息、FAQ等\",\n        \"rows\": 10\n      },\n      \"group\": \"业务描述\",\n      \"maxLength\": 2000\n    },\n    \"openingPrompt\": {\n      \"displayOrder\": 100,\n      \"displayName\": \"开场白\",\n      \"dataType\": \"TEXT\",\n      \"editorType\": \"MENTIONS_TEXTAREA\",\n      \"attributes\": {\n        \"placeholder\": \"请输入开场白,支持变量\",\n        \"rows\": 3,\n        \"isAutoOptimizePrompt\": true\n      },\n      \"group\": \"业务描述\",\n      \"maxLength\": 100,\n      \"required\": true\n    },\n    \"skills\": {\n      \"displayOrder\": 9,\n      \"displayName\": \"技能\",\n      \"description\": \"描述机器人能够执行的具体事项。例如\\n<copy>技能1:核验用户身份\\n技能2:进行活动推荐\\n技能3:确认用户参与意向并礼貌挂机<copy>\",\n      \"dataType\": \"TEXT\",\n      \"editorType\": \"MENTIONS_TEXTAREA\",\n      \"attributes\": {\n        \"placeholder\": \"描述机器人包含的能力\\n例如:\\n1.使用客服语气询问客户的产品满意度情况\\n2.需要针对产品的易用性、性能、功能完善度、商品价格这4个纬度进行打分调研\",\n        \"rows\": 5,\n        \"isAutoOptimizePrompt\": true,\n        \"quickOptionsEnabled\": true,\n        \"apiPluginsEnabled\": true\n      },\n      \"group\": \"业务描述\",\n      \"maxLength\": 1000\n    },\n    \"workflow\": {\n      \"displayOrder\": 10,\n      \"displayName\": \"流程\",\n      \"description\": \"描述机器人执行任务时,与客户交流的过程。例如\\n<copy>根据预先设定的问题逻辑推进调研:\\n1. 总体满意度:“首先,请问您对我们服务的整体满意度如何评价?非常满意、满意、一般、不满意还是非常不满意?”\\n2. 服务亮点(若上一题为正面评价):“很高兴听到您的满意!请问哪些方面让您感到特别满意呢?”\\n3. 改进建议(若上一题为负面评价):“非常抱歉给您带来了不便。您认为我们在哪方面可以做得更好?”\\n4. 服务效率:“在服务响应速度和服务完成的时效性上,您的感受是怎样的?”\\n5. 员工态度:“对于服务人员的专业度和态度,您有何评价?”\\n6. 再次选择意愿:“基于此次体验,您未来是否会考虑再次使用我们的服务?”</copy>\",\n      \"dataType\": \"TEXT\",\n      \"editorType\": \"MENTIONS_TEXTAREA\",\n      \"attributes\": {\n        \"placeholder\": \"描述工作流程\",\n        \"rows\": 10,\n        \"isAutoOptimizePrompt\": true,\n        \"quickOptionsEnabled\": true,\n        \"apiPluginsEnabled\": true\n      },\n      \"group\": \"业务描述\",\n      \"maxLength\": 4000\n    },\n    \"constraint\": {\n      \"displayOrder\": 11,\n      \"displayName\": \"约束\",\n      \"description\": \"描述对话的约束或整体要求,例如\\n<copy>你需要记住你的角色信息,并始终遵循。\\n- 在整个通话过程中,保持语气的中立性和友好性,避免对受访者产生引导性影响。\\n- 每轮对话不超过50个字,确保信息传达的高效性。\\n- 严格遵守调研伦理,保证受访者信息的匿名性和隐私安全。\\n- 避免在电话中深入讨论涉及个人隐私或具体服务细节的问题。\\n- 用户询问的问题与目标或流程无关时, 请礼貌拒绝,并引导到目标问题上。\\n- 只回复与本次任务相关的问题;对于不知道的问题,请不要胡乱回复,需要礼貌回复“不清楚”,并引导到目标问题上。</copy>\",\n      \"dataType\": \"TEXT\",\n      \"editorType\": \"MENTIONS_TEXTAREA\",\n      \"attributes\": {\n        \"placeholder\": \"描述机器人交流过程中需要注意的问题,或异常情况下的回复参考\\n例如:\\n1.保持对话的专业客服行业专业术语和礼貌性,维护公司形象\\n2.针对客服的情绪如不耐烦、生气等能够精准识别并及时停止调研\",\n        \"rows\": 5,\n        \"isAutoOptimizePrompt\": true\n      },\n      \"group\": \"业务描述\",\n      \"maxLength\": 1000,\n      \"defaultValue\": \"- 当前时间:${currentTimeWithDayOfWeek}。\\n- 星期和日期转换时,请用北京时间。\\n- 如果不知道目标用户(客户)性别,则直接称呼目标用户(客户)姓名,不要尊称xx先生/女士。例如:不知道张三的性别,请直接称呼张三,不要称呼张三先生/女士。\\n- 如果知道目标用户(客户)性别,直接称呼xx先生/女士。\\n- 请严格按照流程步骤逐步执行,并确保所有步骤都已经执行,如果还存在没有执行的步骤,则需要再执行一次。\"\n    },\n    \"output\": {\n      \"displayOrder\": 1000,\n      \"displayName\": \"输出\",\n      \"description\": \"输出\",\n      \"dataType\": \"TEXT\",\n      \"editorType\": \"MENTIONS_TEXTAREA\",\n      \"attributes\": {\n        \"placeholder\": \"- 无格式\\n\",\n        \"rows\": 10,\n        \"isAutoOptimizePrompt\": false\n      },\n      \"group\": \"业务描述\",\n      \"maxLength\": 2000,\n      \"defaultValue\": \"- 无格式\\n\",\n      \"hidden\": true\n    },\n    \"aiHangupOutput\": {\n      \"displayOrder\": 1001,\n      \"displayName\": \"aiHangupOutput\",\n      \"description\": \"aiHangupOutput\",\n      \"dataType\": \"TEXT\",\n      \"editorType\": \"MENTIONS_TEXTAREA\",\n      \"attributes\": {\n        \"placeholder\": \"- 如果判断会话结束,则礼貌回复并追加#[HangUp]\\n- 如果流程已执行完成,则礼貌回复并追加#[HangUp]\\n- 如果大模型(机器人或者Bot)输出了再见,并且表示希望结束会话,则追加#[HangUp]\",\n        \"rows\": 10,\n        \"isAutoOptimizePrompt\": false\n      },\n      \"group\": \"业务描述\",\n      \"maxLength\": 2000,\n      \"defaultValue\": \"- 如果判断会话结束,则礼貌回复并追加#[HangUp]\\n- 如果流程已执行完成,则礼貌回复并追加#[HangUp]\\n- 如果大模型(机器人或者Bot)输出了再见,并且表示希望结束会话,则追加#[HangUp]\",\n      \"hidden\": true\n    },\n    \"aiSilenceTimeoutOutput\": {\n      \"displayOrder\": 1002,\n      \"displayName\": \"aiSilenceTimeoutOutput\",\n      \"description\": \"aiSilenceTimeoutOutput\",\n      \"dataType\": \"TEXT\",\n      \"editorType\": \"MENTIONS_TEXTAREA\",\n      \"attributes\": {\n        \"placeholder\": \"- 如果用户没有说话,则礼貌回复用户。比如“抱歉,我听不到您讲话,请您再说一遍?“\\n- 如果用户没有说话没有达到${aiSilenceTimeoutMaxCount}次,请不要结束会话,但需要进行礼貌回复。\\n-如果用户没有说话达到${aiSilenceTimeoutMaxCount}次,则礼貌回复结束会话并追加#[HangUp]\",\n        \"rows\": 10,\n        \"isAutoOptimizePrompt\": false\n      },\n      \"group\": \"业务描述\",\n      \"maxLength\": 2000,\n      \"defaultValue\": \"- 如果用户没有说话,则礼貌回复用户。比如“抱歉,我听不到您讲话,请您再说一遍?“\\n- 如果用户没有说话没有达到${aiSilenceTimeoutMaxCount}次,请不要结束会话,但需要进行礼貌回复。\\n-如果用户没有说话达到${aiSilenceTimeoutMaxCount}次,则礼貌回复结束会话并追加#[HangUp]\",\n      \"hidden\": true\n    }\n  }\n}"
  },
  "HttpStatusCode": 200,
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC"
}

错误码

HTTP status code错误码错误信息
HTTP status code错误码错误信息
404NotExists.InstanceIdThe specified instance %s does not exist.

访问错误中心查看更多错误码。

  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等