Skip to main content

Create Chatbot from file

The Sarufi Python SDK allows you to create a chatbot from a file where you can define your intents, utterances and responses separately.

You can either use the YAML or JSON format to define your chatbot. You can find the sample JSON file here.

note

You should choose between YAML or JSON based on your business needs and preferences. We will be using YAML in this tutorial because it is more readable.

Create Chatbot from file

The Sarufi Python SDK allows you to create a chatbot from a file where you can define your intents, utterances, and responses separately.

You can either use the YAML or JSON format to define your chatbot. You can find the sample YAML file here and the sample JSON file here.

To create a chatbot from the YAML file, use the following code snippet:

greetings:
- Hi
- Hello
- Howdy
- Hey
- Good morning
- Good evening
- Good afternoon
- Good day
- Good night

goodbye:
- Bye
- Goodbye
- See you later
- See you soon
- Talk to you later
- Talk to you soon
- Talk to you
- See you
- Have a nice day
- Have a nice evening
- Have a nice night
- Have a nice morning

thanks:
- Thanks
- Thank you
- Thank you so much
- Thanks a lot
- Thanks a bunch
- Thanks a ton
- Thanks a million
- Thanks a zillion

If you are not familiar with YAML or JSON, you can learn more about them here and here, respectively.

Create dialog file

Here is a sample file with dialog defined in YAML format. You can find the sample YAML file here.

greetings:
message:
- Hi, how can I help you?
next_state: end

goodbye:
message:
- Bye
- See you soon
next_state: end

thanks:
message:
- You are welcome
next_state: end

Create a description YAML file

Here is a sample file with description defined in YAML format. You can find the sample YAML file here.

name: Pizza Bot
description: A chatbot that helps you order pizza
industry: Food

Create a chatbot from YAML files

You can create a chatbot from YAML files using the following code.

>>> from sarufi import Sarufi
>>> sarufi = Sarufi(api_key='your API KEY')
>>> response = sarufi.create_from_file(
... intents="data/intents.yaml",
... flow="data/flows.yaml",
... metadata="data/metadata.yaml",
... )

You can also update a chatbot from YAML files using the following code.

>>> from sarufi import Sarufi
>>> sarufi = Sarufi(api_key='your API KEY')
>>> response = sarufi.update_from_file(
... intents="data/intents.yaml",
... flow="data/flows.yaml",
... metadata="data/metadata.yaml",
... id="xxx",
... )

You can use the same code to create or update a chatbot from JSON files. The only difference is the file extension.

What you have learned

In this tutorial, you have learned how to create a chatbot from YAML files using the Sarufi Python SDK.