CLOVA Chatbotの概要

Classic/VPC環境で利用できます。

CLOVA Chatbotは、ユーザーからの質問の意図を把握して適切な返答をさまざまな形式で返す NAVERクラウドプラットフォームのサービスです。CLOVA Chatbot Custom APIは、CLOVA Chatbotビルダで設定したドメインの学習結果に基づいて質問返答機能の APIを RESTful形式で提供し、メッセンジャーチャンネルではなく、一般的なウェブ(Web)やアプリ(App)でチャットボットを実装する場合に適しています。
このガイドでは、Customチャンネルで CLOVA Chatbotにリクエスト(Request)を送る方法を説明します。

CLOVA Chatbot連携と開発プロセス

CLOVA Chatbotの Custom連携と開発プロセスを説明します。

連携プロセス

連携プロセスは次の通りです。

1. CLOVA Chatbotビルダを利用して会話シナリオを作成します。
2. 会話モデルをビルドしてデプロイします。
3. CLOVA Chatbot Custom連携を設定します。
4. API Gateway呼び出し URLを作成して Secret Keyを発行します。
5. API Gateway Invoke URLでアプリケーションから APIを呼び出します。

開発プロセス

開発プロセスは次の通りです。

1. API Gateway Invoke URLを確認します。
2. リクエストヘッダで渡す認証キー作成のための署名を作成します。
   • CLOVA * Chatbot Customで作成した Secret Keyを利用
3. 会話クエリをリクエストするためのレスポンスボディを作成します。
4. API Gateway Invoke URLを使用してクエストします。
   • CLOVA Chatbot Custom APIのユースケースを参照

CLOVA Chatbotの共通設定

CLOVA Chatbot Custom APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

CLOVA Chatbotビルダで作成された API Gatewayの固有の Invoke URL

リクエストヘッダ

ヘッダの説明は次の通りです。

Secret Keyの発行および確認方法

CLOVA Chatbotで Secret Keyを発行したり、確認する方法は次の通りです。

1. NAVERクラウドプラットフォームコンソールで Services > CLOVA Chatbot > Domainメニューを順にクリックします。
2. 希望するドメインの [ビルダを実行する] ボタンをクリックしてチャットボットビルダを実行します。
3. チャットボットビルダで [チャットボット設定] ボタンをクリックします。
4. チャットボット設定でメッセンジャー連携タブをクリックします。
5. Customの [連携] ボタンをクリックします。
6. Custom連携ポップアップで Secret Keyを発行したり確認します。

X-NCP-CHATBOT_SIGNATURE作成のサンプルコード

言語別X-NCP-CHATBOT_SIGNATURE設定のサンプルコードは次の通りです。

• JavaScript

  const HmacSHA256 = require('crypto-js/hmac-sha256');
  const EncBase64 = require('crypto-js/enc-base64');
  signatureHeader = HmacSHA256(requestBodyString, secretKey).toString(EncBase64);
  

• Java

  byte[] secretKeyBytes = secretKey.getBytes(StandardCharsets.UTF_8);
  SecretKeySpec secretKeySpec = new SecretKeySpec(secretKeyBytes, "HmacSHA256");
  Mac mac = Mac.getInstance("HmacSHA256");
  mac.init(secretKeySpec);
  byte[] signature = mac.doFinal(body.getBytes(StandardCharsets.UTF_8));
  String signatureHeader = Base64.getEncoder().encodeToString(signature);
  

レスポンス

共通レスポンス形式を説明します。

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

CLOVA Chatbot Custom API

CLOVA Chatbot Customサービスで提供する APIの説明は次の通りです。

CLOVA Chatbot関連リソース

CLOVA Chatbot Custom APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。

• CLOVA Chatbot Custom APIの使用方法
  • Ncloudの共通レスポンスステータスコード: CLOVA Chatbotサービスで使用される NAVERクラウドプラットフォームの共通レスポンスステータスコード情報
  • API Gatewayご利用ガイド: ドメインの InvokeURLを API Gatewayと連携するための API Gatewayサービスの申し込み
  • CLOVA Chatbotと API Gatewayの基本連携ガイド: CLOVA Chatbotと API Gatewayの基本的な連携方法の案内
  • Sub Accountご利用ガイド: CLOVA Chatbotの運用権限管理をサポートする Sub Accountの使用方法の案内
• CLOVA Chatbotサービスの使用方法
  • CLOVA Chatbotご利用ガイド: NAVERクラウドプラットフォームコンソールでの Chatbot制作プロセス、会話コンポーネント管理、Chatbotの高度な活用、メッセンジャーと拡張サービスの連携、Chatbotの管理と問題解決の方法
  • CLOVA Chatbotを使用する前に: CLOVA Chatbotでサポートする環境スペック、使用時の留意事項、利用料金の案内
  • Ncloud使用環境ガイド: VPC、Classic環境とサポートの有無に関するご利用ガイド
  • 料金の紹介、特徴、詳細機能: CLOVA Chatbotの料金体系、CLOVA Chatbotの特徴と詳細機能のサマリー
  • サービス関連の最新のお知らせ: CLOVA Chatbot関連の最新共有ニュース
  • よくある質問: CLOVA Chatbotユーザーからのよくある質問
  • お問い合わせ: ご利用ガイドだけでは不明な点が解消されない場合、直接お問い合わせ