Obtener materiales de entrenamiento

Esta API te permite obtener los detalles y los metadatos de los materiales de entrenamiento asociados con un bot de ConvoKraft particular.

Puedes integrar esta funcionalidad en tu aplicación de Catalyst usando la API proporcionada a continuación.

Detalles de la solicitud

URL de solicitud

GET

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

copy

api-domain

URL

El dominio específico del DC para acceder a Catalyst API

project_id

Numerical

El ID único del proyecto en el que se ha creado el bot

botid

Numerical

El ID único del bot de ConvoKraft

Nota:

El parámetro de consulta type=DEVELOPED se usa para indicar que el bot está en estado de desarrollo dentro del servicio ConvoKraft.
Puedes obtener el botid directamente desde la URL en el servicio ConvoKraft cuando el entorno está configurado en Development en la consola.

Por ejemplo : https://console.catalyst.zoho.com/baas/v1/project/183272829220/Development#/convokraft/bots/3828281991118
Aquí, 3828281991118 es el botid.

Scope

ZIAPlatform.Convokraft.RAG.READ

Encabezados de solicitud

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

Nota: El encabezado de solicitud CATALYST-Environment: Development indica que la operación de la API debe realizarse en el bot dentro del entorno de desarrollo de Catalyst.

Detalles de la respuesta

Esta API proporciona los detalles y los metadatos de todos los materiales de entrenamiento asociados con el bot, incluyendo el ID único generado por ConvoKraft, el título, la URL y el estado de cada material de entrenamiento. También incluye información sobre la creación y modificación de los materiales, como la dirección de correo electrónico del usuario, zona horaria, ZUID, rol y otros detalles relevantes, junto con las marcas de tiempo de creación y modificación.

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

Sample Response
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