Training

It’s challenging to predict all the queries coming to the chatbot every day. People communicate in different styles, using different words and phrases. Stop guessing what your clients are going to say and start listening and using the data you have to train your bot.

List items

Returns list of Training object items.

Request URL

curl --request GET \
	--url https://api.chatbot.com/training \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}'

Response Example

{
    "items": [
        {
            "id": "5acb6abf0fe82bf4d13a5f98",
            "storyId": "5a8aa27ec7266a0007a00764",
            "conversationId": "5b0ba763c8bb5a339cfb10fc",
            "date": "2018-04-09T13:29:32.999Z",
            "text": "Foo Bar",
            "unmatched": 1
        }
    ],
    "count": 1
}

Properties

Periods: yesterday,last7days,last30days, thisMonth,lastMonth,last3Months, thisMonth, lastMonth,last3Months, thisYear, lastYear

Training object

Delete items

Removes provided items.

Request URL

curl --request DELETE \
	--url https://api.chatbot.com/training \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json' \
	--data '
[
  "5acb6abf0fe82bf4d13a5f98"
]
'

Response Example

{
    "timestamp": "2017-04-12T13:41:47.020Z",
    "status": {
        "code": 200,
        "type": "success"
    }
}

Ignore items

Marks provided items as ignored.

Request URL

curl --request PUT \
	--url https://api.chatbot.com/training/ignore \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json' \
	--data '
[
  "5acb6abf0fe82bf4d13a5f98"
]
'

Response Example

{
    "timestamp": "2017-04-12T13:41:47.020Z",
    "status": {
        "code": 200,
        "type": "success"
    }
}

Train items

Move training items to interaction.

Request URL

curl --request PUT \
	--url https://api.chatbot.com/training/train/:interactionID \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json' \
	--data '
[
  "5acb6abf0fe82bf4d13a5f98"
]
'

Response Example

{
    "used": [
        "5acb6abf0fe82bf4d13a5f98"
    ],
    "unused": [],
    "timestamp": "2018-01-19T11:55:07.552Z",
    "status": {
        "code": 200,
        "type": "success"
    }
}

Train by text

Train by provided text & remove training item if exists.

Request URL

curl --request PUT \
	--url https://api.chatbot.com/training/train/:interactionID/text \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json' \
	--data '
{
    "text": "Here put your training text"
}
'

Properties

Response Example

{
    "used": [
        "5acb6abf0fe82bf4d13a5f98"
    ],
    "unused": [],
    "timestamp": "2018-01-19T11:55:07.552Z",
    "status": {
        "code": 200,
        "type": "success"
    }
}