Loading...

お知らせ:

当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

Catalyst ConvoKraft

Catalyst ConvoKraftは、インテリジェントなチャットボットを構築してCatalystアプリケーションにデプロイできるAI搭載サービスです。これらのボットは自然言語理解(NLU)を活用してメッセージを解釈し、自然な会話形式の英語で応答します。アプリケーションの要件に基づいて、独自のロジックを設定したり、簡単な質問と回答のペアを提供したり、カスタムリソースでトレーニングしたりして、ボットをカスタマイズできます。

SmartTrainは、Catalyst ConvoKraftサービスのコンポーネントで、独自のリソースを使用してチャットボットをトレーニングできます。リソースがホストされているWebURLを設定することで、ボットがトレーニング済みコンテンツに関連するユーザーのクエリに迅速かつ正確に回答できるようになります。

Catalyst ConvoKraftサービスの詳細については、こちらのヘルプドキュメントを参照してください。

SmartTrainの有効化・無効化

このAPIは、Catalyst ConvoKraftサービスのSmartTrainを有効化または無効化します。有効化すると、ボットの応答を向上させるための学習素材を追加できます。無効化すると、ボットのトレーニング済み知識が一時的に停止され、トレーニングデータに基づくクエリに回答できなくなります。再度有効化すると、トレーニングが自動的に復元され、以前にアップロードされた素材を使用してボットが応答できるようになります。

以下のAPIを使用して、この機能をCatalystアプリケーションに導入できます。

リクエスト詳細

リクエストURL

PATCH

{api-domain}/convokraft/api/v1/bots/{botid}? type=DEVELOPED

copy

api-domain
URL
Catalyst APIにアクセスするためのDC固有ドメイン

project_id
Numerical
ボットが作成されたプロジェクトの一意のID

botid
Numerical
ConvoKraftボットの一意のID

注意:

  1. クエリパラメーターtype=DEVELOPEDは、ボットがConvoKraftサービス内で開発状態であることを示すために使用されます。

  2. botidは、コンソールで環境がDevelopmentに設定されている場合、ConvoKraftサービスのURLから直接取得できます。

例: https://console.catalyst.zoho.com/baas/v1/project/183272829220/Development#/convokraft/bots/3828281991118
ここで、3828281991118がbotidです。

スコープ

ZIAPlatform.Convokraft.RAG.UPDATE

リクエストヘッダー

Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: {org_id}
X-CATALYST-projectid: {project id}
X-CATALYST-Environment: Development

注意: リクエストヘッダーCATALYST-Environment: Developmentは、API操作がCatalyst開発環境内のボットに対して実行されることを示します。

リクエストJSONプロパティ

is_rag_enabled boolean
mandatory

RAG機能を有効にするにはtrue、無効にするにはfalseを渡します。
デフォルト: true

レスポンス詳細

レスポンスには、SmartTrainの有効化・無効化操作のステータスが、ステータスメッセージおよびステータスコードとともに返されます。

リクエスト例
copy

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 } }’

レスポンス例
copy
{
"status": "SUCCESS",
"code": "SUCCESS",
"message": "Updated Successfully."
}