https://github.com/telexintegrations/legaldoc-ai-summarizer

A Telex Modifier Integration that summarizes text messages, uploaded files (PDF and DOCX), and provides legal assistance via `/legal` commands.
https://github.com/telexintegrations/legaldoc-ai-summarizer

Last synced: over 1 year ago
JSON representation

A Telex Modifier Integration that summarizes text messages, uploaded files (PDF and DOCX), and provides legal assistance via `/legal` commands.

• Host: GitHub
• URL: https://github.com/telexintegrations/legaldoc-ai-summarizer
• Owner: telexintegrations
• License: mit
• Created: 2025-02-22T08:47:32.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-22T17:26:55.000Z (over 1 year ago)
• Last Synced: 2025-02-22T18:18:56.966Z (over 1 year ago)
• Language: TypeScript
• Homepage: https://legal-doc-ai-summarizer.vercel.app
• Size: 72.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# LegalAidSummaryBot

A Telex Modifier Integration that summarizes text messages, uploaded files (PDF and DOCX), and provides legal assistance via `/legal` commands.

## Description

This integration enhances Telex channels by:

- Summarizing text messages and files (`.pdf`, `.docx`) using Hugging Face’s `facebook/bart-large-cnn`.

- Providing legal answers via `deepset/roberta-base-squad2`.

## Prerequisites

- Node.js (LTS)

- Git

- Hugging Face API Token

## Setup

1. Clone: `git clone https://github.com/telexintegrations/LegalDoc-AI-Summarizer.git`

2. Install: `npm install`

3. Configure `.env`: `HUGGING_FACE_TOKEN=your_token_here`

4. Start: `npm start`

## Testing Locally

- Use Postman with `http://localhost:5577/webhook`.

- Examples in README (from previous versions).

## Deployment

- **Vercel URL**: `https://legaldoc-ai-summarizer.onrender.com/webhookk`

- **integration.json URL**: `https://raw.githubusercontent.com/telexintegrations/LegalDoc-AI-Summarizer/main/integration.json`

- **Steps**:

  1. Deployed with Render (Build Command: `npm install && npm run build`, Start Command: `node ./dist/index.js`).

  2. Set `HUGGING_FACE_TOKEN` in Render Environment Variables.

## Screenshots

- **Text Summary**: ![Text Summary](screenshots/text-summary.png)

- **PDF Summary**: ![PDF Summary](screenshots/pdf-summary.png)

- **Chatbot Response**: ![Chatbot Response](screenshots/chatbot-response.png)

[Paste your current README.md content, adding:]\n\n## Telex Testing\n- Tested in Telex test organization with channel ID: [your-telex-channel-id].\n- Webhook URL: https://ping.telex.im/v1/webhooks/0195387e-00d5-733c-b972-d824624c6dbd.\n