plaud-embedded-transcription-api-skill について
Plaudの文字起こしパイプラインを使う開発者向けのAPIガイドスキルです。音声URLの送信、非同期ジョブのポーリング、言語検出や話者識別などの設定方法を説明します。
主な機能
- 01音声文字起こしの送信手順
- 02非同期ステータスのポーリング方法
- 03マルチパートアップロード手順
- 04言語と検出レベルの設定
- 05話者ラベルと埋め込みの有効化
- 06文字起こし結果の項目説明
活用シーン
- 01公開ダウンロードURLの音声を文字起こし
- 02音声をアップロードしてから文字起こし
- 03ジョブをポーリングして整列テキストを取得
- 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 Embedded Transcription API スキル
このスキルでは、文字起こしのために Plaud に音声ファイルをアップロードする方法について、コンテキストと手順を説明します。
このスキルを使用するタイミング
Plaud の Transcription Pipeline(言語検出、ノイズ除去、ASR、音声からテキストへの変換などを行うパイプライン)を使用して音声ファイルを文字起こししたいというユーザーの要望がある場合に、このスキルを使用してください。
前提条件
- ユーザーが次のいずれかの場所に音声ファイルを持っていること:
- Plaud デバイスから同期されたモバイルアプリ
- パブリック URL(S3 のダウンロード URL など)からダウンロード可能な音声ファイル
Plaud の Transcription API の仕組み
Transcription API は、主に 2 つのエンドポイントを備えた AI API です。
- 音声ファイルをダウンロードするための
file_urlを指定して、非同期の文字起こしジョブを開始します - ポーリングで文字起こしタスクのステータスを取得します。タスクが完了すると、会話の文字起こし結果を利用できます
文字起こしの開始方法
Transcription API では、音声ファイルをダウンロードするためにパブリックなダウンロード URL が必要です。
開発者がファイルをアップロードしてパブリックなダウンロード URL を生成する手段をまだ持っていない場合は、File Upload API を使用してください。
それ以外の場合は、File Upload API を使用せず、Transcription API を直接使用してください。
File Upload API [ダウンロード URL を使って音声ファイルにアクセスできないユーザーのみ対象]
File Upload API は、Plaud のクラウドストレージを使用して音声ファイルをアップロードするための API です。 モバイルアプリまたはバックエンドから実行できます。
利用可能な File Upload API のエンドポイントとデータフローについては、File Upload の概要をお読みください。
3 ステップのマルチパートアップロードです。
filesizeとfiletypeを指定してPOST /generate-presigned-urlsを実行すると、FileId、UploadId、ChunkSize、および署名付き S3 URL を含むParts配列が返されます- 各
PresignedUrlに最大ChunkSizeの生バイトデータをPUTします(認証は不要です。署名付き URL のためです)。すべてのPUTで返されるETagレスポンスヘッダーを保存してください。次のステップで必要になります file_id、upload_id、PartNumberとETagのペアを含むpart_list、filetype、およびfile_md5を指定してPOST /complete-uploadを実行すると、DownloadUrlが返されます
重要:返される DownloadUrl の有効期間は 24 時間です。Transcription API の file_url として渡してください。
API リファレンス(アップロードのステップは S3 に直接アップロードするため含まれていません)
文字起こし API
音声ファイルを公開ダウンロード API(ファイルアップロード API 経由、またはユーザー固有のクラウドストレージ経由)にアップロードした後、ユーザーはファイル URL を使って文字起こし API を利用できます。
文字起こし 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.language | auto | BCP-47 コード(en-US、zh-CN)または auto |
transcribe.detection_level | segment | 言語識別のレベル(segment または chapter) |
vad.decode_silence | false | 無音区間をデコードするかどうか |
diarization.enabled | false | 話者を識別し、ラベル付けするかどうか |
diarization.return_embedding | false | 話者の埋め込みベクトルを返すかどうか |
ポーリング:タスクの処理中、GET エンドポイントは PENDING、RECEIVED、STARTED、PROGRESS のいずれかの status を返します。ポーリングを続けてください。SUCCESS は data に値が設定されたことを意味します。FAILURE と REVOKED は終端状態の失敗です。ポーリングを続けるのではなく、適切に処理してください。
SUCCESS の場合、data には text、language、duration(秒)、および時間情報が対応付けられたセグメントの配列(start、end、text、話者分離が有効な場合は speaker_id、language、言語の信頼度を示す確率)が含まれます。
API リファレンス
参考コード
- iOS — Plaud Starter App の TranscriptionManager.swift
- Android — Plaud Starter App の TranscriptionManager.kt
完了の定義 - 文字起こし API の実装完了
ユーザーが次の操作を行えること:
- (ユーザーが公開ダウンロード URL をまだ持っていない場合)ファイルアップロード API を介して、モバイルアプリから Plaud の管理ストレージに音声ファイルをアップロードする
- 文字起こし API にリクエストを送信し、文字起こし結果を取得する