Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
diptanu authored Oct 12, 2024
1 parent d59530e commit 9573b5a
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions examples/website_audio_summary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,25 @@ This project demonstrates how to build a website summarization pipeline using In
- Content summarization using OpenAI's GPT-4
- Text-to-speech generation using ElevenLabs


## How it Works

We define functions to do the following tasks -
1. **Website Scraping:**
- Uses `httpx` to fetch the content of a given URL.
2. **Content Summarization:**
- Utilizes OpenAI's GPT-4 to generate a concise summary of the website content.
3. **Text-to-Speech Generation:**
- Employs ElevenLabs' API to convert the summary into an audio file.

## Graph Structure

The functions are laid out in the graph as follows:

```
scrape_website -> summarize_website -> generate_tts
```

## Prerequisites

- Python 3.9+
Expand Down Expand Up @@ -83,25 +102,6 @@ This project demonstrates how to build a website summarization pipeline using In
python workflow.py --mode remote-run
```

## How it Works

1. **Website Scraping:**
- Uses `httpx` to fetch the content of a given URL.

2. **Content Summarization:**
- Utilizes OpenAI's GPT-4 to generate a concise summary of the website content.

3. **Text-to-Speech Generation:**
- Employs ElevenLabs' API to convert the summary into an audio file.

## Indexify Graph Structure

The project uses the following Indexify graph:

```
scrape_website -> summarize_website -> generate_tts
```

## Customization

- Modify the `url` variable in the `run_workflow()` function to summarize different websites.
Expand Down

0 comments on commit 9573b5a

Please sign in to comment.