Trigger Build

Co-authored-by: Marcus Schiesser <mail@marcusschiesser.de>

.changeset/config.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://unpkg.com/@changesets/config@2.3.1/schema.json",
   "changelog": "@changesets/cli/changelog",
-  "commit": true,
+  "commit": false,
   "fixed": [],
   "linked": [],
   "access": "public",

.changeset/fresh-pugs-explain.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+Add pipeline.register to create a managed index in LlamaCloud

.changeset/quick-fans-battle.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+fix: support import subdirectory

.changeset/strange-ducks-kiss.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+feat: use claude3 with react agent

.changeset/violet-bags-hide.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+feat: add wikipedia tool

.eslintrc.js

@@ -11,5 +11,13 @@ module.exports = {
     "max-params": ["error", 4],
     "prefer-const": "error",
   },
+  overrides: [
+    {
+      files: ["examples/**/*.ts"],
+      rules: {
+        "turbo/no-undeclared-env-vars": "off",
+      },
+    },
+  ],
   ignorePatterns: ["dist/", "lib/"],
 };

.github/workflows/e2e.yml

@@ -1,68 +0,0 @@
-name: E2E Tests
-on:
-  push:
-    branches: [main]
-  pull_request:
-    paths:
-      - "packages/create-llama/**"
-      - ".github/workflows/e2e.yml"
-    branches: [main]
-
-env:
-  POETRY_VERSION: "1.6.1"
-
-jobs:
-  e2e:
-    name: create-llama
-    timeout-minutes: 60
-    strategy:
-      fail-fast: true
-      matrix:
-        node-version: [18, 20]
-        python-version: ["3.11"]
-        os: [macos-latest, windows-latest]
-    defaults:
-      run:
-        shell: bash
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          version: ${{ env.POETRY_VERSION }}
-      - uses: pnpm/action-setup@v2
-      - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: "pnpm"
-      - name: Install dependencies
-        run: pnpm install
-      - name: Install Playwright Browsers
-        run: pnpm exec playwright install --with-deps
-        working-directory: ./packages/create-llama
-      - name: Build create-llama
-        run: pnpm run build
-        working-directory: ./packages/create-llama
-      - name: Pack
-        run: pnpm pack --pack-destination ./output
-        working-directory: ./packages/create-llama
-      - name: Extract Pack
-        run: tar -xvzf ./output/*.tgz -C ./output
-        working-directory: ./packages/create-llama
-      - name: Run Playwright tests
-        run: pnpm exec playwright test
-        env:
-          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
-        working-directory: ./packages/create-llama
-      - uses: actions/upload-artifact@v3
-        if: always()
-        with:
-          name: playwright-report
-          path: ./packages/create-llama/playwright-report/
-          retention-days: 30

.github/workflows/publish.yml

@@ -0,0 +1,36 @@
+name: Publish
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ".nvmrc"
+          cache: "pnpm"
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Publish @llamaindex/env
+        run: npx jsr publish
+        working-directory: packages/env
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish @llamaindex/core
+        run: npx jsr publish --allow-slow-types
+        working-directory: packages/core
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -44,6 +44,24 @@ jobs:
           name: typecheck-build-dist
           path: ./packages/core/dist
           if-no-files-found: error
+  core-edge-runtime:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ".nvmrc"
+          cache: "pnpm"
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build
+        run: pnpm run build --filter @llamaindex/edge
+      - name: Build Edge Runtime
+        run: pnpm run build
+        working-directory: ./packages/edge/e2e/test-edge-runtime
   typecheck-examples:
     runs-on: ubuntu-latest
 

.gitignore

@@ -44,6 +44,7 @@ test-results/
 playwright-report/
 blob-report/
 playwright/.cache/
+.tsbuildinfo
 
 # intellij
 **/.idea

CONTRIBUTING.md

@@ -79,13 +79,27 @@ That should start a webserver which will serve the docs on https://localhost:300
 
 Any changes you make should be reflected in the browser. If you need to regenerate the API docs and find that your TSDoc isn't getting the updates, feel free to remove apps/docs/api. It will automatically regenerate itself when you run pnpm start again.
 
-## Publishing
+## Changeset
 
-To publish a new version of the library, run
+We use [changesets](https://github.com/changesets/changesets) for managing versions and changelogs. To create a new changeset, run:
+
+```
+pnpm changeset
+```
+
+Please send a descriptive changeset for each PR.
+
+## Publishing (maintainers only)
+
+To publish a new version of the library, first create a new version:
+
+```shell
+pnpm new-version
+```
+
+If everything looks good, commit the generated files and release the new version:
 
 ```shell
-pnpm new-llamaindex
-pnpm new-create-llama
 pnpm release
 git push # push to the main branch
 git push --tags

README.md

@@ -121,6 +121,42 @@ const nextConfig = {
 module.exports = nextConfig;
 ```
 
+### NextJS with Milvus:
+
+As proto files are not loaded per default in NextJS, you'll need to add the following to your next.config.js to have it load the proto files.
+
+```js
+const path = require("path");
+const CopyWebpackPlugin = require("copy-webpack-plugin");
+
+// next.config.js
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  webpack: (config, { isServer }) => {
+    if (isServer) {
+      // Copy the proto files to the server build directory
+      config.plugins.push(
+        new CopyWebpackPlugin({
+          patterns: [
+            {
+              from: path.join(
+                __dirname,
+                "node_modules/@zilliz/milvus2-sdk-node/dist",
+              ),
+              to: path.join(__dirname, ".next"),
+            },
+          ],
+        }),
+      );
+    }
+    // Important: return the modified config
+    return config;
+  },
+};
+
+module.exports = nextConfig;
+```
+
 ## Supported LLMs:
 
 - OpenAI GPT-3.5-turbo and GPT-4

apps/docs/CHANGELOG.md

@@ -1,5 +1,12 @@
 # docs
 
+## 0.0.4
+
+### Patch Changes
+
+- Updated dependencies [5116ad8]
+  - @llamaindex/env@0.0.5
+
 ## 0.0.3
 
 ### Patch Changes

apps/docs/docs/modules/embeddings/available_embeddings/huggingface.md

@@ -23,3 +23,15 @@ const results = await queryEngine.query({
   query,
 });
 ```
+
+Per default, `HuggingFaceEmbedding` is using the `Xenova/all-MiniLM-L6-v2` model. You can change the model by passing the `modelType` parameter to the constructor.
+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({
+  modelType: "BAAI/bge-small-en-v1.5",
+  quantized: false,
+});
+```

apps/docs/docs/modules/ingestion_pipeline/transformations.md

@@ -1,6 +1,6 @@
 # Transformations
 
-A transformation is something that takes a list of nodes as an input, and returns a list of nodes. Each component that implements the Transformatio class has both a `transform` definition responsible for transforming the nodes
+A transformation is something that takes a list of nodes as an input, and returns a list of nodes. Each component that implements the Transformation class has both a `transform` definition responsible for transforming the nodes.
 
 Currently, the following components are Transformation objects:
 

apps/docs/docs/modules/node_postprocessors/index.md

@@ -36,7 +36,7 @@ const processor = new SimilarityPostprocessor({
   similarityCutoff: 0.7,
 });
 
-const filteredNodes = processor.postprocessNodes(nodes);
+const filteredNodes = await processor.postprocessNodes(nodes);
 
 // cohere rerank: rerank nodes given query using trained model
 const reranker = new CohereRerank({
@@ -100,7 +100,7 @@ const response = await queryEngine.query("<user_query>");
 ```ts
 import { SimilarityPostprocessor } from "llamaindex";
 
-nodes = await index.asRetriever().retrieve("test query str");
+nodes = await index.asRetriever().retrieve({ query: "test query str" });
 
 const processor = new SimilarityPostprocessor({
   similarityCutoff: 0.7,

apps/docs/docs/modules/retriever.md

@@ -11,7 +11,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Fetch nodes!
-const nodesWithScore = await retriever.retrieve("query string");
+const nodesWithScore = await retriever.retrieve({ query: "query string" });
 ```
 
 ## API Reference

apps/docs/i18n/ar/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // جلب العقد!
-const nodesWithScore = await retriever.retrieve("سلسلة الاستعلام");
+const nodesWithScore = await retriever.retrieve({ query: "سلسلة الاستعلام" });
 ```
 
 ## مرجع الواجهة البرمجية (API Reference)

apps/docs/i18n/bg/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Извличане на върхове!
-const nodesWithScore = await retriever.retrieve("query string");
+const nodesWithScore = await retriever.retrieve({ query: "query string" });
 ```
 
 ## API Reference (API справка)

apps/docs/i18n/cat/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const recuperador = vector_index.asRetriever();
 recuperador.similarityTopK = 3;
 
 // Obteniu els nodes!
-const nodesAmbPuntuació = await recuperador.retrieve("cadena de consulta");
+const nodesAmbPuntuació = await recuperador.retrieve({ query: "cadena de consulta" });
 ```
 
 ## Referència de l'API

apps/docs/i18n/cs/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Získání uzlů!
-const nodesWithScore = await retriever.retrieve("dotazovací řetězec");
+const nodesWithScore = await retriever.retrieve({ query: "dotazovací řetězec" });
 ```
 
 ## API Reference (Odkazy na rozhraní)

apps/docs/i18n/da/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Hent noder!
-const nodesWithScore = await retriever.retrieve("forespørgselsstreng");
+const nodesWithScore = await retriever.retrieve({ query: "forespørgselsstreng" });
 ```
 
 ## API Reference

apps/docs/i18n/de/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Knoten abrufen!
-const nodesWithScore = await retriever.retrieve("Abfragezeichenfolge");
+const nodesWithScore = await retriever.retrieve({ query: "Abfragezeichenfolge" });
 ```
 
 ## API-Referenz

apps/docs/i18n/el/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Ανάκτηση κόμβων!
-const nodesWithScore = await retriever.retrieve("συμβολοσειρά ερωτήματος");
+const nodesWithScore = await retriever.retrieve({ query: "συμβολοσειρά ερωτήματος" });
 ```
 
 ## Αναφορά API

apps/docs/i18n/es/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const recuperador = vector_index.asRetriever();
 recuperador.similarityTopK = 3;
 
 // ¡Obtener nodos!
-const nodosConPuntuación = await recuperador.retrieve("cadena de consulta");
+const nodosConPuntuación = await recuperador.retrieve({ query: "cadena de consulta" });
 ```
 
 ## Referencia de la API

apps/docs/i18n/et/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Too sõlmed!
-const nodesWithScore = await retriever.retrieve("päringu string");
+const nodesWithScore = await retriever.retrieve({ query: "päringu string" });
 ```
 
 ## API viide

apps/docs/i18n/fa/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // بازیابی گره ها!
-const nodesWithScore = await retriever.retrieve("رشته پرس و جو");
+const nodesWithScore = await retriever.retrieve({ query: "رشته پرس و جو" });
 ```
 
 ## مرجع API

apps/docs/i18n/fi/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Hae solmut!
-const nodesWithScore = await retriever.retrieve("kyselymerkkijono");
+const nodesWithScore = await retriever.retrieve({ query: "kyselymerkkijono" });
 ```
 
 ## API-viite

apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -11,7 +11,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Récupérer les nœuds !
-const nodesWithScore = await retriever.retrieve("chaîne de requête");
+const nodesWithScore = await retriever.retrieve({ query: "chaîne de requête" });
 ```
 
 ## Référence de l'API

apps/docs/i18n/he/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // אחזור צמתים!
-const nodesWithScore = await retriever.retrieve("מחרוזת שאילתה");
+const nodesWithScore = await retriever.retrieve({ query: "מחרוזת שאילתה" });
 ```
 
 ## מדריך לממשק API

apps/docs/i18n/hi/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // नोड्स प्राप्त करें!
-const nodesWithScore = await retriever.retrieve("क्वेरी स्ट्रिंग");
+const nodesWithScore = await retriever.retrieve({ query: "क्वेरी स्ट्रिंग" });
 ```
 
 ## एपीआई संदर्भ (API Reference)

apps/docs/i18n/hr/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const dohvatnik = vector_index.asRetriever();
 dohvatnik.similarityTopK = 3;
 
 // Dohvati čvorove!
-const čvoroviSaRezultatom = await dohvatnik.retrieve("upitni niz");
+const čvoroviSaRezultatom = await dohvatnik.retrieve({ query: "upitni niz" });
 ```
 
 ## API Referenca

apps/docs/i18n/hu/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Node-ok lekérése!
-const nodesWithScore = await retriever.retrieve("lekérdezési karakterlánc");
+const nodesWithScore = await retriever.retrieve({ query: "lekérdezési karakterlánc" });
 ```
 
 ## API Referencia

apps/docs/i18n/in/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Mengambil node!
-const nodesWithScore = await retriever.retrieve("string query");
+const nodesWithScore = await retriever.retrieve({ query: "string query" });
 ```
 
 ## Referensi API

apps/docs/i18n/it/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Recupera i nodi!
-const nodesWithScore = await retriever.retrieve("stringa di query");
+const nodesWithScore = await retriever.retrieve({ query: "stringa di query" });
 ```
 
 ## Riferimento API

apps/docs/i18n/ja/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // ノードを取得します！
-const nodesWithScore = await retriever.retrieve("クエリ文字列");
+const nodesWithScore = await retriever.retrieve({ query: "クエリ文字列" });
 ```
 
 ## API リファレンス

apps/docs/i18n/ko/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // 노드를 가져옵니다!
-const nodesWithScore = await retriever.retrieve("쿼리 문자열");
+const nodesWithScore = await retriever.retrieve({ query: "쿼리 문자열" });
 ```
 
 ## API 참조

apps/docs/i18n/lt/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const gavėjas = vector_index.asRetriever();
 gavėjas.similarityTopK = 3;
 
 // Išgaunami mazgai!
-const mazgaiSuRezultatu = await gavėjas.retrieve("užklausos eilutė");
+const mazgaiSuRezultatu = await gavėjas.retrieve({ query: "užklausos eilutė" });
 ```
 
 ## API nuorodos (API Reference)

apps/docs/i18n/nl/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Haal knooppunten op!
-const nodesWithScore = await retriever.retrieve("zoekopdracht");
+const nodesWithScore = await retriever.retrieve({ query: "zoekopdracht" });
 ```
 
 ## API Referentie

apps/docs/i18n/no/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Hent noder!
-const nodesWithScore = await retriever.retrieve("spørringsstreng");
+const nodesWithScore = await retriever.retrieve({ query: "spørringsstreng" });
 ```
 
 ## API-referanse

apps/docs/i18n/pl/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Pobierz węzły!
-const nodesWithScore = await retriever.retrieve("ciąg zapytania");
+const nodesWithScore = await retriever.retrieve({ query: "ciąg zapytania" });
 ```
 
 ## Dokumentacja interfejsu API

apps/docs/i18n/pt/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const recuperador = vector_index.asRetriever();
 recuperador.similarityTopK = 3;
 
 // Buscar nós!
-const nósComPontuação = await recuperador.retrieve("string de consulta");
+const nósComPontuação = await recuperador.retrieve({ query: "string de consulta" });
 ```
 
 ## Referência da API

apps/docs/i18n/ro/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const recuperator = vector_index.asRetriever();
 recuperator.similarityTopK = 3;
 
 // Preia nodurile!
-const noduriCuScor = await recuperator.retrieve("șir de interogare");
+const noduriCuScor = await recuperator.retrieve({ query: "șir de interogare" });
 ```
 
 ## Referință API

apps/docs/i18n/ru/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Получение узлов!
-const nodesWithScore = await retriever.retrieve("строка запроса");
+const nodesWithScore = await retriever.retrieve({ query: "строка запроса" });
 ```
 
 ## Справочник по API

apps/docs/i18n/se/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Dohvati čvorove!
-const nodesWithScore = await retriever.retrieve("upitni niz");
+const nodesWithScore = await retriever.retrieve({ query: "upitni niz" });
 ```
 
 ## API Referenca

apps/docs/i18n/sk/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const pridobitelj = vector_index.asRetriever();
 pridobitelj.similarityTopK = 3;
 
 // Pridobivanje vozlišč!
-const vozliščaZRezultatom = await pridobitelj.retrieve("poizvedbeni niz");
+const vozliščaZRezultatom = await pridobitelj.retrieve({ query: "poizvedbeni niz" });
 ```
 
 ## API Sklic

apps/docs/i18n/sl/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Získajte uzly!
-const nodesWithScore = await retriever.retrieve("reťazec dotazu");
+const nodesWithScore = await retriever.retrieve({ query: "reťazec dotazu" });
 ```
 
 ## API Referencia

apps/docs/i18n/sv/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Hämta noder!
-const nodesWithScore = await retriever.retrieve("frågesträng");
+const nodesWithScore = await retriever.retrieve({ query: "frågesträng" });
 ```
 
 ## API-referens

apps/docs/i18n/th/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // เรียกคืนโหนด!
-const nodesWithScore = await retriever.retrieve("query string");
+const nodesWithScore = await retriever.retrieve({ query: "query string" });
 ```
 
 ## API Reference (การอ้างอิง API)

apps/docs/i18n/tr/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Düğümleri getir!
-const nodesWithScore = await retriever.retrieve("sorgu dizesi");
+const nodesWithScore = await retriever.retrieve({ query: "sorgu dizesi" });
 ```
 
 ## API Referansı

apps/docs/i18n/uk/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Отримати вузли!
-const nodesWithScore = await retriever.retrieve("рядок запиту");
+const nodesWithScore = await retriever.retrieve({ query: "рядок запиту" });
 ```
 
 ## Довідник API

apps/docs/i18n/vi/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Lấy các node!
-const nodesWithScore = await retriever.retrieve("chuỗi truy vấn");
+const nodesWithScore = await retriever.retrieve({ query: "chuỗi truy vấn" });
 ```
 
 ## Tài liệu tham khảo API

apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -11,7 +11,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // 获取节点！
-const nodesWithScore = await retriever.retrieve("查询字符串");
+const nodesWithScore = await retriever.retrieve({ query: "查询字符串" });
 ```
 
 ## API 参考

apps/docs/i18n/zh_tw/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // 提取節點！
-const nodesWithScore = await retriever.retrieve("查詢字串");
+const nodesWithScore = await retriever.retrieve({ query: "查詢字串" });
 ```
 
 ## API 參考

apps/docs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docs",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",

examples/CHANGELOG.md

@@ -0,0 +1,14 @@
+# examples
+
+## 0.0.4
+
+### Patch Changes
+
+- d2e8d0c: add support for Milvus vector store
+- Updated dependencies [d2e8d0c]
+- Updated dependencies [aefc326]
+- Updated dependencies [484a710]
+- Updated dependencies [d766bd0]
+- Updated dependencies [dd95927]
+- Updated dependencies [bf583a7]
+  - llamaindex@0.2.0

examples/agent/query_openai_agent.ts

@@ -8,7 +8,7 @@ import {
 async function main() {
   // Load the documents
   const documents = await new SimpleDirectoryReader().loadData({
-    directoryPath: "node_modules/llamaindex/examples/",
+    directoryPath: "node_modules/llamaindex/examples",
   });
 
   // Create a vector index from the documents

examples/agent/react_agent.ts

@@ -1,4 +1,4 @@
-import { FunctionTool, ReActAgent } from "llamaindex";
+import { Anthropic, FunctionTool, ReActAgent } from "llamaindex";
 
 // Define a function to sum two numbers
 function sumNumbers({ a, b }: { a: number; b: number }): number {
@@ -56,8 +56,14 @@ async function main() {
     parameters: divideJSON,
   });
 
-  // Create an OpenAIAgent with the function tools
+  const anthropic = new Anthropic({
+    apiKey: process.env.ANTHROPIC_API_KEY,
+    model: "claude-3-opus",
+  });
+
+  // Create an ReActAgent with the function tools
   const agent = new ReActAgent({
+    llm: anthropic,
     tools: [functionTool, functionTool2],
     verbose: true,
   });

examples/agent/step_wise_openai.ts

@@ -0,0 +1,95 @@
+import { FunctionTool, OpenAIAgent } from "llamaindex";
+
+// Define a function to sum two numbers
+function sumNumbers({ a, b }: { a: number; b: number }): number {
+  return a + b;
+}
+
+// Define a function to divide two numbers
+function divideNumbers({ a, b }: { a: number; b: number }): number {
+  return a / b;
+}
+
+// Define the parameters of the sum function as a JSON schema
+const sumJSON = {
+  type: "object",
+  properties: {
+    a: {
+      type: "number",
+      description: "The first number",
+    },
+    b: {
+      type: "number",
+      description: "The second number",
+    },
+  },
+  required: ["a", "b"],
+};
+
+const divideJSON = {
+  type: "object",
+  properties: {
+    a: {
+      type: "number",
+      description: "The dividend a to divide",
+    },
+    b: {
+      type: "number",
+      description: "The divisor b to divide by",
+    },
+  },
+  required: ["a", "b"],
+};
+
+async function main() {
+  // Create a function tool from the sum function
+  const functionTool = new FunctionTool(sumNumbers, {
+    name: "sumNumbers",
+    description: "Use this function to sum two numbers",
+    parameters: sumJSON,
+  });
+
+  // Create a function tool from the divide function
+  const functionTool2 = new FunctionTool(divideNumbers, {
+    name: "divideNumbers",
+    description: "Use this function to divide two numbers",
+    parameters: divideJSON,
+  });
+
+  // Create an OpenAIAgent with the function tools
+  const agent = new OpenAIAgent({
+    tools: [functionTool, functionTool2],
+    verbose: true,
+  });
+
+  // Create a task to sum and divide numbers
+  const task = agent.createTask("How much is 5 + 5? then divide by 2");
+
+  let count = 0;
+
+  while (true) {
+    const stepOutput = await agent.runStep(task.taskId);
+
+    console.log(`Runnning step ${count++}`);
+    console.log(`======== OUTPUT ==========`);
+    if (stepOutput.output.response) {
+      console.log(stepOutput.output.response);
+    } else {
+      console.log(stepOutput.output.sources);
+    }
+    console.log(`==========================`);
+
+    if (stepOutput.isLast) {
+      const finalResponse = await agent.finalizeResponse(
+        task.taskId,
+        stepOutput,
+      );
+      console.log({ finalResponse });
+      break;
+    }
+  }
+}
+
+main().then(() => {
+  console.log("Done");
+});

examples/agent/step_wise_query_tool.ts

@@ -8,7 +8,7 @@ import {
 async function main() {
   // Load the documents
   const documents = await new SimpleDirectoryReader().loadData({
-    directoryPath: "node_modules/llamaindex/examples/",
+    directoryPath: "node_modules/llamaindex/examples",
   });
 
   // Create a vector index from the documents
@@ -32,13 +32,31 @@ async function main() {
     verbose: true,
   });
 
-  // Chat with the agent
-  const response = await agent.chat({
-    message: "What was his salary?",
-  });
+  const task = agent.createTask("What was his salary?");
 
-  // Print the response
-  console.log(String(response));
+  let count = 0;
+
+  while (true) {
+    const stepOutput = await agent.runStep(task.taskId);
+
+    console.log(`Runnning step ${count++}`);
+    console.log(`======== OUTPUT ==========`);
+    if (stepOutput.output.response) {
+      console.log(stepOutput.output.response);
+    } else {
+      console.log(stepOutput.output.sources);
+    }
+    console.log(`==========================`);
+
+    if (stepOutput.isLast) {
+      const finalResponse = await agent.finalizeResponse(
+        task.taskId,
+        stepOutput,
+      );
+      console.log({ finalResponse });
+      break;
+    }
+  }
 }
 
 main().then(() => {

examples/agent/step_wise_react.ts

@@ -0,0 +1,90 @@
+import { FunctionTool, ReActAgent } from "llamaindex";
+
+// Define a function to sum two numbers
+function sumNumbers({ a, b }: { a: number; b: number }): number {
+  return a + b;
+}
+
+// Define a function to divide two numbers
+function divideNumbers({ a, b }: { a: number; b: number }): number {
+  return a / b;
+}
+
+// Define the parameters of the sum function as a JSON schema
+const sumJSON = {
+  type: "object",
+  properties: {
+    a: {
+      type: "number",
+      description: "The first number",
+    },
+    b: {
+      type: "number",
+      description: "The second number",
+    },
+  },
+  required: ["a", "b"],
+};
+
+const divideJSON = {
+  type: "object",
+  properties: {
+    a: {
+      type: "number",
+      description: "The dividend",
+    },
+    b: {
+      type: "number",
+      description: "The divisor",
+    },
+  },
+  required: ["a", "b"],
+};
+
+async function main() {
+  // Create a function tool from the sum function
+  const functionTool = new FunctionTool(sumNumbers, {
+    name: "sumNumbers",
+    description: "Use this function to sum two numbers",
+    parameters: sumJSON,
+  });
+
+  // Create a function tool from the divide function
+  const functionTool2 = new FunctionTool(divideNumbers, {
+    name: "divideNumbers",
+    description: "Use this function to divide two numbers",
+    parameters: divideJSON,
+  });
+
+  // Create an OpenAIAgent with the function tools
+  const agent = new ReActAgent({
+    tools: [functionTool, functionTool2],
+    verbose: true,
+  });
+
+  const task = agent.createTask("Divide 16 by 2 then add 20");
+
+  let count = 0;
+
+  while (true) {
+    const stepOutput = await agent.runStep(task.taskId);
+
+    console.log(`Runnning step ${count++}`);
+    console.log(`======== OUTPUT ==========`);
+    console.log(stepOutput.output);
+    console.log(`==========================`);
+
+    if (stepOutput.isLast) {
+      const finalResponse = await agent.finalizeResponse(
+        task.taskId,
+        stepOutput,
+      );
+      console.log({ finalResponse });
+      break;
+    }
+  }
+}
+
+main().then(() => {
+  console.log("Done");
+});

examples/agent/stream_openai_agent.ts

@@ -0,0 +1,77 @@
+import { FunctionTool, OpenAIAgent } from "llamaindex";
+
+// Define a function to sum two numbers
+function sumNumbers({ a, b }: { a: number; b: number }): number {
+  return a + b;
+}
+
+// Define a function to divide two numbers
+function divideNumbers({ a, b }: { a: number; b: number }): number {
+  return a / b;
+}
+
+// Define the parameters of the sum function as a JSON schema
+const sumJSON = {
+  type: "object",
+  properties: {
+    a: {
+      type: "number",
+      description: "The first number",
+    },
+    b: {
+      type: "number",
+      description: "The second number",
+    },
+  },
+  required: ["a", "b"],
+};
+
+const divideJSON = {
+  type: "object",
+  properties: {
+    a: {
+      type: "number",
+      description: "The dividend",
+    },
+    b: {
+      type: "number",
+      description: "The divisor",
+    },
+  },
+  required: ["a", "b"],
+};
+
+async function main() {
+  // Create a function tool from the sum function
+  const functionTool = new FunctionTool(sumNumbers, {
+    name: "sumNumbers",
+    description: "Use this function to sum two numbers",
+    parameters: sumJSON,
+  });
+
+  // Create a function tool from the divide function
+  const functionTool2 = new FunctionTool(divideNumbers, {
+    name: "divideNumbers",
+    description: "Use this function to divide two numbers",
+    parameters: divideJSON,
+  });
+
+  // Create an OpenAIAgent with the function tools
+  const agent = new OpenAIAgent({
+    tools: [functionTool, functionTool2],
+    verbose: false,
+  });
+
+  const stream = await agent.chat({
+    message: "Divide 16 by 2 then add 20",
+    stream: true,
+  });
+
+  for await (const chunk of stream.response) {
+    process.stdout.write(chunk.response);
+  }
+}
+
+main().then(() => {
+  console.log("\nDone");
+});

examples/agent/wikipedia-tool.ts

@@ -0,0 +1,23 @@
+import { OpenAIAgent, WikipediaTool } from "llamaindex";
+
+async function main() {
+  const wikipediaTool = new WikipediaTool();
+
+  // Create an OpenAIAgent with the function tools
+  const agent = new OpenAIAgent({
+    tools: [wikipediaTool],
+    verbose: true,
+  });
+
+  // Chat with the agent
+  const response = await agent.chat({
+    message: "Where is Ho Chi Minh City?",
+  });
+
+  // Print the response
+  console.log(response);
+}
+
+main().then(() => {
+  console.log("Done");
+});

examples/anthropic/chat.ts

@@ -3,6 +3,7 @@ import { Anthropic } from "llamaindex";
 (async () => {
   const anthropic = new Anthropic({
     apiKey: process.env.ANTHROPIC_API_KEY,
+    model: "claude-3-opus",
   });
   const result = await anthropic.chat({
     messages: [

examples/anthropic/chat_interactive.ts

@@ -0,0 +1,34 @@
+import { Anthropic, SimpleChatEngine, SimpleChatHistory } from "llamaindex";
+import { stdin as input, stdout as output } from "node:process";
+import readline from "node:readline/promises";
+
+(async () => {
+  const llm = new Anthropic({
+    apiKey: process.env.ANTHROPIC_API_KEY,
+    model: "claude-3-opus",
+  });
+  // chatHistory will store all the messages in the conversation
+  const chatHistory = new SimpleChatHistory({
+    messages: [
+      {
+        content: "You want to talk in rhymes.",
+        role: "system",
+      },
+    ],
+  });
+  const chatEngine = new SimpleChatEngine({
+    llm,
+    chatHistory,
+  });
+  const rl = readline.createInterface({ input, output });
+
+  while (true) {
+    const query = await rl.question("User: ");
+    process.stdout.write("Assistant: ");
+    const stream = await chatEngine.chat({ message: query, stream: true });
+    for await (const chunk of stream) {
+      process.stdout.write(chunk.response);
+    }
+    process.stdout.write("\n");
+  }
+})();

examples/anthropic/haiku.ts

@@ -0,0 +1,19 @@
+import { Anthropic } from "llamaindex";
+
+(async () => {
+  const anthropic = new Anthropic({
+    apiKey: process.env.ANTHROPIC_API_KEY,
+    model: "claude-3-haiku",
+  });
+  const result = await anthropic.chat({
+    messages: [
+      { content: "You want to talk in rhymes.", role: "system" },
+      {
+        content:
+          "How much wood would a woodchuck chuck if a woodchuck could chuck wood?",
+        role: "user",
+      },
+    ],
+  });
+  console.log(result);
+})();

examples/anthropic/stream.ts

@@ -0,0 +1,23 @@
+import { Anthropic } from "llamaindex";
+
+(async () => {
+  const anthropic = new Anthropic({
+    apiKey: process.env.ANTHROPIC_API_KEY,
+    model: "claude-instant-1.2",
+  });
+  const stream = await anthropic.chat({
+    messages: [
+      { content: "You want to talk in rhymes.", role: "system" },
+      {
+        content:
+          "How much wood would a woodchuck chuck if a woodchuck could chuck wood?",
+        role: "user",
+      },
+    ],
+    stream: true,
+  });
+
+  for await (const chunk of stream) {
+    process.stdout.write(chunk.delta);
+  }
+})();

examples/astradb/README.md

@@ -32,10 +32,10 @@ run `ts-node astradb/example`
 
 This sample loads the same dataset of movie reviews as the Astra Portal sample dataset. (Feel free to load the data in your the Astra Data Explorer to compare)
 
-run `ts-node astradb/load`
+run `npx ts-node astradb/load`
 
 ### Use RAG to Query the data
 
 Check out your data in the Astra Data Explorer and change the sample query as you see fit.
 
-run `ts-node astradb/query`
+run `npx ts-node astradb/query`

examples/cloud/README.md

@@ -31,3 +31,11 @@ This example shows how to use the managed index with a query engine.
 ```shell
 pnpx ts-node cloud/query.ts
 ```
+
+## Pipeline
+
+This example shows how to create a managed index with a pipeline.
+
+```shell
+pnpx ts-node cloud/pipeline.ts
+```

examples/cloud/pipeline.ts

@@ -0,0 +1,34 @@
+import fs from "node:fs/promises";
+
+import {
+  Document,
+  IngestionPipeline,
+  OpenAIEmbedding,
+  SimpleNodeParser,
+} from "llamaindex";
+
+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 pipeline = new IngestionPipeline({
+    name: "pipeline",
+    transformations: [
+      new SimpleNodeParser({ chunkSize: 1024, chunkOverlap: 20 }),
+      new OpenAIEmbedding({ apiKey: "api-key" }),
+    ],
+  });
+
+  const pipelineId = await pipeline.register({
+    documents: [document],
+    verbose: true,
+  });
+
+  console.log(`Pipeline with id ${pipelineId} successfully created.`);
+}
+
+main().catch(console.error);

examples/milvus/README.md

@@ -0,0 +1,34 @@
+# Milvus Vector Store
+
+Here are two sample scripts which work with loading and querying data from a Milvus Vector Store.
+
+## Prerequisites
+
+- An Milvus Vector Database
+  - Hosted https://milvus.io/
+  - Self Hosted https://milvus.io/docs/install_standalone-docker.md
+- An OpenAI API Key
+
+## Setup
+
+1. Set your env variables:
+
+- `MILVUS_ADDRESS`: Address of your Milvus Vector Store (like localhost:19530)
+- `MILVUS_USERNAME`: empty or username for your Milvus Vector Store
+- `MILVUS_PASSWORD`: empty or password for your Milvus Vector Store
+- `OPENAI_API_KEY`: Your OpenAI key
+
+2. `cd` Into the `examples` directory
+3. run `npm i`
+
+## Load the data
+
+This sample loads the same dataset of movie reviews as sample dataset. You can install https://github.com/zilliztech/attu to inspect the loaded data.
+
+run `npx ts-node milvus/load`
+
+## Use RAG to Query the data
+
+Check out your data in Attu and change the sample query as you see fit.
+
+run `npx ts-node milvus/query`

examples/milvus/load.ts

@@ -0,0 +1,26 @@
+import {
+  MilvusVectorStore,
+  PapaCSVReader,
+  storageContextFromDefaults,
+  VectorStoreIndex,
+} from "llamaindex";
+
+const collectionName = "movie_reviews";
+
+async function main() {
+  try {
+    const reader = new PapaCSVReader(false);
+    const docs = await reader.loadData("./data/movie_reviews.csv");
+
+    const vectorStore = new MilvusVectorStore({ collection: collectionName });
+
+    const ctx = await storageContextFromDefaults({ vectorStore });
+    const index = await VectorStoreIndex.fromDocuments(docs, {
+      storageContext: ctx,
+    });
+  } catch (e) {
+    console.error(e);
+  }
+}
+
+main();

examples/milvus/query.ts

@@ -0,0 +1,30 @@
+import {
+  MilvusVectorStore,
+  serviceContextFromDefaults,
+  VectorStoreIndex,
+} from "llamaindex";
+
+const collectionName = "movie_reviews";
+
+async function main() {
+  try {
+    const milvus = new MilvusVectorStore({ collection: collectionName });
+
+    const ctx = serviceContextFromDefaults();
+    const index = await VectorStoreIndex.fromVectorStore(milvus, ctx);
+
+    const retriever = await index.asRetriever({ similarityTopK: 20 });
+
+    const queryEngine = await index.asQueryEngine({ retriever });
+
+    const results = await queryEngine.query({
+      query: "What is the best reviewed movie?",
+    });
+
+    console.log(results.response);
+  } catch (e) {
+    console.error(e);
+  }
+}
+
+main();

examples/multimodal/retrieve.ts

@@ -27,9 +27,9 @@ async function main() {
   // retrieve documents using the index
   const index = await createIndex();
   const retriever = index.asRetriever({ similarityTopK: 3 });
-  const results = await retriever.retrieve(
-    "what are Vincent van Gogh's famous paintings",
-  );
+  const results = await retriever.retrieve({
+    query: "what are Vincent van Gogh's famous paintings",
+  });
   for (const result of results) {
     const node = result.node;
     if (!node) {

examples/openai.ts

@@ -1,4 +1,4 @@
-import { OpenAI } from "llamaindex";
+import { OpenAI, OpenAIEmbedding } from "llamaindex";
 
 (async () => {
   const llm = new OpenAI({ model: "gpt-4-1106-preview", temperature: 0.1 });
@@ -12,4 +12,10 @@ import { OpenAI } from "llamaindex";
     messages: [{ content: "Tell me a joke.", role: "user" }],
   });
   console.log(response2.message.content);
+
+  // embeddings
+  const embedModel = new OpenAIEmbedding();
+  const texts = ["hello", "world"];
+  const embeddings = await embedModel.getTextEmbeddingsBatch(texts);
+  console.log(`\nWe have ${embeddings.length} embeddings`);
 })();

examples/package.json

@@ -1,16 +1,19 @@
 {
   "name": "examples",
   "private": true,
-  "version": "0.0.3",
+  "version": "0.0.4",
   "dependencies": {
+    "@aws-crypto/sha256-js": "^5.2.0",
     "@datastax/astra-db-ts": "^0.1.4",
     "@notionhq/client": "^2.2.14",
     "@pinecone-database/pinecone": "^1.1.3",
+    "@zilliz/milvus2-sdk-node": "^2.3.5",
     "chromadb": "^1.8.1",
     "commander": "^11.1.0",
     "dotenv": "^16.4.1",
     "llamaindex": "latest",
-    "mongodb": "^6.2.0"
+    "mongodb": "^6.2.0",
+    "pathe": "^1.1.2"
   },
   "devDependencies": {
     "@types/node": "^18.19.10",

examples/pinecone-vector-store/README.md

@@ -7,8 +7,9 @@ There are two scripts available here: load-docs.ts and query.ts
 You'll need a Pinecone account, project, and index. Pinecone does not allow automatic creation of indexes on the free plan,
 so this vector store does not check and create the index (unlike, e.g., the PGVectorStore)
 
-Set the **PINECONE_API_KEY** and **PINECONE_ENVIRONMENT** environment variables to match your specific values. You will likely also need to set **PINECONE_INDEX_NAME**, unless your
-index is the default value "llama".
+Set the **PINECONE_API_KEY** and **PINECONE_ENVIRONMENT** environment variables to match your specific values.
+You will likely also need to set **PINECONE_INDEX_NAME**, unless your index is the default value "llama".
+By default, all operations take place inside the default namespace '', but you can set **PINECONE_NAMESPACE** to a different value if you need to.
 
 You'll also need a value for OPENAI_API_KEY in your environment.
 

examples/qdrantdb/README.md

@@ -0,0 +1,11 @@
+# Qdrant Vector Store Example
+
+How to run `examples/qdrantdb/preFilters.ts`:
+
+Add your OpenAI API Key into a file called `.env` in the parent folder of this directory. It should look like this:
+
+```
+OPEN_API_KEY=sk-you-key
+```
+
+Now, open a new terminal window and inside `examples`, run `npx ts-node qdrantdb/preFilters.ts`.

examples/qdrantdb/preFilters.ts

@@ -0,0 +1,82 @@
+import * as dotenv from "dotenv";
+import {
+  CallbackManager,
+  Document,
+  MetadataMode,
+  QdrantVectorStore,
+  VectorStoreIndex,
+  serviceContextFromDefaults,
+  storageContextFromDefaults,
+} from "llamaindex";
+
+// Load environment variables from local .env file
+dotenv.config();
+
+const collectionName = "dog_colors";
+const qdrantUrl = "http://127.0.0.1:6333";
+
+async function main() {
+  try {
+    const docs = [
+      new Document({
+        text: "The dog is brown",
+        metadata: {
+          dogId: "1",
+        },
+      }),
+      new Document({
+        text: "The dog is red",
+        metadata: {
+          dogId: "2",
+        },
+      }),
+    ];
+    console.log("Creating QdrantDB vector store");
+    const qdrantVs = new QdrantVectorStore({ url: qdrantUrl, collectionName });
+    const ctx = await storageContextFromDefaults({ vectorStore: qdrantVs });
+
+    console.log("Embedding documents and adding to index");
+    const index = await VectorStoreIndex.fromDocuments(docs, {
+      storageContext: ctx,
+      serviceContext: serviceContextFromDefaults({
+        callbackManager: new CallbackManager({
+          onRetrieve: (data) => {
+            console.log(
+              "The retrieved nodes are:",
+              data.nodes.map((node) => node.node.getContent(MetadataMode.NONE)),
+            );
+          },
+        }),
+      }),
+    });
+
+    console.log(
+      "Querying index with no filters: Expected output: Brown probably",
+    );
+    const queryEngineNoFilters = index.asQueryEngine();
+    const noFilterResponse = await queryEngineNoFilters.query({
+      query: "What is the color of the dog?",
+    });
+    console.log("No filter response:", noFilterResponse.toString());
+    console.log("Querying index with dogId 2: Expected output: Red");
+    const queryEngineDogId2 = index.asQueryEngine({
+      preFilters: {
+        filters: [
+          {
+            key: "dogId",
+            value: "2",
+            filterType: "ExactMatch",
+          },
+        ],
+      },
+    });
+    const response = await queryEngineDogId2.query({
+      query: "What is the color of the dog?",
+    });
+    console.log("Filter with dogId 2 response:", response.toString());
+  } catch (e) {
+    console.error(e);
+  }
+}
+
+main();

examples/readers/CHANGELOG.md

@@ -0,0 +1,11 @@
+# llamaindex-loader-example
+
+### Patch Changes
+
+- Updated dependencies [d2e8d0c]
+- Updated dependencies [aefc326]
+- Updated dependencies [484a710]
+- Updated dependencies [d766bd0]
+- Updated dependencies [dd95927]
+- Updated dependencies [bf583a7]
+  - llamaindex@0.2.0

examples/readers/src/assemblyai.ts

@@ -1,6 +1,6 @@
 import { program } from "commander";
-import { TranscribeParams, VectorStoreIndex } from "llamaindex";
-import { AudioTranscriptReader } from "llamaindex/readers/AssemblyAIReader";
+import { VectorStoreIndex, type TranscribeParams } from "llamaindex";
+import { AudioTranscriptReader } from "llamaindex/readers";
 import { stdin as input, stdout as output } from "node:process";
 import { createInterface } from "node:readline/promises";
 

examples/readers/src/csv.ts

@@ -5,7 +5,7 @@ import {
   serviceContextFromDefaults,
   VectorStoreIndex,
 } from "llamaindex";
-import { PapaCSVReader } from "llamaindex/readers/CSVReader";
+import { PapaCSVReader } from "llamaindex/readers";
 
 async function main() {
   // Load CSV

examples/readers/src/custom-simple-directory-reader.ts

@@ -3,7 +3,7 @@ import {
   FILE_EXT_TO_READER,
   SimpleDirectoryReader,
   TextFileReader,
-} from "llamaindex/readers/SimpleDirectoryReader";
+} from "llamaindex/readers";
 
 class ZipReader implements BaseReader {
   loadData(...args: any[]): Promise<Document<Metadata>[]> {

examples/readers/src/docx.ts

@@ -1,5 +1,5 @@
-import { VectorStoreIndex } from "llamaindex";
-import { DocxReader } from "llamaindex/readers/DocxReader";
+import { VectorStoreIndex } from "llamaindex/indices";
+import { DocxReader } from "llamaindex/readers";
 
 const FILE_PATH = "../data/stars.docx";
 const SAMPLE_QUERY = "Information about Zodiac";

examples/readers/src/html.ts

@@ -1,5 +1,5 @@
-import { VectorStoreIndex } from "llamaindex";
-import { HTMLReader } from "llamaindex/readers/HTMLReader";
+import { VectorStoreIndex } from "llamaindex/indices";
+import { HTMLReader } from "llamaindex/readers";
 
 async function main() {
   // Load page

examples/readers/src/llamaparse.ts

@@ -1,4 +1,5 @@
-import { LlamaParseReader, VectorStoreIndex } from "llamaindex";
+import { VectorStoreIndex } from "llamaindex/indices";
+import { LlamaParseReader } from "llamaindex/readers";
 
 async function main() {
   // Load PDF using LlamaParse

examples/readers/src/markdown.ts

@@ -1,5 +1,5 @@
-import { VectorStoreIndex } from "llamaindex";
-import { MarkdownReader } from "llamaindex/readers/MarkdownReader";
+import { VectorStoreIndex } from "llamaindex/indices";
+import { MarkdownReader } from "llamaindex/readers";
 
 const FILE_PATH = "../data/planets.md";
 const SAMPLE_QUERY = "List all planets";

examples/readers/src/notion.ts

@@ -1,7 +1,7 @@
 import { Client } from "@notionhq/client";
 import { program } from "commander";
-import { VectorStoreIndex } from "llamaindex";
-import { NotionReader } from "llamaindex/readers/NotionReader";
+import { VectorStoreIndex } from "llamaindex/indices";
+import { NotionReader } from "llamaindex/readers";
 import { stdin as input, stdout as output } from "node:process";
 import { createInterface } from "node:readline/promises";
 

examples/readers/src/pdf.ts

@@ -1,5 +1,5 @@
-import { VectorStoreIndex } from "llamaindex";
-import { PDFReader } from "llamaindex/readers/PDFReader";
+import { VectorStoreIndex } from "llamaindex/indices";
+import { PDFReader } from "llamaindex/readers";
 
 async function main() {
   // Load PDF

examples/readers/src/pdf_fw.ts

@@ -1,5 +1,7 @@
-import { FireworksEmbedding, FireworksLLM, VectorStoreIndex } from "llamaindex";
-import { PDFReader } from "llamaindex/readers/PDFReader";
+import { FireworksEmbedding } from "llamaindex/embeddings";
+import { VectorStoreIndex } from "llamaindex/indices";
+import { FireworksLLM } from "llamaindex/llm";
+import { PDFReader } from "llamaindex/readers";
 
 import { serviceContextFromDefaults } from "llamaindex";
 

examples/readers/src/pdf_fw_openai.ts

@@ -1,5 +1,7 @@
-import { OpenAI, OpenAIEmbedding, VectorStoreIndex } from "llamaindex";
-import { PDFReader } from "llamaindex/readers/PDFReader";
+import { OpenAIEmbedding } from "llamaindex/embeddings";
+import { VectorStoreIndex } from "llamaindex/indices";
+import { OpenAI } from "llamaindex/llm";
+import { PDFReader } from "llamaindex/readers";
 
 import { serviceContextFromDefaults } from "llamaindex";
 

examples/readers/src/simple-directory-reader.ts

@@ -1,4 +1,4 @@
-import { SimpleDirectoryReader } from "llamaindex/readers/SimpleDirectoryReader";
+import { SimpleDirectoryReader } from "llamaindex/readers";
 // or
 // import { SimpleDirectoryReader } from 'llamaindex'
 

package.json

@@ -11,10 +11,12 @@
     "prepare": "husky",
     "test": "turbo run test",
     "type-check": "tsc -b --diagnostics",
-    "release": "pnpm run build:release && changeset publish",
-    "new-llamaindex": "pnpm run build:release && changeset version --ignore create-llama",
-    "new-create-llama": "pnpm run build:release && changeset version --ignore llamaindex",
-    "new-snapshots": "pnpm run build:release && changeset version --snapshot"
+    "release": "pnpm run check-minor-version && pnpm run build:release && changeset publish",
+    "release-snapshot": "pnpm run check-minor-version && pnpm run build:release && changeset publish --tag snapshot",
+    "check-minor-version": "node ./scripts/check-minor-version",
+    "update-version": "node ./scripts/update-version",
+    "new-version": "pnpm run build:release && changeset version && pnpm run check-minor-version && pnpm run update-version",
+    "new-snapshot": "pnpm run build:release && changeset version --snapshot && pnpm run update-version"
   },
   "devDependencies": {
     "@changesets/cli": "^2.27.1",

packages/core/.gitignore

@@ -1 +1,3 @@
 .turbo
+README.md
+LICENSE

packages/core/CHANGELOG.md

@@ -1,5 +1,57 @@
 # llamaindex
 
+## 0.2.1
+
+### Patch Changes
+
+- 41210df: Add auto create milvus collection and add milvus node metadata
+- 137cf67: Use Pinecone namespaces for all operations
+- 259c842: Add support for edge runtime by using @llamaindex/edge
+
+## 0.2.0
+
+### Minor Changes
+
+- bf583a7: Use parameter object for retrieve function of Retriever (to align usage with query function of QueryEngine)
+
+### Patch Changes
+
+- d2e8d0c: add support for Milvus vector store
+- aefc326: feat: experimental package + json query engine
+- 484a710: - Add missing exports:
+  - `IndexStructType`,
+  - `IndexDict`,
+  - `jsonToIndexStruct`,
+  - `IndexList`,
+  - `IndexStruct`
+  - Fix `IndexDict.toJson()` method
+- d766bd0: Add streaming to agents
+- dd95927: add Claude Haiku support and update anthropic SDK
+
+## 0.1.21
+
+### Patch Changes
+
+- 552a61a: Add quantized parameter to HuggingFaceEmbedding
+- d824876: Add support for Claude 3
+
+## 0.1.20
+
+### Patch Changes
+
+- 64683a5: fix: prefix messages always true
+- 698cd9c: fix: step wise agent + examples
+- 7257751: fixed removeRefDocNode and persist store on delete
+- 5116ad8: fix: compatibility issue with Deno
+- Updated dependencies [5116ad8]
+  - @llamaindex/env@0.0.5
+
+## 0.1.19
+
+### Patch Changes
+
+- 026d068: feat: enhance pinecone usage
+
 ## 0.1.18
 
 ### Patch Changes

packages/core/jsr.json

@@ -0,0 +1,8 @@
+{
+  "name": "@llamaindex/core",
+  "version": "0.1.21",
+  "exports": "./src/index.ts",
+  "imports": {
+    "@llamaindex/env": "jsr:@llamaindex/env@0.0.5"
+  }
+}

packages/core/package.json

@@ -1,29 +1,32 @@
 {
   "name": "llamaindex",
-  "version": "0.1.18",
+  "version": "0.2.1",
+  "expectedMinorVersion": "2",
   "license": "MIT",
   "type": "module",
   "dependencies": {
-    "@anthropic-ai/sdk": "^0.13.0",
+    "@anthropic-ai/sdk": "^0.18.0",
     "@aws-crypto/sha256-js": "^5.2.0",
     "@datastax/astra-db-ts": "^0.1.4",
-    "@types/lodash": "^4.14.202",
-    "@types/node": "^18.19.14",
-    "@types/papaparse": "^5.3.14",
-    "@types/pg": "^8.11.0",
-    "@llamaindex/cloud": "^0.0.1",
+    "@grpc/grpc-js": "^1.10.2",
+    "@llamaindex/cloud": "0.0.4",
     "@llamaindex/env": "workspace:*",
     "@mistralai/mistralai": "^0.0.10",
     "@notionhq/client": "^2.2.14",
     "@pinecone-database/pinecone": "^2.0.1",
     "@qdrant/js-client-rest": "^1.7.0",
+    "@types/lodash": "^4.14.202",
+    "@types/node": "^18.19.14",
+    "@types/papaparse": "^5.3.14",
+    "@types/pg": "^8.11.0",
     "@xenova/transformers": "^2.15.0",
+    "@zilliz/milvus2-sdk-node": "^2.3.5",
     "assemblyai": "^4.2.2",
     "chromadb": "~1.7.3",
     "cohere-ai": "^7.7.5",
-    "file-type": "^18.7.0",
     "js-tiktoken": "^1.0.10",
     "lodash": "^4.17.21",
+    "magic-bytes.js": "^1.10.0",
     "mammoth": "^1.6.0",
     "md-utils-ts": "^2.0.0",
     "mongodb": "^6.3.0",
@@ -38,7 +41,8 @@
     "rake-modified": "^1.0.8",
     "replicate": "^0.25.2",
     "string-strip-html": "^13.4.6",
-    "wink-nlp": "^1.14.3"
+    "wink-nlp": "^1.14.3",
+    "wikipedia": "^2.1.2"
   },
   "devDependencies": {
     "@swc/cli": "^0.3.9",
@@ -59,15 +63,191 @@
         "types": "./dist/type/index.d.ts",
         "default": "./dist/index.js"
       },
-      "edge-light": {
-        "types": "./dist/type/index.d.ts",
-        "default": "./dist/index.edge-light.js"
-      },
       "require": {
         "types": "./dist/type/index.d.ts",
         "default": "./dist/cjs/index.js"
       }
     },
+    "./agent": {
+      "import": {
+        "types": "./dist/type/agent/index.d.ts",
+        "default": "./dist/agent/index.js"
+      },
+      "require": {
+        "types": "./dist/type/agent/index.d.ts",
+        "default": "./dist/cjs/agent/index.js"
+      }
+    },
+    "./cloud": {
+      "import": {
+        "types": "./dist/type/cloud/index.d.ts",
+        "default": "./dist/cloud/index.js"
+      },
+      "require": {
+        "types": "./dist/type/cloud/index.d.ts",
+        "default": "./dist/cjs/cloud/index.js"
+      }
+    },
+    "./embeddings": {
+      "import": {
+        "types": "./dist/type/embeddings/index.d.ts",
+        "default": "./dist/embeddings/index.js"
+      },
+      "require": {
+        "types": "./dist/type/embeddings/index.d.ts",
+        "default": "./dist/cjs/embeddings/index.js"
+      }
+    },
+    "./engines": {
+      "import": {
+        "types": "./dist/type/engines/index.d.ts",
+        "default": "./dist/engines/index.js"
+      },
+      "require": {
+        "types": "./dist/type/engines/index.d.ts",
+        "default": "./dist/cjs/engines/index.js"
+      }
+    },
+    "./evaluation": {
+      "import": {
+        "types": "./dist/type/evaluation/index.d.ts",
+        "default": "./dist/evaluation/index.js"
+      },
+      "require": {
+        "types": "./dist/type/evaluation/index.d.ts",
+        "default": "./dist/cjs/evaluation/index.js"
+      }
+    },
+    "./extractors": {
+      "import": {
+        "types": "./dist/type/extractors/index.d.ts",
+        "default": "./dist/extractors/index.js"
+      },
+      "require": {
+        "types": "./dist/type/extractors/index.d.ts",
+        "default": "./dist/cjs/extractors/index.js"
+      }
+    },
+    "./indices": {
+      "import": {
+        "types": "./dist/type/indices/index.d.ts",
+        "default": "./dist/indices/index.js"
+      },
+      "require": {
+        "types": "./dist/type/indices/index.d.ts",
+        "default": "./dist/cjs/indices/index.js"
+      }
+    },
+    "./ingestion": {
+      "import": {
+        "types": "./dist/type/ingestion/index.d.ts",
+        "default": "./dist/ingestion/index.js"
+      },
+      "require": {
+        "types": "./dist/type/ingestion/index.d.ts",
+        "default": "./dist/cjs/ingestion/index.js"
+      }
+    },
+    "./llm": {
+      "import": {
+        "types": "./dist/type/llm/index.d.ts",
+        "default": "./dist/llm/index.js"
+      },
+      "require": {
+        "types": "./dist/type/llm/index.d.ts",
+        "default": "./dist/cjs/llm/index.js"
+      }
+    },
+    "./nodeParsers": {
+      "import": {
+        "types": "./dist/type/nodeParsers/index.d.ts",
+        "default": "./dist/nodeParsers/index.js"
+      },
+      "require": {
+        "types": "./dist/type/nodeParsers/index.d.ts",
+        "default": "./dist/cjs/nodeParsers/index.js"
+      }
+    },
+    "./objects": {
+      "import": {
+        "types": "./dist/type/objects/index.d.ts",
+        "default": "./dist/objects/index.js"
+      },
+      "require": {
+        "types": "./dist/type/objects/index.d.ts",
+        "default": "./dist/cjs/objects/index.js"
+      }
+    },
+    "./postprocessors": {
+      "import": {
+        "types": "./dist/type/postprocessors/index.d.ts",
+        "default": "./dist/postprocessors/index.js"
+      },
+      "require": {
+        "types": "./dist/type/postprocessors/index.d.ts",
+        "default": "./dist/cjs/postprocessors/index.js"
+      }
+    },
+    "./prompts": {
+      "import": {
+        "types": "./dist/type/prompts/index.d.ts",
+        "default": "./dist/prompts/index.js"
+      },
+      "require": {
+        "types": "./dist/type/prompts/index.d.ts",
+        "default": "./dist/cjs/prompts/index.js"
+      }
+    },
+    "./readers": {
+      "import": {
+        "types": "./dist/type/readers/index.d.ts",
+        "default": "./dist/readers/index.js"
+      },
+      "require": {
+        "types": "./dist/type/readers/index.d.ts",
+        "default": "./dist/cjs/readers/index.js"
+      }
+    },
+    "./selectors": {
+      "import": {
+        "types": "./dist/type/selectors/index.d.ts",
+        "default": "./dist/selectors/index.js"
+      },
+      "require": {
+        "types": "./dist/type/selectors/index.d.ts",
+        "default": "./dist/cjs/selectors/index.js"
+      }
+    },
+    "./storage": {
+      "import": {
+        "types": "./dist/type/storage/index.d.ts",
+        "default": "./dist/storage/index.js"
+      },
+      "require": {
+        "types": "./dist/type/storage/index.d.ts",
+        "default": "./dist/cjs/storage/index.js"
+      }
+    },
+    "./synthesizers": {
+      "import": {
+        "types": "./dist/type/synthesizers/index.d.ts",
+        "default": "./dist/synthesizers/index.js"
+      },
+      "require": {
+        "types": "./dist/type/synthesizers/index.d.ts",
+        "default": "./dist/cjs/synthesizers/index.js"
+      }
+    },
+    "./tools": {
+      "import": {
+        "types": "./dist/type/tools/index.d.ts",
+        "default": "./dist/tools/index.js"
+      },
+      "require": {
+        "types": "./dist/type/tools/index.d.ts",
+        "default": "./dist/cjs/tools/index.js"
+      }
+    },
     "./*": {
       "import": {
         "types": "./dist/type/*.d.ts",
@@ -92,10 +272,11 @@
   "scripts": {
     "lint": "eslint .",
     "build": "rm -rf ./dist && pnpm run build:esm && pnpm run build:cjs && pnpm run build:type",
-    "build:esm": "swc src -d dist --strip-leading-paths --config-file .swcrc",
-    "build:cjs": "swc src -d dist/cjs --strip-leading-paths --config-file .cjs.swcrc",
-    "build:type": "pnpm run -w type-check",
-    "postbuild": "node -e \"require('fs').writeFileSync('./dist/cjs/package.json', JSON.stringify({ type: 'commonjs' }))\"",
+    "build:esm": "swc src -d dist --strip-leading-paths --config-file ../../.swcrc",
+    "build:cjs": "swc src -d dist/cjs --strip-leading-paths --config-file ../../.cjs.swcrc",
+    "build:type": "tsc -p tsconfig.json",
+    "copy": "cp -r ../../README.md ../../LICENSE .",
+    "postbuild": "pnpm run copy && node -e \"require('fs').writeFileSync('./dist/cjs/package.json', JSON.stringify({ type: 'commonjs' }))\"",
     "circular-check": "madge -c ./src/index.ts",
     "dev": "concurrently \"pnpm run build:esm --watch\" \"pnpm run build:cjs --watch\" \"pnpm run build:type --watch\""
   }

packages/core/src/Retriever.ts

@@ -2,14 +2,16 @@ import type { Event } from "./callbacks/CallbackManager.js";
 import type { NodeWithScore } from "./Node.js";
 import type { ServiceContext } from "./ServiceContext.js";
 
+export type RetrieveParams = {
+  query: string;
+  parentEvent?: Event;
+  preFilters?: unknown;
+};
+
 /**
  * Retrievers retrieve the nodes that most closely match our query in similarity.
  */
 export interface BaseRetriever {
-  retrieve(
-    query: string,
-    parentEvent?: Event,
-    preFilters?: unknown,
-  ): Promise<NodeWithScore[]>;
+  retrieve(params: RetrieveParams): Promise<NodeWithScore[]>;
   getServiceContext(): ServiceContext;
 }