Giter Club home page Giter Club logo

legal-information-retrieval's Introduction

Legal Information Retrieval System

Setup and Usage Instructions

Setting Up the Environment

  1. Data Acquisition: Begin by downloading all necessary data files from this link. Ensure that you have access to all the specified folders and files.
  2. Configuration Files: Obtain secrets.toml and .env files by contacting [email protected] for access to the necessary private keys and configuration settings. Once obtained, place the secrets.toml file inside the .streamlit directory, ensuring it resides at the same level as the gui, data, and .env files.
  3. Virtual Environment Creation: Set up a virtual environment to manage dependencies efficiently.
  4. Installing Dependencies: Install all required Python packages by running the following command in your terminal:
    pip install -r requirements.txt
    
  5. Launching the GUI: To start the graphical user interface, execute:
    streamlit run gui/main.py
    

System Architecture

For a visual representation of the system architecture, refer to the following image: Architecture.png. For an in-depth understanding, consult the accompanying detailed report.

Functionality and Examples

Legal Query Handling

The system is capable of answering legal queries specific to Vietnamese law, using the Zalo data set. It color-codes sources based on relevance, ranging from darkest (most relevant) to lightest (least relevant). We also employed technique for automatically removing highest unrelevant documents depend on answer and question to avoid too many reference chunks proposed. While answers are not always exact, this method of reference display significantly aids in verification and easier access to accurate information. Information snippets can be re-ranked for future use, as detailed in the report. Time to response: 5~10s

Examples:

  • Example 1: Demonstrates filtering out irrelevant or non-legal queries. -Example 2: Shows the system providing precise answers with high relevance.
  • Example 3: Illustrates the system's capability to maintain and understand the context of an ongoing conversation, enhancing user experience.
  • Example 4: The system also suggests related questions to extend the discussion, with some suggestions being random to broaden the conversation scope.

Feedback Mechanism

The system includes a feedback option with a "thumbs up" button, allowing users to contribute to Reinforcement Learning with Human Feedback (RLHF) and other model improvements. However, this feature is not fully utilized currently.

Each of these functionalities is designed to enhance the legal information retrieval process, making it more efficient and user-friendly.

legal-information-retrieval's People

Contributors

thiemcun203 avatar vincent-doan avatar

Stargazers

Viri Nguyen avatar tyuukau avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.