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

使用量集計タグ

同一アカウントを共用する場合の属性別使用量の取得​

AmiVoice API を使用したサービスを提供する場合、複数のシステムや環境、エンドユーザ等ごとにそれぞれ AmiVoice API アカウントを取得するのではなく、一つの AmiVoice API アカウントを共用する場合も考えられます。このような場合に、任意の属性ごとに使用量集計タグを設定することで、属性ごとの AmiVoice API 使用量を取得することができ、分析等に活用できます。

概要​

音声認識リクエストを送る際、リクエストパラメータに任意の使用量集計タグ（billing_key）を設定することで、タグごとの使用量を取得できます。マイページで確認できる利用明細の発話量CSVが、接続エンジンと使用量集計タグの組み合わせごとに集計されるようになります。 たとえば、エンドユーザごとにタグ（user01 user02など）を設定すれば、エンドユーザごとの使用量を集計し、使用状況の分析や、各エンドユーザに請求する利用量の算出等に活用することができます。ほかにも以下のような使い方が考えられます。

  • 複数のシステムでアカウントを共用する場合、システムごとの使用量の集計（voicebot transcriptionなど）
  • 環境ごとの使用量の集計（development staging productionなど）
  • システムのバージョンごとの使用量の集計（v1 v2など）
  • 使用端末ごとの集計（tel01 tel02など）
注記
  • 明細のファイルが使用量集計タグごとに分割されるわけではなく、一つのファイル内にタグごとの集計が出力されます。
  • マイページの「今月の使用量」ではタグごとの集計は確認できません。

リクエスト方法​

使用量集計タグbilling_keyは、リクエストパラメータにextensionを設定し、その中に記述するものとしてclient_infoの下に付与します。billing_keyには任意の文字列を設定してください。

extensionの内容の例：

{
    "client_info": {
        "billing_key": "any_key_for_billing_aggregation"
    }
}

同期・非同期 HTTP インタフェースの場合​

dパラメータにextensionを設定します。extensionの値はURLエンコードしてください。

同期 HTTP インタフェースで、上記の内容のextensionでリクエストを送る場合の例：

curl -X POST https://acp-api.amivoice.com/v1/nolog/recognize \
     -F u={YOUR_APPKEY} \
     -F d="grammarFileNames=-a-general extension=%7B%22client_info%22%3A+%7B%22billing_key%22%3A+%22any_key_for_billing_aggregation%22%7D%7D" \
     -F a=@test.wav

WebSocket インタフェースの場合​

sコマンドのリクエスト行にextensionを設定します。extensionに設定する文字列中の"は""のように2つ重ねてエスケープしてください。

WebSocket インタフェースで、上記の内容のextensionでリクエストを送る場合の例：

s 16K -a-general extension="{""client_info"":{""billing_key"":""any_key_for_billing_aggregation""}}" authorization={YOUR_APPKEY}