ユーザー単語登録

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

ユーザー登録単語の取得

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

エンドポイント

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

認証

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

Authorization: Bearer {APPKEY}

リクエストパラメータ

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

プロファイル一覧の取得

プロファイルの一覧をJSON形式で取得することができます。

エンドポイント

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

認証

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

Authorization: Bearer {APPKEY}

リクエストパラメータ

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

警告

「プロファイル一覧の取得」は現在対応していません。近々対応予定です。

ユーザー登録単語の登録

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

エンドポイント

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

認証

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

Authorization: Bearer {APPKEY}

リクエストパラメータ

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

コンテンツタイプ

Content-Type: application/json

リクエストボディ

フィールド名	説明	補足
`profilewords`	単語登録情報	登録したい単語を配列形式で指定します
`profilewords[].written`	表記	単語の表記を指定します
`profilewords[].spoken`	読み	単語の読みを指定します
`profilewords[].classname`	クラス名	クラス名を指定します。設定しないときは省略可能です。

例

{
    "profilewords": [
        {
            "written": "AMI",
            "spoken": "あみ"
        },
        {
            "written": "AOI",
            "spoken": "あおい"
        },
        {
            "written": "躑躅森",
            "spoken": "つつじもり",
            "classname": "名前"
        }
    ]
}

レスポンス

成功時

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

レスポンスボディ

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

例

{
    "profilewords": [
        {
            "written": "AMI",
            "spoken": "あみ"
        },
        {
            "written": "AOI",
            "spoken": "あおい"
        },
        {
            "written": "躑躅森",
            "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"}`	APPKEY（サービス認証キー文字列）の認証に失敗した時
401 Unauthorized	`{"code":"-","message":"service authorization has expired: <expirationTime> (<expiresIn>)"}`	APPKEY（サービス認証キー文字列）の認証に失敗した時
500 Internal Server Error	`{"code":"?","message":"unexpected exception occurred (<optionalMessage>)"}`	想定外の例外が発生した時

例

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

ユーザー登録単語の取得​

エンドポイント​

認証​

リクエストパラメータ​

プロファイル一覧の取得​

エンドポイント​

認証​

リクエストパラメータ​

ユーザー登録単語の登録​

エンドポイント​

認証​

リクエストパラメータ​

レスポンス​

成功時​

失敗時​

ユーザー登録単語の取得

エンドポイント

認証

リクエストパラメータ

プロファイル一覧の取得

エンドポイント

認証

リクエストパラメータ

ユーザー登録単語の登録

エンドポイント

認証

リクエストパラメータ

レスポンス

成功時

失敗時