Create a "Hello World" bot
Follow these steps to create the configuration files you will need:
You have guessed it correctly, another
/outputstore/outputsetscreates the bot's
Outputwith a JSON in the body like this:
"text": "Hello World!"
You should again get a return code of
locationheader referencing the newly created output :
Now we will align the just created
Package. Make a
/packagestore/packageswith a JSON in the body like this:
Extension Types in this examples
/botstore/botswith a JSON like this:
b. You should again get a return code of
locationheader referencing the newly created bot :
Finally, we are ready to let the bot fly. From here on, you have the possibility to let an UI do it for you or you do it step by step.
The UI that automates these steps can be reached here:
Otherwise via REST:
- 1.Deploy the Bot:Make a
<BOT_VERSION>You will receive a
- 2.Since deployment could take a while it has been made asynchronous.
- 3.Make a
<BOT_VERSION>to find out the status of deployment.
READYis what you can expect to be returned in the body.
- 1.As soon as the Bot is deployed and has
READYstatus, make a
- 1.You will receive a
URIfor the newly created Conversation, like this:
- 2.Now it's time to start talking to our Bot 1. Make a
Option 1: is to hand over the input text as
contentType text/plain. Include the User Input in the body as
Option 2: is to hand over the input as
contentType application/json, which also allows you to handover context information that you can use with the eddi configurations 1. Include the User Input in the body as application/json (e.g. Hello)
"input": "some user input"
- 1.You have two query params you can use to config the returned output 1.
returnDetailed- default is false - will return all sub results of the entire conversation steps, otherwise only public ones such as input, action, output & quickreplies 2.
returnCurrentStepOnly- default is true - will return only the latest conversation step that has just been processed, otherwise returns all conversation steps since the beginning of this conversation
- 2.The output from the bot will be returned as JSON
- 3.If you are interested in fetching the
conversationmemoryat any given time, make a
?returnDetailed=true(the query param is optional, default is false)
If you made it till here, CONGRATULATIONS, you have created your first Chatbot with EDDI !
By the way you can use the attached postman collection below to do all of the steps mentioned above by clicking send on each request in postman.
- 1.Create outputSet
- 2.Creating package
- 3.Creating bot
- 4.Deploy the bot
- 5.Create conversation
- 6.Say Hello to the bot
Creating and chatting with a bot.postman_collection.json
Example to download