复刻人经历训练
# 1.复刻人经历训练状态查询
# 接口描述
接口地址:https://open.galaxyeye-api.com/intellect-saas-v4/v2/robot/milvus/status (opens new window)
请求方式: HTTP POST
请求类型:application/json; charset=utf-8
接口鉴权:参见接口鉴权
# 输入参数
| 参数名称 | 必选 | 字段类型 | 说明 |
|---|---|---|---|
| robotId | 是 | String | 复刻人ID |
# 输出参数
| 参数名称 | 必选 | 字段类型 | 说明 |
|---|---|---|---|
| code | 是 | int | 状态码 |
| msg | 是 | String | 状态描述信息 |
| data | 是 | object | 业务数据 |
| |-data.robotId | 是 | String | 复刻人ID |
| |-data.robotStatus | 是 | String | 复刻人经历训练状态(0:训练中;2:空闲); 训练中的复刻人不可再训练。 |
# 示例
- 输入示例:
{
"robotId": "****WY-JCALWrAPhkc7mU"
}
- 输出示例:
{
"msg": "ok",
"code": 0,
"data": {
"robotStatus": 2,
"robotId": "****WY-JCALWrAPhkc7mU"
}
}
# 快速测试
- curl
curl --location --request POST 'https://open.galaxyeye-api.com/intellect-saas-v4/v2/robot/milvus/status' \
--header 'X-Bm-Access-Token: ****yMjc3LCJhY2Nlc3NLZXkiOiJlZTg4OGYyMjY1MGI0YzdkYjExODA0ZWFkNTQyMmEwMyIsImp3dF90b2tlbl9pZCI6ImU4NjljYTc3LTJiMjctNDBjZC04Yzg4LWE1ODY5NWJlN2Q2NiIsInRlbmFudElkIjoiODUyNTM1NTE0MTIwMDYwOTI4Iiwiand0X3Rva2VuX3R5cGUiOjN9.U5QYuSI-ymzTm6QcAHs2ow1MV3BTXwsACWDGaSeW84Y' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
"robotId": "****WY-JCALWrAPhkc7mU"
}'
# 2.创建经历训练任务
# 接口描述
接口地址:https://open.galaxyeye-api.com/intellect-saas-v4/v2/robot/milvus/train (opens new window)
请求方式: HTTP POST
请求类型:application/json; charset=utf-8
接口鉴权:参见接口鉴权
# 输入参数
| 参数名称 | 必选 | 类型 | 说明 |
|---|---|---|---|
| robotId | 是 | String | 复刻人ID |
| texts | 是 | array | 复刻人经历文本列表(如果texts参数为空,提交训练会清空复刻人经历) |
| callbackUrl | 否 | String | 复刻人经历训练回调接口URL(复刻人系统通过该接口将测试结果反馈给用户) |
# 输出参数
| 参数名称 | 必选 | 类型 | 说明 |
|---|---|---|---|
| code | 是 | int | 状态码 |
| msg | 是 | String | 状态描述信息 |
| data | 是 | object | 业务数据 |
| |-data.taskNo | 是 | String | 任务号 |
| |-data.taskNum | 是 | int | 提交经历条数 |
| |-data.trainNum | 是 | int | 有效经历条数 |
| |-data.startTime | 是 | String | 训练开始时间 |
# 示例
- 输入示例:
{
"robotId": "****WY-JCALWrAPhkc7mU",
"callbackUrl": "https://xxxxxxxx/xxx/taskStatusCallBack",
"texts": [
"孙悟空出生在花果山,从小便聪明伶俐,捣蛋学艺,日渐成长。",
"逐渐发现自己身怀异能,能够施展七十二变和筋斗云术。",
"学艺之道,历经苦难,才能天下无敌。",
"误入如来佛祖的五行山监狱,被困五百年,终因唐僧三藏的出现得以获释。",
"随后,他跟随唐僧取经,走遍千山万水,历经千辛万苦,斩妖除魔,护佑唐僧安全取经。",
"他在取经过程中,与沙僧、猪八戒等成为好友,情同手足。",
"取经后,孙悟空拜访了东海龙王,获得七十二变和定海神针。",
"为了维护天下太平,孙悟空在取经后还历经了多次大战,如打败牛魔王、三打白骨精等。",
"最终,他在唐玄奘取得正果后,被封为斗战胜佛,功德圆满。"
]
}
- 输出示例:
{
"msg": "ok",
"code": 0,
"data": {
"trainNum": 9,
"taskNo": "03b87337-5b44-48b2-9b66-ceed6b81563f",
"startTime": "2023-04-11 15:18:57",
"taskNum": 9
}
}
# 快速测试
- curl
curl --location --request POST 'https://open.galaxyeye-api.com/intellect-saas-v4/v2/robot/milvus/train' \
--header 'X-Bm-Access-Token: ****yMjc3LCJhY2Nlc3NLZXkiOiJlZTg4OGYyMjY1MGI0YzdkYjExODA0ZWFkNTQyMmEwMyIsImp3dF90b2tlbl9pZCI6ImU4NjljYTc3LTJiMjctNDBjZC04Yzg4LWE1ODY5NWJlN2Q2NiIsInRlbmFudElkIjoiODUyNTM1NTE0MTIwMDYwOTI4Iiwiand0X3Rva2VuX3R5cGUiOjN9.U5QYuSI-ymzTm6QcAHs2ow1MV3BTXwsACWDGaSeW84Y' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
"robotId": "****WY-JCALWrAPhkc7mU",
"callbackUrl": "http://xxxxxxxx/xxx/taskStatusCallBack",
"texts": [
"孙悟空出生在花果山,从小便聪明伶俐,捣蛋学艺,日渐成长。",
"逐渐发现自己身怀异能,能够施展七十二变和筋斗云术。",
"学艺之道,历经苦难,才能天下无敌。",
"误入如来佛祖的五行山监狱,被困五百年,终因唐僧三藏的出现得以获释。",
"随后,他跟随唐僧取经,走遍千山万水,历经千辛万苦,斩妖除魔,护佑唐僧安全取经。",
"他在取经过程中,与沙僧、猪八戒等成为好友,情同手足。",
"取经后,孙悟空拜访了东海龙王,获得七十二变和定海神针。",
"为了维护天下太平,孙悟空在取经后还历经了多次大战,如打败牛魔王、三打白骨精等。",
"最终,他在唐玄奘取得正果后,被封为斗战胜佛,功德圆满。"
]
}'
# 3.训练状态查询
# 接口描述
接口地址:https://open.galaxyeye-api.com/intellect-saas-v4/v2/robot/milvus/taskStatus (opens new window)
请求方式: HTTP POST
请求类型:application/json; charset=utf-8
接口鉴权:参见接口鉴权
# 输入参数
| 参数名称 | 必选 | 类型 | 说明 |
|---|---|---|---|
| taskNo | 是 | String | 任务号 |
| robotId | 是 | String | 复刻人ID |
# 输出参数
| 参数名称 | 必选 | 类型 | 说明 |
|---|---|---|---|
| code | 是 | int | 状态码 |
| msg | 是 | String | 状态描述信息 |
| data | 是 | object | 业务数据 |
| |-data.taskNo | 是 | int | 任务号 |
| |-data.status | 是 | int | 训练状态( -1:失败; 0:运行中; 1:成功) |
| |-data.startTime | 是 | String | 训练开始时间 |
| |-data.endTime | 是 | String | 训练结束时间 |
| |-data.taskNum | 是 | integer | 任务量 |
| |-data.trainNum | 是 | integer | 训练量 |
# 示例
- 输入示例:
{
"taskNo": "03b87337-5b44-48b2-9b66-ceed6b81563f",
"robotId": "****WY-JCALWrAPhkc7mU"
}
- 输出示例:
{
"msg": "ok",
"code": 0,
"data": {
"taskNo": "03b87337-5b44-48b2-9b66-ceed6b81563f",
"startTime": "2023-04-11 15:18:57",
"endTime": "2023-04-11 15:18:57",
"status": 1,
"taskNum":9,
"trainNum":9
}
}
# 快速测试
- curl
curl --location --request POST 'https://open.galaxyeye-api.com/intellect-saas-v4/v2/robot/milvus/taskStatus' \
--header 'X-Bm-Access-Token: ****yMjc3LCJhY2Nlc3NLZXkiOiJlZTg4OGYyMjY1MGI0YzdkYjExODA0ZWFkNTQyMmEwMyIsImp3dF90b2tlbl9pZCI6ImU4NjljYTc3LTJiMjctNDBjZC04Yzg4LWE1ODY5NWJlN2Q2NiIsInRlbmFudElkIjoiODUyNTM1NTE0MTIwMDYwOTI4Iiwiand0X3Rva2VuX3R5cGUiOjN9.U5QYuSI-ymzTm6QcAHs2ow1MV3BTXwsACWDGaSeW84Y' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
"taskNo": "03b87337-5b44-48b2-9b66-ceed6b81563f",
"robotId": "****WY-JCALWrAPhkc7mU"
}'
# 4.经历训练结果回调
# 接口描述
接口地址:/xxx/taskStatusCallBack(接口名称仅作示例,开发者可自定义)
请求方式: HTTP POST
请求类型:application/json; charset=utf-8
特别说明: 回调地址端口仅支持默认80或443端口
# 输入参数
| 参数名称 | 必选 | 类型 | 说明 |
|---|---|---|---|
| taskNo | 是 | string | 任务号 |
| taskStatus | 是 | integer | 任务状态( -1:失败; 0:运行中; 1:成功) |
| startTime | 是 | string | 任务开始时间 |
| endTime | 是 | string | 任务结束时间 |
| taskNum | 是 | integer | 任务量 |
| trainNum | 是 | integer | 训练量 |
# 输出参数
北冥复刻人系统在回调该接口时不解析参数内容,http状态码为200即代表回调成功。因此,输出参数可由开发者自行定义,此处定义仅做参考。
| 参数名称 | 必选 | 类型 | 说明 |
|---|---|---|---|
| code | 是 | int | 状态码 |
| msg | 是 | String | 状态描述信息 |
# 示例
- 输入示例:
{
"taskStatus":1,
"taskNo":"03b87337-5b44-48b2-9b66-ceed6b81563f",
"startTime":"2023-04-11 15:18:57",
"endTime":"2023-04-11 15:18:57",
"taskNum":9,
"trainNum":9
}
- 输出示例:
{
"code":0,
"msg":"ok"
}
# 快速测试
略
# 5.复刻人经历查询接口
# 接口描述
接口地址:https://open.galaxyeye-api.com/intellect-saas-v4/v2/robot/milvus/texts (opens new window)
请求方式: HTTP POST
请求类型:application/json; charset=utf-8
接口鉴权:参见 接口鉴权
# 输入参数
| 参数名称 | 必选 | 类型 | 说明 |
|---|---|---|---|
| robotId | 是 | String | 复刻人ID |
# 输出参数
| 参数名称 | 必选 | 类型 | 说明 |
|---|---|---|---|
| code | 是 | int | 状态码 |
| msg | 是 | String | 状态描述信息 |
| data | 是 | object | 业务数据 |
| |-data.robotId | 是 | String | 复刻人ID |
| |-data.robotNum | 是 | int | 当前生效经历条数 |
| |-data.texts | 是 | array | 当前生效经历数组 |
# 示例
- 输入示例
{
"robotId": "****WY-JCALWrAPhkc7mU"
}
- 输出示例
{
"msg": "ok",
"code": 0,
"data": {
"texts": [
"孙悟空出生在花果山,从小便聪明伶俐,捣蛋学艺,日渐成长。",
"逐渐发现自己身怀异能,能够施展七十二变和筋斗云术。",
"学艺之道,历经苦难,才能天下无敌。",
"他在取经过程中,与沙僧、猪八戒等成为好友,情同手足。",
"最终,他在唐玄奘取得正果后,被封为斗战胜佛,功德圆满。",
"为了维护天下太平,孙悟空在取经后还历经了多次大战,如打败牛魔王、三打白骨精等。",
"随后,他跟随唐僧取经,走遍千山万水,历经千辛万苦,斩妖除魔,护佑唐僧安全取经。",
"误入如来佛祖的五行山监狱,被困五百年,终因唐僧三藏的出现得以获释。",
"取经后,孙悟空拜访了东海龙王,获得七十二变和定海神针。"
],
"robotNum": 9,
"robotId": "****WY-JCALWrAPhkc7mU"
}
}
# 快速测试
- curl
curl --location --request POST 'https://open.galaxyeye-api.com/intellect-saas-v4/v2/robot/milvus/texts' \
--header 'X-Bm-Access-Token: ****yMjc3LCJhY2Nlc3NLZXkiOiJlZTg4OGYyMjY1MGI0YzdkYjExODA0ZWFkNTQyMmEwMyIsImp3dF90b2tlbl9pZCI6ImU4NjljYTc3LTJiMjctNDBjZC04Yzg4LWE1ODY5NWJlN2Q2NiIsInRlbmFudElkIjoiODUyNTM1NTE0MTIwMDYwOTI4Iiwiand0X3Rva2VuX3R5cGUiOjN9.U5QYuSI-ymzTm6QcAHs2ow1MV3BTXwsACWDGaSeW84Y' \
--header 'Content-Type: application/json' \
--data-raw '{
"robotId": "****WY-JCALWrAPhkc7mU"
}'
# 6.状态码
| 返回码 | 返回码说明 | 备注 |
|---|---|---|
| 8100 | robotId字段不允许为空,请核实。 经历任务号必传! | |
| 8223 | 复刻人不属于当前租户 | |
| 56001 | 请检查robotId和tenantId | |
| -1 | 人物经历段落数量超过500,请修改后再次提交; 当前机器人没配置引擎; | |
| 8215 | 经历字段数量超出允许范围,请核实 | |
| 8309 | 经历字段长度超出允许范围,请核实 | |
| 57000 | 远程调用创建机器人经历,观点训练任务异常; 远程调用查询机器人当前状态异常 | 请联系管理员 |