API Task リアルタイム エンドポイント
- 最終更新日2024/07/30
API Task リアルタイム エンドポイント
リアルタイム エンドポイントで API Tasksを即座に呼び出します。API Task実行 URL とトークンを生成し、API エンドポイントから API Task実行を開始できます。
主なメリット
- プログラム的デプロイ: お好みの API クライアントを使用して、リアルタイムでどこからでも API Taskを呼び出します。
- 応答時間: 低レイテンシーで、ほぼリアルタイムの応答速度を実現するように設計されており、ほとんど即座に (通常はミリ秒以内に) 応答することを目指しています。
- 処理:
- オートメーションはクラウドにロードされ、いつでもリクエストを受け付けることができます。これにより、迅速な処理と対応が可能になります。
- プレミアム ライセンスではオートメーションが拡張され、クラウド リソースの大規模なプールにアクセスして API Taskの複数のインスタンスを実行できるため、並行性が高まり、より多くの API Task リクエストを同時に処理できるようになります。
- 使用事例:
- チャットボットのようなインタラクティブな状況に最適
- リアルタイムの不正検知
- オンライン ケース作成
- 即座の応答が重要な事例
前提条件
- 必ず API Taskを作成してください。API Taskの作成の詳細については、「Create an API Task」を参照してください。
- API Taskをチェックインしている必要があります。API Taskのチェックインについての詳細は、「リポジトリに API タスクをチェックインする」を参照してください。
以下のサンプル コード スニペットでは、API Taskをリアルタイムでクラウド デバイスにデプロイする手順について説明しています。また、変数は、デプロイされたときに API Tasksに渡すこともできます。
- ステップ 1: API タスク リアルタイム エンドポイント - 認証
- Control Room インスタンスへのアクセスを認証します。
- ステップ 2: API タスク割り当ての作成 (管理者)
- 管理者は API Taskの割り当てを作成できます。
- ステップ 3: API タスクの割り当ての一覧表示 (管理者)
- 管理者はすべての API Taskの割り当てをリストできます。
- ステップ 4: タスク実行 URL/トークンの生成
- URL とトークンを生成して、API Taskをデプロイします。
- ステップ 5: API タスクのリアルタイム エンドポイントの実行
- 生成された一意の URL とトークンで API Taskを実行します。