获取智能体配置。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| outboundbot:GetAgentProfile | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 实例 ID | 0ec0c897-b92c-40e4-9ad7-e6e4f5ce13bb |
| AgentProfileId | string | 是 | 智能体配置 ID。 说明
可通过 DescribeScript 的返回参数 ChatbotId 获取已经创建场景的智能体配置 ID
| d31794e2a51f47d2901b4094d88311d7 |
| AppIp | string | 否 | app_ip（系统字段，可不填） | 127.0.0.1 |
返回参数
示例
正常返回示例
JSON格式
{
"Success": true,
"Code": "OK",
"Message": "Success",
"Data": {
"CreateTime": 1741338619000,
"UpdateTime": 1741338619000,
"AgentProfileId": "d31794e2a51f47d2901b4094d88311d7",
"InstanceId": "7f04f92c-ccfc-4f8f-a816-6902023be5c6",
"ScriptId": "d13ad2d3-3fe6-4352-b38b-bd6559047de8",
"AgentType": "",
"PromptJson": {
"name": "小x",
"gender": "男",
"age": 18,
"role": "游戏推广员",
"communicationStyle": [
"亲切"
],
"goals": "你好",
"background": "不是很好",
"openingPrompt": "你好，我是xxx"
},
"Prompt": "",
"AgentProfileTemplateId": "default-survey",
"Model": "model_002",
"ModelConfig": {},
"System": false,
"LabelsJson": "[{\\\"name\\\":\\\"是否送达\\\",\\\"description\\\":\\\"购买的家电是否已经送达\\\",\\\"valueList\\\":\\\"[\\\\\\\"是\\\\\\\",\\\\\\\"否\\\\\\\"]\\\"},{\\\"name\\\":\\\"预约上门时间\\\",\\\"description\\\":\\\"收集客户期望的上门安装时间\\\",\\\"valueList\\\":\\\"[]\\\"}]\n",
"VariablesJson": "[{\\\"name\\\":\\\"name\\\",\\\"description\\\":\\\"客户姓名\\\"},{\\\"name\\\":\\\"gender\\\",\\\"description\\\":\\\"客户性别\\\"}]\n",
"Scenario": "测试场景",
"Description": "这是一个大模型机器人",
"InstructionJson": [
{
"type": "TransferToAgent",
"instructions": [
{
"code": "Transfer0",
"skillGroupId": 123,
"skillGroupName": 123
}
],
"timeoutEnable": false
},
{
"type": "CollectNumber",
"instructions": []
}
],
"ApiPluginJson": [],
"NluConfigJson": {
"chatbotInstanceId": "chatbot-cn-j7eiVJZRmb",
"faqCategoryIds": [
30000474726
],
"llmAgentId": 1246206,
"llmAgentInstanceId": "outbound_05efb75a-95df-438e-9b9b-8f2c857d5498",
"llmAgentKey": "d682716514814815ae77757c0bcbda01_p_outbound_public"
}
},
"HttpStatusCode": 200,
"RequestId": "7A573837-3AD3-54CF-930A-07A3287042C2"
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 404 | NotExists.InstanceId | The specified instance %s does not exist. |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史