Metadata-Version: 2.1
Name: prompt-evaluator
Version: 0.1.7
Summary: A package to evaluate prompts using OpenAI and google models
Home-page: https://github.com/akshaytheau/prompt_evaluator
Author: Akshay Ugale
Author-email: akshay.ugale88@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: openai
Requires-Dist: tiktoken
Requires-Dist: google.generativeai

# Prompt Evaluator

`prompt_evaluator` is a Python package that evaluates prompts using OpenAI and google models based on criteria like clarity, specificity, relevance, and more.

It can do below tasks.

1) prompt evaluation 

```bash
from prompt-evaluator import PromptEvaluator
evaluator = PromptEvaluator(openai_api_key="your_api_key",model="model_name")
evaluator.evaluate_prompt(model="model_name",prompt=prompt)
```

2) Finding the number of tokens in prompt.

```bash
from prompt-evaluator import PromptEvaluator
evaluator = PromptEvaluator(openai_api_key="your_api_key",model="model_name")
evaluator.token_length(prompt,model="model_name")
```

3) Prompt enhancement as per the use-case - In dev.
4) Prompt token reducer to lower the prompt tokens - In dev.

## Installation

```bash
pip install prompt_evaluator
