跳转至

AIGC说明文档

一、AIGC使用

使用AIGC能力需要开通权限后使用并选择哪些技能需要使用AIGC,开通权限请联系商务人员!

1.1 biz后台账号申请

后台地址:http://biz.turingos.cn

注意:使用此接口申请机器人接入方式,WebSocket、SDK接⼊(Android)

1.2 域名地址

正式环境:ws[s]://ws-api.turingapi.com/api/v2

1.3 加密说明

加密请求(openSocket请求默认不加密,biz后台可选择加密方式请求) 为保证接口的安全性和稳定性,如需要对接口数据进行加密参考以下说明

加密必须包含的信息:APIkey,Secret(需通过图灵Biz平台 - 机器人信息页获取);

需针对请求参数中的data字段,进行AES加密处理,具体加密方式如下:
参数 说明 备注
加密模式 CBC -
填充 PKCS5Padding -
数据块 128位(密钥为16位) -
密码 secretKey Apikey+Secret+时间戳(毫秒,与入参保持一致)
进行Md5加密,取16位小写值
偏移量 secretKey Apikey+Secret+时间戳(毫秒,与入参保持一致)
进行Md5加密,取16位小写值
输出 base64编码 -
字符集 utf-8 -

1.4 AIGC功能时序图

Image

1.5 输入协议

最终请求参数

{
    "key":"ed474dae62***67050faea1788",
    "timestamp":"1507793000",
    "data":"加密后的内容"
}

data加密前数据格式:

{
        "deviceId": "123",
        "nlpRequest": {
            "content": [
                {
                    "data": "写一篇关于春天的作文"
                }
            ]
        },
        "requestType": [
            1
        ]
    }

请求参数说明

data

参数 是否必须 说明
deviceId Y 设备deviceId唯一标识码
nlpRequest Y 请求信息
requestType Y aigc 请求时固定为【1】,语音请求aigc时使用【0,1】
0:ASR
1:NLP

data-nlpRequest

参数 是否必须 说明
content Y 输入信息

data-nlpRequest-content

参数 类型 是否必须 说明
type int N 输入类型:0-文本(默认)、1-图片、2-音频(asr)、4-主动交互、5-音频(技能)
data String Y 输入内容,文本 ,图片url、音频存字节Base64编码字符;文本类型存输入内容

1.6 返回数据示例及参数说明

json返回示例如下:

{
    "aigcResponse": {
        "intentCode": 1000843,
        "results": [
            {
                "resultType": "text",
                "value": "题目:春天的魅力\n春天到了,大自然万物开始焕发出生机勃勃的气息。随着气温的升高,阳光更加明媚,花儿开始绽放,树木开始发芽,一切都变得充满了生机和活力。\n春天是一个充满魅力的季节。在这个季节里,我们可以感受到大自然的美丽和神奇。我们可以欣赏到万物复苏的景象,感受到大自然的力量和魔力。我们可以漫步在花海中,欣赏着各种美丽的花卉,感受春天带来的愉悦和幸福。\n春天也是一个充满活力和希望的季节。在这个季节里,我们可以迎来新的开始和机遇。我们可以开始新的工作和学习,迎接新的挑战和机遇。我们可以拥有新的心情和状态,充满了积极向上的力量和信心。\n春天是一个美丽而充满活力的季节。在这个季节里,我们可以感受到大自然的神奇和魅力,感受到大自然的力量和魔力,感受到春天带来的愉悦和幸福,感受到新的力量和希望。让我们一起享受春天的魅力,迎接更加美好的未来!"
            }
        ],
        "state": 200
    },
    "code": 262,
    "done": true,
    "globalId": "210528880791611001",
    "message": "AIGC最终结果"
}

返回数据参数说明

参数 类型 是否必须 取值范围 说明
code int N 261,262 261:生成内容中间结果;262:生成内容结束,可能存在错误。
message String N - 返回说明
aigcResponse-state int N 210,200,400 210:中间结果;200:最终结果;400:异常;500:⾮法词异常
aigcResponse-results array N - resultType:数据类型,⽬前⽀持:image/text,value 数据内容,image输出url
aigcResponse-extendArgs json N - 透传输出内容
aigcResponse-errorCode int N - 透传异常code
aigcResponse-errorMsg String N - 异常信息说明