AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页 音视频通信 开发参考 API参考 API目录 纪要 StartCloudNote - 开始纪要任务

StartCloudNote - 开始纪要任务

更新时间：
复制为 MD 格式
产品详情
我的收藏

开启智能纪要

接口说明

使用说明

本接口用于开始在线频道的纪要任务。如果需要纪要和字幕，建议把所有功能都启用。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

说明

并发限制

  • 同一频道同时只允许一个纪要任务存在。

  • 同一频道可以多次发起开启和停止纪要任务，但是每次 TaskId 需要不同。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rtc:StartCloudNote

create

*App

acs:rtc:*:{#accountId}:app/{#AppId}

 无 无

请求参数

名称

类型

必填

描述

示例值
AppId

string

是

应用 ID。

2ws***z3
ChannelId

string

是

频道 ID。

test
TaskId

string

是

任务 ID。

rtc
StorageConfig

object

是

存储配置。

Vendor

integer

是

存储平台。取值：

vendor对象存储产品备注
1AliYun OSS阿里云

1
Region

integer

是

存储地域。

RegionAliYun OSS
0CN_Hangzhou
1CN_Shanghai
2CN_Qingdao
3CN_Beijing
4CN_Zhangjiakou
5CN_Huhehaote
6CN_Shenzhen
7CN_Hongkong
8US_West_1
9US_East_1
10AP_Southeast_1
11AP_Southeast_2
12AP_Southeast_3
13AP_Southeast_5
14AP_Northeast_1
15AP_South_1 （已下线，请勿使用）
16EU_Central_1
17EU_West_1
18EU_East_1(ME_East_1)
19AP_Southeast_6
20CN_Heyuan
21CN_Guangzhou
22CN_Chengdu
23CN_Nanjing
24CN_Fuzhou
25CN_Wulanchabu
26AP_Northeast_2
27AP_Southeast_7

0
Bucket

string

是

存储桶名称。

test-bucket-for-recording
AccessKey

string

是

accessKey。

LTAX***
SecretKey

string

是

secretKey。

APb6qWYEzKtYxE***
SourceLanguage

string

否

频道使用的源语言模型。

  • cn 中文

  • yue 粤语

  • en 英文

  • multilingual 多语种

  • ja 日语

  • ko 韩语

  • de 德语

  • fr 法语

  • ru 俄语

  • es 西班牙语

  • vi 越南语

  • it 意大利语

  • sv 瑞典语

  • cs 捷克语

  • pl 波兰语

  • th 泰语

  • fi 芬兰语

  • hi 印地语

  • id 印尼语(印度尼西亚)

  • pt 葡萄牙语

  • ar 阿拉伯语

  • fil 菲律宾语

  • ms 马来语

  • tr 土耳其语

  • hu 匈牙利语

  • lo 老挝语

  • pt-br 葡萄牙语(巴西)

  • es-ar 西班牙语(阿根廷)

  • es-mx 西班牙语(墨西哥)

cn
LanguageHints

array

否

该参数已废弃，无需传递。

string

否

  • cn 中文

  • en 英文

  • ja 日语

  • ko 韩语

  • de 德语

  • fr 法语

  • ru 俄语

  • es 西班牙语

  • vi 越南语

  • it 意大利语

  • sv 瑞典语

  • cs 捷克语

  • pl 波兰语

  • th 泰语

  • fi 芬兰语

  • hi 印地语

  • id 印尼语(印度尼西亚)

  • pt 葡萄牙语

  • ar 阿拉伯语

  • fil 菲律宾语

  • ms 马来语

  • tr 土耳其语

  • hu 匈牙利语

  • lo 老挝语

  • pt-br 葡萄牙语(巴西)

  • es-ar 西班牙语(阿根廷)

  • es-mx 西班牙语(墨西哥)

ko
Transcription

object

否

转写功能，默认开启。

DiarizationEnabled

boolean

否

是否开启说话人分离功能。

SpeakerCount

integer

否

设置说话人分离参数，默认 0。 0：说话人角色区分结果为不定人数。 2：说话人角色区分结果为 2 人。

2
TranscriptionLevel

integer

否

语音识别结果返回等级，默认 2。 1：识别出完整句子时返回识别结果； 2：识别出中间结果及完整句子时返回识别结果；

1
PhraseId

string

否

热词表 ID。

b27cb31b8ca24c5b8e664e0387bac573
AutoChapters

object

否

章节速览功能，开启后会生成章节标题和章节摘要结果。

Enabled

boolean

否

是否开启。

MeetingAssistance

object

否

智能纪要功能，开启后会生成关键词、重点内容、待办等结果

Enabled

boolean

否

是否开启。

MeetingAssistanceType

array

是

设置智能纪要功能的算法类型。

string

是

具体算法。

Actions：待办事项。

KeyInformation：关键信息(含关键词和重点内容)。

Actions
Summarization

object

否

摘要功能，开启后会可以生成全文摘要、发言人总结等结果。

Enabled

boolean

否

是否开启。

Type

array

是

具体类型。

string

是

开启摘要功能时，需传入期望的摘要类型。

Paragraph：全文摘要

Conversational：发言人总结摘要

QuestionsAnswering：问答回顾摘要

Conversational
TextPolish

object

否

口语书面化功能。

Enabled

boolean

否

是否开启。

ServiceInspection

object

否

服务质检功能。

Enabled

boolean

否

是否开启。

SceneIntroduction

string

是

服务质检对话场景介绍。

汽车门店线下销售场景
InspectionIntroduction

string

是

服务质检的检测目标和侧重点描述。

请监测对话中销售人员表现是否接待热情、态度良好
InspectionContents

array<object>

是

服务质检的质检维度列表，包含质检维度名称和定义，即需要大模型以什么样的标准判断该维度是否命中。

object

是

具体规则。

Title

string

是

服务质检的质检维度名称。

到店欢迎-欢迎语
Content

string

是

服务质检的质检维度定义。

销售在开场白的时候主动向客户打招呼进行欢迎
CustomPrompt

object

否

自定义 Prompt 控制参数对象。

Enabled

boolean

否

是否开启。

CustomPromptContents

array<object>

是

自定义 Prompt 的参数列表。

object

否

具体 Prompt。

Name

string

是

Prompt 的自定义名称，用于匹配输出结果。

split-summary-demo
Prompt

string

是

Prompt 的自定义内容，需要包含{Transcription}标签，{Transcription}会被自动替换为语音转写结果来作为模型输入。

请帮我将下面的对话进行总结，根据发言人来总结:\n {Transcription}
Model

string

否

指定 Prompt 的模型，目前可选择 tingwu-turbo、tingwu-plus 和 qwen-max。如果不填写该参数，会默认设置为 tingwu-turbo。

tingwu-turbo
TransType

string

否

指定{Transcription}标签格式，目前可选 chat 和 default。

chat: 转写结果包含发言人信息。

default: 转写结果为纯文本格式。

chat
RealtimeSubtitle

object

否

实时字幕。

AsrCallback

boolean

否

是否同时回传给服务端。

true
Enabled

boolean

否

是否开启。

Translation

object

否

翻译参数，具体翻译目标语言可以通过 SDK 设置。

TranslateLevel

integer

否

翻译文本输出等级 ，默认 2。

1: 识别完整句子时返回结果。

2: 识别中间结果及完整句子时返回结果。

1

返回参数

名称

类型

描述

示例值

object

result

TaskId

string

本次任务 ID。

123
RequestId

string

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CF8

示例

正常返回示例

JSON格式

{
  "TaskId": "123",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CF8"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：DeleteCloudNotePhrases - 删除热词表下一篇：StopCloudNote - 停止纪要任务