BotnoiDevPlatform 0.0.8
A programatical alternative to the visual chatbot builder provided by https://botnoi.ai .
Keywords: botnoi,chatbot,bot,botnoi dev platform

<img src="https://th.bing.com/th/id/OIP.HfSXFZI8Bk4GKR98TRIALwHaHa?rs=1&pid=ImgDetMain" width="150" height="150" />

# Botnoi Dev Platform

Botnoi Dev Platform is a programatical alternative to the visual chatbot builder provided by https://botnoi.ai .
It can be used to build and train chatbots for various platforms such as Facebook Messenger and LINE.

This official library provides a Python implementation of Botnoi Dev Platform's API in order to simplify the process of building chatbots.
It also provides various data types related to chatbots such as 'Intent', 'Object' and lots of helper functions to work with them.

This suits best for developers who want to build chatbots programmatically or to automate the process of chatbot training when an action is performed by the applications' users.

# Installation
Run this command in the terminal
```
pip install BotnoiDevPlatform
```

then, import the package
```python
from BotnoiDevPlatform.cores import BotnoiChatbotServer
from BotnoiDevPlatform.elements import Bot, Intent, Object, IntentKeyword, IntentReaction, ImageObject
from BotnoiDevPlatform.utils import ObjectType, Action
```

note: you have to have an API key to use this package. You can get one from https://botnoi.ai

# Usage
## Set up
First, setup a client with your API key
```python
BotnoiChatbotServer.setup_client('your_api_key')
```
Then, you can create a BotnoiChatbotServer server instance
```python
server = BotnoiChatbotServer()
```

## Create a bot
Creating a bot is simple. You just have to create a bot instance and add it to the server
```python
test_bot = Bot(
    botName="test",
    businessType="test",
    botAvatar="https://console.botnoi.ai/assets/botnoi-logo/botnoi.svg",
    sex="male",
    age=20,
)

server.create_bot(test_bot)

# reload the bot from the server. 
# This is required to get the bot's id from the server.
test_bot.reload() 
```

Or find an existing bot by name
```python
test_bot = server.find_bot_with_name("test")
```

## Create and train an intent
You can create an intent by creating a new Intent instance and add it to the bot
```python
test_intent = Intent(name="test_intent")

test_bot.opt.create_intent(test_intent)

# reload the intent from the server. 
# This is required to get the intent's id from the server.
test_intent.reload() 
```

Or find an existing one by name
```python
test_intent = test_bot.opt.find_intent_with_name("test_intent")
```

notice that the 'opt' property is used when you want to do something with the bot that is related to Botnoi Dev Platform (eg. create_intent, find_intents, etc.). This is the standard for all data types that can directly interact with the server (eg. Bot, Intent, Object, etc.).

You can train the intent by adding some keywords(inputs) and reactions(outputs) to it
```python
test_intent.opt.train_keyword(IntentKeyword("hello"))

test_intent.opt.train_reaction(IntentReaction(["hello!", "it works!"]))
```

Or train the reaction with more complex actions like this
```python
test_intent.opt.train_reaction(
    IntentReaction([
        Action.image("test_image"), # send an image with name "test_image"
        Action.createParameter(parameterName="test_param", parameterValue=Action.get_keyword()), # create a parameter to store the latest message from the user
        Action.text("test param is " + Action.parameter("test_param")), # get the parameter and use it in a text,
    ])
)
```

## Create an object
Creating objects is similar to creating intents. First, create an Object instance with typed objects in its objects property (eg. ApiObject, ImageObject, ButtonObject etc.). Every typed object instances must be of the same type. Then, you can add the Object instance to the bot.
```python
test_image_object = Object(
    objectName="test_image",
    objects=[
        ImageObject(
            original_url="https://console.botnoi.ai/assets/botnoi-logo/botnoi.svg",
            preview_image_url="https://console.botnoi.ai/assets/botnoi-logo/botnoi.svg",
        )
    ]
)

test_bot.opt.create_object(test_image_object)
```

Or find an existing one by name
```python
test_image_object = test_bot.opt.find_object_with_name("test_image",type=ObjectType.image())
```