星火助手创建指南
星火创研院**2023-08-14 23:58:54**发布1134003137
大模型
一键看摘要
7分22秒** **听全文
一、什么是星火助手
星火助手是基于讯飞星火认知大模型,面向用户使用场景,打造的高效生产力工具。通过设置结构化的指令模板,用户即可完成助手功能设定,每个助手在对话的模式下能够快速满足场景需求。同时支持助手模板、数据集、web应用、助手API等功能。二、新建助手流程
1、找到新建助手
登录讯飞星火SparkDesk产品首页,在左上角,点击进入“助手中心” 在星火助手中心页面,点击右上方”助手创作中心” 在助手创作中心,点击”立即创建”,进入新建助手页面,开始创建助手创建之旅2、助手创建指令设置
在新建助手页面中,完成助手名称、助手类型、功能描述、输入模板、知识库信源、其他示例、角色设定、目标任务、需求说明、风格设定等字段的设置后,可在右侧进行调试与预览。调试完成,确认助手效果无误后,点击”创建”即可创建完成您的助手。如您希望自己创建的助手上架到助手中心,让更多的用户使用,则点击”创建并申请上架”,等待申请通过;如您创建的助手希望仅自己可见和可用,则点击”创建”。
2.1助手创建基本信息填写
助手创建的基本信息包括四个必填项(助手名称、助手类型、多轮对话、功能描述)以及三个选填项(输入模板、知识库信源、其他示例),为了给到用户使用助手的清晰指引,建议尽量为助手补充完整信息。2.1.1助手名称
请为您的助手设计一个方便识别的名称,例如”周报小助理”、”PPT大纲助手”等,最多20个字。 温馨提示:如您创建的助手计划申请上架到助手中心,建议助手名称建议体现核心功能,方便用户可以快速理解该助手的功能,并且可以根据功能快速检索到您的助手。如”短视频脚本助手”,用户如有短视频脚本相关需求,则可通过在助手中心”全部”分类中搜索”短视频”、”脚本”、”短视频脚本”等相关关键词搜索到您在市场中创建的助手。2.1.2助手类型及多轮对话
请为您的助手选择助手类型,目前助手中心包含:职场、营销、点评、创作、编程、生活、招聘、学习、客服、趣味、出行、公文、情感、脑暴、其他等15个分类。选择分类后,当您的助手上架申请成功后,会显示在助手市场该分类中。PS:正确选择分类,将有利于用户在市场中找到您的助手
助手类型右侧的”多轮对话”,是指您可以选择设置该助手在对话过程中,是否需要带有上下文记忆。如您选择”关闭多轮对话”,则助手在对话过程中不会记住上文内容,每轮对话都是一轮新对话。如您选择”开启多轮对话”,则助手在对话过程中会带上上文内容。如您的助手是需要多轮对话进行使用的,则建议选择开启,反之则选择关闭。2.1.3功能描述
请在此处简明清晰的填写该助手的功能介绍,以及明确告知用户应该如何使用该助手,此处限制100个字符。例如”面试官模拟器”助手中的功能描述为:我可以帮您进行模拟面试训练。填写岗位名称,我将给您5个该岗位的常见面试问题。2.1.4输入模板和其他示例
请在此处给出用户具体的输入示例,即用户需要输入什么内容。仍以”面试官模拟器”助手为例,输入模板可以为”产品经理”。为了方便用户发散更多的使用场景,也可以在”其他示例”中给出更多输入示例,例如”面试官模拟器”助手的其他示例就可以是”行政专员”、”大客户经理”、”数据分析师”等。
2.1.5知识库信源
如您希望该助手的回答内容,除了可以从星火大模型现有语料库中获取,还可以从您的专属知识库中获取,您可以先在助手创作中心中的”数据集”页面里搭建您的数据集(数据集管理可见”四、数据集功能”),在助手创建时将对应的数据集绑定至该助手上。则该助手在交互时,会从您的知识库中检索答案回复用户。温馨提示:如您上传并使用的数据集是您或您所在企业的隐私数据,请谨慎选择该助手是否上架到助手中心。绑定了您数据集的助手上架到助手中心后,其他用户在使用该助手时,也会获取您数据集中的信息。
2.2助手创建结构化指令
结构化指令主要功能是助手给讯飞星火认知大模型输入的指令模板,该指令的设置将直接影响创建助手的使用效果。结构化指令主要包括角色设定、目标任务、需求说明三个字段,风格设定与自定义维度则为选填字段。如您初次与大模型接触,不知道如何与大模型交流,如何创建效果更好的助手,只需按照结构化指令字段填写您的场景任务,就可以组成助手创建的完整指令啦~2.2.1角色设定
角色设定:为您的助手设定一个角色,例如”面试官模拟器”助手,填写的角色设定可以是”您是一个经验丰富的面试官”2.2.2目标任务
目标任务:填写该助手需要完成的任务,例如”面试官模拟器”助手,目标任务是”你需要根据我说的岗位,给我列出该岗位的常见面试问题”2.2.3需求说明
需求说明:填写对于该助手的其他指令或要求,例如”面试官模拟器”助手,需求说明是”需要给我5个问题,分条展示”2.2.4风格设定及自定义维度
风格设定:填写该助手的人设风格或回答风格要求,例如”文字风格需严谨、符合书面用语” 自定义维度:如您需要设置更多字段的指令,可以在”我的维度”中填写,或点击”+”创建更多 温馨提示:在撰写助手指令时需要注意的是要尽量使用简单、直接、精准的表达,避免使用模糊或者过于复杂的词汇,在文本过长或有多段文字时,注意使用正确的标点符号将文本分开,否则会影响大模型理解和助手效果。2.3调试与预览
完成助手创建相关设置后,请进入”调试与预览”测试您创建的助手效果,并可根据测试效果进行内容调试。2.4创建助手与上架助手中心
填写完上述内容后,点击”创建”您的助手就创建好了,如您希望助手上架到助手市场,让更多用户可以体验您的助手,请点击”创建并申请上架” 温馨提示:如您选择了“创建并申请上架”,助手审核通过与否的状态,以及不通过的修改建议可至助手中心-上架管理中查看,地址为 https://xinghuo.xfyun.cn/botcenter/up2.5已创建助手修改
已创建/已上架的助手如需修改,可以在助手创作中心-创建助手页面,直接点击要修改的助手,进入助手创建页面,点击编辑助手,重新填完更新内容后,点击更新上架信息。如果是未上架助手,则是点击保存修改温馨提示:已上架助手提交更新上架信息后,需重新审核
三、助手模板
为了用户能够更加方便快捷得创建专属助手,星火助手开放了180+个官方助手模板,用户可在”助手模板”页面中选择自己想要复制的模板进行使用。3.1选择助手模板
用户可根据不同分类快速查找助手模块,或者通过搜索关键词,找到想要的模板。3.2应用模板
点击想要复制的助手模板卡片中的”查看模板”进入该模板查看及编辑页面,对模板进行编辑微调后,点击”应用此模板”,系统将自动跳转到创建模板页面,并将调整后的模板输入助手创建页面中。调试及预览后,即可点击”创建”完成啦。四、数据集功能
数据集可以关联到助手中作为上下文,强化助手针对数据集内容的理解能力,满足用户私域知识问答、根据资料与大模型对话的需求。4.1新建数据集
进入数据集页面,点击”新建数据集”进入数据集上传页面。 输入数据集名称、数据描述,将需要上传的数据集在”上传文件”中上传。一个数据集最多支持上传10个文件,单文件字数不超过20w,支持txt、pdf格式的文档。4.2配置与分段预览
分段策略支持智能分段与自定义分段策略。 智能分段支持自动设置分段规则与预处理规则,如果不了解这些参数建议选择此项。 自定义分段策略可填写标识符与最大长度字段。标识符是指用户希望用什么字符切分上传的数据集,常用的切分符号主要有换行符”/n”、句号”。”等。最大长度是指用户希望每段切分文字的最大字数限制,目前是支持”200-300”之间。设置完成即可点击”确定并预览”查看对数据集文档的切分效果了。 温馨提示:目前仅提供部分分段预览的提示文字 点击”下一步”进入完成创建与命中测试4.3完成创建与命中测试
上传数据集完成后,可以在命中测试中输入关键词,测试数据集命中情况4.4数据集关联助手创建
数据集上传成功后,进入助手创建页面,在知识库信源中,点击”关联您创建的数据集”可选择已上传的数据集,目前单个助手支持上传99个数据集。五、Web应用
助手Web应用支持将助手作为独立的Web应用分享出去,用户可一键复制助手访问地址,将链接分享给更多用户使用自己创建的助手。5.1复制访问地址
在”创建助手”页面选择已创建的且希望发布Web应用的助手,点击助手卡片进入助手概览页面 点击左侧边框“web应用”栏 开启助手授权按钮后,再点击”复制访问地址”或者”预览”即可查看分享出去的web页面。同时在本页面还支持查看用量监控相关数据。5.2查看Web页面
复制链接后即可打开该助手的web页面,右侧为助手创建者个人信息5.3分享后用户使用
被分享者点击链接后,登录星火账号,就可以使用新创建的助手了六、助手API
创建助手后,如用户有调用该助手API的需求,可在助手API页面将该接口集成到外部应用中直接使用。6.1进入助手API
进入已建助手的助手概览页面,点击左侧“助手API”页面进入,通过实名认证、绑定APPID、查看调用文档即可完成助手API申请6.2完成实名认证
用户可点击”去认证”进入讯飞开放平台官网进行实名认证6.3绑定APPID
点击“立即创建”快速创建APPID后,回到当前的助手API页面,在“服务接口认证信息”处填入下拉选择应用,即可完成绑定6.4调用服务
用户可进入“接口文档”查看调用文档,完成助手API调用 温馨提示:每个助手API可免费拥有1000万token的调用量,每位用户最多享受100次助手API免费调用量权益,如需更多调用量或扩容QPS,请填写工单。七、助手查找和使用功能
您所有创建的助手,会在[星火助手中心]-[我的助手]-[我创建的助手]中展示,点击该助手即可进入对话,开始使用您创建的助手版权声明:本文内容由讯飞AI社区注册用户自发贡献,版权归原作者所有,讯飞AI社区不拥有其著作权,亦不承担相应法律责任。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
评论(66条)
社区问答:
Prompt才能实现多轮对话呢?企鹅Kubernetes**回复:**熊猫Pyro2023-06-14 14:27:12
00
我也想知道这个答案程小丸子**回复:**熊猫Pyro2023-07-10 16:15:03
00
预设一个场景,或者星火每次完成任务,直接回复该任务的修改建议及需求,都可以多轮对话呢~ 如果我输入的内容是结构化的该如何?比如我想给出一个名字生成相应属性(用于小说人物设定),为了泛化,属性名称需要用户输入,名字也要输入,这个时候一个指令里面出现两个输入,该如何处理?程小丸子**回复:**程序语言大师2023-07-10 16:17:51
00
目前暂时只支持一处用户输入,建议可以在功能描述中,引导用户一次性将两个需求都描述出来 我试成功创建了。就是说{{}}这个指令括号里是用户输入的内容, 你在创建指令的时候,里面不要写任何内容。 举例:你是一位公司起名字的大师,请为一家{{}}的公司,起3个中文企业名称,要求有创意、吸引人、简短、大气、积极正能量。未来科技探索家2023-10-13 11:32:59
11
绘画的助手怎么创建啊,无论怎么设置角色,都说自己是文字模型啊元宇宙探险家**回复:**未来科技探索家2023-11-16 23:20:55
00
同问。我现在只能用生成的文字去漂现成的绘画助手 为什么添加{{}}的内容,还是创建不了前端大神企鹅**回复:**机器人勇士战士2023-06-20 15:20:52
00
这个是自然识别别人合作本模型而独立的名称娃娃**回复:**机器人勇士战士2023-06-25 15:46:58
00
不能在中间添加{{}},要在最后添加程小丸子**回复:**机器人勇士战士2023-07-10 16:18:31
00
{{}}中的内容应该是空的哦 代码诗人2023-06-14 11:51:4601
有解决的没,创建不了是什么原因器喵灵灵**回复:**代码诗人2023-07-26 19:17:28
00
可能主要是{{}}的原因呢,看指令里是不是只有一个{{}},且括号里的内容为空 这个小助手的创建真的不友好,助手指令的作用和格式说明的不够清晰,上架审批失败的详细原因无法点开查看。器喵灵灵**回复:**C++大师2023-07-18 18:47:32
00
可以再重新申请上架嘛,拒绝时会显示理由的~程序语言大师2023-07-03 12:53:53
01
我想创建一个提供心理测试的助手,一问一答的模式,但是由于只有一个输入点,这种模式的对话似乎无法成功,因为对话中有两个结构,一个是提问测试内容,一个是问答。模型似乎无法理解提问和问答的用户反馈之间的区别器喵灵灵**回复:**程序语言大师2023-07-18 18:47:59
00
可以创建”支持上下文理解“的助手 模型回答的字数是有多少限制呢?回答的结果老是显示不完器喵灵灵**回复:**李白Redis2023-07-18 18:49:54
00
可以创建一个支持上下文理解的助手,这样当没有回答完整的时候,输入”继续”就可以继续回答啦Erlang小牛2023-07-07 16:12:41
01
请问是否是支持链路式多级提示器喵灵灵**回复:**Erlang小牛2023-07-18 18:49:12
00
666~· 小助手搜索可以优化一下吗?就是说搜索可以稍微范围大一些 只要我搜索的关键词有关联的全都可以搜索的到,而不是一定要输入非常完成的助手名称才可以搜索的到!!!器喵灵灵**回复:**藤曼花AI工程师2023-07-26 19:18:47
00
可以在“全部”里再尝试搜索下呢 有没有开放API出来可以创建助手和使用助手?机器喵灵灵**回复:**Python狂热者2023-07-26 19:19:19
00
敬请期待哦天鹅Gin2023-07-21 15:42:05
01
api什么时候开放器喵灵灵**回复:**天鹅Gin2023-07-26 19:19:39
00
您可以先在星火官网申请API试用 支持自己上传文档,对文档内容进行提问吗?本的猫FF**回复:**JavaScript巨人2023-08-24 11:02:05
00
可以的,试试助手创建的数据集功能吧 我自己有个知识库,包含多个问题和答复,我希望实现,知识库中能找到的用我给的回复,没有找到的用AI实现,请问如何实现?本的猫FF**回复:**PHP写手2023-08-24 11:02:23
00
现在可以在助手创建中关联数据集 宇宙星霸征服者**回复:**赫本的猫FF2023-09-01 14:19:0500
用什么样的方式可以让他基于知识库回答呢,现在他回答的和我知识库的无关 新增的维度这一功能有什么作用?有没有什么例子?本的猫FF**回复:**Rust牛仔2023-08-24 11:03:35
00
新增维度主要是针对结构化指令,如果现在结构化指令中已有的设置不能满足咱们的需求,可以自己增加维度 助手怎么上传图片啊本的猫FF**回复:**大模型魔法师2023-08-24 11:04:06
00
目前助手暂时不支持上传图片呢 如果想创建一个由文案生成视频的助手该怎么做呢,可以让使用助手的人更换自己想要的形象和背景,而不是只能用预设好的这些本的猫FF**回复:**Dlang小鲨鱼2023-08-24 11:04:36
00
目前这个功能只有在”节日祝福视频助手”可以体验未来战士程序员**回复:**赫本的猫FF2023-09-07 10:49:25
00
试过,一点生成视频就出错。用不了机器喵灵灵**回复:**未来战士程序员2023-09-15 15:10:2600
如果使用中遇到问题可以点踩进行反馈哦 我会发几段文字给你,我每次发送给你之后,你不用回答我,我会在发送最后一段文字后发”ok”,然后你帮我把我之前发送给你的所有文字合并起来。这种需求好像模型也不理解。。。Perl探险家2023-08-22 12:12:13
01
您好,麻烦解答一下: 1、星火助手中心的各种助手都是用户调教的?官方的助手是哪些,是否可以标注出来(比如用不同的色块或者右上角添加”官方”字样) 2、和星火对话的时候怎么不显示时间? 3、对话页面的水印可否去掉? 4、新建对话中如果对答案不满意需要重新生成,会覆盖掉原回答,可否另起一行生产? 5、答案能否附图,在教小朋友认动物的时候全是纯文字的。 6、对话生成的答案里面的链接是纯文字无法点击,但它却让用户点击。Rust牛仔**回复:**Perl探险家2023-08-31 11:11:36
00
官方的和自己创建的都不显示手机号。 创建的助手用户输入框中如何才能支持图片或拍照上传?器喵灵灵**回复:**未来战士程序员2023-09-15 15:11:16
00
目前助手还不支持,可以在通用对话里试试移动应用高手2023-12-19 16:34:35
00
建议开放更多喂养方式,且调试更为简便【好的,我会尽量按照您的要求回答问题。请问您有什么问题需要我回答吗?】这句话非常讨厌。希望出更详细的喂养和调教方法。 23.09——之后未回复超拟⼈合成协议-调用
#接⼝说明
#请求⽅法和URL
ws(s)://cbm01.cn-huabei-1.xf-yun.com/v1/private/medd90fec
重要提示:
- 服务输出的结果段如果分多帧返回(如合成⾳频段audio),结果帧之间的顺序可能⽆法保证,建议接⼊⽅在⼀定时间⽚内根据服务响应帧中的seq序号做重排序
- 部分开发语言demo如下,其他开发语言请参照文档进行开发,也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo
超拟⼈合成 python demo
#接⼝要求
接⼝类型:流式 [ws(s)]接⼝鉴权:使⽤签名机制进⾏鉴权,签名详情参照 “接⼝鉴权”
#请求
#请求协议示例
{
"header": {
"app_id": "123456",
"uid": "39769795890",
"did": "SR082321940000200",
"imei": "8664020318693660",
"imsi": "4600264952729100",
"mac": "6c:92:bf:65:c6:14",
"net_type": "wifi",
"net_isp": "CMCC",
"status": 0,
"request_id": "null",
"res_id": ""
},
"parameter": {
"oral": {
"spark_assist": 1,
"oral_level": "mid"
},
"tts": {
"vcn": "x4_yq_m_oral",
"speed": 50,
"volume": 50,
"pitch": 50,
"bgs": 0,
"reg": 0,
"rdn": 0,
"rhy": 0,
"scn": 0,
"version": 0,
"L5SilLen": 0,
"ParagraphSilLen": 0,
"audio": {
"encoding": "speex-wb",
"sample_rate": 16000,
"channels": 1,
"bit_depth": 16,
"frame_size": 0
},
"pybuf": {
"encoding": "utf8",
"compress": "raw",
"format": "plain"
}
}
},
"payload": {
"text": {
"encoding": "utf8",
"compress": "raw",
"format": "json",
"status": 0,
"seq": 0,
"text": "5aSn5qih5Z6L6L6T5Ye6"
},
"user_text": {
"encoding": "utf8",
"compress": "raw",
"format": "json",
"status": 0,
"seq": 0,
"text": "55So5oi36Zeu6aKY"
}
}
}
协议结构说明
字段 | 含义 | 类型 | 说明 |
---|---|---|---|
header | 协议头部 | Object | 协议头部,⽤于描述平台特性的参数,详⻅ 3.2.1 平台参数。 |
parameter | 能⼒参数 | Object | AI 能⼒功能参数,⽤于控制 AI 引擎特性的开关。 |
cbm | 服务别名 | Object | cbm能⼒功能参数,详⻅ 3.2.2 服务功能参数。 |
oral | 服务别名 | Object | oral能⼒功能参数,详⻅ 3.2.2 服务功能参数。 |
tts | 服务别名 | Object | tts能⼒功能参数,详⻅ 3.2.2 服务功能参数。 |
payload | 输⼊数据段 | Object | 数据段,携带请求的数据。 |
text | 输⼊数据 | Object | 待合成⽂本,详⻅ 3.2.3 请求数据。 |
user_text | 输⼊数据 | Object | ⽤户原始输⼊,场景化合成开启时必传,不开启为⾮必传,详⻅3.2.3 请求数据。 |
#3.2. 请求参数
#3.2.1. 平台参数
字段 | 含义 | 类型 | 限制 | 是否必传 |
---|---|---|---|---|
app_id | 在平台申请的appid信息 | string | “maxLength”:50 | 是 |
uid | 请求⽤户服务返回的uid,⽤户及设备级别个性化功能依赖此参数 | string | “maxLength”:50 | 否 |
did | 请求⽅确保唯⼀的设备标志,设备级别个性化功能依赖此参数 | string | “maxLength”:50 | 否 |
imei | 设备imei信息 | string | “maxLength”:50 | 否 |
imsi | 设备imsi信息 | string | “maxLength”:50 | 否 |
mac | 设备mac信息 | string | “maxLength”:50 | 否 |
net_type | ⽹络类型,可选值为wifi、2G、3G、4G、5G | string | wifi、2G、3G、4G、5G | 否 |
net_isp | 运营商信息,可选值为CMCC、CUCC、CTCC、other | string | CMCC、CUCC、CTCC、other | 否 |
request_id | 客户端请求的会话唯⼀标识 | string | “maxLength”:64 | 否 |
res_id | 个性化资源ID | string | “maxLength”:1024 | 否 |
status | 请求状态,可选值为:0-开始、1-继续、2-结束 | int | “maxLength”:50 | 是 |
#3.2.2. 服务功能参数
功能参数 oral
功能标识 | 功能描述 | 数据类型 | 取值范围 | 必填 | 默认值 |
---|---|---|---|---|---|
oral_level | ⼝语化等级 | string | ⾼:high,中:mid,低:low | 否 | mid |
spark_assist | 是否通过⼤模型进⾏⼝语化 | int | 开启:1, 关闭:0 | 否 | 1 |
功能参数 tts
功能标识 | 功能描述 | 数据类型 | 取值范围 | 必填默 | 认值 |
---|---|---|---|---|---|
vcn | 发⾳⼈ | string | x4_lingxiaoxuan_oral,聆⼩璇,⼥:中⽂、通⽤、通⽤; x4_lingfeizhe_oral,聆⻜哲,男:中⽂、通⽤、通⽤; x4_lingyuzhao_oral,聆⽟昭,⼥:中⽂、通⽤、通⽤; | 是 | |
speed | 语速:0对应默认语速的1/2,100 对应默认语速的2倍 | int | 最⼩值:0, 最⼤值:100 | 否 | 50 |
volume | ⾳量:0是 静⾳,1对 应默认⾳量 1/2,100对应默认⾳量的2倍 | int | 最⼩值:0, 最⼤值:100 | 否 | 50 |
pitch | 语调:0对应默认语速的1/2,100对应默认语速的2倍 | int | 最⼩值:0, 最⼤值:100 | 否 | 50 |
bgs | 背景⾳ | int | 0:⽆背景⾳, 1:内置背景⾳1, 2:内置背景⾳2 | 否 | 0 |
reg | 英⽂发⾳⽅式 | int | 0:⾃动判断处理,如果不确定将按照英⽂词语拼写处理(缺省), 1:所有英⽂按字⺟发⾳, 2:⾃动判断处理,如果不确定将按照字⺟朗读 | 否 | 0 |
rdn | 合成⾳频数字发⾳⽅式 | int | 0:⾃动判断, 1:完全数值, 2:完全字符串, 3:字符串优先 | 否 | 0 |
rhy | 是否返回拼⾳标注 | int | 0:不返回拼⾳, 1:返回拼⾳(纯⽂本格式,utf8编码) | 否 | 0 |
scn | 场景 | int | 0:⽆, 1:散⽂阅读, 2:⼩说阅读, 3:新闻, 4:⼴告, 5:交互 | 否 | 0 |
version | 引擎初始化,是否返回版本信息+时间戳信息 | int | 0:不返回, 1:返回版本信息+时间戳信息。如XXX.18928127 XXX表示版本号,后接秒为单位的时间戳 | 否 | 0 |
L5SilLen | 控制L5静⾳时⻓,取值范围为 0~10000ms | int | 最⼩值:0, 最⼤值:10000 | 否 | |
ParagraphSilLen | 段落静⾳时⻓,取值范围为0~10000ms | int | 最⼩值:0, 最⼤值:10000 | 否 |
控制输出参数 audio 段的参数(默认返回)
字段 | 含义 | 数据类型 | 取值范围 | 默认值 | 说明 | 必填 |
---|---|---|---|---|---|---|
encoding | ⾳频编码 | string | lame, speex, opus, opus-wb, speex-wb,opus-swb | speex-wb | 取值范围可枚举 | 否 |
sample_rate | 采样率 | int | 16000, 8000, 24000 | 16000 | ⾳频采样率,可枚举 | 否 |
channels | 声道数 | int | 1, 2 | 1 | 声道数,可枚举 | 否 |
bit_depth | 位深 | int | 16, 8 | 16 | 单位bit,可枚举 | 否 |
frame_size | 帧⼤⼩ | int | 最⼩值:0, 最⼤值:1024 | 0 | 帧⼤⼩,默认0 | 否 |
字段 | 含义 | 数据类型 | 取值范围 | 默认值 | 说明 | 必填 |
---|---|---|---|---|---|---|
encoding | ⽂本编码 | string | utf8, gb2312 | utf8 | 取值范围可枚举 | 否 |
compress | ⽂本压缩格式 | string | raw, gzip | raw | 取值范围可枚举 | 否 |
format | ⽂本格式 | string | plain, json, xml | plain | 取值范围可枚举 | 否 |
#3.2.3. 请求数据
text(默认请求)字段 | 含义 | 数据类型 | 取值范围 | 默认值 | 说明 | 必填 |
---|---|---|---|---|---|---|
encoding | ⽂本编码 | string | utf8, gb2312, gbk | utf8 | 取值范围可枚举 | 否 |
compress | ⽂本压缩格式 | string | raw, gzip | raw | 取值范围可枚举 | 否 |
format | ⽂本格式 | string | plain, json, xml | plain | 取值范围可枚举 | 否 |
status | 数据状态 | int | 0:开始, 1:开始, 2:结束 | 流式传输 | 是 | |
seq | 数据序号 | int | 最⼩值:0, 最⼤值:9999999 | 数据序号 | 是 | |
text | ⽂本数据 | string | 最⼩尺⼨:1B, 最⼤尺⼨:1048576B | 需base64编码,⽂本⼤⼩:0-1M | 是 |
字段 | 含义 | 数据类型 | 取值范围 | 默认值 | 说明 | 必填 |
---|---|---|---|---|---|---|
encoding | ⽂本编码 | string | utf8, gb2312, gbk | utf8 | 取值范围可枚举 | 否 |
compress | ⽂本压缩格式 | string | raw, gzip | raw | 取值范围可枚举 | 否 |
format | ⽂本格式 | string | plain, json, xml | plain | 取值范围可枚举 | 否 |
status | 数据状态 | int | 0:开始, 1:开始, 2:结束 | 流式传输 | 是 | |
seq | 数据序号 | int | 最⼩值:0, 最⼤值:9999999 | 数据序号 | 是 | |
text | ⽂本数据 | string | 最⼩尺⼨:1B, 最⼤尺⼨:1048576B 需base64编码,⽂本⼤⼩:0-1M | 是 |