Legal_Expert_Contract_Advisor_Using_Precision_RAG

ระบบถาม & คำตอบ

ภาพรวม

โครงการนี้มีวัตถุประสงค์เพื่อพัฒนาระบบผู้เชี่ยวชาญด้านกฎหมายที่มีความแม่นยำสูงสำหรับการทำสัญญาและตอบโดยใช้ Generation Retrieval-Augmented Generation (RAG) ระบบใช้ประโยชน์จากเทคนิคการประมวลผลภาษาธรรมชาติขั้นสูง (NLP) เพื่อให้คำตอบที่ถูกต้องและตระหนักถึงบริบทเกี่ยวกับสัญญาทางกฎหมายและรวมรูปแบบภาษาที่ทรงพลังกับกลไกการดึงข้อมูลแบบกำหนดเองเพื่อให้คำตอบที่ถูกต้องและเกี่ยวข้องกับบริบท

สารบัญ

• ภาพรวม
• โครงสร้างโครงการ
• การติดตั้ง
• การใช้งาน
• การพัฒนา
• การประเมิน
• เทคนิคการเพิ่มประสิทธิภาพ
• การบริจาค
• ใบอนุญาต
• กิตติกรรมประกาศ
• ติดต่อ

คุณสมบัติ

• ท่อส่งข้อมูลการเรียกคืน (RAG) สำหรับการทำสัญญา Q&A
• ส่วนประกอบ Retriever และเครื่องกำเนิดไฟฟ้าที่ปรับแต่งได้
• กรอบการประเมินผลโดยใช้ตัวชี้วัด Ragas
• เทคนิคการเพิ่มประสิทธิภาพเพื่อประสิทธิภาพที่ดีขึ้น

โครงสร้างโครงการ

 Legal_Expert_Contract_Advisor_Using_Precision_RAG/
├── data/
│   ├── raw/
│   ├── processed/
│   └── evaluation/
├── notebooks/
│   ├── 1_data_exploration.ipynb
│   ├── 2_rag_implementation.ipynb
│   └── 3_evaluation_and_optimization.ipynb
├── src/
│   ├── data/
│   │   ├── __init__.py
│   │   ├── preprocess.py
│   │   └── load_data.py
│   ├── models/
│   │   ├── __init__.py
│   │   ├── retriever.py
│   │   └── generator.py
│   ├── evaluation/
│   │   ├── __init__.py
│   │   └── metrics.py
│   └── utils/
│       ├── __init__.py
│       └── helpers.py
├── tests/
│   ├── test_data.py
│   ├── test_models.py
│   └── test_evaluation.py
├── config.yaml
├── requirements.txt
├── setup.py
├── main.py
├── .gitignore
└── README.md

• data/ : มีไฟล์ข้อมูลดิบและประมวลผล
• notebooks/ : สมุดบันทึก Jupyter สำหรับการสำรวจการใช้งานและการประเมินผล
• src/ : ซอร์สโค้ดสำหรับระบบ RAG
  • data/ : การโหลดข้อมูลและสคริปต์การประมวลผลล่วงหน้า
  • models/ : การใช้งานแบบจำลองและเครื่องกำเนิดไฟฟ้า
  • evaluation/ : การประเมินผลการวัดและสคริปต์
  • utils/ : ฟังก์ชั่นและผู้ช่วยด้านสาธารณูปโภค
• tests/ : การทดสอบหน่วยสำหรับส่วนประกอบต่างๆ
• config.yaml : ไฟล์กำหนดค่าสำหรับการตั้งค่าโครงการ
• requirements.txt : รายการการพึ่งพาโครงการ
• setup.py : การตั้งค่าสคริปต์สำหรับโครงการ
• main.py : จุดเข้าหลักสำหรับการเรียกใช้ระบบ RAG

การติดตั้ง

1. โคลนที่เก็บ

git clone https://github.com/dev-abuke/Legal_Expert_Contract_Advisor_Using_Precision_RAG.git

2. นำทางไปยังไดเรกทอรีโครงการ

 cd Legal_Expert_Contract_Advisor_Using_Precision_RAG

3. สร้างสภาพแวดล้อมเสมือนจริง

python -m venv venv

4. เปิดใช้งานสภาพแวดล้อม

 source venv/bin/activate  # On Windows, use venvScriptsactivate

3. ติดตั้งการพึ่งพาที่ต้องการ:

pip install -r requirements.txt

การใช้งาน

1. เตรียมข้อมูลสัญญาของคุณและวางไว้ใน data/raw/ ไดเรกทอรี

2. ประมวลผลข้อมูลล่วงหน้า

python src/data/preprocess.py

3. เรียกใช้ระบบผ้าขี้ริ้ว

python main.py

4. ประเมินประสิทธิภาพของระบบ:

python src/evaluation/evaluate.py

การพัฒนา

• ใช้สมุดบันทึก Jupyter ใน notebooks/ ไดเรกทอรีสำหรับการสำรวจและการสร้างต้นแบบ
• ใช้ฟังก์ชั่นหลักในไดเรกทอรี src/
• เพิ่มการทดสอบหน่วยใน tests/ ไดเรกทอรี
• ใช้ config.yaml เพื่อจัดการการตั้งค่าโครงการ

การประเมิน

ประสิทธิภาพของระบบได้รับการประเมินโดยใช้ตัวชี้วัดต่อไปนี้

• ดึงความแม่นยำและการเรียกคืน
• คำตอบที่เกี่ยวข้อง
• ความถูกต้องตามข้อเท็จจริง
• การเชื่อมโยงการตอบสนอง

อ้างถึงสมุดบันทึกการประเมินผลเพื่อผลลัพธ์และการวิเคราะห์โดยละเอียด

เทคนิคการเพิ่มประสิทธิภาพ

โครงการนี้สำรวจเทคนิคการเพิ่มประสิทธิภาพที่หลากหลายรวมถึง

1. โมเดลการฝังขั้นสูงสำหรับการดึงข้อมูล
2. วิธีการค้นหาแบบไฮบริด
3. การขยายการสอบถาม
4. กลวิธี Chunking
5. วิศวกรรมที่รวดเร็ว

การบริจาค

ยินดีต้อนรับการมีส่วนร่วมในการปรับปรุงระบบ โปรดทำตามขั้นตอนเหล่านี้:

1. แยกที่เก็บ
2. สร้างสาขาใหม่ ( git checkout -b feature/your-feature )
3. ทำการเปลี่ยนแปลงของคุณและกระทำพวกเขา ( git commit -am 'Add new feature' )
4. ผลักดันไปยังสาขา ( git push origin feature/your-feature )
5. สร้างคำขอดึงใหม่

ใบอนุญาต

โครงการนี้ได้รับใบอนุญาตภายใต้ใบอนุญาต MIT - ดูไฟล์ใบอนุญาตสำหรับรายละเอียด

กิตติกรรมประกาศ

• 10 Academy สำหรับการให้โอกาสความท้าทายและการเรียนรู้
• Lizzyai สำหรับแรงบันดาลใจและคำแนะนำของโครงการ

ติดต่อ

สำหรับการสอบถามใด ๆ โปรดเปิดปัญหาเกี่ยวกับที่เก็บนี้หรือติดต่อ Abubeker Shamil