Skip to content

Commit

Permalink
Merge pull request #2 from guardrails-ai/qa_relevance_llm_eval_fix
Browse files Browse the repository at this point in the history
Format README to template
  • Loading branch information
CalebCourier authored Jul 30, 2024
2 parents 16e7b30 + 27d824b commit 5e99c20
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
## Overview

| Developed by | Guardrails AI |
| --- | --- |
| Date of development | Feb 15, 2024 |
| Validator type | Chatbots, QA |
| Blog | - |
| Blog | |
| License | Apache 2 |
| Input/Output | Output |

Expand All @@ -16,14 +15,16 @@ This validator checks whether an answer is relevant to the question asked by ask

The primary intended uses is for building chatbots, and verifying answer relevance for chatbots.

### Resources required
### Requirements

* Dependencies: Foundation model access (any LLM provider supported by LiteLLM)
* Dependencies:
- Foundation model access (any LLM provider supported by LiteLLM)
- guardrails-ai>=0.4.0

## Installation

```bash
guardrails hub install hub://guardrails/qa_relevance_llm_eval
$ guardrails hub install hub://guardrails/qa_relevance_llm_eval
```

## Usage Examples
Expand Down Expand Up @@ -72,7 +73,7 @@ Output:
Validation failed for field with errors: The LLM says 'No'. The validation failed.
```

## API Reference
# API Reference

**`__init__(self, llm_callable="gpt-3.5-turbo", on_fail="noop")`**
<ul>
Expand Down

0 comments on commit 5e99c20

Please sign in to comment.