メインコンテンツまでスキップ

ユーザ単語登録(公開予定)

ユーザ登録単語のインポート、エクスポートを行うAPIです。

注意

2024年10月上旬ごろに公開予定のAPIです。先行して仕様を公開しています。

ユーザ登録単語の取得​

登録した単語の一覧をJSON形式で取得することができます。

エンドポイント​

GET https://acp-api.amivoice.com/profilewords/<dgn>/<pid>

認証​

APPKEY はAuthorizationヘッダーに指定してください。

Authorization: Bearer {APPKEY}

リクエストパラメータ​

パラメータ名
パラメータ名
注記
dgn接続エンジン名-a-generalなどの接続エンジン名を指定します。指定できる値は音声認識エンジンの一覧を参照してください。パスパラメータとして設定します。
pidプロファイルID任意の文字列。パスパラメータとして設定します。
adf音声データ形式16kまたは8kのいずれかを指定します。指定しない場合は16kとなります。音声認識エンジンによっては複数のサンプリングレートに対応していますが、単語登録は8k、16kでそれぞれ異なるエンジンとしてとりあつかうためにどちらかを指定する必要があります。クエリパラメータとして設定します。

ユーザ登録単語の登録​

指定した音声認識エンジンとプロファイルIDのユーザ登録単語を置き換えることができます。

エンドポイント​

POST https://acp-api.amivoice.com/profilewords/<dgn>/<pid>

認証​

APPKEY はAuthorizationヘッダーに指定してください。

Authorization: Bearer {APPKEY}

リクエストパラメータ​

パラメータ名
パラメータ名
注記
dgn接続エンジン名-a-generalなどの接続エンジン名を指定します。指定できる値は音声認識エンジンの一覧を参照してください。
adf音声データ形式16kまたは8kのいずれかを指定します。指定しない場合は16kとなります。音声認識エンジンによっては複数のサンプリングレートに対応していますが、単語登録は8k、16kでそれぞれ異なるエンジンとしてとりあつかうためにどちらかを指定する必要があります。
pidプロファイルID任意の文字列

コンテンツタイプ

Content-Type: application/json

リクエストボディ

フィールド名
説明
補足
profilewords単語登録情報登録した単語が配列形式で得られます
profilewords[].written表記単語の表記が得られます
profilewords[].spoken読み単語の読みが得られます
profilewords[].classnameクラス名クラス名が得られます。設定されていないときは空文字です

例

{
    "profilewords": [
        {
            "written": "AMI",
            "spoken": "あみ",
            "classname": ""
        },
        {
            "written": "AOI",
            "spoken": "あおい",
            "classname": ""
        }
    ]
}

レスポンス​

成功時​

HTTPステータスコード: 200 OK

レスポンスボディ

フィールド名
説明
補足
profilewords単語登録情報登録した単語が配列形式で得られます
profilewords[].written表記単語の表記が得られます
profilewords[].spoken読み単語の読みが得られます
profilewords[].classnameクラス名クラス名が得られます。設定されていないときは空文字です

例

{
    "profilewords": [
        {
            "written": "AMI",
            "spoken": "あみ",
            "classname": ""
        },
        {
            "written": "AOI",
            "spoken": "あおい",
            "classname": ""
        }
    ]
}

失敗時​

HTTPステータスコード: 200以外

レスポンスボディ

フィールド名
説明
補足
codeエラーコードエラーの種別を示すコード
messageエラーメッセージエラー内容の詳細を説明するテキスト

エラーコードとエラーメッセージ

HTTPステータスコード
レスポンスボディエラーの状況
404 Not Found{"code":"?","message":"missing dictation grammar file name"}ディクテーショングラマファイル名 <dgn> が指定されていない時
404 Not Found{"code":"?","message":"missing profile id"}プロファイル ID <pid> が指定されていない時
405 Method Not Allowed{"code":"?","message":"POST method is not allowed"}POST が指定された時
400 Bad Request{"code":"-","message":"missing request body"}POST メソッドでリクエストされたのにリクエストボディが指定されていない時
400 Bad Request{"code":"-","message":"invalid request body (<optionalMessage>)"}リクエストボディが JSON として正しくない時
422 Unprocessable Entity{"code":"-","message":"missing profile words"}リクエストボディに指定された JSON が期待した形式でない時
422 Unprocessable Entity{"code":"-","message":"invalid written: <written>"}リクエストボディに指定された JSON の中の表記／読み／単語クラスが正しくない時
422 Unprocessable Entity{"code":"-","message":"invalid written: <spoken>"}リクエストボディに指定された JSON の中の表記／読み／単語クラスが正しくない時
422 Unprocessable Entity{"code":"-","message":"invalid written: <className>"}リクエストボディに指定された JSON の中の表記／読み／単語クラスが正しくない時
401 Unauthorized{"code":"-","message":"can't verify service authorization"}サービス認証キー文字列の認証に失敗した時
401 Unauthorized{"code":"-","message":"service authorization has expired: <expirationTime> (<expiresIn>)"}サービス認証キー文字列の認証に失敗した時
500 Internal Server Error{"code":"?","message":"unexpected exception occurred (<optionalMessage>)"}想定外の例外が発生した時

例

{
    "code":"?",
    "message":"missing dictation grammar file name"
}