学習素材の削除

このAPIを使用すると、リクエストに各素材に割り当てられた一意のIDを指定して、ConvoKraftボットのSmartTrain機能にアップロードされたカスタム学習素材を削除できます。カンマ区切りでIDを渡すことで、複数の素材を一度に削除することもできます。学習素材を削除すると、ボット内のトレーニング済み知識も自動的に削除され、削除された学習素材に基づくクエリには回答できなくなりますのでご注意ください。

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

リクエスト詳細

リクエストURL

DELETE

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

copy

api-domain

URL

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

project_id

Numerical

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

botid

Numerical

ConvoKraftボットの一意のID

注意:

クエリパラメーター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.DELETE

リクエストヘッダー

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プロパティ

rag_training_data Numerical

mandatory

ConvoKraftが生成した学習素材の一意のIDを指定します。

レスポンス詳細

このAPIは、ステータスコードとメッセージとともに削除操作のステータスを返します。

リクエスト例
copy

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

レスポンス例
copy

{
“status”: “SUCCESS”,
“code”: “SUCCESS”,
“message”: “Updated Successfully.”
}

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit