AudioSpeechActionオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.0 |
since | 8.0.0 |
音声生成アクションを実行するためのクラスです。
Java版のAudioSpeechActionクラスとは異なり、直接インスタンスを生成して利用可能です。
このAPIを利用するためには以下の前提条件を満たしている必要があります。
実装例は以下の通りです。
Java版のAudioSpeechActionクラスとは異なり、直接インスタンスを生成して利用可能です。
このAPIを利用するためには以下の前提条件を満たしている必要があります。
- モジュール構成にて「IM-Copilot」モジュールを選択し WARファイルが作成されていること
- IM-Copilot ドライバ設定ファイルにて、利用テナントについて、アクセス先のLLMのドライバ設定が行われていること
- IM-Copilot アクション設定ファイルにて、利用テナントについて、アクション種別"audio-speech"の設定がドライバ種別「open-ai」を指定して行われていること
実装例は以下の通りです。
- オプション指定ありで、オプションにByteWriterを指定して生成した音声を保存する場合
var action = new AudioSpeechAction(); var result; var storage = new PublicStorage('momotarou.mp3'); // この記述方法の場合、オプションに与えるByteWriterは自動的にcloseされます。 storage.createAsBinary(function(writer, error) { result = action.execute('むかしむかし、あるところに、お爺さんとお婆さんが住んでいました。', { model: 'tts-1-hd', output: writer }); }); // // 成功した場合 // // 処理結果オブジェクトのdataプロパティにはnullが設定され、オプションで指定したByteWriterに結果が書き込まれます。 // result = { // error: false, // data: null // }; // // 失敗した場合 // // 詳細なエラー内容は、出力される例外ログ内に記載されます。 // result = { // error: true, // data: null, // errorMessage: 'OpenAIにて音声生成に失敗しました。' // };
- オプション指定なしで、返り値のByteReaderを利用して生成した音声を保存する場合
var action = new AudioSpeechAction(); var result = action.execute('むかしむかし、あるところに、お爺さんとお婆さんが住んでいました。'); if (!result.error) { var reader = result.data; // この記述方法の場合、返り値のByteReaderをtry-finally文を利用して自前でcloseする必要があります。 try { var storage = new PublicStorage('momotarou.mp3'); storage.createAsBinary(function(writer, error) { reader.transferTo(writer); }); } finally { reader.close(); } }
コンストラクタの概要
AudioSpeechAction () コンストラクタ。設定ファイルの記述に従って音声生成アクションを作成します。 |
メソッドの概要
返却値の型 | メソッド名 |
---|---|
ResultObject | execute (String text , AudioSpeechOption [option] ) 音声生成を実行します。 |
String | getActionType () このアクションの種別を返します。 |
String | getDriverType () このアクションのドライバ種別を返します。 |
コンストラクタの詳細
AudioSpeechAction ()
コンストラクタ。設定ファイルの記述に従って音声生成アクションを作成します。
|
メソッドの詳細
ResultObject execute (String text , AudioSpeechOption [option] )
音声生成を実行します。
パラメータ
返却値
|
String getActionType ()
このアクションの種別を返します。
音声生成アクションでは、固定で"audio-speech"です。
返却値
|
String getDriverType ()
このアクションのドライバ種別を返します。
返却値
|