From c2b521199c50f529e3e36ea067becd89a61cd8bc Mon Sep 17 00:00:00 2001
From: Erick Sosa Garcia <ericksosagarcias@gmail.com>
Date: Tue, 13 Feb 2024 20:16:47 -0400
Subject: [PATCH] fix: some errors in available llms examples (#544)
---
.../docs/modules/llms/available_llms/azure.md | 5 ++++-
.../modules/llms/available_llms/llama2.md | 5 ++++-
.../modules/llms/available_llms/mistral.md | 5 ++++-
.../modules/llms/available_llms/ollama.md | 19 ++++++++++++++++---
.../modules/llms/available_llms/openai.md | 5 ++++-
.../modules/llms/available_llms/portkey.md | 5 ++++-
.../modules/llms/available_llms/together.md | 5 ++++-
7 files changed, 40 insertions(+), 9 deletions(-)
diff --git a/apps/docs/docs/modules/llms/available_llms/azure.md b/apps/docs/docs/modules/llms/available_llms/azure.md
index f6ca3ef6a..d13f94317 100644
--- a/apps/docs/docs/modules/llms/available_llms/azure.md
+++ b/apps/docs/docs/modules/llms/available_llms/azure.md
@@ -50,7 +50,7 @@ const results = await queryEngine.query({
```ts
import {
- Anthropic,
+ OpenAI,
Document,
VectorStoreIndex,
serviceContextFromDefaults,
@@ -70,6 +70,9 @@ async function main() {
serviceContext,
});
+ // get retriever
+ const retriever = index.asRetriever();
+
// Create a query engine
const queryEngine = index.asQueryEngine({
retriever,
diff --git a/apps/docs/docs/modules/llms/available_llms/llama2.md b/apps/docs/docs/modules/llms/available_llms/llama2.md
index 65c26d627..ffcac13ac 100644
--- a/apps/docs/docs/modules/llms/available_llms/llama2.md
+++ b/apps/docs/docs/modules/llms/available_llms/llama2.md
@@ -59,7 +59,7 @@ const results = await queryEngine.query({
```ts
import {
- Anthropic,
+ LlamaDeuce,
Document,
VectorStoreIndex,
serviceContextFromDefaults,
@@ -79,6 +79,9 @@ async function main() {
serviceContext,
});
+ // get retriever
+ const retriever = index.asRetriever();
+
// Create a query engine
const queryEngine = index.asQueryEngine({
retriever,
diff --git a/apps/docs/docs/modules/llms/available_llms/mistral.md b/apps/docs/docs/modules/llms/available_llms/mistral.md
index a928d7548..81d17510a 100644
--- a/apps/docs/docs/modules/llms/available_llms/mistral.md
+++ b/apps/docs/docs/modules/llms/available_llms/mistral.md
@@ -41,7 +41,7 @@ const results = await queryEngine.query({
```ts
import {
- Anthropic,
+ MistralAI,
Document,
VectorStoreIndex,
serviceContextFromDefaults,
@@ -61,6 +61,9 @@ async function main() {
serviceContext,
});
+ // get retriever
+ const retriever = index.asRetriever();
+
// Create a query engine
const queryEngine = index.asQueryEngine({
retriever,
diff --git a/apps/docs/docs/modules/llms/available_llms/ollama.md b/apps/docs/docs/modules/llms/available_llms/ollama.md
index d92e2841f..9d690bc98 100644
--- a/apps/docs/docs/modules/llms/available_llms/ollama.md
+++ b/apps/docs/docs/modules/llms/available_llms/ollama.md
@@ -7,7 +7,10 @@ import { Ollama, serviceContextFromDefaults } from "llamaindex";
const ollamaLLM = new Ollama({ model: "llama2", temperature: 0.75 });
-const serviceContext = serviceContextFromDefaults({ llm: ollamaLLM });
+const serviceContext = serviceContextFromDefaults({
+ llm: ollamaLLM,
+ embedModel: ollamaLLM,
+});
```
## Load and index documents
@@ -38,18 +41,25 @@ const results = await queryEngine.query({
```ts
import {
- Anthropic,
+ Ollama,
Document,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
+import fs from "fs/promises";
+
async function main() {
// Create an instance of the LLM
const ollamaLLM = new Ollama({ model: "llama2", temperature: 0.75 });
+ const essay = await fs.readFile("./paul_graham_essay.txt", "utf-8");
+
// Create a service context
- const serviceContext = serviceContextFromDefaults({ llm: ollamaLLM });
+ const serviceContext = serviceContextFromDefaults({
+ embedModel: ollamaLLM, // prevent 'Set OpenAI Key in OPENAI_API_KEY env variable' error
+ llm: ollamaLLM,
+ });
const document = new Document({ text: essay, id_: "essay" });
@@ -58,6 +68,9 @@ async function main() {
serviceContext,
});
+ // get retriever
+ const retriever = index.asRetriever();
+
// Create a query engine
const queryEngine = index.asQueryEngine({
retriever,
diff --git a/apps/docs/docs/modules/llms/available_llms/openai.md b/apps/docs/docs/modules/llms/available_llms/openai.md
index 284e7d5a1..67b461205 100644
--- a/apps/docs/docs/modules/llms/available_llms/openai.md
+++ b/apps/docs/docs/modules/llms/available_llms/openai.md
@@ -42,7 +42,7 @@ const results = await queryEngine.query({
```ts
import {
- Anthropic,
+ OpenAI,
Document,
VectorStoreIndex,
serviceContextFromDefaults,
@@ -62,6 +62,9 @@ async function main() {
serviceContext,
});
+ // get retriever
+ const retriever = index.asRetriever();
+
// Create a query engine
const queryEngine = index.asQueryEngine({
retriever,
diff --git a/apps/docs/docs/modules/llms/available_llms/portkey.md b/apps/docs/docs/modules/llms/available_llms/portkey.md
index 7c7720f9f..1b3faed8f 100644
--- a/apps/docs/docs/modules/llms/available_llms/portkey.md
+++ b/apps/docs/docs/modules/llms/available_llms/portkey.md
@@ -40,7 +40,7 @@ const results = await queryEngine.query({
```ts
import {
- Anthropic,
+ Portkey,
Document,
VectorStoreIndex,
serviceContextFromDefaults,
@@ -62,6 +62,9 @@ async function main() {
serviceContext,
});
+ // get retriever
+ const retriever = index.asRetriever();
+
// Create a query engine
const queryEngine = index.asQueryEngine({
retriever,
diff --git a/apps/docs/docs/modules/llms/available_llms/together.md b/apps/docs/docs/modules/llms/available_llms/together.md
index 620adf8a9..b8bc507ba 100644
--- a/apps/docs/docs/modules/llms/available_llms/together.md
+++ b/apps/docs/docs/modules/llms/available_llms/together.md
@@ -40,7 +40,7 @@ const results = await queryEngine.query({
```ts
import {
- Anthropic,
+ TogetherLLM,
Document,
VectorStoreIndex,
serviceContextFromDefaults,
@@ -62,6 +62,9 @@ async function main() {
serviceContext,
});
+ // get retriever
+ const retriever = index.asRetriever();
+
// Create a query engine
const queryEngine = index.asQueryEngine({
retriever,
--
GitLab