Comment on page
Introduction
Kogno is an open source framework running on the Ruby programming language for developing chatbots.
Currently, with Kogno you can develop conversational applications in Messenger, WhatsApp and Telegram, maintaining a unified code in a single application for all of them.
As Kongo was created to develop conversational applications, many definitions, elements and methods were adopted from conversational concepts.
One of the most important concepts are the contexts, where most of the conversational logic will reside in an application, developed with this framework.
When a user sends a message, Kogno will determine the context of the conversation. In this context would reside the logic for processing the message and eventually send a reply to the user and/or even move the conversation to another context if it's necessary.
A context in Kogno is represented by a
class, where a series of code blocks are defined, one for each type of message or event expected.When a message/event arrives, only one of these blocks will be executed, if the characteristics of the message matches with the block's execution criteria.
In the example below,
MainContext will have the ability to handle the following scenarios:intent"greeting": A greeting message such as "Hello" or "Hi". Which was previously created and trained on the NLP engine.postback"featured_products": Click event on the button"View Products"that have been sent as reply in the previous blockintent"greeting".everything_else: Any message whose characteristics didn't match the execution criteria of the blocks explained above.
class MainContext < Conversation
def blocks
intent "greeting" do
@reply.text "Hello!"
@reply.button(
"How can I help you today?",
[
{
title: "View Products",
payload: "featured_products"
},
{
title: "My Cart",
payload: "purchases/view_cart"
}
]
)
end
postback "featured_products" do
@reply.text "Alright."
@reply.template "products/featured", title: "Here is a list of today's featured products."
end
keyword ["stop", "quit"] do
@reply.text "Alright"
@reply.typing 2.seconds
@reply.text "I'll stop writing you now.."
end
everything_else do
@reply.text "Sorry, but I don't understand what you said."
end
end
end
For best understanding, this introductory chapter will draw a parallel with MVC pattern and Rails.
After creating a new project by running
kogno new your_project in the terminal, the initial directory structure will contain several directories that will be explained in the following chapters, but the part we'll draw the parallel, is on the bot/ directory.├── bot
│ ├── contexts
│ │ └── main_context.rb
│ ├── templates
│ │ └── main
│ ├── models
│ │ └── user.rb
│ ├── conversation.rb
The term "context" used in Kogno would be the equivalent of what the "controller" is in Rails.
Just as in an
ActionController class in Rails, the logic that coordinates the interactions between a user visiting a web, with views and models is written in files such as products_controller.rb, purchases_controller.rb and so on.In a
Context class in Kogno, the logic that coordinates the interactions between an user who sends a message, with the templates and the models, are also written in files such asproducts_context.rb, purchases_context.rb or main_context.rb (created by default).Just as in Rails, requests to a certain URL on a website can be handled by a particular
controller, in Kogno you can also route messages and events to a particular context. In a conversational application there are no views like in Rails, but there are reply messages, which could be defined in files with an
.erb extension in directories like bot/templates/main (created by default), bot/templates/products and bot/templates/purchases.The example template below is created in
bot/templates/main/menu.erb file and will expect two parameters: message and buttons_message which will be explained below.<%
@reply.text message
@reply.typing 1.second
@reply.button(
buttons_message,
[
{
title: "View Products",
payload: "featured_products"
},
{
title: "My Cart",
payload: "purchases/view_cart"
}
]
)
%>
To use a template, the
@reply.template() method must be called, which would be the equivalent of the render() method in Rails. In the example below you can see how the same template
"main/menu" is used in different situations in the conversation, such as when the user sends a message like "Hi" , "Thank you" or even when the app hasn't understood what the user has said.class MainContext < Conversation
def blocks
intent "greeting" do
@reply.template("main/menu",
{
message: "Hello!",
buttons_message: "How can I help you today?"
}
)
end
intent "thanks" do
@reply.template("main/menu",
{
message: "You're welcome!",
buttons_message: "Is there anything else I can help you with?"
}
)
end
everything_else do
@reply.template("main/menu",
{
message: "Sorry, but I don't understand what you said.",
buttons_message: "Maybe I can help you with this.."
}
)
end
end
end
The way this section works doesn't change at all from Rails, since the
ActiveRecord library is also used in Kogno. In a new project,
User (database table users) is a model that by default is already created in bot/models/users.rb file.class User < ActiveRecord::Base
end
When an incoming message arrives from a user, the framework will automatically create a record with the user's information in the
users table in database. Within a block or template,
@user can be called, since this is the instance of the User model for the message sender.class MainContext < Conversation
def blocks
intent "greeting" do
unless @user.first_name.nil?
@reply.text "Hello #{@user.first_name}!"
else
@reply.text "Hello!"
end
case @user.platform
when "messenger"
@reply.text "You're in Messenger"
when "whatsapp"
@reply.text "You're in WhatsApp"
when "telegram"
@reply.text "You're in Telegram"
end
end
end
end
All the models needed can be created and make the necessary association between them and/or with
User model. Last but not least, the
Conversation class, which would be equivalent to ApplicationController class in Rails. All contexts inherit from this class and the entire conversation goes through it.
In it, global logics or validations of the conversation could be defined by calling callbacks.
class Conversation < Kogno::Context
before_blocks :do_something_before_blocks
after_blocks :do_something_after_blocks
def do_something_before_blocks
# This will be called before the blocks method in the current context will be executed
end
def do_something_after_blocks
# This will be called after the blocks method in the current context will be executed
end
end
A project in Kogno needs to be connected to a database, which will contain the tables associated with the models through the
ActiveRecord library.- MySQL
The main goal is to get Kogno adopted as an open-source alternative for developing conversational applications, while also being able to create value-added services around this framework on kogno.io website.
You can contribute a lot to this project by developing conversational applications with Kogno and in case you find a bug, please report it.
And if you're as passionate about it as we are, come and code with us on GitHub by fixing bugs, adding more integrations and creating more features.
Learn to develop in Kogno by downloading the source code of a flight booking chatbot developed with this framework at https://github.com/kogno/travel_chatbot
Last modified 1yr ago