魔笔平台提供了强大的通义听悟集成功能,允许用户通过简单的配置,实现对通义听悟的无缝连接和数据交互。本文档将指导您如何创建和使用通义听悟集成。
功能介绍
魔笔平台的通义听悟集成功能支持以下特点:
自定义触发方式:集成操作可以设置为手动触发或自动运行,满足不同的业务场景需求。
回调和数据转换:支持在查询成功或失败时执行特定的集成操作事件,以及对返回的数据进行自定义处理。
高级设置:提供防抖和禁止执行条件的高级配置,以优化集成操作的执行。
事件相关内容可参考:集成操作事件
使用通义听悟集成
步骤 1:创建通义听悟集成
登录魔笔平台,进入管控台。
导航至“资源”->“集成”,点击“创建集成”。
选择“通义听悟”,并填写集成名称及描述。
配置不同环境的通义听悟集成信息,包括
项目 AppKey
和访问密钥
。点击“确定”创建通义听悟集成。
步骤 2:在应用内部创建集成操作
打开“代码”面板,点击对应作用域的“+”后选中“集成操作”。
选择之前创建的通义听悟集成作为资源,选择操作类型后会展开该操作类型下的所有参数,配置参数后点击运行获取返回结果。
点击“运行”预览查询效果。
配置面板详解
集成配置
关于通义听悟请参考什么是通义听悟。
项目 AppKey:定义了通义听悟的项目。关于创建通义听悟项目和获取项目 AppKey,可以参考快速入门。
访问密钥:定义了预期发起 OpenAPI 请求所使用的访问密钥,关于访问密钥,可以参考创建AccessKey。
通用配置
开始实时任务: 在通义听悟创建一个实时任务,返回任务 ID 和推流地址。关于通义听悟任务,可以参考CreateTask - 创建听悟任务。操作类型为
开始实时任务
时,需要填写以下参数:转写模型:音频转写使用的语言模型,支持
中文
、英文
和中英文自由说
。转码格式:将原始音视频文件或音频流转码保存,目前仅支持 mp3 格式。
说话人分离:是否启用说话人分离功能。
分离人数:启用说话人分离功能时,设定的说话人分离参数。支持设置为
0
或2
。0
代表说话人角色区分结果为不定人数,2
代表说话人角色区分结果为 2 人。翻译:是否启用翻译功能。
翻译目标语言:翻译功能开启时设置的目标语言。支持中英文。
翻译目标语言
不能与转写模型
使用的语言相同,否则无法使用。章节速览:是否启用章节速览功能,开启后会生成章节标题和章节摘要结果。
智能纪要:是否启用智能纪要功能,开启后会生成关键词、重点内容、待办等结果。
摘要总结:是否开启摘要总结功能。
总结类型:开启摘要总结功能时,需传入期望的摘要总结类型。支持
全文
、问答回顾
和发言人
。口语书面化:是否启用口语书面化功能。
停止实时任务:根据
开始实时任务
操作返回的任务 ID 停止对应的实时任务。操作类型为停止实时任务
时,需要填写以下参数:任务 ID:
开始实时任务
操作返回的任务 ID。转写模型:音频转写使用的语言模型,支持
中文
、英文
和中英文自由说
。
创建离线任务: 创建一个通义听悟的离线任务,返回任务 ID。操作类型为
创建离线任务
时,需要填写以下参数:转写模型:音频转写使用的语言模型,支持
中文
、英文
和中英文自由说
。文件 URL:传递给通义听悟离线任务的音视频文件的 http(s) 链接。
查询任务状态和结果:根据
开始实时任务
和创建离线任务
操作返回的任务 ID 查询对应任务的状态和结果,关于查询通义听悟任务的状态和结果,可以参考GetTaskInfo - 查询任务状态和任务结果。当操作类型为查询任务状态和结果
时,需要填写以下参数:任务 ID:
开始实时任务
和创建离线任务
操作返回的任务 ID
回调配置
数据转化:对接口返回的数据进行处理,默认为
return data
,即不进行处理。成功回调:配置接口调用成功时触发的事件。
失败回调:配置接口调用失败时触发的事件。
高级配置
防抖:设置防抖表达式,避免接口的频繁调用。
禁止执行条件:根据条件表达式确定是否执行此集成操作。
手动触发集成
事件触发
在需要触发集成操作的组件中,配置事件处理器。
将动作类型设置为集成操作,并选择相应的集成。
以对象形式填写已配置的参数。
API 触发
若此集成操作的名称为action1
,则在任何可以执行脚本的地方,可以使用action1.trigger()
方法触发集成操作,若集成操作配置了参数,则需要以对象形式填写已配置的参数。
- 本页导读
- 功能介绍
- 使用通义听悟集成
- 步骤 1:创建通义听悟集成
- 步骤 2:在应用内部创建集成操作
- 配置面板详解
- 集成配置
- 通用配置
- 回调配置
- 高级配置
- 手动触发集成
- 事件触发
- API 触发