Update README.md

README.md

@@ -57,6 +57,32 @@ Score: {'The Frog Prince': {'The movie "The Princess and the Frog" is loosely ba
 '''
 ```
 
+#### Prompting LLM For Evaluation
+
+Note: The prompting function can be used for any prompting purposes.
+
+###### OpenAI
+```python
+from qa_metrics.prompt_llm import *
+set_openai_api_key(YOUR_OPENAI_KEY)
+prompt = 'question: What is the Capital of France?\nreference: Paris\ncandidate: The capital is Paris\nIs the candidate answer correct based on the question and reference answer? Please only output correct or incorrect.'
+prompt_gpt(prompt=prompt, model_engine='gpt-3.5-turbo', temperature=0.1, max_token=10)
+
+'''
+'correct'
+'''
+```
+
+###### Anthropic
+```python
+set_anthropic_api_key(YOUR_OPENAI_KEY)
+prompt_claude(prompt=prompt, model_engine='claude-v1', anthropic_version="2023-06-01", max_tokens_to_sample=100, temperature=0.7)
+
+'''
+'correct'
+'''
+```
+
 #### F1 Score
 ```python
 from qa_metrics.f1 import f1_match,f1_score_with_precision_recall