call-transcript: A JavaScript repository from ApoorvTyagi

Project Description

This application generates, summarizes, and answers questions based on sales call transcripts using OpenAI's API. It saves transcripts to both text files and a MongoDB database for future data retrieval.

The application also supports multi-language feature, allowing for the generation, summarization, and answering of call transcripts in the language of your choice.

The app is structured into separate modules following software engineering principles, making it modular, scalable, and easy to maintain.

Features

Generate Transcript: Creates a realistic sales call transcript and saves it to MongoDB and as a text file to the root directory.
Summarize Transcript: Summarizes & extracts key points from the saved transcript file.
Answer Question: Answers questions based on the transcript content.

Folder Structure

src
├── config
│   └── config.js           # Environment configuration file
├── database
│   ├── connection.js       # MongoDB connection setup
│   └── repository.js       # Database access layer
├── models
│   └── transcript.js       # Mongoose schema for transcripts
├── services
│   ├── analyze.js          # Summarizes transcript content
│   ├── answer.js           # Answers questions based on transcript
│   ├── openai.js           # Wrapper functions for OpenAI API
│   └── transcript.js       # Handles transcript generation and saving
└── index.js                # Main application entry point
tests
└── test.js                 # Test file
.env                        # Environment variables file

Setup Instructions

Clone the Repository

git clone <repository-url>
cd call-Transcript

Install Dependencies

npm i

Set Up Environment Variables

MONGODB_URI=<Your MongoDB connection string>
OPENAI_API_KEY=<Your OpenAI API key>

Create a .env file in the root directory and add the above variables in it.

Start MongoDB

Make sure MongoDB is running. This can be locally or via a cloud provider like MongoDB Atlas.

Run the Application

Use the commands below to generate, summarize, or answer questions about a transcript.

Usage Guide

Run the application with the following commands:

Generate Transcript

node src/index.js generate <language>

<language>: The language in which you want to generate the transcript.

This command generates a transcript and saves it as a file and in the database.

Summarize Transcript

node src/index.js summarize <language> <fileName>

<language>: The language in which you want to generate the summary.
<fileName>: The name of the transcript file you want to summarize. The fileName is also returned by generateTranscript() called in previous step.

This will extract all the key points from the given transcript.

Answer Questions

node src/index.js answer <language> <fileName> <question>

<language>: The language in which you want to generate the answer for your question.
<fileName>: The name of the transcript file you want to query.
<question>: The question you want to ask based on the transcript content.

This will return an answer for the given question.

Running Test Cases

To run the test cases, use the following command:

npm run test