Endpointのテストモード

説明

Endpoint のテストモードでは、課金対象トーク数に影響を与えないメッセージを既存のEndpoint に送信することができ、通常のメッセージと同じように処理されます。

このモードは次のように使用できます:

  • バーチャルエージェントの可用性を定期的にチェックする。
  • 特定のエンドユーザー環境の条件を指定した End-To-End テストの実行。

可用性

テストモードは、以下のEndpointタイプに対応しています:

EndpointCognigy.AIバージョン以降対応
REST>= v4.27.0
Socket.io>= v4.42.0

使用方法

以下に、個別に対応する Endpoint タイプのテストモードの使用方法を示します。

REST Endpoint

テストモードメッセージを送信するには、以下のようにURLの<URL TOKEN>の前に/test/を付けてください:

POST https://<ENDPOINT_BASE_URL>/test/<URL_TOKEN>

Socket.io Endpoint

テストモードメッセージを送信するには、Cognigy Socket Endpointとソケット接続を確立し、testModeパラメータにtrueを指定してSocketClientに渡します。以下の例をご覧ください。この例は、使用する Socket.IO クライアントライブラリによって異なる場合があります:

const { SocketClient } = require("@cognigy/socket-client");

const client = new SocketClient("https://socket.url", "socket-token", {
  testMode: true,
});
socketClient = new SocketClient({<provide your config parameters>})
...

if (config.testMode) {
    socketClient.io.opts.query["testMode"] = "true";
}

socketClient.connect();
...

課金への影響

テストモードを使用して送信されたメッセージは、トーク内の課金対象メッセージカウントを増加させません。トークがテストモードを使用して受信された入力のみで構成されている場合、入力数は0となり、請求されません。

ただし、Cognigy.AIは課金対象トーク数に加え、テストモードを含む合計トーク数も追跡し、不正使用を防止するため、両指標はCognigyへの課金レポートに含まれます。1時間に最大600のテストメッセージは不正使用とみなされません。