task-started
クライアントが run-task コマンドを送信した後、サーバーはタスクが開始されたことを示す task-started イベントを返します。クライアントはこのイベントを受信した後にのみ、後続のコマンドを送信できます。
header.task_idstring クライアントによって生成されたタスク ID。 header.event string イベントタイプ。固定値：task-started。 payload object 空のオブジェクト。 | {
"header": {
"task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
"event": "task-started",
"attributes": {}
},
"payload": {}
}
|
result-generated
クライアントがテキストを送信した後、サーバーは継続的に result-generated イベントを返します。各イベントには文レベルのメタデータが含まれます。
header.task_idstring クライアントによって生成されたタスク ID。 header.event string イベントタイプ。固定値：result-generated。 payload.output object 出力情報。 プロパティ type string サブイベントタイプ。有効な値：
sentence-begin：文の開始。合成対象のテキストを返します。sentence-synthesis：オーディオフレームを示します。各イベントの直後に、WebSocket バイナリチャネルを通じて 1 つのオーディオフレームが送信されます。sentence-end：文の終了。テキスト内容と累積文字数を返します。 sentence.index integer 文インデックス。0 から始まります。 sentence.words array 単語レベルのタイムスタンプ配列。 words 要素のプロパティ text string 単語のテキスト内容。 begin_index integer 文内の単語の開始文字インデックス。0 から始まります。 end_index integer 文内の単語の終了文字インデックス。1 から始まります。 begin_time integer 単語に対応する音声の開始時刻（ミリ秒単位）。 end_time integer 単語に対応する音声の終了時刻（ミリ秒単位）。 original_text string 合成用に分割された文のテキスト。 payload.usage object 課金情報。sentence-end イベントで返されます。 プロパティ characters integer 課金対象文字数の累積数。 | {
"header": {
"task_id": "3f2d5c86-0550-45c0-801f-xxxxxxxxxx",
"event": "result-generated",
"attributes": {}
},
"payload": {
"output": {
"sentence": {
"index": 0,
"words": []
},
"type": "sentence-begin",
"original_text": "Before my bed, moonlight shines bright,"
}
}
}
{
"header": {
"task_id": "3f2d5c86-0550-45c0-801f-xxxxxxxxxx",
"event": "result-generated",
"attributes": {}
},
"payload": {
"output": {
"sentence": {
"index": 0,
"words": []
},
"type": "sentence-synthesis"
}
}
}
{
"header": {
"task_id": "3f2d5c86-0550-45c0-801f-xxxxxxxxxx",
"event": "result-generated",
"attributes": {}
},
"payload": {
"output": {
"sentence": {
"index": 0,
"words": [
{
"text": "Before",
"begin_index": 0,
"end_index": 1,
"begin_time": 0,
"end_time": 263
}
]
},
"type": "sentence-end",
"original_text": "Before my bed, moonlight shines bright,"
},
"usage": {
"characters": 6
}
}
}
|
task-finished
タスクが完了すると、サーバーは task-finished イベントを返します。その後、クライアントは WebSocket 接続を閉じるか、再利用して新しいタスクを開始できます。
header.task_idstring クライアントによって生成されたタスク ID。 header.event string イベントタイプ。固定値：task-finished。 payload.usage.characters integer 課金対象文字数の累積数。 | {
"header": {
"task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
"event": "task-finished",
"attributes": {
"request_uuid": "0a9dba9e-d3a6-45a4-be6d-xxxxxxxxxxxx"
}
},
"payload": {
"usage": {
"characters": 13
}
}
}
|
task-failed
タスクが失敗すると、サーバーは task-failed イベントを返します。このイベントを受信すると、クライアントは WebSocket 接続を閉じ、エラーを処理する必要があります。
header.task_idstring クライアントによって生成されたタスク ID。 header.event string イベントタイプ。固定値：task-failed。 header.error_codestring エラーコード。 header.error_messagestring 詳細なエラーメッセージ。 | {
"header": {
"task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
"event": "task-failed",
"error_code": "InvalidParameter",
"error_message": "[tts:]Engine return error code: 418",
"attributes": {}
},
"payload": {}
}
|