0.1.20 • Published 5 months ago

@eeacms/volto-chatbot v0.1.20

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

Volto Chatbot

Releases

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Volto add-on that integrates an AI-powered chatbot with a customizable interface and advanced settings to tailor its behavior and enhance user interactions.

Features

https://github.com/user-attachments/assets/f9b5f813-672f-4e4d-81d0-bf2aec35b587

The Volto Chatbot block allows the integration of an AI-powered chatbot into your Volto project. It offers a customizable interface and advanced settings to tailor the chatbot's behavior to your needs. Below is an overview of its features and configuration options.


Functionalities

PropertyDescriptionTypeDefault
assistantChoose from the list of available assistants configured in the application.Dropdown-
qgenAsistantIdSelect an assistant for generating related questions.Dropdown-
enableQgenToggle the generation of related questions.Booleanfalse
enableFeedbackEnable or disable thumbs up/down feedback for assistant responses.Booleantrue
placeholderPromptSet placeholder text for the chat input field.StringAsk a question
showAssistantTitleDisplay or hide the assistant's title in the chat interface.Booleantrue
showAssistantDescriptionDisplay or hide the assistant's description in the chat interface.Booleantrue
showAssistantPromptsShow or hide predefined prompts provided by the assistant.Booleantrue
chatTitleTitle assigned to saved chats, visible only in Danswer or analytics.StringOnline public chat
heightSet the height of the chat window using CSS dimensions (e.g., 500px, 70vh).String-
scrollToInputAutomatically scroll the page to focus on the chat input when interacting.Booleanfalse

Getting started

Try volto-chatbot with Docker

  git clone https://github.com/eea/volto-chatbot.git
  cd volto-chatbot
  make
  make start

Go to http://localhost:3000

Add volto-chatbot to your Volto project

  1. Make sure you have a Plone backend up-and-running at http://localhost:8080/Plone

    docker compose up backend
  2. Start Volto frontend

  • If you already have a volto project, just update package.json:

    "addons": [
        "@eeacms/volto-chatbot"
    ],
    
    "dependencies": {
        "@eeacms/volto-chatbot": "*"
    }
  • If not, create one:

    npm install -g yo @plone/generator-volto
    yo @plone/volto my-volto-project --canary --addon @eeacms/volto-chatbot
    cd my-volto-project
  1. Install new add-ons and restart Volto:

    yarn
    yarn start

Environment Configuration

To properly configure the middleware and authenticate with the Danswer service, ensure that the following environment variables are set:

Environment VariableDescription
DANSWER_URLThe base URL of the Danswer service (e.g., https://api.danswer.com).
DANSWER_USERNAMEUsername for authenticating with the Danswer service.
DANSWER_PASSWORDPassword for authenticating with the Danswer service.

Example .env File

Create a .env file in your project root with the following content:

DANSWER_URL=https://api.danswer.com
DANSWER_USERNAME=your_username
DANSWER_PASSWORD=your_password

If you encounter issues, double-check your .env configuration and ensure the Danswer service is accessible at the URL you’ve provided.

Release

See RELEASE.md.

How to contribute

See DEVELOP.md.

Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.

See LICENSE.md for details.

Funding

European Environment Agency (EU) de is European Environment Agency (EEA). All Rights Reserved.

See LICENSE.md for details.

Funding

European Environment Agency (EU)

0.1.20

5 months ago

0.1.10

11 months ago

0.1.11

9 months ago

0.1.12

9 months ago

0.1.13

8 months ago

0.1.14

7 months ago

0.1.15

7 months ago

0.1.16

7 months ago

0.1.8

11 months ago

0.1.17

6 months ago

0.1.18

6 months ago

0.1.19

5 months ago

0.1.9

11 months ago

0.1.7

1 year ago

0.1.6

1 year ago

0.1.5

1 year ago

0.1.4

1 year ago

0.1.3

1 year ago

0.1.2

1 year ago

0.1.1

1 year ago