YOMEL Webhookの仕様について#
設定方法#
当社でYOMEL側から送信先のエンドポイントURLとトリガーとなるイベントを登録する必要があります。
送信先エンドポイントとトリガーとなるイベントを営業担当へお伝えください。YOMELサーバーからアクセスできないURLやプライベートネットワークアドレスでは利用できません。外部からアクセス可能なエンドポイントURLを用意してください。
YOMELでは会話や会議を一つのログとして管理します。会話が始まると、YOMELでの吹き出し単位でリアルタイム書き起こしの結果が生成され、会話が終了すると一つのログとして保存されます。
会話が終了すると話者分離や要約が行われ、処理が完了次第、そのログに属した話者分離結果や要約結果が保存されます。
※ 話者分離・要約処理はオプショナルなため、結果がない場合があることに注意データの受信について#
メソッド#
このWebhookではYOMELサーバーから指定されたURLにPOSTでデータを送信します。
イベント#
Webhookが発動されるイベントは次の通りです。
レスポンスパラメータ:type によってどのイベントが発動したか判定できます。| 発動タイミング | イベントタイプ(レスポンスパラメータ:type ) | プロセスタイプ(レスポンスパラメータ:process_type) | 送信オブジェクト |
|---|
| リアルタイム書き起こし発生時 | UserAccountLogRealtime | created | 吹き出し単位のリアルタイム書き起こしテキスト |
| 会議終了時 | UserAccountLog | updated | 書き起こし結果テキスト(全文) |
| 話者分離完了時 | UserAccountLogDiarization | updated | 話者分離結果テキスト |
| 要約処理完了時 | UserAccountLogSummaryGPT3 | updated | 要約結果テキスト |
エラー・リトライについて#
データ受信後はステータスコード200番台で応答するようにしてください。
200番台以外のレスポンスを検知した場合や10秒以内に応答がなかった場合は送信失敗とみなします。
エラーの累計が100回に対象の Webhook が無効化されます。利用再開をご希望の場合は、営業担当者までお問い合わせください。