From 32ad0992cf4cd3bb4acb89469c662af45da9d1be Mon Sep 17 00:00:00 2001
From: Talha Jubair Siam <65123233+tsensei@users.noreply.github.com>
Date: Mon, 10 Jun 2024 19:19:06 +0600
Subject: [PATCH] docs : fix correctness and relevancy example (#913)
---
apps/docs/docs/modules/evaluation/modules/correctness.md | 4 ++--
apps/docs/docs/modules/evaluation/modules/relevancy.md | 8 +++++++-
2 files changed, 9 insertions(+), 3 deletions(-)
diff --git a/apps/docs/docs/modules/evaluation/modules/correctness.md b/apps/docs/docs/modules/evaluation/modules/correctness.md
index 0e425a291..eec2361f0 100644
--- a/apps/docs/docs/modules/evaluation/modules/correctness.md
+++ b/apps/docs/docs/modules/evaluation/modules/correctness.md
@@ -21,7 +21,7 @@ export OPENAI_API_KEY=your-api-key
Import the required modules:
```ts
-import { CorrectnessEvaluator, OpenAI, Settings } from "llamaindex";
+import { CorrectnessEvaluator, OpenAI, Settings, Response } from "llamaindex";
```
Let's setup gpt-4 for better results:
@@ -45,7 +45,7 @@ const evaluator = new CorrectnessEvaluator();
const result = await evaluator.evaluateResponse({
query,
- response,
+ response: new Response(response),
});
console.log(
diff --git a/apps/docs/docs/modules/evaluation/modules/relevancy.md b/apps/docs/docs/modules/evaluation/modules/relevancy.md
index 7da066bea..fcf70f6c4 100644
--- a/apps/docs/docs/modules/evaluation/modules/relevancy.md
+++ b/apps/docs/docs/modules/evaluation/modules/relevancy.md
@@ -21,7 +21,13 @@ export OPENAI_API_KEY=your-api-key
Import the required modules:
```ts
-import { RelevancyEvaluator, OpenAI, Settings } from "llamaindex";
+import {
+ RelevancyEvaluator,
+ OpenAI,
+ Settings,
+ Document,
+ VectorStoreIndex,
+} from "llamaindex";
```
Let's setup gpt-4 for better results:
--
GitLab