Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ata-turhan/delta-chatbot

It is a chatbot for answering questions with information in documents.
https://github.com/ata-turhan/delta-chatbot

langchain llm openai python streamlit

Last synced: 11 days ago
JSON representation

It is a chatbot for answering questions with information in documents.

Host: GitHub
URL: https://github.com/ata-turhan/delta-chatbot
Owner: ata-turhan
License: gpl-3.0
Created: 2022-12-23T20:30:08.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-08-28T17:29:02.000Z (over 1 year ago)
Last Synced: 2024-04-09T01:04:19.985Z (9 months ago)
Topics: langchain, llm, openai, python, streamlit
Language: Python
Homepage:
Size: 8.31 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.MD
- License: LICENSE

Awesome Lists containing this project

README

        ---



[![Sourcery](https://img.shields.io/badge/Sourcery-enabled-brightgreen)](https://sourcery.ai)

[![Poetry](https://img.shields.io/badge/packaging-poetry-cyan.svg)](https://python-poetry.org/)

[![GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

[![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)





# Delta ChatBot

This is a chatbot that answers questions based on uploaded documents.

[WebApp Link](https://delta-chat-bot.streamlit.app/)

## Table of Contents

- [Prerequisites](#prerequisites)

- [Installation](#installation)

- [Usage](#usage)

## Prerequisites

Before setting up the project, ensure that you have the following prerequisites installed on your machine:

- Python (version 3.10.10):

(https://www.python.org/downloads/)

- Poetry (version 1.4.0):

(https://python-poetry.org/docs/#installation)

## Installation

1. Clone the project repository:

```

git clone https://github.com/olympian-21/Delta-Chatbot.git

```

2. Navigate to the project directory:

```

cd delta-chatbot

```

3. Install project dependencies using Poetry:

```

poetry install

```

This command will create a virtual environment and install all the necessary dependencies specified in the `pyproject.toml` file.

## Usage

1. Activate the virtual environment created by Poetry:

```

poetry shell

```

2. Run the project:

```

streamlit run "delta-chatbot/app.py"

```

## Contributing

If you would like to contribute to this project, follow the guidelines below:

1. Fork the repository and clone it locally.

2. Create a new branch for your feature or bug fix:

   ```

   git checkout -b feature/your-feature

   ```

3. Make your changes and commit them with descriptive commit messages.

4. Push your changes to your forked repository:

   ```

   git push origin feature/your-feature

   ```

5. Open a pull request in the original repository, describing your changes in detail.

## License

GPL v3

---