mcpField
P
plaud-embedded-transcription-api-skill

plaud-embedded-transcription-api-skill

github.com/plaud-ai生产力1375 次安装3 周前更新
代码仓库

关于 plaud-embedded-transcription-api-skill

为使用 Plaud 转录流程的开发者提供音频上传与转录 API 操作指引。技能说明如何提交文件 URL、轮询异步任务,并配置语言检测和说话人识别等选项。

主要功能

  1. 01指导提交音频转录任务
  2. 02说明异步任务状态轮询
  3. 03提供分段文件上传流程
  4. 04配置语言与检测级别
  5. 05启用说话人识别及嵌入向量
  6. 06说明转录结果字段

适用场景

  1. 01转录已有公开下载链接的音频
  2. 02上传本地音频后提交转录
  3. 03轮询任务并读取时间对齐文本
  4. 04为转录配置语言或说话人识别

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/plaud-ai/plaud-embedded-skills --skill plaud-embedded-transcription-api-skill

安装后在 Claude Code 中输入/plaud-embedded-transcription-api-skill确认已加载。

详细介绍

Plaud 嵌入式转录 API 技能

此技能提供如何将音频文件上传到 Plaud 进行转录的背景信息和说明。

何时使用此技能

当用户想要使用 Plaud 的转录流程转录音频文件时,请使用此技能(该流程会执行语言检测、降噪、ASR、语音转文本等操作)。

前提条件
  • 用户拥有以下任一来源的音频文件:
    1. 从 Plaud 设备同步到其移动应用中的文件
    2. 可通过公开 URL 下载的音频文件(例如 S3 下载 URL)

Plaud 转录 API 的工作原理

转录 API 是一款 AI API,包含两个主要端点。

  1. 提供用于下载音频文件的 file_url,触发一个异步转录任务
  2. 获取转录任务状态以进行轮询;任务完成后,即可获取对话转录文本

如何开始转录

转录 API 本身需要一个公开下载 URL 来下载音频文件。

如果开发者目前没有上传文件并生成公开下载 URL 的方式,请使用文件上传 API。

否则,请跳过文件上传 API,直接使用转录 API。

文件上传 API [仅适用于没有下载 URL 来访问音频文件的用户]

文件上传 API 用于使用 Plaud 云存储上传音频文件。 可通过移动应用或后端执行此操作。

请阅读文件上传概览,了解可用的文件上传 API 端点和数据流。

这是一个三步分段上传流程:

  1. 使用 filesize 和 filetype 调用 POST /generate-presigned-urls → 返回 FileId、UploadId、ChunkSize 和一个包含预签名 S3 URL 的 Parts 数组
  2. 向每个 PresignedUrl 执行 PUT,上传不超过 ChunkSize 的原始字节(无需身份验证——这些 URL 已预签名)。保留每次 PUT 响应头中的 ETag——下一步需要用到
  3. 使用 file_id、upload_id、包含 PartNumber/ETag 对的 part_list、filetype 和 file_md5 调用 POST /complete-upload → 返回 DownloadUrl

重要:返回的 DownloadUrl 有效期为 24 小时。请将其作为 file_url 传递给转录 API。

API 参考(不包含上传步骤,因为该步骤直接上传到 S3)
转录 API

将音频文件上传到公共下载 API(通过文件上传 API 或用户专属的云存储)后,用户即可使用转录 API 处理该文件 URL。

转录 API 概述介绍了 Plaud 的转录流程。

重要提示:转录 API 使用 X-Client-Id 和 X-Client-Api-Key 请求头进行身份验证(api_key 不是你的 client_secret——请从开发者门户的 App Settings > API Keys 中获取)。

file_url 支持的音频格式为 M4A、MP3 和 WAV。超过 5 小时的录音应拆分成多个片段,分段进行转录。

POST 接受可选的 params 对象,用于调整处理流程:

参数默认值用途
transcribe.languageautoBCP-47 语言代码(en-US、zh-CN)或 auto
transcribe.detection_levelsegment语言识别级别(segment 或 chapter)
vad.decode_silencefalse是否解码静音片段
diarization.enabledfalse识别并标记说话者
diarization.return_embeddingfalse返回说话者嵌入向量

轮询:任务进行期间,GET 端点会返回 PENDING、RECEIVED、STARTED 或 PROGRESS 状态——请继续轮询。SUCCESS 表示 data 已填充。FAILURE 和 REVOKED 是终止失败状态——应妥善处理,不要无限轮询。

任务状态为 SUCCESS 时,data 包含 text、language、duration(秒)以及一个按时间对齐的片段数组;每个片段包含 start、end、text,启用说话者区分时还包含 speaker_id,以及 language 和语言置信度概率。

API 参考

参考代码

完成标准 - 转录 API 实现完成

当用户可以:

  • (如果用户尚无公共下载 URL)通过文件上传 API,将音频文件从其移动应用上传到 Plaud 的托管存储
  • 提交转录 API 请求并获取转录结果

评论

支持 Markdown