获取离线会议纪要任务结果的API参考。
前提条件
已开通服务并获取与配置 API Key,请配置API Key到环境变量,而非硬编码在代码中,防范因代码泄露导致的安全风险。
接入地址
请求方式
post方法请求
请求头
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
model | string | 是 | 定义业务类型,固定为 |
|
input | object | 是 | 传入相关业务参数 | |
input.task | string | 是 | 定义任务类型,固定为 | getTask |
input.dataId | string | 是 | 需要查询的离线会议纪要任务id | wkb*** |
返回参数
名称 | 类型 | 描述 | 示例值/解析协议 |
|---|---|---|---|
code | string | 错误码 | |
message | string | 错误信息 | |
request_id | string | 请求id | f97ee37d-0f9c-9b93-b6bf-bd263a232bf9 |
usage | object | 用量,目前无值 | {} |
output | object | 业务返回体 | |
output.status | int | 任务状态:
| 0 |
output.errorCode | string | 任务成功提交,但是执行失败( | TSC.FileError |
output.errorMessage | string | 任务成功提交,但是任务执行失败( | File cannot be read. |
output.playbackUrl | string | 回听音频url,有效期是24h | ossUrl对应的文件内容解析协议参见: 注意,当且仅当url中字符串为null时,代表子任务失败,否则认为子任务成功 |
output.transcriptionPath | string | 转写结果对象的ossUrl | |
output.translationsPath | string | 翻译的ossUrl | |
output.autoChaptersPath | string | 章节速览的ossUrl | |
output.summarizationPath | string | 全文摘要、发言总结、问答回顾、思维导图的ossUrl | |
output.meetingAssistancePath | string | 待办事项、关键词的ossUrl | |
output.pptExtractionPath | string | PPT抽取及摘要的ossUrl | |
output.textPolishPath | string | 口语书面化的ossUrl | |
output.customPromptPath | string | 自定义Prompt的ossUrl |
output.transcriptionPath的解析协议
最外层是一个Object,具体字段如下:
名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
audioInfo | object | 音频信息对象。 | |
audioInfo.Size | long | 音频大小,单位:字节。 | 3335756 |
audioInfo.Duration | long | 音频时长,单位:毫秒。(实时语音转写时,该字段不表示实际音频时长) | 104006 |
audioInfo.SampleRate | int | 音频采样率。 | 16000 |
audioInfo.Language | string | 音频语种。 | cn |
audioSegments | array<array<int>> | 有效音频片断范围。 | |
audioSegments[i][0] | int | 有效音频片段的开始时间,单位为毫秒。 | 1690 |
audioSegments[i][1] | int | 有效音频片段的结束时间,单位为毫秒。 | 10704 |
paragraphs | array | 段落列表 | |
paragraphs[0].paragraphId | String | 段落ID | 16987422100275***** |
paragraphs[0].speakerId | String | 说话者ID | 1 |
paragraphs[0].words | array | 字词列表 | |
paragraphs[0].words[0].id | int | 字词编号 | 10 |
paragraphs[0].words[0].sentenceId | int | 句子ID | 1 |
paragraphs[0].words[0].start | int | 开始时间(毫秒) | 4970 |
paragraphs[0].words[0].end | int | 结束时间(毫秒) | 5560 |
paragraphs[0].words[0].text | String | 字词文本 | 您好, |
output.translationsPath的解析协议
最外层是一个Object,具体字段如下:
参数名 | 类型 | 说明 |
|---|---|---|
paragraphs | list[] | 翻译结果以段落形式组织的集合,和语音识别结果报文对应。 |
paragraphs.paragraphId | string | 段落分段id标识,和语音识别结果中的ParagraphId对应。 |
paragraphs.sentences | list[] | 翻译文本集合。 |
paragraphs.sentences[i].sentenceId | long | 句子id。 |
paragraphs.sentences[i].start | long | 该段相对于音频起始时间的开始时间,相对时间戳,单位毫秒。 |
paragraphs.sentences[i].end | long | 该段相对于音频起始时间的结束时间,相对时间戳,单位毫秒。 |
paragraphs.sentences[i].text | string | 翻译文本,和语音识别结果报文对应。 |
output.autoChaptersPath的解析协议
最外层是一个array,具体字段如下:
参数名 | 类型 | 说明 |
|---|---|---|
[i].id | int | 该章节序号。 |
[i].start | long | 该章节相对于音频起始时间的开始时间,相对时间戳,单位毫秒。 |
[i].end | long | 该章节相对于音频起始时间的结束时间,相对时间戳,单位毫秒。 |
[i].headline | string | 该章节的一句话标题。 |
[i].summary | string | 章节总结。 |
output.summarizationPath的解析协议
最外层是一个Object,具体字段如下:
参数名 | 类型 | 说明 |
|---|---|---|
paragraphSummary | string | 全文摘要结果,以
|
conversationalSummary | list[] | 发言总结摘要结果列表。 |
conversationalSummary[i].speakerId | string | 发言人id。 |
conversationalSummary[i].speakerName | string | 发言人名字。 |
conversationalSummary[i].summary | string | 该发言人对应的总结。 |
questionsAnsweringSummary | list[] | 问答回顾摘要结果列表。 |
questionsAnsweringSummary[i].question | string | 问题 |
questionsAnsweringSummary[i].sentenceIdsOfQuestion | list[] | 提炼出该问题对应的原语音转写的SentenceId列表。 |
questionsAnsweringSummary[i].answer | string | 问题对应的答案。 |
questionsAnsweringSummary[i].sentenceIdsOfAnswer | list[] | 总结出该答案对应的原语音转写的SentenceId列表。 |
mindMapSummary | list[] | 思维导图结果列表。 |
mindMapSummary[i].title | string | 思维导图单个节点的文本内容。 |
mindMapSummary[i].beginTime | int | 思维导图单个节点相较于开始时的时间戳,单位ms,仅存在叶子节点中。 |
mindMapSummary[i].topic | list[] | 思维导图单个节点的子节点列表 |
output.meetingAssistancePath的解析协议
最外层是一个Object,具体字段如下:
参数名 | 类型 | 说明 |
|---|---|---|
keywords | list[] | 关键词提取结果。 |
actions | list[] | 待办内容、待办摘要的集合。 |
actions[i].id | long | 待办序号。 |
actions[i].sentenceId | long | 该关键句在原ASR转写中对应的句子Id。 |
actions[i].start | long | 相对于音频起始时间的开始时间,相对时间戳,单位毫秒。 |
actions[i].end | long | 相对于音频起始时间的结束时间,相对时间戳,单位毫秒。 |
actions[i].text | string | 待办内容。 |
classifications | object | 场景识别分类,目前只有3种场景分类。 |
classifications.interview | float | 面试场景置信度得分。 |
classifications.lecture | float | 演讲场景置信度得分。 |
classifications.meeting | float | 会议场景置信度得分。 |
output.pptExtractionPath的解析协议
最外层是一个Object,具体字段如下:
参数名 | 类型 | 说明 |
|---|---|---|
availableForSummary | boolean | 标识是否存在PPT总结文本。为false表示没有PPT总结结果,为true表示至少有一条。 |
keyFrameList | list[] | PPT结果list,含PPT图片和总结文本。 |
keyFrameList[i].id | long | 序号。 |
keyFrameList[i].start | long | 相对于音频起始时间的开始时间,相对时间戳,单位毫秒。 |
keyFrameList[i].end | long | 相对于音频起始时间的结束时间,相对时间戳,单位毫秒。 |
keyFrameList[i].fileUrl | string | 生成的PPT图片结果,HTTP下载链接。 |
keyFrameList[i].summary | string | 对应的PPT总结。 |
output.textPolishPath的解析协议
最外层是一个array,具体字段如下:
JSON字段 | 类型 | 说明 |
|---|---|---|
[i].formalParagraphText | string | 口语书面化的文本结果。 |
[i].sentenceIds | list | 口语书面化改写内容对应的SentenceId列表。 |
[i].paragraphId | string | 文本结果的段落id,和语音转写结果中的段落id对应。 |
[i].start | long | 文本结果在原音频中的开始时间,相对时间戳,单位为毫秒。 |
[i].end | long | 文本结果在原音频中的结束时间,相对时间戳,单位为毫秒。 |
output.customPromptPath的解析协议
最外层是一个array,具体字段如下:
JSON字段 | 类型 | 说明 |
[i].name | string | 任务相应的dataId |
[i].result | string | 大模型返回结果。 |
[i].truncated | boolean | 是否发生了截断。 |