学習素材の追加
このAPIを使用すると、SmartTrainにカスタム学習素材をアップロードし、ConvoKraftボットを自動的にトレーニングさせることができます。HTMLまたはTXT形式でサードパーティプラットフォームにホストされている学習素材のWebURLを提供できます。アップロードされると、ボットはコンテンツを処理し、関連するクエリへの応答に使用します。
以下のAPIを使用して、この機能をCatalystアプリケーションに導入できます。
リクエスト詳細
リクエストURL
{api-domain}/convokraft/api/v1/bots/{botid}/rag_training_data?type=DEVELOPED
注意:
-
クエリパラメーターtype=DEVELOPEDは、ボットがConvoKraftサービス内で開発状態であることを示すために使用されます。
-
botidは、コンソールで環境がDevelopmentに設定されている場合、ConvoKraftサービスのURLから直接取得できます。
例: https://console.catalyst.zoho.com/baas/v1/project/183272829220/Development#/convokraft/bots/3828281991118
ここで、3828281991118がbotidです。
スコープ
ZIAPlatform.Convokraft.RAG.CREATE
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: {org_id}
X-CATALYST-projectid: {project id}
X-CATALYST-Environment: Development
リクエストJSONプロパティ
レスポンス詳細
このAPIは、ステータスコードとメッセージを含む学習素材のアップロードプロセスのステータスを提供します。また、アップロードされた素材のURLと、ConvoKraftが各URLに割り当てた一意のIDも返します。
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/"
},
]
}
}
Yes
No
Thank you for your feedback!
Send your feedback to us