sコマンドパケット／sコマンド応答パケット
s コマンドパケットと s コマンド応答パケットは、対になっています。 s コマンドで音声データ送信開始をサーバに通知すると、サーバは s コマンド応答パケットを返します。
s コマンド応答パケットが "s" 一文字の場合は成功です。続けて p コマンドパケットによる音声データの供給を始めることができます。音声データの送信がすべて終了したら e コマンドパケットで送信終了を通知しますが、その後も接続が維持されていれば、再び s コマンドパケットから再開できます。
s コマンドパケット
音声データ送信を開始します。 送信開始を通知することに加えて、送信する音声のフォーマットや使用したい音声認識エンジン（接続エンジン名）、認証情報（APPKEY）その他のパラメータを送信する必要があります。
形式
タ イプ TEXT
s <audio_format> <grammar_file_names>
s <audio_format> <grammar_file_names> <key>=<value> ...
s および各パラメータブロックの区切り文字は、半角スペースです。 以下に各パラメータの詳細について説明します。
<audio_format>
送信する音声フォーマットを指定します。このパラメータは必須です。指定できるフォーマット名については、利用ガイドの音声フォーマットについてを参照してください。
<grammar_file_names>
接続エンジン名を指定します。このパラメータは必須です。
<key>
<key> には、以下のキー文字列が指定できます。 <value> にスペースが含まれる場合は、value の前後を半角ダブルコーテーション「"」で囲みます。
| <key> | 説明 |
|---|---|
| authorization | authorization にはマイページに記載された[APPKEY] 、または、ワンタイム APPKEY 発行 APIで取得したワンタイム APPKEY を設定します。このパラメータは必須です。 |
| profileId | profileId は、ユーザー辞書でユーザー固有の単語を登録する場合の、ユーザー固有のデータファイル（プロファイル）の ID です。そのプロファイルを指定して使用できるのは、そのユーザーのみです。プロファイルは、ユーザー固有の領域に格納されますので、他のユーザーとの名前の衝突は起きません。 ※ profileId には、半角英数文字、および、「-」(半角マイナス)、「_」(半角アンダーライン) で構成される文字列を指定します。ただし、「__」(半角アンダーライン 2 文字)ではじまる文字列は、 音声認識エンジン側で予約されていますので、「__」(半角アンダーライン 2 文字)ではじまる文字列は 指定しないようにしてください。 マイページのユーザー辞書登録で単語を登録すると、マイページの 接続情報に記載のあるサービス ID（アカウント ID から自動生成されます）と同じ名前のプロファイルがサーバ上に自動的に作成保存されます。このプロファイルを利用して音声認識を行いたいときは、**「サービス ID の先頭に半角コロン":"を付加した文字列」**を、 profileId に指定します。（例）サービス ID が「aiueo12345」の場合、「:aiueo12345」を profileId の値とします。 ユーザー辞書 ユーザー辞書の単語の登録は、マイページのユーザー辞書登録画面で行うのがもっとも簡単です。このほかに、ユーザー辞書登録 API を使用する方法や、リクエスト毎に設定する方法があります。それぞれの詳細はユーザー辞書登録の方法を参照してください。 |
| profileWords | profileWords パラメータには単語登録または単語強調として設定したい単語の情報を設定します。ハイブリッドエンジンの単語登録の場合は『表記<半角スペース>読み』のように、End to End エンジンの単語強調の場合は『表記<半角スペース>代替表記<半角スペース>単語強調度』のように登録します。複数登録する場合は「 | 」で区切ります。送信時は profileWords パラメータの値全体を「"」で囲みます。 ※単語登録でクラス名を指定する場合は、『表記<半角スペース>読み <半角スペース> クラス名』としてください。単語強調の代替表記や単語強調度は省略可能ですが、代替表記を省略する場合は『表記<半角スペース><半角スペース>単語強調度』としてください。 |
| keepFillerToken | 発話に含まれるフィラー単語（「あー」や「えー」など）を認識結果文字列に含めたい場合には、以下のように指定します。 keepFillerToken=1 フィラー単語には様々なものがありますが、すべて、表記の前後が半角の%で囲まれています。（例） %あー% %えー% %おー% %えーっと% keepFillerToken=1 の指定をしていない場合、フィラー単語は認識結果文字列から除去されます。 |
| segmenterProperties | 発話検出のパラメータです。話者ダイアライゼーションの有効・無効を制御したり、結果を調整するためのパラメータを設定できます。複数のパラメータを空白で区切って設定できます。 segmenterProperties="key1=value1 key2=value2..." 設定できるパラメータは以下のとおりです。 useDiarizer 1を設定すると話者ダイアライゼーションが有効になります。 ・指定可能な値: 0 または 1 ・デフォルト値: 0 diarizerAlpha 新規話者の出現しやすさを制御するパラメータです。 大きな値を指定するほど新規話者が出現しやすくなり、小さな値を指定するほど新規話者が出現しづらくなります。 useDiarizer=1のときのみ有効です。・指定可能な値: 0以上 ・目安となる範囲: 1e-100～1e50 ・デフォルト値: 1 diarizerTransitionBias 話者の切り替わりやすさを制御するパラメータです。 大きな値を指定するほど話者が切り替わりやすくなり、小さな値を指定するほど話者が切り替わりづらくなります。 useDiarizer=1のときのみ有効です。・指定可能な値: 0以上1未満 ・目安となる範囲: 1e-150～1e-10 ・デフォルト値: 1e-40 (8kの場合は、1e-20) |
マイページで登録した単語を利用したい場合の s コマンド
s MSB16K -a-general profileId=:<サービスID> authorization=XXXXXXXXXXXXXX
このセッションのために一時的に単語登録する場合の s コマンド
s MSB16K -a-general profileWords="AMI あみ|AmiVoice あみぼいす" authorization=XXXXXXXXXXXXXX
上の例は、profileId を指定せず 、 "AMI あみ|AmiVoice あみぼいす"（2 単語）を登録しています。続けて、このセッションの中で音声データを送信すれば、これらの単語が認識処理に利用されます。その後、e コマンドパケットを送信（セッション終了）すれば、これらの単語は無効になり、保存されることもありません。
ユーザー辞書の使用方法
プロファイルに登録した単語を利用して音声認識を行うためには、ｓコマンドパケットを送信するときの profileId に、以前にユーザー辞書の登録を行ったプロファイルの profileId を、先頭に「：」（半角コロン）を付けて指定します。
複数のメンバーが利用する場合で、profileId の先頭に「：」をつけないで指定した場合は、認識精度が低下する場合があります。
独自プロファイルを音声認識に利用したい場合の s コマンド
s MSB16K -a-general profileId=:test authorization=XXXXXXXXXXXXXX
s コマンド応答パケット
s コマンドに対する応答としてサーバからクライアントに送信されます。
形式
タイプ TEXT
開始要求成功時の応答パケット
送信開始要求が成功すると、s 一文字が返ります。
s
開始要求失敗時の応答パケット
送信開始要求が失敗すると、s の後ろに半角スペースを挟んでエラーメッセージが返ります。
s <error_message>
エラーメッセージ
クライアントエラー
sコマンドのリクエストパラメータや認証情報の誤りによるエラーです。修正してから再度リクエストを送信し てください。
| エラーメッセージ | 内容 |
|---|---|
| s received unsupported audio format | 指定された音声フォーマットに誤りがありました。 |
| s can't verify service authorization | 認証に失敗しました。以下のいずれかの理由です。 - APPKEYが設定されていません - 設定されたAPPKEYに誤りがあります - ワンタイム APPKEYで制限されたIPアドレス外からアクセスしました |
| s can't validate service authorization | 認証に失敗しました。以下のいずれかの理由です。 - 設定されたAPPKEYに誤りがあります（アカウントが無効になっている場合も含む） - 指定された接続エンジン名に誤りがあります（例： -a-generalをa-generalなどと記述するタイプミス、AmiVoice API Private の契約をしていない状態で Private 専用のエンジンを指定する、など） |
| s service authorization has expired: <expirationTime> <expiresIn> | ワンタイム APPKEYで制限した有効期限がきれています。 |
| s can’t connect to recognizer server | 認証に失敗しました。ワンタイム APPKEYが不正です。 |
| s can’t connect to recognizer server (can’t find available servers) | 指定された接続エンジン名に対して音声フォーマットのサンプリングレートの組み合わせが正しくなく、適切なエンジンを見つけられないため、接続に失敗しました。 たとえば、8k のサンプリングレートに対応していないエンジンに対して 、8k の音声フォーマットを指定した場合などが該当します。各音声認識エンジンが対応しているサンプリングレートについては、音声認識エンジンの一覧を参照してください。 |
| s can't start feeding audio data to recognizer server | 指定されたセグメンターのパラメータに誤りがあり、音声データの送信開始処理に失敗しました。 |
サーバーエラー
基盤システムの障害などによって稀に起きてしまう可能性のあるエラーです。しばらく待ってから再度リクエストを送信してください。
| エラーメッセージ | 内容 |
|---|---|
| s can't connect to recognizer server (can't connect to server)" | 音声認識サーバに接続できませんでした。 |
| s can’t connect to recognizer server (can’t find available servers because all requested servers are busy) | 指定された接続エンジン名や音声フォーマットに対する適切な音声認識サーバの全て混雑しているために接続できませんでした。 |
| s can't connect to recognizer server (can't find available servers because maximum allowed clients has reached) | 接続可能なクライアント数の上限に達しているため、音声認識サーバに接続できませんでした。 |
| s can't connect to recognizer server (can't send data) | 基盤システム内のサーバ間の通信エラーにより接続に失敗しました。 |
| s can't connect to recognizer server (can't receive data) | 基盤システム内のサーバ間の通信エラーにより接続に失敗しました。 |
| s can't connect to recognizer server (disconnected by force) | 基盤システム内のサーバ間の通信エラーにより接続に失敗しました。 |
制限事項によるエラー
制限事項に抵触した場合に発生します。sコマンドのリクエストからやり直してください。
| エラーメッセージ | 内容 |
|---|---|
| s session timeout occurred | セッションタイムアウトが発生しました。制限事項のセッションの最大時間を超えた場合に発生します。サーバ側から切断処理を行いました。 |