Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nitin-sagar-b/sparkprompt

SparkPrompt is a tool that generates, evaluates, and refines prompts using LangChain and the Gemini API. It provides precise, context-aware prompts and feedback, streamlining the prompt creation process for various domains.
https://github.com/nitin-sagar-b/sparkprompt

gemini-api genai-usecase langchain prompt-engineering prompt-writing python3

Last synced: 21 days ago
JSON representation

Host: GitHub
URL: https://github.com/nitin-sagar-b/sparkprompt
Owner: Nitin-Sagar-B
License: mit
Created: 2024-08-10T14:22:23.000Z (5 months ago)
Default Branch: main
Last Pushed: 2024-08-10T14:48:46.000Z (5 months ago)
Last Synced: 2024-08-10T15:41:00.038Z (5 months ago)
Topics: gemini-api, genai-usecase, langchain, prompt-engineering, prompt-writing, python3
Language: Python
Homepage: https://sparkprompt.streamlit.app/
Size: 15.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# SparkPrompt

**Spark Prompt** is a cutting-edge tool designed to enhance the process of creating, evaluating, and refining problem statements and prompts. Powered by LangChain and the Gemini API, Spark Prompt provides a seamless experience for generating precise and contextually relevant prompts across various domains.

Live Demo: SparkPrompt

## 🌟 Features

- **📝 Problem Statement Generation**: Automatically crafts concise and relevant problem statements based on your selected domain and skills.
- **🔍 Prompt Evaluation**: Delivers detailed feedback on user-generated prompts, evaluating their relevance, clarity, and completeness.
- **✍️ Prompt Refinement**: Suggests improvements to enhance the quality and effectiveness of your prompts.
- **🖥️ Interactive Interface**: Provides a user-friendly web interface for real-time interaction and feedback.

## 🚀 Getting Started

Follow these steps to set up and use Spark Prompt:

### 🛠️ Prerequisites

- Python 3.x
- Streamlit
- LangChain
- Gemini API key

### 📥 Installation

1. **Clone the Repository**:

```bash
git clone https://github.com/your-username/spark-prompt.git
```

2. **Navigate to the Project Directory**:

```bash
cd spark-prompt
```

3. **Install the Required Python Packages**:

```bash
pip install -r requirements.txt
```

4. **Set Up Your Google API Key**:

```bash
export GOOGLE_API_KEY='your_google_api_key_here'
```

### ▶️ Usage

1. **Run the Application**:

```bash
streamlit run app.py
```

2. **Access the Tool**: Open your web browser and go to [http://localhost:8501](http://localhost:8501) to start using Spark Prompt.

### 📋 How It Works

- **Generate Problem Statements**: Enter the domain and skills to generate a problem statement tailored to your requirements.
- **Evaluate Prompts**: Submit prompts to receive feedback on their effectiveness and relevance.
- **Refine Prompts**: Get suggestions to improve your prompts based on the generated problem statement.

## 🎯 Significance

Spark Prompt is designed to streamline and improve the prompt creation process. By leveraging advanced AI techniques, it ensures that prompts are not only relevant but also highly effective in addressing specific problem statements. This tool is ideal for educators, researchers, and professionals who need to craft high-quality prompts for various applications.

## 💡 Contributing

We welcome contributions to Spark Prompt! To contribute:

1. **Fork the Repository**.
2. **Create a New Branch**.
3. **Make Your Changes**.
4. **Submit a Pull Request**.

Please refer to our [contributing guidelines](CONTRIBUTING.md) for more details.

## 📝 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.

## 📬 Contact

For questions or support, feel free to reach out to us on [Discord](https://discord.gg/HKscyfKb).
---