Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
penguine-ip committed Feb 3, 2024
1 parent 8c99c56 commit 49b165b
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/docs/metrics-ragas.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,16 @@ There are three optional parameters when creating a `RagasMetric`:

- [Optional] `threshold`: a float representing the minimum passing threshold, defaulted to 0.5.
- [Optional] `model`: a string specifying which of OpenAI's GPT models to use, **OR** any one of langchain's [chat models](https://python.langchain.com/docs/integrations/chat/) of type `BaseChatModel`. Defaulted to 'gpt-3.5-turbo'.

:::note
You can also choose to import and evaluate using each metric individually:

```python
from deepeval.metrics.ragas import RAGASAnswerRelevancyMetric
from deepeval.metrics.ragas import RAGASFaithfulnessMetric
from deepeval.metrics.ragas import RAGASContextualRecallMetric
from deepeval.metrics.ragas import RAGASContextualPrecisionMetric
```

These metrics accept the same arguments as the `RagasMetric`.
:::

0 comments on commit 49b165b

Please sign in to comment.