# ConvoKraft ## SDK ### JS SDK -------------------------------------------------------------------------------- title: "概要" description: "Catalystアプリケーションに強力なチャットBotアシスタントを統合する機能を持つCatalyst ConvoKraftサービスが提供するJS SDKパッケージについて学びます。" last_updated: "2026-07-02T09:34:21.908Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/sdk/js/overview/" service: "ConvoKraft" -------------------------------------------------------------------------------- # ConvoKraft JavaScript Client SDK ### 概要 ConvoKraft JavaScript SDKを使用すると、Webアプリケーションに簡単にConvoKraft Botを追加でき、ユーザーはプログラムされたチャットウィンドウを通じてBotと直接対話できます。 このドキュメントでは、JavaScript SDKをCatalyst Webアプリケーションに統合し、アプリケーションの特定の要件に応じてConvoKraft Botをカスタマイズする手順について詳しく説明します。 このSDKは、以下の最小バージョンを含むすべてのモダンWebブラウザをサポートしています： <table class="content-table"> <thead> <tr> <th>ブラウザ</th> <th>バージョン</th> </tr> </thead> <tbody> <tr> <td>Microsoft Edge</td> <td>12+</td> </tr> <tr> <td>Mozilla Firefox</td> <td>21+</td> </tr> <tr> <td>Google Chrome</td> <td>23+</td> </tr> <tr> <td>iOS Safari</td> <td>6+</td> </tr> </tbody> </table> ### SDK統合 ConvoKraft JS SDKをアプリケーションに組み込むために、Webアプリケーションのソースコードのindex.htmlファイルに以下のコードスニペットを追加してください： &lt;script src="https://console.catalyst.zoho.com/convokraft/assets/js/convokraft-chat-sdk.js"&gt; &lt;/script&gt; チャットウィンドウを従来のチャットBotの位置、つまりCatalyst Webアプリケーション画面の右下隅に表示するために、以下のコードスニペットをWebアプリケーションに含めるようにしてください。さらに、サイズ、位置、外観を変更し、必要に応じてチャットウィンドウを完全にカスタマイズできます。詳細についてはこのセクションで説明します。 &lt;div class="anchor_convokraft_toBottom"&gt; &lt;convokraft-chat-bot bot-name="test" project-id="6687000000009014" org-id="74535893"&gt;&lt;/convokraft-chat-bot&gt; &lt;/div&gt; Style - &lt;style&gt; div.anchor_convokraft_toBottom { width: 330px; height: 450px; position: fixed; bottom: 0; right: 0; } &lt;/style&gt; 注意: 1. **convokraft-chat-sdk.js**は**&lt;convokraft-chat-bot/&gt;**タグの後に含めるようにしてください。 2. このSDKは固定位置指定で最適に動作するため、**&lt;convokraft-chat-bot/&gt;**タグを囲むコンテナは固定位置指定のものにしてください。 -------------------------------------------------------------------------------- title: "Botのカスタマイズ" description: "Catalystアプリケーションに強力なチャットBotアシスタントを統合する機能を持つCatalyst ConvoKraftサービスが提供するJS SDKパッケージについて学びます。" last_updated: "2026-07-02T09:34:21.908Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/sdk/js/customization-of-a-bot/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Botのカスタマイズ ConvoKraft JS SDKは、アプリケーションの特定の要件に合わせてチャットウィンドウのさまざまな要素をカスタマイズすることをサポートしています。以下の属性は、Webアプリケーションのソースコードのindex.htmlファイル内の**&lt;convokraft-chat-bot&gt;**タグで使用する必要があります： * lt-prop-convokraft-title * show-convokraft-header * bot-name * lt-prop-conversation * show-help * show-typing-suggestions * show-action-suggestions * lt-prop-styles ### lt-prop-convokraft-title この属性は、チャットウィンドウUIのタイトルを設定するために使用します。 **サンプルコード：** &lt;convokraft-chat-bot lt-prop-bot-title="Ask convokraft"&gt; &lt;/convokraft-chat-bot&gt; ### show-convokraft-header この属性は、チャットウィンドウのヘッダーを表示するかどうかをConvoKraft Botに知らせるために使用されます。この属性の値は、要件に応じてtrueまたはfalseに設定できます。デフォルトではtrueに設定されています。値がfalseに設定されている場合、チャットウィンドウのヘッダーは表示されません。 **サンプルコード：** &lt;convokraft-chat-bot lt-prop-convokraft-title="Ask convokraft" show-convokraft-header="false"&gt; &lt;/convokraft-chat-bot&gt; ### bot-name この属性の値として特定のBot名（bot namespace）を指定すると、ConvoKraftはその特定のBotとのみ会話します。 **サンプルコード：** &lt;convokraft-chat-bot lt-prop-convokraft-title="Ask convokraft" bot-name = "ecommercebot" &gt;&lt;/convokraft-chat-bot&gt; ### lt-prop-conversation この属性は、Bot会話内のメッセージの配置を設定するために使用します。この属性の値はtrueまたはfalseのいずれかに設定できます。 * trueの場合、チャットウィンドウ内のすべてのメッセージ会話が会話ビューに変換されます（ユーザーメッセージは右揃え、ConvoKraftの応答はチャットウィンドウの左揃えになります）。 **サンプルコード：** &lt;convokraft-chat-bot lt-prop-convokraft-title="Ask convokraft" bot-name = "aqualordappointmentbooker" lt-prop-conversation="true"&gt; &lt;/convokraft-chat-bot&gt; * falseの場合、チャットウィンドウ内のすべてのメッセージ会話は左揃えになります。 **サンプルコード：** &lt;convokraft-chat-bot lt-prop-convokraft-title="Ask convokraft" bot-name = "aqualordappointmentbooker" lt-prop-conversation="false"&gt; &lt;/convokraft-chat-bot&gt; ### show-help この属性は、チャットウィンドウの入力エリアの横にヘルプアイコンを有効にするために使用できます。ヘルプアイコンをクリックすると、onboarding screenが表示されます。 onboarding screenには、そのConvoKraft Bot用に設定されたSample SentencesまたはAction suggestionsが含まれています。この属性の値はtrueまたはfalseに設定できます。デフォルトではfalseに設定されています。 **サンプルコード：** &lt;convokraft-chat-bot lt-prop-convokraft-title="Ask convokraft" bot-name = "aqualordappointmentbooker" show-help="true"&gt; &lt;/convokraft-chat-bot&gt; ### show-typing-suggestions この属性は、入力エリアでメッセージを入力している間にaction suggestionsを同時に表示するために使用されます。この属性の値はtrueまたはfalseのいずれかに設定できます。 **サンプルコード：** &lt;convokraft-chat-bot lt-prop-convokraft-title="Ask convokraft" bot-name = "aqualordappointmentbooker" show-help="true" show-history="true" show-typing-suggestions="true"&gt; &lt;/convokraft-chat-bot&gt; ### show-action-suggestions この属性は、各チャット会話の最後にaction suggestionsを表示するために使用できます。この属性の値はtrueまたはfalseのいずれかに設定できます。 この属性が有効になっている場合、show-typing-suggestions属性は自動的に有効になります。 **サンプルコード：** &lt;convokraft-chat-bot lt-prop-convokraft-title="Ask convokraft" bot-name = "aqualordappointmentbooker" show-help="true" show-history="true" show-action-suggestions="true"&gt; &lt;/convokraft-chat-bot&gt; ### lt-prop-styles この属性は、チャットウィンドウUIのさまざまな要素のスタイルを設定するために使用します。スタイルは以下のように設定できます： <table class="content-table"> <thead> <tr> <th>属性名</th> <th>用途</th> <th>値</th> <th>例</th> </tr> </thead> <tbody> <tr> <td>headerBg</td> <td>チャットウィンドウヘッダーの背景色を設定します。</td> <td>任意の色の値を指定できます。</td> <td>#5acc42</td> </tr> <tr> <td>headerText</td> <td>チャットウィンドウヘッダーのテキスト色を設定します。</td> <td>任意の色の値を指定できます。</td> <td>black</td> </tr> <tr> <td>headerFont</td> <td>チャットウィンドウヘッダーテキストのフォントファミリーを設定します。</td> <td>任意のフォントファミリー名を指定できます。</td> <td>sans-serif</td> </tr> <tr> <td>userBg</td> <td>チャットウィンドウ内のユーザーメッセージコンテナの背景色を設定します。</td> <td>任意の色の値を指定できます。</td> <td>#5acc42</td> </tr> <tr> <td>userText</td> <td>ユーザーメッセージコンテナ内のテキスト色を設定します。</td> <td>任意の色の値を指定できます。</td> <td>black</td> </tr> <tr> <td>userFont</td> <td>ユーザーメッセージコンテナ内のテキストのフォントファミリーを設定します。</td> <td>任意のフォントファミリー名を指定できます。</td> <td>Comic Sans MS</td> </tr> <tr> <td>botBg</td> <td>チャットウィンドウ内のConvoKraftメッセージコンテナの背景色を設定します。</td> <td>任意の色の値を指定できます。</td> <td>#ddd</td> </tr> <tr> <td>botText</td> <td>ConvoKraftメッセージコンテナ内のテキスト色を設定します。</td> <td>任意の色の値を指定できます。</td> <td>#222</td> </tr> <tr> <td>botFont</td> <td>ConvoKraftメッセージコンテナ内のテキストのフォントファミリーを設定します。</td> <td>任意のフォントファミリー名を指定できます。</td> <td>Arial</td> </tr> <tr> <td>bodyBg</td> <td>チャットウィンドウ本体の背景色を設定します。</td> <td>任意の色の値を指定できます。</td> <td>#ddd</td> </tr> </tbody> </table> lt-prop-styles属性の場合、スタイルとその値は以下のサンプルコードに示すようにJSON形式で指定する必要があります： &lt;convokraft-chat-bot lt-prop-conversation="true" lt-prop-styles='{"headerBg":"#5acc42", "headerText":"black", "headerFont":"sans-serif", "userBg":"#5acc42", "userText":"black", "botBg":"#ddd", "botText":"#222", "userFont":"Comic Sans MS", "botFont":"Arial", "bodyBg":"#ddd"}'&gt; &lt;/convokraft-chat-bot&gt; -------------------------------------------------------------------------------- title: "フック" description: "Catalystアプリケーションに強力なチャットBotアシスタントを統合する機能を持つCatalyst ConvoKraftサービスが提供するJS SDKパッケージについて学びます。" last_updated: "2026-07-02T09:34:21.908Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/sdk/js/hooks/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Hooks ConvoKraft hooksは、Catalyst WebアプリケーションのグローバルスコープでConvoKraftオブジェクトを使用してアクセスできるように、開発者が設定できる関数です。ConvoKraft JS SDKは以下のhooksを提供しています： * handleResponse * handleMissed * handleError * minimizeChat * didConnect * setOnBoarding * setOnBoardingSentences * setClientSessionData * handleUpload * handleWelcome ### handleResponse 任意のactionに対してConvoKraftが提供する応答に基づいて、データを処理し、特定の要件に応じて応答のビジュアル表現をカスタマイズできます。 送信された元の応答は、WebアプリケーションからのDeluge関数のdataキーで送信されます。応答をカスタマイズするには、以下のhookにデータ値とHTML要素を渡す必要があります。HTML要素内でWebアプリケーションがConvoKraftの元の応答をレンダリングできます。 **構文** convokraft.handleResponse=function(actionName,data,element,responseHandled,fromHistory,fromPagination) { //ロジックをここに入力する return true; } 以下の表は、関数の各要素の詳細を示しています： <table class="content-table"> <thead> <tr> <th>要素</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>actionName</td> <td>呼び出されたactionのnamespaceです。</td> </tr> <tr> <td>data</td> <td>Delugeからhookに送信されるカスタムデータを保持します。</td> </tr> <tr> <td>element</td> <td>チャットウィンドウに表示されるConvoKraftのカスタム返信要素を保持します。</td> </tr> <tr> <td>responseHandled</td> <td>DOM操作が完了し、チャットdivを上部にスクロールできることをBotに知らせるための必須コールバック関数です。</td> </tr> <tr> <td>fromHistory</td> <td>現在構築中のメッセージが現在のセッションのものか過去のセッションのものかを表すBoolean値を含むキーです。</td> </tr> <tr> <td>fromPagination</td> <td>現在構築中のメッセージがページネーション呼び出し後のメッセージかどうかを表すBoolean値を含むキーです。trueの場合、メッセージが最下部までスクロールされないように、responseHandled()を呼び出さないことをお勧めします。</td> </tr> </tbody> </table> **サンプルコード** convokraft.handleResponse = function(actionName,data,element,responseHandled,fromHistory,fromPagination) { if(actionName=="schedule_event") { element.innerHTML="This is a test function from "+data.name; element.style.padding="10px"; responseHandled(); return false; //上記で構築したレスポンスを返す } return true; //元のConvoKraftレスポンスを返す } ### handleMissed ユーザーのメッセージがBotの設定済みActionsのいずれとも一致しない場合、Webアプリケーションのグローバルスコープでconvokraft.handleMissed() hookを定義していれば、ConvoKraftはこのhookを通じてレンダリングされたカスタム応答を表示します。 **構文** convokraft.handleMissed = function(element, responseHandled, fromHistory, fromPagination) { //convokraftのレスポンスとしてレンダリングされる要素のロジックを入力する } 以下の表は、構文の各要素とその説明を示しています： <table class="content-table"> <thead> <tr> <th>要素</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>element</td> <td>チャットウィンドウに表示されるConvoKraftのカスタム返信要素を保持します。</td> </tr> <tr> <td>responseHandled</td> <td>DOM操作が完了し、チャットdivを上部にスクロールできることをBotに知らせるための必須コールバック関数です。</td> </tr> <tr> <td>fromHistory</td> <td>現在構築中のメッセージが現在のセッションのものか過去のセッションのものかを表すboolean値を含むキーです。</td> </tr> <tr> <td>fromPagination</td> <td>現在構築中のメッセージがページネーション呼び出し後のメッセージかどうかを表すboolean値を含むキーです。trueの場合、メッセージが最下部までスクロールされないように、responseHandled()を呼び出さないことをお勧めします。</td> </tr> </tbody> </table> **サンプルコード** convokraft.handleMissed= function(element,responseHandled,fromHistory){ element.innerHTML = "<div class='wrapped_not_found'>Sorry! Not found!<br/><br/><img src='https://www.zylker.com/files/2020/06/iStock-872962368-chat-bots.webp'></img></div>"; responseHandled(); return false; } ### handleError Actionの実行中にAPIエラーが発生した場合、Catalyst Webアプリケーションのグローバルスコープでconvokraft.handleErrorを定義することで、このhookを使用してカスタムエラー応答を表示できます。 **構文** convokraft.handleError = function(element, responseHandled, fromHistory, fromPagination) { //エラーメッセージをカスタマイズするロジックを入力する } 以下の表は、構文の各要素とその説明を示しています： <table class="content-table"> <thead> <tr> <th>要素</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>element</td> <td>チャットウィンドウに表示されるConvoKraftのカスタム返信要素を保持します。</td> </tr> <tr> <td>responseHandled</td> <td>DOM操作が完了し、チャットdivを上部にスクロールできることをBotに知らせるための必須コールバック関数です。</td> </tr> <tr> <td>fromHistory</td> <td>現在構築中のメッセージが現在のセッションのものか過去のセッションのものかを表すboolean値を含むキーです。</td> </tr> <tr> <td>fromPagination</td> <td>現在構築中のメッセージがページネーション呼び出し後のメッセージかどうかを表すboolean値を含むキーです。true の場合、メッセージが最下部までスクロールされないように、responseHandled()を呼び出さないことをお勧めします。</td> </tr> </tbody> </table> **サンプルコード** convokraft.handleError= function(element,responseHandled){ if(typeof data !== "undefined"){ messageString = data.data.code; } else{ messageString = "Api Error!"; } element.innerHTML = "<div class='wrapped_not_found'>Sorry! "+messageString+"<br/><br/><img src='https://www.zylker.com/files/2020/06/iStock-872962368-chat-bots.webp'></img></div>"; responseHandled(); } ### minimizeChat このhookを使用すると、チャットウィンドウのヘッダーをクリックしたときにチャットウィンドウを最小化または最大化できます。 **構文** convokraft.minimizeChat=function() { //チャットdivを取得し、必要に応じて最小化アニメーションとスタイルを適用する } **サンプルコード** convokraft.minimizeChat=function() { if(document.getElementById("zdivid").style.marginBottom=="-400px"||document.getElementById("zdivid").style.marginBottom=="") { document.getElementById("zdivid").style.marginBottom="-0px"; } else { document.getElementById("zdivid").style.marginBottom="-400px"; } } ### didConnect このhookは、チャットが完全に読み込まれたことをCatalyst Webアプリケーションに通知するために使用されます。 **構文** convokraft.didConnect=function() { //ロジックをここに入力する } **サンプルコード** convokraft.didConnect=function() { var loadingDiv=document.getElementById("loadingDiv"); if(loadingDiv) { loadingDiv.style.display='none'; } } ### setOnBoarding チャット履歴がない場合、onboarding screenがデフォルトで表示されます。このhookは、要件に応じてConvoKraft Botのonboarding screenをカスタマイズするために、Webアプリケーションのグローバルスコープで定義できます。 **構文** convokraft.setOnBoarding=function(element,sentences,placeholders) { //必要に応じてHTMLとスタイルを構築し、要素に追加する } 以下の表は、構文の各要素とその説明を示しています： <table class="content-table"> <thead> <tr> <th>要素</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>element</td> <td>カスタマイズが必要なHTML要素を保持します。</td> </tr> <tr> <td>sentences</td> <td>その特定のactionのSample Sentencesを保持します。</td> </tr> <tr> <td>placeholders</td> <td>onboarding screenに表示される文のさまざまなパラメータを保持するために使用できる文字列の配列です。</td> </tr> </tbody> </table> **サンプルコード** convokraft.setOnBoarding=function(element,sentences,placeholders) { var html="<div style='font-weight:bold;font-family:'proxima_nova_ltsemibold'>This is a custom onboarding screen by client app and here are the list of sentences:</div><br/><br/><ul style='list-style:none;margin-left:-15px'>"; sentences.forEach(function(item) { html+="<li class='onboard_item' onclick='convokraftvoice.sendMessage(\""+item+"\")'>"+item+"</li>"; }) html+="</ul>"; element.innerHTML=html; element.style.padding="10px"; } ### setOnBoardingSentences このhookは、ConvoKraftチャットウィンドウを開いたときに表示されるonboarding sentencesまたはaction suggestionsをカスタマイズするために使用されます。デフォルトでは、チャットウィンドウはConvoKraft ActionsのSample Sentencesの設定に基づいて提案を表示します。以下に示すように、JSON形式のオブジェクトの配列をこのhookの引数として渡すことができます。また、JSONのsentencesを使用して、プレースホルダーにさまざまな値を設定して返すことができます。 [ { "id": "1", "sentence": "Apply leave for {{fromdate}} and {{todate}}", "actual_sentence": "Apply leave for today and tomorrow" }, { "id": "2", "sentence": "What is the {{property}} of {{country}}?", "actual_sentence": "What is the capital of India?" } ] //オンボーディング画面に表示される文を絞り込みまたは修正する **構文** convokraft.setOnBoardingSentences=function(sentences) { //必要に応じてHTMLとスタイルを定義し、要素に追加する } **サンプルコード** convokraft.setOnBoardingSentences=function(sentences) { sentences.splice(0,8); return sentences; } 注意: * このhookはsetOnBoarding hookが適用されていない場合にのみ考慮されます。 * setOnBoarding hookでカスタムsentencesが必要な場合は、setOnBoarding hook内のsentencesに同じ処理を適用してください。 ### setClientSessionData このhookは、Catalyst Webアプリケーションのカスタムクライアントセッションデータを取得するために使用されます。ConvoKraftがアクセスできるように、Catalyst Webアプリケーションのグローバルスコープで定義してください。 **構文** convokraft.setClientSessionData=function() { //JSONオブジェクトを返す } **サンプルコード** convokraft.setClientSessionData=function() { return { portal_name: "zylker", ui_version: "2.0" } } 注意: * セッションデータはJSONオブジェクトとして返すようにしてください。 * Deluge関数を使用する場合、このハンドルから返されるJSONデータはsessionData.set("client_data").を使用して取得できます。 ### handleUpload このhookは、ファイルアップロード後に実行する操作を定義するために使用されます。選択した開発プラットフォームがDelugeまたはFunctionの場合、ファイルはCatalystクラウド環境にアップロードされます。Webhooksの場合は、file属性で独自のファイルパスを定義する必要があります。特定の要件に基づいて、onSuccesおよびonFailureコールバック引数にそれぞれのメッセージを設定できます。 **構文** convokraft.handleUpload = function(input){ //convokraftのレスポンスとしてレンダリングされる要素に対して自由に処理する } このhookでは以下の属性がサポートされています： <table class="content-table"> <thead> <tr> <th>属性名</th> <th>用途</th> </tr> </thead> <tbody> <tr> <td>sessionId</td> <td>現在のトランスクリプトセッションのIDです。</td> </tr> <tr> <td>param</td> <td>param名、タイプ、プロンプトメッセージなどの現在のプロンプトのparam情報です。</td> </tr> <tr> <td>file</td> <td>ユーザーが提供したファイルオブジェクトです。</td> </tr> <tr> <td>action</td> <td>現在の会話のaction namespaceです。</td> </tr> <tr> <td>bot</td> <td>現在の会話のbot namespaceです。</td> </tr> <tr> <td>onSuccess</td> <td>ファイルIDを入力として受け取る必須コールバックです。</td> </tr> <tr> <td>onProgressChange</td> <td>計算されたアップロードパーセンテージをパラメータとして受け取る必須コールバックです。アップロードパーセンテージが変化するたびに呼び出す必要があります。アップロードが完了した場合は、パーセンテージを100に設定し、成功状態を示すメッセージ（例：onProgressChange(100,"File upload completed");）を表示してください。</td> </tr> <tr> <td>onFailure</td> <td>アップロード失敗の理由を示すメッセージ文字列を入力として受け取る必須コールバックです。</td> </tr> </tbody> </table> **サンプルコード** convokraft.handleUpload=function(uploadObject){ let percentage = 20; let onSuccess = uploadObject.onSuccess; let onFailure = uploadObject.onFailure; var percentageInterval = setInterval(function() { if(percentage === 100){ clearInterval(percerntageInterval); uploadObject.updateProgress(100,"Your file is being processed. Please wait..."); setTimeout(function() { if(zia.fileUploadCount > 1){ onSuccess((Date.now()).toString()); } else{ onFailure("Your file is over 2MB. Please upload a file of less size."); } }, 5000); return; } percentage+=20; uploadObject.onProgressChange(percentage); }, 500); } ### handleWelcome このhookは、ウェルカムメッセージ（チャットセッションで最初に表示されるメッセージ）を変更するために使用されます。UIのカスタマイズのみが必要な場合にこのhookを使用できます。ウェルカムメッセージの表示にバックエンドロジックの実行が必要な場合は、welcome message handler関数を使用してください。 **構文** convokraft.handleWelcome = function(config){ //convokraftのレスポンスとしてレンダリングされる要素に対して自由に処理する } **サンプルコード** convokraft.handleWelcome = function(config) { config.element.innerHTML = `Hello Guest! Here are few things I can do for you. &lt;div class='suggestion'&gt;Raise a ticket&lt;/div&gt; &lt;div class='suggestion'&gt;List my inventory and assets&lt;/div&gt;`; } -------------------------------------------------------------------------------- title: "メソッド" description: "Catalystアプリケーションに強力なチャットBotアシスタントを統合する機能を持つCatalyst ConvoKraftサービスが提供するJS SDKパッケージについて学びます。" last_updated: "2026-07-02T09:34:21.908Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/sdk/js/methods/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Convokraft JS SDKメソッド ConvoKraft JS SDKは、基本的な操作セットを実行するために以下のメソッドをWebアプリケーションに公開しています： * sendMessage() * pushTranscript() ### sendMessage() sendMessage()メソッドは、クライアントアプリケーションからConvoKraftサーバーにチャットメッセージを送信するように設定するために使用されます。つまり、ユーザーがチャットウィンドウに表示されたオプションをクリックすると、そのオプションに対応する設定済みメッセージがチャットウィンドウにすぐに表示されます。 このメソッドの引数には、チャット会話に表示されるメッセージを含む文字列（必須）と、配列paramの場合に選択されたオプションのIDであるoption_idを含む別の文字列が含まれます。option_id引数はオプションです。 { convokraft.sendMessage(messageString,option_id); } ### pushTranscript() このメソッドは、ConvoKraft Botとの会話中にユーザーのカスタムトランスクリプト（ユーザー会話内の個別メッセージ）をプッシュするために使用できます。メッセージは、その特定のセッションのチャットBotにのみ表示されます。以下に示すトランスクリプトデータを関数に渡す必要があります。このメソッドは、リマインダーをプッシュするシナリオで有用です。 { "message": "Reminder to call Bob at 11am", "id": "1", "sender": "user", "time": "1523356878103" } convokraft.pushTranscript(transcriptObject); ここで、transcriptObjectは会話に表示されるメッセージオブジェクトです。 ## はじめに -------------------------------------------------------------------------------- title: "はじめに" description: "Catalystアプリケーションに強力なチャットBotアシスタントを統合する機能を提供するCatalyst ConvoKraftサービスについて学びます。" last_updated: "2026-07-02T09:34:21.908Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/getting-started/introduction/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Catalyst ConvoKraft ### はじめに ConvoKraftは、テキストで会話するCatalystアプリケーション用の会話型Botを構築するために使用できるAI駆動サービスです。ConvoKraftで構築されたBotとは、人と対話するのと同じように、会話的な英語でやり取りできます。メッセージのIntentを理解するために、ConvoKraft Botは自然言語理解（NLU）アルゴリズムで広範にトレーニングされています。このNLU能力により、メッセージの理解と会話的な応答が可能になります。 ConvoKraftは、複数のオンデマンド開発サービスを統合したCatalyst開発プラットフォームの一部です。これらの完全に機能するサービスはそれぞれ、複数のコンポーネントで構成されています。Catalystアプリケーションを作成してBot を構築する場合、アプリケーションが使用するサーバーリソースのセットアップと管理はすべてCatalystによって処理されるため、インフラストラクチャ、メンテナンスのコストと労力が完全に排除されます。 Catalyst Serverless Functionsコンポーネント（Integration functions）を使用して、ConvoKraft BotのBusiness logicを**Java**、**Node.js**、または**Python**プログラミング環境でコーディングできます。また、Catalyst Devopsサービスを活用して、Catalyst Functionsの実行詳細を継続的に監視・取得することも可能です。Catalystサービスは、独立して使用することも、互いに統合して高機能で堅牢なアプリケーションやあらゆる規模のマイクロサービスを構築することもできます。 注意: Catalystサービス（Catalyst Cloud Scale、Catalyst Serverless、Catalyst Devopsなど）の下にある他のすべてのCatalystコンポーネントを確認できます。 ConvoKraft BotのBusiness logicは、Zohoのネイティブオンラインスクリプト言語であるDelugeを使用してコーディングすることも可能です。これらの関数はZohoのサーバーレス環境でホストされます。また、ConvoKraftでは任意のプログラミング言語でBusiness logicを開発し、パブリックサーバーでホストして、Webhooksを通じてConvoKraft内でアクセスすることもできます。開発されたBotは、アプリケーションのエンドユーザーが使用できるよう、アプリケーションのフロントエンド（例：Webアプリケーション）に組み込む必要があります。Catalystは、Webアプリケーションに簡単にBotを構築・組み込むためのConvoKraft Javascript client SDKパッケージを提供しています。 クライアントSDKを使用して、構築したBotをアプリケーションまたはWebサイトのフロントエンドに組み込み、エンドツーエンドのスムーズなBot構築体験を実現できます。BotのBusiness logicをコーディングしてアプリケーションに組み込んだ後、開発環境でトレーニングとテストを行い、本番環境にデプロイできます。Catalystプロジェクト内のBotへのアクセスと更新には、各Catalystプロファイルに権限を設定できます。 このチュートリアルを試すことで、Catalyst ConvoKraftやその他のCatalystサービスに慣れることもできます。このクイックスタートガイドを使用して、Catalyst ConvoKraftをすぐに始めることができます。 -------------------------------------------------------------------------------- title: "Catalyst ConvoKraftの機能" description: "Catalystアプリケーションに強力なチャットBotアシスタントを統合する機能を提供するCatalyst ConvoKraftの機能について学びます。" last_updated: "2026-07-02T09:34:21.908Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/getting-started/features-of-convokraft/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Catalyst ConvoKraftの機能 Catalyst Webアプリケーションに組み込み可能な、24時間365日利用できる会話型アシスタントです。 チャットを通じたユーザーとの対話中にConvoKraft Botが実行できるプログラム化されたタスクです。 Catalyst Functions、Delugeで構築された、またはWebhooksを使用してアクセスされるBusiness logicです。 <br /> 上記のように、Catalyst ConvoKraftの機能は、Catalystアプリケーション用のBot形式の会話型自動化ワークフローの作成を支援します。各機能について詳しく見ていきましょう： ### Bots ConvoKraft Botは、メッセージのIntentを理解し、処理し、ユーザーに応答する能力を持つプログラム化された会話型アシスタントです。Botは、アプリケーションでの用途に応じて必要なタスクセットで設定できます。ユーザーを歓迎する、問い合わせに応答する、またはアプリケーション内で任意の操作を実行するように設定できます。Botは、直接設定された応答から簡単な回答を取得したり、Business logicを実行してアプリケーション内のデータを取得したり操作を実行したりします。設定完了後、デフォルトのNLP能力を強化するためにトレーニングし、Catalystコンソールで直接テストしてから、本番環境へのデプロイ前にCatalystアプリケーションにBotを組み込むことができます。 ### Actions Actionは、ConvoKraft Botが実行するように設定できる能力またはタスクのセットです。アプリケーションユーザーがBotとの会話を開始すると、BotはNLU能力を通じてIntentを理解し、その場合に実行すべきActionsを決定します。Botのactionsを設定して、直接的な事前設定済みの回答で応答したり、関連データを取得したり、Business logicを実行してアプリケーション内で操作を実行したりできます。 ### Bot Logic Bot Logicは、ConvoKraft Botがさまざまなactionsを実行するために構築するバックエンドロジックです。以下のプラットフォームのいずれかを使用してBot Logicを開発し、作成したBotに関連付けることができます。選択したBot Logicは、設定されたactionsの呼び出し時に実行されます。以下の方法でBot Logicを開発できます： * **Catalyst Functions**: CatalystのサーバーでホストされるCatalyst Integration Functionsを通じてBusiness logicをコーディングできます。ConvoKraftは、Java、Node.js、またはPythonプログラミング環境でIntegration functionsをコーディングするための関連SDKパッケージを提供しています。 * **Deluge Functions**: Zohoのクラウド環境でホストされるDeluge Functionsでコードを記述できます。 * **Webhooks**: 任意のプログラミング言語を使用して、Bot Logicをコーディングし、パブリックサーバーの任意のカスタムドメインにホストして、Webhooksを使用してアクセスできます。 -------------------------------------------------------------------------------- title: "メリット" description: "Catalystアプリケーションに強力なチャットBotアシスタントを統合する機能を提供するCatalyst ConvoKraftの多くのメリットについて学びます。" last_updated: "2026-07-02T09:34:21.908Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/getting-started/benefits/" service: "ConvoKraft" -------------------------------------------------------------------------------- # メリット Catalyst ConvoKraftサービスを使用することで得られる主な利点を以下に示します： 1. **高可用性と顧客エンゲージメントの向上**: ConvoKraft Botは24時間体制でサービスを提供する準備が常にできています。可用性の向上は、カスタマーエクスペリエンスを大幅に高めます。Botは顧客の問い合わせに即座に応答し、任意の数の顧客に並行して対応できます。これにより、顧客維持率が向上し、一定期間内に対応されなかった顧客の問い合わせによるアプリケーションの離脱率を削減できます。 2. **シームレスなBot設定**: ConvoKraft Botを設定して、ユーザーの問い合わせに対する応答を直接設定するか、Bot Logicを実行することで、必要なActionsを実行させることができます。ConvoKraftが提供する任意の開発プラットフォームを使用して、アプリケーションのニーズに応じたBot Logicをコーディングできます。例えば、Catalystがサポートする任意のプログラミング環境を使用してIntegration Functionsを構築したり、Deluge Functionsを使用してコードを記述したり、カスタムサーバーにロジックをホストしてWebhooks経由でアクセスしたりすることも可能です。また、Catalyst DevOpsサービスのコンポーネントを使用して、Catalyst Functionsの実行をテスト・監視することもできます。 3. **応答時間の短縮と効率の向上**: アプリケーションでConvoKraft Botを使用することで、顧客の問い合わせ解決にかかる全体的な時間を短縮できます。ConvoKraft Botは24時間サービスを提供でき、ブランドの信頼性と可用性に貢献します。Botが効率的に設定されている場合、人的介入によって発生する可能性のあるエラーを削減し、顧客により満足度の高いサービスを提供できます。 4. **冗長なタスクの自動化による運用オーバーヘッドの削減**: ConvoKraft Botの使用により、開発者側での手動モデルトレーニングやアルゴリズムキュレーションのオーバーヘッドを最小限に抑えられます。これらのBotにはデフォルトのNLP能力が搭載されており、ConvoKraft Botに対して行われたカスタムAction設定でトレーニングすることで強化することも可能です。アプリケーションにBotを組み込んでさまざまな分野で顧客を支援することで、幅広いシナリオにおける人的リソースの配置や大規模なロジックの構築にかかる運用コストを最小限に抑えることができます。ConvoKraft Botが独立して動作することで、コストを大幅に削減し、全体的な収益にプラスに貢献できます。また、カスタマーサポートスタッフが反復的なタスクやインタラクションに費やす時間を削減し、複雑で重要な問題の解決により集中できるようにすることも可能です。 5. **理想的なデータ収集と顧客フィードバック**: ConvoKraft Botは、全体的なセールスおよびリード生成プロセスの強化を支援できます。顧客がアプリケーションを使用している間に対話するだけで、有用な顧客情報を収集できます。顧客データを分析して、顧客の関心を追跡し、インサイトを引き出し、アプリケーションをさらに強化するために使用できる顧客トレンドを把握できます。 6. **アプリケーションへの簡単な統合**: Catalystは、アプリケーションのフロントエンドコードに実装してBotをすばやく組み込むことができるConvoKraft SDKパッケージを提供しています。各種プラットフォーム向けのこれらのSDKパッケージは、アプリケーション内のBotのデザインと機能をカスタマイズするためのサンプルコードスニペットを提供します。 7. **オートスケーリング機能を備えた信頼性の高いインフラストラクチャ**: Catalyst ConvoKraftには、Catalystが提供するリソースの効率的な使用を可能にする強力なオートスケーリング機能が搭載されています。Catalystは、Zohoの実績あるインフラストラクチャ上に構築されたバックエンドサーバー管理全体を処理するため、セットアップとメンテナンスの労力が完全に排除されます。 -------------------------------------------------------------------------------- title: "ユースケース" description: "Catalystアプリケーションに強力なチャットBotアシスタントを統合する機能を提供するCatalyst ConvoKraftのさまざまなユースケースについて学びます。" last_updated: "2026-07-02T09:34:21.909Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/getting-started/usecases/" service: "ConvoKraft" -------------------------------------------------------------------------------- # ユースケース 以下は、ConvoKraft Botの一般的なリアルタイムユースケースと、Catalystアプリケーションで使用する主な利点です： 1. ビジネスのオンラインリテールアシスタントとして機能するeコマースBotで、顧客のオンラインショッピング注文の管理を支援します。注文の追跡、購入履歴の取得、現在の購入商品に関する情報、シーズンのベストセラー商品やカート内の商品に適用されるオファーの詳細の取得など、シンプルで簡単な顧客の問い合わせに応答するようBotを設定できます。また、Botと対話して適切な注文詳細を提供することで、顧客が直接商品のキャンセルまたは交換手続きを開始できるようにBotを設定することも可能です。 2. ビジネスWebサイトの訪問者と対話し、求めている情報を提供してリードを生成するバーチャルフロントオフィスアシスタント。住宅ローンや教育ローンを提供する金融会社を考えてみましょう。会社のビジネスWebサイトでは、ローンの仕様や適格性の詳細が提供されています。この場合、ConvoKraft Botを使用して、問い合わせに応じて必要な情報を提示し、営業担当者がフォローアップやリード転換を行うために役立つユーザー詳細を収集できます。 3. カウンター担当者として機能するチケット発行Botで、今後のイベント、会場、期間、日時、アジェンダ、基調講演者などに関する顧客の問い合わせに応答します。Botを設定して、顧客に代わってアプリケーションでチケットを予約し、チケットのコピーを顧客に送信できます。また、Botは顧客が予約済みチケットのキャンセルや返金手続きを開始することも可能にします。 4. 製品Webサイト向けのシンプルなFAQ Botは、毎回FAQドキュメントを検索する代わりに、ConvoKraft Botと対話するだけでユーザーが必要な情報をすばやく取得できるようにします。また、ユーザーが製品の特定の機能について問い合わせた場合に、適切なヘルプドキュメントのリンクを表示するようBotを設定することも可能です。これにより、カスタマーサポートチームが時間のかかる簡単な質問への対応を避け、より複雑なチケットにのみ集中できるため、大幅な時間の節約になります。 5. 病院のWebサイトにおける予約スケジューリングBotで、患者の問題について問い合わせ、詳細を収集し、該当する利用可能な医療専門家との予約をスケジュールします。また、Botは患者と対話し、この特定の病院で以前に受診したことがあるかどうかを確認し、患者の履歴レコードを取得して、予約時間前に医療専門家に送信することで、患者にとってシームレスな診察体験を実現できます。 -------------------------------------------------------------------------------- title: "クイックスタートガイド" description: "Catalystアプリケーションに強力なチャットBotアシスタントを統合する機能を提供するCatalyst ConvoKraftの使用を開始する手順について学びます。" last_updated: "2026-07-02T09:34:21.909Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/getting-started/quick-start-guide/" service: "ConvoKraft" -------------------------------------------------------------------------------- # クイックスタートガイド このセクションでは、Catalystプロジェクトの作成、ConvoKraft Botの構築、BotのBusiness logicの設定、Botのトレーニングとテスト、Catalystアプリケーションへの組み込み、そして本番環境へのデプロイまで、Catalyst ConvoKraftサービスの使用に関わる全体的なプロセスを説明します。 ConvoKraftサービスを使用する際には、Catalystプラットフォームでいくつかの前提条件と事後条件があります。例えば、アプリケーション用にCatalystプラットフォームでプロジェクトを作成し、そのアプリケーション用のBotを構築する必要があります。Botを構築してアプリケーションに同期した後、Botを本番環境で稼働させるために、CatalystコンソールからCatalystプロジェクト全体をデプロイする必要があります。 各手順を詳しく見ていきましょう： 1. **Catalystプロジェクトの作成** - Catalystコンソールにアクセスして新しいプロジェクトを作成します。プロジェクトの作成が完了すると、コンソールからすべてのCatalystサービスにアクセスできるようになります。 2. **Botの作成と設定** - CatalystコンソールのConvoKraftサービスにアクセスしてBotを直接作成し、Botが実行するActionsを設定できます。ConvoKraft BotのActionsは、基盤となるBusiness logicを実行するか、直接的な事前設定済みの応答で返答するように設定できます。Actionsの作成、Sample Sentencesの定義、Actionsのparamの定義の詳細については、このページを参照してください。 3. **Business logicの構築** - Business logicを実行してアプリケーション内で操作を行うようActionsを設定する場合、Catalyst FunctionsまたはDelugeを使用してロジックをコーディングできます。また、ロジックをコーディングしてサーバーにホストし、Webhooksを通じて参照することも可能です。 4. **Botのテストとトレーニング** - 必要なActionsでBotを作成・設定したら、Botをトレーニングできます。トレーニングにより、BotのデフォルトのNLP能力を強化し、設定内容やBotの会話履歴に基づいてニーズに合わせて調整できます。Botがトレーニングされたら、コンソールから直接対話してすぐにテストできます。Botのトレーニングとテストプロセスの詳細については、このページを参照してください。 5. **アプリケーションへのBotの組み込み** - Botをテストしたら、Catalystアプリケーションに組み込み、アプリケーションの特定のニーズに基づいてカスタマイズできます。例えば、Botのウィンドウのサイズ、位置、外観などを必要に応じて変更できます。アプリケーションでBotを使用するには、コードベースにConvoKraftのJavascript SDKパッケージを組み込むだけです。 6. **アプリケーションのホスト** - Catalyst CloudScaleサービスのWebクライアントホスティングコンポーネントを通じて、Catalystアプリケーションを開発環境に並行してホストする必要があります。Catalyst DevOpsサービスのコンポーネントを使用して、Catalyst Integration FunctionsでのBusiness logicの実行を監視し、ログを確認することもできます。 7. **アプリケーションの本番環境へのデプロイ** - 開発環境でアプリケーションをテストした後、このページの説明に従って本番環境に移行できます。Catalystプロジェクトをデプロイすると、本番環境のアプリケーションのクライアントインターフェースからBotにアクセスし、直接対話できるようになります。 ## ヘルプコンポーネント -------------------------------------------------------------------------------- title: "SmartTrain" description: "この機能を使用すると、URLを通じてカスタムデータを追加することで、ConvoKraft Botをトレーニングできます。" last_updated: "2026-07-02T09:34:21.909Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/smarttrain/" service: "ConvoKraft" -------------------------------------------------------------------------------- # SmartTrain SmartTrainは、Catalyst ConvoKraftサービスの高度な機能で、設定済みのActionsに対する定義済みのBot Logicを超えて、カスタムデータでBotをトレーニングし、学習能力を強化することができます。 SmartTrainを使用すると、Catalystコンソールから直接カスタムトレーニングデータをConvoKraftにアップロードできます。システムはアップロードされたデータを処理し、自動的にBotをトレーニングすることで、トレーニングされたコンテンツに基づいてユーザーのクエリにインテリジェントな応答を提供できるようになります。 Catalystは、SmartTrainの機能を活用するためにアプリケーションに統合できる包括的なREST APIセットを提供しています。これらのAPIを使用すると、SmartTrainの有効化・無効化、新しいトレーニング素材の追加、既存のトレーニングデータの詳細取得、トレーニング素材の削除、カスタムデータでのトレーニング成功後のConvoKraft Botからの応答取得が可能です。詳細については、APIドキュメントを参照してください。 ### トレーニングデータのアップロード ConvoKraft Botをカスタムデータでトレーニングするには、まず**SmartTrain**機能を有効にする必要があります。有効にしたら、トレーニング用のデータをアップロードでき、Botは自動的にコンテンツを処理・学習し、インテリジェントな応答を提供する能力を向上させます。 トレーニングデータは、以下のファイル形式のWebリソースへのURLとしてアップロードできます： * **.html** * **.txt** URLには、Botが学習し応答生成に使用する必要のある情報が含まれている必要があります。トレーニングプロセスは完全に自動化されており、**SmartTrain**が情報の理解と整理の複雑さを管理します。コンテンツの手動構造化やフォーマットは必要ありません。SmartTrainはデータ内のコンテキストと関係性を保持し、Botが正確で関連性の高い応答を提供できるようにします。 Botを作成してから、以下の手順に従ってSmartTrainを有効にし、トレーニングデータをアップロードできます： 1. **SmartTrain**タブに移動し、**Enable SmartTrain**をクリックします。 2. 確認ポップアップで、**Enable**をクリックします。 3. **Add Training Data**をクリックして、カスタムデータをアップロードします。 4. **Add URL**セクションで、トレーニングデータを含む**.html**または**.txt**形式のWebリソースのURLを入力し、**Add**をクリックします。 デモンストレーション目的で、Catalystヘルプドキュメントのリンクを追加しました。 5. トレーニング素材が追加され、Botが自動的に処理を開始します。 6. トレーニングが完了すると、ステータスが**Trained**に更新されます。 アップロードしたカスタムデータに関連する質問をしてBotをテストできます。ここでは、ヘルプドキュメントに記載されているCatalystに関するあらゆるクエリにBotが回答できるようになります。次のセクションでこの動作を確認します。 注意: Actionsを設定する場合のように手動でBotをトレーニングする必要はありません。**SmartTrain**では、トレーニング素材をアップロードすると自動的にトレーニングが行われるため、直接テストに進むことができます。 ### Botのテスト カスタムトレーニングデータのアップロードとトレーニングプロセスの完了後、以下のスクリーンショットに示すように、右下の**Test the Bot**ボタンをクリックしてBotをテストできます。 アップロードしたカスタムトレーニングデータに基づいて、Botに任意の質問をすることができます。Botは情報を分析し、関連する詳細を関連付け、構造化された分かりやすい応答を生成します。 では、Catalyst ConvoKraftサービスについて質問し、Botがどのように応答するか見てみましょう。 トレーニングデータに含まれていない質問やBotの理解を超える質問をした場合、fallback handler関数で設定されたメッセージで応答します。 ### トレーニングデータの削除 アップロードしたトレーニングデータは、Catalystコンソールからいつでも直接削除できます。ただし、一度削除すると、Botはそのソースからの学習内容をすべて失い、再度トレーニングするにはデータを再アップロードする必要があります。 1. トレーニング素材の横にある省略記号アイコンをクリックし、**Delete**を選択します。 2. 確認ポップアップで、**Delete**をクリックします。 ### SmartTrainの無効化 カスタムトレーニングデータに基づいてBotが質問に応答しないようにする場合は、**SmartTrain**機能を無効にできます。SmartTrainを無効にすると機能が一時的に停止しますが、再度有効にすると、Botは既存のトレーニングデータを使用してクエリへの応答を再開します。トレーニングデータを完全に削除する場合は、前のセクションで説明した方法で削除してください。 1. **SmartTrain**を無効にするには、以下のスクリーンショットに示す省略記号アイコンをクリックし、**Disable SmartTrain**を選択します。 2. 確認ポップアップで、**Disable SmartTrain**をクリックします。 ### Botの管理 -------------------------------------------------------------------------------- title: "Botのトレーニング" description: "ConvoKraft botのトレーニングプロセスと、デプロイ前にトレーニングを行うことの重要性について説明します。" last_updated: "2026-07-02T09:34:21.909Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/manage-a-bot/train-a-bot/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Botのトレーニング 開発環境でConvoKraft botのActionsを作成または変更した後、設定した操作でbotをトレーニングする必要があります。Actionを作成する際、Sample Sentencesとそれに対する期待される応答を定義します。ユーザーがタスクを実行するためにbotとの会話を開始すると、botはまずユーザーのメッセージと事前定義されたSample Sentencesをすばやく比較します。設定されたActionsのいずれかと一致する場合、botは意図された回答で応答します。 botをトレーニングすると、一般的な呼び出しパターンと特定のActionsに対する設定を分析し、NLPロジックに到達できるようになります。これにより、対応する自然言語処理（NLP）モデルが自動生成され、トレーニングされます。これらのモデルは、同じユーザークエリの異なるバリエーション間の相関関係を見つけ、知的に応答するのに役立ちます。 botをトレーニングすることで、同じユーザークエリの複数のバリエーションに対してSample Sentencesを定義する時間のかかる作業を回避できます。botをトレーニングした後、更新された設定に関して会話を開始することで、すぐにbotをテストできます。 イベントの詳細を取得して回答を構成するActionに対して、**「イベントの会場はどこですか」**、**「イベントはいつ開催されますか」**、**「イベントの基調講演者は誰ですか」**のようなクエリのSample Sentencesを定義する場合を考えてみましょう。 ユーザーが**「イベント会場はどこですか？」**や**「イベントは何時ですか？」**のように会話形式でbotに質問した場合、botはこれらのメッセージのIntentを認識し、利用可能なNLPモデルに格納されている呼び出しパターンを検索します。botはこれらの質問を、ユーザー入力のIntentをより深く理解するために既に定義されたSample Sentencesと関連付けます。 このため、デプロイ前にbotをトレーニングすることが重要です。Actionsを設定した後、コンソールのBotの詳細ページからbotをトレーニングできます。これにより、Catalystがバックグラウンドでトレーニングプロセスを開始します。botのトレーニングが正常に完了すると、ステータスメッセージが表示されます。 注意: トレーニングプロセス中にネットワークの問題が発生した場合、トレーニングが失敗する可能性があります。その場合は、botを再度トレーニングしてから、デプロイに進むことができます。 Catalystプロジェクトをデプロイすると、botは本番環境にデプロイされます。プロジェクトのデプロイ手順については、こちらのページを参照してください。 -------------------------------------------------------------------------------- title: "Botのテスト" description: "botのAction設定に基づいて、会話形式で対話してConvoKraft botをテストする方法を説明します。" last_updated: "2026-07-02T09:34:21.909Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/manage-a-bot/test-a-bot/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Botのテスト ConvoKraft botをトレーニングした直後に、Catalystコンソールから直接、Actionsに加えた最新の変更に関連するクエリを使用して、会話形式で対話することでテストできます。 注意: 本番環境のライブbotで重大な問題が発生するのを避けるため、本番環境にデプロイする前に、開発環境で必ずbotをトレーニングし、テストすることをお勧めします。 Catalystプロジェクトをデプロイすると、botは本番環境にデプロイされます。プロジェクトのデプロイ手順については、こちらのページを参照してください。 # Botとの対話 Catalyst ConvoKraft上に構築されたbotとは、人間と話したりテキストを送ったりするのと同じように、会話形式の英語で対話できます。botはあなたの自然言語を理解し、質問に答えたり、指示を実行したりしようとします。 botのチャットウィンドウを開くと、botが実行できるActionsのリストとともにonboarding screenが表示されます。botにカスタムのonboarding screenが設定されていない場合、botを開いたときにウェルカムメッセージとして"Hi, how may I help you?"が表示されます。リストから1つを選択するか、テキストボックスにカスタムメッセージを入力して、ConvoKraft botと対話できます。 チャットウィンドウからbotにメッセージを送信すると、botは返信で応答します。返信は、質問に対する回答または指示の実行結果です。botが質問に答えたり操作を実行したりするためにさらに情報が必要な場合、会話形式で追加情報を求めることがあります。たとえば、イベントを予約しようとしている場合、botはイベント名、イベントの種類、開催日などの詳細を取得するために質問を促すことがあります。 特定の質問に対して、botは選択肢を表示し、要件に応じて1つまたは複数のオプションを選択できます。選択後、適切なボタン（利用可能な場合）をクリックして指示を進めます。ボタンが表示されていない場合、選択したオプションはすぐにbotに送信されます。たとえば、イベントの曜日に関する質問では、botは月曜日、火曜日、水曜日などのオプションを提供することがあります。 * **単一入力の選択** * **複数入力の選択** * **日付ピッカー** ConvoKraft botでは、その指示の処理にオプションとみなされる特定の質問をスキップできる場合があります。特定の質問に答えたくない場合は、Skip giving this inputオプションをクリックしてください。 同様に、回答が無効な形式であったり、botがメッセージから意味のあるデータを推測できない場合、有効な回答が得られるまで同じ入力を繰り返し求めます。 いつでも、現在の会話のコンテキストを続行したくない場合は、Start a new conversationオプションをクリックできます。これにより、botは会話の現在のコンテキストを破棄し、別の指示で会話をやり直すことができます。 必要な詳細をすべて受け取ると、botは目的の操作を実行し、最終的な出力を表示します。出力は、設定に基づいて、シンプルなメッセージ、テーブル、画像、箇条書きリストなどになります。 他の質問をしたり、さらなる指示を与えたりすることで、botとの会話を続けることができます。botは前回の指示に関連する提案も表示します。提案から1つを選択するか、新しいメッセージを入力して対話を続けることができます。提案の表示と同様に、botは会話を進めるための提案とともにフォローアップの質問をすることもあります。表示された提案から1つを選択するか、適切な回答を返信として入力することで、その質問に答えることができます。 -------------------------------------------------------------------------------- title: "Botのデプロイ" description: "開発環境でのトレーニングとテスト後のConvoKraft botのデプロイプロセスについて説明します。" last_updated: "2026-07-02T09:34:21.909Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/manage-a-bot/deploy-a-bot/" service: "ConvoKraft" -------------------------------------------------------------------------------- # 本番環境へのデプロイ botまたはその基盤となるActionsに加えた変更は、ConvoKraftの開発環境にのみ保存されます。これらの変更は、本番環境のbotにすぐには反映されません。ライブbotが新しいActionsの追加、削除、または既存のActionsの変更を理解するには、botを本番環境にデプロイする必要があります。 これは、本番環境でユーザーに既に使用されているbotに対して、開発環境でシームレスに変更を加えることができるようにするために必要です。 botを本番環境にデプロイするには、Botの詳細ページでDeploy to Productionボタンをクリックします。 注意: Deploy to Productionボタンは、botに設定した基盤となるActionsに変更が加えられた場合にのみアクティブになります。 Deploy to Productionボタンをクリックすると、以下のセクションを含むポップアップウィンドウが表示されます： * **Choose Actions**：前回のデプロイ以降に変更されたすべてのActionsが、このセクションにカテゴリ別にリストされます。Actionを選択して、その変更を本番環境にデプロイします。選択されていないActionsに加えた変更はデプロイされません。 * **Release Type**：変更内容に基づいて適切なリリースタイプを選択します。この選択に基づいて、デプロイに適切なバージョン番号が付与されます。 * **Release Notes**：将来の参照用に、変更内容についてのメモを残すことができます。 必要な値をすべて入力したら、Deployボタンをクリックします。デプロイが成功すると、基盤となるActionsに加えた変更が本番環境のbotに反映されます。 ドロップダウンから選択することで、本番環境に切り替えることができます。 コンソールのClientsタブに移動し、以下のスクリーンショットに表示されているコードをコピーして、アプリケーションのソースコードのindex.htmlファイルに貼り付けることで、ConvoKraft botをWebアプリケーションに埋め込むことができます。 さらに、ConvoKraft JS SDKパッケージを使用して、特定の要件に合わせてConvoKraft botをカスタマイズできます。 -------------------------------------------------------------------------------- title: "利用統計" description: "Catalystコンソールで確認できるConvoKraft botのさまざまな利用統計について説明します。" last_updated: "2026-07-02T09:34:21.909Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/manage-a-bot/usage-stats/" service: "ConvoKraft" -------------------------------------------------------------------------------- # 利用統計 botが入力メッセージを受信すると、応答としてActionを呼び出すか、そもそもメッセージを理解できないかのいずれかになります。開始されたActionは、会話の途中でユーザーによって中止されたり、技術的な問題により失敗したりする場合もあります。Usage Statsタブは、botの利用状況の分析を提供し、Actionレベルでのカウントの詳細も表示します。 # Actionごとの呼び出し 利用統計レポートは、ConvoKraft botによって処理されたすべてのメッセージのカウントを、以下のカテゴリに大きく分類します： * Responded With Actions：botに設定されたActionsによって応答された呼び出しの数。 * Responded By ConvoKraft：botに設定されたhandlerによって応答された呼び出しの数。 * Missed To Understand：botが理解できなかった呼び出しの数。 Actionsで応答された呼び出しの数は、呼び出されたActionsに基づいてさらに分類されます。各Actionの合計呼び出しカウントは、さらに3つのカテゴリに分割されます： * COMPLETED - Actionが正常に完了した呼び出しの数。 * CANCELLED - 会話の途中でActionがキャンセルされた呼び出しの数。 * FAILED - Business logicの技術的な問題によりActionが失敗した呼び出しの数。 注意: 1. Usage statsタブは、botを本番環境にデプロイした場合にのみ表示されます。 2. さまざまな期間の利用統計を表示でき、任意の列に基づいてソートすることもできます。 ### アクション -------------------------------------------------------------------------------- title: "Actionの作成" description: "クエリへの直接応答やデータ取得・タスク実行のためのBusiness Logicの実行など、Botに設定できるCatalyst ConvoKraft Actionsについて説明します。" last_updated: "2026-07-02T09:34:21.911Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/create-an-action/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Actionの作成 このセクションでは、Actionを作成し、ConvoKraft BotのSample SentencesとParamを設定する手順について説明します。 Botを作成した後、1つ以上のActionsを追加できます。ConvoKraft Botに新しいActionを追加するには、以下の手順に従ってください： 1. 新しいConvoKraft Botを作成するか、既存のBotをクリックすると、以下のスクリーンショットに示すようにBotの詳細ページが表示されます。Create Actionをクリックします。 2. 表示されるポップアップでActionに意味のある名前を入力します。Actionの応答をDirect answerまたはBusiness Logicに基づいて設定するかを選択できます。選択してNextをクリックします。 ### Direct answerで応答する Actionの応答をDirect answerで設定する場合は、以下の手順に従ってください： 1. この質問がどのように尋ねられるかについて、適切なSample Sentencesを入力します。つまり、ユーザーがConvoKraft Botと会話する際に使用する可能性のある質問のさまざまなバリエーションです。Sample Sentencesの詳細については、こちらのページをご覧ください。Nextをクリックします。 2. 「What's the answer」セクションで、質問に対する回答として返信するコンテンツを入力します。回答内の特定のテキストを選択し、ツールバーで利用可能な各種フォーマットアイコンをクリックしてフォーマットスタイルを適用できます。各種フォーマット構造の詳細については、こちらのセクションをご覧ください。 注意: ここで設定された回答は、地域やタイムゾーンに関係なく、すべてのユーザーに共通の普遍的なものです。 3. MarkdownエディタのツールバーのPreviewオプションをクリックして、適用されたフォーマットスタイルでコンテンツのライブプレビューを表示します。Saveをクリックします。 ### Business Logicの実行による回答の構築 データの取得または任意の操作の実行により、Business Logicの実行に基づいてActionの応答を設定する場合は、以下の手順に従ってください： 1. ActionのSample Sentencesを定義します。 2. Actionに必要なparamを設定します。 注意: paramは、Actionの応答をBusiness Logicに基づいて設定する場合にのみ追加できます。 * Actionに新しいparamを追加するには： PARAMSセクションのNew Paramsオプションをクリックします。 3. ConvoKraftがサポートするデータ型のリストから必要なparam型を選択すると、詳細を設定するための新しいダイアログボックスが表示されます。各param型の属性の詳細については、paramをご覧ください。 #### String まず、String型の新しいparamを作成します。 paramには以下の詳細を設定できます： 1. ユーザー入力のプロンプトメッセージと、無効な入力の場合に表示するエラーメッセージを入力します。 2. 必要に応じて、「Allow to skip」を有効にします。 注意: 上記の属性は、ConvoKraftのすべてのparam型に適用されます。 #### Single/Multi selection list 次に、Single selection list型の別のparamを作成します： 1. Single selection list/Multi-selection list paramを設定する場合、以下の画像に示すようにNew Optionボタンをクリックして、適用可能なオプションを追加できます。このparam型の詳細については、こちらのページを参照してください。 注意: 「allow values」チェックボックスを有効にすることで、設定された値以外の値を実行時に許可することもできます。 2. オプションで、Submission Buttonsラベルの横にあるAdd Buttonオプションをクリックして、選択したオプションでさらなる操作を実行するカスタムボタンを設定することもできます。Configure Buttons画面が表示されます。各ボタンの必須フィールドの値を入力します。これらのフィールドの詳細については、こちらのページを参照してください。 別のボタンを追加するには、New Buttonをクリックし、必要なボタンが正常に追加されたらDONEをクリックします。 3. 要件に応じて、入力モードをTextualまたはVisualから選択します。 4. 必要なテキストを選択して、Sample Sentences内の特定のフレーズにparamを関連付けます。表示されたリストから設定済みのparamの1つを選択し、テキストにすぐに関連付けます。New paramをクリックして新しいparamを作成することもできます。 注意: Sample Sentencesにparamを関連付けていない場合、paramは定義された順序どおりに会話で呼び出されます。 5. Actionに必要なSample Sentencesとparamを設定したら、Saveをクリックします。 Editボタンをクリックして、設定をさらに編集できます。Actionの表示と管理の詳細については、こちらのページを参照してください。 -------------------------------------------------------------------------------- title: "Sample Sentencesの定義" description: "クエリへの直接応答やデータ取得・タスク実行のためのBusiness Logicの実行など、Botに設定できるCatalyst ConvoKraft Actionsについて説明します。" last_updated: "2026-07-02T09:34:21.911Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/define-sample-sentences/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Sample Sentencesの定義 ## はじめに Sample Sentencesは、ConvoKraft BotのActionを設定する際に追加する例文です。これらの文は会話形式であり、ユーザーがBotとどのように対話するかに基づいて設定できます。特定のActionに対して複数のSample Sentencesを追加できます。 ユーザーがBotと対話すると、ConvoKraft BotはSample Sentencesから類似する呼び出しを検索し、その呼び出しに関連付けられた対応するActionをトリガーします。既存の設定済みSample Sentencesと一致するものが見つからない場合、Botはfallback handlerで行われた設定に基づいて応答します。 注意: Delugeを使用してBot Logicを開発することを選択した場合は、fallback handler関数の詳細についてこちらのページを参照してください。選択した開発プラットフォームがCatalyst FunctionsまたはWebhooksの場合は、ソースコード内で失敗シナリオを自分で処理する必要があります。 Sample Sentencesは、直接応答やBusiness Logicの実行など、すべてのAction実行に適用されます。両方のAction実行のケースにおいて、作成するBotにSample Sentencesを定義する必要があります。 * Direct answerに基づいて応答を設定することを選択した場合、ユーザーが会話形式で使用する可能性のあるSample Sentencesを定義できます。ConvoKraftはNLP能力を使用して設定済みSample Sentencesの意図を理解し、ユーザーが類似のクエリを投げかけると、Botは設定されたDirect answerで応答します。 * Business Logicを実行するように応答を設定することを選択した場合、Sample Sentencesの設定とともに、Sample Sentence内に入力されたテキストを選択してparamとしてマークできます。ユーザーが提供した値を持つparamは、さらなる処理のためにBusiness Logicに渡されます。 Sample Sentencesの実装と使用方法の詳細については、Actionの作成をご覧ください。 ## Sample Sentenceの定義 このセクションでは、ConvoKraft ActionにおけるSample Sentencesの使用方法を説明するためのいくつかの例シナリオを説明します： たとえば、特定のモデルの携帯電話の詳細に関するクエリに応答するために呼び出されるActionを作成しているとします。入力（モデル名や番号など）に基づいて、対応するBusiness Logicが実行され、その特定のモデルの詳細が取得されます。 ユーザーは以下のような質問をする可能性があります： **「iPhone 14のスペックを教えてください」** **「iPhone 13のスペック」** **「iPhone 14 Pro Maxについてすべて教えてください」** **「iPhone 14の技術仕様」** **「iPhone SE2の技術スペック」** 質問への応答はユーザー入力に基づいて取得されます。たとえば、ユーザーがiPhone 14について問い合わせた場合、回答は以下のようになります。 <table class="content-table"> <thead> <tr> <th>技術仕様</th> <th>iPhone 14</th> </tr> </thead> <tbody> <tr> <td>プロセッサ</td> <td>Apple A15 Bionic</td> </tr> <tr> <td>ストレージ</td> <td>128GB, 256GB, 512GB</td> </tr> <tr> <td>ピクセル密度</td> <td>460 ppi</td> </tr> <tr> <td>ディスプレイサイズ解像度</td> <td>6.1-inch OLED; 2,532x1,170 pixels</td> </tr> </tbody> </table> Zoho Corporationに関する詳細を提供するActionの別の例を考えてみましょう。この場合、Zohoに関連する質問への回答はAction内で直接設定されます。 ユーザーが尋ねる可能性のある質問とそのさまざまなバリエーションを想像し、それらをSample Sentencesとして設定します。いくつかの質問の例： **「Zohoとは何ですか？」** **「Zoho Corporationは何をしている会社ですか？」** **「Zoho Corpについて教えてください」** Botは設定された回答で応答します： **「Zoho Corporationは、コンピュータソフトウェアとWebベースのビジネスツールを開発するインドの多国籍テクノロジー企業です。オンラインオフィススイートのZoho Office Suiteの提供で最もよく知られています。同社は1996年にSridhar VembuとTony Thomasによって設立され、インドのタミル・ナードゥ州チェンナイにグローバル本社を置き、7つの拠点に展開しています。」** ConvoKraft BotのAction作成時のSample Sentencesの実装と使用方法についてより詳しく理解するには、こちらのページを参照してください。 -------------------------------------------------------------------------------- title: "Paramの定義" description: "ConvoKraft BotでActionsを設定する際のparamの使用方法とユースケースについて説明します。" last_updated: "2026-07-02T09:34:21.911Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/define-params/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Paramの定義 # はじめに Botとの会話中にユーザーから受け取る入力データは、Actionのparamとして記述されます。Actionの実行をフォームへの記入に例えると、フォーム内のフィールドがActionのparamと見なすことができます。 たとえば、イベントを作成するActionのparamは通常以下のとおりです： * イベントのタイトル * イベントの開始時間 * イベントの終了時間 ユーザーはこれらの各paramに対して、自然言語で会話形式で値を提供できます。Actionに設定されたparamに基づいて、ConvoKraftはメッセージの意図を自動的に理解し、paramの適切な値を抽出します。 注意: Botの会話フローは、定義されたparamの順序に依存します。Actionが検出された後、Botは未入力のすべてのparamを定義された順序で、それぞれのプロンプトメッセージとともに1つずつプロンプトします。 ConvoKraftはNLP能力を使用して、Actionに対して行われた設定と実行時のユーザー入力との一致を行います。特定のparamの宣言されたデータ型に従って、ユーザーの入力を計算値に変換します。paramのサポートされるデータ型については、このページの後半で詳しく説明します。これらのparamは、Botの必要な操作を実行するためにBusiness Logicで使用されます。 paramの実装と使用方法の詳細については、Actionの作成をご覧ください。 注意: * paramの定義は、Business Logicを実行するようにActionを設定した場合にのみ適用されます。 * Actionには最大20個のparamを設定できます。 ### Paramの属性 このセクションでは、paramのさまざまな属性について詳しく説明します： 1. **Param名** paramの有効な名前は、以下のポイントに準拠する必要があります： * 小文字で始まること * 数字と文字のみ使用可能 * 最大50文字 * すべてのActionで一意であること * ConvoKraftの予約語として以下の名前はparamとして使用できません：userInput、previousParam、additionalParams、sessionData、broadcast、previousUserMsgs、cache、org、user 2. **Param型** ConvoKraftでサポートされている型のリストからparamに必要なデータ型を選択できます： <table class="content-table"> <thead> <tr> <th>データ型</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>String</td> <td>String型の単一入力</td> </tr> <tr> <td>Integer Number</td> <td>Integer型の単一入力</td> </tr> <tr> <td>Integer Number Range</td> <td>整数の開始範囲と終了範囲を表す2つの入力</td> </tr> <tr> <td>Decimal Number</td> <td>小数の四捨五入する桁数。許可される最大精度は5です。</td> </tr> <tr> <td>Decimal Number Range</td> <td>小数の開始範囲と終了範囲を表す2つの入力</td> </tr> <tr> <td>Date</td> <td>Date型の単一入力</td> </tr> <tr> <td>Date Range</td> <td>日付の開始範囲と終了範囲を表す2つの入力</td> </tr> <tr> <td>Date/Time</td> <td>Date/Time型の単一入力</td> </tr> <tr> <td>Date/Time Range</td> <td>Date/Timeの開始範囲と終了範囲を表す2つの入力</td> </tr> <tr> <td>Boolean</td> <td>YESまたはNOの入力</td> </tr> <tr> <td>Email</td> <td>Email型の単一入力</td> </tr> <tr> <td>Amount</td> <td>通貨コード/通貨記号を含む金額入力</td> </tr> <tr> <td>File</td> <td>ユーザー入力としてアップロードするファイル。このparamでは、ユーザーがアップロードできるファイルタイプを指定できます。サポートされているファイルタイプは以下に記載されています。</td> </tr> <tr> <td>Single selection list</td> <td>ユーザーが1つ選択できる利用可能なオプションのリスト。詳細は以下のとおりです。</td> </tr> <tr> <td>Multiple selection list</td> <td>ユーザーが複数選択できる利用可能なオプションのリスト。詳細は以下のとおりです。</td> </tr> </tbody> </table> 注意: * 日付範囲または時間範囲のparamが既にある場合、Actionに日付または時間のparamを追加することはできません。 * 整数範囲または小数範囲のparamが既にある場合、Actionに整数または小数のparamを追加することはできません。 ファイルparamについて、サポートされるファイルタイプは以下のように定義できます： <table class="content-table"> <thead> <tr> <th>フォーマット</th> <th>サポートされるファイルタイプ</th> </tr> </thead> <tbody> <tr> <td>IMAGE</td> <td>image/png, image/jpeg,image/bmp, image/tiff, image/vnd.microsoft.icon</td> </tr> <tr> <td>DOCUMENTS</td> <td>text/plain, text/csv, application/rtf, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.oasis.opendocument.text</td> </tr> <tr> <td>PDF</td> <td>application/pdf</td> </tr> <tr> <td>PRESENTATION</td> <td>application/mspowerpoint, application/vnd.ms-powerpoint, application/vnd.ms-powerpoint, application/vnd openxmlformatsofficedocument.presentationml .presentation, application/vnd.oasis.opendocument.presentation</td> </tr> <tr> <td>SPREADSHEET</td> <td>application/vnd.ms-excel, application/vnd.msexcel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.oasis.opendocument.spreadsheet</td> </tr> <tr> <td>AUDIO</td> <td>audio/mpeg , audio/wav, audio/midi, audio/x-midi, audio/aac</td> </tr> <tr> <td>VIDEO</td> <td>video/mpeg, video/x-msvideo ,video/x-flv, video/mp4, video/quicktime</td> </tr> <tr> <td>COMPRESSION</td> <td>application/zip, application/x-tar, application/gzip</td> </tr> </tbody> </table> ### Single and Multiple Selection List Single selection listおよびMultiple selection listのparamについては、以下の追加情報を入力する必要があります： 1. **Options**：ユーザーが1つまたは複数の選択肢を選択できる利用可能なオプションのリストです。 コードを使用せずに静的にオプションを設定できます。ユーザーが理解できる明確な値をすべてのオプションに設定することを推奨します。すべてのオプションにはIDがあり、プログラム上でオプションを一意に識別するために使用されます。すべてのオプションのIDを手動で入力するか、オプションを入力する際に自動生成されたIDを使用できます。選択リストオプションの有効な名前とIDは、以下のポイントに準拠する必要があります： * IDは英数字、ハイフン、アンダースコアのみサポート * オプション名は最大150文字 * 選択リストparamには最大50のオプションを設定可能 2. **Buttons**：ボタンは、選択された選択リストオプションに対して実行されるActionsを表します。カスタムボタンが設定されていない場合、デフォルトのアクションは選択された選択リストオプションの送信です。 ボタンのプロパティには以下が含まれます： * **Label** - ボタンの表示テキスト。 * **ID** - 会話中にどのボタンが選択されたかをBusiness Logicが一意に識別するための識別子。 * **Theme** - 会話中のボタンの外観を反映するカラースキーム。以下の3つのテーマがサポートされています。 1. **Positive** 2. **Negative** 3. **Neutral** ボタンの有効な名前とIDは、以下のポイントに準拠する必要があります： * ボタン名とIDには、すべての英数字と特殊記号を含めることができます。 * 最大150文字を含めることができます。 * 選択リストparamには最大3つのボタンを設定できます。 3. **Allow values other than these options**：このオプションにより、定義したオプションリストから選択するのではなく、ユーザーが独自の値を送信できるようになります。このオプションが有効になっている場合、そのような値のIDはnullに設定されます。 4. **Mode of Input**：ユーザーがparamに値を提供する方法を指定します。TextualまたはVisualのいずれかです。Textualを選択した場合、ユーザーはparamに割り当てたい値を入力できます。Visualの場合、ユーザーは利用可能な視覚的オプションから入力を選択する必要があります。オプションはラジオボタン（Single selectionの場合）、チェックボックス（Multiple selectionの場合）、または日付/時間ピッカー（Date/Time Rangeの場合）として表示されます。 5. **Prompt Message**：ユーザーとのBot会話の一部として、Botがユーザーにparamの入力を求める質問です。たとえば、イベント作成Actionでイベントの開始時間の値を取得するには、プロンプトメッセージを**「イベントは何時に始まりますか？」**や**「イベントはいつですか？」**のように設定します。このフィールドは空にできず、以下のポイントに準拠する必要があります： * #、/、\、&、*、+、=、()を除くすべての英数字と特殊記号を含めることができます。 * 最大255文字を含めることができます。 範囲を含むparamの場合、プロンプトメッセージフィールドは以下に分割されます： * Start of the Range：範囲の開始値を取得するためのプロンプトメッセージ。 * End of the Range：範囲の終了値を取得するためのプロンプトメッセージ。 6. **Prompt message on validation failure**：プロンプトされたparamに対してユーザー入力が無効と判定された場合にユーザーに表示されるカスタムメッセージです。このフィールドは任意です。 7. **Allow to skip**：Botとの会話中にparamへの回答をスキップすることをユーザーに許可します。 ### Paramの定義 このセクションでは、ConvoKraft ActionにおけるParamの使用方法を説明するためのいくつかの例シナリオを説明します： * ユーザーがオンライン注文の返品リクエストを開始する必要があるシナリオを考えてみましょう。ユーザーは次のような質問をするでしょう： **「注文を返品したいです」** **「注文を返品して」** **「この商品を返品して返金をリクエストして」** 返品リクエストの開始時にユーザーから詳細を取得するためにparam order idを作成し、Sample Sentencesの任意のフレーズにparamを関連付けることができます。これにより、ユーザーが返品について問い合わせると、Botはすぐに注文番号を尋ねるプロンプトを表示します。 * カレンダーに会議をスケジュールする別のシナリオを考えてみましょう。 ユーザーは次のようなものを入力するでしょう： **「明日の午後5時にカレンダーに会議をスケジュールして」** **「明日の会議を追加して」** この場合、eventname(String)、eventtype(Single selection list)、eventdays(Multi-selection list)、eventtime(Date/Time Range)などのparamを作成できます。 ConvoKraft BotのAction作成時にparamを設定する方法については、Actionの作成を参照してください。 -------------------------------------------------------------------------------- title: "Bot応答の定義" description: "クエリへの直接応答やデータ取得・タスク実行のためのBusiness Logicの実行など、Botに設定できるCatalyst ConvoKraft Actionsについて説明します。" last_updated: "2026-07-02T09:34:21.912Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/define-bot-responses/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Bot応答の定義 このセクションでは、ConvoKraft Botに設定できるさまざまな応答構造について詳しく説明します。Actionsの応答をDirect answerまたは定義済みのBusiness Logicに基づいて設定できます。このセクションでは、応答の種類とその構文について説明します。 ### Direct Answer応答 Actionを作成し、設定されたDirect answerに基づいて応答する場合、以下のオプションを使用して特定のニーズに合わせて回答をフォーマットできます。 * **太字** * **斜体** * **下線** * **取り消し線** * **ハイライト** * **見出し** * **箇条書きリスト** * **番号付きリスト** * **画像** * **引用** * **テーブル** エディタの上部にあるフォーマットメニューを使用し、クリックするだけで特定のフォーマットを適用できます。以下のスクリーンショットは、適用可能なすべてのスタイルでフォーマットされた回答を示しています。 **Preview**をクリックして、フォーマットされた応答の出力テキストを表示します。 # Business Logicに基づいた応答 設定されたBusiness Logicに基づいて応答するActionを作成する場合、以下の構文を使用してCatalyst Integration Function、Deluge、またはWebhooksでさまざまな応答を設定できます。さまざまな応答の種類とその構造を詳しく見ていきましょう。 ### プレーンテキスト ConvoKraft Botでユーザーのクエリに対してシンプルなテキストメッセージを応答として送信するには、以下の構造を使用してください。 #### JSON { "message": "This is a sample message response" } #### Java public class ExecuteHandler { public JSONObject handleExecuteRequest(JSONObject reqBody) { JSONObject jsonResponse = new JSONObject(); jsonResponse.put("message", "This is a sample message response"); } return jsonResponse; } #### Node.js export default function handleExecute(request) { let result={}; result.message="This is a sample message response"; return result; } #### Python def handle_execute_request(req_body): result = {} result['message'] = "This is a sample message response" return result 応答は以下のように表示されます： ### カード ConvoKraft Botでカード応答を設定するには、以下の構造に従ってください。Deluge関数でのカード応答の設定の詳細については、こちらのセクションをご覧ください。 **タイトルとノート付きのプレーンカード** このコードスニペットでは、タイトルとノートを含むカード内のシンプルなメッセージを定義できます。 #### JSON { "message": "Plain Card response", "card": [ { "type": "title", "content": "This is a card with title" }, { "type": "note", "content": "This is a card with note" } ] } #### Java public class ExecuteHandler { public JSONObject handleExecuteRequest(JSONObject reqBody) { JSONObject jsonResponse = new JSONObject(); jsonResponse.put("card", new JSONArray() .put(new JSONObject().put("type", "title").put("content", "This is a card with title")) .put(new JSONObject().put("type", "note").put("content", "This is a card with note")));} return jsonResponse; } #### Node.js export default function handleExecute(request) { let result={}; result.card=[]; result.card.push({ "type":"title", "content":"This is a card with title" }) result.card.push({ "type":"note", "content":"This is a card with note" }) return result; } #### Python def handle_execute_request(req_body): result = {} result['card'] = [ {"type": "title", "content": "This is a card with title"}, {"type": "note", "content": "This is a card with note"} ] return result 応答は以下のように表示されます： #### 箇条書きリストカード このコードスニペットでは、ConvoKraft応答のカード内に箇条書きリストを定義できます。 #### JSON { "message": "Bullet List RESPONSE", "card": [ { "type": "title", "content": "This is a title card for Bullet List" }, { "type": "list", "format": "bullet", "elements": [ { "label": "ABC" }, { "label": "DEF" } ] } ] } #### Java public class ExecuteHandler { public JSONObject handleExecuteRequest(JSONObject reqBody) { JSONObject jsonResponse = new JSONObject(); jsonResponse.put("card", new JSONArray() .put(new JSONObject().put("type", "title").put("content", "This is a title card for Bullet List")) .put(new JSONObject().put("type", "list").put("format", "bullet").put("elements", new JSONArray() .put(new JSONObject().put("label", "ABC")) .put(new JSONObject().put("label", "DEF")))));return jsonResponse; } #### Node.js export default function handleExecute(request) { let result={}; result.card=[]; result.card.push({ "type":"title", "content":"This is a title card for Bullet List" }) result.card.push({ "type":"list", "format":"bullet", "elements":[ { "label":"ABC" }, { "label":"DEF" } ] }); return result; } #### Python def handle_execute_request(req_body): result = {} result['card'] = [ {"type": "title", "content": "This is a title card for Bullet List"}, {"type": "list", "format": "bullet", "elements": [{"label": "ABC"}, {"label": "DEF"}]} ] return result Botでの応答は以下のように表示されます： #### 番号付きリストカード このコードスニペットでは、ConvoKraft応答のカード内に番号付きリストを定義できます。 #### JSON { "message": "Numbered List RESPONSE", "card": [ { "type": "note", "content": "This is a note card with Numbered List" }, { "type": "list", "format": "numbered", "elements": [ { "label": "point no. 1" }, { "label": "point no. 2" } ] } ] } #### Java public class ExecuteHandler { public JSONObject handleExecuteRequest(JSONObject reqBody) { JSONObject jsonResponse = new JSONObject(); jsonResponse.put("card", new JSONArray() .put(new JSONObject().put("type", "note").put("content", "This is a note card with Numbered List")) .put(new JSONObject().put("type", "list").put("format", "numbered").put("elements", new JSONArray() .put(new JSONObject().put("label", "point no. 1")) .put(new JSONObject().put("label", "point no. 2"))))); return jsonResponse; } #### Node.js export default function handleExecute(request) { let result={}; result.card=[]; result.card.push({ "type":"note", "content":"This is a note card with Numbered List" }) result.card.push({ "type":"list", "format":"numbered", "elements":[ { "label":"point no. 1" }, { "label":"point no. 2" } ] }); return result; } #### Python def handle_execute_request(req_body): result = {} result['card'] = [ {"type": "note", "content": "This is a note card with Numbered List"}, {"type": "list", "format": "numbered", "elements": [{"label": "point no. 1"}, {"label": "point no. 2"}]} ] return result Botでの応答は以下のように表示されます： ### リンク応答 このコードスニペットでは、ConvoKraft応答のカード内にハイパーリンクを送信できます。 #### JSON { "message": "LINK RESPONSE", "card": [ { "type": "link", "text": "Click Here to Know about ZOHO", "content": "https://www.zoho.com" } ] } #### Java public class ExecuteHandler { public JSONObject handleExecuteRequest(JSONObject reqBody) { JSONObject jsonResponse = new JSONObject(); jsonResponse.put("card", new JSONArray() .put(new JSONObject().put("type", "link").put("text", "Click Here to Know about ZOHO").put("content", "https://www.zoho.com"))); return jsonResponse; } #### Node.js export default function handleExecute(request) { let result={}; result.card=[]; result.card.push({ "type":"link", "text":"Click Here to Know about ZOHO", "content":"https://www.zoho.com" }) return result; } #### Python def handle_execute_request(req_body): result = {} result['card'] = [ {"type": "link", "text": "Click Here to Know about ZOHO", "content": "https://www.zoho.com"} ] return result Botでの応答は以下のように表示されます： ### テーブル応答 このコードスニペットでは、ConvoKraft応答のカード内に値が入力されたテーブルを表示できます。 #### JSON { "message": "TABLE RESPONSE", "card": [ { "type": "table", "heading": "Convokraft Dummy Table", "columns": [ "Name", "AGE", "CITY" ], "rows": [ [ "BOB", "25", "SFO" ], [ "Evan", "28", "NY" ] ] } ] } #### Java public class ExecuteHandler { public JSONObject handleExecuteRequest(JSONObject reqBody) { JSONObject jsonResponse = new JSONObject(); jsonResponse.put("card", new JSONArray() .put(new JSONObject().put("type", "table").put("heading", "Convokraft Dummy Table").put("columns", new JSONArray() .put("Name").put("AGE").put("CITY")).put("rows", new JSONArray() .put(new JSONArray().put("BOB").put("25").put("SFO")) .put(new JSONArray().put("Evan").put("28").put("NY"))))); return jsonResponse; } #### Node.js export default function handleExecute(request) { let result={}; result.card=[]; result.card.push({ "type":"table", "heading":"Convokraft Dummy Table ", "columns":[ "Name", "AGE", "CITY" ], "rows":[ [ "BOB", "25", "SFO" ], [ "Evan", "28", "NY" ] ] }) return result; } #### Python def handle_execute_request(req_body): result = {} result['card'] = [ {"type": "table", "heading": "Convokraft Dummy Table", "columns": ["Name", "AGE", "CITY"], "rows": [["BOB", "25", "SFO"], ["Evan", "28", "NY"]]} ] return result Botでの応答は以下のように表示されます： ### VCard応答 このコードスニペットでは、ConvoKraft応答のカード内に名、姓、会社名、Webサイトを含む連絡先情報を定義できます。 #### JSON { "message": "VCard Response", "card": [ { "type": "vcard", "info": { "image": "https://contacts.zoho.com/file?ID=53157432", "fields": [ { "First Name": "Prashaanth" }, { "Last Name": "Ramesh" }, { "Company": "Zoho" }, { "Website": "https://www.zoho.com" } ] } } ] } #### Java public class ExecuteHandler { public JSONObject handleExecuteRequest(JSONObject reqBody) { JSONObject jsonResponse = new JSONObject(); jsonResponse.put("card", new JSONArray() .put(new JSONObject().put("type", "vcard").put("info", new JSONObject().put("image", "https://contacts.zoho.com/file?ID=53157432").put("fields", new JSONArray() .put(new JSONObject().put("First Name", "Prashaanth")) .put(new JSONObject().put("Last Name", "Ramesh")) .put(new JSONObject().put("Company", "Zoho")) .put(new JSONObject().put("Website", "https://www.zoho.com")))))); return jsonResponse; } #### Node.js export default function handleExecute(request) { let result={}; result.card=[]; result.card.push({ "type":"vcard", "info":{ "image":"https://contacts.zoho.com/file?ID=53157432", "fields":[ { "First Name":"Prashaanth" }, { "Last Name":"Ramesh" }, { "Company":"Zoho" }, { "Website":"https://www.zoho.com" } ] } }) return result; } #### Python def handle_execute_request(req_body): result = {} result['card'] = [ {"type": "vcard", "info": {"image": "https://contacts.zoho.com/file?ID=53157432", "fields": [{"First Name": "Prashaanth"}, {"Last Name": "Ramesh"}, {"Company": "Zoho"}, {"Website": "https://www.zoho.com"}]}} ] return result Botでの応答は以下のように表示されます： ### ファイル応答 このコードスニペットでは、ConvoKraft応答のカード内にファイルを送信できます。 #### JSON { "message": "FILE Response", "card": [ { "type": "file", "name": "SamplePDF", "format": "pdf", // ファイル拡張子 "content": "https://pdfobject.com/pdf/sample.pdf" } ] } #### Java public class ExecuteHandler { public JSONObject handleExecuteRequest(JSONObject reqBody) { JSONObject jsonResponse = new JSONObject(); jsonResponse.put("card", new JSONArray() .put(new JSONObject().put("type", "file").put("name", "SamplePDF").put("format", "pdf").put("content", "https://pdfobject.com/pdf/sample.pdf")));return jsonResponse; } #### Node.js export default function handleExecute(request) { let result={}; result.card=[]; result.card.push({ "type":"file", "name":"SamplePDF", "format":"pdf", // ファイル拡張子 "content":"https://pdfobject.com/pdf/sample.pdf" }) return result; } #### Python def handle_execute_request(req_body): result = {} result['card'] = [ {"type": "file", "name": "SamplePDF", "format": "pdf", "content": "https://pdfobject.com/pdf/sample.pdf"} ] return result Botでの応答は以下のように表示されます： -------------------------------------------------------------------------------- title: "Actionの管理" description: "クエリへの直接応答やデータ取得・タスク実行のためのBusiness Logicの実行など、Botに設定できるCatalyst ConvoKraft Actionsについて説明します。" last_updated: "2026-07-02T09:34:21.912Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/manage-an-action/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Actionの表示 Actionは、会話の一部として指示を出した際にBotが実行する単一の能力またはタスクです。Actionを作成するには、こちらのページを参照してください。作成されたActionsは、以下のスクリーンショットに示すように、Botの詳細ページのActionsセクションに表示されます。これらのActionsは、Actionsセクションのフィルターを使用して次のように分類できます： * **Active**：作成され使用可能なActionsで、デプロイボタンをクリックすると本番環境に移行されます。 * **Inactive**：無効化により開発環境で使用できないActionsですが、無効化前に公開されている場合は本番環境でのチャットに使用できます。 # Actionの管理 Actionに必要なSample Sentencesとparamを設定した後、以下のスクリーンショットに示すように、Actionの詳細ページからActionをさらに編集できます： 省略記号アイコンにカーソルを合わせて Deactivateをクリックすることで、BotのActionを無効化することもできます。 -------------------------------------------------------------------------------- title: "アクションフォローアップ" description: "クエリへの直接応答やデータ取得・タスク実行のためのBusiness Logicの実行など、Botに設定できるCatalyst ConvoKraft Actionsについて説明します。" last_updated: "2026-07-02T09:34:21.912Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/action-followups/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Action Followups Action Followupsは、Actionの実行後にBotがユーザーに何を推奨すべきかを定義し、会話にユーザーをさらに引き付けるためのものです。Botは提案のリストを表示したり、特定のActionの完了後にユーザーにとってコンテキスト上有用な別のActionを呼び出すかどうかを尋ねたりできます。フォローアップとして設定されたActionsは、同じActionまたは異なるActionsにすることができますが、対応するConvoKraft Botにそれぞれのactionsが設定されている必要があります。 Action Followupsを設定することで、ユーザーがConvoKraft Botと対話するためのより多くの方法をBotが積極的に提案するようにできます。これにより、Action実行後にコンテキスト上有用な次のActionをユーザーが簡単にトリガーできるようになります。このようなコンテキスト上有用なActionsをフォローアップとして設定することで、現在のAction実行が完了すると、Botは定義済みの提案リストを即座に表示します。ユーザーが適切な提案を選択すると、その提案に設定されたActionが次のActionとして呼び出されます。 **例：** タスク管理アプリケーション用に構築されたBotを考えてみましょう。新しいタスクを作成した後、ユーザーへの提案として以下を表示することがコンテキスト上適切です：**「このタスクを開始する」**、**「未完了タスクを表示する」**、**「このタスクを重要としてマークする」**など。ユーザーが**「このタスクを重要としてマークする」**をクリックすると、タスクステータスを更新するActionが呼び出されます。 Action Followupsは、Actionsのリストを直接提供するか、実行時にActionsを動的に取得することで設定できます。Action Followups機能は、Direct answerで応答するように設定されたActionsとBusiness Logicを実行するActionsの両方に同様に適用されます。 <br> ### Static Followup Suggestions コードを使用せずにAction Followupsを静的に設定する場合は、以下の手順に従ってください： 1. コンソールで既存のActionをクリックすると、Actionの詳細ページが表示されます。Actionの作成については、こちらのページを参照してください。 Followup SuggestionsセクションのAdd Followup Suggestionsをクリックします。 2. Followup Suggestionsのポップアップウィンドウで、以下の操作を行います： * Suggestionsセクションのテキストボックスに適切な提案テキストを入力します。 * Mapped Actionsセクションのドロップダウンをクリックし、指定した提案テキストにマッピングする適切なActionを選択します。これにより、ユーザーが提案をクリックした際にActionが実行されます。さらに提案を追加し、適切なActionsにマッピングすることもできます。 注意: Actionのフォローアップ提案として最大5つの提案を追加できます。 3. 必要な提案テキストとそのマッピングされたActionsの設定後、Updateボタンをクリックします。 設定されたフォローアップ提案は、Followup Suggestionsセクションにリスト表示されます。 4. 既存のフォローアップ提案リストを変更するには、Followup SuggestionsセクションのConfigureをクリックします。そこから、必要に応じてさらに更新できます。 注意: フォローアップ提案として設定された特定のActionが無効化/削除された場合、そのActionはFollowup Suggestionsリストから自動的に削除されます。 フォローアップ提案は、以下のようにチャットウィンドウに表示されます： <br> ### Dynamic Followup Suggestions ConvoKraft Botに実行時にフォローアップとして提案リストを動的に表示させるには、以下に示すように、Execution関数出力のfollowupキーにマップ値として渡す必要があります： フォローアップActionのparam値を設定して、そのAction実行時にユーザーに再度プロンプトが表示されないようにすることもできます。 { "followup":{ "suggestions":[ { "message":"//ユーザーに表示するチャット候補", "action":{ "name":"//呼び出すアクションの名前空間", "params":[ { "name":"//パラメーター名", "value":"//パラメーター値" } //必要に応じて他のパラメータを追加する ] } } //必要に応じて他の提案を追加する ] } } <br> ### 別のActionの呼び出しをプロンプトする 場合によっては、複数のActionsよりも1つのActionがAction後に実行する方が適切なことがあります。このActionを定義済みの提案とともにフォローアップとして設定することで、Botはその特定のActionを定義済みの提案リストとともに表示し、次のActionを呼び出すようプロンプトメッセージでユーザーに尋ねます。ユーザーは必要な提案を選択するか、適切なメッセージでプロンプトに返信し、会話をさらに進めることができます。 **例：** タスク管理Botを考えてみましょう。ユーザーは次のタスクを表示したい場合があります。次のタスクを表示した後、**「このタスクを開始しますか？」**とともに、このプロンプトに適した提案として**「はい、このタスクを開始済みにしてください」**、**「いいえ、結構です」**、**「いいえ、このタスクは後で開始します」**を尋ねることがコンテキスト上適切です。ユーザーは適切な提案を選択するか、適切なメッセージでこのプロンプトに返信して、そのタスクを開始するActionを呼び出すことができます。 フォローアップActionに多くのparamがあり、Botが他のparamの中で最初に特定のparamの値をプロンプトするようにしたい場合は、フォローアップActionの設定でそのparam名を指定できます。フォローアップActionのparam値を設定して、そのAction実行時にユーザーに再度プロンプトが表示されないようにすることもできます。 注意: 提案リストには最大5つの提案を設定できます。 ConvoKraft Botがフォローアップとして特定のActionを呼び出すようユーザーにプロンプトするには、以下の形式に示すように、Execution関数出力のfollowupキーにActionの詳細をマップ値として渡す必要があります： { "followup":{ "prompt":{ "message":"//ユーザーへのプロンプトメッセージ", "suggestions":["//候補テキスト1", "//候補テキスト2", ... "//候補テキスト5"], "reject_message":"//プロンプトをキャンセルするための否定的なフレーズをユーザーが返したときに表示するメッセージ", "param":"//このアクション実行時に最初に値を促すパラメーター名", "action":{ "name":"//呼び出すアクションの名前空間", "params":[ { "name":"//パラメーター名", "value":"//パラメーター値" } //必要に応じて他のパラメータを追加する ] } } } } -------------------------------------------------------------------------------- title: "Actionのテスト" description: "ConvoKraft Botに設定されたActionを会話形式でテストする方法を説明します。" last_updated: "2026-07-02T09:34:21.924Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/test-an-action/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Actionのテスト Actionに機能的な問題がないことを確認するために、本番環境にデプロイする前にActionをテストする必要があります。さらに、ユーザーエクスペリエンスを検証し、期待どおりに動作することを確認できます。 デプロイ前にActionをテストするには、Edit Execution Functionsページの右側パネルにあるサンプルチャットウィンドウを使用するために、Test this botをクリックします。このサンプルチャットウィンドウは、本番環境でのBotの実際のチャットウィンドウと同様に表示されます。 これを使用して、現在のActionのみをテストできます。指定された呼び出し文が現在のActionと無関係な場合、Botは理解できず、メッセージが理解できないという返信を行います。 注意: このウィンドウでは現在のActionのみテストでき、Botのすべての設定済みActionsをテストすることはできません。 ### Override Session Data 関数がBusiness LogicでsessionData引数を使用している場合、チャットウィンドウの右上にあるOverride Session Dataオプションを使用して、異なるモックセッションデータのセットでActionをテストできます。たとえば、Webクライアントに固有のコードロジックを記述している場合、適切なセッションデータ値を設定し、本番環境で実際のWebクライアントからBotにアクセスした場合にロジックがどのように機能するかをモックできます。 属性に適切な値を入力して保存すると、設定された値は次の会話のsessionData引数に渡されます。 #### ボットロジック -------------------------------------------------------------------------------- title: "Catalyst 統合ファンクション" description: "Catalyst Integration Functionsについて学び、ConvoKraft BotのBusiness Logicをコーディングするために使用する方法を説明します。" last_updated: "2026-07-02T09:34:21.925Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/bot-logic/catalyst-integration-functions/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Catalyst Integration Functions # はじめに Catalyst Integration Functionsを使用すると、他のZohoまたはCatalystサービスのBusiness Logicをコーディングし、2つのサービス間の統合を確立するためのバックエンドとして使用できます。関連するサービスで特定の機能にアクセスすると、HTTP呼び出しを通じてCatalystでコーディングされたIntegration Functionの実行が自動的に呼び出されます。Catalystがサポートする以下のプラットフォームで、サービスのバックエンド機能のBusiness Logicをコーディングできます： * **Java** * **Node.js** * **Python** ConvoKraft Bots用にCatalyst Functionsで構築するBusiness LogicはBot Logicと呼ばれ、Integration Function型です。CLIからCatalyst Integration Functionを初期化し、ローカル環境で作業し、サーブしてテストするか、リモートコンソールにデプロイできます。その後、作成するBotに関数を関連付けることができます。 Catalyst Integration Functionsを使用する場合、Catalyst LogsやApplication Performance Monitoringを通じて関数実行のログやレポートを表示できる、他のCatalyst機能も活用できます。 Catalyst Integration Functionsの詳細については、こちらのページをご覧ください。 <br> ### ConvoKraft Integration ConvoKraft Integration Functionsを使用すると、ConvoKraft BotsのBusiness Logicをコーディングし、以下のConvoKraftハンドラーを通じてバンドルできます： **1. Welcome Message Handler**：新しいチャットセッションを開く際に表示される応答を設定できます。 **2. Fallback Handler**：Botがユーザーの入力を理解できなかった場合に表示される応答を設定できます。 **3. Failure Handler**：会話中のユーザーのメッセージで例外が発生した場合に表示される応答を設定できます。 ### 関数構造 Integration Functionを作成すると、CatalystはBusiness Logicを構築するためのボイラープレートテンプレートコードを提供します。Java、Node.js、Pythonプログラミング環境でBusiness Logicを構築するために、それぞれのテンプレートを使用できます。Catalystでサポートされているすべてのスタックの完全な関数ディレクトリ構造の詳細については、こちらのページを参照してください。 Integration FunctionをCatalystで作成する方法の詳細については、後述のこちらで説明します。 ## Java Javaファイル構造には、メインJavaファイル、Action実行のコアBusiness Logicを保持するExecuteHandlerファイル、およびその他のハンドラーと設定ファイルが含まれます。 上記のファイルとボイラープレートテンプレートコードは、CLIからConvoKraft型のJava Integration Functionを初期化すると、関数ディレクトリに自動的に利用可能になります。CLIからCatalyst関数を初期化する方法の詳細については、こちらを参照してください。 初期化が完了したら、Bot Logicのコーディングに進み、ローカルでテストしてからCatalyst Functionをデプロイできます。 ## Node.js Nodeファイル構造には、メイン関数ファイルとハンドラーファイル、ノードモジュール、設定ファイルが含まれます。 上記のファイルとボイラープレートテンプレートコードは、CLIまたはコンソールからConvoKraft型のNode.js Integration Functionを初期化すると、関数ディレクトリに自動的に利用可能になります。こちらに記載された手順に従って、CatalystコンソールからConvoKraft Integration Functionを作成できます。 CLIからCatalyst関数を初期化する方法の詳細については、こちらを参照してください。 初期化が完了したら、Bot Logicのコーディングに進み、ローカルでテストしてからCatalyst Functionをデプロイできます。 ## Python JavaおよびNode.jsと同様に、Pythonファイル構造にはメイン関数ファイル、ハンドラー関数ファイル、設定ファイル、および追加でPythonモジュールファイルが含まれます。 requirements.txtファイルには、Catalyst Python関数を実装するために必要なインストール済み依存関係のリストが含まれています。requirements.txtファイルの使用方法の詳細については、こちらのページをご覧ください。 Java関数と同様に、Catalyst CLIからPython関数を初期化できます。ConvoKraft型のPython Integration Functionを初期化すると、上記のファイルとボイラープレートテンプレートコードがローカル環境の対応する関数ディレクトリに自動的に利用可能になります。 初期化が完了したら、Bot Logicのコーディングに進み、ローカルでテストしてからCatalyst Functionをデプロイできます。 注意: コンソールエディタから直接JavaおよびPython関数をコーディングすることはできません。エディタからはNode.js関数のみ作業できます。または、ローカル環境からJavaおよびPython関数を作業し、対応するコードバンドルをコンソールにアップロードできます。 <br> ### リクエスト形式 ConvoKraftは、Catalyst Integration Functionに以下の形式でリクエストを送信します： { "todo": "prompt || execute || fallback || button", "bot" : "", "action" : "", "button_id" : "", "environment" : "development || production" "params":{ }, "userInput" : "", "previousParam" : "", "user" : {}, "org" : {}, "broadcast" : {}, "cache" : {}, "sessionData" : {} "clientData" : {} } <br> ### レスポンス形式 ConvoKraftは、意図した応答を理解してユーザーに伝えるために、Catalyst Integration Functionからのレスポンスが以下の形式であることを期待します。ConvoKraftは、コンテンツをさまざまな形式で表示するための複数の応答タイプをサポートしています。応答を設定する際は、定義された標準に従う必要があります。応答構造の詳細については、こちらのセクションを参照してください。 **ケース1**：入力paramをユーザーにプロンプトする必要がある場合 { "status" : "prompt", "prompt" : { "param_name" : "leave_type", "options":[ { "id" : "111" ,"label" : "", "image" : "image_url"}, {"id" : "112" ,"label" :"" ,"image" : "image_url"} ], "buttons" : [] }, "message" : "You don't have enough casual leaves. Please choose some other leave type.", "data" : {} } **ケース2**：出力メッセージをユーザーに表示する必要がある場合 { "status" : "execution", "message":"Please check your screen.", "card":[], "data":{}, "broadcast":{}, "trigger":{}, "followup" : {} } Catalyst Integration Functionから受信するレスポンスには、以下のようないくつかの制限があります： * レスポンスの最大サイズは3 MBです。 * リクエストタイムアウトの最大時間は15秒です。 レスポンスが上記のガイドラインに準拠していない場合、ユーザーへの応答としてエラーメッセージが送信されます。 <br> ### 実装 Catalyst Integration Functionは、CatalystコンソールまたはCLIから作成できます。コンソールからIntegration Functionを作成するには、以下の手順に従ってください。CLIから関数を作成する手順については、こちらのページを参照してください。 1. CatalystコンソールからCatalyst Integration Functionを直接作成するには、Catalystコンソールの左ペインのServerlessアイコンに移動し、Create Functionをクリックします。 2. 意味のある関数名を入力し、Function TypeとしてIntegrationを選択し、Zoho ServiceとしてConvoKraftを選択します。Java、Node.js、Pythonのいずれかのプログラミング環境でロジックをコーディングすることを選択できます。Createをクリックして、新しいCatalyst Integration Functionを作成します。 注意: コンソールエディタからJavaおよびPython関数をコーディングすることはできません。Node.js関数のみ作業できます。JavaおよびPython関数はローカル環境から作業し、File Uploadオプションを使用して対応するコードバンドルをコンソールにアップロードできます。 3. Code tabに切り替えて、BotのBusiness Logicの記述を開始できます。 Business Logicをコーディングした後、Saveをクリックします。 ConvoKraft BotのBusiness Logicを開発したら、Botの作成時またはBotの詳細ページから後で、適切なCatalyst Integration Functionを開発プラットフォームとしてマッピングできます。関連付けられたIntegration Functionは、Botの設定済みActionsの呼び出し時に実行されます。 -------------------------------------------------------------------------------- title: "Webhook" description: "Webhooksについて学び、公開アクセス可能な外部サーバーでコーディングされたConvoKraft BotのBusiness Logicにアクセスするために使用する方法を説明します。" last_updated: "2026-07-02T09:34:21.925Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/bot-logic/webhooks/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Webhooks # はじめに Webhooksは、事前定義されたイベントの発生時に2つのアプリケーション間で開始される自動トリガーです。この場合、Business Logicを外部サーバーに配置することを選択した場合、開発プラットフォームとしてWebhooksを選択できます。外部サーバーがREST APIを通じてConvoKraftから公開アクセス可能であることを確認する必要があります。Business Logicを実行するために、Action実行中の対応する呼び出しポイントで設定されたWebhook URLがConvoKraftによって呼び出されます。 WebhookサーバーはConvoKraft Botの適切な機能のために、以下のリクエストおよびレスポンス形式に準拠する必要があります。 ### リクエスト形式 ConvoKraftは、設定されたWebhook URLに以下の形式でリクエストを送信します。 { "todo": "prompt || execute || fallback || button", "bot" : "", "action" : "", "button_id" : "", "environment" : "development || production" "params":{ }, "userInput" : "", "previousParam" : "", "user" : {}, "org" : {}, "broadcast" : {}, "cache" : {}, "sessionData" : {} "clientData" : {} } ### レスポンス形式 ConvoKraftは、意図した応答を理解してユーザーに伝えるために、Webhook URLからのレスポンスが以下の形式であることを期待します。ConvoKraftは、コンテンツをさまざまな形式で表示するための複数の応答タイプをサポートしています。応答を設定する際は、定義された標準に従う必要があります。応答構造の詳細については、こちらのセクションを参照してください。 **ケース1**：入力paramをユーザーにプロンプトする必要がある場合 { "status" : "prompt", "prompt" : { "param_name" : "leave_type", "options":[ { "id" : "111" ,"label" : "", "image" : "image_url"}, {"id" : "112" ,"label" :"" ,"image" : "image_url"} ], "buttons" : [] }, "message" : "You don't have enough casual leaves. Please choose some other leave type.", "data" : {} } **ケース2**：出力メッセージをユーザーに表示する必要がある場合 { "status" : "execution", "message":"Please check your screen.", "card":[], "data":{}, "broadcast":{}, "trigger":{}, "followup" : {} } Webhook URLから受信するレスポンスには、以下のようないくつかの制限があります： * レスポンスの最大サイズは100 KBです。 * リクエストタイムアウトの最大時間は5秒です。 レスポンスが上記のガイドラインに準拠していない場合、ユーザーへの応答としてエラーメッセージが送信されます。 ### Webhook呼び出しのセキュリティ保護 Webhookリクエストは、信頼できないリクエストの処理を回避するために、Webhookサーバーがリクエストの発信元がConvoKraftであることを検証できるようにセキュリティ保護できます。ConvoKraftはDigital Signature Algorithm(DSA)暗号システムを使用してセキュリティキーを生成します。これは、Webhookサーバーがリクエストを検証するために使用する必要があります。 # セキュリティ検証フロー 1. 開発プラットフォームの選択時にWebhook呼び出しのセキュリティ保護を選択すると、ConvoKraftはDSA暗号システムに基づいて秘密鍵と公開鍵を自動生成します。これらの両方のキーは暗号化されてConvoKraftのサーバーに保存され、公開鍵のみがCatalystコンソールで開発者に公開されます。 2. Webhookサーバーにリクエストを送信する際、ConvoKraftは保存された秘密鍵を使用してデジタル署名を生成し、リクエストヘッダーX-CONVOKRAFT-SIGNATUREに署名を送信します。ユーザーがチャットウィンドウにメッセージを入力すると、メッセージは秘密鍵で暗号化され、ヘッダーのデジタル署名とともにWebhookサーバーにリクエストボディとして送信されます。 3. Webhookサーバーがこのメッセージを受信すると、リクエスト内の受信したデジタル署名と暗号化された公開鍵を使用して作成されたオリジナルの署名を比較します。不一致が見つかった場合、メッセージが改ざんされたことを意味します。 ### 実装 Botを作成した後、開発プラットフォームとしてWebhooksを選択し、以下の手順に従います： 1. Business Logicコードが存在する外部サーバーのWebhook URLを入力します。Botの設定済みActionsの実行時に、このURLがアクセスされます。 2. 会話中のすべてのユーザーメッセージの後にWebhook URLを呼び出すか、会話の特定のコンテキストが終了するたびに呼び出すかを選択できます。 3. Botの作成が完了すると、ConvoKraft Botの重要な情報を一覧表示するBotの詳細ページが表示されます。 生成された公開鍵を表示するには、Botの詳細ページのShow keyボタンをクリックします。 Show keyオプションをクリックすると、Security Keyポップアップに公開鍵が表示されます。 この公開鍵は開発環境ですぐに使用されます。Catalystプロジェクトをデプロイすると、本番環境で使用されます。 ##### Deluge ファンクション -------------------------------------------------------------------------------- title: "Deluge Functionsの定義" description: "Deluge Functionsについて学び、ConvoKraft BotのBusiness Logicをコーディングするために使用する方法を説明します。" last_updated: "2026-07-02T09:34:21.925Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/bot-logic/deluge-functions/defining-deluge-functions/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Deluge Functionsの定義 Delugeは、Zohoクラウド環境のネイティブオンラインスクリプト言語です。Delugeを使用して、Business Logicを記述し、複数のZohoアプリケーション間でActionsを自動化し、サードパーティの外部サービスとの統合を有効にすることができます。また、一般的なタスクを実行するための組み込み関数のパックも含まれており、これを使用してアプリケーションロジックを迅速に構築し、アプリケーションの機能を強化できます。Delugeはユーザーフレンドリーな構文を持ち、強力なアプリケーションを素早く構築できます。 Deluge Functionsを使用して、ConvoKraft Botsのバックエンドロジックをシームレスにコーディングできます。Deluge Functionsでサポートされるデータ型の詳細については、こちらのページをご覧ください。 ConvoKraftは、BotsのBusiness Logicを定義するために、それぞれ独自の目的と呼び出しポイントを持つ以下の定義済みDeluge Functionsを提供しています。 * Execution関数 * Context Handler関数 * Button Click関数 <br> ### システム定義の入力引数 以下のシステム定義入力引数は、すべての定義済みDeluge Function型で使用できます： <table class="content-table"> <thead> <tr> <th>引数</th> <th>Delugeデータ型</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>sessionData</td> <td>Map</td> <td>現在のチャットセッションをホストしているクライアントの詳細が含まれます。この引数の詳細については、こちらを参照してください。</td> </tr> <tr> <td>cache</td> <td>Map</td> <td>Action実行サイクル全体で関数間でデータを渡すために使用される一時ストレージ変数です。この引数の詳細については、こちらを参照してください。</td> </tr> <tr> <td>broadcast</td> <td>Map</td> <td>ユーザーがBotと対話している間、異なるActions間でデータを渡すために使用されるストレージ変数です。この引数の詳細については、こちらを参照してください。</td> </tr> </tbody> </table> 上記のシステム定義引数に加えて、コンソールでActionに定義されたすべての静的paramも、各Deluge Functionの入力引数として個別に利用可能になります。ConvoKraftはすべての変数に適切な値を設定し、すべての関数の入力引数として渡します。 <br> # Deluge Functionsのコーディング ConvoKraftが提供する組み込みエディタでDeluge Functionsをコーディングできます。このセクションでは、エディタ、その使用方法と機能について詳しく説明します。 ### コードエディタの概要 ConvoKraftのDelugeエディタは、基本的な操作から複雑な操作まですべてを同じ場所で実行できる統合されたエクスペリエンスを提供します。タスクをドラッグしてエディタのスクリプト領域にドロップすることでスクリプティングが可能です。変数の設定、情報ステートメントやコメントの追加、if、else if、elseを含む条件ステートメントの追加への迅速なアクセスを提供します。 さらに、エディタを使用してメールで通知を送信したり、Zoho Cliq（Zohoが提供するコミュニケーションプラットフォーム）に通知として投稿したりすることもできます。他のZohoサービスや、Webhooksを使用して外部サーバーでホストされているアプリケーションと統合することもできます。コレクションの作成、コレクションへのデータ挿入、データの取得、更新、削除、またはコレクションの各要素の取得が可能です。Delugeエディタの詳細については、こちらのページをご覧ください。 <br> # 関数の検証 ConvoKraftは、エディタ内のDeluge Functionsの構文と戻り値の正確性を自動的に検証します。 ### 構文の検証 構文の検証は、Deluge Functionを保存しようとするたびに行われます。コンパイル時エラーにより構文の検証が失敗した場合、関数は保存されず、適切なエラーメッセージが表示されます。コンパイル時エラーには、不正な構文、句読点、変数初期化の欠落などが含まれます。 <br> ### 戻り値の検証 構文の検証に加えて、ConvoKraftコードエディタでのすべての関数実行に対して、Deluge Functionsの戻り値も検証されます。Deluge Functionsの定義済み戻り値形式の詳細については、こちらのページをご覧ください。 戻り値の検証は、コンソール内のBotのチャットウィンドウを使用してActionをテストする際に実行されます。Test this botをクリックして対話を開始します。ConvoKraftは、message、card、broadcast、followupなどのレスポンス内のキーのデータ型を検証します。 Actionの適切な機能のために、Deluge Functionsの戻りマップ内のすべての値を必ず満たすようにしてください。関数の戻り値が指定された形式に違反している場合、エラーを引き起こしたJSON要素を含むエラーメッセージがLogsウィンドウに表示されます。 <br> ### 関数ログ すべてのログには、以下のラベルの少なくとも1つが含まれます： * **INFO**：デバッグ情報を表示し、コード内で指定されたものを出力します。 * **WARNING**：何かが間違っているまたは異常と検出された場合に警告テキストを表示します。たとえば、コード内での非推奨構文の使用などです。警告はAction実行中に無視されます。 * **ERROR**：コードの実行中に発生するエラーを表示します。たとえば、構文の不一致や未処理の例外などです。エラーはAction実行を中断し、適切なメッセージが応答としてスローされます。 エディタ内でさまざまなログレベルを切り替えて、それぞれのログのみを表示できます。 注意: Actionのフロー内のすべての関数で発生したエラーが、実行中の関数のエラーとともにここに表示されます。 -------------------------------------------------------------------------------- title: "Deluge オブジェクトリファレンス" description: "Delugeファンクションについて学び、ConvoKraft Botのビジネスロジックをコーディングするために使用します。" last_updated: "2026-07-02T09:34:21.925Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/bot-logic/deluge-functions/deluge-object-reference/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Deluge Object Reference Deluge Object Referenceドキュメントは、ConvoKraftにおけるDelugeファンクションのさまざまな要素について詳細に説明することを目的としています。ConvoKraftがサポートするコアオブジェクトには、データアクセスオブジェクト、入力オブジェクト、およびレスポンスオブジェクトが含まれます。このセクションでは、それぞれについて詳しく説明します。 # データアクセスオブジェクト ### sessionData クライアントの現在のチャットセッションに関する詳細です。このデータは、sessionData引数の下ですべてのファンクションで利用可能です。 <table class="content-table"> <thead> <tr> <th>Delugeデータ型</th> <th>利用可能範囲</th> </tr> </thead> <tbody> <tr> <td>Map</td> <td>すべてのファンクション</td> </tr> </tbody> </table> この引数は以下のキーで構成されます: <table class="content-table"> <thead> <tr> <th>キー名</th> <th>Delugeデータ型</th> <th>説明</th> <th>サンプル値</th> </tr> </thead> <tbody> <tr> <td>medium</td> <td>Text</td> <td>ユーザーがBotと対話する通信モードです。取りうる値はcallまたはchatです。</td> <td>chat</td> </tr> <tr> <td>client_host</td> <td>Text</td> <td>Botをホストするクライアントアプリケーションの種類です。取りうる値はmobileまたはwebです。</td> <td>web</td> </tr> <tr> <td>client_identifier</td> <td>Text</td> <td>クライアントの一意の識別子です。 <br> client_identifierがwebの場合、Webアプリケーションの URLです。 <br> client_identifierがmobileの場合、モバイルアプリケーションのパッケージ名バンドル識別子です。 </td> <td>https://zylker.com</td> </tr> <tr> <td>client_data</td> <td>Map</td> <td>セッション開始時にクライアントからConvoKraftに渡されるデータです。</td> <td>{ "user_email": "todd@hmail.com" }</td> </tr> </tbody> </table> ### cache cacheオブジェクトは、一時的なストレージ変数として機能します。このオブジェクトにキーと値のペア形式で保存されたデータは、現在実行中のActionのすべてのファンクションで、そのActionの実行が完了するまでアクセス可能です。 <table class="content-table"> <thead> <tr> <th>Delugeデータ型</th> <th>利用可能範囲</th> </tr> </thead> <tbody> <tr> <td>Map</td> <td>すべてのファンクション</td> </tr> </tbody> </table> ### broadcast Botに現在実行中のActionに関連する情報を記憶させたい場合、その情報をbroadcastオブジェクトに保存できます。この値は現在のActionの実行後も保持され、現在のチャットセッションが終了するまで、以降のすべてのActionで利用可能です。後続のActionは、ビジネスロジックの必要に応じてこの値を使用できます。 <table class="content-table"> <thead> <tr> <th>Delugeデータ型</th> <th>利用可能範囲</th> </tr> </thead> <tbody> <tr> <td>Map</td> <td>すべてのファンクション</td> </tr> </tbody> </table> #### messageData messageDataオブジェクトには、各トランスクリプト（Botの会話内のメッセージ）リクエストに対してクライアントがdataキーで送信したカスタムメッセージが含まれます。 <table class="content-table"> <thead> <tr> <th>Delugeデータ型</th> <th>利用可能範囲</th> </tr> </thead> <tbody> <tr> <td>Map</td> <td>すべてのファンクション</td> </tr> </tbody> </table> # 入力オブジェクト ### param ユーザーが各静的paramに対して提供した入力値は、Delugeファンクション全体で同じparam名のオブジェクトの下にキャプチャされます。 <table class="content-table"> <thead> <tr> <th>Delugeデータ型</th> <th>利用可能範囲</th> </tr> </thead> <tbody> <tr> <td>対応するparamのデータ型</td> <td>Context handlerファンクションおよびAction executionファンクション</td> </tr> </tbody> </table> ### previousParam previousParamオブジェクトには、ユーザーに最後にプロンプトされたparamが含まれます。ユーザーの最新の返答がこのparamの値として設定されます。 <table class="content-table"> <thead> <tr> <th>Delugeデータ型</th> <th>利用可能範囲</th> </tr> </thead> <tbody> <tr> <td>対応するparamのデータ型</td> <td>Context Handlerファンクションのみ</td> </tr> </tbody> </table> # レスポンスオブジェクト ### card cardは、ユーザーへの返答として視覚的にフォーマットされたメッセージを提供するために使用できます。cardは、テーブルや画像などの視覚要素のコレクションです。このキーの値は、mapオブジェクトのリストです。各mapオブジェクトは、card内のUI要素を表します。1つのcardには、同じ種類の複数の要素を含めることができます。card内のすべての要素は、返信メッセージ内で上から順に表示されます。 Bold、Italic、Underline、Strikethrough、Link、およびHighlightなどのインラインフォーマットオプションは、card要素にも適用できます。したがって、上記のフォーマットオプションのいずれかを、以下のcardのテキスト値で使用できます。 ConvoKraftの返信メッセージcardでは、以下のUI要素がサポートされています: <table class="content-table"> <thead> <tr> <th class="w90p">要素</th> <th class="w70p">フォーマット</th> </tr> </thead> <tbody> <tr> <td>Note</td> <td> { "type" : "note", "content" : "&lt;Text content that needs to be displayed as a note.&gt;" } </td> </tr> <tr> <td>Title</td> <td> { "type" : "title", "content" : "&lt;Text content that needs to be displayed as the title&gt;" }</td> </tr> <tr> <td>List - Bullet & Numbered</td> <td> { "type" : "list", "format" : "bullet" or "numbered" "elements" : [ { "label" : "&lt;element_label&gt;" "preview" : { "header" : { "title" : "&lt;title_content&gt;" "description" : "&lt;description_content&gt;", "subheading" : "&lt;subheading_content&gt;", "image" : { "url" :"&lt;image_url&gt;" } }, "fields" :[ { "label" : "&lt;field labels&gt;" "value" : "&lt;field values&gt;" } //add other fields as necessary ] } } //add other elements as necessary ] } 注意: list cardでは、previewオブジェクトに最大7つのフィールドを設定できます。 </td> </tr> <tr> <td>Table</td> <td> { "type": "table", "heading" : "&lt;Table Heading&gt;", "columns": [ "&lt;column1 header&gt;". "&lt;column2 header&gt;" "&lt;column3 header&gt;" ], "rows": [ [ "&lt;value al&gt;" "&lt;value a2&gt;" "&lt;value a3&gt;" ], [ "&lt;value b1&gt;" "&lt;value b2&gt;" "&lt;value b3&gt;" ] ] } </td> </tr> <td>Image</td> <td> { "type" : "image", "content" : "&lt;image url&gt;" } </td> </tr> <tr> <td>File</td> <td> { "type" : "file", "name" : "&lt;file_name&gt;", "format" : "pdf", //file extension "content": "&lt;file url&gt;" } </td> </tr> <tr> <td>Contact card</td> <td> { "type" : "vcard", "info" : { "image" : "<image url>", "fields" : [ { "First Name" : "Smith" }. { "Last Name" : "Gibbs" }, { "Company": "ABC Corp" }, { "Website" : "https://" } ] } } </td> </tr> <tr> <td>Link</td> <td> { "type" : "label", "content" : "&lt;URL link&gt;" } </td> </tr> <tr> <td>Button</td> <td> { "type" : "button", "label" : "&lt;button label&gt;". "theme" : "&lt;button theme&gt;" "id" : "&lt;button id&gt;", "onclick" : { "execute" : "function (or)clienthook", "function":"&lt;button click function name&gt;", "data" : {} } } 1. themeキーの値は、positive、negative、またはneutralのいずれかを指定できます。 2. executeキーの値は、以下のいずれかを指定できます: * function - 定義されたButton Clickファンクションを実行します。 * clienthook - クライアントアプリケーションが実装したhookを実行します。 clienthookがexecuteキーの値として設定されている場合、functionキーは不要です。 4. dataキーには、Button Clickファンクションに渡す必要のある値を設定します。 注意: button cardを使用して、1つのActionに最大3つのボタンを設定できます。 </td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "実行ファンクション" description: "Deluge Functionsについて学び、ConvoKraft BotのBusiness Logicをコーディングするために使用する方法を説明します。" last_updated: "2026-07-02T09:34:21.925Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/bot-logic/deluge-functions/execution-function/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Execution Function # はじめに Execution関数は、Action実行のエンドポイントです。Actionの実行完了を定義します。Actionの実際の実行を処理し、Action完了後にユーザーに最終的な成功または失敗メッセージを返します。ユーザーへの応答は、テキストまたはカードのコレクションなどの視覚要素のいずれかです。 ### 呼び出しポイント Execution関数は、Actionのエンドポイントで呼び出されます。デフォルトでは、Actionのエンドポイントは、すべてのparam値がプロンプトされ、適切な値で入力された後に来ます。または、Context Handler関数 ("todo" : "execute")からエンドポイントをトリガーすることもできます。Execution関数が呼び出された後、Actionは完了し、ユーザーからのさらなる会話は新しいActionとして扱われます。 # 入力引数 システム定義入力引数は、Execution関数の入力引数としてのみ利用可能です。 ### 戻り値 Execution関数は、以下の形式のマップを返します： { "message" : "The reply message.", "card" : { }, "broadcast" : { }, "followup" : { } } Execution関数が返すマップに含まれるキーについて以下で説明します： ### message ユーザーへの返信としてテキストメッセージを提供します。このキーは必須です。ConvoKraftでは以下のテキストフォーマットオプションがサポートされています。これらのオプションのいずれかをテキストメッセージで使用できます。 <table class="content-table"> <thead> <tr> <th>フォーマットオプション</th> <th>構文</th> </tr> </thead> <tbody> <tr> <td>Bold</td> <td>*text*</td> </tr> <tr> <td>Italic</td> <td>_text_</td> </tr> <tr> <td>Underline</td> <td>__text__</td> </tr> <tr> <td>Strikethrough</td> <td>~text~</td> </tr> <tr> <td>Link</td> <td>[label](URL_link)</td> </tr> <tr> <td>Highlight</td> <td>`text`</td> </tr> <tr> <td>Heading</td> <td>h1 - #Heading h2 - ##Heading h3 - ###Heading h4 - ####Heading h5 - #####Heading</td> </tr> <tr> <td>Bullet list</td> <td>* first_item \n * second_item \n * third_item</td> </tr> <tr> <td>Numbered list</td> <td>1. first_item \n 2. second_item \n 3. third_item</td> </tr> <tr> <td>Image</td> <td>![alternate_text](image_URL)</td> </tr> <tr> <td>Blockquote</td> <td>!text</td> </tr> <tr> <td>Table</td> <td>| header1 | header2 | header3 | \n |------------|------------|------------| \n | value1 | value2 | value3 | \n | value1 | value2 | value3 |</td> </tr> </tbody> </table> 以下は、message引数のサンプル値です： message : "Your event has been created successfully" ### card ユーザーへの返信として視覚的にフォーマットされたメッセージを提供します。cardは、テーブル、画像などの視覚要素のコレクションです。このキーの値はマップオブジェクトのリストです。各マップオブジェクトは、カード内のUI要素を表します。1つのカードには同じ型の複数の要素を含めることができます。カード内のすべての要素は返信メッセージで上から下に順に表示されます。このキーは任意です。 ConvoKraftの返信メッセージcardでサポートされるUI要素のリストの詳細については、こちらのページを参照してください。 以下は、card引数のサンプル値です： "card" : { "type" : "note", "content" : "Your event details are displayed below" { "type" : "image", "image" : "event_details.png" } //マップオブジェクトを追加する } ### broadcast 現在のActionの実行後にBotが記憶する必要があるデータを渡します。値はマップ形式で、セッション全体のすべての連続するActionsで利用可能になります。このキーは任意です。broadcastの詳細については、こちらのページをご覧ください。 以下は、broadcast引数のサンプル値です。 "broadcast" : { "user_level" : "admin", "status" : "booked" } ### followup 現在のAction実行の完了後に、Botが提案リストを表示するか、特定のActionをフォローアップとして呼び出すようユーザーにプロンプトするかを設定できます。このキーは任意です。Action Followupsとこのキーの値の構造の詳細については、こちらのページをご覧ください。 以下は、card引数のサンプル値です： "followup":{ "suggestions":[ { "message":"Would you like to set a reminder for this event", "action":{ "name":"schedule remainder", "params":[ { "name":"event time", "value":"11:00 am" } //必要に応じて他のパラメータを追加する ] } } ### 実装 ConvoKraft BotのActionを作成し、Business Logicに基づいて応答を設定することを選択したら、Sample Sentencesとそれぞれのparamを定義する必要があります。Execution関数を実装するには、以下の手順に従ってください： 1. Actionに必要なSample Sentencesとparamを設定して保存した後、Actionの詳細ページが表示されます。Functionsタブに切り替え、Execution functionセクションのEdit Functionをクリックします。 2. ConvoKraft Delugeエディタが開き、Business Logicをコーディングしてスクリプトを保存できます。Delugeエディタの詳細については、こちらのページをご覧ください。Test this bot機能を使用して、変更を並行してテストできます。 -------------------------------------------------------------------------------- title: "コンテキストハンドラファンクション" description: "Deluge Functionsについて学び、ConvoKraft BotのBusiness Logicをコーディングするために使用する方法を説明します。" last_updated: "2026-07-02T09:34:21.926Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/bot-logic/deluge-functions/context-handler-function/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Context Handler関数 # はじめに Context Handler関数は、Actionの会話フローを制御するために使用されます。実行時にparamがユーザーにプロンプトされる順序を変更できます。一部のparamをスキップしたり、param値のカスタムバリデーションを行ったり、実行時にAction実行前に確認を求めたりすることもできます。 Context Handler関数は、静的paramが定義されている順序をオーバーライドできます。Context Handler関数が有効な場合、BotはCatalystコンソールでparamを定義した際に宣言した順序ではなく、Context Handler関数で指定された順序でパラメータをプロンプトします。 注意: Context Handler関数は、ConvoKraft Botの開発プラットフォームとしてDelugeを選択した場合にのみ使用できます。 ### 呼び出しポイント ConvoKraftがユーザー入力のActionを検出すると、ユーザー入力に含まれる可能なparam値が検出され、Botは最初の未入力paramをユーザーにプロンプトします。ユーザーがparamプロンプトに返信すると、ConvoKraftはContext Handler関数を呼び出します。Context Handler関数は、会話中にプロンプトされるすべてのparamに対して呼び出されます。Actionにparamがない場合、Context Handler関数はExecution関数の前に1回実行されます。 ### 入力引数 システム定義入力引数に加えて、Context Handler関数では以下の入力引数も利用可能です： <table class="content-table"> <thead> <tr> <th>引数</th> <th>Delugeデータ型</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>userInput</td> <td>String</td> <td>ユーザーからの最新の返信</td> </tr> <tr> <td>previousParam</td> <td>Map</td> <td>ユーザーに最後にプロンプトされたparam。ユーザーの最新の返信がこのparamの値です。</td> </tr> </tbody> </table> ### 戻り値 Context Handler関数は、以下の形式のマップを返します： { "todo":"prompt", "prompt":{ "param_name":"&lt;name of the param to be prompted&gt;", "prompt_msg":"&lt;the text to be displayed as a prompt message&gt;", "validation_failure_message":"&lt;the text to be displayed if the user submits invalid input&gt;", "options":[ ], "buttons":[ ], "fields":[ ], }, "confirm":{ "message":"Are you sure you want to cancel?" }, "assign":{ "clientData":{ "&lt;key1&gt;":"&lt;value1&gt;", "&lt;key2&gt;":"&lt;value2&gt;" //必要に応じてクライアントデータを追加する } } } 上記のように、Context Handler関数から返されるマップには以下のキーが含まれます： ### todo このキーは、Context Handler関数の実行後にConvoKraft Botが何をすべきかを示すために使用されます。以下の値のいずれかのみを取ることができます。このキーは必須です。 * **prompt**：ユーザーにparamをプロンプトするようBotに指示します。 * **confirm**：ActionのExecution関数を呼び出すための最終確認を求めるようBotに指示します。 * **execute**：Execution関数を呼び出すようConvoKraftに指示します。 ### prompt このキーには、ユーザーにプロンプトするparamを指定するマップが含まれ、todoがpromptに設定されている場合にのみ使用されます。 todoがpromptに設定されていてもこのキーが提供されない場合、Botはコンソールで定義されたparamの順序に従って次のparamをプロンプトします。したがって、param定義のデフォルト順序を使用する場合、このキーはスキップできます。このキーのマップ値には以下の属性が含まれます： 1. **param_name**：プロンプトするparamの名前。param名は、コンソールで定義された既存のparamのいずれかである必要があります。 2. **prompt_msg**：Catalystコンソールでparam作成時に定義されたparamのプロンプトメッセージをオーバーライドするために使用できます。 **validation_failure_message** - プロンプトされたparamに対してユーザーが入力した値が無効な場合に表示されるカスタムメッセージ。このキーは任意です。 3. **options**：ユーザーが選択できるSingle selection listおよびMultiple selection list paramのオプションリスト。 * **id**：オプションの一意のID。 * **label**：オプションのラベルとして表示されるテキスト。 * **preview**：Single selection listおよびMultiple selection list paramのオプションに表示される追加情報。オプションプレビューは、Single selection listおよびMultiple selection list paramの入力モードがVisualの場合にのみ利用可能です。previewキーは任意です。 * **header**：headerは、Single selection listおよびMultiple selection list paramオプションのプロパティをリストします。headerオブジェクトには、以下の形式で以下の属性を含める必要があります： { "id":"&lt;the unique id for the option&gt;", "label":"&lt;the text to be displayed as the options label&gt;", "preview":{ "header":{ "title":"&lt;the text to be displayed as the option previews title&gt;", "description":"&lt;the text to be displayed as the option previews description&gt;", "subheading":"&lt;the text to be displayed as the subheading to the options preview&gt;", "image":{ "url":"&lt;the url of the preview image&gt;" } } } } headerオブジェクトにオプションの適切な属性が設定されている場合、ユーザーが各オプションの情報アイコンをクリックするとプレビューが表示されます。 情報アイコンをクリックすると、設定された画像、名前、URLが表示されます。 * **fields**：fieldsオブジェクトは、オプションに関する追加プロパティをリストします。fieldsオブジェクトには、以下の形式で以下の属性を含める必要があります。これは、プレビューが設定されている場合にのみ必須です。 [ { "label":"&lt;the text to be displayed as the field name&gt;", "value":"&lt;the text to be displayed as the field value&gt;" } ] 注意: オプションには最大7つのfieldsを設定できます。 previewキーのキー要素は、headerとfieldsです。fieldsオブジェクトがpreviewキーとともに設定されている場合、ユーザーがそれぞれのオプションにホバーすると適切なプレビューが表示され、この場合は情報アイコンは表示されません。 4. **buttons**：ボタンは、Single selection listおよびMultiple selection list paramで定義されたオプションに対して実行される操作を設定するために使用されます。buttonsキーには、以下の形式で以下の属性を含める必要があります。 [ { "id":"the unique id for the button", "label":"the text to be displayed as the button's label", "theme":"&lt;positive | neutral | negative&gt;" } ] 注意: Single selection listおよびMultiple selection list paramには最大3つのボタンを設定できます。 ### confirm Action実行の確認メッセージを指定するマップが含まれ、ユーザーにプロンプトされます。todoがconfirmに設定されている場合にのみ必須です。マップ値には以下のキーのみ含めることができます： * **message**：ユーザーにプロンプトする確認メッセージ。 ### assign assignキーの値はMap型です。実行時にすべての静的paramとシステム定義引数の値を変更するために使用できます。 * **clientData**：実行時にセッションデータに基づいてクライアントデータの値を更新するために使用されます。 ### 実装 ConvoKraft BotのActionを作成し、Business Logicに基づいて応答を設定することを選択したら、Sample Sentencesとそれぞれのparamを定義する必要があります。Context Handler関数を実装するには、以下の手順に従ってください： 1. Actionに必要なSample Sentencesとparamを設定して保存した後、Actionの詳細ページが表示されます。Functionsタブに切り替え、Context Handler functionを有効にします。 2. 以下のメッセージが表示されます。OKをクリックして続行します。 3. ConvoKraft Delugeエディタが開き、Business Logicをコーディングしてスクリプトを保存できます。Delugeエディタの詳細については、こちらのページをご覧ください。Test this bot機能を使用して、変更を並行してテストできます。 -------------------------------------------------------------------------------- title: "ボタンクリックファンクション" description: "Deluge Functionsについて学び、ConvoKraft BotのBusiness Logicをコーディングするために使用する方法を説明します。" last_updated: "2026-07-02T09:34:21.926Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/bot-logic/deluge-functions/button-click-function/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Button Click Functions # はじめに ConvoKraftでは、デフォルトのSubmitボタンとともに、ユーザーとの対話中の応答にカスタムボタンを設定できます。ActionにSingle/Multi selection listのparamを定義する場合、選択されたオプションを入力としてさらにカスタム操作を実行する必要がある場合は、Button Click関数でロジックをコーディングできます。 これらのボタンは、Execution関数でbuttonカードを定義することで作成できます。 注意: 1. Button Click Functionは、ConvoKraft Botの開発プラットフォームとしてDelugeを選択した場合にのみ使用できます。 2. Actionには最大3つのButton Click Functionを設定できます。 ### 呼び出しポイント Execution Handler応答に設定されたカスタムボタンがクリックされると、そのボタンに設定された対応するButton Click関数が呼び出されます。 ### 入力引数 システム定義入力引数に加えて、Button Click Functionでは以下の入力引数も利用可能です： <table class="content-table"> <thead> <tr> <th>引数</th> <th>Delugeデータ型</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>data</td> <td>Map</td> <td>Execution関数のbuttonカードのdataキーに設定された値 </td> </tr> </tbody> </table> ### 戻り値 Button Click関数は、以下の形式のマップを返します： { "message" : "The reply message.", "card" : { }, "broadcast" : { }, "followup" : { } } Button Click Functionが返すキーの詳細については、こちらのページを参照してください。 ### 実装 ConvoKraft BotのActionを作成し、Business Logicに基づいて応答を設定することを選択したら、Sample Sentencesとそれぞれのparamを定義する必要があります。Button Click関数を実装するには、以下の手順に従ってください： 1. Actionを作成する際、必要なSample Sentencesとparamを設定する必要があります。New paramをクリックし、Single/Multi selection listを選択します。 2. paramダイアログボックスのSubmission Buttonsで、Add Buttonをクリックして新しいカスタムボタンを作成します。 3. ボタンの意味のあるアクション名をLabelとして入力し、このカスタムボタンのExecution関数で参照する名前をIdとして定義します。 4. Sample Sentencesとparamへの変更を保存すると、Functionsタブが表示されます。Button Click Functionsの下に、作成したカスタムボタンが表示されます。Edit Functionをクリックして、ボタン呼び出しのBusiness Logicをコーディングします。Add Functionをクリックして新しい関数を作成することもできます。 5. ConvoKraft Delugeエディタでロジックの記述を開始し、完了したらスクリプトを保存します。エディタでは関数間の切り替えもすぐに行えます。Test this BotボタンをクリックしてBotと対話し、変更内容を検証します。 ConvoKraftエディタの要素と使用方法の詳細については、こちらのページを参照してください。 #### 概要 -------------------------------------------------------------------------------- title: "はじめに" description: "クエリへの直接応答やデータ取得・タスク実行のためのBusiness Logicの実行など、Botに設定できるCatalyst ConvoKraft Actionsについて説明します。" last_updated: "2026-07-02T09:34:21.941Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/overview/introduction/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Actions - はじめに ### 概要 Actionは、会話の一部として指示を出した際にBotが実行する単一の能力またはタスクです。たとえば、Botにその日の予定を取得するよう依頼したり、カレンダーに会議をスケジュールするよう依頼したりできます。 Actionを完了するために、BotはそのActionを実行するために必要ないくつかの質問を投げかけることがあります。たとえば、一般的な会議スケジュールActionの会話は以下のようになります： ユーザー : 明日の午前11時までにZylkerの案件について話し合う会議をスケジュールして。 <br> ConvoKraft Bot : かしこまりました。会議はいつ終了しますか？ <br> ユーザー : 午後12時までです。 <br> ConvoKraft Bot : 会議はどこで行いますか？ <br> ユーザー : 本社です。 <br> ConvoKraft Bot : わかりました。会議をカレンダーに追加しました。 したがって、Actionは必ずしもユーザーとBot間の単一のメッセージ交換ではありません。単一のタスクを達成するために、ユーザーとBot間で複数のメッセージが交換される場合があります。上記の例では、Botは設定されたBusiness Logicを実行して会議をスケジュールします。 <br> ### Actionsの種類 意図に基づいて、Actionsは2つの種類に分類できます： #### 質問への直接回答 これらのActionsは、操作の実行やBusiness Logicの実行なしに、静的な質問に対してDirect answerを提供します。通常、単一の会話交換で完了し、ユーザー、タイムゾーン、地域、またはその他のパラメータに関係なく回答が同じになるような普遍的なものです。 **質問の例：ConvoKraftとは何ですか？** この質問に対する応答は簡潔で、特定のBusiness Logicを伴わず、質問するすべてのユーザーに対して同じになります。 関連するSample Sentencesと特定の質問に対する回答を定義することで、これらのActionsを設定できます。ユーザーがConvoKraft Botと対話すると、Botはこれらの設定済みActionsを検索し、ユーザーのクエリと一致する場合、設定されたDirect answerで応答します。 #### Business Logicの実行 これらのActionsは、指定されたデータソースから関連データを取得して、ユーザー入力に対する回答を動的に構築するようBotに指示します。これには、Actionに固有のBusiness Logicの実行が含まれ、回答はデータと実行されたロジックに基づいて異なる場合があります。Business Logicの実行には、特定のデータソースでデータの取得、追加、変更、または削除を行う指定された操作の実行が含まれます。Business Logicの複雑さに応じて、より多くの入力を収集するために会話が複数のメッセージに拡張される場合もあります。 ConvoKraft Botの適用可能なSample Sentencesと関連するparamを定義することで、これらのActionsを設定できます。 **質問の例：** 1. **「今日のスケジュールは何ですか？」** この質問に答えるために、Botはカレンダーからデータを取得し、取得されたデータに応じて回答を構築します。 2. **「会議をスケジュールして」** 会議をスケジュールするために、Botはユーザーから関連する入力データを求めて取得し、カレンダーにイベントを作成します。 ### Action実行フロー 1. Botがユーザー入力を受信するたびに、ConvoKraftはそのユーザー入力の意図を検出するために内容を理解しようとします。Botをトレーニングすると、設定されたActionsがConvoKraftによって使用され、新しいNLPモデルを形成し、既存のモデルを強化して、すべてのActionの意図を理解するBotの知的能力を向上させます。 2. Botは、Actionに定義された設定済みSample Sentencesを検索します。ユーザー入力の意図が設定済みActionsのいずれかの意図と一致する場合、BotはBusiness Logicを通じてそのActionを実行するために必要なparamの値を関連付けるためにユーザーに追加情報を求めるか、会話形式でDirect answerを提供します。 3. Botのいずれかのactionsと一致しないタスクの実行をユーザーが要求した場合、Fallback message handler関数で設定されたロジックに基づいて応答します。 4. 設定されたBusiness Logicに基づいて、ConvoKraftは特定のActionに関連付けられたWebhook URL、Deluge Function、またはCatalyst Integration Functionを呼び出し、ロジックを実行します。 5. 最後に、Actionへの応答がConvoKraft Botで会話形式でユーザーへの返信として送信されます。 -------------------------------------------------------------------------------- title: "Actionモデル" description: "クエリへの直接応答やデータ取得・タスク実行のためのBusiness Logicの実行など、Botに設定できるCatalyst ConvoKraft Actionsについて説明します。" last_updated: "2026-07-02T09:34:21.941Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/actions/overview/models/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Actionモデル ConvoKraft Botは、ユーザーとの会話中にActionsを実行するように設定できます。BotのActionは、Sample Sentences、param、およびBot Logicによって特徴付けられます。Direct answerで応答するように設定されたActionsは、関連するSample Sentencesで定義されます。一方、Bot Logicを実行するActionsは、特定の操作を実行するためにユーザー入力が必要な場合があり、Sample Sentencesとともにparamを設定する必要があります。 ### Sample Sentences Sample Sentencesは、エンドユーザーが特定のActionを会話形式で呼び出す際に使用する例文です。これらのSample Sentencesは、ユーザー入力をより適切に理解するためのConvoKraftのインテリジェンスの強化に役立ちます。 以下は、イベントを作成するために設定できる一般的なSample Sentencesの例です： * **「イベントを作成して」** * **「会議をスケジュールして」** 実際には、ユーザーは呼び出し指示の一部としてデータを話すため、Sample Sentencesには特定のparam値が含まれる場合もあります。以下の例のように、ユーザーはイベントをスケジュールしようとする際に、最初の呼び出し文の一部としてイベントタイトル、開始時間、終了時間を言及する場合があります。 * **「午後5時から午後6時まで、Zylkerの案件について話し合うイベントを作成して」** * **「午後5時にJohnとの会議をスケジュールして」** 呼び出し文に必要なすべてのparamが含まれていない場合、Botはユーザーにそれらの必須param値の入力を求めます。 Sample Sentencesは特定のActionの意図を定義し、paramはそのActionを実行するために必要なエンティティを定義します。したがって、ConvoKraft Actionのデータモデルは、Sample Sentencesとparamの組み合わせによって実現されます。 Sample Sentencesの詳細とAction設定における重要性については、こちらのページを参照してください。 ### Params Paramは、Actionを実行するために必要な入力データです。たとえば、カレンダーにイベントを作成するように設定されたActionのparamは、通常、イベントタイトル、開始時間、終了時間、イベント会場などになります。 paramとその種類の詳細については、こちらを参照してください。 ### Bot Logic Actionの会話フローと実行は、そのために定義されたBusiness Logic（またはBot Logic）に依存します。ConvoKraftは、ActionのBot Logicを定義するために以下の開発プラットフォームをサポートしています： * Catalyst Functions * Deluge Functions * Webhooks Actionのすべての宣言されたparamは、Actionを実行するためにBusiness Logicに渡されます。宣言されたparamに加えて、Business Logicの実行に必要なその他の環境データ（ユーザーやクライアントアプリケーションに関する詳細など）も、これらの関数への入力引数として渡されます。 1. **Catalyst Functions** Catalyst Functionsは、Catalystアプリケーションの高度なBusiness Logicを含むカスタムビルドのコーディング構造です。Catalyst Integration Functionsを使用すると、Catalyst関数をコーディングして、他のCatalystまたはZohoサービスのバックエンドとして使用し、それらとの統合を確立できます。ConvoKraftでActionを呼び出すと、HTTP呼び出しを通じて設定されたIntegration Functionが自動的に呼び出されます。 Catalyst Functionsを使用する場合、Business Logicは以下のプログラミング環境で定義できます： * **Java** * **Node.js** * **Python** コンソールのServerlessサービスに移動してCatalyst Functionを作成するか、Catalyst CLIを使用してローカル環境から関数を作成・コーディングすることもできます。 Catalyst Functionsは高いスケーラビリティと効率性を備えています。関数がホストされるサーバーインフラストラクチャはCatalystによって完全に管理されるため、バックエンドを管理する必要がなく、Business Logicの開発にのみ集中できます。アプリケーションに強力なバックエンドを提供することに加えて、Catalyst Functionsは堅牢で信頼性が高く、ConvoKraftとのシームレスな統合を提供します。 Catalyst Functionsを使用してConvoKraft ActionsのBusiness Logicを定義する方法の詳細については、こちらを参照してください。 2. **Deluge Functions** Delugeは、Zohoクラウド環境のネイティブオンラインスクリプト言語です。ユーザーフレンドリーな構文を持ち、2つのZohoサービス間、またはサードパーティサービスとのシームレスな統合を可能にします。 ConvoKraft ActionsのBusiness Logicは、以下の定義済み関数テンプレートを通じてDelugeで記述する必要があります： * Execution（必須）：ConvoKraft Botのすべてのactionsの実行に関わるコア関数です。 * Context Handler（任意）：Action中のすべてのユーザー入力に対して呼び出される関数です。会話フローにおけるparamの順序変更、必要に応じたスキップ、カスタムバリデーションの実行に使用できます。 * Button Click（任意）：ボタンカードのBusiness Logicを定義する際に使用できる関数です。カスタムボタンの実装に焦点を当てたExecution関数タイプの一部です。 これらの関数はZohoクラウドでホストされ、Action実行中のそれぞれの呼び出しポイントで実行されます。Catalyst Functionsと同様に、Deluge Functionsも高い効率性を備え、ホスティングとメンテナンスはZohoによって完全に管理されます。Deluge Functionsを使用してConvoKraft ActionsのBusiness Logicを定義する方法の詳細については、こちらをご覧ください。 3. **Webhooks** Webhooksの場合、外部プラットフォームでバックエンドロジックをコーディングし、ConvoKraft内で設定されたWebhooksを通じて呼び出すことができます。ActionsのBusiness Logicは、ConvoKraftからアクセス可能な公開ホストサーバーで外部的にビルド、管理、ホストする必要があります。構築するBotsからロジックにアクセスするためにREST APIを使用する必要があります。設定されたWebhook URLは、Action実行中の適切な呼び出しポイントでConvoKraftによって呼び出されます。 Webhooksを使用する場合、Business Logicは任意の便利なプログラミング言語で定義できます。ただし、DelugeおよびCatalyst Functionsとは異なり、Webhooksを使用する場合は、インフラストラクチャのセットアップと設定を完全に自分で管理する必要があります。Webhooksを使用してConvoKraft ActionsのBusiness Logicを定義する方法の詳細については、こちらのページをご覧ください。 ### ハンドラ -------------------------------------------------------------------------------- title: "ウェルカムメッセージハンドラ" description: "ConvoKraft botの挨拶応答を設定できるWelcome message handlerについて説明します。" last_updated: "2026-07-02T09:34:21.941Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/handlers/welcome-message-handler/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Welcome Message Handler # はじめに ユーザーが新しいチャットセッションでConvoKraft botを開くと、botはウェルカムメッセージで応答します。このデフォルトの応答メッセージをカスタマイズして独自の返信を行いたい場合は、Welcome Message handler関数で設定できます。Welcome message handler関数は、Execution関数のreturnマップと同様の構造を持つマップを返します。 注意: ConvoKraft botの開発プラットフォームとしてCatalyst functionsまたはWebhooksを選択している場合、コンソールからhandlerを有効にし、handler関数のロジックをIntegration Functionまたは設定されたwebhook URLに関連付けられたコードベースでそれぞれ定義できます。 Delugeでのhandler関数の定義の詳細については、こちらのページを参照してください。 開発プラットフォームとしてFunctionsを選択した場合、Java、Node.js、Pythonスタックの以下のサンプルコードを使用できます： ### Java import org.json.JSONObject; import java.io.*; import java.util.logging.Logger; public class WelcomeHandler { Logger LOGGER = Logger.getLogger(WelcomeHandler.class.getName()); public JSONObject handleWelcomeRequest(JSONObject reqBody) throws Exception{ LOGGER.info("Welcome Handler: : TODO : "+ reqBody.get("todo")); JSONObject welcomeResponse = new JSONObject(); welcomeResponse.put("message", "Welcome to your Bot. Please ask your queries"); JSONObject jsonResponse = new JSONObject(); jsonResponse.put("welcome_response", welcomeResponse); return jsonResponse; } } ### Node.js import logger from "./logger.js"; // ウェルカム機能を処理する export default function handleWelcome() { logger.info('Handling welcome request'); return { "welcome_response": { "message": "Welcome to your Bot. Please ask your queries" } }; } ### Python import logging def handle_welcome_request(): # これはウェルカムメッセージハンドラーです。 # ボットがユーザーに挨拶するためのデフォルトのウェルカムメッセージを記述してください。 # ウェルカムメッセージを返す方法は次のとおりです： # { # 'welcome_response': { # 'message': 'ボットへようこそ。お気軽にお問い合わせください' # } # } # 以下に同じ設定のサンプルコードがあります。 logging.info('Handling welcome request') return { 'welcome_response': { 'message': 'Welcome to your Bot. Please ask your queries' } } -------------------------------------------------------------------------------- title: "フォールバックハンドラ" description: "ConvoKraftがユーザーメッセージを理解できないシナリオに対してbot応答を設定できるfallback handlerについて説明します。" last_updated: "2026-07-02T09:34:21.941Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/handlers/fallback-handler/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Fallback Handler # はじめに botが理解できない入力メッセージを受信した場合、botはfallback handler関数で設定されたメッセージで応答します。デフォルトの応答メッセージをカスタマイズして独自の返信を行いたい場合は、botの特定のニーズに基づいてfallback handler関数を設定できます。 Execution関数のシステム定義の入力引数に加えて、Fallback Handler関数には、現在のチャットセッションにおけるユーザーからの最新の応答を格納するString型のuserInputというカスタム引数が含まれています。Fallback handler関数は、Execution関数のreturnマップと同様の構造を持つマップを返します。 注意: 1. ConvoKraft botの開発プラットフォームとしてCatalyst functionsまたはWebhooksを選択している場合、コンソールからhandlerを有効にし、handler関数のロジックをIntegration functionまたは設定されたwebhook URLに関連付けられたコードベースでそれぞれ定義できます。 2. fallback handler関数の成功シナリオの応答ステータスは、handledとして設定する必要があります。設定しない場合、ステータスは失敗とみなされます。関数の返却応答は、fallback function handlerで設定されたロジックに依存します。これはCatalyst functionsとWebhooksの両方に適用されます。 Delugeでのhandler関数の定義の詳細については、こちらのページを参照してください。 開発プラットフォームとしてFunctionsを選択した場合、Java、Node.js、Pythonスタックの以下のサンプルコードを使用できます： ### Java import org.json.JSONObject; import java.io.*; import java.util.logging.Logger; public class FallbackHandler { Logger LOGGER = Logger.getLogger(FallbackHandler.class.getName()); public JSONObject handleFallbackRequest(JSONObject reqBody) throws Exception{ JSONObject jsonResponse = new JSONObject(); LOGGER.info("Fallback Handler : : TODO : "+ reqBody.get("todo")); jsonResponse.put("message", "Fallback Response: Please define this question and try again"); return jsonResponse; } } ### Node.js import logger from "./logger.js"; // フォールバック機能を処理する export default function handleFallback() { logger.info('Handling fallback request'); return { "message": "Fallback Response: Please define this question and try again" }; } ### Python import logging def handle_fallback_request(): # これはフォールバックレスポンスハンドラーです。 # ボットがユーザーへの応答方法を知らない場合のフォールバックレスポンスを記述してください。 # フォールバックメッセージを返す方法は次のとおりです： # { # 'message': 'フォールバックレスポンス：この質問を定義してもう一度お試しください' # } # 以下に同じ設定のサンプルコードがあります。 logging.info('Handling fallback request') return { 'message': 'Fallback Response: Please define this question and try again' } -------------------------------------------------------------------------------- title: "コード Deluge ハンドラ" description: "ConvoKraftの組み込みエディタを使用したDeluge handlerのコーディングについて説明します。" last_updated: "2026-07-02T09:34:21.941Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/handlers/code-deluge-handlers/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Code Deluge Handlers # 実装 ConvoKraft botのDeluge handlerを設定するには、以下の手順に従ってください： 1. ConvoKraft botを作成し、必要なActionsを設定した後、Handlersタブに移動して必要なhandlerを有効にすると、handler関数をさらに編集できるようになります。 注意: コンソールからhandler関数を編集できるのは、ConvoKraft botの開発プラットフォームとしてDelugeを選択した場合のみです。 2. handler関数を有効にしたら、Edit Functionをクリックすると、handlerの関数ページにリダイレクトされます。 3. botの特定のニーズに基づいて応答を構成した後、関数コードを保存し、DONEをクリックします。 -------------------------------------------------------------------------------- title: "失敗ハンドラ" description: "アクション実行中の例外シナリオを処理するためのbot logicを設定できるFailure handlerについて説明します。" last_updated: "2026-07-02T09:34:21.941Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/handlers/failure-handler/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Failure Handler # はじめに ユーザーの入力メッセージで例外が発生した場合、botはFailure handler関数で設定されたメッセージで応答します。デフォルトの応答メッセージをカスタマイズして独自の返信を行いたい場合は、botの特定のニーズに基づいてFailure Handler関数を設定できます。 Execution関数のシステム定義の入力引数に加えて、Failure handler関数には、現在のチャットセッションにおけるユーザーからの最新の応答を格納するString型のuserInputというカスタム引数が含まれています。Failure handler関数は、Execution関数のreturnマップと同様の構造を持つマップを返します。 注意: ConvoKraft botの開発プラットフォームとしてCatalyst functionsまたはWebhooksを選択している場合、コンソールからhandlerを有効にし、handler関数のロジックをIntegration functionまたは設定されたwebhook URLに関連付けられたコードベースでそれぞれ定義できます。 Delugeでのhandler関数の定義の詳細については、こちらのページを参照してください。 開発プラットフォームとしてFunctionsを選択した場合、Java、Node.js、Pythonスタックの以下のサンプルコードを使用できます： ### Java import org.json.JSONObject; import java.io.*; import java.util.logging.Logger; public class FailureHandler { Logger LOGGER = Logger.getLogger(FailureHandler.class.getName()); public JSONObject handleFailureRequest(JSONObject reqBody) throws Exception{ JSONObject jsonResponse = new JSONObject(); LOGGER.info("Failure Handler : : TODO : " + reqBody.get("todo")); jsonResponse.put("message", "Failure Response: Please define this question and try again"); return jsonResponse; } } ### Node.js import logger from "./logger.js"; // 失敗機能を処理する export default function handleFailure() { logger.info('Handling failure request'); return { "message": "Failure Response: Please define this question and try again" }; } ### Python import logging def handle_failure_request(): # これは失敗レスポンスハンドラーです。 # 関数の実行中にボットが失敗した場合の失敗レスポンスを記述してください。 # 失敗メッセージを返す方法は次のとおりです： # { # 'message': '申し訳ありません、問題が発生しました' # } # 以下に同じ設定のサンプルコードがあります。 logging.info('Handling failure request') return { 'message': 'Failure Response: Please define this question and try again' } ### ボット -------------------------------------------------------------------------------- title: "はじめに" description: "アプリケーションのエンドユーザーに会話アシスタンスを提供するCatalyst ConvoKraft botについて説明します。" last_updated: "2026-07-02T09:34:21.941Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/bots/introduction/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Bots - はじめに ### 概要 ConvoKraft botは、Catalystアプリケーションの会話インターフェースとして機能するために構築する会話アシスタントです。技術的には、botはConvoKraftサービスで作成するインスタンスであり、自然言語理解（NLU）と会話機能を備えています。 CatalystコンソールからCatalystアプリケーション用のbotを作成できます。botが実行するタスクのセットをActionsとして設定する必要があります。ConvoKraft botは、ユーザーと会話しながらActionsを実行するように設定できます。各Actionの応答は、アプリケーションの特定のニーズに基づいて設定できます。各Actionは、Direct answerで応答するか、アプリケーションのBusiness logicを実行するように設定できます。ConvoKraft botのBusiness logicは、以下のプラットフォームのいずれかを使用して開発できます： * Catalyst Integration Functions：Catalyst Serverless Integration Functionsは、Catalystサーバーでホストされるカスタムビルドのコーディング構造です。Catalyst Integration functionsの詳細については、こちらを参照してください。 * Deluge：Delugeは、Zohoのクラウド環境でホストされるZohoネイティブのオンラインスクリプト言語です。Delugeの詳細については、こちらを参照してください。 * Webhooks：Webhooksは、botによって特定のActionsが呼び出されたときにカスタムサーバーエンドポイントにアクセスするために使用できるコールバック関数です。必要に応じて、Webhook URLのセキュリティを確保することもできます。 要件に応じて、アプリケーション用に複数のConvoKraft botを作成できます。ConvoKraft botに必要なActionsを設定した後、botはネイティブの会話機能を使用して会話に応答し、設定されたActionsの理解に基づいて必要なタスクを実行できるようになります。 <br> ### ConvoKraft botの機能 Catalyst ConvoKraft botには、デフォルトで以下の組み込み機能があります： * **Intent解析**：必要なActionを実行するために文の意図を理解します。 * **コンテキスト維持**：文とその前後の文との関係を理解します。 * **エンティティ抽出**：会話文からプログラム可能なデータとして情報を抽出します。 これらのネイティブ機能は、ConvoKraftサービスを使用して構築されたすべてのbotのカスタム機能またはActionsを補完します。 <br> ### ConvoKraft botのワークフロー ConvoKraft botを作成した後、アプリケーションのさまざまなユースケースに基づいて必要なActionsを設定する必要があります。その後、botはその特定のActionに関連するすべてのユーザーメッセージに応答できるようになります。入力メッセージを受信すると、ConvoKraftは入力メッセージをbotの設定済みActionsのサンプル呼び出しと比較します。 メッセージが設定済みのActionsのいずれにも一致しない場合、botはメッセージを理解できないと応答します。ConvoKraftが入力メッセージをbotの事前設定済みActionと一致させることができた場合、そのActionを実行するために必要なユーザーデータを、会話形式で入力として求めます。たとえば、イベントを予約しようとしている場合、botはイベント名、開始時刻、終了時刻、場所などの詳細を取得するために質問を促すことがあります。必要なデータがすべて入力として取得された後、ConvoKraftはそのActionに設定された応答に応じて、そのActionに定義されたBusiness logicを実行するか、Direct answerで応答します。 -------------------------------------------------------------------------------- title: "Botの作成" description: "アプリケーションのエンドユーザーに会話アシスタンスを提供するCatalyst ConvoKraft botについて説明します。" last_updated: "2026-07-02T09:34:21.941Z" source: "https://docs.catalyst.zoho.com/ja/convokraft/help/bots/create-a-bot/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Botの作成 ConvoKraftサービスを使用する最初のステップは、botを作成することです。Catalystコンソールからbotを作成し、適切なActionsを追加できます。新しいConvoKraft botを作成するには、以下の手順に従ってください。 1. プロジェクトのCatalystコンソールの左側ナビゲーションペインで**ConvoKraftアイコン**をクリックし、サービスに移動します。*Bots*ページが開きます。 2. **Create New Bot**をクリックします。 3. ポップアップで、botの名前を入力します。オプションとして、botの簡単な説明とアイコンも追加できます。 4. **Save**をクリックします。 botの作成が成功すると、Botの詳細ページにリダイレクトされます。このページからbotの編集やActionsの追加を行うことができます。 次に、Business logicを構築するために、以下の開発プラットフォームのいずれかを選択する必要があります：Catalyst Integration Functions、Webhooks、またはDeluge。 * Catalyst Integration functionsを使用してBusiness logicをコーディングする場合は、**Function**を選択し、ドロップダウンリストから必要なCatalyst FunctionをConvoKraft botに関連付けます。プロジェクト内の**Bot Logic**タイプのすべての関数がここにリストされます。Actionの終了時、または会話内のすべてのメッセージ交換の直後に関数を呼び出すことも選択できます。Catalyst Integration functionsの使用の詳細については、こちらのページを参照してください。 注意: bot用のCatalyst Integration functionを事前に作成して設定する必要があります。その後、botを関数に関連付けることができます。 * Business logicを独自にコーディングし、ConvoKraftからアクセス可能な外部パブリックサーバーでホストする場合は、**Webhook**を選択します。サーバーのエンドポイントの有効なURLを入力してください。Catalyst Integration functionsと同様に、すべてのActionの終了時、またはbot会話のすべてのメッセージの後にwebhookを呼び出すことを選択できます。必要に応じて、webhook呼び出しのセキュリティを確保することもできます。webhookの使用の詳細については、こちらのページを参照してください。 * DelugeでBusiness logicをコーディングする場合は、**Deluge**を選択します。コンソールでDeluge Functionsをコーディングするための組み込みコードエディタが提供されます。Deluge Functionsとエディタの使用の詳細については、こちらのページを参照してください。 選択を行った後、**Save**をクリックします。 ConvoKraft botが作成された後、botが実行する必要があるActionsを設定できます。 --- ## API Reference — ConvoKraft -------------------------------------------------------------------------------- title: "SmartTrainの有効化・無効化" description: "このAPIは、ConvoKraftのSmartTrain機能を有効化または無効化するために使用されます。" last_updated: "2026-07-02T09:34:21.967Z" source: "https://docs.catalyst.zoho.com/ja/api/code-reference/convokraft/enable-or-disable-smarttrain/" service: "ConvoKraft" -------------------------------------------------------------------------------- # Catalyst ConvoKraft Catalyst ConvoKraftは、インテリジェントなチャットボットを構築してCatalystアプリケーションにデプロイできるAI搭載サービスです。これらのボットは自然言語理解（NLU）を活用してメッセージを解釈し、自然な会話形式の英語で応答します。アプリケーションの要件に基づいて、独自のロジックを設定したり、簡単な質問と回答のペアを提供したり、カスタムリソースでトレーニングしたりして、ボットをカスタマイズできます。 SmartTrainは、Catalyst ConvoKraftサービスのコンポーネントで、独自のリソースを使用してチャットボットをトレーニングできます。リソースがホストされているWebURLを設定することで、ボットがトレーニング済みコンテンツに関連するユーザーのクエリに迅速かつ正確に回答できるようになります。 Catalyst ConvoKraftサービスの詳細については、こちらのヘルプドキュメントを参照してください。 # SmartTrainの有効化・無効化 このAPIは、Catalyst ConvoKraftサービスの**SmartTrain**を有効化または無効化します。有効化すると、ボットの応答を向上させるための学習素材を追加できます。無効化すると、ボットのトレーニング済み知識が一時的に停止され、トレーニングデータに基づくクエリに回答できなくなります。再度有効化すると、トレーニングが自動的に復元され、以前にアップロードされた素材を使用してボットが応答できるようになります。 以下のAPIを使用して、この機能をCatalystアプリケーションに導入できます。 ### リクエスト詳細 #### リクエストURL <p>{api-domain}/convokraft/api/v1/bots/{botid}? type=DEVELOPED Catalyst APIにアクセスするためのDC固有ドメイン ボットが作成されたプロジェクトの一意のID ConvoKraftボットの一意のID 注意: 1. クエリパラメーターtype=DEVELOPEDは、ボットがConvoKraftサービス内で開発状態であることを示すために使用されます。 2. botidは、コンソールで環境がDevelopmentに設定されている場合、ConvoKraftサービスのURLから直接取得できます。 例: <span style="pointer-events: none;word-break: break-all;">https://console.catalyst.zoho.com/baas/v1/project/183272829220/Development#/convokraft/bots/3828281991118</span> <br> ここで、**3828281991118**がbotidです。 #### スコープ ZIAPlatform.Convokraft.RAG.UPDATE #### リクエストヘッダー **Authorization:** Zoho-oauthtoken {oauth_token} <br> Content-Type: application/json <br> CATALYST-ORG: {org_id} <br> X-CATALYST-projectid: {project id} <br> X-CATALYST-Environment: Development <br> 注意: リクエストヘッダーCATALYST-Environment: Developmentは、API操作がCatalyst開発環境内のボットに対して実行されることを示します。 #### リクエストJSONプロパティ RAG機能を有効にするにはtrue、無効にするにはfalseを渡します。 <br> デフォルト: true ### レスポンス詳細 レスポンスには、SmartTrainの有効化・無効化操作のステータスが、ステータスメッセージおよびステータスコードとともに返されます。 <br> <br> curl -X PATCH \ https://api.catalyst.zoho.com/baas/v1/project/4000000006007/convokraft/api/v1/bots/92738220219110?type=DEVELOPED \ -H 'Authorization: Zoho-oauthtoken 1000.910*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*16.2f*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*57' \ -H 'Content-Type: application/json' \ -H 'CATALYST-ORG: 372822922' \ -H 'X-CATALYST-projectid: 2728172727718' \ -H 'X-CATALYST-Environment: "Development"' \ -\-data '{ "bots": { "is_rag_enabled": true } }' { "status": "SUCCESS", "code": "SUCCESS", "message": "Updated Successfully." } -------------------------------------------------------------------------------- title: "学習素材の追加" description: "このAPIは、ConvoKraftのSmartTrain機能に学習用URLを追加するために使用されます。" last_updated: "2026-07-02T09:34:21.967Z" source: "https://docs.catalyst.zoho.com/ja/api/code-reference/convokraft/add-training-material/" service: "ConvoKraft" -------------------------------------------------------------------------------- # 学習素材の追加 このAPIを使用すると、SmartTrainにカスタム学習素材をアップロードし、ConvoKraftボットを自動的にトレーニングさせることができます。HTMLまたはTXT形式でサードパーティプラットフォームにホストされている学習素材のWebURLを提供できます。アップロードされると、ボットはコンテンツを処理し、関連するクエリへの応答に使用します。 以下のAPIを使用して、この機能をCatalystアプリケーションに導入できます。 ### リクエスト詳細 #### リクエストURL <p>{api-domain}/convokraft/api/v1/bots/{botid}/rag_training_data?type=DEVELOPED Catalyst APIにアクセスするためのDC固有ドメイン ボットが作成されたプロジェクトの一意のID ConvoKraftボットの一意のID 注意: 1. クエリパラメーターtype=DEVELOPEDは、ボットがConvoKraftサービス内で開発状態であることを示すために使用されます。 2. botidは、コンソールで環境がDevelopmentに設定されている場合、ConvoKraftサービスのURLから直接取得できます。 例: <span style="pointer-events: none;word-break: break-all;">https://console.catalyst.zoho.com/baas/v1/project/183272829220/Development#/convokraft/bots/3828281991118</span> <br> ここで、**3828281991118**がbotidです。 #### スコープ ZIAPlatform.Convokraft.RAG.CREATE #### リクエストヘッダー **Authorization:** Zoho-oauthtoken {oauth_token} <br> Content-Type: application/json <br> CATALYST-ORG: {org_id} <br> X-CATALYST-projectid: {project id} <br> X-CATALYST-Environment: Development <br> 注意: リクエストヘッダーCATALYST-Environment: Developmentは、API操作がCatalyst開発環境内のボットに対して実行されることを示します。 #### リクエストJSONプロパティ **.html**または**.txt**を指す学習素材の完全なURLを指定します。 学習素材のタイトルを指定します。 ### レスポンス詳細 このAPIは、ステータスコードとメッセージを含む学習素材のアップロードプロセスのステータスを提供します。また、アップロードされた素材のURLと、ConvoKraftが各URLに割り当てた一意のIDも返します。 <br> <br> curl -X POST \ https://api.catalyst.zoho.com/baas/v1/project/4000000006007/convokraft/api/v1/bots/92738220219110/rag_training_data?type=DEVELOPED \ -H 'Authorization: Zoho-oauthtoken 1000.910*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*16.2f*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*57' \ -H 'Content-Type: application/json' \ -H 'CATALYST-ORG: 372822922' \ -H 'X-CATALYST-projectid: 2728172727718' \ -H 'X-CATALYST-Environment: "Development"' \ -\-data '{ "rag_training_data": [ { "url": "https://www.apple.com/iphone-15", "title": "Iphone 15 Specifications" }, { "url": "https://www.apple.com/iphone-11/", "title": "Iphone 11 Specifications" } ] }' { "status": "SUCCESS", "code": "SUCCESS", "message": "File upload in progress", "info": { "files": [ { "id": "2000000028005", "url": "https://www.apple.com/iphone-15/" }, { "id": "2000000028007", "url": "https://www.apple.com/iphone-11/" }, ] } } -------------------------------------------------------------------------------- title: "学習素材の取得" description: "このAPIは、ConvoKraftのSmartTrain機能にアップロードされた学習素材を取得するために使用されます。" last_updated: "2026-07-02T09:34:21.967Z" source: "https://docs.catalyst.zoho.com/ja/api/code-reference/convokraft/get-training-materials/" service: "ConvoKraft" -------------------------------------------------------------------------------- # 学習素材の取得 このAPIを使用すると、特定のConvoKraftボットに関連する学習素材の詳細とメタデータを取得できます。 以下のAPIを使用して、この機能をCatalystアプリケーションに統合できます。 ### リクエスト詳細 #### リクエストURL <p>{api-domain}/convokraft/api/v1/bots/{botid}/rag_training_data?type=DEVELOPED Catalyst APIにアクセスするためのDC固有ドメイン ボットが作成されたプロジェクトの一意のID ConvoKraftボットの一意のID 注意: 1. クエリパラメーターtype=DEVELOPEDは、ボットがConvoKraftサービス内で開発状態であることを示すために使用されます。 2. botidは、コンソールで環境がDevelopmentに設定されている場合、ConvoKraftサービスのURLから直接取得できます。 例: <span style="pointer-events: none;word-break: break-all;">https://console.catalyst.zoho.com/baas/v1/project/183272829220/Development#/convokraft/bots/3828281991118</span> <br> ここで、**3828281991118**がbotidです。 #### スコープ ZIAPlatform.Convokraft.RAG.READ #### リクエストヘッダー **Authorization:** Zoho-oauthtoken {oauth_token} <br> Content-Type: application/json <br> CATALYST-ORG: {org_id} <br> X-CATALYST-projectid: {project id} <br> X-CATALYST-Environment: Development <br> 注意: リクエストヘッダーCATALYST-Environment: Developmentは、API操作がCatalyst開発環境内のボットに対して実行されることを示します。 ### レスポンス詳細 このAPIは、ConvoKraftが生成した一意のID、タイトル、URL、各学習素材のステータスを含む、ボットに関連する全学習素材の詳細とメタデータを提供します。また、ユーザーのメールアドレス、タイムゾーン、ZUID、ロール、その他の関連詳細など、素材の作成・変更に関する情報と、作成・変更のタイムスタンプも含まれます。 curl -X GET \ https://api.catalyst.zoho.com/baas/v1/project/4000000006007/convokraft/api/v1/bots/92738220219110/rag_training_data?type=DEVELOPED \ -H 'Authorization: Zoho-oauthtoken 1000.910*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*16.2f*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*57' \ -H 'Content-Type: application/json' \ -H 'CATALYST-ORG: 372822922' \ -H 'X-CATALYST-projectid: 2728172727718' \ -H 'X-CATALYST-Environment: "Development"' \ { "rag_training_data": [ { "id": "67799000000085007", "title": "Iphone 15 Specifications", "url": "https://www.apple.com/iphone-15/", "source": "URL", "created_by": { "id": "76859507", "email": "amelia.burrows@zylker.com", "username": "amelia.burrows", "timezone": "Asia/Calcutta", "nickname": "amelia", "locale": "en_IN", "role": "SUPER_ADMIN", "zuid": "76859507" }, "created_time": "1732880033148", "modified_by": { "id": "76859507", "email": "amelia.burrows@zylker.com", "username": "amelia.burrows", "timezone": "Asia/Calcutta", "nickname": "nivetha.raja", "locale": "en_IN", "role": "SUPER_ADMIN", "zuid": "76859507" }, "modified_time": "1732880389581", "status": "TRAINED" }, { "id": "67799000000085009", "title": "Iphone 11 Specifications", "url": "https://www.apple.com/iphone-11/", "source": "URL", "created_by": { "id": "76859507", "email": "amelia.burrows", "username": "amelia.burrows", "timezone": "Asia/Calcutta", "nickname": "amelia", "locale": "en_IN", "role": "SUPER_ADMIN", "zuid": "76859507" }, "created_time": "1732880131250", "modified_by": { "id": "76859507", "email": "amelia.burrows@zylker.com", "username": "amelia.burrows", "timezone": "Asia/Calcutta", "nickname": "amelia", "locale": "en_IN", "role": "SUPER_ADMIN", "zuid": "76859507" }, "modified_time": "1732880131250", "status": "TRAINED" } ] } -------------------------------------------------------------------------------- title: "学習素材の削除" description: "このAPIは、ConvoKraftのSmartTrain機能からアップロードされた学習素材を削除するために使用されます。" last_updated: "2026-07-02T09:34:21.967Z" source: "https://docs.catalyst.zoho.com/ja/api/code-reference/convokraft/delete-training-material/" service: "ConvoKraft" -------------------------------------------------------------------------------- # 学習素材の削除 このAPIを使用すると、リクエストに各素材に割り当てられた一意のIDを指定して、ConvoKraftボットのSmartTrain機能にアップロードされたカスタム学習素材を削除できます。カンマ区切りでIDを渡すことで、複数の素材を一度に削除することもできます。学習素材を削除すると、ボット内のトレーニング済み知識も自動的に削除され、削除された学習素材に基づくクエリには回答できなくなりますのでご注意ください。 以下のAPIを使用して、この機能をCatalystアプリケーションに統合できます。 ### リクエスト詳細 #### リクエストURL <p>{api-domain}/convokraft/api/v1/bots/{botid}/rag_training_data?type=DEVELOPED Catalyst APIにアクセスするためのDC固有ドメイン ボットが作成されたプロジェクトの一意のID ConvoKraftボットの一意のID 注意: 1. クエリパラメーターtype=DEVELOPEDは、ボットがConvoKraftサービス内で開発状態であることを示すために使用されます。 2. botidは、コンソールで環境がDevelopmentに設定されている場合、ConvoKraftサービスのURLから直接取得できます。 例: <span style="pointer-events: none;word-break: break-all;">https://console.catalyst.zoho.com/baas/v1/project/183272829220/Development#/convokraft/bots/3828281991118</span> <br> ここで、**3828281991118**がbotidです。 #### スコープ ZIAPlatform.Convokraft.RAG.DELETE #### リクエストヘッダー **Authorization:** Zoho-oauthtoken {oauth_token} <br> Content-Type: application/json <br> CATALYST-ORG: {org_id} <br> X-CATALYST-projectid: {project id} <br> X-CATALYST-Environment: Development <br> 注意: リクエストヘッダーCATALYST-Environment: Developmentは、API操作がCatalyst開発環境内のボットに対して実行されることを示します。 #### リクエストJSONプロパティ ConvoKraftが生成した学習素材の一意のIDを指定します。 ### レスポンス詳細 このAPIは、ステータスコードとメッセージとともに削除操作のステータスを返します。<br> <br> curl -X DELETE \ https://api.catalyst.zoho.com/baas/v1/project/4000000006007/convokraft/api/v1/bots/92738220219110/rag_training_data?type=DEVELOPED \ -H 'Authorization: Zoho-oauthtoken 1000.910*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*16.2f*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*57' \ -H 'Content-Type: application/json' \ -H 'CATALYST-ORG: 372822922' \ -H 'X-CATALYST-projectid: 2728172727718' \ -H 'X-CATALYST-Environment: "Development"' \ -\-data '{ "rag_training_data": [ { "id": "67799000000084013" } ] }' { "status": "SUCCESS", "code": "SUCCESS", "message": "Updated Successfully." } -------------------------------------------------------------------------------- title: "ボットからの回答取得" description: "このAPIは、ConvoKraftでSmartTrainを有効にした後、トレーニング済みボットから回答を取得するために使用されます。" last_updated: "2026-07-02T09:34:21.967Z" source: "https://docs.catalyst.zoho.com/ja/api/code-reference/convokraft/fetch-answer-from-bot/" service: "ConvoKraft" -------------------------------------------------------------------------------- # ボットからの回答取得 このAPIを使用すると、トランスクリプトクエリを送信してConvoKraftボットから回答を取得できます。ボットは質問を理解し、トレーニングに基づいた回答を返します。 以下のAPIを使用して、この機能をCatalystアプリケーションに統合できます。 ### リクエスト詳細 #### リクエストURL <p>{api-domain}/convokraft/api/v1/bots/{production_botid}/answer Catalyst APIにアクセスするためのDC固有ドメイン ボットが作成されたプロジェクトの一意のID 本番環境におけるConvoKraftボットの一意のID 注意: production_botidは、コンソールで環境がProductionに設定されている場合、ConvoKraftサービスのURLから直接取得できます。 例: <span style="pointer-events: none;word-break: break-all;">https://console.catalyst.zoho.com/baas/v1/project/183272829220/Production#/convokraft/bots/3828281991118</span> <br> ここで、**3828281991118**がproduction_botidです。 #### スコープ ZIAPlatform.Convokraft.RAG.CREATE #### リクエストヘッダー **Authorization:** Zoho-oauthtoken {oauth_token} <br> Content-Type: application/json <br> CATALYST-ORG: {org_id} <br> X-CATALYST-projectid: {project id} <br> X-CATALYST-Environment: Development <br> 注意: リクエストヘッダーCATALYST-Environment: Productionは、API操作がCatalyst本番環境内のボットに対して実行されることを示します。 ### レスポンス詳細 このAPIは、学習素材に基づいてConvoKraftが提供する回答を、回答取得プロセスのステータスとともに返します。 <br> curl -X POST \ https://api.catalyst.zoho.com/convokraft/api/v1/bots/92738220219110/answer \ -H 'Authorization: Zoho-oauthtoken 1000.910*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*16.2f*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*57' \ -H 'Content-Type: application/json' \ -H 'CATALYST-ORG: 372822922' \ -H 'X-CATALYST-projectid: 2728172727718' \ -H 'X-CATALYST-Environment: "Production"' \ -\-data '{ "transcript": { "message": "Explain Iphone 11 Specifications" } }' { "transcript": { "message": "The iPhone 11 is a sleek and powerful smartphone from Apple, featuring a 6.1-inch Liquid Retina HD display that offers vibrant colors and sharp detail. It's powered by the A13 Bionic chip, which ensures fast performance and smooth multitasking. Whether you're gaming, editing photos, or using apps, the iPhone 11 can handle it with ease. One of the standout features of the iPhone 11 is its camera system. It has a dual-camera setup, with a 12MP wide and ultra-wide lens, making it great for capturing detailed photos and videos. The Night Mode feature helps take clearer pictures in low-light environments, and it also supports 4K video recording at 60fps, allowing you to shoot high-quality videos.", "status": "action_completion" } } --- ## FAQ — ConvoKraft # 一般 Catalyst ConvoKraftは、ユーザーのメッセージとその意図を理解し、英語で会話形式で応答するように構成できる会話型ボットを構築するために使用されるAI駆動サービスです。ConvoKraftボットのバックエンドロジックは、Catalyst Integration FunctionsまたはDelugeを使用して構成できます。また、任意のプログラミング言語でコーディングし、公開アクセス可能な外部サーバーに保存して、Webhooksを使用してConvoKraftからアクセスすることもできます。 ConvoKraftで作成されたボットは認証されていないため、Catalystアプリケーションから現在のログインユーザーの詳細を取得することはできません。 # Bots ConvoKraftボットをアプリケーションに簡単に埋め込むことができるJavaScript Client SDKパッケージを提供しています。ヘッダー、タイトル、配置などのチャットウィンドウをカスタマイズするための要素が含まれています。さまざまな要素とその使用方法の詳細については、こちらのページを参照してください。 はい、変更を行うたびにコンソールでTrainボタンをクリックしてボットをトレーニングする必要があります。これにより、ボットは一般的な呼び出しパターンを分析し、バックエンドの自然言語処理モデルをトレーニングできます。これらのモデルは、同じユーザークエリのさまざまなバリエーション間の強い相関関係を構築し、ユーザーにインテリジェントに応答するのに役立ちます。 はい、Catalystコンソールのボットの本番環境から、ボットのインタラクションの使用統計を取得できます。 はい、ビジネスロジックに基づいてボットをトレーニングすることも、直接回答を設定することもできます。ボットをトレーニングするには、さまざまなサンプルの質問と回答のセットを提供する必要があります。トレーニングが完了すると、ボットはトレーニングされたデータに基づいてクエリに回答します。 Catalystコンソールから直接ボットを一時的に有効化/無効化できます。 # Actions Delugeで失敗ハンドラーをコーディングするか、Catalyst Functionを統合して失敗を処理し、失敗イベント時にファンクションからメールを送信して通知することもできます。 はい、invokeURL() Delugeファンクションを使用してCatalyst FunctionエンドポイントにAPI呼び出しを行い、レスポンスを取得できます。 # Handlers コンソールからZoho独自のスクリプト言語Delugeを使用して、ウェルカムハンドラーや失敗ハンドラーなどのさまざまなハンドラーをコーディングし、ファンクションをテストすることもできます。また、Catalyst Integration Functionを特定のアクションのボットに関連付けることもできます。特定のアクションでボットがアクセスされると、Integration Functionが自動的に呼び出され、レスポンスがボットを通じてユーザーに返されます。 Catalyst Integration Functionsを使用してConvoKraftボットのボットロジックを開発する場合、またはWebhooksを使用して外部サーバーにコーディングされたバックエンドロジックにアクセスする場合は、必要なハンドラー（Welcome Message Handler、Fallback Handler、Failure Handler）を有効にして、コードベースの各ハンドラーファンクションにロジックをコーディングするだけです。詳細については、こちらのページを参照してください。