Bot_ChatbotEntity
Bot_ChatbotEntities
- Bot_ChatbotEntities Manage
GET bot/chatbotEntities/{id}
GET bot/chatbots/{id}/chatbotEntities
POST bot/chatbotEntities
PUT bot/chatbotEntities/{id}
DELETE bot/chatbotEntities/{id}
Model
Bot_ChatbotEntity JSON Format
Bot_ChatbotEntity is represented as simple flat JSON objects with the following keys:
| Name | Type | Description |
|---|---|---|
id |
guid | Id of the entity. |
chatbotId |
guid | Id of the chatbot. |
name |
string | Name of the entity. |
chatbotEntityKeywords |
chatbotEntityKeywords[] | Reference to Entity Keyword. |
Entity Keyword JSON Format:
| Name | Type | Description |
|---|---|---|
id |
guid | Id of the entity keyword. |
keyword |
string | Keyword. |
synonyms |
string [] | An array of string, synonyms list of keyword. |
entityId |
guid | Id of the entity. |
Endpoint
Get a single Bot_ChatbotEntity
GET bot/chatbotEntities/{id}
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
include |
string | query | no | Allowed value is "chatbotEntityKeyword". |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotEntities/73d07166-3dfc-4257-aec7-6b57b31684d1 \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Get the list of Bot_ChatbotEntities
GET bot/chatbots/{id}/chatbotEntities
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
keywords |
string | query | no | Search entity name or keyword or synonym by the keyword. |
chatbotId |
guid | query | yes | Id of the chatbot. |
include |
string | query | no | Allowed value is "chatbotEntityKeyword". |
Response:
An array of Bot_ChatbotEntity
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbots/73d07166-3dfc-4257-aec7-6b57b31684d1/chatbotEntities \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Create a new Bot_ChatbotEntity
POST bot/chatbotEntities
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
chatbotId |
guid | body | yes | Id of the chatbot. |
name |
string | body | yes | Name of the entity. |
chatbotEntityKeywords |
chatbotEntityKeywords[] | body | no | Reference to Entity Keyword. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotEntities \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"chatbotId":"e8bf0d25-eed6-4a46-a417-318e15019609","name":"color","chatbotEntityKeywords":[{"keyword":"Pink","synonyms":["white pink"]}]}'
Response:
HTTP/1.1 201 Created
Update the Bot_ChatbotEntity
PUT bot/chatbotEntities/{id}
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
chatbotId |
guid | body | yes | Id of the chatbot. |
name |
string | body | yes | Name of the entity. |
chatbotEntityKeywords |
chatbotEntityKeywords[] | body | no | Reference to Entity Keyword. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotEntities/73d07166-3dfc-4257-aec7-6b57b31684d1 \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"chatbotId":"e8bf0d25-eed6-4a46-a417-318e15019609","name":"color","chatbotEntityKeywords":[{"keyword":"Pink","synonyms":["white pink"]}]}'
Response:
HTTP/1.1 200 OK
Remove the Bot_ChatbotEntity
DELETE bot/chatbotEntities/{id}
Parameters:
No Parameters
Response:
No Content
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotEntities/73d07166-3dfc-4257-aec7-6b57b31684d1 \
-X
'DELETE'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 204 No Content