Agregar material de entrenamiento

Esta API te permite cargar materiales de entrenamiento personalizados a SmartTrain, permitiendo que el bot de ConvoKraft se entrene automáticamente. Puedes proporcionar URLs web de los materiales de entrenamiento alojados en cualquier plataforma de terceros en formato HTML o TXT. Una vez cargados, el bot procesa el contenido y lo usa para responder a consultas relevantes.

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

Detalles de la solicitud

URL de solicitud

POST

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

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.

Propiedades JSON de la solicitud

rag_training_data String

mandatory

Proporciona la URL completa del material de entrenamiento apuntando a .html o .txt.

title String

optional

Proporciona el título del material de entrenamiento.

Detalles de la respuesta

Esta API proporciona el estado del proceso de carga del material de entrenamiento, incluyendo el código de estado y el mensaje. También devuelve las URLs de los materiales cargados junto con un ID único asignado por ConvoKraft para cada URL.

Sample Request
copy

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

Sample Response
copy

{
"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

Thank you for your feedback!

Send your feedback to us

Skip

Submit