ユーザー辞書の単語の登録
POST/profilewords/:dgn/:pid
指定した音声認識エンジンとプロファイルIDのユーザー辞書の単語を置き換えることができます。
リクエストボディの形式は、接続するエンジンによって異なります。
- ハイブリッドエンジン:
written（表記）とspoken（読み）で単語を登録します。classname（クラス名）は省略可能です。 - End to End エンジン:
written（表記）をalternativewritten（代替表記）に置き換えて単語を強調します。biasing（単語強調度、0 ～ 1、既定は 0.5）で強調の強さを指定します。
End to End エンジンでは、同一の表記に対して複数の代替表記を指定することも可能です。この時、同一の表記の単語に対しては同一の単語強調度が適用されます。もしリクエスト時に同一の表記に対して異なる単語強調度を指定した場合、リクエスト中に一番最初に登場するものの単語強調度の値が採用されます。例えば、同一の表記「AMI」に単語強調度 0.8 と指定なしの 2 件を指定した場合、一番最初に登場するものに適用される値「0.8」が統一して適用されます。
リクエスト
レスポンス
- 200
- 400
- 401
- 404
- 422
- 500
登録した単語の一覧をJSON形式で返します。
リクエストボディが正しくない時に返されます。
| レスポンスボディ | エラーの状況 |
|---|---|
{"code":"-","message":"missing request body"} | POST メソッドでリクエストされたのにリクエストボディが指定されていない時 |
{"code":"-","message":"invalid request body (<optionalMessage>)"} | リクエストボディが JSON として正しくない時 |
API キー（サービス認証キー文字列）の認証に失敗した時に返されます。
| レスポンスボディ | エラーの状況 |
|---|---|
{"code":"-","message":"can't verify service authorization"} | API キーの認証に失敗した時 |
{"code":"-","message":"service authorization has expired: <expirationTime> (<expiresIn>)"} | API キーの有効期限が切れている時 |
パスパラメータが指定されていない時に返されます。
| レスポンスボディ | エラーの状況 |
|---|---|
{"code":"?","message":"missing dictation grammar file name"} | 接続エンジン名 <dgn> が指定されていない時 |
{"code":"?","message":"missing profile id"} | プロファイル ID <pid> が指定されていない時 |
リクエストボディに指定された JSON が期待した形式でない時に返されます。
| レスポンスボディ | エラーの状況 |
|---|---|
{"code":"?","message":"missing profile words"} | JSON が期待した形式でない時 |
{"code":"?","message":"invalid written: <written>"} | 表記が正しくない時 |
{"code":"?","message":"invalid spoken: <spoken>"} | 読みが正しくない時 |
{"code":"?","message":"invalid class name: <className>"} | 単語クラスが正しくない時 |
{"code":"?","message":"invalid alternative written: <alternativeWritten>"} | 代替表記が正しくない時 |
想定外の例外が発生した時に返されます。
| レスポンスボディ | エラーの状況 |
|---|---|
{"code":"?","message":"unexpected exception occurred (<optionalMessage>)"} | 想定外の例外が発生した時 |