学習素材の取得

このAPIを使用すると、特定のConvoKraftボットに関連する学習素材の詳細とメタデータを取得できます。

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

リクエスト詳細

リクエストURL

GET

{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.READ

リクエストヘッダー

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開発環境内のボットに対して実行されることを示します。

レスポンス詳細

このAPIは、ConvoKraftが生成した一意のID、タイトル、URL、各学習素材のステータスを含む、ボットに関連する全学習素材の詳細とメタデータを提供します。また、ユーザーのメールアドレス、タイムゾーン、ZUID、ロール、その他の関連詳細など、素材の作成・変更に関する情報と、作成・変更のタイムスタンプも含まれます。

リクエスト例
copy

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”’ \

レスポンス例
copy

{
“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”
}
]
}

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit