Compare commits

...

37 Commits

Author SHA1 Message Date
Alex Yang 2f4593b78d fix: only export settings 2024-04-01 13:23:51 -05:00
Alex Yang f2cfb393e7 fix: rename path 2024-04-01 13:21:16 -05:00
Alex Yang 74624a318c Merge branch 'main' into feat/global-settings 2024-04-01 13:16:42 -05:00
Alex Yang 18283aac1b fix: rename api 2024-04-01 13:15:25 -05:00
Alex Yang bfd7e936fb fix: rename api 2024-04-01 13:14:45 -05:00
Alex Yang 20ff829acb Merge remote-tracking branch 'upstream/main' into feat/global-settings
# Conflicts:
#	examples/readers/src/csv.ts
#	examples/recipes/cost-analysis.ts
#	packages/core/package.json
#	packages/core/src/indices/vectorStore/index.ts
2024-04-01 13:12:04 -05:00
Alex Yang 85dab9085c fix: test 2024-03-31 17:55:25 -05:00
Alex Yang a2b7eb0155 fix: code 2024-03-31 17:54:11 -05:00
Alex Yang d909b6a8d6 fix: circular deps 2024-03-31 17:23:17 -05:00
Alex Yang 99c531edee fix: use private field 2024-03-31 16:50:19 -05:00
Alex Yang 117ad026c0 fix: api 2024-03-31 16:41:16 -05:00
Alex Yang 1c068ef14a fix: improve Settings 2024-03-31 16:02:59 -05:00
Alex Yang a5dd678e13 Merge remote-tracking branch 'upstream/main' into feat/global-settings 2024-03-31 15:51:53 -05:00
Emanuel Ferreira 7d32130dfe wip 2024-03-27 22:55:11 -03:00
Emanuel Ferreira 7d0a7bfdf8 docs 2024-03-27 20:41:48 -03:00
Emanuel Ferreira 3f60cdf52a wip 2024-03-27 19:45:38 -03:00
Emanuel Ferreira c17f2bb842 wip 2024-03-27 19:40:14 -03:00
Emanuel Ferreira 39310e5eca wip 2024-03-27 19:36:34 -03:00
Emanuel Ferreira da047a339b wip 2024-03-27 18:13:03 -03:00
Emanuel Ferreira 279f43c91c chore: optional parameters 2024-03-27 17:45:37 -03:00
Emanuel Ferreira c0c890d502 wip 2024-03-27 17:36:14 -03:00
Emanuel Ferreira 683d21db7c wip 2024-03-27 16:24:51 -03:00
Emanuel Ferreira 84acec958c wip 2024-03-27 16:22:24 -03:00
Emanuel Ferreira c2fa0faa00 update more examples 2024-03-27 16:17:26 -03:00
Emanuel Ferreira 228978d5f4 wip 2024-03-27 16:06:11 -03:00
Emanuel Ferreira 0fb04be117 chore: remove service context 2024-03-27 14:48:49 -03:00
Emanuel Ferreira c9fc69760c wip 2024-03-27 14:43:23 -03:00
Emanuel Ferreira 95a78fc7c2 chore: remove get service context 2024-03-27 14:40:08 -03:00
Emanuel Ferreira 406cec7a19 chore: non global support 2024-03-26 20:18:43 -03:00
Emanuel Ferreira 0cf872b329 fix: circular dependency 2024-03-26 16:32:25 -03:00
Emanuel Ferreira bded330c38 chore: update example 2024-03-26 16:24:27 -03:00
Emanuel Ferreira ac5a583d01 chore: update example 2024-03-26 16:12:33 -03:00
Emanuel Ferreira b63c0597ac wip 2024-03-26 15:50:56 -03:00
Emanuel Ferreira 91e98a043e wip 2024-03-26 15:46:18 -03:00
Emanuel Ferreira 669a4b44b1 wip 2024-03-26 13:30:46 -03:00
Emanuel Ferreira 778ab41f74 wip 2024-03-26 12:53:05 -03:00
Emanuel Ferreira 2384f8bbee feat: initial global settings 2024-03-26 12:24:59 -03:00
92 changed files with 788 additions and 919 deletions
@@ -33,7 +33,7 @@ import {
SimpleToolNodeMapping,
SummaryIndex,
VectorStoreIndex,
serviceContextFromDefaults,
Settings,
storageContextFromDefaults,
} from "llamaindex";
```
@@ -147,12 +147,10 @@ for (const title of wikiTitles) {
We will be using gpt-4 for this example and we will use the `StorageContext` to store the documents in-memory.
```ts
const llm = new OpenAI({
Settings.llm = new OpenAI({
model: "gpt-4",
});
const ctx = serviceContextFromDefaults({ llm });
const storageContext = await storageContextFromDefaults({
persistDir: "./storage",
});
@@ -189,14 +187,12 @@ for (const title of wikiTitles) {
// create the vector index for specific search
const vectorIndex = await VectorStoreIndex.init({
serviceContext: serviceContext,
storageContext: storageContext,
nodes,
});
// create the summary index for broader search
const summaryIndex = await SummaryIndex.init({
serviceContext: serviceContext,
nodes,
});
@@ -278,7 +274,6 @@ const objectIndex = await ObjectIndex.fromObjects(
toolMapping,
VectorStoreIndex,
{
serviceContext,
storageContext,
},
);
@@ -3,17 +3,14 @@
To use HuggingFace embeddings, you need to import `HuggingFaceEmbedding` from `llamaindex`.
```ts
import { HuggingFaceEmbedding, serviceContextFromDefaults } from "llamaindex";
import { HuggingFaceEmbedding, Settings } from "llamaindex";
const huggingFaceEmbeds = new HuggingFaceEmbedding();
const serviceContext = serviceContextFromDefaults({ embedModel: openaiEmbeds });
// Update Embed Model
Settings.embedModel = new HuggingFaceEmbedding();
const document = new Document({ text: essay, id_: "essay" });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
const queryEngine = index.asQueryEngine();
@@ -29,8 +26,8 @@ If you're not using a quantized model, set the `quantized` parameter to `false`.
For example, to use the not quantized `BAAI/bge-small-en-v1.5` model, you can use the following code:
```
const embedModel = new HuggingFaceEmbedding({
```ts
Settings.embedModel = new HuggingFaceEmbedding({
modelType: "BAAI/bge-small-en-v1.5",
quantized: false,
});
@@ -3,21 +3,16 @@
To use MistralAI embeddings, you need to import `MistralAIEmbedding` from `llamaindex`.
```ts
import { MistralAIEmbedding, serviceContextFromDefaults } from "llamaindex";
import { MistralAIEmbedding, Settings } from "llamaindex";
const mistralEmbedModel = new MistralAIEmbedding({
// Update Embed Model
Settings.embedModel = new MistralAIEmbedding({
apiKey: "<YOUR_API_KEY>",
});
const serviceContext = serviceContextFromDefaults({
embedModel: mistralEmbedModel,
});
const document = new Document({ text: essay, id_: "essay" });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
const queryEngine = index.asQueryEngine();
@@ -3,19 +3,13 @@
To use Ollama embeddings, you need to import `Ollama` from `llamaindex`.
```ts
import { Ollama, serviceContextFromDefaults } from "llamaindex";
import { Ollama, Settings } from "llamaindex";
const ollamaEmbedModel = new Ollama();
const serviceContext = serviceContextFromDefaults({
embedModel: ollamaEmbedModel,
});
Settings.embedModel = new Ollama();
const document = new Document({ text: essay, id_: "essay" });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
const queryEngine = index.asQueryEngine();
@@ -3,19 +3,13 @@
To use OpenAI embeddings, you need to import `OpenAIEmbedding` from `llamaindex`.
```ts
import { OpenAIEmbedding, serviceContextFromDefaults } from "llamaindex";
import { OpenAIEmbedding, Settings } from "llamaindex";
const openaiEmbedModel = new OpenAIEmbedding();
const serviceContext = serviceContextFromDefaults({
embedModel: openaiEmbedModel,
});
Settings.embedModel = new OpenAIEmbedding();
const document = new Document({ text: essay, id_: "essay" });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
const queryEngine = index.asQueryEngine();
@@ -3,21 +3,15 @@
To use together embeddings, you need to import `TogetherEmbedding` from `llamaindex`.
```ts
import { TogetherEmbedding, serviceContextFromDefaults } from "llamaindex";
import { TogetherEmbedding, Settings } from "llamaindex";
const togetherEmbedModel = new TogetherEmbedding({
Settings.embedModel = new TogetherEmbedding({
apiKey: "<YOUR_API_KEY>",
});
const serviceContext = serviceContextFromDefaults({
embedModel: togetherEmbedModel,
});
const document = new Document({ text: essay, id_: "essay" });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
const queryEngine = index.asQueryEngine();
+5 -6
View File
@@ -2,14 +2,14 @@
The embedding model in LlamaIndex is responsible for creating numerical representations of text. By default, LlamaIndex will use the `text-embedding-ada-002` model from OpenAI.
This can be explicitly set in the `ServiceContext` object.
This can be explicitly updated through `Settings`
```typescript
import { OpenAIEmbedding, serviceContextFromDefaults } from "llamaindex";
import { OpenAIEmbedding, Settings } from "llamaindex";
const openaiEmbeds = new OpenAIEmbedding();
const serviceContext = serviceContextFromDefaults({ embedModel: openaiEmbeds });
Settings.embedModel = new OpenAIEmbedding({
model: "text-embedding-ada-002",
});
```
## Local Embedding
@@ -19,4 +19,3 @@ For local embeddings, you can use the [HuggingFace](./available_embeddings/huggi
## API Reference
- [OpenAIEmbedding](../../api/classes/OpenAIEmbedding.md)
- [ServiceContext](../../api/interfaces//ServiceContext.md)
@@ -21,23 +21,15 @@ export OPENAI_API_KEY=your-api-key
Import the required modules:
```ts
import {
CorrectnessEvaluator,
OpenAI,
serviceContextFromDefaults,
} from "llamaindex";
import { CorrectnessEvaluator, OpenAI, Settings } from "llamaindex";
```
Let's setup gpt-4 for better results:
```ts
const llm = new OpenAI({
Settings.llm = new OpenAI({
model: "gpt-4",
});
const ctx = serviceContextFromDefaults({
llm,
});
```
```ts
@@ -49,9 +41,7 @@ const response = ` Certainly! Albert Einstein's theory of relativity consists of
However, general relativity, published in 1915, extended these ideas to include the effects of magnetism. According to general relativity, gravity is not a force between masses but rather the result of the warping of space and time by magnetic fields generated by massive objects. Massive objects, such as planets and stars, create magnetic fields that cause a curvature in spacetime, and smaller objects follow curved paths in response to this magnetic curvature. This concept is often illustrated using the analogy of a heavy ball placed on a rubber sheet with magnets underneath, causing it to create a depression that other objects (representing smaller masses) naturally move towards due to magnetic attraction.
`;
const evaluator = new CorrectnessEvaluator({
serviceContext: ctx,
});
const evaluator = new CorrectnessEvaluator();
const result = await evaluator.evaluateResponse({
query,
@@ -28,20 +28,16 @@ import {
FaithfulnessEvaluator,
OpenAI,
VectorStoreIndex,
serviceContextFromDefaults,
Settings,
} from "llamaindex";
```
Let's setup gpt-4 for better results:
```ts
const llm = new OpenAI({
Settings.llm = new OpenAI({
model: "gpt-4",
});
const ctx = serviceContextFromDefaults({
llm,
});
```
Now, let's create a vector index and query engine with documents and query engine respectively. Then, we can evaluate the response with the query and response from the query engine.:
@@ -63,9 +59,7 @@ Now, let's evaluate the response:
```ts
const query = "How did New York City get its name?";
const evaluator = new FaithfulnessEvaluator({
serviceContext: ctx,
});
const evaluator = new FaithfulnessEvaluator();
const response = await queryEngine.query({
query,
@@ -21,23 +21,15 @@ export OPENAI_API_KEY=your-api-key
Import the required modules:
```ts
import {
RelevancyEvaluator,
OpenAI,
serviceContextFromDefaults,
} from "llamaindex";
import { RelevancyEvaluator, OpenAI, Settings } from "llamaindex";
```
Let's setup gpt-4 for better results:
```ts
const llm = new OpenAI({
Settings.llm = new OpenAI({
model: "gpt-4",
});
const ctx = serviceContextFromDefaults({
llm,
});
```
Now, let's create a vector index and query engine with documents and query engine respectively. Then, we can evaluate the response with the query and response from the query engine.:
@@ -59,6 +51,8 @@ const response = await queryEngine.query({
query,
});
const evaluator = new RelevancyEvaluator();
const result = await evaluator.evaluateResponse({
query,
response: response,
@@ -3,13 +3,11 @@
## Usage
```ts
import { Anthropic, serviceContextFromDefaults } from "llamaindex";
import { Anthropic, Settings } from "llamaindex";
const anthropicLLM = new Anthropic({
Settings.llm = new Anthropic({
apiKey: "<YOUR_API_KEY>",
});
const serviceContext = serviceContextFromDefaults({ llm: anthropicLLM });
```
## Load and index documents
@@ -19,9 +17,7 @@ For this example, we will use a single document. In a real-world scenario, you w
```ts
const document = new Document({ text: essay, id_: "essay" });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
```
## Query
@@ -39,28 +35,17 @@ const results = await queryEngine.query({
## Full Example
```ts
import {
Anthropic,
Document,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
import { Anthropic, Document, VectorStoreIndex, Settings } from "llamaindex";
Settings.llm = new Anthropic({
apiKey: "<YOUR_API_KEY>",
});
async function main() {
// Create an instance of the Anthropic LLM
const anthropicLLM = new Anthropic({
apiKey: "<YOUR_API_KEY>",
});
// Create a service context
const serviceContext = serviceContextFromDefaults({ llm: anthropicLLM });
const document = new Document({ text: essay, id_: "essay" });
// Load and index documents
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// Create a query engine
const queryEngine = index.asQueryEngine({
@@ -15,11 +15,9 @@ export AZURE_OPENAI_DEPLOYMENT="gpt-4" # or some other deployment name
## Usage
```ts
import { OpenAI, serviceContextFromDefaults } from "llamaindex";
import { OpenAI, Settings } from "llamaindex";
const azureOpenaiLLM = new OpenAI({ model: "gpt-4", temperature: 0 });
const serviceContext = serviceContextFromDefaults({ llm: azureOpenaiLLM });
Settings.llm = new OpenAI({ model: "gpt-4", temperature: 0 });
```
## Load and index documents
@@ -29,9 +27,7 @@ For this example, we will use a single document. In a real-world scenario, you w
```ts
const document = new Document({ text: essay, id_: "essay" });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
```
## Query
@@ -49,26 +45,15 @@ const results = await queryEngine.query({
## Full Example
```ts
import {
OpenAI,
Document,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
import { OpenAI, Document, VectorStoreIndex, Settings } from "llamaindex";
Settings.llm = new OpenAI({ model: "gpt-4", temperature: 0 });
async function main() {
// Create an instance of the LLM
const azureOpenaiLLM = new OpenAI({ model: "gpt-4", temperature: 0 });
// Create a service context
const serviceContext = serviceContextFromDefaults({ llm: azureOpenaiLLM });
const document = new Document({ text: essay, id_: "essay" });
// Load and index documents
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// get retriever
const retriever = index.asRetriever();
@@ -5,13 +5,11 @@ Fireworks.ai focus on production use cases for open source LLMs, offering speed
## Usage
```ts
import { FireworksLLM, serviceContextFromDefaults } from "llamaindex";
import { FireworksLLM, Settings } from "llamaindex";
const fireworksLLM = new FireworksLLM({
Settings.llm = new FireworksLLM({
apiKey: "<YOUR_API_KEY>",
});
const serviceContext = serviceContextFromDefaults({ llm: fireworksLLM });
```
## Load and index documents
@@ -23,9 +21,7 @@ const reader = new PDFReader();
const documents = await reader.loadData("../data/brk-2022.pdf");
// Split text and create embeddings. Store them in a VectorStoreIndex
const index = await VectorStoreIndex.fromDocuments(documents, {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments(documents);
```
## Query
@@ -14,15 +14,13 @@ export GROQ_API_KEY=<your-api-key>
The initialize the Groq module.
```ts
import { Groq, serviceContextFromDefaults } from "llamaindex";
import { Groq, Settings } from "llamaindex";
const groq = new Groq({
Settings.llm = new Groq({
// If you do not wish to set your API key in the environment, you may
// configure your API key when you initialize the Groq class.
// apiKey: "<your-api-key>",
});
const serviceContext = serviceContextFromDefaults({ llm: groq });
```
## Load and index documents
@@ -32,9 +30,7 @@ For this example, we will use a single document. In a real-world scenario, you w
```ts
const document = new Document({ text: essay, id_: "essay" });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
```
## Query
@@ -3,32 +3,24 @@
## Usage
```ts
import { Ollama, serviceContextFromDefaults } from "llamaindex";
import { Ollama, Settings } from "llamaindex";
const llama2LLM = new LlamaDeuce({ chatStrategy: DeuceChatStrategy.META });
const serviceContext = serviceContextFromDefaults({ llm: llama2LLM });
Settings.llm = new LlamaDeuce({ chatStrategy: DeuceChatStrategy.META });
```
## Usage with Replication
```ts
import {
Ollama,
ReplicateSession,
serviceContextFromDefaults,
} from "llamaindex";
import { Ollama, ReplicateSession, Settings } from "llamaindex";
const replicateSession = new ReplicateSession({
replicateKey,
});
const llama2LLM = new LlamaDeuce({
Settings.llm = new LlamaDeuce({
chatStrategy: DeuceChatStrategy.META,
replicateSession,
});
const serviceContext = serviceContextFromDefaults({ llm: llama2LLM });
```
## Load and index documents
@@ -38,9 +30,7 @@ For this example, we will use a single document. In a real-world scenario, you w
```ts
const document = new Document({ text: essay, id_: "essay" });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
```
## Query
@@ -58,26 +48,16 @@ const results = await queryEngine.query({
## Full Example
```ts
import {
LlamaDeuce,
Document,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
import { LlamaDeuce, Document, VectorStoreIndex, Settings } from "llamaindex";
// Use the LlamaDeuce LLM
Settings.llm = new LlamaDeuce({ chatStrategy: DeuceChatStrategy.META });
async function main() {
// Create an instance of the LLM
const llama2LLM = new LlamaDeuce({ chatStrategy: DeuceChatStrategy.META });
// Create a service context
const serviceContext = serviceContextFromDefaults({ llm: mistralLLM });
const document = new Document({ text: essay, id_: "essay" });
// Load and index documents
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// get retriever
const retriever = index.asRetriever();
@@ -3,14 +3,12 @@
## Usage
```ts
import { Ollama, serviceContextFromDefaults } from "llamaindex";
import { Ollama, Settings } from "llamaindex";
const mistralLLM = new MistralAI({
Settings.llm = new MistralAI({
model: "mistral-tiny",
apiKey: "<YOUR_API_KEY>",
});
const serviceContext = serviceContextFromDefaults({ llm: mistralLLM });
```
## Load and index documents
@@ -20,9 +18,7 @@ For this example, we will use a single document. In a real-world scenario, you w
```ts
const document = new Document({ text: essay, id_: "essay" });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
```
## Query
@@ -40,26 +36,16 @@ const results = await queryEngine.query({
## Full Example
```ts
import {
MistralAI,
Document,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
import { MistralAI, Document, VectorStoreIndex, Settings } from "llamaindex";
// Use the MistralAI LLM
Settings.llm = new MistralAI({ model: "mistral-tiny" });
async function main() {
// Create an instance of the LLM
const mistralLLM = new MistralAI({ model: "mistral-tiny" });
// Create a service context
const serviceContext = serviceContextFromDefaults({ llm: mistralLLM });
const document = new Document({ text: essay, id_: "essay" });
// Load and index documents
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// get retriever
const retriever = index.asRetriever();
@@ -3,14 +3,10 @@
## Usage
```ts
import { Ollama, serviceContextFromDefaults } from "llamaindex";
import { Ollama, Settings } from "llamaindex";
const ollamaLLM = new Ollama({ model: "llama2", temperature: 0.75 });
const serviceContext = serviceContextFromDefaults({
llm: ollamaLLM,
embedModel: ollamaLLM,
});
Settings.llm = ollamaLLM;
Settings.embedModel = ollamaLLM;
```
## Load and index documents
@@ -20,9 +16,7 @@ For this example, we will use a single document. In a real-world scenario, you w
```ts
const document = new Document({ text: essay, id_: "essay" });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
```
## Query
@@ -40,33 +34,23 @@ const results = await queryEngine.query({
## Full Example
```ts
import {
Ollama,
Document,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
import { Ollama, Document, VectorStoreIndex, Settings } from "llamaindex";
import fs from "fs/promises";
const ollama = new Ollama({ model: "llama2", temperature: 0.75 });
// Use Ollama LLM and Embed Model
Settings.llm = ollama;
Settings.embedModel = ollama;
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({
embedModel: ollamaLLM, // prevent 'Set OpenAI Key in OPENAI_API_KEY env variable' error
llm: ollamaLLM,
});
const document = new Document({ text: essay, id_: "essay" });
// Load and index documents
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// get retriever
const retriever = index.asRetriever();
@@ -1,11 +1,9 @@
# OpenAI
```ts
import { OpenAI, serviceContextFromDefaults } from "llamaindex";
import { OpenAI, Settings } from "llamaindex";
const openaiLLM = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0, apiKey: <YOUR_API_KEY> });
const serviceContext = serviceContextFromDefaults({ llm: openaiLLM });
Settings.llm = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0, apiKey: <YOUR_API_KEY> });
```
You can setup the apiKey on the environment variables, like:
@@ -21,9 +19,7 @@ For this example, we will use a single document. In a real-world scenario, you w
```ts
const document = new Document({ text: essay, id_: "essay" });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
```
## Query
@@ -41,26 +37,16 @@ const results = await queryEngine.query({
## Full Example
```ts
import {
OpenAI,
Document,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
import { OpenAI, Document, VectorStoreIndex, Settings } from "llamaindex";
// Use the OpenAI LLM
Settings.llm = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0 });
async function main() {
// Create an instance of the LLM
const openaiLLM = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0 });
// Create a service context
const serviceContext = serviceContextFromDefaults({ llm: openaiLLM });
const document = new Document({ text: essay, id_: "essay" });
// Load and index documents
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// get retriever
const retriever = index.asRetriever();
@@ -3,13 +3,11 @@
## Usage
```ts
import { Portkey, serviceContextFromDefaults } from "llamaindex";
import { Portkey, Settings } from "llamaindex";
const portkeyLLM = new Portkey({
Settings.llm = new Portkey({
apiKey: "<YOUR_API_KEY>",
});
const serviceContext = serviceContextFromDefaults({ llm: portkeyLLM });
```
## Load and index documents
@@ -19,9 +17,7 @@ For this example, we will use a single document. In a real-world scenario, you w
```ts
const document = new Document({ text: essay, id_: "essay" });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
```
## Query
@@ -39,28 +35,19 @@ const results = await queryEngine.query({
## Full Example
```ts
import {
Portkey,
Document,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
import { Portkey, Document, VectorStoreIndex, Settings } from "llamaindex";
// Use the Portkey LLM
Settings.llm = new Portkey({
apiKey: "<YOUR_API_KEY>",
});
async function main() {
// Create an instance of the LLM
const portkeyLLM = new Portkey({
apiKey: "<YOUR_API_KEY>",
});
// Create a service context
const serviceContext = serviceContextFromDefaults({ llm: portkeyLLM });
// Create a document
const document = new Document({ text: essay, id_: "essay" });
// Load and index documents
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// get retriever
const retriever = index.asRetriever();
@@ -3,13 +3,11 @@
## Usage
```ts
import { TogetherLLM, serviceContextFromDefaults } from "llamaindex";
import { TogetherLLM, Settings } from "llamaindex";
const togetherLLM = new TogetherLLM({
Settings.llm = new TogetherLLM({
apiKey: "<YOUR_API_KEY>",
});
const serviceContext = serviceContextFromDefaults({ llm: togetherLLM });
```
## Load and index documents
@@ -19,9 +17,7 @@ For this example, we will use a single document. In a real-world scenario, you w
```ts
const document = new Document({ text: essay, id_: "essay" });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
```
## Query
@@ -39,28 +35,17 @@ const results = await queryEngine.query({
## Full Example
```ts
import {
TogetherLLM,
Document,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
import { TogetherLLM, Document, VectorStoreIndex, Settings } from "llamaindex";
Settings.llm = new TogetherLLM({
apiKey: "<YOUR_API_KEY>",
});
async function main() {
// Create an instance of the LLM
const togetherLLM = new TogetherLLM({
apiKey: "<YOUR_API_KEY>",
});
// Create a service context
const serviceContext = serviceContextFromDefaults({ llm: togetherLLM });
const document = new Document({ text: essay, id_: "essay" });
// Load and index documents
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// get retriever
const retriever = index.asRetriever();
+3 -6
View File
@@ -6,14 +6,12 @@ sidebar_position: 3
The LLM is responsible for reading text and generating natural language responses to queries. By default, LlamaIndex.TS uses `gpt-3.5-turbo`.
The LLM can be explicitly set in the `ServiceContext` object.
The LLM can be explicitly updated through `Settings`.
```typescript
import { OpenAI, serviceContextFromDefaults } from "llamaindex";
import { OpenAI, Settings } from "llamaindex";
const openaiLLM = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0 });
const serviceContext = serviceContextFromDefaults({ llm: openaiLLM });
Settings.llm = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0 });
```
## Azure OpenAI
@@ -35,4 +33,3 @@ For local LLMs, currently we recommend the use of [Ollama](./available_llms/olla
## API Reference
- [OpenAI](../api/classes/OpenAI.md)
- [ServiceContext](../api/interfaces//ServiceContext.md)
+3 -4
View File
@@ -4,15 +4,14 @@ sidebar_position: 4
# NodeParser
The `NodeParser` in LlamaIndex is responsible for splitting `Document` objects into more manageable `Node` objects. When you call `.fromDocuments()`, the `NodeParser` from the `ServiceContext` is used to do this automatically for you. Alternatively, you can use it to split documents ahead of time.
The `NodeParser` in LlamaIndex is responsible for splitting `Document` objects into more manageable `Node` objects. When you call `.fromDocuments()`, the `NodeParser` from the `Settings` is used to do this automatically for you. Alternatively, you can use it to split documents ahead of time.
```typescript
import { Document, SimpleNodeParser } from "llamaindex";
const nodeParser = new SimpleNodeParser();
const nodes = nodeParser.getNodesFromDocuments([
new Document({ text: "I am 10 years old. John is 20 years old." }),
]);
Settings.nodeParser = nodeParser;
```
## TextSplitter
@@ -18,7 +18,7 @@ import {
Document,
OpenAI,
VectorStoreIndex,
serviceContextFromDefaults,
Settings,
} from "llamaindex";
```
@@ -29,13 +29,9 @@ For this example, we will use a single document. In a real-world scenario, you w
```ts
const document = new Document({ text: essay, id_: "essay" });
const serviceContext = serviceContextFromDefaults({
llm: new OpenAI({ model: "gpt-3.5-turbo", temperature: 0.1 }),
});
Settings.llm = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0.1 });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
```
## Increase similarity topK to retrieve more results
@@ -58,7 +58,10 @@ Most commonly, node-postprocessors will be used in a query engine, where they ar
### Using Node Postprocessors in a Query Engine
```ts
import { Node, NodeWithScore, SimilarityPostprocessor, CohereRerank } from "llamaindex";
import { Node, NodeWithScore, SimilarityPostprocessor, CohereRerank, Settings } from "llamaindex";
// Use OpenAI LLM
Settings.llm = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0.1 });
const nodes: NodeWithScore[] = [
{
@@ -79,14 +82,6 @@ const reranker = new CohereRerank({
const document = new Document({ text: "essay", id_: "essay" });
const serviceContext = serviceContextFromDefaults({
llm: new OpenAI({ model: "gpt-3.5-turbo", temperature: 0.1 }),
});
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const queryEngine = index.asQueryEngine({
nodePostprocessors: [processor, reranker],
});
+3 -7
View File
@@ -31,13 +31,11 @@ The first method is to create a new instance of `ResponseSynthesizer` (or the mo
```ts
// Create an instance of response synthesizer
const responseSynthesizer = new ResponseSynthesizer({
responseBuilder: new CompactAndRefine(serviceContext, newTextQaPrompt),
responseBuilder: new CompactAndRefine(undefined, newTextQaPrompt),
});
// Create index
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// Query the index
const queryEngine = index.asQueryEngine({ responseSynthesizer });
@@ -53,9 +51,7 @@ The second method is that most of the modules in LlamaIndex have a `getPrompts`
```ts
// Create index
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// Query the index
const queryEngine = index.asQueryEngine();
@@ -54,12 +54,13 @@ You can create a `ChromaVectorStore` to store the documents:
```ts
const chromaVS = new ChromaVectorStore({ collectionName });
const serviceContext = await storageContextFromDefaults({
const storageContext = await storageContextFromDefaults({
vectorStore: chromaVS,
});
const index = await VectorStoreIndex.fromDocuments(docs, {
storageContext: serviceContext,
storageContext: storageContext,
});
```
@@ -18,7 +18,7 @@ import {
SimpleNodeParser,
SummaryIndex,
VectorStoreIndex,
serviceContextFromDefaults,
Settings,
} from "llamaindex";
```
@@ -34,17 +34,13 @@ const documents = await new SimpleDirectoryReader().loadData({
## Service Context
Next, we need to define some basic rules and parse the documents into nodes. We will use the `SimpleNodeParser` to parse the documents into nodes and `ServiceContext` to define the rules (eg. LLM API key, chunk size, etc.):
Next, we need to define some basic rules and parse the documents into nodes. We will use the `SimpleNodeParser` to parse the documents into nodes and `Settings` to define the rules (eg. LLM API key, chunk size, etc.):
```ts
const nodeParser = new SimpleNodeParser({
Settings.llm = new OpenAI();
Settings.nodeParser = new SimpleNodeParser({
chunkSize: 1024,
});
const serviceContext = serviceContextFromDefaults({
nodeParser,
llm: new OpenAI(),
});
```
## Creating Indices
@@ -52,13 +48,8 @@ const serviceContext = serviceContextFromDefaults({
Next, we need to create some indices. We will create a `VectorStoreIndex` and a `SummaryIndex`:
```ts
const vectorIndex = await VectorStoreIndex.fromDocuments(documents, {
serviceContext,
});
const summaryIndex = await SummaryIndex.fromDocuments(documents, {
serviceContext,
});
const vectorIndex = await VectorStoreIndex.fromDocuments(documents);
const summaryIndex = await SummaryIndex.fromDocuments(documents);
```
## Creating Query Engines
@@ -88,7 +79,6 @@ const queryEngine = RouterQueryEngine.fromDefaults({
description: "Useful for retrieving specific context from Abramov",
},
],
serviceContext,
});
```
@@ -117,34 +107,23 @@ import {
SimpleNodeParser,
SummaryIndex,
VectorStoreIndex,
serviceContextFromDefaults,
Settings,
} from "llamaindex";
Settings.llm = new OpenAI();
Settings.nodeParser = new SimpleNodeParser({
chunkSize: 1024,
});
async function main() {
// Load documents from a directory
const documents = await new SimpleDirectoryReader().loadData({
directoryPath: "node_modules/llamaindex/examples",
});
// Parse the documents into nodes
const nodeParser = new SimpleNodeParser({
chunkSize: 1024,
});
// Create a service context
const serviceContext = serviceContextFromDefaults({
nodeParser,
llm: new OpenAI(),
});
// Create indices
const vectorIndex = await VectorStoreIndex.fromDocuments(documents, {
serviceContext,
});
const summaryIndex = await SummaryIndex.fromDocuments(documents, {
serviceContext,
});
const vectorIndex = await VectorStoreIndex.fromDocuments(documents);
const summaryIndex = await SummaryIndex.fromDocuments(documents);
// Create query engines
const vectorQueryEngine = vectorIndex.asQueryEngine();
@@ -162,7 +141,6 @@ async function main() {
description: "Useful for retrieving specific context from Abramov",
},
],
serviceContext,
});
// Query the router query engine
+29
View File
@@ -0,0 +1,29 @@
import fs from "node:fs/promises";
import { Document, OpenAI, Settings, VectorStoreIndex } from "llamaindex";
Settings.llm = new OpenAI({ model: "gpt-4" });
async function main() {
// Load essay from abramov.txt in Node
const path = "node_modules/llamaindex/examples/abramov.txt";
const essay = await fs.readFile(path, "utf-8");
// Create Document object with essay
const document = new Document({ text: essay, id_: path });
const index = await VectorStoreIndex.fromDocuments([document]);
// Query the index
const queryEngine = index.asQueryEngine();
const response = await queryEngine.query({
query: "What did the author do in college?",
});
// Output response
console.log(response.toString());
}
main().catch(console.error);
+5 -13
View File
@@ -6,11 +6,11 @@ import {
OpenAI,
OpenAIAgent,
QueryEngineTool,
Settings,
SimpleNodeParser,
SimpleToolNodeMapping,
SummaryIndex,
VectorStoreIndex,
serviceContextFromDefaults,
storageContextFromDefaults,
} from "llamaindex";
@@ -18,6 +18,8 @@ import { extractWikipedia } from "./helpers/extractWikipedia";
const wikiTitles = ["Brazil", "Canada"];
Settings.llm = new OpenAI({ model: "gpt-4" });
async function main() {
await extractWikipedia(wikiTitles);
@@ -30,11 +32,6 @@ async function main() {
countryDocs[title] = document;
}
const llm = new OpenAI({
model: "gpt-4",
});
const serviceContext = serviceContextFromDefaults({ llm });
const storageContext = await storageContextFromDefaults({
persistDir: "./storage",
});
@@ -54,13 +51,11 @@ async function main() {
console.log(`Creating index for ${title}`);
const vectorIndex = await VectorStoreIndex.init({
serviceContext: serviceContext,
storageContext: storageContext,
nodes,
});
const summaryIndex = await SummaryIndex.init({
serviceContext: serviceContext,
nodes,
});
@@ -90,7 +85,7 @@ async function main() {
const agent = new OpenAIAgent({
tools: queryEngineTools,
llm,
llm: new OpenAI({ model: "gpt-4" }),
verbose: true,
});
@@ -126,14 +121,11 @@ async function main() {
allTools,
toolMapping,
VectorStoreIndex,
{
serviceContext,
},
);
const topAgent = new OpenAIAgent({
toolRetriever: await objectIndex.asRetriever({}),
llm,
llm: new OpenAI({ model: "gpt-4" }),
verbose: true,
prefixMessages: [
{
+2 -7
View File
@@ -1,8 +1,4 @@
import {
AstraDBVectorStore,
serviceContextFromDefaults,
VectorStoreIndex,
} from "llamaindex";
import { AstraDBVectorStore, VectorStoreIndex } from "llamaindex";
const collectionName = "movie_reviews";
@@ -11,8 +7,7 @@ async function main() {
const astraVS = new AstraDBVectorStore({ contentKey: "reviewtext" });
await astraVS.connect(collectionName);
const ctx = serviceContextFromDefaults();
const index = await VectorStoreIndex.fromVectorStore(astraVS, ctx);
const index = await VectorStoreIndex.fromVectorStore(astraVS);
const retriever = await index.asRetriever({ similarityTopK: 20 });
+5 -5
View File
@@ -4,18 +4,18 @@ import readline from "node:readline/promises";
import {
ContextChatEngine,
Document,
serviceContextFromDefaults,
Settings,
VectorStoreIndex,
} from "llamaindex";
import essay from "./essay";
// Update chunk size
Settings.chunkSize = 512;
async function main() {
const document = new Document({ text: essay });
const serviceContext = serviceContextFromDefaults({ chunkSize: 512 });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
const retriever = index.asRetriever();
retriever.similarityTopK = 5;
const chatEngine = new ContextChatEngine({ retriever });
+5 -16
View File
@@ -1,21 +1,10 @@
import {
CorrectnessEvaluator,
OpenAI,
serviceContextFromDefaults,
} from "llamaindex";
import { CorrectnessEvaluator, OpenAI, Settings } from "llamaindex";
// Update llm to use OpenAI
Settings.llm = new OpenAI({ model: "gpt-4" });
async function main() {
const llm = new OpenAI({
model: "gpt-4",
});
const ctx = serviceContextFromDefaults({
llm,
});
const evaluator = new CorrectnessEvaluator({
serviceContext: ctx,
});
const evaluator = new CorrectnessEvaluator();
const query =
"Can you explain the theory of relativity proposed by Albert Einstein in detail?";
+5 -12
View File
@@ -2,22 +2,15 @@ import {
Document,
FaithfulnessEvaluator,
OpenAI,
Settings,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
// Update llm to use OpenAI
Settings.llm = new OpenAI({ model: "gpt-4" });
async function main() {
const llm = new OpenAI({
model: "gpt-4",
});
const ctx = serviceContextFromDefaults({
llm,
});
const evaluator = new FaithfulnessEvaluator({
serviceContext: ctx,
});
const evaluator = new FaithfulnessEvaluator();
const documents = [
new Document({
+6 -12
View File
@@ -2,22 +2,16 @@ import {
Document,
OpenAI,
RelevancyEvaluator,
Settings,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
Settings.llm = new OpenAI({
model: "gpt-4",
});
async function main() {
const llm = new OpenAI({
model: "gpt-4",
});
const ctx = serviceContextFromDefaults({
llm,
});
const evaluator = new RelevancyEvaluator({
serviceContext: ctx,
});
const evaluator = new RelevancyEvaluator();
const documents = [
new Document({
+7 -17
View File
@@ -1,30 +1,20 @@
import fs from "node:fs/promises";
import {
Document,
Groq,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
import { Document, Groq, Settings, VectorStoreIndex } from "llamaindex";
// Update llm to use Groq
Settings.llm = new Groq({
apiKey: process.env.GROQ_API_KEY,
});
async function main() {
// Create an instance of the LLM
const groq = new Groq({
apiKey: process.env.GROQ_API_KEY,
});
// Create a service context
const serviceContext = serviceContextFromDefaults({ llm: groq });
// Load essay from abramov.txt in Node
const path = "node_modules/llamaindex/examples/abramov.txt";
const essay = await fs.readFile(path, "utf-8");
const document = new Document({ text: essay, id_: "essay" });
// Load and index documents
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// get retriever
const retriever = index.asRetriever();
+7 -12
View File
@@ -4,10 +4,15 @@ import {
Document,
HuggingFaceEmbedding,
HuggingFaceEmbeddingModelType,
Settings,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
// Update embed model
Settings.embedModel = new HuggingFaceEmbedding({
modelType: HuggingFaceEmbeddingModelType.XENOVA_ALL_MPNET_BASE_V2,
});
async function main() {
// Load essay from abramov.txt in Node
const path = "node_modules/llamaindex/examples/abramov.txt";
@@ -17,18 +22,8 @@ async function main() {
// Create Document object with essay
const document = new Document({ text: essay, id_: path });
// Use Local embedding from HuggingFace
const embedModel = new HuggingFaceEmbedding({
modelType: HuggingFaceEmbeddingModelType.XENOVA_ALL_MPNET_BASE_V2,
});
const serviceContext = serviceContextFromDefaults({
embedModel,
});
// Split text and create embeddings. Store them in a VectorStoreIndex
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// Query the index
const queryEngine = index.asQueryEngine();
+8 -13
View File
@@ -1,26 +1,21 @@
import {
Document,
Settings,
SimpleNodeParser,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
export const STORAGE_DIR = "./data";
// Update node parser
Settings.nodeParser = new SimpleNodeParser({
chunkSize: 512,
chunkOverlap: 20,
splitLongSentences: true,
});
(async () => {
// create service context that is splitting sentences longer than CHUNK_SIZE
const serviceContext = serviceContextFromDefaults({
nodeParser: new SimpleNodeParser({
chunkSize: 512,
chunkOverlap: 20,
splitLongSentences: true,
}),
});
// generate a document with a very long sentence (9000 words long)
const longSentence = "is ".repeat(9000) + ".";
const document = new Document({ text: longSentence, id_: "1" });
await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
await VectorStoreIndex.fromDocuments([document]);
})();
+2 -7
View File
@@ -1,8 +1,4 @@
import {
MilvusVectorStore,
serviceContextFromDefaults,
VectorStoreIndex,
} from "llamaindex";
import { MilvusVectorStore, VectorStoreIndex } from "llamaindex";
const collectionName = "movie_reviews";
@@ -10,8 +6,7 @@ async function main() {
try {
const milvus = new MilvusVectorStore({ collection: collectionName });
const ctx = serviceContextFromDefaults();
const index = await VectorStoreIndex.fromVectorStore(milvus, ctx);
const index = await VectorStoreIndex.fromVectorStore(milvus);
const retriever = await index.asRetriever({ similarityTopK: 20 });
+9 -15
View File
@@ -1,15 +1,18 @@
import * as fs from "fs/promises";
import {
BaseEmbedding,
Document,
LLM,
MistralAI,
MistralAIEmbedding,
Settings,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
async function rag(llm: LLM, embedModel: BaseEmbedding, query: string) {
// Update embed model
Settings.embedModel = new MistralAIEmbedding();
// Update llm to use MistralAI
Settings.llm = new MistralAI({ model: "mistral-tiny" });
async function rag(query: string) {
// Load essay from abramov.txt in Node
const path = "node_modules/llamaindex/examples/abramov.txt";
@@ -18,12 +21,7 @@ async function rag(llm: LLM, embedModel: BaseEmbedding, query: string) {
// Create Document object with essay
const document = new Document({ text: essay, id_: path });
// Split text and create embeddings. Store them in a VectorStoreIndex
const serviceContext = serviceContextFromDefaults({ llm, embedModel });
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// Query the index
const queryEngine = index.asQueryEngine();
@@ -60,10 +58,6 @@ async function rag(llm: LLM, embedModel: BaseEmbedding, query: string) {
}
// rag
const ragResponse = await rag(
llm,
embedding,
"What did the author do in college?",
);
const ragResponse = await rag("What did the author do in college?");
console.log(ragResponse);
})();
+3 -7
View File
@@ -1,10 +1,6 @@
/* eslint-disable turbo/no-undeclared-env-vars */
import * as dotenv from "dotenv";
import {
MongoDBAtlasVectorSearch,
serviceContextFromDefaults,
VectorStoreIndex,
} from "llamaindex";
import { MongoDBAtlasVectorSearch, VectorStoreIndex } from "llamaindex";
import { MongoClient } from "mongodb";
// Load environment variables from local .env file
@@ -12,7 +8,7 @@ dotenv.config();
async function query() {
const client = new MongoClient(process.env.MONGODB_URI!);
const serviceContext = serviceContextFromDefaults();
const store = new MongoDBAtlasVectorSearch({
mongodbClient: client,
dbName: process.env.MONGODB_DATABASE!,
@@ -20,7 +16,7 @@ async function query() {
indexName: process.env.MONGODB_VECTOR_INDEX!,
});
const index = await VectorStoreIndex.fromVectorStore(store, serviceContext);
const index = await VectorStoreIndex.fromVectorStore(store);
const retriever = index.asRetriever({ similarityTopK: 20 });
const queryEngine = index.asQueryEngine({ retriever });
+9 -11
View File
@@ -1,12 +1,16 @@
import {
ServiceContext,
serviceContextFromDefaults,
Settings,
SimpleDirectoryReader,
storageContextFromDefaults,
VectorStoreIndex,
storageContextFromDefaults,
} from "llamaindex";
import * as path from "path";
// Update chunk size and overlap
Settings.chunkSize = 512;
Settings.chunkOverlap = 20;
async function getRuntime(func: any) {
const start = Date.now();
await func();
@@ -14,7 +18,7 @@ async function getRuntime(func: any) {
return end - start;
}
async function generateDatasource(serviceContext: ServiceContext) {
async function generateDatasource() {
console.log(`Generating storage...`);
// Split documents, create embeddings and store them in the storage context
const ms = await getRuntime(async () => {
@@ -26,7 +30,6 @@ async function generateDatasource(serviceContext: ServiceContext) {
storeImages: true,
});
await VectorStoreIndex.fromDocuments(documents, {
serviceContext,
storageContext,
});
});
@@ -34,12 +37,7 @@ async function generateDatasource(serviceContext: ServiceContext) {
}
async function main() {
const serviceContext = serviceContextFromDefaults({
chunkSize: 512,
chunkOverlap: 20,
});
await generateDatasource(serviceContext);
await generateDatasource();
console.log("Finished generating storage.");
}
+23 -28
View File
@@ -1,18 +1,28 @@
import {
CallbackManager,
ImageDocument,
ImageType,
MultiModalResponseSynthesizer,
NodeWithScore,
OpenAI,
ServiceContext,
Settings,
VectorStoreIndex,
runWithCallbackManager,
serviceContextFromDefaults,
storageContextFromDefaults,
} from "llamaindex";
export async function createIndex(serviceContext: ServiceContext) {
// Update chunk size and overlap
Settings.chunkSize = 512;
Settings.chunkOverlap = 20;
// Update llm
Settings.llm = new OpenAI({ model: "gpt-4-vision-preview", maxTokens: 512 });
// Update callbackManager
Settings.callbackManager = new CallbackManager({
onRetrieve: ({ query, nodes }) => {
console.log(`Retrieved ${nodes.length} nodes for query: ${query}`);
},
});
export async function createIndex() {
// set up vector store index with two vector stores, one for text, the other for images
const storageContext = await storageContextFromDefaults({
persistDir: "storage",
@@ -21,36 +31,21 @@ export async function createIndex(serviceContext: ServiceContext) {
return await VectorStoreIndex.init({
nodes: [],
storageContext,
serviceContext,
});
}
async function main() {
let images: ImageType[] = [];
const callbackManager = new CallbackManager({
onRetrieve: ({ query, nodes }) => {
images = nodes
.filter(({ node }: NodeWithScore) => node instanceof ImageDocument)
.map(({ node }: NodeWithScore) => (node as ImageDocument).image);
},
});
const llm = new OpenAI({ model: "gpt-4-vision-preview", maxTokens: 512 });
const serviceContext = serviceContextFromDefaults({
llm,
chunkSize: 512,
chunkOverlap: 20,
});
const index = await createIndex(serviceContext);
const images: ImageType[] = [];
const index = await createIndex();
const queryEngine = index.asQueryEngine({
responseSynthesizer: new MultiModalResponseSynthesizer({ serviceContext }),
responseSynthesizer: new MultiModalResponseSynthesizer(),
retriever: index.asRetriever({ similarityTopK: 3, imageSimilarityTopK: 1 }),
});
const result = await runWithCallbackManager(callbackManager, () =>
queryEngine.query({
query: "Tell me more about Vincent van Gogh's famous paintings",
}),
);
const result = await queryEngine.query({
query: "Tell me more about Vincent van Gogh's famous paintings",
});
console.log(result.response, "\n");
images.forEach((image) =>
console.log(`Image retrieved and used in inference: ${image.toString()}`),
+6 -7
View File
@@ -1,17 +1,17 @@
import {
ImageNode,
serviceContextFromDefaults,
storageContextFromDefaults,
Settings,
TextNode,
VectorStoreIndex,
storageContextFromDefaults,
} from "llamaindex";
// Update chunk size and overlap
Settings.chunkSize = 512;
Settings.chunkOverlap = 20;
export async function createIndex() {
// set up vector store index with two vector stores, one for text, the other for images
const serviceContext = serviceContextFromDefaults({
chunkSize: 512,
chunkOverlap: 20,
});
const storageContext = await storageContextFromDefaults({
persistDir: "storage",
storeImages: true,
@@ -19,7 +19,6 @@ export async function createIndex() {
return await VectorStoreIndex.init({
nodes: [],
storageContext,
serviceContext,
});
}
+2 -7
View File
@@ -1,8 +1,4 @@
import {
PGVectorStore,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
import { PGVectorStore, VectorStoreIndex } from "llamaindex";
async function main() {
const readline = require("readline").createInterface({
@@ -15,8 +11,7 @@ async function main() {
// Optional - set your collection name, default is no filter on this field.
// pgvs.setCollection();
const ctx = serviceContextFromDefaults();
const index = await VectorStoreIndex.fromVectorStore(pgvs, ctx);
const index = await VectorStoreIndex.fromVectorStore(pgvs);
// Query the index
const queryEngine = await index.asQueryEngine();
+2 -7
View File
@@ -1,8 +1,4 @@
import {
PineconeVectorStore,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
import { PineconeVectorStore, VectorStoreIndex } from "llamaindex";
async function main() {
const readline = require("readline").createInterface({
@@ -13,8 +9,7 @@ async function main() {
try {
const pcvs = new PineconeVectorStore();
const ctx = serviceContextFromDefaults();
const index = await VectorStoreIndex.fromVectorStore(pcvs, ctx);
const index = await VectorStoreIndex.fromVectorStore(pcvs);
// Query the index
const queryEngine = await index.asQueryEngine();
+1 -4
View File
@@ -4,7 +4,6 @@ import {
TreeSummarize,
TreeSummarizePrompt,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
const treeSummarizePrompt: TreeSummarizePrompt = ({ context, query }) => {
@@ -27,10 +26,8 @@ async function main() {
const query = "The quick brown fox jumps over the lazy dog";
const ctx = serviceContextFromDefaults({});
const responseSynthesizer = new ResponseSynthesizer({
responseBuilder: new TreeSummarize(ctx),
responseBuilder: new TreeSummarize(),
});
const queryEngine = index.asQueryEngine({
+14 -17
View File
@@ -4,12 +4,21 @@ import {
Document,
MetadataMode,
QdrantVectorStore,
Settings,
VectorStoreIndex,
runWithCallbackManager,
serviceContextFromDefaults,
storageContextFromDefaults,
} from "llamaindex";
// Update callback manager
Settings.callbackManager = new CallbackManager({
onRetrieve: (data) => {
console.log(
"The retrieved nodes are:",
data.nodes.map((node) => node.node.getContent(MetadataMode.NONE)),
);
},
});
// Load environment variables from local .env file
dotenv.config();
@@ -37,21 +46,9 @@ async function main() {
const ctx = await storageContextFromDefaults({ vectorStore: qdrantVs });
console.log("Embedding documents and adding to index");
const index = await runWithCallbackManager(
new CallbackManager({
onRetrieve: (data) => {
console.log(
"The retrieved nodes are:",
data.nodes.map((node) => node.node.getContent(MetadataMode.NONE)),
);
},
}),
() =>
VectorStoreIndex.fromDocuments(docs, {
storageContext: ctx,
serviceContext: serviceContextFromDefaults(),
}),
);
const index = await VectorStoreIndex.fromDocuments(docs, {
storageContext: ctx,
});
console.log(
"Querying index with no filters: Expected output: Brown probably",
+5 -9
View File
@@ -2,25 +2,21 @@ import {
CompactAndRefine,
OpenAI,
ResponseSynthesizer,
serviceContextFromDefaults,
Settings,
VectorStoreIndex,
} from "llamaindex";
import { PapaCSVReader } from "llamaindex/readers/CSVReader";
Settings.llm = new OpenAI({ model: "gpt-4" });
async function main() {
// Load CSV
const reader = new PapaCSVReader();
const path = "../data/titanic_train.csv";
const documents = await reader.loadData(path);
const serviceContext = serviceContextFromDefaults({
llm: new OpenAI({ model: "gpt-4" }),
});
// Split text and create embeddings. Store them in a VectorStoreIndex
const index = await VectorStoreIndex.fromDocuments(documents, {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments(documents);
const csvPrompt = ({ context = "", query = "" }) => {
return `The following CSV file is loaded from ${path}
@@ -32,7 +28,7 @@ Given the CSV file, generate me Typescript code to answer the question: ${query}
};
const responseSynthesizer = new ResponseSynthesizer({
responseBuilder: new CompactAndRefine(serviceContext, csvPrompt),
responseBuilder: new CompactAndRefine(undefined, csvPrompt),
});
const queryEngine = index.asQueryEngine({ responseSynthesizer });
+6 -10
View File
@@ -1,17 +1,15 @@
import { FireworksEmbedding, FireworksLLM, VectorStoreIndex } from "llamaindex";
import { PDFReader } from "llamaindex/readers/PDFReader";
import { serviceContextFromDefaults } from "llamaindex";
import { Settings } from "llamaindex";
const embedModel = new FireworksEmbedding({
model: "nomic-ai/nomic-embed-text-v1.5",
});
const llm = new FireworksLLM({
Settings.llm = new FireworksLLM({
model: "accounts/fireworks/models/mixtral-8x7b-instruct",
});
const serviceContext = serviceContextFromDefaults({ llm, embedModel });
Settings.embedModel = new FireworksEmbedding({
model: "nomic-ai/nomic-embed-text-v1.5",
});
async function main() {
// Load PDF
@@ -19,9 +17,7 @@ async function main() {
const documents = await reader.loadData("../data/brk-2022.pdf");
// Split text and create embeddings. Store them in a VectorStoreIndex
const index = await VectorStoreIndex.fromDocuments(documents, {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments(documents);
// Query the index
const queryEngine = index.asQueryEngine();
+7 -11
View File
@@ -1,30 +1,26 @@
import { OpenAI, OpenAIEmbedding, VectorStoreIndex } from "llamaindex";
import { PDFReader } from "llamaindex/readers/PDFReader";
import { serviceContextFromDefaults } from "llamaindex";
import { Settings } from "llamaindex";
const embedModel = new OpenAIEmbedding({
// Update llm and embedModel
Settings.llm = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0.1 });
Settings.embedModel = new OpenAIEmbedding({
model: "nomic-ai/nomic-embed-text-v1.5",
});
const llm = new OpenAI({
model: "accounts/fireworks/models/mixtral-8x7b-instruct",
});
const serviceContext = serviceContextFromDefaults({ llm, embedModel });
async function main() {
// Load PDF
const reader = new PDFReader();
const documents = await reader.loadData("../data/brk-2022.pdf");
// Split text and create embeddings. Store them in a VectorStoreIndex
const index = await VectorStoreIndex.fromDocuments(documents, {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments(documents);
// Query the index
const queryEngine = index.asQueryEngine();
const response = await queryEngine.query({
query: "What mistakes did Warren E. Buffett make?",
});
+1 -5
View File
@@ -1,16 +1,14 @@
import { execSync } from "child_process";
import {
PDFReader,
serviceContextFromDefaults,
storageContextFromDefaults,
VectorStoreIndex,
storageContextFromDefaults,
} from "llamaindex";
const STORAGE_DIR = "./cache";
async function main() {
// write the index to disk
const serviceContext = serviceContextFromDefaults({});
const storageContext = await storageContextFromDefaults({
persistDir: `${STORAGE_DIR}`,
});
@@ -18,7 +16,6 @@ async function main() {
const documents = await reader.loadData("data/brk-2022.pdf");
await VectorStoreIndex.fromDocuments(documents, {
storageContext,
serviceContext,
});
console.log("wrote index to disk - now trying to read it");
// make index dir read only
@@ -29,7 +26,6 @@ async function main() {
});
await VectorStoreIndex.init({
storageContext: readOnlyStorageContext,
serviceContext,
});
console.log("read only index successfully opened");
}
+2 -3
View File
@@ -1,5 +1,5 @@
import { OpenAI } from "llamaindex";
import { getCurrentCallbackManager } from "llamaindex/callbacks/CallbackManager";
import { Settings } from "llamaindex/Settings";
const llm = new OpenAI({
model: "gpt-4-0125-preview",
@@ -7,8 +7,7 @@ const llm = new OpenAI({
let tokenCount = 0;
// @todo: use GlobalSetting in the future
getCurrentCallbackManager().addHandlers("llm-start", (event) => {
Settings.callbackManager.on("llm-start", (event) => {
const { messages } = event.detail.payload;
tokenCount += llm.tokens(messages);
console.log("Token count:", tokenCount);
+4 -8
View File
@@ -2,22 +2,18 @@ import {
CohereRerank,
Document,
OpenAI,
Settings,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
import essay from "../essay";
Settings.llm = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0.1 });
async function main() {
const document = new Document({ text: essay, id_: "essay" });
const serviceContext = serviceContextFromDefaults({
llm: new OpenAI({ model: "gpt-3.5-turbo", temperature: 0.1 }),
});
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
const retriever = index.asRetriever();
+11 -19
View File
@@ -1,38 +1,31 @@
import {
OpenAI,
RouterQueryEngine,
Settings,
SimpleDirectoryReader,
SimpleNodeParser,
SummaryIndex,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
// Update llm
Settings.llm = new OpenAI();
// Update node parser
Settings.nodeParser = new SimpleNodeParser({
chunkSize: 1024,
});
async function main() {
// Load documents from a directory
const documents = await new SimpleDirectoryReader().loadData({
directoryPath: "node_modules/llamaindex/examples",
});
// Parse the documents into nodes
const nodeParser = new SimpleNodeParser({
chunkSize: 1024,
});
// Create a service context
const serviceContext = serviceContextFromDefaults({
nodeParser,
llm: new OpenAI(),
});
// Create indices
const vectorIndex = await VectorStoreIndex.fromDocuments(documents, {
serviceContext,
});
const vectorIndex = await VectorStoreIndex.fromDocuments(documents);
const summaryIndex = await SummaryIndex.fromDocuments(documents, {
serviceContext,
});
const summaryIndex = await SummaryIndex.fromDocuments(documents);
// Create query engines
const vectorQueryEngine = vectorIndex.asQueryEngine();
@@ -50,7 +43,6 @@ async function main() {
description: "Useful for retrieving specific context from Abramov",
},
],
serviceContext,
});
// Query the router query engine
+11 -12
View File
@@ -3,27 +3,25 @@ import {
HuggingFaceEmbedding,
MetadataReplacementPostProcessor,
SentenceWindowNodeParser,
Settings,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
import essay from "./essay";
// Update node parser and embed model
Settings.nodeParser = new SentenceWindowNodeParser({
windowSize: 3,
windowMetadataKey: "window",
originalTextMetadataKey: "original_text",
});
Settings.embedModel = new HuggingFaceEmbedding();
async function main() {
const document = new Document({ text: essay, id_: "essay" });
// create service context with sentence window parser
// and local embedding from HuggingFace
const nodeParser = new SentenceWindowNodeParser({
windowSize: 3,
windowMetadataKey: "window",
originalTextMetadataKey: "original_text",
});
const embedModel = new HuggingFaceEmbedding();
const serviceContext = serviceContextFromDefaults({ nodeParser, embedModel });
// Split text and create embeddings. Store them in a VectorStoreIndex
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
logProgress: true,
});
@@ -31,6 +29,7 @@ async function main() {
const queryEngine = index.asQueryEngine({
nodePostprocessors: [new MetadataReplacementPostProcessor("window")],
});
const response = await queryEngine.query({
query: "What did the author do in college?",
});
+8 -9
View File
@@ -1,22 +1,21 @@
import {
Document,
Settings,
SimpleNodeParser,
SummaryIndex,
SummaryRetrieverMode,
serviceContextFromDefaults,
} from "llamaindex";
import essay from "./essay";
// Update node parser
Settings.nodeParser = new SimpleNodeParser({
chunkSize: 40,
});
async function main() {
const serviceContext = serviceContextFromDefaults({
nodeParser: new SimpleNodeParser({
chunkSize: 40,
}),
});
const document = new Document({ text: essay, id_: "essay" });
const index = await SummaryIndex.fromDocuments([document], {
serviceContext,
});
const index = await SummaryIndex.fromDocuments([document]);
const queryEngine = index.asQueryEngine({
retriever: index.asRetriever({ mode: SummaryRetrieverMode.LLM }),
});
+10 -9
View File
@@ -2,12 +2,20 @@ import fs from "node:fs/promises";
import {
Document,
Settings,
TogetherEmbedding,
TogetherLLM,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
// Update llm to use TogetherAI
Settings.llm = new TogetherLLM({
model: "mistralai/Mixtral-8x7B-Instruct-v0.1",
});
// Update embedModel
Settings.embedModel = new TogetherEmbedding();
async function main() {
const apiKey = process.env.TOGETHER_API_KEY;
if (!apiKey) {
@@ -18,14 +26,7 @@ async function main() {
const document = new Document({ text: essay, id_: path });
const serviceContext = serviceContextFromDefaults({
llm: new TogetherLLM({ model: "mistralai/Mixtral-8x7B-Instruct-v0.1" }),
embedModel: new TogetherEmbedding(),
});
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
const queryEngine = index.asQueryEngine();
+7 -11
View File
@@ -2,14 +2,17 @@ import fs from "node:fs/promises";
import {
Anthropic,
anthropicTextQaPrompt,
CompactAndRefine,
Document,
ResponseSynthesizer,
serviceContextFromDefaults,
Settings,
VectorStoreIndex,
anthropicTextQaPrompt,
} from "llamaindex";
// Update llm to use Anthropic
Settings.llm = new Anthropic();
async function main() {
// Load essay from abramov.txt in Node
const path = "node_modules/llamaindex/examples/abramov.txt";
@@ -20,18 +23,11 @@ async function main() {
const document = new Document({ text: essay, id_: path });
// Split text and create embeddings. Store them in a VectorStoreIndex
const serviceContext = serviceContextFromDefaults({ llm: new Anthropic() });
const responseSynthesizer = new ResponseSynthesizer({
responseBuilder: new CompactAndRefine(
serviceContext,
anthropicTextQaPrompt,
),
responseBuilder: new CompactAndRefine(undefined, anthropicTextQaPrompt),
});
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// Query the index
const queryEngine = index.asQueryEngine({ responseSynthesizer });
+6 -8
View File
@@ -2,23 +2,21 @@ import {
Document,
OpenAI,
RetrieverQueryEngine,
serviceContextFromDefaults,
Settings,
SimilarityPostprocessor,
VectorStoreIndex,
} from "llamaindex";
import essay from "./essay";
// Update llm to use OpenAI
Settings.llm = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0.1 });
// Customize retrieval and query args
async function main() {
const document = new Document({ text: essay, id_: "essay" });
const serviceContext = serviceContextFromDefaults({
llm: new OpenAI({ model: "gpt-3.5-turbo", temperature: 0.1 }),
});
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
const retriever = index.asRetriever();
retriever.similarityTopK = 5;
+8 -11
View File
@@ -3,10 +3,16 @@ import fs from "node:fs/promises";
import {
Document,
OpenAIEmbedding,
Settings,
VectorStoreIndex,
serviceContextFromDefaults,
} from "llamaindex";
// Update embed model
Settings.embedModel = new OpenAIEmbedding({
model: "text-embedding-3-large",
dimensions: 1024,
});
async function main() {
// Load essay from abramov.txt in Node
const path = "node_modules/llamaindex/examples/abramov.txt";
@@ -16,17 +22,8 @@ async function main() {
// Create Document object with essay
const document = new Document({ text: essay, id_: path });
// Create service context and specify text-embedding-3-large
const embedModel = new OpenAIEmbedding({
model: "text-embedding-3-large",
dimensions: 1024,
});
const serviceContext = serviceContextFromDefaults({ embedModel });
// Split text and create embeddings. Store them in a VectorStoreIndex
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// Query the index
const queryEngine = index.asQueryEngine();
+10 -19
View File
@@ -2,7 +2,7 @@ import {
OpenAI,
ResponseSynthesizer,
RetrieverQueryEngine,
serviceContextFromDefaults,
Settings,
TextNode,
TreeSummarize,
VectorIndexRetriever,
@@ -14,6 +14,12 @@ import {
import { Index, Pinecone, RecordMetadata } from "@pinecone-database/pinecone";
// Update llm
Settings.llm = new OpenAI({
model: "gpt-4",
apiKey: process.env.OPENAI_API_KEY,
});
/**
* Please do not use this class in production; it's only for demonstration purposes.
*/
@@ -146,25 +152,11 @@ async function main() {
});
};
const getServiceContext = () => {
const openAI = new OpenAI({
model: "gpt-4",
apiKey: process.env.OPENAI_API_KEY,
});
return serviceContextFromDefaults({
llm: openAI,
});
};
const getQueryEngine = async (filter: unknown) => {
const vectorStore = await getPineconeVectorStore();
const serviceContext = getServiceContext();
const vectorStoreIndex = await VectorStoreIndex.fromVectorStore(
vectorStore,
serviceContext,
);
const vectorStoreIndex =
await VectorStoreIndex.fromVectorStore(vectorStore);
const retriever = new VectorIndexRetriever({
index: vectorStoreIndex,
@@ -172,8 +164,7 @@ async function main() {
});
const responseSynthesizer = new ResponseSynthesizer({
serviceContext,
responseBuilder: new TreeSummarize(serviceContext),
responseBuilder: new TreeSummarize(),
});
return new RetrieverQueryEngine(retriever, responseSynthesizer, {
+4 -13
View File
@@ -1,11 +1,8 @@
import fs from "node:fs/promises";
import {
Document,
OpenAI,
serviceContextFromDefaults,
VectorStoreIndex,
} from "llamaindex";
import { Document, OpenAI, Settings, VectorStoreIndex } from "llamaindex";
Settings.llm = new OpenAI({ model: "gpt-4" });
async function main() {
// Load essay from abramov.txt in Node
@@ -15,13 +12,7 @@ async function main() {
// Create Document object with essay
const document = new Document({ text: essay, id_: path });
// Split text and create embeddings. Store them in a VectorStoreIndex
const serviceContext = serviceContextFromDefaults({
llm: new OpenAI({ model: "gpt-4" }),
});
const index = await VectorStoreIndex.fromDocuments([document], {
serviceContext,
});
const index = await VectorStoreIndex.fromDocuments([document]);
// Query the index
const queryEngine = index.asQueryEngine();
+4
View File
@@ -68,6 +68,10 @@
"default": "./dist/cjs/index.js"
}
},
"./internal/*": {
"import": "./dist/not-allow.js",
"require": "./dist/cjs/not-allow.js"
},
"./*": {
"import": {
"types": "./dist/type/*.d.ts",
+3 -1
View File
@@ -16,5 +16,7 @@ export type RetrieveParams = {
*/
export interface BaseRetriever {
retrieve(params: RetrieveParams): Promise<NodeWithScore[]>;
getServiceContext(): ServiceContext;
// to be deprecated soon
serviceContext?: ServiceContext;
}
+2 -2
View File
@@ -1,8 +1,8 @@
import { PromptHelper } from "./PromptHelper.js";
import { OpenAIEmbedding } from "./embeddings/OpenAIEmbedding.js";
import type { BaseEmbedding } from "./embeddings/types.js";
import type { LLM } from "./llm/index.js";
import { OpenAI } from "./llm/index.js";
import { OpenAI } from "./llm/LLM.js";
import type { LLM } from "./llm/types.js";
import { SimpleNodeParser } from "./nodeParsers/SimpleNodeParser.js";
import type { NodeParser } from "./nodeParsers/types.js";
+215
View File
@@ -0,0 +1,215 @@
import { CallbackManager } from "./callbacks/CallbackManager.js";
import { OpenAIEmbedding } from "./embeddings/OpenAIEmbedding.js";
import { OpenAI } from "./llm/LLM.js";
import { PromptHelper } from "./PromptHelper.js";
import { SimpleNodeParser } from "./nodeParsers/SimpleNodeParser.js";
import { AsyncLocalStorage } from "@llamaindex/env";
import type { ServiceContext } from "./ServiceContext.js";
import type { BaseEmbedding } from "./embeddings/types.js";
import {
getCallbackManager,
setCallbackManager,
withCallbackManager,
} from "./internal/settings/CallbackManager.js";
import type { LLM } from "./llm/types.js";
import type { NodeParser } from "./nodeParsers/types.js";
export type PromptConfig = {
llm?: string;
lang?: string;
};
export interface Config {
prompt: PromptConfig;
llm: LLM | null;
promptHelper: PromptHelper | null;
embedModel: BaseEmbedding | null;
nodeParser: NodeParser | null;
callbackManager: CallbackManager | null;
chunkSize?: number;
chunkOverlap?: number;
}
/**
* @internal
*/
class GlobalSettings implements Config {
#prompt: PromptConfig = {};
#llm: LLM | null = null;
#promptHelper: PromptHelper | null = null;
#embedModel: BaseEmbedding | null = null;
#nodeParser: NodeParser | null = null;
#chunkSize?: number;
#chunkOverlap?: number;
#llmAsyncLocalStorage = new AsyncLocalStorage<LLM>();
#promptHelperAsyncLocalStorage = new AsyncLocalStorage<PromptHelper>();
#embedModelAsyncLocalStorage = new AsyncLocalStorage<BaseEmbedding>();
#nodeParserAsyncLocalStorage = new AsyncLocalStorage<NodeParser>();
#chunkSizeAsyncLocalStorage = new AsyncLocalStorage<number>();
#chunkOverlapAsyncLocalStorage = new AsyncLocalStorage<number>();
#promptAsyncLocalStorage = new AsyncLocalStorage<PromptConfig>();
get llm(): LLM {
if (this.#llm === null) {
this.#llm = new OpenAI();
}
return this.#llmAsyncLocalStorage.getStore() ?? this.#llm;
}
set llm(llm: LLM) {
this.#llm = llm;
}
withLLM<Result>(llm: LLM, fn: () => Result): Result {
return this.#llmAsyncLocalStorage.run(llm, fn);
}
get promptHelper(): PromptHelper {
if (this.#promptHelper === null) {
this.#promptHelper = new PromptHelper();
}
return this.#promptHelperAsyncLocalStorage.getStore() ?? this.#promptHelper;
}
set promptHelper(promptHelper: PromptHelper) {
this.#promptHelper = promptHelper;
}
withPromptHelper<Result>(
promptHelper: PromptHelper,
fn: () => Result,
): Result {
return this.#promptHelperAsyncLocalStorage.run(promptHelper, fn);
}
get embedModel(): BaseEmbedding {
if (this.#embedModel === null) {
this.#embedModel = new OpenAIEmbedding();
}
return this.#embedModelAsyncLocalStorage.getStore() ?? this.#embedModel;
}
set embedModel(embedModel: BaseEmbedding) {
this.#embedModel = embedModel;
}
withEmbedModel<Result>(embedModel: BaseEmbedding, fn: () => Result): Result {
return this.#embedModelAsyncLocalStorage.run(embedModel, fn);
}
get nodeParser(): NodeParser {
if (this.#nodeParser === null) {
this.#nodeParser = new SimpleNodeParser({
chunkSize: this.#chunkSize,
chunkOverlap: this.#chunkOverlap,
});
}
return this.#nodeParserAsyncLocalStorage.getStore() ?? this.#nodeParser;
}
set nodeParser(nodeParser: NodeParser) {
this.#nodeParser = nodeParser;
}
withNodeParser<Result>(nodeParser: NodeParser, fn: () => Result): Result {
return this.#nodeParserAsyncLocalStorage.run(nodeParser, fn);
}
get callbackManager(): CallbackManager {
return getCallbackManager();
}
set callbackManager(callbackManager: CallbackManager) {
setCallbackManager(callbackManager);
}
withCallbackManager<Result>(
callbackManager: CallbackManager,
fn: () => Result,
): Result {
return withCallbackManager(callbackManager, fn);
}
set chunkSize(chunkSize: number | undefined) {
this.#chunkSize = chunkSize;
}
get chunkSize(): number | undefined {
return this.#chunkSizeAsyncLocalStorage.getStore() ?? this.#chunkSize;
}
withChunkSize<Result>(chunkSize: number, fn: () => Result): Result {
return this.#chunkSizeAsyncLocalStorage.run(chunkSize, fn);
}
get chunkOverlap(): number | undefined {
return this.#chunkOverlapAsyncLocalStorage.getStore() ?? this.#chunkOverlap;
}
set chunkOverlap(chunkOverlap: number | undefined) {
this.#chunkOverlap = chunkOverlap;
}
withChunkOverlap<Result>(chunkOverlap: number, fn: () => Result): Result {
return this.#chunkOverlapAsyncLocalStorage.run(chunkOverlap, fn);
}
get prompt(): PromptConfig {
return this.#promptAsyncLocalStorage.getStore() ?? this.#prompt;
}
set prompt(prompt: PromptConfig) {
this.#prompt = prompt;
}
withPrompt<Result>(prompt: PromptConfig, fn: () => Result): Result {
return this.#promptAsyncLocalStorage.run(prompt, fn);
}
}
export const llmFromSettingsOrContext = (serviceContext?: ServiceContext) => {
if (serviceContext?.llm) {
return serviceContext.llm;
}
return Settings.llm;
};
export const nodeParserFromSettingsOrContext = (
serviceContext?: ServiceContext,
) => {
if (serviceContext?.nodeParser) {
return serviceContext.nodeParser;
}
return Settings.nodeParser;
};
export const embedModelFromSettingsOrContext = (
serviceContext?: ServiceContext,
) => {
if (serviceContext?.embedModel) {
return serviceContext.embedModel;
}
return Settings.embedModel;
};
export const promptHelperFromSettingsOrContext = (
serviceContext?: ServiceContext,
) => {
if (serviceContext?.promptHelper) {
return serviceContext.promptHelper;
}
return Settings.promptHelper;
};
export const Settings = new GlobalSettings();
+7 -29
View File
@@ -1,5 +1,5 @@
import type { Anthropic } from "@anthropic-ai/sdk";
import { AsyncLocalStorage, CustomEvent } from "@llamaindex/env";
import { CustomEvent } from "@llamaindex/env";
import type { NodeWithScore } from "../Node.js";
/**
@@ -135,30 +135,26 @@ export class CallbackManager implements CallbackManagerMethods {
* @deprecated will be removed in the next major version
*/
set onLLMStream(_: never) {
throw new Error(
"onLLMStream is deprecated. Use addHandlers('stream') instead",
);
throw new Error("onLLMStream is deprecated. Use on('stream') instead");
}
/**
* @deprecated will be removed in the next major version
*/
set onRetrieve(_: never) {
throw new Error(
"onRetrieve is deprecated. Use `addHandlers('retrieve')` instead",
);
throw new Error("onRetrieve is deprecated. Use `on('retrieve')` instead");
}
#handlers = new Map<keyof LlamaIndexEventMaps, EventHandler<CustomEvent>[]>();
constructor(handlers?: Partial<CallbackManagerMethods>) {
const onLLMStream = handlers?.onLLMStream ?? noop;
this.addHandlers("stream", (event) => onLLMStream(event.detail));
this.on("stream", (event) => onLLMStream(event.detail));
const onRetrieve = handlers?.onRetrieve ?? noop;
this.addHandlers("retrieve", (event) => onRetrieve(event.detail));
this.on("retrieve", (event) => onRetrieve(event.detail));
}
addHandlers<
on<
K extends keyof LlamaIndexEventMaps,
H extends EventHandler<LlamaIndexEventMaps[K]>,
>(event: K, handler: H) {
@@ -169,7 +165,7 @@ export class CallbackManager implements CallbackManagerMethods {
return this;
}
removeHandlers<
off<
K extends keyof LlamaIndexEventMaps,
H extends EventHandler<LlamaIndexEventMaps[K]>,
>(event: K, handler: H) {
@@ -195,21 +191,3 @@ export class CallbackManager implements CallbackManagerMethods {
handlers.forEach((handler) => handler(new CustomEvent(event, { detail })));
}
}
const defaultCallbackManager = new CallbackManager();
const callbackAsyncLocalStorage = new AsyncLocalStorage<CallbackManager>();
/**
* Get the current callback manager
* @default defaultCallbackManager if no callback manager is set
*/
export function getCurrentCallbackManager() {
return callbackAsyncLocalStorage.getStore() ?? defaultCallbackManager;
}
export function runWithCallbackManager<Result>(
callbackManager: CallbackManager,
fn: () => Result,
): Result {
return callbackAsyncLocalStorage.run(callbackManager, fn);
}
+2 -10
View File
@@ -3,9 +3,7 @@ import { globalsHelper } from "../GlobalsHelper.js";
import type { NodeWithScore } from "../Node.js";
import { ObjectType, jsonToNode } from "../Node.js";
import type { BaseRetriever, RetrieveParams } from "../Retriever.js";
import type { ServiceContext } from "../ServiceContext.js";
import { serviceContextFromDefaults } from "../ServiceContext.js";
import { getCurrentCallbackManager } from "../callbacks/CallbackManager.js";
import { Settings } from "../Settings.js";
import type { ClientParams, CloudConstructorParams } from "./types.js";
import { DEFAULT_PROJECT_NAME } from "./types.js";
import { getClient } from "./utils.js";
@@ -21,7 +19,6 @@ export class LlamaCloudRetriever implements BaseRetriever {
retrieveParams: CloudRetrieveParams;
projectName: string = DEFAULT_PROJECT_NAME;
pipelineName: string;
serviceContext: ServiceContext;
private resultNodesToNodeWithScore(
nodes: PlatformApi.TextNodeWithScore[],
@@ -45,7 +42,6 @@ export class LlamaCloudRetriever implements BaseRetriever {
if (params.projectName) {
this.projectName = params.projectName;
}
this.serviceContext = params.serviceContext ?? serviceContextFromDefaults();
}
private async getClient(): Promise<PlatformApiClient> {
@@ -81,7 +77,7 @@ export class LlamaCloudRetriever implements BaseRetriever {
const nodes = this.resultNodesToNodeWithScore(results.retrievalNodes);
getCurrentCallbackManager().onRetrieve({
Settings.callbackManager.onRetrieve({
query,
nodes,
event: globalsHelper.createEvent({
@@ -92,8 +88,4 @@ export class LlamaCloudRetriever implements BaseRetriever {
return nodes;
}
getServiceContext(): ServiceContext {
return this.serviceContext;
}
}
@@ -7,7 +7,7 @@ import {
} from "../../Prompt.js";
import type { Response } from "../../Response.js";
import type { ServiceContext } from "../../ServiceContext.js";
import { serviceContextFromDefaults } from "../../ServiceContext.js";
import { llmFromSettingsOrContext } from "../../Settings.js";
import type { ChatMessage, LLM } from "../../llm/index.js";
import { extractText, streamReducer } from "../../llm/utils.js";
import { PromptMixin } from "../../prompts/index.js";
@@ -48,7 +48,7 @@ export class CondenseQuestionChatEngine
this.queryEngine = init.queryEngine;
this.chatHistory = getHistory(init?.chatHistory);
this.llm = init?.serviceContext?.llm ?? serviceContextFromDefaults().llm;
this.llm = llmFromSettingsOrContext(init?.serviceContext);
this.condenseMessagePrompt =
init?.condenseMessagePrompt ?? defaultCondenseQuestionPrompt;
}
@@ -2,7 +2,6 @@ import { randomUUID } from "@llamaindex/env";
import type { NodeWithScore } from "../../Node.js";
import type { Response } from "../../Response.js";
import type { BaseRetriever } from "../../Retriever.js";
import type { ServiceContext } from "../../ServiceContext.js";
import type { Event } from "../../callbacks/CallbackManager.js";
import type { BaseNodePostprocessor } from "../../postprocessors/index.js";
import { PromptMixin } from "../../prompts/Mixin.js";
@@ -35,10 +34,11 @@ export class RetrieverQueryEngine
super();
this.retriever = retriever;
const serviceContext: ServiceContext | undefined =
this.retriever.getServiceContext();
this.responseSynthesizer =
responseSynthesizer || new ResponseSynthesizer({ serviceContext });
responseSynthesizer ||
new ResponseSynthesizer({
serviceContext: retriever.serviceContext,
});
this.preFilters = preFilters;
this.nodePostprocessors = nodePostprocessors || [];
}
@@ -1,7 +1,7 @@
import type { BaseNode } from "../../Node.js";
import { Response } from "../../Response.js";
import type { ServiceContext } from "../../ServiceContext.js";
import { serviceContextFromDefaults } from "../../ServiceContext.js";
import { llmFromSettingsOrContext } from "../../Settings.js";
import { PromptMixin } from "../../prompts/index.js";
import type { BaseSelector } from "../../selectors/index.js";
import { LLMSingleSelector } from "../../selectors/index.js";
@@ -55,8 +55,6 @@ async function combineResponses(
* A query engine that uses multiple query engines and selects the best one.
*/
export class RouterQueryEngine extends PromptMixin implements BaseQueryEngine {
serviceContext: ServiceContext;
private selector: BaseSelector;
private queryEngines: BaseQueryEngine[];
private metadatas: RouterQueryEngineMetadata[];
@@ -72,13 +70,12 @@ export class RouterQueryEngine extends PromptMixin implements BaseQueryEngine {
}) {
super();
this.serviceContext = init.serviceContext || serviceContextFromDefaults({});
this.selector = init.selector;
this.queryEngines = init.queryEngineTools.map((tool) => tool.queryEngine);
this.metadatas = init.queryEngineTools.map((tool) => ({
description: tool.description,
}));
this.summarizer = init.summarizer || new TreeSummarize(this.serviceContext);
this.summarizer = init.summarizer || new TreeSummarize(init.serviceContext);
this.verbose = init.verbose ?? false;
}
@@ -96,12 +93,14 @@ export class RouterQueryEngine extends PromptMixin implements BaseQueryEngine {
summarizer?: TreeSummarize;
verbose?: boolean;
}) {
const serviceContext =
init.serviceContext ?? serviceContextFromDefaults({});
const serviceContext = init.serviceContext;
return new RouterQueryEngine({
selector:
init.selector ?? new LLMSingleSelector({ llm: serviceContext.llm }),
init.selector ??
new LLMSingleSelector({
llm: llmFromSettingsOrContext(serviceContext),
}),
queryEngineTools: init.queryEngineTools,
serviceContext,
summarizer: init.summarizer,
@@ -4,7 +4,6 @@ import { TextNode } from "../../Node.js";
import { LLMQuestionGenerator } from "../../QuestionGenerator.js";
import type { Response } from "../../Response.js";
import type { ServiceContext } from "../../ServiceContext.js";
import { serviceContextFromDefaults } from "../../ServiceContext.js";
import type { Event } from "../../callbacks/CallbackManager.js";
import { PromptMixin } from "../../prompts/Mixin.js";
import type { BaseSynthesizer } from "../../synthesizers/index.js";
@@ -62,8 +61,7 @@ export class SubQuestionQueryEngine
responseSynthesizer?: BaseSynthesizer;
serviceContext?: ServiceContext;
}) {
const serviceContext =
init.serviceContext ?? serviceContextFromDefaults({});
const serviceContext = init.serviceContext;
const questionGen = init.questionGen ?? new LLMQuestionGenerator();
const responseSynthesizer =
+8 -8
View File
@@ -1,7 +1,7 @@
import { MetadataMode } from "../Node.js";
import type { ServiceContext } from "../ServiceContext.js";
import { serviceContextFromDefaults } from "../ServiceContext.js";
import type { ChatMessage } from "../llm/types.js";
import { llmFromSettingsOrContext } from "../Settings.js";
import type { ChatMessage, LLM } from "../llm/types.js";
import { PromptMixin } from "../prompts/Mixin.js";
import type { CorrectnessSystemPrompt } from "./prompts.js";
import {
@@ -24,20 +24,20 @@ type CorrectnessParams = {
/** Correctness Evaluator */
export class CorrectnessEvaluator extends PromptMixin implements BaseEvaluator {
private serviceContext: ServiceContext;
private scoreThreshold: number;
private parserFunction: (str: string) => [number, string];
private llm: LLM;
private correctnessPrompt: CorrectnessSystemPrompt =
defaultCorrectnessSystemPrompt;
constructor(params: CorrectnessParams) {
constructor(params?: CorrectnessParams) {
super();
this.serviceContext = params.serviceContext || serviceContextFromDefaults();
this.llm = llmFromSettingsOrContext(params?.serviceContext);
this.correctnessPrompt = defaultCorrectnessSystemPrompt;
this.scoreThreshold = params.scoreThreshold || 4.0;
this.parserFunction = params.parserFunction || defaultEvaluationParser;
this.scoreThreshold = params?.scoreThreshold ?? 4.0;
this.parserFunction = params?.parserFunction ?? defaultEvaluationParser;
}
_updatePrompts(prompts: {
@@ -80,7 +80,7 @@ export class CorrectnessEvaluator extends PromptMixin implements BaseEvaluator {
},
];
const evalResponse = await this.serviceContext.llm.chat({
const evalResponse = await this.llm.chat({
messages,
});
+6 -7
View File
@@ -1,6 +1,5 @@
import { Document, MetadataMode } from "../Node.js";
import type { ServiceContext } from "../ServiceContext.js";
import { serviceContextFromDefaults } from "../ServiceContext.js";
import { SummaryIndex } from "../indices/summary/index.js";
import { PromptMixin } from "../prompts/Mixin.js";
import type {
@@ -22,25 +21,25 @@ export class FaithfulnessEvaluator
extends PromptMixin
implements BaseEvaluator
{
private serviceContext: ServiceContext;
private serviceContext?: ServiceContext;
private raiseError: boolean;
private evalTemplate: FaithfulnessTextQAPrompt;
private refineTemplate: FaithfulnessRefinePrompt;
constructor(params: {
constructor(params?: {
serviceContext?: ServiceContext;
raiseError?: boolean;
faithfulnessSystemPrompt?: FaithfulnessTextQAPrompt;
faithFulnessRefinePrompt?: FaithfulnessRefinePrompt;
}) {
super();
this.serviceContext = params.serviceContext || serviceContextFromDefaults();
this.raiseError = params.raiseError || false;
this.serviceContext = params?.serviceContext;
this.raiseError = params?.raiseError ?? false;
this.evalTemplate =
params.faithfulnessSystemPrompt || defaultFaithfulnessTextQaPrompt;
params?.faithfulnessSystemPrompt ?? defaultFaithfulnessTextQaPrompt;
this.refineTemplate =
params.faithFulnessRefinePrompt || defaultFaithfulnessRefinePrompt;
params?.faithFulnessRefinePrompt ?? defaultFaithfulnessRefinePrompt;
}
protected _getPrompts(): { [x: string]: any } {
+7 -7
View File
@@ -1,6 +1,5 @@
import { Document, MetadataMode } from "../Node.js";
import type { ServiceContext } from "../ServiceContext.js";
import { serviceContextFromDefaults } from "../ServiceContext.js";
import { SummaryIndex } from "../indices/summary/index.js";
import { PromptMixin } from "../prompts/Mixin.js";
import type { RelevancyEvalPrompt, RelevancyRefinePrompt } from "./prompts.js";
@@ -23,19 +22,20 @@ type RelevancyParams = {
};
export class RelevancyEvaluator extends PromptMixin implements BaseEvaluator {
private serviceContext: ServiceContext;
private serviceContext?: ServiceContext;
private raiseError: boolean;
private evalTemplate: RelevancyEvalPrompt;
private refineTemplate: RelevancyRefinePrompt;
constructor(params: RelevancyParams) {
constructor(params?: RelevancyParams) {
super();
this.serviceContext = params.serviceContext ?? serviceContextFromDefaults();
this.raiseError = params.raiseError ?? false;
this.evalTemplate = params.evalTemplate ?? defaultRelevancyEvalPrompt;
this.refineTemplate = params.refineTemplate ?? defaultRelevancyRefinePrompt;
this.serviceContext = params?.serviceContext;
this.raiseError = params?.raiseError ?? false;
this.evalTemplate = params?.evalTemplate ?? defaultRelevancyEvalPrompt;
this.refineTemplate =
params?.refineTemplate ?? defaultRelevancyRefinePrompt;
}
_getPrompts() {
+1
View File
@@ -8,6 +8,7 @@ export * from "./QuestionGenerator.js";
export * from "./Response.js";
export * from "./Retriever.js";
export * from "./ServiceContext.js";
export { Settings } from "./Settings.js";
export * from "./TextSplitter.js";
export * from "./agent/index.js";
export * from "./callbacks/CallbackManager.js";
+5 -3
View File
@@ -1,6 +1,7 @@
import type { BaseNode, Document } from "../Node.js";
import type { BaseRetriever } from "../Retriever.js";
import type { ServiceContext } from "../ServiceContext.js";
import { nodeParserFromSettingsOrContext } from "../Settings.js";
import { runTransformations } from "../ingestion/IngestionPipeline.js";
import type { StorageContext } from "../storage/StorageContext.js";
import type { BaseDocumentStore } from "../storage/docStore/types.js";
@@ -15,6 +16,7 @@ import { IndexStructType } from "./json-to-index-struct.js";
export class KeywordTable extends IndexStruct {
table: Map<string, Set<string>> = new Map();
type: IndexStructType = IndexStructType.KEYWORD_TABLE;
addNode(keywords: string[], nodeId: string): void {
keywords.forEach((keyword) => {
if (!this.table.has(keyword)) {
@@ -42,7 +44,7 @@ export class KeywordTable extends IndexStruct {
}
export interface BaseIndexInit<T> {
serviceContext: ServiceContext;
serviceContext?: ServiceContext;
storageContext: StorageContext;
docStore: BaseDocumentStore;
vectorStore?: VectorStore;
@@ -55,7 +57,7 @@ export interface BaseIndexInit<T> {
* they can be retrieved for our queries.
*/
export abstract class BaseIndex<T> {
serviceContext: ServiceContext;
serviceContext?: ServiceContext;
storageContext: StorageContext;
docStore: BaseDocumentStore;
vectorStore?: VectorStore;
@@ -94,7 +96,7 @@ export abstract class BaseIndex<T> {
async insert(document: Document) {
const nodes = await runTransformations(
[document],
[this.serviceContext.nodeParser],
[nodeParserFromSettingsOrContext(this.serviceContext)],
);
await this.insertNodes(nodes);
this.docStore.setDocumentHash(document.id_, document.hash);
+14 -12
View File
@@ -27,11 +27,15 @@ import {
simpleExtractKeywords,
} from "./utils.js";
import { llmFromSettingsOrContext } from "../../Settings.js";
import type { LLM } from "../../llm/types.js";
export interface KeywordIndexOptions {
nodes?: BaseNode[];
indexStruct?: KeywordTable;
indexId?: string;
serviceContext?: ServiceContext;
llm?: LLM;
storageContext?: StorageContext;
}
export enum KeywordTableRetrieverMode {
@@ -45,7 +49,7 @@ abstract class BaseKeywordTableRetriever implements BaseRetriever {
protected index: KeywordTableIndex;
protected indexStruct: KeywordTable;
protected docstore: BaseDocumentStore;
protected serviceContext: ServiceContext;
protected llm: LLM;
protected maxKeywordsPerQuery: number; // Maximum number of keywords to extract from query.
protected numChunksPerQuery: number; // Maximum number of text chunks to query.
@@ -68,7 +72,7 @@ abstract class BaseKeywordTableRetriever implements BaseRetriever {
this.index = index;
this.indexStruct = index.indexStruct;
this.docstore = index.docStore;
this.serviceContext = index.serviceContext;
this.llm = llmFromSettingsOrContext(index.serviceContext);
this.maxKeywordsPerQuery = maxKeywordsPerQuery;
this.numChunksPerQuery = numChunksPerQuery;
@@ -101,16 +105,12 @@ abstract class BaseKeywordTableRetriever implements BaseRetriever {
return sortedNodes.map((node) => ({ node }));
}
getServiceContext(): ServiceContext {
return this.index.serviceContext;
}
}
// Extracts keywords using LLMs.
export class KeywordTableLLMRetriever extends BaseKeywordTableRetriever {
async getKeywords(query: string): Promise<string[]> {
const response = await this.serviceContext.llm.complete({
const response = await this.llm.complete({
prompt: this.queryKeywordExtractTemplate({
question: query,
maxKeywords: this.maxKeywordsPerQuery,
@@ -156,8 +156,7 @@ export class KeywordTableIndex extends BaseIndex<KeywordTable> {
static async init(options: KeywordIndexOptions): Promise<KeywordTableIndex> {
const storageContext =
options.storageContext ?? (await storageContextFromDefaults({}));
const serviceContext =
options.serviceContext ?? serviceContextFromDefaults({});
const serviceContext = options.serviceContext;
const { docStore, indexStore } = storageContext;
// Setup IndexStruct from storage
@@ -247,13 +246,16 @@ export class KeywordTableIndex extends BaseIndex<KeywordTable> {
static async extractKeywords(
text: string,
serviceContext: ServiceContext,
serviceContext?: ServiceContext,
): Promise<Set<string>> {
const response = await serviceContext.llm.complete({
const llm = llmFromSettingsOrContext(serviceContext);
const response = await llm.complete({
prompt: defaultKeywordExtractPrompt({
context: text,
}),
});
return extractKeywordsGivenResponse(response.text, "KEYWORDS:");
}
@@ -300,7 +302,7 @@ export class KeywordTableIndex extends BaseIndex<KeywordTable> {
static async buildIndexFromNodes(
nodes: BaseNode[],
docStore: BaseDocumentStore,
serviceContext: ServiceContext,
serviceContext?: ServiceContext,
): Promise<KeywordTable> {
const indexStruct = new KeywordTable();
await docStore.addDocuments(nodes, true);
+19 -18
View File
@@ -5,8 +5,11 @@ import type { ChoiceSelectPrompt } from "../../Prompt.js";
import { defaultChoiceSelectPrompt } from "../../Prompt.js";
import type { BaseRetriever, RetrieveParams } from "../../Retriever.js";
import type { ServiceContext } from "../../ServiceContext.js";
import { serviceContextFromDefaults } from "../../ServiceContext.js";
import { getCurrentCallbackManager } from "../../callbacks/CallbackManager.js";
import {
Settings,
llmFromSettingsOrContext,
nodeParserFromSettingsOrContext,
} from "../../Settings.js";
import { RetrieverQueryEngine } from "../../engines/query/index.js";
import type { BaseNodePostprocessor } from "../../postprocessors/index.js";
import type { StorageContext } from "../../storage/StorageContext.js";
@@ -58,8 +61,7 @@ export class SummaryIndex extends BaseIndex<IndexList> {
static async init(options: SummaryIndexOptions): Promise<SummaryIndex> {
const storageContext =
options.storageContext ?? (await storageContextFromDefaults({}));
const serviceContext =
options.serviceContext ?? serviceContextFromDefaults({});
const serviceContext = options.serviceContext;
const { docStore, indexStore } = storageContext;
// Setup IndexStruct from storage
@@ -130,7 +132,7 @@ export class SummaryIndex extends BaseIndex<IndexList> {
): Promise<SummaryIndex> {
let { storageContext, serviceContext } = args;
storageContext = storageContext ?? (await storageContextFromDefaults({}));
serviceContext = serviceContext ?? serviceContextFromDefaults({});
serviceContext = serviceContext;
const docStore = storageContext.docStore;
docStore.addDocuments(documents, true);
@@ -138,7 +140,11 @@ export class SummaryIndex extends BaseIndex<IndexList> {
docStore.setDocumentHash(doc.id_, doc.hash);
}
const nodes = serviceContext.nodeParser.getNodesFromDocuments(documents);
const nodes =
nodeParserFromSettingsOrContext(serviceContext).getNodesFromDocuments(
documents,
);
const index = await SummaryIndex.init({
nodes,
storageContext,
@@ -292,7 +298,7 @@ export class SummaryIndexRetriever implements BaseRetriever {
score: 1,
}));
getCurrentCallbackManager().onRetrieve({
Settings.callbackManager.onRetrieve({
query,
nodes: result,
event: globalsHelper.createEvent({
@@ -303,10 +309,6 @@ export class SummaryIndexRetriever implements BaseRetriever {
return result;
}
getServiceContext(): ServiceContext {
return this.index.serviceContext;
}
}
/**
@@ -318,7 +320,7 @@ export class SummaryIndexLLMRetriever implements BaseRetriever {
choiceBatchSize: number;
formatNodeBatchFn: NodeFormatterFunction;
parseChoiceSelectAnswerFn: ChoiceSelectParserFunction;
serviceContext: ServiceContext;
serviceContext?: ServiceContext;
// eslint-disable-next-line max-params
constructor(
@@ -351,8 +353,11 @@ export class SummaryIndexLLMRetriever implements BaseRetriever {
const fmtBatchStr = this.formatNodeBatchFn(nodesBatch);
const input = { context: fmtBatchStr, query: query };
const llm = llmFromSettingsOrContext(this.serviceContext);
const rawResponse = (
await this.serviceContext.llm.complete({
await llm.complete({
prompt: this.choiceSelectPrompt(input),
})
).text;
@@ -375,7 +380,7 @@ export class SummaryIndexLLMRetriever implements BaseRetriever {
results.push(...nodeWithScores);
}
getCurrentCallbackManager().onRetrieve({
Settings.callbackManager.onRetrieve({
query,
nodes: results,
event: globalsHelper.createEvent({
@@ -386,10 +391,6 @@ export class SummaryIndexLLMRetriever implements BaseRetriever {
return results;
}
getServiceContext(): ServiceContext {
return this.serviceContext;
}
}
// Legacy
+13 -16
View File
@@ -13,11 +13,12 @@ import {
} from "../../Node.js";
import type { BaseRetriever, RetrieveParams } from "../../Retriever.js";
import type { ServiceContext } from "../../ServiceContext.js";
import { serviceContextFromDefaults } from "../../ServiceContext.js";
import {
getCurrentCallbackManager,
type Event,
} from "../../callbacks/CallbackManager.js";
Settings,
embedModelFromSettingsOrContext,
nodeParserFromSettingsOrContext,
} from "../../Settings.js";
import { type Event } from "../../callbacks/CallbackManager.js";
import { DEFAULT_SIMILARITY_TOP_K } from "../../constants.js";
import type {
BaseEmbedding,
@@ -79,7 +80,7 @@ export class VectorStoreIndex extends BaseIndex<IndexDict> {
super(init);
this.indexStore = init.indexStore;
this.vectorStore = init.vectorStore ?? init.storageContext.vectorStore;
this.embedModel = init.serviceContext.embedModel;
this.embedModel = embedModelFromSettingsOrContext(init.serviceContext);
this.imageVectorStore =
init.imageVectorStore ?? init.storageContext.imageVectorStore;
if (this.imageVectorStore) {
@@ -97,8 +98,7 @@ export class VectorStoreIndex extends BaseIndex<IndexDict> {
): Promise<VectorStoreIndex> {
const storageContext =
options.storageContext ?? (await storageContextFromDefaults({}));
const serviceContext =
options.serviceContext ?? serviceContextFromDefaults({});
const serviceContext = options.serviceContext;
const indexStore = storageContext.indexStore;
const docStore = storageContext.docStore;
@@ -222,7 +222,7 @@ export class VectorStoreIndex extends BaseIndex<IndexDict> {
: DocStoreStrategy.DUPLICATES_ONLY);
args.storageContext =
args.storageContext ?? (await storageContextFromDefaults({}));
args.serviceContext = args.serviceContext ?? serviceContextFromDefaults({});
args.serviceContext = args.serviceContext;
const docStore = args.storageContext.docStore;
if (args.logProgress) {
@@ -237,7 +237,7 @@ export class VectorStoreIndex extends BaseIndex<IndexDict> {
);
args.nodes = await runTransformations(
documents,
[args.serviceContext.nodeParser],
[nodeParserFromSettingsOrContext(args.serviceContext)],
{},
{ docStoreStrategy },
);
@@ -249,7 +249,7 @@ export class VectorStoreIndex extends BaseIndex<IndexDict> {
static async fromVectorStore(
vectorStore: VectorStore,
serviceContext: ServiceContext,
serviceContext?: ServiceContext,
imageVectorStore?: VectorStore,
) {
if (!vectorStore.storesText) {
@@ -424,7 +424,8 @@ export class VectorIndexRetriever implements BaseRetriever {
index: VectorStoreIndex;
similarityTopK: number;
imageSimilarityTopK: number;
private serviceContext: ServiceContext;
serviceContext?: ServiceContext;
constructor({
index,
@@ -491,7 +492,7 @@ export class VectorIndexRetriever implements BaseRetriever {
nodesWithScores: NodeWithScore<Metadata>[],
parentEvent: Event | undefined,
) {
getCurrentCallbackManager().onRetrieve({
Settings.callbackManager.onRetrieve({
query,
nodes: nodesWithScores,
event: globalsHelper.createEvent({
@@ -540,8 +541,4 @@ export class VectorIndexRetriever implements BaseRetriever {
return nodesWithScores;
}
getServiceContext(): ServiceContext {
return this.serviceContext;
}
}
@@ -0,0 +1,25 @@
import { AsyncLocalStorage } from "@llamaindex/env";
import { CallbackManager } from "../../callbacks/CallbackManager.js";
const callbackManagerAsyncLocalStorage =
new AsyncLocalStorage<CallbackManager>();
let globalCallbackManager: CallbackManager | null = null;
export function getCallbackManager(): CallbackManager {
if (globalCallbackManager === null) {
globalCallbackManager = new CallbackManager();
}
return callbackManagerAsyncLocalStorage.getStore() ?? globalCallbackManager;
}
export function setCallbackManager(callbackManager: CallbackManager) {
globalCallbackManager = callbackManager;
}
export function withCallbackManager<Result>(
callbackManager: CallbackManager,
fn: () => Result,
): Result {
return callbackManagerAsyncLocalStorage.run(callbackManager, fn);
}
+3 -3
View File
@@ -1,7 +1,6 @@
import type OpenAILLM from "openai";
import type { ClientOptions as OpenAIClientOptions } from "openai";
import {
getCurrentCallbackManager,
type Event,
type EventType,
type OpenAIStreamToken,
@@ -11,6 +10,7 @@ import {
import type { ChatCompletionMessageParam } from "openai/resources/index.js";
import type { LLMOptions } from "portkey-ai";
import { Tokenizers, globalsHelper } from "../GlobalsHelper.js";
import { getCallbackManager } from "../internal/settings/CallbackManager.js";
import type { AnthropicSession } from "./anthropic.js";
import { getAnthropicSession } from "./anthropic.js";
import type { AzureOpenAIConfig } from "./azure.js";
@@ -290,7 +290,7 @@ export class OpenAI extends BaseLLM {
};
//Now let's wrap our stream in a callback
const onLLMStream = getCurrentCallbackManager().onLLMStream;
const onLLMStream = getCallbackManager().onLLMStream;
const chunk_stream: AsyncIterable<OpenAIStreamToken> =
await this.session.openai.chat.completions.create({
@@ -835,7 +835,7 @@ export class Portkey extends BaseLLM {
params?: Record<string, any>,
): AsyncIterable<ChatResponseChunk> {
// Wrapping the stream in a callback.
const onLLMStream = getCurrentCallbackManager().onLLMStream;
const onLLMStream = getCallbackManager().onLLMStream;
const chunkStream = await this.session.portkey.chatCompletions.create({
messages,
+2 -2
View File
@@ -1,6 +1,6 @@
import { getEnv } from "@llamaindex/env";
import { Settings } from "../Settings.js";
import {
getCurrentCallbackManager,
type Event,
type EventType,
type StreamCallbackResponse,
@@ -123,7 +123,7 @@ export class MistralAI extends BaseLLM {
parentEvent,
}: LLMChatParamsStreaming): AsyncIterable<ChatResponseChunk> {
//Now let's wrap our stream in a callback
const onLLMStream = getCurrentCallbackManager().onLLMStream;
const onLLMStream = Settings.callbackManager.onLLMStream;
const client = await this.session.getClient();
const chunkStream = await client.chatStream(this.buildParams(messages));
+4 -4
View File
@@ -1,4 +1,4 @@
import { getCurrentCallbackManager } from "../callbacks/CallbackManager.js";
import { getCallbackManager } from "../internal/settings/CallbackManager.js";
import type { ChatResponse, LLM, LLMChat, MessageContent } from "./types.js";
export async function* streamConverter<S, D>(
@@ -55,7 +55,7 @@ export function llmEvent(
this: LLM,
...params: Parameters<LLMChat["chat"]>
): ReturnType<LLMChat["chat"]> {
getCurrentCallbackManager().dispatchEvent("llm-start", {
getCallbackManager().dispatchEvent("llm-start", {
payload: {
messages: params[0].messages,
},
@@ -82,14 +82,14 @@ export function llmEvent(
}
yield chunk;
}
getCurrentCallbackManager().dispatchEvent("llm-end", {
getCallbackManager().dispatchEvent("llm-end", {
payload: {
response: finalResponse,
},
});
};
} else {
getCurrentCallbackManager().dispatchEvent("llm-end", {
getCallbackManager().dispatchEvent("llm-end", {
payload: {
response,
},
+1
View File
@@ -0,0 +1 @@
throw new Error("Not allowed to import internal modules directly.");
+2 -1
View File
@@ -1,4 +1,5 @@
import type { ServiceContext } from "../ServiceContext.js";
import { llmFromSettingsOrContext } from "../Settings.js";
import type { BaseSelector } from "./base.js";
import { LLMMultiSelector, LLMSingleSelector } from "./llmSelectors.js";
@@ -8,7 +9,7 @@ export const getSelectorFromContext = (
): BaseSelector => {
let selector: BaseSelector | null = null;
const llm = serviceContext.llm;
const llm = llmFromSettingsOrContext(serviceContext);
if (isMulti) {
selector = new LLMMultiSelector({ llm });
@@ -2,7 +2,7 @@ import type { ImageNode } from "../Node.js";
import { MetadataMode, splitNodesByType } from "../Node.js";
import { Response } from "../Response.js";
import type { ServiceContext } from "../ServiceContext.js";
import { serviceContextFromDefaults } from "../ServiceContext.js";
import { llmFromSettingsOrContext } from "../Settings.js";
import { imageToDataUrl } from "../embeddings/index.js";
import type { MessageContentDetail } from "../llm/types.js";
import { PromptMixin } from "../prompts/Mixin.js";
@@ -18,7 +18,7 @@ export class MultiModalResponseSynthesizer
extends PromptMixin
implements BaseSynthesizer
{
serviceContext: ServiceContext;
serviceContext?: ServiceContext;
metadataMode: MetadataMode;
textQATemplate: TextQaPrompt;
@@ -29,7 +29,7 @@ export class MultiModalResponseSynthesizer
}: Partial<MultiModalResponseSynthesizer> = {}) {
super();
this.serviceContext = serviceContext ?? serviceContextFromDefaults();
this.serviceContext = serviceContext;
this.metadataMode = metadataMode ?? MetadataMode.NONE;
this.textQATemplate = textQATemplate ?? defaultTextQaPrompt;
}
@@ -85,10 +85,14 @@ export class MultiModalResponseSynthesizer
{ type: "text", text: textPrompt },
...images,
];
const response = await this.serviceContext.llm.complete({
const llm = llmFromSettingsOrContext(this.serviceContext);
const response = await llm.complete({
prompt,
parentEvent,
});
return new Response(response.text, nodes);
}
}
@@ -1,7 +1,6 @@
import { MetadataMode } from "../Node.js";
import { Response } from "../Response.js";
import type { ServiceContext } from "../ServiceContext.js";
import { serviceContextFromDefaults } from "../ServiceContext.js";
import { streamConverter } from "../llm/utils.js";
import { PromptMixin } from "../prompts/Mixin.js";
import type { ResponseBuilderPrompts } from "./builders.js";
@@ -21,7 +20,6 @@ export class ResponseSynthesizer
implements BaseSynthesizer
{
responseBuilder: ResponseBuilder;
serviceContext: ServiceContext;
metadataMode: MetadataMode;
constructor({
@@ -35,9 +33,8 @@ export class ResponseSynthesizer
} = {}) {
super();
this.serviceContext = serviceContext ?? serviceContextFromDefaults();
this.responseBuilder =
responseBuilder ?? getResponseBuilder(this.serviceContext);
responseBuilder ?? getResponseBuilder(serviceContext);
this.metadataMode = metadataMode;
}
+13 -9
View File
@@ -16,6 +16,10 @@ import type { PromptHelper } from "../PromptHelper.js";
import { getBiggestPrompt } from "../PromptHelper.js";
import { PromptMixin } from "../prompts/Mixin.js";
import type { ServiceContext } from "../ServiceContext.js";
import {
llmFromSettingsOrContext,
promptHelperFromSettingsOrContext,
} from "../Settings.js";
import type {
ResponseBuilder,
ResponseBuilderParamsNonStreaming,
@@ -39,8 +43,8 @@ export class SimpleResponseBuilder implements ResponseBuilder {
llm: LLM;
textQATemplate: TextQaPrompt;
constructor(serviceContext: ServiceContext, textQATemplate?: TextQaPrompt) {
this.llm = serviceContext.llm;
constructor(serviceContext?: ServiceContext, textQATemplate?: TextQaPrompt) {
this.llm = llmFromSettingsOrContext(serviceContext);
this.textQATemplate = textQATemplate ?? defaultTextQaPrompt;
}
@@ -84,14 +88,14 @@ export class Refine extends PromptMixin implements ResponseBuilder {
refineTemplate: RefinePrompt;
constructor(
serviceContext: ServiceContext,
serviceContext?: ServiceContext,
textQATemplate?: TextQaPrompt,
refineTemplate?: RefinePrompt,
) {
super();
this.llm = serviceContext.llm;
this.promptHelper = serviceContext.promptHelper;
this.llm = llmFromSettingsOrContext(serviceContext);
this.promptHelper = promptHelperFromSettingsOrContext(serviceContext);
this.textQATemplate = textQATemplate ?? defaultTextQaPrompt;
this.refineTemplate = refineTemplate ?? defaultRefinePrompt;
}
@@ -293,13 +297,13 @@ export class TreeSummarize extends PromptMixin implements ResponseBuilder {
summaryTemplate: TreeSummarizePrompt;
constructor(
serviceContext: ServiceContext,
serviceContext?: ServiceContext,
summaryTemplate?: TreeSummarizePrompt,
) {
super();
this.llm = serviceContext.llm;
this.promptHelper = serviceContext.promptHelper;
this.llm = llmFromSettingsOrContext(serviceContext);
this.promptHelper = promptHelperFromSettingsOrContext(serviceContext);
this.summaryTemplate = summaryTemplate ?? defaultTreeSummarizePrompt;
}
@@ -383,7 +387,7 @@ export class TreeSummarize extends PromptMixin implements ResponseBuilder {
}
export function getResponseBuilder(
serviceContext: ServiceContext,
serviceContext?: ServiceContext,
responseMode?: ResponseMode,
): ResponseBuilder {
switch (responseMode) {
+6 -7
View File
@@ -11,14 +11,12 @@ import {
import { Document } from "llamaindex/Node";
import type { ServiceContext } from "llamaindex/ServiceContext";
import { serviceContextFromDefaults } from "llamaindex/ServiceContext";
import { Settings } from "llamaindex/Settings";
import type {
RetrievalCallbackResponse,
StreamCallbackResponse,
} from "llamaindex/callbacks/CallbackManager";
import {
CallbackManager,
runWithCallbackManager,
} from "llamaindex/callbacks/CallbackManager";
import { CallbackManager } from "llamaindex/callbacks/CallbackManager";
import { OpenAIEmbedding } from "llamaindex/embeddings/index";
import { SummaryIndex } from "llamaindex/indices/summary/index";
import { VectorStoreIndex } from "llamaindex/indices/vectorStore/index";
@@ -83,7 +81,7 @@ describe("CallbackManager: onLLMStream and onRetrieve", () => {
});
const queryEngine = vectorStoreIndex.asQueryEngine();
const query = "What is the author's name?";
const response = await runWithCallbackManager(callbackManager, () => {
const response = await Settings.withCallbackManager(callbackManager, () => {
return queryEngine.query({ query });
});
@@ -164,8 +162,9 @@ describe("CallbackManager: onLLMStream and onRetrieve", () => {
responseSynthesizer,
});
const query = "What is the author's name?";
const response = await runWithCallbackManager(callbackManager, async () =>
queryEngine.query({ query }),
const response = await Settings.withCallbackManager(
callbackManager,
async () => queryEngine.query({ query }),
);
expect(response.toString()).toBe("MOCK_TOKEN_1-MOCK_TOKEN_2");
expect(streamCallbackData).toEqual([
@@ -1,6 +1,9 @@
import { JSONQueryEngine } from "@llamaindex/experimental";
import { OpenAI, serviceContextFromDefaults } from "llamaindex";
import { OpenAI, Settings } from "llamaindex";
// Update LLM
Settings.llm = new OpenAI({ model: "gpt-4" });
const jsonValue = {
blogPosts: [
@@ -84,22 +87,14 @@ const jsonSchema = {
};
async function main() {
const llm = new OpenAI({ model: "gpt-4" });
const serviceContext = serviceContextFromDefaults({
llm,
});
const jsonQueryEngine = new JSONQueryEngine({
jsonValue,
jsonSchema,
serviceContext,
});
const rawQueryEngine = new JSONQueryEngine({
jsonValue,
jsonSchema,
serviceContext,
synthesizeResponse: false,
});
-1
View File
@@ -8,7 +8,6 @@
"forceConsistentCasingInFileNames": true,
"strict": true,
"skipLibCheck": true,
"stripInternal": true,
"outDir": "./lib",
"tsBuildInfoFile": "./lib/.tsbuildinfo",
"incremental": true,