跳至主要内容

使用量统计标签

同一账户共用时按属性获取使用量​

在提供使用 AmiVoice API 的服务时，可能会出现多个系统、环境或最终用户共用一个 AmiVoice API 账户的情况，而不是为每个系统或环境单独获取 AmiVoice API 账户。在这种情况下，通过为任意属性设置使用量统计标签，可以获取各属性的 AmiVoice API 使用量，并用于分析等用途。

概述​

在发送语音识别请求时，通过在请求参数中设置任意的使用量统计标签（billing_key），可以获取每个标签的使用量。在 MyPage 可以查看的使用明细的发话量 CSV 将按连接引擎和使用量统计标签的组合进行统计。 例如，如果为每个最终用户设置标签（如 user01、user02 等），就可以统计每个最终用户的使用量，用于分析使用情况或计算向各最终用户收取的使用费用等。此外，还可以考虑以下使用方式：

  • 多个系统共用账户时，统计每个系统的使用量（如 voicebot、transcription 等）
  • 统计每个环境的使用量（如 development、staging、production 等）
  • 统计系统各版本的使用量（如 v1、v2 等）
  • 按使用终端统计（如 tel01、tel02 等）
备注
  • 明细文件不会按使用量统计标签分割，而是在一个文件内输出每个标签的统计结果。
  • 在 MyPage 的"Usage of This Month"中无法查看按标签统计的结果。

请求方法​

使用量统计标签 billing_key 需要在请求参数中设置 extension，并在其中的 client_info 下添加。billing_key 可设置为任意字符串。

extension 内容示例：

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

同步・异步 HTTP 接口的情况​

在 d 参数中设置 extension。extension 的值需要进行 URL 编码。

使用上述 extension 内容通过同步 HTTP 接口发送请求的示例：

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 中设置的字符串中的 " 需要使用 "" 进行转义。

使用上述 extension 内容通过 WebSocket 接口发送请求的示例：

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