Skip to content

Commit c455c38

Browse files
authored
docs: clean get-started (#1816)
1 parent 0cc71de commit c455c38

File tree

5 files changed

+9
-90
lines changed

5 files changed

+9
-90
lines changed

docs/getstarted/evals.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,13 +171,13 @@ Viewing the sample-level results in a CSV file, as shown above, is fine for quic
171171

172172
For this you may sign up and setup [app.ragas.io]() easily. If not, you may use any alternative tools available to you.
173173

174-
In order to use the [app.ragas.io](http://app.ragas.io) dashboard, you need to have an account on [app.ragas.io](https://app.ragas.io/). If you don't have one, you can sign up for one [here](https://app.ragas.io/login). You will also need to generate a [Ragas API key](https://app.ragas.io/dashboard/settings/app-tokens).
174+
In order to use the [app.ragas.io](http://app.ragas.io) dashboard, you need to have an account on [app.ragas.io](https://app.ragas.io/). If you don't have one, you can sign up for one [here](https://app.ragas.io/login). You will also need to generate a [Ragas APP token](https://app.ragas.io/dashboard/settings/app-tokens).
175175

176176
Once you have the API key, you can use the `upload()` method to export the results to the dashboard.
177177

178178
```python
179179
import os
180-
os.environ["RAGAS_API_KEY"] = "your_api_key"
180+
os.environ["RAGAS_APP_TOKEN"] = "your_app_token"
181181
```
182182

183183
Now you can view the results in the dashboard by following the link in the output of the `upload()` method.

docs/getstarted/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ If you have any questions about Ragas, feel free to join and ask in the `#questi
1212
Let's get started!
1313

1414
- [Evaluate your first AI app](./evals.md)
15-
- [Run ragas metrics for evaluating RAG](rag_evaluation.md)
15+
- [Run ragas metrics for evaluating RAG](rag_eval.md)
1616
- [Generate test data for evaluating RAG](rag_testset_generation.md)

docs/getstarted/rag_eval.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ from ragas.llms import LangchainLLMWrapper
165165

166166

167167
evaluator_llm = LangchainLLMWrapper(llm)
168-
from ragas.metrics import LLMContextRecall, LLMContextPrecisionWithReference, Faithfulness, FactualCorrectness
168+
from ragas.metrics import LLMContextRecall, Faithfulness, FactualCorrectness
169169

170170
result = evaluate(dataset=evaluation_dataset,metrics=[LLMContextRecall(), Faithfulness(), FactualCorrectness()],llm=evaluator_llm)
171171
result
@@ -180,19 +180,19 @@ Output
180180

181181
Once you have evaluated, you may want to view, analyse and share results. This is important to interpret the results and understand the performance of your RAG system. For this you may sign up and setup [app.ragas.io]() easily. If not, you may use any alternative tools available to you.
182182

183-
In order to use the [app.ragas.io](http://app.ragas.io) dashboard, you need to have an account on [app.ragas.io](https://app.ragas.io/). If you don't have one, you can sign up for one [here](https://app.ragas.io/login). You will also need to generate a [Ragas API key](https://app.ragas.io/dashboard/settings/app-tokens).
183+
In order to use the [app.ragas.io](http://app.ragas.io) dashboard, you need to have an account on [app.ragas.io](https://app.ragas.io/). If you don't have one, you can sign up for one [here](https://app.ragas.io/login). You will also need to generate a [Ragas APP token](https://app.ragas.io/dashboard/settings/app-tokens).
184184

185185
Once you have the API key, you can use the `upload()` method to export the results to the dashboard.
186186

187187
```python
188188
import os
189-
os.environ["RAGAS_API_KEY"] = "your_api_key"
189+
os.environ["RAGAS_APP_TOKEN"] = "your_app_token"
190190
```
191191

192192
Now you can view the results in the dashboard by following the link in the output of the `upload()` method.
193193

194194
```python
195-
results.upload()
195+
result.upload()
196196
```
197197

198198
![](rag_eval.gif)

docs/getstarted/rag_evaluation.md

Lines changed: 0 additions & 81 deletions
This file was deleted.

docs/getstarted/rag_testset_generation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@ dataset.to_pandas()
5959

6060
You can also use other tools like [app.ragas.io](https://app.ragas.io/) or any other similar tools available for you in the [Integrations](../howtos/integrations/index.md) section.
6161

62-
In order to use the [app.ragas.io](https://app.ragas.io/) dashboard, you need to have an account on [app.ragas.io](https://app.ragas.io/). If you don't have one, you can sign up for one [here](https://app.ragas.io/login). You will also need to have a [Ragas API key](https://app.ragas.io/settings/api-keys).
62+
In order to use the [app.ragas.io](https://app.ragas.io/) dashboard, you need to have an account on [app.ragas.io](https://app.ragas.io/). If you don't have one, you can sign up for one [here](https://app.ragas.io/login). You will also need to have a [Ragas APP token](https://app.ragas.io/settings/api-keys).
6363

6464
Once you have the API key, you can use the `upload()` method to export the results to the dashboard.
6565

6666
```python
6767
import os
68-
os.environ["RAGAS_API_KEY"] = "your_api_key"
68+
os.environ["RAGAS_APP_TOKEN"] = "your_app_token"
6969
dataset.upload()
7070
```
7171

0 commit comments

Comments
 (0)