qornanali / faq-bot Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 2.0 2.41 MB

A messenger bot + wit.ai to help answer your customer's frequently asked question.

License: MIT License

Ruby 100.00%

rails ruby wit-ai messenger-bot messenger-platform

faq-bot's Introduction

FAQ-bot

🇮🇩 Versi Indonesia

FAQ-bot adalah bot messenger yang membantu pagemu menjawab pertanyaan-pertanyaan yang sering dilontarkan oleh pengguna.

Bot ini dibuat untuk mengikuti Facebook developer circle community challenge 2020. Isi dari botnya dirancang agar menjawab pertanyaan-pertanyaan yang sering dilontarkan tentang challenge tersebut.

Karena bot ini belum dirilis, kalau kamu ingin mencoba sample dari FAQ-bot https://m.me/askmeforfaq, kamu bisa menghubungi kita untuk meminta aksesnya.

Daftar Tutorial

🇬🇧 English Version

FAQ-bot is bot messenger that helps your page to answer frequently asked questions (FAQ) by user.

This bot is made to join Facebook developer circle community challenge 2020. The contents is designed to answer the freqeuently asked questions (FAQ) about Facebook developer circle community challenge 2020.

Because this bot isn't published yet, if you want to try the FAQ-bot sample https://m.me/askmeforfaq, you can contact us to request for access.

Tutorial

Author

Ali Qornan Muhammad Jafar

📌 Bandung, Indonesia

Linkedin | Blog

faq-bot's People

Contributors

Stargazers

Watchers

Forkers

mhmmdjafarg fgarnadi

faq-bot's Issues

Create tutorial in English

To provide information on how we build this project, please document it on the following files:

- README.md
- docs/en/...

Add spec and integration spec

Add internal endpoint to crud answer

Currently, we assign answers via rails console and it obviously not a good approach.

Please create new endpoints for this contract:

For now, the token in basic authorization will be compared to the generated token from the user and password in the config.
POST /internal/v1/answers
PATCH /internal/v1/answers/:id
GET /internal/v1/answers?page=1&limit=5
GET /internal/v1/answers/:id
DELETE /internal/v1/answers/:id

Messenger URL is not working in README

Messenger url in README is not working. Please fix it.

You can put https:// as the prefix of the URL.

Link in author is broken

https://github.com/qornanali/faq-bot#author

Add authorization in webhook

In order to prevent malicious requests, please modify the current webhook URL.

From /webhook to /v1/external/messenger/webhook?access_token=<access_token> where access_token is configurable from ENV for now.

Example curl

curl --location --request POST 'https://localhost:3000/external/messenger/v1/webhook?access_token=foo' \
--header 'Content-Type: application/json' \
--data-raw '{
    "object": "page",
    "entry": [
        {
            "id": "107461401142256",
            "time": 1602923843364,
            "messaging": [
                {
                    "sender": {
                        "id": "3394010770691329"
                    },
                    "recipient": {
                        "id": "107461401142256"
                    },
                    "timestamp": 1602923843223,
                    "message": {
                        "mid": "m_sFrBBrkrx2LmF8YZSBf7WeqfkEM-NXTTk34MVB5g2wYZUTOUt4RRD2EWhrrCyy4O86A6bj4NfeKid_R2johmBA",
                        "text": "kartu prakerja",
                        "nlp": {
                            "intents": [
                                {
                                    "id": "653269161996408",
                                    "name": "Tanya_program",
                                    "confidence": 0.9
                                }
                            ],
                            "entities": {
                                "nama_program:nama_program": [
                                    {
                                        "id": "387471645725440",
                                        "name": "nama_program",
                                        "role": "nama_program",
                                        "start": 0,
                                        "end": 14,
                                        "body": "kartu prakerja",
                                        "confidence": 0.9566,
                                        "entities": [],
                                        "value": "Kartu Prakerja",
                                        "type": "value"
                                    }
                                ]
                            },
                            "traits": {
                                "wit$sentiment": [
                                    {
                                        "id": "5ac2b50a-44e4-466e-9d49-bad6bd40092c",
                                        "value": "neutral",
                                        "confidence": 0.536
                                    }
                                ]
                            },
                            "detected_locales": [
                                {
                                    "locale": "id_ID",
                                    "confidence": 0.9685
                                }
                            ]
                        }
                    }
                }
            ]
        }
    ]
}'

If the incoming request has a blank access_token or incorrect, it should response with body:

FAILED

and http status 401 unauthorized.