Compare commits

..

103 Commits

Author SHA1 Message Date
github-actions[bot] 37dcf37625 Release 0.9.11 (#1734)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: marcusschiesser <17126+marcusschiesser@users.noreply.github.com>
2025-03-12 12:44:55 +07:00
Stefan Edberg a8c0637d11 feat: make it possible to provide base URL to OpenAI (#1740)
Co-authored-by: Marcus Schiesser <mail@marcusschiesser.de>
2025-03-12 12:17:38 +07:00
Marcus Schiesser 387a19284d fix: Update mistral package for mistral API 1.5.1 (#1741) 2025-03-12 11:23:42 +07:00
ANKIT VARSHNEY a654f580cf docs: add doc for perplexity (#1738) 2025-03-12 11:17:23 +07:00
Thuc Pham 68ea7ec6a5 chore: use agent workflow for examples (#1726) 2025-03-11 19:05:00 +07:00
Marcus Schiesser 2d11ffbaea docs: update contrib (#1736) 2025-03-11 18:06:06 +07:00
ANKIT VARSHNEY 1587e48a14 Feat/perplexity (#1719) 2025-03-11 17:21:57 +07:00
Marcus Schiesser bd239aaf2d docs: update main agent docs (#1735) 2025-03-11 17:18:38 +07:00
Jack Qian 98eebf7277 feat: add request options for gemini (#1733) 2025-03-11 15:56:10 +07:00
github-actions[bot] 5478ba88b1 Release 0.9.10 (#1728)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: marcusschiesser <17126+marcusschiesser@users.noreply.github.com>
2025-03-11 13:47:43 +07:00
Marcus Schiesser aea550aff4 feat: Add factory convenience factory for each LLM provider, e.g. you… (#1731) 2025-03-11 13:42:09 +07:00
Marcus Schiesser e66c6e25fb feat: add tool factory method (#1730) 2025-03-11 12:57:13 +07:00
Marcus Schiesser 40ee7610b2 feat: add asQueryTool to index and add factory methods for simplifying agent usage (#1715) 2025-03-11 11:06:21 +07:00
yangqiao c14a21bc0b fix: Add user agent for AzureCosmosDBMongoDBVectorStore (#1729)
Co-authored-by: yangqiao <yangqiao@microsoft.com>
2025-03-10 18:08:28 +07:00
Thomas Vanier 33f98565ab fix: google start chat tools params (#1716)
Co-authored-by: Marcus Schiesser <mail@marcusschiesser.de>
2025-03-10 18:07:36 +07:00
Huu Le b5cb35a732 chore: add unit test for agent workflow (#1704) 2025-03-10 16:44:49 +07:00
Thuc Pham c1b5be5182 feat: make AgentWorkflow llm param optional (#1727) 2025-03-10 11:48:51 +07:00
Alex Yang 6f8b68ac5f chore: fix turbo.json (#1724) 2025-03-09 01:45:28 -08:00
Alex Yang e075643b50 chore: bump bunchee (#1725) 2025-03-09 01:33:33 -08:00
Alex Yang f71b143ceb chore: add tailwindcss prettier (#1723) 2025-03-09 01:11:27 -08:00
Alex Yang ead4a80a3a feat(docs): improve misc (#1722) 2025-03-09 00:57:47 -08:00
Alex Yang da78689e24 fix(docs): use docs.toFumadocsSource (#1721) 2025-03-09 00:34:49 -08:00
Alex Yang f24a9dfe00 fix(docs): openapi generation & twoslash fix (#1720) 2025-03-09 00:02:30 -08:00
Alex Yang e31d6ba472 fix(docs): development error 2025-03-08 21:51:43 -08:00
Alex Yang d212240d64 feat: use fumadoc 15 + tailwind 4 (#1690)
Co-authored-by: thucpn <thucsh2@gmail.com>
2025-03-07 23:30:54 -08:00
github-actions[bot] cb73f77bb8 Release 0.9.9 (#1713)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: marcusschiesser <17126+marcusschiesser@users.noreply.github.com>
2025-03-07 16:28:36 +07:00
Huu Le 8bf1ca1701 Support chat stream with tools for Anthropic LLM (#1710)
Co-authored-by: thucpn <thucsh2@gmail.com>
Co-authored-by: Thuc Pham <51660321+thucpn@users.noreply.github.com>
2025-03-07 15:41:15 +07:00
Alexander Tigselema 58b3ee52e0 Add Gemini 2.0 Flas Lite, Fix tools error with LLM Agent (#1712) 2025-03-07 11:15:51 +07:00
Thomas Vanier 4bac71d6a2 feat: additional tool argument (#1693) 2025-03-07 11:15:10 +07:00
github-actions[bot] a3cbcb31a2 Release 0.9.8 (#1711)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: marcusschiesser <17126+marcusschiesser@users.noreply.github.com>
2025-03-06 16:33:19 +07:00
Thuc Pham bbc8c8787d fix: prefer using embedding model from vector store (#1708) 2025-03-06 16:24:05 +07:00
Huu Le 4b49428f57 fix agent workflow tool call for Ollama (#1706)
Co-authored-by: Marcus Schiesser <mail@marcusschiesser.de>
2025-03-06 11:13:42 +07:00
Peter Goldstein 7ee4968b06 Add Gemini 2.0 Pro Experimental (#1707) 2025-03-06 11:04:56 +07:00
github-actions[bot] 0111f5c8b0 Release 0.9.7 (#1703)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: marcusschiesser <17126+marcusschiesser@users.noreply.github.com>
2025-03-05 16:59:05 +07:00
Thuc Pham beb922b743 fix: build fail in edge runtime (#1705)
Co-authored-by: Marcus Schiesser <mail@marcusschiesser.de>
2025-03-05 16:35:00 +07:00
patryktop e28c29d1f5 feat: add Llama 3.3 70B Instruct to community package (#1702) 2025-03-04 17:27:35 -08:00
github-actions[bot] 008cccd9f1 Release 0.9.6 (#1698) 2025-03-04 17:33:18 +07:00
Huu Le 081698d68c chore: simplify imports of agent workflow (#1700) 2025-03-04 17:01:29 +07:00
Huu Le ab5fe5d7a0 chore: remove core import in document (#1699) 2025-03-04 16:14:31 +07:00
Huu Le 56689707d3 feat: Support AgentWorkflow (#1685)
Co-authored-by: Marcus Schiesser <mail@marcusschiesser.de>
2025-03-04 16:05:25 +07:00
Brian Lange fd74ba4bf1 fix: Voyage typescript configs + docs (#1696) 2025-03-04 11:00:05 +07:00
github-actions[bot] b2634e47ca Release 0.9.5 (#1694)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: marcusschiesser <17126+marcusschiesser@users.noreply.github.com>
2025-02-28 18:18:14 +07:00
Thuc Pham ad3c7f1ec1 fix: streaming issues with LLMAgent (#1692) 2025-02-28 18:13:36 +07:00
Alex Yang 335f2df626 chore: fix lock file 2025-02-27 12:31:11 -08:00
github-actions[bot] ee963644bf Release 0.9.4 (#1689)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-02-27 12:28:48 -08:00
Alex Yang cb256f24ae feat: support gpt-4.5 (#1688) 2025-02-27 12:24:33 -08:00
Alex Yang 1ccc04ecb5 chore: fix changeset 2025-02-27 12:17:12 -08:00
Brian Lange 034639153b feat: Voyage embeddings (#1574)
Co-authored-by: Marcus Schiesser <mail@marcusschiesser.de>
2025-02-27 10:22:33 +07:00
patryktop 1914b52708 feat: add Claude 3.7 Sonnet model to community package (#1683) 2025-02-26 14:38:14 -08:00
Alex Yang cb021e7196 feat(node-parser): support async function (#1682) 2025-02-26 08:59:51 -08:00
ratacat c2aa836b35 docs: upgrade remote ollama embeddings (#1680) 2025-02-25 11:39:16 -08:00
github-actions[bot] 3b0f55f1ea Release 0.9.3 (#1676)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: marcusschiesser <17126+marcusschiesser@users.noreply.github.com>
2025-02-25 16:53:30 +07:00
Marcus Schiesser a9c6144eec feat: stream thinking tokens for claude 3.7 (#1679) 2025-02-25 16:48:12 +07:00
Marcus Schiesser 3564244ced chore: add claude 3.7 support (#1678) 2025-02-25 15:18:45 +07:00
Gunnar Holwerda d952e68ec4 Fix refine synthesizer empty source nodes behavior (#1677) 2025-02-24 10:56:21 +07:00
Tushar Sonawane 5c026e839f feat(vectorstore): adds firestore vector store support (#1600) 2025-02-21 16:23:50 +07:00
github-actions[bot] 9c1c5b4d50 Release 0.9.2 (#1673)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-02-21 10:57:11 +07:00
Thuc Pham c902fcbc33 chore: bump llamacloud openapi (#1674) 2025-02-20 17:47:41 +07:00
Thuc Pham 88d776f392 fix: enhance error message in llamacloud (#1672) 2025-02-20 16:33:34 +07:00
github-actions[bot] 6fcc6bcb84 Release @llamaindex/anthropic@0.1.2 (#1671)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-02-20 12:56:33 +07:00
Thuc Pham be74207945 fix: dont add empty text block to tool call (#1670) 2025-02-20 12:47:43 +07:00
Alex Yang 6be223dfad chore: bump version (#1668) 2025-02-19 19:28:12 +08:00
Alex Yang 4cbfdb5f5c ci: only run in pull request (#1669) 2025-02-19 19:11:53 +08:00
github-actions[bot] 9767d1c004 Release 0.9.1 (#1664)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: himself65 <14026360+himself65@users.noreply.github.com>
2025-02-19 18:15:41 +08:00
Alex Yang e831b28627 ci: add size limit check (#1667) 2025-02-19 18:05:28 +08:00
Alex Yang cc50c9c2d4 chore: trigger env package release 2025-02-19 17:59:38 +08:00
Thuc Pham 954140776e fix: missing document entrypoints (#1663)
Co-authored-by: Marcus Schiesser <mail@marcusschiesser.de>
2025-02-14 17:06:23 +07:00
Savas Ziplies 6d37d440a6 refactor(agent): changed regex for tool use extraction to look for optional "Input:" prefix to comply with Cohere command-r models (#1654) 2025-02-14 15:17:03 +07:00
Alex Yang e724f7e9f2 fix: cjs module resolve esm module unexpectedly (#1662) 2025-02-14 15:52:37 +08:00
Alex Yang 1b029ae525 test: add cjs smoke test (#1660) 2025-02-14 14:28:09 +08:00
Marcus Schiesser d1db2189c9 docs: update starter to ask for api key (#1661) 2025-02-14 12:14:51 +07:00
Alex Yang 2c5b4030c9 chore: bump bunchee (#1645) 2025-02-14 09:41:32 +08:00
Alex Yang 96eb597059 fix: bundler issue default in default (#1653) 2025-02-14 09:20:39 +08:00
Marcus Schiesser 04098d55ff chore: fix pnpm lock (#1658) 2025-02-13 17:49:21 +07:00
Marcus Schiesser 335a6b9e88 chore: add pathe to examples (#1657) 2025-02-13 17:44:30 +07:00
github-actions[bot] c2a345ebb1 Release 0.9.0 (#1643)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: marcusschiesser <17126+marcusschiesser@users.noreply.github.com>
2025-02-13 17:34:06 +07:00
Marcus Schiesser d3fa729a30 Cleanups before 0.9 release (#1656) 2025-02-13 17:26:22 +07:00
Thuc Pham c7c08005ec fix: fumadoc build fail (#1655) 2025-02-13 16:24:28 +07:00
Alex Yang bb0ae5e321 chore: fix pkg.pr.new issue (#1651) 2025-02-12 21:19:29 +08:00
Marcus Schiesser f4588bc770 chore: Remove readers package from llamaindex (#1649) 2025-02-12 17:16:41 +07:00
Marcus Schiesser b49037612d remove service context (#1618)
Co-authored-by: thucpn <thucsh2@gmail.com>
2025-02-12 15:10:11 +07:00
Thuc Pham a87efb91a4 docs: update chat engine docs (#1648) 2025-02-12 12:45:26 +07:00
Thuc Pham 6a4a73760b chore: remove re-exporting packages in llamaindex (#1624)
Co-authored-by: Marcus Schiesser <mail@marcusschiesser.de>
2025-02-12 12:44:52 +07:00
Alex Yang 1564831158 ci: fix pkg-pr-new release (#1646) 2025-02-11 22:42:42 +08:00
Alex Yang 4d94f6e50d test: smoke test with cjs/esm dual package (#1644) 2025-02-11 15:02:06 +08:00
Thuc Pham 7bd5d9340c docs: update workflow doc (#1637)
Co-authored-by: Marcus Schiesser <mail@marcusschiesser.de>
2025-02-11 13:41:11 +07:00
Thuc Pham d924c63162 feat: asChatEngine function for index (#1640) 2025-02-11 12:57:15 +07:00
github-actions[bot] 83cff1277c Release 0.8.37 (#1642)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: marcusschiesser <17126+marcusschiesser@users.noreply.github.com>
2025-02-11 12:48:58 +07:00
Marcus Schiesser 1c908fd852 Revert "fix: bundle output incorrect (#1638)" (#1641) 2025-02-11 12:27:11 +07:00
github-actions[bot] 56f367f08d Release 0.8.36 (#1639)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: himself65 <14026360+himself65@users.noreply.github.com>
2025-02-10 21:49:19 +08:00
Alex Yang cb608b5d01 fix: bundle output incorrect (#1638) 2025-02-10 21:30:36 +08:00
github-actions[bot] bd55bcffff Release 0.8.35 (#1633)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: marcusschiesser <17126+marcusschiesser@users.noreply.github.com>
2025-02-10 16:45:42 +07:00
Thuc Pham 6d4d96f8fe chore: update import to workspace pages for examples and docs (#1626)
Co-authored-by: Marcus Schiesser <mail@marcusschiesser.de>
2025-02-10 15:43:29 +07:00
Thuc Pham b6ea2bf964 fix(gemini): use function role for message contains tool-result (#1634) 2025-02-10 12:57:45 +07:00
Parham Saidi 15563a0f70 fix: delete temp competely from params when calling openai o3 (#1629) 2025-02-10 11:07:21 +07:00
github-actions[bot] bd940d1d43 Release 0.8.34 (#1630)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-02-07 16:02:27 +07:00
Thuc Pham 9f8ad37b79 fix: missing peer deps in llamaindex (#1631) 2025-02-07 15:06:41 +07:00
Peter Goldstein 7265f74c24 Add reasoning_effort for o1 and o3 (#1628) 2025-02-07 12:01:48 +07:00
github-actions[bot] e3f1b85846 Release 0.8.33 (#1619)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: marcusschiesser <17126+marcusschiesser@users.noreply.github.com>
2025-02-06 15:53:47 +07:00
Peter Goldstein e38e474f86 Add Gemini 2.0 models (#1625) 2025-02-06 15:41:20 +07:00
Parham Saidi 2019a041f7 fix: o3 calls do not support temperature param (#1622) 2025-02-06 10:23:23 +07:00
Thuc Pham 067a4894fe fix: missing condition to stringify tool input (#1620) 2025-02-05 17:25:37 +07:00
clean99 21769c8ad9 Fix: update deprecated response property in examples (#1614)
Co-authored-by: Marcus Schiesser <mail@marcusschiesser.de>
2025-02-05 11:28:32 +07:00
611 changed files with 26290 additions and 14212 deletions
+1 -1
View File
@@ -25,4 +25,4 @@ jobs:
run: pnpm run build run: pnpm run build
- name: Pre Release - name: Pre Release
run: pnpx pkg-pr-new publish ./packages/* ./packages/providers/* run: pnpx pkg-pr-new publish --pnpm ./packages/* ./packages/providers/* ./packages/providers/storage/*
+25 -5
View File
@@ -83,11 +83,6 @@ jobs:
run: pnpm install run: pnpm install
- name: Build - name: Build
run: pnpm run build run: pnpm run build
- name: Use Build For Examples
run: |
pnpm link ../packages/llamaindex/
cd readers && pnpm link ../../packages/llamaindex/
working-directory: ./examples
- name: Run Type Check - name: Run Type Check
run: pnpm run type-check run: pnpm run type-check
- name: Run Circular Dependency Check - name: Run Circular Dependency Check
@@ -103,6 +98,7 @@ jobs:
- nextjs-node-runtime - nextjs-node-runtime
- waku-query-engine - waku-query-engine
- llama-parse-browser - llama-parse-browser
- vite-import-llamaindex
runs-on: ubuntu-latest runs-on: ubuntu-latest
name: Build LlamaIndex Example (${{ matrix.packages }}) name: Build LlamaIndex Example (${{ matrix.packages }})
steps: steps:
@@ -121,6 +117,30 @@ jobs:
run: pnpm run build run: pnpm run build
working-directory: e2e/examples/${{ matrix.packages }} working-directory: e2e/examples/${{ matrix.packages }}
size-limit:
runs-on: ubuntu-latest
if: github.event_name == 'pull_request'
name: Size Limit
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
cache: "pnpm"
- name: Install dependencies
run: pnpm install
- name: Build llamaindex
run: pnpm run build
- uses: andresz1/size-limit-action@94bc357df29c36c8f8d50ea497c3e225c3c95d1d
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
directory: e2e/examples/vite-import-llamaindex
skip_step: "install"
build_script: build
package_manager: pnpm
typecheck-examples: typecheck-examples:
runs-on: ubuntu-latest runs-on: ubuntu-latest
+1 -3
View File
@@ -1,3 +1 @@
pnpm format pnpm run lint-staged
pnpm lint
npx lint-staged
+1
View File
@@ -0,0 +1 @@
LlamaIndexTS
+2 -1
View File
@@ -14,5 +14,6 @@
"[json]": { "[json]": {
"editor.defaultFormatter": "esbenp.prettier-vscode" "editor.defaultFormatter": "esbenp.prettier-vscode"
}, },
"prettier.prettierPath": "./node_modules/prettier" "prettier.prettierPath": "./node_modules/prettier",
"prettier.configPath": "prettier.config.mjs"
} }
+48 -8
View File
@@ -14,13 +14,14 @@ There are some important folders in the repository:
all JS runtime environments. all JS runtime environments.
- `env`: The environment package of LlamaIndex.TS, which contains the environment-specific classes and interfaces. It - `env`: The environment package of LlamaIndex.TS, which contains the environment-specific classes and interfaces. It
includes compatibility layers for Node.js, Deno, Vercel Edge Runtime, Cloudflare Workers... includes compatibility layers for Node.js, Deno, Vercel Edge Runtime, Cloudflare Workers...
- `providers/*`: The providers package of LlamaIndex.TS, which contains the providers for LLM and other services.
- `apps/*`: The applications based on LlamaIndex.TS. - `apps/*`: The applications based on LlamaIndex.TS.
- `next`: Our documentation website based on Next.js. - `next`: Our documentation website based on Next.js.
- `examples`: The code examples of LlamaIndex.TS using Node.js. - `examples`: The code examples of LlamaIndex.TS using Node.js.
## Getting Started ## Getting Started
Make sure you have Node.js LIS (Long-term Support) installed. You can check your Node.js version by running: Make sure you have Node.js LTS (Long-term Support) installed. You can check your Node.js version by running:
```shell ```shell
node -v node -v
@@ -30,7 +31,7 @@ node -v
### Use pnpm ### Use pnpm
```shell ```shell
corepack enable npm install -g pnpm
``` ```
### Install dependencies ### Install dependencies
@@ -41,26 +42,65 @@ pnpm install
### Build the packages ### Build the packages
To build all packages, run:
```shell ```shell
# Build all packages pnpm build
turbo build --filter "./packages/*"
``` ```
### Run tests
#### Unit tests
After build, to run all unit tests, call:
```shell
pnpm test
```
Unit tests are located in the `tests` folder of each package. They are using their own package (e.g. `@llamaindex/core-tests` for `@llamaindex/core`). The tests are importing the package under test and the test package is not published.
#### E2E tests
To run all E2E tests, call:
```shell
pnpm e2e
```
All E2E tests are in the `e2e` folder.
### Docs ### Docs
See the [docs](./apps/next/README.md) for more information. See the [docs](./apps/next/README.md) for more information.
## Changeset ## Adding a new package
Please follow these steps to add a new package:
1. Only add new packages to the `packages/providers` folder.
2. Use the `package.json` and `tsconfig.json` of an existing packages as template.
3. Reference your new package in the root `tsconfig.json` file
4. Add your package to the `examples/package.json` file if you add a new example.
## Before sending a PR
Before sending a PR, make sure of the following:
1. Tests are all running and you added meaningful tests for your change.
2. If you have a new feature, document it in the `apps/next` docs folder.
3. If you have a new feature, add a new example in the `examples` folder.
4. You have a descriptive changeset for each PR:
### Changesets
We use [changesets](https://github.com/changesets/changesets) for managing versions and changelogs. To create a new We use [changesets](https://github.com/changesets/changesets) for managing versions and changelogs. To create a new
changeset, run in the root folder: changeset, run in the root folder:
``` ```shell
pnpm changeset pnpm changeset
``` ```
Please send a descriptive changeset for each PR.
## Publishing (maintainers only) ## Publishing (maintainers only)
The [Release Github Action](.github/workflows/release.yml) is automatically generating and updating a The [Release Github Action](.github/workflows/release.yml) is automatically generating and updating a
+7 -33
View File
@@ -65,44 +65,18 @@ yarn add llamaindex
See our official document: <https://ts.llamaindex.ai/docs/llamaindex/getting_started/> See our official document: <https://ts.llamaindex.ai/docs/llamaindex/getting_started/>
### Tips when using in non-Node.js environments ### Adding provider packages
When you are importing `llamaindex` in a non-Node.js environment(such as Vercel Edge, Cloudflare Workers, etc.) In most cases, you'll also need to install provider packages to use LlamaIndexTS. These are for adding AI models, file readers for ingestion or storing documents, e.g. in vector databases.
Some classes are not exported from top-level entry file.
The reason is that some classes are only compatible with Node.js runtime,(e.g. `PDFReader`) which uses Node.js specific APIs(like `fs`, `child_process`, `crypto`). For example, to use the OpenAI LLM, you would install the following package:
If you need any of those classes, you have to import them instead directly though their file path in the package. ```shell
Here's an example for importing the `PineconeVectorStore` class: npm install @llamaindex/openai
pnpm install @llamaindex/openai
```typescript yarn add @llamaindex/openai
import { PineconeVectorStore } from "llamaindex/vector-store/PineconeVectorStore";
``` ```
As the `PDFReader` is not working with the Edge runtime, here's how to use the `SimpleDirectoryReader` with the `LlamaParseReader` to load PDFs:
```typescript
import { SimpleDirectoryReader } from "llamaindex/readers/SimpleDirectoryReader";
import { LlamaParseReader } from "llamaindex/readers/LlamaParseReader";
export const DATA_DIR = "./data";
export async function getDocuments() {
const reader = new SimpleDirectoryReader();
// Load PDFs using LlamaParseReader
return await reader.loadData({
directoryPath: DATA_DIR,
fileExtToReader: {
pdf: new LlamaParseReader({ resultType: "markdown" }),
},
});
}
```
> _Note_: Reader classes have to be added explictly to the `fileExtToReader` map in the Edge version of the `SimpleDirectoryReader`.
You'll find a complete example with LlamaIndexTS here: https://github.com/run-llama/create_llama_projects/tree/main/nextjs-edge-llamaparse
## Playground ## Playground
Check out our NextJS playground at https://llama-playground.vercel.app/. The source is available at https://github.com/run-llama/ts-playground Check out our NextJS playground at https://llama-playground.vercel.app/. The source is available at https://github.com/run-llama/ts-playground
+211
View File
@@ -1,5 +1,216 @@
# @llamaindex/doc # @llamaindex/doc
## 0.1.11
### Patch Changes
- a8c0637: feat: simplify to provide base URL to OpenAI
- a654f58: Added docs for using perplexity
- 98eebf7: Add RequestOptions parameter passing to support Gemini proxy calls.
Add a usage example for the RequestOptions parameter.
- Updated dependencies [a8c0637]
- @llamaindex/openai@0.1.61
- llamaindex@0.9.11
## 0.1.10
### Patch Changes
- Updated dependencies [aea550a]
- Updated dependencies [c1b5be5]
- Updated dependencies [40ee761]
- Updated dependencies [40ee761]
- @llamaindex/openai@0.1.60
- llamaindex@0.9.10
- @llamaindex/workflow@0.0.16
- @llamaindex/core@0.5.8
- @llamaindex/cloud@3.0.9
- @llamaindex/node-parser@1.0.8
- @llamaindex/readers@2.0.8
## 0.1.9
### Patch Changes
- 4bac71d: Support binding additional argument to function tool
- Updated dependencies [4bac71d]
- @llamaindex/core@0.5.7
- @llamaindex/cloud@3.0.8
- llamaindex@0.9.9
- @llamaindex/node-parser@1.0.7
- @llamaindex/openai@0.1.59
- @llamaindex/readers@2.0.7
- @llamaindex/workflow@0.0.15
## 0.1.8
### Patch Changes
- Updated dependencies [4b49428]
- Updated dependencies [bbc8c87]
- @llamaindex/workflow@0.0.14
- llamaindex@0.9.8
## 0.1.7
### Patch Changes
- Updated dependencies [beb922b]
- @llamaindex/core@0.5.6
- llamaindex@0.9.7
- @llamaindex/cloud@3.0.7
- @llamaindex/node-parser@1.0.6
- @llamaindex/openai@0.1.58
- @llamaindex/readers@2.0.6
- @llamaindex/workflow@0.0.13
## 0.1.6
### Patch Changes
- Updated dependencies [5668970]
- @llamaindex/core@0.5.5
- @llamaindex/workflow@0.0.12
- @llamaindex/cloud@3.0.6
- llamaindex@0.9.6
- @llamaindex/node-parser@1.0.5
- @llamaindex/openai@0.1.57
- @llamaindex/readers@2.0.5
## 0.1.5
### Patch Changes
- Updated dependencies [ad3c7f1]
- @llamaindex/core@0.5.4
- @llamaindex/cloud@3.0.5
- llamaindex@0.9.5
- @llamaindex/node-parser@1.0.4
- @llamaindex/openai@0.1.56
- @llamaindex/readers@2.0.4
## 0.1.4
### Patch Changes
- Updated dependencies [cb256f2]
- Updated dependencies [cb021e7]
- @llamaindex/openai@0.1.55
- @llamaindex/core@0.5.3
- llamaindex@0.9.4
- @llamaindex/cloud@3.0.4
- @llamaindex/node-parser@1.0.3
- @llamaindex/readers@2.0.3
## 0.1.3
### Patch Changes
- Updated dependencies [d952e68]
- @llamaindex/core@0.5.2
- @llamaindex/cloud@3.0.3
- llamaindex@0.9.3
- @llamaindex/node-parser@1.0.2
- @llamaindex/openai@0.1.54
- @llamaindex/readers@2.0.2
## 0.1.2
### Patch Changes
- Updated dependencies [c902fcb]
- Updated dependencies [88d776f]
- @llamaindex/cloud@3.0.2
- llamaindex@0.9.2
## 0.1.1
### Patch Changes
- Updated dependencies [6d37d44]
- llamaindex@0.9.1
- @llamaindex/cloud@3.0.1
- @llamaindex/core@0.5.1
- @llamaindex/node-parser@1.0.1
- @llamaindex/openai@0.1.53
- @llamaindex/readers@2.0.1
- @llamaindex/workflow@0.0.11
## 0.1.0
### Minor Changes
- 6a4a737: Remove re-exports from llamaindex main package
- f4588bc: Remove readers package from llamaindex
### Patch Changes
- c7c0800: fix: fumadoc build fail
- a87efb9: docs: update chat engine docs
- 7bd5d93: docs: update workflow doc
- Updated dependencies [6a4a737]
- Updated dependencies [d924c63]
- Updated dependencies [b490376]
- Updated dependencies [f4588bc]
- llamaindex@0.9.0
- @llamaindex/core@0.5.0
- @llamaindex/cloud@3.0.0
- @llamaindex/node-parser@1.0.0
- @llamaindex/openai@0.1.52
- @llamaindex/readers@2.0.0
## 0.0.41
### Patch Changes
- Updated dependencies [1c908fd]
- @llamaindex/openai@0.1.51
- @llamaindex/node-parser@0.0.24
- @llamaindex/workflow@0.0.10
- @llamaindex/readers@1.0.25
- @llamaindex/cloud@2.0.24
- @llamaindex/core@0.4.23
- llamaindex@0.8.37
## 0.0.40
### Patch Changes
- Updated dependencies [cb608b5]
- @llamaindex/openai@0.1.50
- @llamaindex/node-parser@0.0.23
- @llamaindex/workflow@0.0.9
- @llamaindex/readers@1.0.24
- @llamaindex/cloud@2.0.23
- @llamaindex/core@0.4.22
- llamaindex@0.8.36
## 0.0.39
### Patch Changes
- 6d4d96f: chore: update examples and docs to use unified imports
- Updated dependencies [15563a0]
- @llamaindex/openai@0.1.49
- llamaindex@0.8.35
## 0.0.38
### Patch Changes
- Updated dependencies [9f8ad37]
- Updated dependencies [7265f74]
- llamaindex@0.8.34
- @llamaindex/openai@0.1.48
## 0.0.37
### Patch Changes
- Updated dependencies [2019a04]
- @llamaindex/openai@0.1.47
- llamaindex@0.8.33
## 0.0.36 ## 0.0.36
### Patch Changes ### Patch Changes
+1 -2
View File
@@ -6,8 +6,7 @@ This is a Next.js application generated with
Run development server: Run development server:
```bash ```bash
turbo run dev pnpm run dev
# turbo will build all required packages before running the dev server
``` ```
## Learn More ## Learn More
+8 -1
View File
@@ -5,8 +5,15 @@ const withMDX = createMDX();
/** @type {import('next').NextConfig} */ /** @type {import('next').NextConfig} */
const config = { const config = {
reactStrictMode: true, reactStrictMode: true,
eslint: {
ignoreDuringBuilds: true,
},
transpilePackages: ["monaco-editor"], transpilePackages: ["monaco-editor"],
serverExternalPackages: ["@huggingface/transformers"], serverExternalPackages: [
"@huggingface/transformers",
"twoslash",
"typescript",
],
webpack: (config, { isServer }) => { webpack: (config, { isServer }) => {
if (Array.isArray(config.target) && config.target.includes("web")) { if (Array.isArray(config.target) && config.target.includes("web")) {
config.target = ["web", "es2020"]; config.target = ["web", "es2020"];
+28 -26
View File
@@ -1,18 +1,19 @@
{ {
"name": "@llamaindex/doc", "name": "@llamaindex/doc",
"version": "0.0.36", "version": "0.1.11",
"private": true, "private": true,
"scripts": { "scripts": {
"build": "pnpm run build:docs && next build", "postinstall": "fumadocs-mdx",
"prebuild": "pnpm run build:docs",
"build": "next build",
"dev": "next dev", "dev": "next dev",
"start": "next start", "start": "next start",
"postdev": "fumadocs-mdx", "postbuild": "tsx scripts/post-build.mts",
"postbuild": "fumadocs-mdx && tsx scripts/post-build.mts", "build:docs": "cross-env NODE_OPTIONS=\"--max-old-space-size=8192\" typedoc && tsx scripts/generate-docs.mts"
"build:docs": "cross-env NODE_OPTIONS=\"--max-old-space-size=8192\" typedoc && node ./scripts/generate-docs.mjs"
}, },
"dependencies": { "dependencies": {
"@icons-pack/react-simple-icons": "^10.1.0", "@icons-pack/react-simple-icons": "^10.1.0",
"@llamaindex/chat-ui": "0.0.9", "@llamaindex/chat-ui": "0.2.0",
"@llamaindex/cloud": "workspace:*", "@llamaindex/cloud": "workspace:*",
"@llamaindex/core": "workspace:*", "@llamaindex/core": "workspace:*",
"@llamaindex/node-parser": "workspace:*", "@llamaindex/node-parser": "workspace:*",
@@ -27,35 +28,35 @@
"@radix-ui/react-slider": "^1.2.1", "@radix-ui/react-slider": "^1.2.1",
"@radix-ui/react-slot": "^1.1.0", "@radix-ui/react-slot": "^1.1.0",
"@radix-ui/react-tooltip": "^1.1.4", "@radix-ui/react-tooltip": "^1.1.4",
"@scalar/api-client-react": "^1.1.25",
"@vercel/functions": "^1.5.0", "@vercel/functions": "^1.5.0",
"ai": "^3.4.33", "ai": "^3.4.33",
"class-variance-authority": "^0.7.0", "class-variance-authority": "^0.7.0",
"clsx": "2.1.1", "clsx": "2.1.1",
"foxact": "^0.2.41", "foxact": "^0.2.41",
"framer-motion": "^11.11.17", "framer-motion": "^11.11.17",
"fumadocs-core": "14.6.0", "fumadocs-core": "^15.0.15",
"fumadocs-docgen": "1.3.2", "fumadocs-docgen": "^2.0.0",
"fumadocs-mdx": "^11.1.2", "fumadocs-mdx": "^11.5.6",
"fumadocs-openapi": "^5.8.2", "fumadocs-openapi": "^6.3.0",
"fumadocs-twoslash": "^2.0.2", "fumadocs-twoslash": "^3.1.0",
"fumadocs-typescript": "^3.0.2", "fumadocs-typescript": "^3.1.0",
"fumadocs-ui": "14.6.0", "fumadocs-ui": "^15.0.15",
"hast-util-to-jsx-runtime": "^2.3.2", "hast-util-to-jsx-runtime": "^2.3.2",
"llamaindex": "workspace:*", "llamaindex": "workspace:*",
"lucide-react": "^0.460.0", "lucide-react": "^0.460.0",
"next": "15.0.3", "next": "^15.2.1",
"next-themes": "^0.4.3", "next-themes": "^0.4.3",
"react": "^18.3.1", "react": "^19.0.0",
"react-dom": "^18.3.1", "react-dom": "^19.0.0",
"react-icons": "^5.3.0", "react-icons": "^5.3.0",
"react-monaco-editor": "^0.56.2", "react-monaco-editor": "^0.56.2",
"react-text-transition": "^3.1.0",
"react-use-measure": "^2.1.1", "react-use-measure": "^2.1.1",
"rehype-katex": "^7.0.1", "rehype-katex": "^7.0.1",
"remark-math": "^6.0.0", "remark-math": "^6.0.0",
"rimraf": "^6.0.1", "rimraf": "^6.0.1",
"shiki": "1.23.1", "shiki": "^3.1.0",
"shiki-magic-move": "^0.5.0", "shiki-magic-move": "^1.0.1",
"swr": "^2.2.5", "swr": "^2.2.5",
"tailwind-merge": "^2.5.2", "tailwind-merge": "^2.5.2",
"tailwindcss-animate": "^1.0.7", "tailwindcss-animate": "^1.0.7",
@@ -66,27 +67,28 @@
"zod": "^3.23.8" "zod": "^3.23.8"
}, },
"devDependencies": { "devDependencies": {
"@next/env": "^15.0.3", "@next/env": "^15.2.1",
"@tailwindcss/postcss": "^4.0.9",
"@types/mdx": "^2.0.13", "@types/mdx": "^2.0.13",
"@types/node": "22.9.0", "@types/node": "22.9.0",
"@types/react": "^18.3.12", "@types/react": "^19.0.10",
"@types/react-dom": "^18.3.1", "@types/react-dom": "^19.0.4",
"autoprefixer": "^10.4.20", "autoprefixer": "^10.4.20",
"cross-env": "^7.0.3", "cross-env": "^7.0.3",
"fast-glob": "^3.3.2", "fast-glob": "^3.3.2",
"gray-matter": "^4.0.3", "gray-matter": "^4.0.3",
"monaco-editor-webpack-plugin": "^7.1.0", "monaco-editor-webpack-plugin": "^7.1.0",
"postcss": "^8.4.49", "postcss": "^8.5.3",
"raw-loader": "^4.0.2", "raw-loader": "^4.0.2",
"remark": "^15.0.1", "remark": "^15.0.1",
"remark-gfm": "^4.0.0", "remark-gfm": "^4.0.0",
"remark-mdx": "^3.1.0", "remark-mdx": "^3.1.0",
"remark-stringify": "^11.0.0", "remark-stringify": "^11.0.0",
"tailwindcss": "^3.4.15", "tailwindcss": "^4.0.9",
"tsx": "^4.19.2", "tsx": "^4.19.3",
"typedoc": "0.27.4", "typedoc": "0.27.4",
"typedoc-plugin-markdown": "^4.3.1", "typedoc-plugin-markdown": "^4.3.1",
"typedoc-plugin-merge-modules": "^6.1.0", "typedoc-plugin-merge-modules": "^6.1.0",
"typescript": "^5.7.2" "typescript": "^5.7.3"
} }
} }
-6
View File
@@ -1,6 +0,0 @@
module.exports = {
plugins: {
tailwindcss: {},
autoprefixer: {},
},
};
+5
View File
@@ -0,0 +1,5 @@
export default {
plugins: {
"@tailwindcss/postcss": {},
},
};
@@ -1,8 +1,7 @@
import * as OpenAPI from "fumadocs-openapi"; import { generateFiles as openapiGenerateFiles } from "fumadocs-openapi";
import { generateFiles } from "fumadocs-typescript"; import { generateFiles as typescriptGenerateFiles } from "fumadocs-typescript";
import fs from "node:fs"; import fs from "node:fs";
import * as path from "node:path"; import * as path from "node:path";
import { fileURLToPath } from "node:url";
import { rimrafSync } from "rimraf"; import { rimrafSync } from "rimraf";
const out = "./src/content/docs/cloud/api"; const out = "./src/content/docs/cloud/api";
@@ -15,28 +14,23 @@ rimrafSync(out, {
}, },
}); });
void OpenAPI.generateFiles({ void openapiGenerateFiles({
input: [ input: ["../../packages/cloud/openapi.json"],
fileURLToPath( output: "./src/content/docs/cloud/api",
new URL("../../../packages/cloud/openapi.json", import.meta.url),
),
],
output: out,
groupBy: "tag", groupBy: "tag",
}); });
void generateFiles({ void typescriptGenerateFiles({
input: ["./src/content/docs/api/**/*.mdx"], input: ["./src/content/docs/api/**/*.mdx"],
output: (file) => path.resolve(path.dirname(file), path.basename(file)), output: (file) => path.resolve(path.dirname(file), path.basename(file)),
transformOutput, transformOutput,
}); });
function transformOutput(filePath, content) { function transformOutput(filePath: string, content: string) {
const fileName = path.basename(filePath); const fileName = path.basename(filePath);
let title = fileName.split(".")[0]; let title = fileName.split(".")[0];
let pageContent = content;
if (title === "index") title = "LlamaIndex API Reference"; if (title === "index") title = "LlamaIndex API Reference";
return `---\ntitle: ${title}\n---\n\n${transformAbsoluteUrl(pageContent, filePath)}`; return `---\ntitle: ${title}\n---\n\n${transformAbsoluteUrl(content, filePath)}`;
} }
/** /**
@@ -46,20 +40,17 @@ function transformOutput(filePath, content) {
* [text](BaseVectorStore.mdx#constructors) -> [text](/docs/api/classes/BaseVectorStore#constructors) * [text](BaseVectorStore.mdx#constructors) -> [text](/docs/api/classes/BaseVectorStore#constructors)
* [text](TaskStep.mdx) -> [text](/docs/api/type-aliases/TaskStep) * [text](TaskStep.mdx) -> [text](/docs/api/type-aliases/TaskStep)
*/ */
function transformAbsoluteUrl(content, filePath) { function transformAbsoluteUrl(content: string, filePath: string) {
const group = path.dirname(filePath).split(path.sep).pop(); const group = path.dirname(filePath).split(path.sep).pop();
return content.replace( return content.replace(/\]\(([^)]+)\.mdx([^)]*)\)/g, (_, slug, anchor) => {
/\]\(([^)]+)\.mdx([^)]*)\)/g, const slugParts = slug.split("/");
(match, slug, anchor) => { const fileName = slugParts[slugParts.length - 1];
const slugParts = slug.split("/"); const fileGroup = slugParts[slugParts.length - 2] ?? group;
const fileName = slugParts[slugParts.length - 1]; const result = ["/docs/api", fileGroup, fileName, anchor]
const fileGroup = slugParts[slugParts.length - 2] ?? group; .filter(Boolean)
const result = ["/docs/api", fileGroup, fileName, anchor] .join("/");
.filter(Boolean) return `](${result})`;
.join("/"); });
return `](${result})`;
},
);
} }
// append meta.json for API page // append meta.json for API page
+5 -1
View File
@@ -4,4 +4,8 @@ import { updateLlamaCloud } from "./update-llamacloud.mjs";
env.loadEnvConfig(process.cwd()); env.loadEnvConfig(process.cwd());
await updateLlamaCloud(); if (process.env.VERCEL_ENV === "production") {
updateLlamaCloud().catch((error) => {
console.error(error);
});
}
+4 -7
View File
@@ -1,11 +1,7 @@
import { upsertBatchPipelineDocumentsApiV1PipelinesPipelineIdDocumentsPut } from "@llamaindex/cloud/api"; import { upsertBatchPipelineDocumentsApiV1PipelinesPipelineIdDocumentsPut } from "@llamaindex/cloud/api";
import fg from "fast-glob"; import fg from "fast-glob";
import { import { fileGenerator, remarkDocGen, remarkInstall } from "fumadocs-docgen";
fileGenerator, import { remarkAutoTypeTable } from "fumadocs-typescript";
remarkDocGen,
remarkInstall,
typescriptGenerator,
} from "fumadocs-docgen";
import matter from "gray-matter"; import matter from "gray-matter";
import * as fs from "node:fs/promises"; import * as fs from "node:fs/promises";
import path, { relative } from "node:path"; import path, { relative } from "node:path";
@@ -21,7 +17,8 @@ async function processContent(content: string): Promise<string> {
const file = await remark() const file = await remark()
.use(remarkMdx) .use(remarkMdx)
.use(remarkGfm) .use(remarkGfm)
.use(remarkDocGen, { generators: [typescriptGenerator(), fileGenerator()] }) .use(remarkAutoTypeTable)
.use(remarkDocGen, { generators: [fileGenerator()] })
.use(remarkInstall, { persist: { id: "package-manager" } }) .use(remarkInstall, { persist: { id: "package-manager" } })
.use(remarkStringify) .use(remarkStringify)
.process(content); .process(content);
+7 -2
View File
@@ -2,10 +2,11 @@ import { rehypeCodeDefaultOptions } from "fumadocs-core/mdx-plugins";
import { fileGenerator, remarkDocGen, remarkInstall } from "fumadocs-docgen"; import { fileGenerator, remarkDocGen, remarkInstall } from "fumadocs-docgen";
import { defineConfig, defineDocs } from "fumadocs-mdx/config"; import { defineConfig, defineDocs } from "fumadocs-mdx/config";
import { transformerTwoslash } from "fumadocs-twoslash"; import { transformerTwoslash } from "fumadocs-twoslash";
import { createFileSystemTypesCache } from "fumadocs-twoslash/cache-fs";
import rehypeKatex from "rehype-katex"; import rehypeKatex from "rehype-katex";
import remarkMath from "remark-math"; import remarkMath from "remark-math";
export const { docs, meta } = defineDocs({ export const docs = defineDocs({
dir: "./src/content/docs", dir: "./src/content/docs",
}); });
@@ -20,7 +21,11 @@ export default defineConfig({
}, },
transformers: [ transformers: [
...(rehypeCodeDefaultOptions.transformers ?? []), ...(rehypeCodeDefaultOptions.transformers ?? []),
transformerTwoslash(), transformerTwoslash({
typesCache: createFileSystemTypesCache({
dir: ".next/cache/twoslash",
}),
}),
{ {
name: "transformers:remove-notation-escape", name: "transformers:remove-notation-escape",
code(hast) { code(hast) {
+54 -43
View File
@@ -8,7 +8,7 @@ import {
} from "@/components/infinite-providers"; } from "@/components/infinite-providers";
import { MagicMove } from "@/components/magic-move"; import { MagicMove } from "@/components/magic-move";
import { NpmInstall } from "@/components/npm-install"; import { NpmInstall } from "@/components/npm-install";
import { TextEffect } from "@/components/text-effect"; import { Supports } from "@/components/supports";
import { Button } from "@/components/ui/button"; import { Button } from "@/components/ui/button";
import { Skeleton } from "@/components/ui/skeleton"; import { Skeleton } from "@/components/ui/skeleton";
import { LEGACY_DOCUMENT_URL } from "@/lib/const"; import { LEGACY_DOCUMENT_URL } from "@/lib/const";
@@ -24,18 +24,18 @@ import { Suspense } from "react";
export default function HomePage() { export default function HomePage() {
return ( return (
<main className="container mx-auto px-4 py-12"> <main className="container mx-auto px-4 py-12">
<h1 className="text-4xl md:text-6xl font-bold text-center mb-4"> <h1 className="mb-4 text-center text-4xl font-bold md:text-6xl">
Build context-augmented web apps using Build context-augmented web apps using
<br /> <span className="text-blue-500">LlamaIndex.TS</span> <br /> <span className="text-blue-500">LlamaIndex.TS</span>
</h1> </h1>
<p className="text-xl text-center text-fd-muted-foreground mb-12 "> <p className="text-fd-muted-foreground mb-12 text-center text-xl">
LlamaIndex.TS is the JS/TS version of{" "} LlamaIndex.TS is the JS/TS version of{" "}
<a href="https://llamaindex.ai">LlamaIndex</a>, the framework for <a href="https://llamaindex.ai">LlamaIndex</a>, the framework for
building agentic generative AI applications connected to your data. building agentic generative AI applications connected to your data.
</p> </p>
<div className="text-center text-lg text-fd-muted-foreground mb-12"> <div className="text-fd-muted-foreground mb-12 text-center text-lg">
<span>Designed for building web applications in </span> <span>Designed for building web applications in </span>
<TextEffect /> <Supports />
</div> </div>
<div className="flex flex-wrap justify-center gap-4"> <div className="flex flex-wrap justify-center gap-4">
@@ -60,7 +60,7 @@ export default function HomePage() {
icon={Footprints} icon={Footprints}
subheading="Progressive" subheading="Progressive"
heading="From the simplest to the most complex" heading="From the simplest to the most complex"
description="LlamaIndex.TS is designed to be simple to get started, but powerful enough to build complex, agentic AI applications." description="LlamaIndex.TS is designed to be simple to get started, but powerful enough to build complex, agentic AI applications using multi-agents."
> >
<Suspense <Suspense
fallback={ fallback={
@@ -76,38 +76,48 @@ export default function HomePage() {
> >
<MagicMove <MagicMove
code={[ code={[
`import { OpenAI } from "llamaindex"; `import { openai } from "@llamaindex/openai";
const llm = new OpenAI();
const llm = openai();
const response = await llm.complete({ prompt: "How are you?" });`, const response = await llm.complete({ prompt: "How are you?" });`,
`import { OpenAI } from "llamaindex"; `import { openai } from "@llamaindex/openai";
const llm = new OpenAI();
const llm = openai();
const response = await llm.chat({ const response = await llm.chat({
messages: [{ content: "Tell me a joke.", role: "user" }], messages: [{ content: "Tell me a joke.", role: "user" }],
});`, });`,
`import { OpenAI, ChatMemoryBuffer } from "llamaindex"; `import { agent } from "llamaindex";
const llm = new OpenAI({ model: 'gpt4o-turbo' }); import { openai } from "@llamaindex/openai";
const buffer = new ChatMemoryBuffer({
tokenLimit: 128_000, const analyseAgent = agent({
}) llm: openai({ model: "gpt-4o" }),
buffer.put({ content: "Tell me a joke.", role: "user" }) tools: [analyseTools],
const response = await llm.chat({
messages: buffer.getMessages(),
stream: true
});`,
`import { OpenAIAgent, ChatMemoryBuffer } from "llamaindex";
const agent = new OpenAIAgent({
llm,
tools: [...myTools]
systemPrompt, systemPrompt,
}); });
const buffer = new ChatMemoryBuffer({ const response = await analyseAgent.run(\`Analyse the given data:
tokenLimit: 128_000, \${data}\`);`,
}) `import { agent, multiAgent } from "llamaindex";
buffer.put({ content: "Analysis the data based on the given data.", role: "user" }) import { openai } from "@llamaindex/openai";
buffer.put({ content: \`\${data}\`, role: "user" })
const response = await agent.chat({ const analyseAgent = agent({
message: buffer.getMessages(), name: "AnalyseAgent",
});`, llm: openai({ model: "gpt-4o" }),
tools: [analyseTools],
});
const reporterAgent = agent({
name: "ReporterAgent",
llm: openai({ model: "gpt-4o" }),
tools: [reporterTools],
canHandoffTo: [analyseAgent],
});
const agents = multiAgent({
agents: [analyseAgent, reporterAgent],
rootAgent: reporterAgent,
});
const response = await agents.run(\`Analyse the given data:
\${data}\`);`,
]} ]}
/> />
</Suspense> </Suspense>
@@ -119,19 +129,20 @@ const response = await agent.chat({
description="Truly powerful retrieval-augmented generation applications use agentic techniques, and LlamaIndex.TS makes it easy to build them." description="Truly powerful retrieval-augmented generation applications use agentic techniques, and LlamaIndex.TS makes it easy to build them."
> >
<CodeBlock <CodeBlock
code={`import { FunctionTool } from "llamaindex"; code={`import { agent, SimpleDirectoryReader, VectorStoreIndex } from "llamaindex";
import { OpenAIAgent } from "@llamaindex/openai"; import { openai } from "@llamaindex/openai";
const interpreterTool = FunctionTool.from(...); // load documents from current directoy into an index
const systemPrompt = \`...\`; const reader = new SimpleDirectoryReader();
const documents = await reader.loadData(currentDir);
const index = await VectorStoreIndex.fromDocuments(documents);
const agent = new OpenAIAgent({ const myAgent = agent({
llm, llm: openai({ model: "gpt-4o" }),
tools: [interpreterTool], tools: [index.queryTool()],
systemPrompt,
}); });
await agent.chat('...');`} await myAgent.run('...');`}
lang="ts" lang="ts"
/> />
</Feature> </Feature>
@@ -143,13 +154,13 @@ await agent.chat('...');`}
> >
<div className="mt-8 flex flex-col gap-8"> <div className="mt-8 flex flex-col gap-8">
<div> <div>
<h3 className="text-lg font-semibold text-fd-muted-foreground mb-2"> <h3 className="text-fd-muted-foreground mb-2 text-lg font-semibold">
LLMs LLMs
</h3> </h3>
<InfiniteLLMProviders /> <InfiniteLLMProviders />
</div> </div>
<div> <div>
<h3 className="text-lg font-semibold text-fd-muted-foreground mb-2"> <h3 className="text-fd-muted-foreground mb-2 text-lg font-semibold">
Vector Stores Vector Stores
</h3> </h3>
<InfiniteVectorStoreProviders /> <InfiniteVectorStoreProviders />
-11
View File
@@ -1,11 +0,0 @@
import { LEGACY_DOCUMENT_URL } from "@/lib/const";
import { redirect } from "next/navigation";
export default async function Page(props: {
params: Promise<{
any: string[];
}>;
}) {
const path = await props.params.then(({ any }) => any.join("/"));
return redirect(new URL(path, LEGACY_DOCUMENT_URL).toString());
}
+4 -1
View File
@@ -13,6 +13,8 @@ import { notFound } from "next/navigation";
const { AutoTypeTable } = createTypeTable(); const { AutoTypeTable } = createTypeTable();
export const revalidate = false;
export default async function Page(props: { export default async function Page(props: {
params: Promise<{ slug?: string[] }>; params: Promise<{ slug?: string[] }>;
}) { }) {
@@ -26,10 +28,10 @@ export default async function Page(props: {
<DocsPage <DocsPage
toc={page.data.toc} toc={page.data.toc}
full={page.data.full} full={page.data.full}
lastUpdate={page.data.lastModified}
editOnGithub={{ editOnGithub={{
owner: "run-llama", owner: "run-llama",
repo: "LlamaIndexTS", repo: "LlamaIndexTS",
sha: "main",
path: `apps/next/src/content/docs/${page.file.path}`, path: `apps/next/src/content/docs/${page.file.path}`,
}} }}
> >
@@ -64,6 +66,7 @@ export async function generateMetadata(props: {
return createMetadata( return createMetadata(
metadataImage.withImage(page.slugs, { metadataImage.withImage(page.slugs, {
metadataBase: new URL("https://ts.llamaindex.ai"),
title: page.data.title, title: page.data.title,
description: page.data.description, description: page.data.description,
openGraph: { openGraph: {
+1 -1
View File
@@ -22,7 +22,7 @@ export default function Layout({ children }: { children: ReactNode }) {
variant: "secondary", variant: "secondary",
size: "xs", size: "xs",
className: className:
"md:flex-1 px-2 ms-2 gap-1.5 text-fd-muted-foreground rounded-full", "text-fd-muted-foreground ms-2 gap-1.5 rounded-full px-2 md:flex-1",
}), }),
)} )}
> >
+11 -40
View File
@@ -1,6 +1,13 @@
@tailwind base; @import "tailwindcss";
@tailwind components; @import "fumadocs-ui/css/neutral.css";
@tailwind utilities; @import "fumadocs-ui/css/preset.css";
@import "../../node_modules/fumadocs-twoslash/dist/twoslash.css";
@plugin "tailwindcss-animate";
@source '../../node_modules/fumadocs-ui/dist/**/*.js';
@source "../../node_modules/fumadocs-openapi/dist/**/*.js",
@source '../../node_modules/@llamaindex/chat-ui/dist/**/*.js';
@config "../../tailwind.config.mjs";
@layer base { @layer base {
:root { :root {
--page-max-width: 1840px; --page-max-width: 1840px;
@@ -46,6 +53,7 @@
--chart-5: 27 87% 67%; --chart-5: 27 87% 67%;
--radius: 0.5rem; --radius: 0.5rem;
} }
.dark { .dark {
--color-neutral-000: #0e0c15; --color-neutral-000: #0e0c15;
--color-neutral-100: #252134; --color-neutral-100: #252134;
@@ -87,40 +95,3 @@
--chart-5: 340 75% 55%; --chart-5: 340 75% 55%;
} }
} }
@layer base {
* {
@apply border-border;
}
body {
@apply bg-background text-foreground;
}
/*
* Override default styles for Markdown
*/
.prose
:where(blockquote):not(
:where([class~="not-prose"], [class~="not-prose"] *)
) {
font-style: normal !important;
}
.prose
:where(blockquote p:first-of-type):not(
:where([class~="not-prose"], [class~="not-prose"] *)
):before {
content: none !important;
}
.prose
:where(blockquote p:first-of-type):not(
:where([class~="not-prose"], [class~="not-prose"] *)
):after {
content: none !important;
}
.prose
:where(code):not(:where([class~="not-prose"], [class~="not-prose"] *)) {
@apply text-blue-600 !important;
}
}
+1 -1
View File
@@ -32,7 +32,7 @@ export default function Layout({ children }: { children: ReactNode }) {
href="/favicon-16x16.png" href="/favicon-16x16.png"
/> />
</head> </head>
<body className="flex flex-col min-h-screen"> <body className="flex min-h-screen flex-col">
<TooltipProvider> <TooltipProvider>
<AIProvider> <AIProvider>
<RootProvider>{children}</RootProvider> <RootProvider>{children}</RootProvider>
+62
View File
@@ -0,0 +1,62 @@
import fg from "fast-glob";
import { fileGenerator, remarkDocGen, remarkInstall } from "fumadocs-docgen";
import { remarkInclude } from "fumadocs-mdx/config";
import { remarkAutoTypeTable } from "fumadocs-typescript";
import matter from "gray-matter";
import * as fs from "node:fs/promises";
import path from "node:path";
import { remark } from "remark";
import remarkGfm from "remark-gfm";
import remarkMdx from "remark-mdx";
import remarkStringify from "remark-stringify";
export const revalidate = false;
export async function GET() {
const files = await fg([
"./src/content/docs/**/*.mdx",
// remove generated openapi files
"!./src/content/docs/cloud/api/**/*",
]);
const scan = files.map(async (file) => {
const fileContent = await fs.readFile(file);
const { content, data } = matter(fileContent.toString());
const dir = path.dirname(file).split(path.sep).at(4);
const category = {
llamaindex: "LlamaIndexTS Framework",
api: "LlamaIndexTS API",
cloud: "LlamaCloud Service",
}[dir ?? ""];
const processed = await processContent(file, content);
return `file: ${file}
# ${category}: ${data.title}
${data.description}
${processed}`;
});
const scanned = await Promise.all(scan);
return new Response(scanned.join("\n\n"));
}
async function processContent(path: string, content: string): Promise<string> {
const file = await remark()
.use(remarkMdx)
.use(remarkInclude)
.use(remarkGfm)
.use(remarkAutoTypeTable)
.use(remarkDocGen, { generators: [fileGenerator()] })
.use(remarkInstall, { persist: { id: "package-manager" } })
.use(remarkStringify)
.process({
path,
value: content,
});
return String(file);
}
+5 -5
View File
@@ -45,13 +45,13 @@ export const AITrigger = (props: AITriggerProps) => {
<Dialog> <Dialog>
<DialogTrigger {...props} /> <DialogTrigger {...props} />
<DialogPortal> <DialogPortal>
<DialogOverlay className="fixed inset-0 z-50 bg-fd-background/50 backdrop-blur-sm data-[state=closed]:animate-fd-fade-out data-[state=open]:animate-fd-fade-in" /> <DialogOverlay className="bg-fd-background/50 data-[state=closed]:animate-fd-fade-out data-[state=open]:animate-fd-fade-in fixed inset-0 z-50 backdrop-blur-sm" />
<DialogContent <DialogContent
onOpenAutoFocus={(e) => { onOpenAutoFocus={(e) => {
document.getElementById("nd-ai-input")?.focus(); document.getElementById("nd-ai-input")?.focus();
e.preventDefault(); e.preventDefault();
}} }}
className="fixed left-1/2 z-50 my-[5vh] flex max-h-[90dvh] w-[98vw] max-w-[860px] origin-left -translate-x-1/2 flex-col rounded-lg border bg-fd-popover text-fd-popover-foreground shadow-lg focus-visible:outline-none data-[state=closed]:animate-fd-dialog-out data-[state=open]:animate-fd-dialog-in" className="bg-fd-popover text-fd-popover-foreground data-[state=closed]:animate-fd-dialog-out data-[state=open]:animate-fd-dialog-in fixed left-1/2 z-50 my-[5vh] flex max-h-[90dvh] w-[98vw] max-w-[860px] origin-left -translate-x-1/2 flex-col rounded-lg border shadow-lg focus-visible:outline-none"
> >
<DialogHeader> <DialogHeader>
<DialogTitle className="sr-only">Search AI</DialogTitle> <DialogTitle className="sr-only">Search AI</DialogTitle>
@@ -67,11 +67,11 @@ export const AITrigger = (props: AITriggerProps) => {
</AlertDescription> </AlertDescription>
</Alert> </Alert>
</DialogHeader> </DialogHeader>
<div className="overflow-scroll flex-grow mt-4"> <div className="mt-4 flex-grow overflow-scroll">
<ChatList messages={messages} /> <ChatList messages={messages} />
</div> </div>
<form <form
className="px-4 py-2 space-y-4" className="space-y-4 px-4 py-2"
action={async () => { action={async () => {
const value = inputValue.trim(); const value = inputValue.trim();
setInputValue(""); setInputValue("");
@@ -102,7 +102,7 @@ export const AITrigger = (props: AITriggerProps) => {
} }
}} }}
> >
<div className="flex flex-row w-full items-center gap-2"> <div className="flex w-full flex-row items-center gap-2">
<Textarea <Textarea
tabIndex={0} tabIndex={0}
placeholder="Ask AI about documentation." placeholder="Ask AI about documentation."
+5 -34
View File
@@ -1,50 +1,21 @@
import { highlight } from "fumadocs-core/highlight";
import * as Base from "fumadocs-ui/components/codeblock"; import * as Base from "fumadocs-ui/components/codeblock";
import { toJsxRuntime, type Jsx } from "hast-util-to-jsx-runtime"; import type { BundledLanguage } from "shiki";
import { Fragment } from "react";
import { jsx, jsxs } from "react/jsx-runtime";
import { codeToHast } from "shiki";
export interface CodeBlockProps { export interface CodeBlockProps {
code: string; code: string;
wrapper?: Base.CodeBlockProps; wrapper?: Base.CodeBlockProps;
lang: "bash" | "ts" | "tsx"; lang: BundledLanguage;
} }
export async function CodeBlock({ export async function CodeBlock({ code, lang, wrapper }: CodeBlockProps) {
code, const rendered = await highlight(code, {
lang,
wrapper,
}: CodeBlockProps): Promise<React.ReactElement> {
const hast = await codeToHast(code, {
lang, lang,
defaultColor: false,
themes: { themes: {
light: "github-light", light: "github-light",
dark: "vesper", dark: "vesper",
}, },
transformers: [
{
name: "rehype-code:pre-process",
line(node) {
if (node.children.length === 0) {
// Keep the empty lines when using grid layout
node.children.push({
type: "text",
value: " ",
});
}
},
},
],
});
const rendered = toJsxRuntime(hast, {
jsx: jsx as Jsx,
jsxs: jsxs as Jsx,
Fragment,
development: false,
components: { components: {
// @ts-expect-error -- JSX component
pre: Base.Pre, pre: Base.Pre,
}, },
}); });
+1 -1
View File
@@ -10,7 +10,7 @@ export function Contributing(): ReactElement {
<h2 className="mb-4 text-xl font-semibold sm:text-2xl"> <h2 className="mb-4 text-xl font-semibold sm:text-2xl">
Made possible by you <Heart className="inline align-middle" /> Made possible by you <Heart className="inline align-middle" />
</h2> </h2>
<p className="mb-4 text-fd-muted-foreground"> <p className="text-fd-muted-foreground mb-4">
LlamaIndex.TS is powered by the open source community. LlamaIndex.TS is powered by the open source community.
</p> </p>
<div className="mb-8 flex flex-row items-center gap-2"> <div className="mb-8 flex flex-row items-center gap-2">
@@ -33,7 +33,7 @@ export default async function ContributorCounter({
href={`https://github.com/${contributor.login}`} href={`https://github.com/${contributor.login}`}
rel="noreferrer noopener" rel="noreferrer noopener"
target="_blank" target="_blank"
className="size-10 overflow-hidden rounded-full border-4 border-fd-background bg-fd-background md:-mr-4 md:size-12" className="border-fd-background bg-fd-background size-10 overflow-hidden rounded-full border-4 md:-mr-4 md:size-12"
style={{ style={{
zIndex: topContributors.length - i, zIndex: topContributors.length - i,
}} }}
@@ -48,7 +48,7 @@ export default async function ContributorCounter({
</a> </a>
))} ))}
{displayCount < contributors.length ? ( {displayCount < contributors.length ? (
<div className="size-12 content-center rounded-full bg-fd-secondary text-center"> <div className="bg-fd-secondary size-12 content-center rounded-full text-center">
+{contributors.length - displayCount} +{contributors.length - displayCount}
</div> </div>
) : null} ) : null}
@@ -83,7 +83,7 @@ export function CreateAppAnimation(): React.ReactElement {
}} }}
> >
{tick > timeWindowOpen && ( {tick > timeWindowOpen && (
<LaunchAppWindow className="absolute bottom-5 right-4 z-10 animate-in fade-in slide-in-from-top-10" /> <LaunchAppWindow className="animate-in fade-in slide-in-from-top-10 absolute bottom-5 right-4 z-10" />
)} )}
<pre className="overflow-hidden rounded-xl border text-xs"> <pre className="overflow-hidden rounded-xl border text-xs">
<div className="flex flex-row items-center gap-2 border-b px-4 py-2"> <div className="flex flex-row items-center gap-2 border-b px-4 py-2">
@@ -92,7 +92,7 @@ export function CreateAppAnimation(): React.ReactElement {
<div className="grow" /> <div className="grow" />
<div className="size-2 rounded-full bg-red-400" /> <div className="size-2 rounded-full bg-red-400" />
</div> </div>
<div className="min-h-[200px] bg-gradient-to-b from-fd-secondary [mask-image:linear-gradient(to_bottom,white,transparent)]"> <div className="from-fd-secondary min-h-[200px] bg-gradient-to-b [mask-image:linear-gradient(to_bottom,white,transparent)]">
<code className="grid p-4">{lines}</code> <code className="grid p-4">{lines}</code>
</div> </div>
</pre> </pre>
@@ -103,7 +103,7 @@ export function CreateAppAnimation(): React.ReactElement {
function UserMessage({ children }: { children: ReactNode }) { function UserMessage({ children }: { children: ReactNode }) {
return ( return (
<div className="group relative flex items-start"> <div className="group relative flex items-start">
<div className="flex h-8 w-8 shrink-0 select-none items-center justify-center rounded-md border shadow-sm bg-background"> <div className="bg-background flex h-8 w-8 shrink-0 select-none items-center justify-center rounded-md border shadow-sm">
<IconUser /> <IconUser />
</div> </div>
<div className="ml-4 flex-1 space-y-2 overflow-hidden px-1"> <div className="ml-4 flex-1 space-y-2 overflow-hidden px-1">
@@ -122,7 +122,7 @@ function BotMessage({
}) { }) {
return ( return (
<div className={cn("group relative flex items-start", className)}> <div className={cn("group relative flex items-start", className)}>
<div className="flex h-8 w-8 shrink-0 select-none items-center justify-center rounded-md border shadow-sm bg-primary text-primary-foreground"> <div className="bg-primary text-primary-foreground flex h-8 w-8 shrink-0 select-none items-center justify-center rounded-md border shadow-sm">
<IconAI /> <IconAI />
</div> </div>
<div className="ml-4 flex-1 space-y-2 overflow-hidden px-1"> <div className="ml-4 flex-1 space-y-2 overflow-hidden px-1">
@@ -164,7 +164,7 @@ export function ChatExample() {
return ( return (
<div className="max-w-64"> <div className="max-w-64">
<div className="flex flex-col px-4 gap-2"> <div className="flex flex-col gap-2 px-4">
{userMessageLength === userMessageFull.length && ( {userMessageLength === userMessageFull.length && (
<UserMessage> <UserMessage>
<span>{userMessageFull}</span> <span>{userMessageFull}</span>
@@ -204,11 +204,11 @@ function LaunchAppWindow(
<div <div
{...props} {...props}
className={cn( className={cn(
"overflow-hidden rounded-md border bg-fd-background shadow-xl", "bg-fd-background overflow-hidden rounded-md border shadow-xl",
props.className, props.className,
)} )}
> >
<div className="relative flex h-6 flex-row items-center border-b bg-fd-muted px-4 text-xs text-fd-muted-foreground"> <div className="bg-fd-muted text-fd-muted-foreground relative flex h-6 flex-row items-center border-b px-4 text-xs">
<p className="absolute inset-x-0 text-center">localhost:8080</p> <p className="absolute inset-x-0 text-center">localhost:8080</p>
</div> </div>
<div className="p-4 text-sm"> <div className="p-4 text-sm">
@@ -1,11 +1,16 @@
"use client"; "use client";
import { ChatInput, ChatMessages, ChatSection } from "@llamaindex/chat-ui"; import {
ChatHandler,
ChatInput,
ChatMessages,
ChatSection,
} from "@llamaindex/chat-ui";
import { useChat } from "ai/react"; import { useChat } from "ai/react";
export const ChatDemo = () => { export const ChatDemo = () => {
const handler = useChat(); const handler = useChat();
return ( return (
<ChatSection handler={handler}> <ChatSection handler={handler as ChatHandler}>
<ChatMessages> <ChatMessages>
<ChatMessages.List className="h-auto max-h-[400px]" /> <ChatMessages.List className="h-auto max-h-[400px]" />
<ChatMessages.Actions /> <ChatMessages.Actions />
@@ -1,23 +1,25 @@
"use client"; "use client";
import { import {
ChatHandler,
ChatInput, ChatInput,
ChatMessage, ChatMessage,
ChatMessages, ChatMessages,
ChatSection as ChatSectionUI, ChatSection as ChatSectionUI,
Message,
} from "@llamaindex/chat-ui"; } from "@llamaindex/chat-ui";
import { useChatRSC } from "./use-chat-rsc"; import { useChatRSC } from "./use-chat-rsc";
export const ChatSectionRSC = () => { export const ChatSectionRSC = () => {
const handler = useChatRSC(); const handler = useChatRSC();
return ( return (
<ChatSectionUI handler={handler}> <ChatSectionUI handler={handler as ChatHandler}>
<ChatMessages> <ChatMessages>
<ChatMessages.List className="h-auto max-h-[400px]"> <ChatMessages.List className="h-auto max-h-[400px]">
{handler.messages.map((message, index) => ( {handler.messages.map((message, index) => (
<ChatMessage <ChatMessage
key={index} key={index}
message={message} message={message as Message}
isLast={index === handler.messages.length - 1} isLast={index === handler.messages.length - 1}
> >
<ChatMessage.Avatar /> <ChatMessage.Avatar />
@@ -57,7 +57,7 @@ export const IDE = () => {
const maxChars = useSlider(); const maxChars = useSlider();
const useSetMaxChars = useSetSlider(); const useSetMaxChars = useSetSlider();
return ( return (
<div className="flex flex-col p-4 border-r max-h-96 overflow-scroll"> <div className="flex max-h-96 flex-col overflow-scroll border-r p-4">
<div> <div>
<Label>Max Chars {maxChars}</Label> <Label>Max Chars {maxChars}</Label>
<Slider <Slider
@@ -113,7 +113,7 @@ const Preview = ({ text }: { text: string }) => {
}, },
}, },
}); });
return <CodeBlock className="py-0 m-2">{rendered}</CodeBlock>; return <CodeBlock className="m-2 py-0">{rendered}</CodeBlock>;
}; };
function ScrollToBottom() { function ScrollToBottom() {
@@ -122,7 +122,7 @@ function ScrollToBottom() {
return ( return (
!isAtBottom && ( !isAtBottom && (
<button <button
className="absolute i-ph-arrow-circle-down-fill text-4xl rounded-lg left-[50%] translate-x-[-50%] bottom-0" className="i-ph-arrow-circle-down-fill absolute bottom-0 left-[50%] translate-x-[-50%] rounded-lg text-4xl"
onClick={() => scrollToBottom()} onClick={() => scrollToBottom()}
/> />
) )
@@ -136,7 +136,7 @@ export const NodePreview = () => {
const textChunks = useMemo(() => parser.splitText(code), [code, maxChars]); const textChunks = useMemo(() => parser.splitText(code), [code, maxChars]);
return ( return (
<StickToBottom <StickToBottom
className="block relative max-h-96 overflow-scroll" className="relative block max-h-96 overflow-scroll"
resize="smooth" resize="smooth"
initial="smooth" initial="smooth"
> >
@@ -154,7 +154,7 @@ export const CodeNodeParserDemo = () => {
const isClient = useIsClient(); const isClient = useIsClient();
if (!isClient) { if (!isClient) {
return ( return (
<div className="my-2 grid grid-cols-1 md:grid-cols-2 gap-2 border rounded-xl w-full max-h-96"> <div className="my-2 grid max-h-96 w-full grid-cols-1 gap-2 rounded-xl border md:grid-cols-2">
<Skeleton className="h-96" /> <Skeleton className="h-96" />
<Skeleton className="h-96" /> <Skeleton className="h-96" />
</div> </div>
@@ -165,13 +165,13 @@ export const CodeNodeParserDemo = () => {
<CodeProvider> <CodeProvider>
<Suspense <Suspense
fallback={ fallback={
<div className="my-2 grid grid-cols-1 md:grid-cols-2 gap-2 border rounded-xl w-full max-h-96"> <div className="my-2 grid max-h-96 w-full grid-cols-1 gap-2 rounded-xl border md:grid-cols-2">
<Skeleton className="h-96" /> <Skeleton className="h-96" />
<Skeleton className="h-96" /> <Skeleton className="h-96" />
</div> </div>
} }
> >
<div className="my-2 grid grid-cols-1 md:grid-cols-2 gap-2 border rounded-xl w-full max-h-96"> <div className="my-2 grid max-h-96 w-full grid-cols-1 gap-2 rounded-xl border md:grid-cols-2">
<IDE /> <IDE />
<NodePreview /> <NodePreview />
</div> </div>
@@ -75,7 +75,7 @@ function ScrollToBottom() {
return ( return (
!isAtBottom && ( !isAtBottom && (
<button <button
className="absolute i-ph-arrow-circle-down-fill text-4xl rounded-lg left-[50%] translate-x-[-50%] bottom-0" className="i-ph-arrow-circle-down-fill absolute bottom-0 left-[50%] translate-x-[-50%] rounded-lg text-4xl"
onClick={() => scrollToBottom()} onClick={() => scrollToBottom()}
/> />
) )
@@ -91,9 +91,9 @@ export function WorkflowStreamingDemo() {
const [total, setTotal] = useState<number>(10); const [total, setTotal] = useState<number>(10);
return ( return (
<div className="flex flex-col items-start w-full gap-2"> <div className="flex w-full flex-col items-start gap-2">
<div className="flex flex-row justify-center items-center"> <div className="flex flex-row items-center justify-center">
<div className="text-lg mr-2">Compute total</div>{" "} <div className="mr-2 text-lg">Compute total</div>{" "}
<FlowInput value={total} onChange={(value) => setTotal(value)} /> <FlowInput value={total} onChange={(value) => setTotal(value)} />
</div> </div>
<Button <Button
@@ -141,7 +141,7 @@ export function WorkflowStreamingDemo() {
> >
Start Workflow Start Workflow
</Button> </Button>
<StickToBottom className="w-full flex flex-col gap-2 p-2 border border-gray-200 rounded-lg max-h-96 overflow-y-auto"> <StickToBottom className="flex max-h-96 w-full flex-col gap-2 overflow-y-auto rounded-lg border border-gray-200 p-2">
<StickToBottom.Content className="flex flex-col gap-2"> <StickToBottom.Content className="flex flex-col gap-2">
{ui} {ui}
</StickToBottom.Content> </StickToBottom.Content>
+1 -1
View File
@@ -20,7 +20,7 @@ export function Feature({
className={cn("border-l border-t px-6 py-12 md:py-16", className)} className={cn("border-l border-t px-6 py-12 md:py-16", className)}
{...props} {...props}
> >
<div className="mb-4 inline-flex items-center gap-2 text-sm font-medium text-fd-muted-foreground"> <div className="text-fd-muted-foreground mb-4 inline-flex items-center gap-2 text-sm font-medium">
<Icon className="size-4" /> <Icon className="size-4" />
<p>{subheading}</p> <p>{subheading}</p>
</div> </div>
+1 -1
View File
@@ -60,7 +60,7 @@ export default function FlowInput({
className={clsx( className={clsx(
showCaret ? "caret-primary" : "caret-transparent", showCaret ? "caret-primary" : "caret-transparent",
"spin-hide w-[1.5em] bg-transparent py-2 text-center font-[inherit] text-transparent outline-none", "spin-hide w-[1.5em] bg-transparent py-2 text-center font-[inherit] text-transparent outline-none",
"[appearance:textfield] [&::-webkit-outer-spin-button]:appearance-none [&::-webkit-inner-spin-button]:appearance-none", "[appearance:textfield] [&::-webkit-inner-spin-button]:appearance-none [&::-webkit-outer-spin-button]:appearance-none",
)} )}
// Make sure to disable kerning, to match NumberFlow: // Make sure to disable kerning, to match NumberFlow:
style={{ fontKerning: "none" }} style={{ fontKerning: "none" }}
+2 -2
View File
@@ -8,7 +8,7 @@ import { IconAI, IconUser } from "./ui/icons";
export function UserMessage({ children }: { children: ReactNode }) { export function UserMessage({ children }: { children: ReactNode }) {
return ( return (
<div className="group relative flex items-start"> <div className="group relative flex items-start">
<div className="flex h-8 w-8 shrink-0 select-none items-center justify-center rounded-md border shadow-sm bg-background"> <div className="bg-background flex h-8 w-8 shrink-0 select-none items-center justify-center rounded-md border shadow-sm">
<IconUser /> <IconUser />
</div> </div>
<div className="ml-4 flex-1 space-y-2 overflow-hidden px-1"> <div className="ml-4 flex-1 space-y-2 overflow-hidden px-1">
@@ -54,7 +54,7 @@ export function BotCard({
<div className="group relative flex items-start md:-ml-12"> <div className="group relative flex items-start md:-ml-12">
<div <div
className={cn( className={cn(
"flex h-8 w-8 shrink-0 select-none items-center justify-center rounded-md border shadow-sm bg-primary text-primary-foreground", "bg-primary text-primary-foreground flex h-8 w-8 shrink-0 select-none items-center justify-center rounded-md border shadow-sm",
!showAvatar && "invisible", !showAvatar && "invisible",
)} )}
> >
+1 -1
View File
@@ -25,7 +25,7 @@ export const NpmInstall = () => {
className="flex flex-row items-center justify-center" className="flex flex-row items-center justify-center"
> >
<code className="mr-2">$ npm i llamaindex</code> <code className="mr-2">$ npm i llamaindex</code>
<div className="relative cursor-pointer bg-transparent w-4 h-4"> <div className="relative h-4 w-4 cursor-pointer bg-transparent">
<div <div
className={`absolute inset-0 transform transition-all duration-300 ${ className={`absolute inset-0 transform transition-all duration-300 ${
hasCheckIcon ? "scale-0 opacity-0" : "scale-100 opacity-100" hasCheckIcon ? "scale-0 opacity-0" : "scale-100 opacity-100"
@@ -0,0 +1,268 @@
import { cn } from "@/lib/utils";
import {
AnimatePresence,
motion,
Transition,
type AnimationControls,
type Target,
type TargetAndTransition,
type VariantLabels,
} from "framer-motion";
import React, {
forwardRef,
useCallback,
useEffect,
useImperativeHandle,
useMemo,
useState,
} from "react";
export interface RotatingTextRef {
next: () => void;
previous: () => void;
jumpTo: (index: number) => void;
reset: () => void;
}
export interface RotatingTextProps
extends Omit<
React.ComponentPropsWithoutRef<typeof motion.span>,
"children" | "transition" | "initial" | "animate" | "exit"
> {
texts: string[];
transition?: Transition;
initial?: boolean | Target | VariantLabels;
animate?: boolean | VariantLabels | AnimationControls | TargetAndTransition;
exit?: Target | VariantLabels;
animatePresenceMode?: "sync" | "wait";
animatePresenceInitial?: boolean;
rotationInterval?: number;
staggerDuration?: number;
staggerFrom?: "first" | "last" | "center" | "random" | number;
loop?: boolean;
auto?: boolean;
splitBy?: string;
onNext?: (index: number) => void;
mainClassName?: string;
splitLevelClassName?: string;
elementLevelClassName?: string;
}
export const RotatingText = forwardRef<RotatingTextRef, RotatingTextProps>(
(
{
texts,
transition = { type: "spring", damping: 25, stiffness: 300 },
initial = { y: "100%", opacity: 0 },
animate = { y: 0, opacity: 1 },
exit = { y: "-120%", opacity: 0 },
animatePresenceMode = "wait",
animatePresenceInitial = false,
rotationInterval = 2000,
staggerDuration = 0,
staggerFrom = "first",
loop = true,
auto = true,
splitBy = "characters",
onNext,
mainClassName,
splitLevelClassName,
elementLevelClassName,
...rest
},
ref,
) => {
const [currentTextIndex, setCurrentTextIndex] = useState<number>(0);
const splitIntoCharacters = (text: string): string[] => {
if (typeof Intl !== "undefined" && Intl.Segmenter) {
const segmenter = new Intl.Segmenter("en", { granularity: "grapheme" });
return Array.from(
segmenter.segment(text),
(segment) => segment.segment,
);
}
return Array.from(text);
};
const elements = useMemo(() => {
const currentText: string = texts[currentTextIndex];
if (splitBy === "characters") {
const words = currentText.split(" ");
return words.map((word, i) => ({
characters: splitIntoCharacters(word),
needsSpace: i !== words.length - 1,
}));
}
if (splitBy === "words") {
return currentText.split(" ").map((word, i, arr) => ({
characters: [word],
needsSpace: i !== arr.length - 1,
}));
}
if (splitBy === "lines") {
return currentText.split("\n").map((line, i, arr) => ({
characters: [line],
needsSpace: i !== arr.length - 1,
}));
}
return currentText.split(splitBy).map((part, i, arr) => ({
characters: [part],
needsSpace: i !== arr.length - 1,
}));
}, [texts, currentTextIndex, splitBy]);
const getStaggerDelay = useCallback(
(index: number, totalChars: number): number => {
const total = totalChars;
if (staggerFrom === "first") return index * staggerDuration;
if (staggerFrom === "last")
return (total - 1 - index) * staggerDuration;
if (staggerFrom === "center") {
const center = Math.floor(total / 2);
return Math.abs(center - index) * staggerDuration;
}
if (staggerFrom === "random") {
const randomIndex = Math.floor(Math.random() * total);
return Math.abs(randomIndex - index) * staggerDuration;
}
return Math.abs((staggerFrom as number) - index) * staggerDuration;
},
[staggerFrom, staggerDuration],
);
const handleIndexChange = useCallback(
(newIndex: number) => {
setCurrentTextIndex(newIndex);
if (onNext) onNext(newIndex);
},
[onNext],
);
const next = useCallback(() => {
const nextIndex =
currentTextIndex === texts.length - 1
? loop
? 0
: currentTextIndex
: currentTextIndex + 1;
if (nextIndex !== currentTextIndex) {
handleIndexChange(nextIndex);
}
}, [currentTextIndex, texts.length, loop, handleIndexChange]);
const previous = useCallback(() => {
const prevIndex =
currentTextIndex === 0
? loop
? texts.length - 1
: currentTextIndex
: currentTextIndex - 1;
if (prevIndex !== currentTextIndex) {
handleIndexChange(prevIndex);
}
}, [currentTextIndex, texts.length, loop, handleIndexChange]);
const jumpTo = useCallback(
(index: number) => {
const validIndex = Math.max(0, Math.min(index, texts.length - 1));
if (validIndex !== currentTextIndex) {
handleIndexChange(validIndex);
}
},
[texts.length, currentTextIndex, handleIndexChange],
);
const reset = useCallback(() => {
if (currentTextIndex !== 0) {
handleIndexChange(0);
}
}, [currentTextIndex, handleIndexChange]);
useImperativeHandle(
ref,
() => ({
next,
previous,
jumpTo,
reset,
}),
[next, previous, jumpTo, reset],
);
useEffect(() => {
if (!auto) return;
const intervalId = setInterval(next, rotationInterval);
return () => clearInterval(intervalId);
}, [next, rotationInterval, auto]);
return (
<motion.span
className={cn(
"relative flex flex-wrap whitespace-pre-wrap",
mainClassName,
)}
{...rest}
layout
transition={transition}
>
<span className="sr-only">{texts[currentTextIndex]}</span>
<AnimatePresence
mode={animatePresenceMode}
initial={animatePresenceInitial}
>
<motion.div
key={currentTextIndex}
className={cn(
splitBy === "lines"
? "flex w-full flex-col"
: "relative flex flex-wrap whitespace-pre-wrap",
)}
layout
aria-hidden="true"
>
{elements.map((wordObj, wordIndex, array) => {
const previousCharsCount = array
.slice(0, wordIndex)
.reduce((sum, word) => sum + word.characters.length, 0);
return (
<span
key={wordIndex}
className={cn("inline-flex", splitLevelClassName)}
>
{wordObj.characters.map((char, charIndex) => (
<motion.span
key={charIndex}
initial={initial}
animate={animate}
exit={exit}
transition={{
...transition,
delay: getStaggerDelay(
previousCharsCount + charIndex,
array.reduce(
(sum, word) => sum + word.characters.length,
0,
),
),
}}
className={cn("inline-block", elementLevelClassName)}
>
{char}
</motion.span>
))}
{wordObj.needsSpace && (
<span className="whitespace-pre"> </span>
)}
</span>
);
})}
</motion.div>
</AnimatePresence>
</motion.span>
);
},
);
RotatingText.displayName = "RotatingText";
+27
View File
@@ -0,0 +1,27 @@
"use client";
import { RotatingText } from "@/components/reactbits/rotating-text";
const supports = [
"Next.js",
"Node.js",
"Hono",
"Express.js",
"Deno",
"Nest.js",
"Waku",
];
export const Supports = () => {
return (
<RotatingText
texts={supports}
mainClassName="inline-flex bg-transparent overflow-hidden justify-center"
initial={{ y: "100%" }}
animate={{ y: 0 }}
exit={{ y: "-120%" }}
staggerDuration={0.025}
transition={{ type: "spring", damping: 30, stiffness: 400 }}
rotationInterval={2000}
/>
);
};
-28
View File
@@ -1,28 +0,0 @@
"use client";
import { useEffect, useState } from "react";
import ReactTextTransition from "react-text-transition";
const supports = [
"Next.js",
"Node.js",
"Hono",
"Express.js",
"Deno",
"Nest.js",
"Waku",
];
export const TextEffect = () => {
const [counter, setCounter] = useState(0);
useEffect(() => {
const id = setInterval(() => {
setCounter(
(Math.floor(Math.random() * supports.length) + 1) % supports.length,
);
}, 4000);
return () => {
clearInterval(id);
};
}, []);
return <ReactTextTransition inline>{supports[counter]}</ReactTextTransition>;
};
+4 -4
View File
@@ -21,7 +21,7 @@ const DialogOverlay = React.forwardRef<
<DialogPrimitive.Overlay <DialogPrimitive.Overlay
ref={ref} ref={ref}
className={cn( className={cn(
"fixed inset-0 z-50 bg-black/80 data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0", "data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 fixed inset-0 z-50 bg-black/80",
className, className,
)} )}
{...props} {...props}
@@ -38,13 +38,13 @@ const DialogContent = React.forwardRef<
<DialogPrimitive.Content <DialogPrimitive.Content
ref={ref} ref={ref}
className={cn( className={cn(
"fixed left-[50%] top-[50%] z-50 grid w-full max-w-lg translate-x-[-50%] translate-y-[-50%] gap-4 border bg-background p-6 shadow-lg duration-200 data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 data-[state=closed]:slide-out-to-left-1/2 data-[state=closed]:slide-out-to-top-[48%] data-[state=open]:slide-in-from-left-1/2 data-[state=open]:slide-in-from-top-[48%] sm:rounded-lg", "bg-background data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 data-[state=closed]:slide-out-to-left-1/2 data-[state=closed]:slide-out-to-top-[48%] data-[state=open]:slide-in-from-left-1/2 data-[state=open]:slide-in-from-top-[48%] fixed left-[50%] top-[50%] z-50 grid w-full max-w-lg translate-x-[-50%] translate-y-[-50%] gap-4 border p-6 shadow-lg duration-200 sm:rounded-lg",
className, className,
)} )}
{...props} {...props}
> >
{children} {children}
<DialogPrimitive.Close className="absolute right-4 top-4 rounded-sm opacity-70 ring-offset-background transition-opacity hover:opacity-100 focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2 disabled:pointer-events-none data-[state=open]:bg-accent data-[state=open]:text-muted-foreground"> <DialogPrimitive.Close className="ring-offset-background focus:ring-ring data-[state=open]:bg-accent data-[state=open]:text-muted-foreground absolute right-4 top-4 rounded-sm opacity-70 transition-opacity hover:opacity-100 focus:outline-none focus:ring-2 focus:ring-offset-2 disabled:pointer-events-none">
<Cross2Icon className="h-4 w-4" /> <Cross2Icon className="h-4 w-4" />
<span className="sr-only">Close</span> <span className="sr-only">Close</span>
</DialogPrimitive.Close> </DialogPrimitive.Close>
@@ -102,7 +102,7 @@ const DialogDescription = React.forwardRef<
>(({ className, ...props }, ref) => ( >(({ className, ...props }, ref) => (
<DialogPrimitive.Description <DialogPrimitive.Description
ref={ref} ref={ref}
className={cn("text-sm text-muted-foreground", className)} className={cn("text-muted-foreground text-sm", className)}
{...props} {...props}
/> />
)); ));
+1 -1
View File
@@ -10,7 +10,7 @@ const Input = React.forwardRef<HTMLInputElement, InputProps>(
<input <input
type={type} type={type}
className={cn( className={cn(
"flex h-9 w-full rounded-md border border-input bg-transparent px-3 py-1 text-sm shadow-sm transition-colors file:border-0 file:bg-transparent file:text-sm file:font-medium file:text-foreground placeholder:text-muted-foreground focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring disabled:cursor-not-allowed disabled:opacity-50", "border-input file:text-foreground placeholder:text-muted-foreground focus-visible:ring-ring flex h-9 w-full rounded-md border bg-transparent px-3 py-1 text-sm shadow-sm transition-colors file:border-0 file:bg-transparent file:text-sm file:font-medium focus-visible:outline-none focus-visible:ring-1 disabled:cursor-not-allowed disabled:opacity-50",
className, className,
)} )}
ref={ref} ref={ref}
+1 -1
View File
@@ -6,7 +6,7 @@ function Skeleton({
}: React.HTMLAttributes<HTMLDivElement>) { }: React.HTMLAttributes<HTMLDivElement>) {
return ( return (
<div <div
className={cn("animate-pulse rounded-md bg-primary/10", className)} className={cn("bg-primary/10 animate-pulse rounded-md", className)}
{...props} {...props}
/> />
); );
+3 -3
View File
@@ -17,10 +17,10 @@ const Slider = React.forwardRef<
)} )}
{...props} {...props}
> >
<SliderPrimitive.Track className="relative h-1.5 w-full grow overflow-hidden rounded-full bg-primary/20"> <SliderPrimitive.Track className="bg-primary/20 relative h-1.5 w-full grow overflow-hidden rounded-full">
<SliderPrimitive.Range className="absolute h-full bg-primary" /> <SliderPrimitive.Range className="bg-primary absolute h-full" />
</SliderPrimitive.Track> </SliderPrimitive.Track>
<SliderPrimitive.Thumb className="block h-4 w-4 rounded-full border border-primary/50 bg-background shadow transition-colors focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring disabled:pointer-events-none disabled:opacity-50" /> <SliderPrimitive.Thumb className="border-primary/50 bg-background focus-visible:ring-ring block h-4 w-4 rounded-full border shadow transition-colors focus-visible:outline-none focus-visible:ring-1 disabled:pointer-events-none disabled:opacity-50" />
</SliderPrimitive.Root> </SliderPrimitive.Root>
)); ));
Slider.displayName = SliderPrimitive.Root.displayName; Slider.displayName = SliderPrimitive.Root.displayName;
+1 -1
View File
@@ -9,7 +9,7 @@ const Textarea = React.forwardRef<HTMLTextAreaElement, TextareaProps>(
return ( return (
<textarea <textarea
className={cn( className={cn(
"flex min-h-[60px] w-full rounded-md border border-input bg-transparent px-3 py-2 text-sm shadow-sm placeholder:text-muted-foreground focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring disabled:cursor-not-allowed disabled:opacity-50", "border-input placeholder:text-muted-foreground focus-visible:ring-ring flex min-h-[60px] w-full rounded-md border bg-transparent px-3 py-2 text-sm shadow-sm focus-visible:outline-none focus-visible:ring-1 disabled:cursor-not-allowed disabled:opacity-50",
className, className,
)} )}
ref={ref} ref={ref}
+1 -1
View File
@@ -20,7 +20,7 @@ const TooltipContent = React.forwardRef<
ref={ref} ref={ref}
sideOffset={sideOffset} sideOffset={sideOffset}
className={cn( className={cn(
"z-50 overflow-hidden rounded-md bg-primary px-3 py-1.5 text-xs text-primary-foreground animate-in fade-in-0 zoom-in-95 data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=closed]:zoom-out-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2", "bg-primary text-primary-foreground animate-in fade-in-0 zoom-in-95 data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=closed]:zoom-out-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 z-50 overflow-hidden rounded-md px-3 py-1.5 text-xs",
className, className,
)} )}
{...props} {...props}
+1 -1
View File
@@ -2,5 +2,5 @@
"title": "LlamaCloud", "title": "LlamaCloud",
"description": "The Cloud framework for LLM", "description": "The Cloud framework for LLM",
"root": true, "root": true,
"pages": ["---Guide---", "index", "api"] "pages": ["---Guide---", "index", "..."]
} }
@@ -5,4 +5,24 @@ title: Gemini Agent
import { DynamicCodeBlock } from 'fumadocs-ui/components/dynamic-codeblock'; import { DynamicCodeBlock } from 'fumadocs-ui/components/dynamic-codeblock';
import CodeSourceGemini from "!raw-loader!../../../../../../../examples/gemini/agent.ts"; import CodeSourceGemini from "!raw-loader!../../../../../../../examples/gemini/agent.ts";
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/google
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/google
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/google
```
</Tabs>
## Source
<DynamicCodeBlock lang="ts" code={CodeSourceGemini} /> <DynamicCodeBlock lang="ts" code={CodeSourceGemini} />
@@ -12,9 +12,8 @@ Here's a simple example of how to use the Context-Aware Agent:
import { import {
Document, Document,
VectorStoreIndex, VectorStoreIndex,
OpenAIContextAwareAgent,
OpenAI,
} from "llamaindex"; } from "llamaindex";
import { OpenAI, OpenAIContextAwareAgent } from "@llamaindex/openai";
async function createContextAwareAgent() { async function createContextAwareAgent() {
// Create and index some documents // Create and index some documents
@@ -58,4 +57,3 @@ In this example, the Context-Aware Agent uses the retriever to fetch relevant co
## Available Context-Aware Agents ## Available Context-Aware Agents
- `OpenAIContextAwareAgent`: A context-aware agent using OpenAI's models. - `OpenAIContextAwareAgent`: A context-aware agent using OpenAI's models.
- `AnthropicContextAwareAgent`: A context-aware agent using Anthropic's models.
@@ -2,6 +2,8 @@
title: Local LLMs title: Local LLMs
--- ---
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
LlamaIndex.TS supports OpenAI and [other remote LLM APIs](other_llms). You can also run a local LLM on your machine! LlamaIndex.TS supports OpenAI and [other remote LLM APIs](other_llms). You can also run a local LLM on your machine!
## Using a local model via Ollama ## Using a local model via Ollama
@@ -24,7 +26,23 @@ The first time you run it will also automatically download and install the model
### Switch the LLM in your code ### Switch the LLM in your code
To tell LlamaIndex to use a local LLM, use the `Settings` object: To switch the LLM in your code, you first need to make sure to install the package for the Ollama model provider:
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install @llamaindex/ollama
```
```shell tab="yarn"
yarn add @llamaindex/ollama
```
```shell tab="pnpm"
pnpm add @llamaindex/ollama
```
</Tabs>
Then, to tell LlamaIndex to use a local LLM, use the `Settings` object:
```javascript ```javascript
Settings.llm = new Ollama({ Settings.llm = new Ollama({
@@ -34,7 +52,25 @@ Settings.llm = new Ollama({
### Use local embeddings ### Use local embeddings
If you're doing retrieval-augmented generation, LlamaIndex.TS will also call out to OpenAI to index and embed your data. To be entirely local, you can use a local embedding model like this: If you're doing retrieval-augmented generation, LlamaIndex.TS will also call out to OpenAI to index and embed your data. To be entirely local, you can use a local embedding model from Huggingface like this:
First install the Huggingface model provider package:
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install @llamaindex/huggingface
```
```shell tab="yarn"
yarn add @llamaindex/huggingface
```
```shell tab="pnpm"
pnpm add @llamaindex/huggingface
```
</Tabs>
And then set the embedding model in your code:
```javascript ```javascript
Settings.embedModel = new HuggingFaceEmbedding({ Settings.embedModel = new HuggingFaceEmbedding({
@@ -7,14 +7,36 @@ import CodeSource from "!raw-loader!../../../../../../../examples/mistral";
By default LlamaIndex.TS uses OpenAI's LLMs and embedding models, but we support [lots of other LLMs](../modules/llms) including models from Mistral (Mistral, Mixtral), Anthropic (Claude) and Google (Gemini). By default LlamaIndex.TS uses OpenAI's LLMs and embedding models, but we support [lots of other LLMs](../modules/llms) including models from Mistral (Mistral, Mixtral), Anthropic (Claude) and Google (Gemini).
If you don't want to use an API at all you can [run a local model](../../examples/local_llm) If you don't want to use an API at all you can [run a local model](./local_llm).
This example runs you through the process of setting up a Mistral model:
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/mistral
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/mistral
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/mistral
```
</Tabs>
## Using another LLM ## Using another LLM
You can specify what LLM LlamaIndex.TS will use on the `Settings` object, like this: You can specify what LLM LlamaIndex.TS will use on the `Settings` object, like this:
```typescript ```typescript
import { MistralAI, Settings } from "llamaindex"; import { MistralAI } from "@llamaindex/mistral";
import { Settings } from "llamaindex";
Settings.llm = new MistralAI({ Settings.llm = new MistralAI({
model: "mistral-tiny", model: "mistral-tiny",
@@ -29,7 +51,8 @@ You can see examples of other APIs we support by checking out "Available LLMs" i
A frequent gotcha when trying to use a different API as your LLM is that LlamaIndex will also by default index and embed your data using OpenAI's embeddings. To completely switch away from OpenAI you will need to set your embedding model as well, for example: A frequent gotcha when trying to use a different API as your LLM is that LlamaIndex will also by default index and embed your data using OpenAI's embeddings. To completely switch away from OpenAI you will need to set your embedding model as well, for example:
```typescript ```typescript
import { MistralAIEmbedding, Settings } from "llamaindex"; import { MistralAIEmbedding } from "@llamaindex/mistral";
import { Settings } from "llamaindex";
Settings.embedModel = new MistralAIEmbedding(); Settings.embedModel = new MistralAIEmbedding();
``` ```
@@ -1,10 +1,12 @@
--- ---
title: Installation title: Installation
description: Install llamaindex by running a single command. description: How to install llamaindex packages.
--- ---
import { Tab, Tabs } from "fumadocs-ui/components/tabs"; import { Tab, Tabs } from "fumadocs-ui/components/tabs";
To install llamaindex, run the following command:
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist> <Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm" ```shell tab="npm"
npm install llamaindex npm install llamaindex
@@ -19,6 +21,25 @@ import { Tab, Tabs } from "fumadocs-ui/components/tabs";
``` ```
</Tabs> </Tabs>
In most cases, you'll also need an LLM package to use LlamaIndex. For example, to use the OpenAI LLM, you would install the following:
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install @llamaindex/openai
```
```shell tab="yarn"
yarn add @llamaindex/openai
```
```shell tab="pnpm"
pnpm add @llamaindex/openai
```
</Tabs>
Go to [Using other LLM APIs](/docs/llamaindex/examples/other_llms) to find out how to use other LLMs.
## What's next? ## What's next?
<Cards> <Cards>
@@ -70,10 +70,8 @@ In Cloudflare Worker and similar serverless JS environment, you need to be aware
- Some Node.js modules are not available in Cloudflare Worker, such as `node:fs`, `node:child_process`, `node:cluster`... - Some Node.js modules are not available in Cloudflare Worker, such as `node:fs`, `node:child_process`, `node:cluster`...
- You are recommend to design your code using network request, such as use `fetch` API to communicate with database, insteadof a long-running process in Node.js. - You are recommend to design your code using network request, such as use `fetch` API to communicate with database, insteadof a long-running process in Node.js.
- Some of LlamaIndex.TS modules are not available in Cloudflare Worker, for example `SimpleDirectoryReader` (requires `node:fs`), Some multimodal API that relies on [`onnxruntime-node`](https://www.npmjs.com/package/onnxruntime-node)(we might port to HTTP based module in the future). - Some of LlamaIndex.TS packages are not available in Cloudflare Worker, for example `@llamaindex/readers` and `@llamaindex/huggingface`.
- `@llamaindex/core` is designed to work in all JavaScript environment, including Cloudflare Worker. If you find any issue, please report to us. - The main `llamaindex` is designed to work in all JavaScript environment, including Cloudflare Worker. If you find any issue, please report to us.
- `@llamaindex/env` is a JS environment binding module, which polyfill some Node.js/Modern Web API (for example, we have a memory based `fs` module, and Crypto API polyfill). It is designed to work in all JavaScript environment, including Cloudflare Worker. - `@llamaindex/env` is a JS environment binding module, which polyfill some Node.js/Modern Web API (for example, we have a memory based `fs` module, and Crypto API polyfill). It is designed to work in all JavaScript environment, including Cloudflare Worker.
## Known issues
- `llamaindex` not work perfectly in Cloudflare Worker, bundle size will be larger than 1MB, which is the limit of Cloudflare Worker. You will need import submodule instead of the whole `llamaindex` module.
@@ -3,6 +3,8 @@ title: With Node.js/Bun/Deno
description: In this guide, you'll learn how to use LlamaIndex with Node.js, Bun, and Deno. description: In this guide, you'll learn how to use LlamaIndex with Node.js, Bun, and Deno.
--- ---
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
## Adding environment variables ## Adding environment variables
By default, LlamaIndex uses OpenAI provider, which requires an API key. You can set the `OPENAI_API_KEY` environment variable to authenticate with OpenAI. By default, LlamaIndex uses OpenAI provider, which requires an API key. You can set the `OPENAI_API_KEY` environment variable to authenticate with OpenAI.
@@ -22,6 +24,26 @@ node --env-file .env your-script.js
For more information, see the [How to read environment variables from Node.js](https://nodejs.org/en/learn/command-line/how-to-read-environment-variables-from-nodejs). For more information, see the [How to read environment variables from Node.js](https://nodejs.org/en/learn/command-line/how-to-read-environment-variables-from-nodejs).
## Performance Optimization
By the default, we are using `js-tiktoken` for tokenization. You can install `gpt-tokenizer` which is then automatically used by LlamaIndex to get a 60x speedup for tokenization:
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install gpt-tokenizer
```
```shell tab="yarn"
yarn add gpt-tokenizer
```
```shell tab="pnpm"
pnpm add gpt-tokenizer
```
</Tabs>
> Note: This only works for Node.js
## TypeScript support ## TypeScript support
<Card <Card
@@ -9,7 +9,7 @@ LlamaIndex.TS is written in TypeScript and designed to be used in TypeScript pro
We do lots of work on strong typing to make sure you have a great typing experience with LlamaIndex.TS. We do lots of work on strong typing to make sure you have a great typing experience with LlamaIndex.TS.
```ts twoslash ```ts twoslash
import { PromptTemplate } from '@llamaindex/core/prompts' import { PromptTemplate } from 'llamaindex'
const promptTemplate = new PromptTemplate({ const promptTemplate = new PromptTemplate({
template: `Context information from multiple sources is below. template: `Context information from multiple sources is below.
--------------------- ---------------------
@@ -29,7 +29,7 @@ promptTemplate.format({
``` ```
```ts twoslash ```ts twoslash
import { FunctionTool } from '@llamaindex/core/tools' import { FunctionTool } from 'llamaindex'
import { z } from 'zod' import { z } from 'zod'
// ---cut-before--- // ---cut-before---
@@ -106,21 +106,38 @@ Some modules uses `Web Stream` API like `ReadableStream` and `WritableStream`, y
} }
``` ```
```ts twoslash ```typescript
import { OpenAIAgent } from '@llamaindex/openai' import { agent, tool } from 'llamaindex'
import { openai } from "@llamaindex/openai";
const agent = new OpenAIAgent({ Settings.llm = openai({
tools: [] model: "gpt-4o-mini",
}) });
const response = await agent.chat({ const addTool = tool({
message: 'Hello, how are you?', name: "add",
stream: true description: "Adds two numbers",
}) parameters: z.object({x: z.number(), y: z.number()}),
for await (const _ of response) { execute: ({ x, y }) => x + y,
//^? });
// ...
const myAgent = agent({
tools: [addTool],
});
// Chat with the agent
const context = myAgent.run("Hello, how are you?");
for await (const event of context) {
if (event instanceof AgentStream) {
for (const chunk of event.data.delta) {
process.stdout.write(chunk); // stream response
}
} else {
console.log(event); // other events
}
} }
``` ```
## Run TypeScript Script in Node.js ## Run TypeScript Script in Node.js
@@ -15,7 +15,7 @@ In LlamaIndex, an agent is a semi-autonomous piece of software powered by an LLM
You'll need to have a recent version of [Node.js](https://nodejs.org/en) installed. Then you can install LlamaIndex.TS by running You'll need to have a recent version of [Node.js](https://nodejs.org/en) installed. Then you can install LlamaIndex.TS by running
```bash ```bash
npm install llamaindex npm install llamaindex @llamaindex/openai @llamaindex/readers @llamaindex/huggingface
``` ```
## Choose your model ## Choose your model
@@ -25,14 +25,22 @@ npx tsx example.ts
First we'll need to pull in our dependencies. These are: First we'll need to pull in our dependencies. These are:
- The OpenAI class to use the OpenAI LLM - The OpenAI class to use the OpenAI LLM
- FunctionTool to provide tools to our agent - tool to provide tools to our agent
- OpenAIAgent to create the agent itself - agent to create the single agent
- Settings to define some global settings for the library - Settings to define some global settings for the library
- Dotenv to load our API key from the .env file - Dotenv to load our API key from the .env file
- Zod to define the schema for our tool
```javascript ```javascript
import { OpenAI, FunctionTool, OpenAIAgent, Settings } from "llamaindex";
import "dotenv/config"; import "dotenv/config";
import {
agent,
AgentStream,
tool,
openai,
Settings,
} from "llamaindex";
import { z } from "zod";
``` ```
### Initialize your LLM ### Initialize your LLM
@@ -40,25 +48,12 @@ import "dotenv/config";
We need to tell our OpenAI class where its API key is, and which of OpenAI's models to use. We'll be using `gpt-4o`, which is capable while still being pretty cheap. This is a global setting, so anywhere an LLM is needed will use the same model. We need to tell our OpenAI class where its API key is, and which of OpenAI's models to use. We'll be using `gpt-4o`, which is capable while still being pretty cheap. This is a global setting, so anywhere an LLM is needed will use the same model.
```javascript ```javascript
Settings.llm = new OpenAI({ Settings.llm = openai({
apiKey: process.env.OPENAI_API_KEY, apiKey: process.env.OPENAI_API_KEY,
model: "gpt-4o", model: "gpt-4o",
}); });
``` ```
### Turn on logging
We want to see what our agent is up to, so we're going to hook into some events that the library generates and print them out. There are several events possible, but we'll specifically tune in to `llm-tool-call` (when a tool is called) and `llm-tool-result` (when it responds).
```javascript
Settings.callbackManager.on("llm-tool-call", (event) => {
console.log(event.detail);
});
Settings.callbackManager.on("llm-tool-result", (event) => {
console.log(event.detail);
});
```
### Create a function ### Create a function
We're going to create a very simple function that adds two numbers together. This will be the tool we ask our agent to use. We're going to create a very simple function that adds two numbers together. This will be the tool we ask our agent to use.
@@ -73,7 +68,7 @@ Note that we're passing in an object with two named parameters, `a` and `b`. Thi
### Turn the function into a tool for the agent ### Turn the function into a tool for the agent
This is the most complicated part of creating an agent. We need to define a `FunctionTool`. We have to pass in: This is the most complicated part of creating an agent. We need to define a `tool`. We have to pass in:
- The function itself (`sumNumbers`) - The function itself (`sumNumbers`)
- A name for the function, which the LLM will use to call it - A name for the function, which the LLM will use to call it
@@ -82,30 +77,25 @@ This is the most complicated part of creating an agent. We need to define a `Fun
- You can see [more examples of function schemas](https://cookbook.openai.com/examples/how_to_call_functions_with_chat_models). - You can see [more examples of function schemas](https://cookbook.openai.com/examples/how_to_call_functions_with_chat_models).
```javascript ```javascript
const tool = FunctionTool.from(sumNumbers, { const addTool = tool({
name: "sumNumbers", name: "sumNumbers",
description: "Use this function to sum two numbers", description: "Use this function to sum two numbers",
parameters: { parameters: z.object({
type: "object", a: z.number({
properties: { description: "First number to sum",
a: { }),
type: "number", b: z.number({
description: "First number to sum", description: "Second number to sum",
}, }),
b: { }),
type: "number", execute: sumNumbers,
description: "Second number to sum",
},
},
required: ["a", "b"],
},
}); });
``` ```
We then wrap up the tools into an array. We could provide lots of tools this way, but for this example we're just using the one. We then wrap up the tools into an array. We could provide lots of tools this way, but for this example we're just using the one.
```javascript ```javascript
const tools = [tool]; const tools = [addTool];
``` ```
### Create the agent ### Create the agent
@@ -113,7 +103,7 @@ const tools = [tool];
With your LLM already set up and your tools defined, creating an agent is simple: With your LLM already set up and your tools defined, creating an agent is simple:
```javascript ```javascript
const agent = new OpenAIAgent({ tools }); const myAgent = agent({ tools });
``` ```
### Ask the agent a question ### Ask the agent a question
@@ -121,61 +111,109 @@ const agent = new OpenAIAgent({ tools });
We can use the `chat` interface to ask our agent a question, and it will use the tools we've defined to find an answer. We can use the `chat` interface to ask our agent a question, and it will use the tools we've defined to find an answer.
```javascript ```javascript
let response = await agent.chat({ const context = myAgent.run("Sum 101 and 303");
message: "Add 101 and 303", const result = await context;
}); console.log(result.data);
```
You will see the following output:
console.log(response); **_Output_**
```
{ result: 'The sum of 101 and 303 is 404.' }
```
To stream the response, you can use the `AgentStream` event which provides chunks of the response as they become available. This allows you to display the response incrementally rather than waiting for the full response:
```javascript
const context = myAgent.run("Add 101 and 303");
for await (const event of context) {
if (event instanceof AgentStream) {
process.stdout.write(event.data.delta);
}
}
```
**_Streaming Output_**
```
The sum of 101 and 303 is 404.
```
### Logging workflow events
To log the workflow events, you can check the event type and log the event data.
```javascript
const context = myAgent.run("Sum 202 and 404");
for await (const event of context) {
if (event instanceof AgentStream) {
// Stream the response
for (const chunk of event.data.delta) {
process.stdout.write(chunk);
}
} else {
// Log other events
console.log("\nWorkflow event:", JSON.stringify(event, null, 2));
}
}
``` ```
Let's see what running this looks like using `npx tsx agent.ts` Let's see what running this looks like using `npx tsx agent.ts`
**_Output_** **_Output_**
```javascript ```
{ Workflow event: {
toolCall: { "data": {
id: 'call_ze6A8C3mOUBG4zmXO8Z4CPB5', "userInput": "Sum 202 and 404"
name: 'sumNumbers',
input: { a: 101, b: 303 }
}, },
toolResult: { "displayName": "StartEvent"
tool: FunctionTool { _fn: [Function: sumNumbers], _metadata: [Object] },
input: { a: 101, b: 303 },
output: '404',
isError: false
}
} }
Workflow event: {
"data": {
"input": [
{
"role": "user",
"content": "Sum 202 and 404"
}
],
"currentAgentName": "Agent"
},
"displayName": "AgentInput"
}
Workflow event: {
"data": {
"input": [
{
"role": "system",
"content": "You are a helpful assistant. Use the provided tools to answer questions."
},
{
"role": "user",
"content": "Sum 202 and 404"
}
],
"currentAgentName": "Agent"
},
"displayName": "AgentSetup"
}
....
``` ```
```javascript We're seeing several workflow events being logged:
{
response: {
raw: {
id: 'chatcmpl-9KwauZku3QOvH78MNvxJs81mDvQYK',
object: 'chat.completion',
created: 1714778824,
model: 'gpt-4-turbo-2024-04-09',
choices: [Array],
usage: [Object],
system_fingerprint: 'fp_ea6eb70039'
},
message: {
content: 'The sum of 101 and 303 is 404.',
role: 'assistant',
options: {}
}
},
sources: [Getter]
}
```
We're seeing two pieces of output here. The first is our callback firing when the tool is called. You can see in `toolResult` that the LLM has correctly passed `101` and `303` to our `sumNumbers` function, which adds them up and returns `404`. 1. `AgentToolCall` - Shows the agent preparing to call our tool with the numbers 202 and 404
2. `AgentToolCallResult` - Shows the result of calling the tool, which returned "606"
3. `AgentInput` - Shows the original user input
4. `AgentOutput` - Shows the agent's response
The second piece of output is the response from the LLM itself, where the `message.content` key is giving us the answer. Great! We've built an agent that can understand requests and use tools to fulfill them. Next you can:
Great! We've built an agent with tool use! Next you can: - [See the full code](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/agentworkflow/blog-writer.ts)
- [See the full code](https://github.com/run-llama/ts-agents/blob/main/1_agent/agent.ts)
- [Switch to a local LLM](3_local_model) - [Switch to a local LLM](3_local_model)
- Move on to [add Retrieval-Augmented Generation to your agent](4_agentic_rag) - Move on to [add Retrieval-Augmented Generation to your agent](4_agentic_rag)
@@ -23,70 +23,27 @@ The first time you run it will also automatically download and install the model
There are two changes you need to make to the code we already wrote in `1_agent` to get Mixtral 8x7b to work. First, you need to switch to that model. Replace the call to `Settings.llm` with this: There are two changes you need to make to the code we already wrote in `1_agent` to get Mixtral 8x7b to work. First, you need to switch to that model. Replace the call to `Settings.llm` with this:
```javascript ```javascript
Settings.llm = new Ollama({ Settings.llm = ollama({
model: "mixtral:8x7b", model: "mixtral:8x7b",
}); });
``` ```
### Swap to a ReActAgent ### Run local agent
In our original code we used a specific OpenAIAgent, so we'll need to switch to a more generic agent pattern, the ReAct pattern. This is simple: change the `const agent` line in your code to read You can also create local agent by importing `agent` from `llamaindex`.
```javascript ```javascript
const agent = new ReActAgent({ tools }); import { agent } from "llamaindex";
const workflow = agent({
tools: [getWeatherTool],
});
const workflowContext = workflow.run(
"What's the weather like in San Francisco?",
);
``` ```
(You will also need to bring in `Ollama` and `ReActAgent` in your imports)
### Run your totally local agent
Because your embeddings were already local, your agent can now run entirely locally without making any API calls.
```bash
node agent.mjs
```
Note that your model will probably run a lot slower than OpenAI, so be prepared to wait a while!
**_Output_**
```javascript
{
response: {
message: {
role: 'assistant',
content: ' Thought: I need to use a tool to add the numbers 101 and 303.\n' +
'Action: sumNumbers\n' +
'Action Input: {"a": 101, "b": 303}\n' +
'\n' +
'Observation: 404\n' +
'\n' +
'Thought: I can answer without using any more tools.\n' +
'Answer: The sum of 101 and 303 is 404.'
},
raw: {
model: 'mixtral:8x7b',
created_at: '2024-05-09T00:24:30.339473Z',
message: [Object],
done: true,
total_duration: 64678371209,
load_duration: 57394551334,
prompt_eval_count: 475,
prompt_eval_duration: 4163981000,
eval_count: 94,
eval_duration: 3116692000
}
},
sources: [Getter]
}
```
Tada! You can see all of this in the folder `1a_mixtral`.
### Extending to other examples
You can use a ReActAgent instead of an OpenAIAgent in any of the further examples below, but keep in mind that GPT-4 is a lot more capable than Mixtral 8x7b, so you may see more errors or failures in reasoning if you are using an entirely local setup.
### Next steps ### Next steps
Now you've got a local agent, you can [add Retrieval-Augmented Generation to your agent](4_agentic_rag). Now you've got a local agent, you can [add Retrieval-Augmented Generation to your agent](4_agentic_rag).
@@ -13,22 +13,34 @@ To learn more about RAG, we recommend this [introduction](https://docs.llamainde
We're going to start with the same agent we [built in step 1](https://github.com/run-llama/ts-agents/blob/main/1_agent/agent.ts), but make a few changes. You can find the finished version [in the repository](https://github.com/run-llama/ts-agents/blob/main/2_agentic_rag/agent.ts). We're going to start with the same agent we [built in step 1](https://github.com/run-llama/ts-agents/blob/main/1_agent/agent.ts), but make a few changes. You can find the finished version [in the repository](https://github.com/run-llama/ts-agents/blob/main/2_agentic_rag/agent.ts).
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/openai @llamaindex/huggingface
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/openai @llamaindex/huggingface
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/openai @llamaindex/huggingface
```
</Tabs>
### New dependencies ### New dependencies
We'll be bringing in `SimpleDirectoryReader`, `HuggingFaceEmbedding`, `VectorStoreIndex`, and `QueryEngineTool`, `OpenAIContextAwareAgent` from LlamaIndex.TS, as well as the dependencies we previously used. We'll be bringing in `SimpleDirectoryReader`, `HuggingFaceEmbedding`, `VectorStoreIndex`, and `QueryEngineTool`, `OpenAIContextAwareAgent` from LlamaIndex.TS, as well as the dependencies we previously used.
```javascript ```javascript
import { import { QueryEngineTool, Settings, VectorStoreIndex } from "llamaindex";
OpenAI, import { OpenAI, OpenAIAgent } from "@llamaindex/openai";
FunctionTool, import { HuggingFaceEmbedding } from "@llamaindex/huggingface";
OpenAIAgent, import { SimpleDirectoryReader } from "@llamaindex/readers/directory";
OpenAIContextAwareAgent,
Settings,
SimpleDirectoryReader,
HuggingFaceEmbedding,
VectorStoreIndex,
QueryEngineTool,
} from "llamaindex";
``` ```
### Add an embedding model ### Add an embedding model
@@ -103,10 +115,8 @@ The total budget for the City and County of San Francisco for the fiscal year 20
If you prefer more flexibility and don't mind additional complexity, you can create a `QueryEngineTool`. This approach allows you to define the query logic, providing a more tailored way to interact with the data, but note that it introduces a delay due to the extra tool call. If you prefer more flexibility and don't mind additional complexity, you can create a `QueryEngineTool`. This approach allows you to define the query logic, providing a more tailored way to interact with the data, but note that it introduces a delay due to the extra tool call.
```javascript ```javascript
const queryEngine = await index.asQueryEngine({ retriever });
const tools = [ const tools = [
new QueryEngineTool({ index.queryTool({
queryEngine: queryEngine,
metadata: { metadata: {
name: "san_francisco_budget_tool", name: "san_francisco_budget_tool",
description: `This tool can answer detailed questions about the individual components of the budget of San Francisco in 2023-2024.`, description: `This tool can answer detailed questions about the individual components of the budget of San Francisco in 2023-2024.`,
@@ -115,11 +125,9 @@ const tools = [
]; ];
// Create an agent using the tools array // Create an agent using the tools array
const agent = new OpenAIAgent({ tools }); const myAgent = agent({ tools });
let toolResponse = await agent.chat({ let toolResponse = await myAgent.run("What's the budget of San Francisco in 2023-2024?");
message: "What's the budget of San Francisco in 2023-2024?",
});
console.log(toolResponse); console.log(toolResponse);
``` ```
@@ -2,58 +2,67 @@
title: A RAG agent that does math title: A RAG agent that does math
--- ---
In [our third iteration of the agent](https://github.com/run-llama/ts-agents/blob/main/3_rag_and_tools/agent.ts) we've combined the two previous agents, so we've defined both `sumNumbers` and a `QueryEngineTool` and created an array of two tools: In [our third iteration of the agent](https://github.com/run-llama/ts-agents/blob/main/3_rag_and_tools/agent.ts) we've combined the two previous agents, so we've defined both `sumNumbers` and a `QueryEngineTool` and created an array of two tools. The tools support both Zod and JSON Schema for parameter definition:
```javascript ```javascript
// define the query engine as a tool // define the query engine as a tool
const tools = [ const tools = [
new QueryEngineTool({ index.queryTool({
queryEngine: queryEngine,
metadata: { metadata: {
name: "san_francisco_budget_tool", name: "san_francisco_budget_tool",
description: `This tool can answer detailed questions about the individual components of the budget of San Francisco in 2023-2024.`, description: `This tool can answer detailed questions about the individual components of the budget of San Francisco in 2023-2024.`,
}, },
}), }),
FunctionTool.from(sumNumbers, { tool({
name: "sumNumbers", name: "sumNumbers",
description: "Use this function to sum two numbers", description: "Use this function to sum two numbers",
parameters: { parameters: z.object({
type: "object", a: z.number({
properties: { description: "First number to sum",
a: { }),
type: "number", b: z.number({
description: "First number to sum", description: "Second number to sum",
}, }),
b: { }),
type: "number", execute: ({ a, b }) => `${a + b}`,
description: "Second number to sum",
},
},
required: ["a", "b"],
},
}), }),
]; ];
``` ```
You can also use JSON Schema to define the tool parameters as an alternative to Zod.
```javascript
tool(sumNumbers, {
name: "sumNumbers",
description: "Use this function to sum two numbers",
parameters: {
type: "object",
properties: {
a: {
type: "number",
description: "First number to sum",
},
b: {
type: "number",
description: "Second number to sum",
},
},
required: ["a", "b"],
},
}),
```
These tool descriptions are identical to the ones we previously defined. Now let's ask it 3 questions in a row: These tool descriptions are identical to the ones we previously defined. Now let's ask it 3 questions in a row:
```javascript ```javascript
let response = await agent.chat({ let response = await agent.run("What's the budget of San Francisco for community health in 2023-24?");
message:
"What's the budget of San Francisco for community health in 2023-24?",
});
console.log(response); console.log(response);
let response2 = await agent.chat({ let response2 = await agent.run("What's the budget of San Francisco for public protection in 2023-24?");
message:
"What's the budget of San Francisco for public protection in 2023-24?",
});
console.log(response2); console.log(response2);
let response3 = await agent.chat({ let response3 = await agent.run("What's the combined budget of San Francisco for community health and public protection in 2023-24?");
message:
"What's the combined budget of San Francisco for community health and public protection in 2023-24?",
});
console.log(response3); console.log(response3);
``` ```
@@ -3,8 +3,6 @@ title: Using API Route
description: Chat interface for your LlamaIndexTS application using API Route description: Chat interface for your LlamaIndexTS application using API Route
--- ---
import { ChatDemo } from '../../../../../components/demo/chat/api/demo'; import { ChatDemo } from '../../../../../components/demo/chat/api/demo';
import "@llamaindex/chat-ui/styles/code.css";
import "@llamaindex/chat-ui/styles/katex.css";
Using [chat-ui](https://github.com/run-llama/chat-ui), it's easy to add a chat interface to your LlamaIndexTS application. Using [chat-ui](https://github.com/run-llama/chat-ui), it's easy to add a chat interface to your LlamaIndexTS application.
You just need to create an API route that provides an `api/chat` endpoint and a chat component to consume the API. You just need to create an API route that provides an `api/chat` endpoint and a chat component to consume the API.
@@ -0,0 +1,22 @@
---
title: Install @llamaindex/chat
description: Chat interface for your LlamaIndexTS application
---
## Quick Start
You can quickly add a chatbot to your project by using Shadcn CLI command:
```sh
npx shadcn@latest add https://ui.llamaindex.ai/r/chat.json
```
## Manual Installation
To install the package, run the following command in your project directory:
```sh
npm install @llamaindex/chat-ui
```
For more information, check out the [github.comrun-llama/chat-ui](https://github.com/run-llama/chat-ui)
@@ -1,6 +1,6 @@
{ {
"title": "Chat-UI", "title": "Chat UI",
"description": "Use chat-ui to add a chat interface to your LlamaIndexTS application.", "description": "Use chat-ui to add a chat interface to your LlamaIndexTS application.",
"defaultOpen": false, "defaultOpen": false,
"pages": ["chat", "rsc"] "pages": ["install", "chat", "rsc"]
} }
@@ -3,8 +3,6 @@ title: Using Next.js RSC
description: Chat interface for your LlamaIndexTS application using Next.js RSC description: Chat interface for your LlamaIndexTS application using Next.js RSC
--- ---
import { ChatDemoRSC } from '../../../../../components/demo/chat/rsc/demo'; import { ChatDemoRSC } from '../../../../../components/demo/chat/rsc/demo';
import "@llamaindex/chat-ui/styles/code.css";
import "@llamaindex/chat-ui/styles/katex.css";
Using [chat-ui](https://github.com/run-llama/chat-ui), it's easy to add a chat interface to your LlamaIndexTS application using [Next.js RSC](https://nextjs.org/docs/app/building-your-application/rendering/server-components) and [Vercel AI RSC](https://sdk.vercel.ai/docs/ai-sdk-rsc/overview). Using [chat-ui](https://github.com/run-llama/chat-ui), it's easy to add a chat interface to your LlamaIndexTS application using [Next.js RSC](https://nextjs.org/docs/app/building-your-application/rendering/server-components) and [Vercel AI RSC](https://sdk.vercel.ai/docs/ai-sdk-rsc/overview).
@@ -10,7 +10,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion';
<Accordions> <Accordions>
<Accordion title="Install @llamaindex/readers"> <Accordion title="Install @llamaindex/readers">
If you want to only use reader modules, you can install `@llamaindex/readers` If you want to use the reader module, you need to install `@llamaindex/readers`
<Tabs groupId="install-llamaindex" items={["npm", "yarn", "pnpm"]} persist> <Tabs groupId="install-llamaindex" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm" ```shell tab="npm"
@@ -31,72 +31,73 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion';
We offer readers for different file formats. We offer readers for different file formats.
<Tabs groupId="llamaindex-or-readers" items={["llamaindex", "@llamaindex/readers"]} persist> ```ts twoslash
```ts twoslash tab="llamaindex" import { CSVReader } from '@llamaindex/readers/csv'
import { CSVReader } from 'llamaindex' import { PDFReader } from '@llamaindex/readers/pdf'
import { PDFReader } from 'llamaindex' import { JSONReader } from '@llamaindex/readers/json'
import { JSONReader } from 'llamaindex' import { MarkdownReader } from '@llamaindex/readers/markdown'
import { MarkdownReader } from 'llamaindex' import { HTMLReader } from '@llamaindex/readers/html'
import { HTMLReader } from 'llamaindex' // you can find more readers in the documentation
// you can find more readers in the documentation ```
```
```ts twoslash tab="@llamaindex/readers"
import { CSVReader } from '@llamaindex/readers/csv'
import { PDFReader } from '@llamaindex/readers/pdf'
import { JSONReader } from '@llamaindex/readers/json'
import { MarkdownReader } from '@llamaindex/readers/markdown'
import { HTMLReader } from '@llamaindex/readers/html'
// you can find more readers in the documentation
```
</Tabs>
## SimpleDirectoryReader ## SimpleDirectoryReader
`SimpleDirectoryReader` is the simplest way to load data from local files into LlamaIndex. `SimpleDirectoryReader` is the simplest way to load data from local files into LlamaIndex.
<Tabs groupId="llamaindex-or-readers" items={["llamaindex", "@llamaindex/readers"]} persist> ```ts twoslash
import { SimpleDirectoryReader } from "@llamaindex/readers/directory";
```ts twoslash tab="llamaindex" const reader = new SimpleDirectoryReader()
import { SimpleDirectoryReader } from "llamaindex"; const documents = await reader.loadData("./data")
// ^?
const reader = new SimpleDirectoryReader()
const documents = await reader.loadData("./data")
// ^?
const texts = documents.map(doc => doc.getText()) const texts = documents.map(doc => doc.getText())
// ^? // ^?
``` ```
```ts twoslash tab="@llamaindex/readers"
import { SimpleDirectoryReader } from "@llamaindex/readers/directory";
const reader = new SimpleDirectoryReader()
const documents = await reader.loadData("./data")
// ^?
const texts = documents.map(doc => doc.getText()) ## Tips when using in non-Node.js environments
// ^?
``` When using `@llamaindex/readers` in a non-Node.js environment (such as Vercel Edge, Cloudflare Workers, etc.)
Some classes are not exported from top-level entry file.
The reason is that some classes are only compatible with Node.js runtime, (e.g. `PDFReader`) which uses Node.js specific APIs (like `fs`, `child_process`, `crypto`).
If you need any of those classes, you have to import them instead directly through their file path in the package.
As the `PDFReader` is not working with the Edge runtime, here's how to use the `SimpleDirectoryReader` with the `LlamaParseReader` to load PDFs:
```typescript
import { SimpleDirectoryReader } from "@llamaindex/readers/directory";
import { LlamaParseReader } from "@llamaindex/cloud";
export const DATA_DIR = "./data";
export async function getDocuments() {
const reader = new SimpleDirectoryReader();
// Load PDFs using LlamaParseReader
return await reader.loadData({
directoryPath: DATA_DIR,
fileExtToReader: {
pdf: new LlamaParseReader({ resultType: "markdown" }),
},
});
}
```
> _Note_: Reader classes have to be added explicitly to the `fileExtToReader` map in the Edge version of the `SimpleDirectoryReader`.
You'll find a complete example with LlamaIndexTS here: https://github.com/run-llama/create_llama_projects/tree/main/nextjs-edge-llamaparse
</Tabs>
## Load file natively using Node.js Customization Hooks ## Load file natively using Node.js Customization Hooks
We have a helper utility to allow you to import a file in Node.js script. We have a helper utility to allow you to import a file in Node.js script.
<Tabs groupId="llamaindex-or-readers" items={["llamaindex", "@llamaindex/readers"]} persist> ```shell
```shell tab="llamaindex" node --import @llamaindex/readers/node ./script.js
node --import llamaindex/register ./script.js ```
```
```shell tab="@llamaindex/readers"
node --import @llamaindex/readers/node ./script.js
```
</Tabs>
```ts ```ts
import csv from './path/to/data.csv'; import csv from './path/to/data.csv';
@@ -15,7 +15,7 @@ By default, we will use `Settings.nodeParser` to split the document into nodes.
```ts twoslash ```ts twoslash
import { TextFileReader } from '@llamaindex/readers/text' import { TextFileReader } from '@llamaindex/readers/text'
import { SentenceSplitter } from '@llamaindex/core/node-parser'; import { SentenceSplitter } from 'llamaindex';
import { Settings } from 'llamaindex'; import { Settings } from 'llamaindex';
const nodeParser = new SentenceSplitter(); const nodeParser = new SentenceSplitter();
@@ -28,7 +28,7 @@ Settings.nodeParser = nodeParser;
The underlying text splitter will split text by sentences. It can also be used as a standalone module for splitting raw text. The underlying text splitter will split text by sentences. It can also be used as a standalone module for splitting raw text.
```ts twoslash ```ts twoslash
import { SentenceSplitter } from "@llamaindex/core/node-parser"; import { SentenceSplitter } from "llamaindex";
const splitter = new SentenceSplitter({ chunkSize: 1 }); const splitter = new SentenceSplitter({ chunkSize: 1 });
@@ -42,7 +42,7 @@ The `MarkdownNodeParser` is a more advanced `NodeParser` that can handle markdow
<Tabs items={["with reader", "with node:fs"]}> <Tabs items={["with reader", "with node:fs"]}>
```ts twoslash tab="with reader" ```ts twoslash tab="with reader"
import { MarkdownNodeParser } from "@llamaindex/core/node-parser"; import { MarkdownNodeParser } from "llamaindex";
import { MarkdownReader } from '@llamaindex/readers/markdown' import { MarkdownReader } from '@llamaindex/readers/markdown'
const reader = new MarkdownReader(); const reader = new MarkdownReader();
@@ -56,8 +56,7 @@ The `MarkdownNodeParser` is a more advanced `NodeParser` that can handle markdow
```ts twoslash tab="with node:fs" ```ts twoslash tab="with node:fs"
import fs from 'node:fs/promises'; import fs from 'node:fs/promises';
import { MarkdownNodeParser } from "@llamaindex/core/node-parser"; import { MarkdownNodeParser, Document } from "llamaindex";
import { Document } from '@llamaindex/core/schema';
const markdownNodeParser = new MarkdownNodeParser(); const markdownNodeParser = new MarkdownNodeParser();
const text = await fs.readFile('path/to/file.md', 'utf-8'); const text = await fs.readFile('path/to/file.md', 'utf-8');
@@ -82,7 +81,7 @@ It will split the code by AST nodes and then parse the nodes into a `Document` o
import TS from "tree-sitter-typescript"; import TS from "tree-sitter-typescript";
const parser = new Parser(); const parser = new Parser();
parser.setLanguage(TS.typescript); parser.setLanguage(TS.typescript as Parser.Language);
const codeSplitter = new CodeSplitter({ const codeSplitter = new CodeSplitter({
getParser: () => parser, getParser: () => parser,
}); });
@@ -100,7 +99,7 @@ It will split the code by AST nodes and then parse the nodes into a `Document` o
import TS from "tree-sitter-typescript"; import TS from "tree-sitter-typescript";
const parser = new Parser(); const parser = new Parser();
parser.setLanguage(TS.typescript); parser.setLanguage(TS.typescript as Parser.Language);
const codeSplitter = new CodeSplitter({ const codeSplitter = new CodeSplitter({
getParser: () => parser, getParser: () => parser,
}); });
@@ -20,5 +20,5 @@ LlamaIndex.TS provides tools for beginners, advanced users, and everyone in betw
className="w-full h-[440px]" className="w-full h-[440px]"
aria-label="LlamaIndex.TS Starter" aria-label="LlamaIndex.TS Starter"
aria-description="This is a starter example for LlamaIndex.TS, it shows the basic usage of the library." aria-description="This is a starter example for LlamaIndex.TS, it shows the basic usage of the library."
src="https://stackblitz.com/github/run-llama/LlamaIndexTS/tree/main/examples?file=starter.ts" src="https://stackblitz.com/github/run-llama/LlamaIndexTS/tree/main/examples?embed=1&file=starter.ts"
/> />
@@ -69,7 +69,7 @@ streamText({
For production deployments, you can use LlamaCloud to store and manage your documents: For production deployments, you can use LlamaCloud to store and manage your documents:
```typescript ```typescript
import { LlamaCloudIndex } from "llamaindex"; import { LlamaCloudIndex } from "@llamaindex/cloud";
// Create a LlamaCloud index // Create a LlamaCloud index
const index = await LlamaCloudIndex.fromDocuments({ const index = await LlamaCloudIndex.fromDocuments({
@@ -7,6 +7,7 @@
"what-is-llamaindex", "what-is-llamaindex",
"index", "index",
"getting_started", "getting_started",
"migration",
"guide", "guide",
"examples", "examples",
"modules", "modules",
@@ -0,0 +1,97 @@
---
title: Migrating from v0.8 to v0.9
---
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
Version 0.9 of LlamaIndex.TS introduces significant architectural changes to improve package size and runtime compatibility. The main goals of this release are:
1. Reduce the package size of the main `llamaindex` package by moving dependencies into provider packages, making it more suitable for serverless environments
2. Enable consistent code across different environments by using unified imports (no separate imports for Node.js and Edge runtimes)
## Major Changes
### Installing Provider Packages
In v0.9, you need to explicitly install the provider packages you want to use. The main `llamaindex` package no longer includes these dependencies by default.
### Updating Imports
You'll need to update your imports to get classes directly from their respective provider packages. Here's how to migrate different components:
### 1. AI Model Providers
Previously:
```typescript
import { OpenAI } from "llamaindex";
```
Now:
```typescript
import { OpenAI } from "@llamaindex/openai";
```
> Note: This examples requires installing the `@llamaindex/openai` package:
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install @llamaindex/openai
```
```shell tab="yarn"
yarn add @llamaindex/openai
```
```shell tab="pnpm"
pnpm add @llamaindex/openai
```
</Tabs>
For more details on available AI model providers and their configuration, see the [LLMs documentation](/docs/llamaindex/modules/llms) and the [Embedding Models documentation](/docs/llamaindex/modules/embeddings).
### 2. Storage Providers
Previously:
```typescript
import { PineconeVectorStore } from "llamaindex";
```
Now:
```typescript
import { PineconeVectorStore } from "@llamaindex/pinecone";
```
For more information about available storage options, refer to the [Data Stores documentation](/docs/llamaindex/modules/data_stores).
### 3. Data Loaders
Previously:
```typescript
import { SimpleDirectoryReader } from "llamaindex";
```
Now:
```typescript
import { SimpleDirectoryReader } from "@llamaindex/readers/directory";
```
For more details about available data loaders and their usage, check the [Loading Data](/docs/llamaindex/guide/loading).
### 4. Prefer using `llamaindex` instead of `@llamaindex/core`
`llamaindex` is now re-exporting most of `@llamaindex/core`. To simplify imports, just use `import { ... } from "llamaindex"` instead of `import { ... } from "@llamaindex/core"`. This is possible because `llamaindex` is now a smaller package.
We might change imports internally in `@llamaindex/core` in the future. Let us know if you're missing something.
## Benefits of the Changes
- **Smaller Bundle Size**: By moving dependencies to separate packages, your application only includes the features you actually use
- **Runtime Consistency**: The same code works across different environments without environment-specific imports
- **Improved Serverless Support**: Reduced package size makes it easier to deploy to serverless environments with size limitations
## Need Help?
If you encounter any issues during migration, please:
1. Check our [GitHub repository](https://github.com/run-llama/LlamaIndexTS) for the latest updates
2. Join our [Discord community](https://discord.gg/dGcwcsnxhU) for support
3. Open an issue on GitHub if you find a bug or have a feature request
@@ -0,0 +1,5 @@
{
"title": "Migration",
"description": "Migration between different versions",
"pages": ["0.8-to-0.9"]
}
@@ -0,0 +1,116 @@
---
title: Agent Workflow
---
Agent Workflows are a powerful system that enables you to create and orchestrate one or multiple agents with tools to perform specific tasks. It's built on top of the base `Workflow` system and provides a streamlined interface for agent interactions.
## Usage
### Single Agent Workflow
The simplest use case is creating a single agent with specific tools. Here's an example of creating an assistant that tells jokes:
```typescript
import { agent, tool } from "llamaindex";
import { openai } from "@llamaindex/openai";
// Define a joke-telling tool
const jokeTool = tool(
() => "Baby Llama is called cria",
{
name: "joke",
description: "Use this tool to get a joke",
}
);
// Create an single agent workflow with the tool
const jokeAgent = agent({
tools: [jokeTool],
llm: openai({ model: "gpt-4o-mini" }),
});
// Run the workflow
const result = await jokeAgent.run("Tell me something funny");
console.log(result); // Baby Llama is called cria
```
### Event Streaming
Agent Workflows provide a unified interface for event streaming, making it easy to track and respond to different events during execution:
```typescript
import { AgentToolCall, AgentStream } from "llamaindex";
// Get the workflow execution context
const context = workflow.run("Tell me something funny");
// Stream and handle events
for await (const event of context) {
if (event instanceof AgentToolCall) {
console.log(`Tool being called: ${event.data.toolName}`);
}
if (event instanceof AgentStream) {
process.stdout.write(event.data.delta);
}
}
```
### Multi-Agent Workflow
An Agent Workflow can orchestrate multiple agents, enabling complex interactions and task handoffs. Each agent in a multi-agent workflow requires:
- `name`: Unique identifier for the agent
- `description`: Purpose description used for task routing
- `tools`: Array of tools the agent can use
- `canHandoffTo` (optional): Array of agent names or agent instances that this agent can delegate tasks to
Here's an example of a multi-agent system that combines joke-telling and weather information:
```typescript
import { multiAgent, agent, tool } from "llamaindex";
import { openai } from "@llamaindex/openai";
import { z } from "zod";
// Create a weather agent
const weatherAgent = agent({
name: "WeatherAgent",
description: "Provides weather information for any city",
tools: [
tool(
{
name: "fetchWeather",
description: "Get weather information for a city",
parameters: z.object({
city: z.string(),
}),
execute: ({ city }) => `The weather in ${city} is sunny`,
}
),
],
llm: openai({ model: "gpt-4o-mini" }),
});
// Create a joke-telling agent
const jokeAgent = agent({
name: "JokeAgent",
description: "Tells jokes and funny stories",
tools: [jokeTool], // Using the joke tool defined earlier
llm: openai({ model: "gpt-4o-mini" }),
canHandoffTo: [weatherAgent], // Can hand off to the weather agent
});
// Create the multi-agent workflow
const agents = multiAgent({
agents: [jokeAgent, weatherAgent],
rootAgent: jokeAgent, // Start with the joke agent
});
// Run the workflow
const result = await agents.run(
"Give me a morning greeting with a joke and the weather in San Francisco"
);
```
The workflow will coordinate between agents, allowing them to handle different aspects of the request and hand off tasks when appropriate.
@@ -12,9 +12,26 @@ const chatEngine = new ContextChatEngine({ retriever });
const response = await chatEngine.chat({ message: query }); const response = await chatEngine.chat({ message: query });
``` ```
In short, you can use the chat engine by calling `index.asChatEngine()`. It will return a `ContextChatEngine` to start chatting.
```typescript
const chatEngine = index.asChatEngine();
```
You can also pass in options to the chat engine.
```typescript
const chatEngine = index.asChatEngine({
similarityTopK: 5,
systemPrompt: "You are a helpful assistant.",
});
```
The `chat` function also supports streaming, just add `stream: true` as an option: The `chat` function also supports streaming, just add `stream: true` as an option:
```typescript ```typescript
const chatEngine = index.asChatEngine();
const stream = await chatEngine.chat({ message: query, stream: true }); const stream = await chatEngine.chat({ message: query, stream: true });
for await (const chunk of stream) { for await (const chunk of stream) {
process.stdout.write(chunk.response); process.stdout.write(chunk.response);
@@ -6,10 +6,28 @@ A simple JSON data loader with various options.
Either parses the entire string, cleaning it and treat each line as an embedding or performs a recursive depth-first traversal yielding JSON paths. Either parses the entire string, cleaning it and treat each line as an embedding or performs a recursive depth-first traversal yielding JSON paths.
Supports streaming of large JSON data using [@discoveryjs/json-ext](https://github.com/discoveryjs/json-ext) Supports streaming of large JSON data using [@discoveryjs/json-ext](https://github.com/discoveryjs/json-ext)
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/readers
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/readers
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/readers
```
</Tabs>
## Usage ## Usage
```ts ```ts
import { JSONReader } from "llamaindex"; import { JSONReader } from "@llamaindex/readers/json";
const file = "../../PATH/TO/FILE"; const file = "../../PATH/TO/FILE";
const content = new TextEncoder().encode("JSON_CONTENT"); const content = new TextEncoder().encode("JSON_CONTENT");
@@ -4,6 +4,24 @@ title: Image Retrieval
LlamaParse `json` mode supports extracting any images found in a page object by using the `getImages` function. They are downloaded to a local folder and can then be sent to a multimodal LLM for further processing. LlamaParse `json` mode supports extracting any images found in a page object by using the `getImages` function. They are downloaded to a local folder and can then be sent to a multimodal LLM for further processing.
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/cloud @llamaindex/openai
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/cloud @llamaindex/openai
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/cloud @llamaindex/openai
```
</Tabs>
## Usage ## Usage
We use the `getImages` method to input our array of JSON objects, download the images to a specified folder and get a list of ImageNodes. We use the `getImages` method to input our array of JSON objects, download the images to a specified folder and get a list of ImageNodes.
@@ -19,14 +37,10 @@ const imageDicts = await reader.getImages(jsonObjs, "images");
You can create an index across both text and image nodes by requesting alternative text for the image from a multimodal LLM. You can create an index across both text and image nodes by requesting alternative text for the image from a multimodal LLM.
```ts ```ts
import { import { Document, ImageNode, VectorStoreIndex } from "llamaindex";
Document, import { LlamaParseReader } from "@llamaindex/cloud";
ImageNode, import { OpenAI } from "@llamaindex/openai";
LlamaParseReader, import { createMessageContent } from "llamaindex";
OpenAI,
VectorStoreIndex,
} from "llamaindex";
import { createMessageContent } from "llamaindex/synthesizers/utils";
const reader = new LlamaParseReader(); const reader = new LlamaParseReader();
async function main() { async function main() {
@@ -4,12 +4,32 @@ title: JSON Mode
In JSON mode, LlamaParse will return a data structure representing the parsed object. In JSON mode, LlamaParse will return a data structure representing the parsed object.
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/cloud
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/cloud
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/cloud
```
</Tabs>
## Usage ## Usage
For Json mode, you need to use `loadJson`. The `resultType` is automatically set with this method. For Json mode, you need to use `loadJson`. The `resultType` is automatically set with this method.
More information about indexing the results on the next page. More information about indexing the results on the next page.
```ts ```ts
import { LlamaParseReader } from "@llamaindex/cloud";
const reader = new LlamaParseReader(); const reader = new LlamaParseReader();
async function main() { async function main() {
// Load the file and return an array of json objects // Load the file and return an array of json objects
@@ -59,7 +79,8 @@ All Readers share a `loadData` method with `SimpleDirectoryReader` that promises
However, a simple work around is to create a new reader class that extends `LlamaParseReader` and adds a new method or overrides `loadData`, wrapping around JSON mode, extracting the required values, and returning a Document object. However, a simple work around is to create a new reader class that extends `LlamaParseReader` and adds a new method or overrides `loadData`, wrapping around JSON mode, extracting the required values, and returning a Document object.
```ts ```ts
import { LlamaParseReader, Document } from "llamaindex"; import { Document } from "llamaindex";
import { LlamaParseReader } from "@llamaindex/cloud";
class LlamaParseReaderWithJson extends LlamaParseReader { class LlamaParseReaderWithJson extends LlamaParseReader {
// Override the loadData method // Override the loadData method
@@ -11,6 +11,38 @@ Document stores contain ingested document chunks, i.e. [Node](/docs/llamaindex/m
Check the [LlamaIndexTS Github](https://github.com/run-llama/LlamaIndexTS) for the most up to date overview of integrations. Check the [LlamaIndexTS Github](https://github.com/run-llama/LlamaIndexTS) for the most up to date overview of integrations.
## Using PostgreSQL as Document Store
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/postgres
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/postgres
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/postgres
```
</Tabs>
You can configure the `schemaName`, `tableName`, `namespace`, and
`connectionString`. If a `connectionString` is not
provided, it will use the environment variables `PGHOST`, `PGUSER`,
`PGPASSWORD`, `PGDATABASE` and `PGPORT`.
```typescript
import { Document, VectorStoreIndex, storageContextFromDefaults } from "llamaindex";
import { PostgresDocumentStore } from "@llamaindex/postgres";
const storageContext = await storageContextFromDefaults({
docStore: new PostgresDocumentStore(),
});
```
## API Reference ## API Reference
- [BaseDocumentStore](/docs/api/classes/BaseDocumentStore) - [BaseDocumentStore](/docs/api/classes/BaseDocumentStore)
@@ -5,9 +5,13 @@ title: Storage
Storage in LlamaIndex.TS works automatically once you've configured a Storage in LlamaIndex.TS works automatically once you've configured a
`StorageContext` object. `StorageContext` object.
Per default a local directory is used for storage. Depening on the storage type (i.e. doc stores, index stores or vector stores), you can configure a different persistence layer.
Most commonly a vector database is used as vector store.
## Local Storage ## Local Storage
You can configure the `persistDir` and attach it to an index. You can configure the `persistDir` to define where to store the data locally.
```typescript ```typescript
import { import {
@@ -26,33 +30,6 @@ const index = await VectorStoreIndex.fromDocuments([document], {
}); });
``` ```
## PostgreSQL Storage
You can configure the `schemaName`, `tableName`, `namespace`, and
`connectionString`. If a `connectionString` is not
provided, it will use the environment variables `PGHOST`, `PGUSER`,
`PGPASSWORD`, `PGDATABASE` and `PGPORT`.
```typescript
import {
Document,
VectorStoreIndex,
PostgresDocumentStore,
PostgresIndexStore,
storageContextFromDefaults,
} from "llamaindex";
const storageContext = await storageContextFromDefaults({
docStore: new PostgresDocumentStore(),
indexStore: new PostgresIndexStore(),
});
const document = new Document({ text: "Test Text" });
const index = await VectorStoreIndex.fromDocuments([document], {
storageContext,
});
```
## API Reference ## API Reference
- [StorageContext](/docs/api/interfaces/StorageContext) - [StorageContext](/docs/api/interfaces/StorageContext)
@@ -11,6 +11,38 @@ Index stores are underlying storage components that contain metadata(i.e. inform
Check the [LlamaIndexTS Github](https://github.com/run-llama/LlamaIndexTS) for the most up to date overview of integrations. Check the [LlamaIndexTS Github](https://github.com/run-llama/LlamaIndexTS) for the most up to date overview of integrations.
## Using PostgreSQL as Index Store
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/postgres
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/postgres
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/postgres
```
</Tabs>
You can configure the `schemaName`, `tableName`, `namespace`, and
`connectionString`. If a `connectionString` is not
provided, it will use the environment variables `PGHOST`, `PGUSER`,
`PGPASSWORD`, `PGDATABASE` and `PGPORT`.
```typescript
import { Document, VectorStoreIndex, storageContextFromDefaults } from "llamaindex";
import { PostgresIndexStore } from "@llamaindex/postgres";
const storageContext = await storageContextFromDefaults({
indexStore: new PostgresIndexStore(),
});
```
## API Reference ## API Reference
- [BaseIndexStore](/docs/api/classes/BaseIndexStore) - [BaseIndexStore](/docs/api/classes/BaseIndexStore)
@@ -21,4 +21,4 @@ Check the [LlamaIndexTS Github](https://github.com/run-llama/LlamaIndexTS) for t
## API Reference ## API Reference
- [VectorStoreBase](/docs/api/classes/VectorStoreBase) - [BaseVectorStore](/docs/api/classes/BaseVectorStore)
@@ -11,11 +11,30 @@ docker pull qdrant/qdrant
docker run -p 6333:6333 qdrant/qdrant docker run -p 6333:6333 qdrant/qdrant
``` ```
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/qdrant
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/qdrant
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/qdrant
```
</Tabs>
## Importing the modules ## Importing the modules
```ts ```ts
import fs from "node:fs/promises"; import fs from "node:fs/promises";
import { Document, VectorStoreIndex, QdrantVectorStore } from "llamaindex"; import { Document, VectorStoreIndex } from "llamaindex";
import { QdrantVectorStore } from "@llamaindex/qdrant";
``` ```
## Load the documents ## Load the documents
@@ -60,7 +79,8 @@ console.log(response.toString());
```ts ```ts
import fs from "node:fs/promises"; import fs from "node:fs/promises";
import { Document, VectorStoreIndex, QdrantVectorStore } from "llamaindex"; import { Document, VectorStoreIndex } from "llamaindex";
import { QdrantVectorStore } from "@llamaindex/qdrant";
async function main() { async function main() {
const path = "node_modules/llamaindex/examples/abramov.txt"; const path = "node_modules/llamaindex/examples/abramov.txt";
@@ -14,13 +14,8 @@ Our metadata extractor modules include the following "feature extractors":
Then you can chain the `Metadata Extractors` with the `IngestionPipeline` to extract metadata from a set of documents. Then you can chain the `Metadata Extractors` with the `IngestionPipeline` to extract metadata from a set of documents.
```ts ```ts
import { import { Document, IngestionPipeline, TitleExtractor, QuestionsAnsweredExtractor } from "llamaindex";
IngestionPipeline, import { OpenAI } from "@llamaindex/openai";
TitleExtractor,
QuestionsAnsweredExtractor,
Document,
OpenAI,
} from "llamaindex";
async function main() { async function main() {
const pipeline = new IngestionPipeline({ const pipeline = new IngestionPipeline({
@@ -5,13 +5,27 @@ title: DeepInfra
To use DeepInfra embeddings, you need to import `DeepInfraEmbedding` from llamaindex. To use DeepInfra embeddings, you need to import `DeepInfraEmbedding` from llamaindex.
Check out available embedding models [here](https://deepinfra.com/models/embeddings). Check out available embedding models [here](https://deepinfra.com/models/embeddings).
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/deepinfra
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/deepinfra
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/deepinfra
```
</Tabs>
```ts ```ts
import { import { Document, Settings, VectorStoreIndex } from "llamaindex";
DeepInfraEmbedding, import { DeepInfraEmbedding } from "@llamaindex/deepinfra";
Settings,
Document,
VectorStoreIndex,
} from "llamaindex";
// Update Embed Model // Update Embed Model
Settings.embedModel = new DeepInfraEmbedding(); Settings.embedModel = new DeepInfraEmbedding();
@@ -33,7 +47,7 @@ By default, DeepInfraEmbedding is using the sentence-transformers/clip-ViT-B-32
For example: For example:
```ts ```ts
import { DeepInfraEmbedding } from "llamaindex"; import { DeepInfraEmbedding } from "@llamaindex/deepinfra";
const model = "intfloat/e5-large-v2"; const model = "intfloat/e5-large-v2";
Settings.embedModel = new DeepInfraEmbedding({ Settings.embedModel = new DeepInfraEmbedding({
@@ -46,7 +60,8 @@ You can also set the `maxRetries` and `timeout` parameters when initializing `De
For example: For example:
```ts ```ts
import { DeepInfraEmbedding, Settings } from "llamaindex"; import { Settings } from "llamaindex";
import { DeepInfraEmbedding } from "@llamaindex/deepinfra";
const model = "intfloat/e5-large-v2"; const model = "intfloat/e5-large-v2";
const maxRetries = 5; const maxRetries = 5;
@@ -62,7 +77,7 @@ Settings.embedModel = new DeepInfraEmbedding({
Standalone usage: Standalone usage:
```ts ```ts
import { DeepInfraEmbedding } from "llamaindex"; import { DeepInfraEmbedding } from "@llamaindex/deepinfra";
import { config } from "dotenv"; import { config } from "dotenv";
// For standalone usage, you need to configure DEEPINFRA_API_TOKEN in .env file // For standalone usage, you need to configure DEEPINFRA_API_TOKEN in .env file
config(); config();
@@ -2,10 +2,29 @@
title: Gemini title: Gemini
--- ---
To use Gemini embeddings, you need to import `GeminiEmbedding` from `llamaindex`. To use Gemini embeddings, you need to import `GeminiEmbedding` from `@llamaindex/google`.
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/google
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/google
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/google
```
</Tabs>
```ts ```ts
import { GeminiEmbedding, Settings } from "llamaindex"; import { Document, Settings, VectorStoreIndex } from "llamaindex";
import { GeminiEmbedding, GEMINI_MODEL } from "@llamaindex/google";
// Update Embed Model // Update Embed Model
Settings.embedModel = new GeminiEmbedding(); Settings.embedModel = new GeminiEmbedding();
@@ -27,7 +46,7 @@ Per default, `GeminiEmbedding` is using the `gemini-pro` model. You can change t
For example: For example:
```ts ```ts
import { GEMINI_MODEL, GeminiEmbedding } from "llamaindex"; import { GEMINI_MODEL, GeminiEmbedding } from "@llamaindex/google";
Settings.embedModel = new GeminiEmbedding({ Settings.embedModel = new GeminiEmbedding({
model: GEMINI_MODEL.GEMINI_PRO_LATEST, model: GEMINI_MODEL.GEMINI_PRO_LATEST,
@@ -2,10 +2,29 @@
title: HuggingFace title: HuggingFace
--- ---
To use HuggingFace embeddings, you need to import `HuggingFaceEmbedding` from `llamaindex`. To use HuggingFace embeddings, you need to import `HuggingFaceEmbedding` from `@llamaindex/huggingface`.
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/huggingface
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/huggingface
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/huggingface
```
</Tabs>
```ts ```ts
import { HuggingFaceEmbedding, Settings } from "llamaindex"; import { Document, Settings, VectorStoreIndex } from "llamaindex";
import { HuggingFaceEmbedding } from "@llamaindex/huggingface";
// Update Embed Model // Update Embed Model
Settings.embedModel = new HuggingFaceEmbedding(); Settings.embedModel = new HuggingFaceEmbedding();
@@ -29,6 +48,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: For example, to use the not quantized `BAAI/bge-small-en-v1.5` model, you can use the following code:
```ts ```ts
import { HuggingFaceEmbedding } from "@llamaindex/huggingface";
Settings.embedModel = new HuggingFaceEmbedding({ Settings.embedModel = new HuggingFaceEmbedding({
modelType: "BAAI/bge-small-en-v1.5", modelType: "BAAI/bge-small-en-v1.5",
quantized: false, quantized: false,
@@ -2,10 +2,11 @@
title: Jina AI title: Jina AI
--- ---
To use Jina AI embeddings, you need to import `JinaAIEmbedding` from `llamaindex`. To use Jina AI embeddings, you need to import `JinaAIEmbedding` from `@llamaindex/jinaai`.
```ts ```ts
import { JinaAIEmbedding, Settings } from "llamaindex"; import { Settings } from "llamaindex";
import { JinaAIEmbedding } from "@llamaindex/jinaai";
Settings.embedModel = new JinaAIEmbedding(); Settings.embedModel = new JinaAIEmbedding();
@@ -2,10 +2,29 @@
title: MistralAI title: MistralAI
--- ---
To use MistralAI embeddings, you need to import `MistralAIEmbedding` from `llamaindex`. To use MistralAI embeddings, you need to import `MistralAIEmbedding` from `@llamaindex/mistral`.
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/mistral
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/mistral
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/mistral
```
</Tabs>
```ts ```ts
import { MistralAIEmbedding, Settings } from "llamaindex"; import { Document, Settings, VectorStoreIndex } from "llamaindex";
import { MistralAIEmbedding } from "@llamaindex/mistral";
// Update Embed Model // Update Embed Model
Settings.embedModel = new MistralAIEmbedding({ Settings.embedModel = new MistralAIEmbedding({
@@ -14,16 +14,28 @@ To find out more about the latest features, updates, and available models, visit
## Setup ## Setup
First, you will need to install the `llamaindex` package. import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/mixedbread
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/mixedbread
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/mixedbread
```
</Tabs>
```bash
pnpm install llamaindex
```
Next, sign up for an API key at [mixedbread.ai](https://mixedbread.ai/). Once you have your API key, you can import the necessary modules and create a new instance of the `MixedbreadAIEmbeddings` class. Next, sign up for an API key at [mixedbread.ai](https://mixedbread.ai/). Once you have your API key, you can import the necessary modules and create a new instance of the `MixedbreadAIEmbeddings` class.
```ts ```ts
import { MixedbreadAIEmbeddings, Document, Settings } from "llamaindex"; import { MixedbreadAIEmbeddings } from "@llamaindex/mixedbread";
import { Document, Settings } from "llamaindex";
``` ```
## Usage with LlamaIndex ## Usage with LlamaIndex
@@ -2,7 +2,7 @@
title: Ollama title: Ollama
--- ---
To use Ollama embeddings, you need to import `OllamaEmbedding` from `llamaindex`. To use Ollama embeddings, you need to import `OllamaEmbedding` from `@llamaindex/ollama`.
Note that you need to pull the embedding model first before using it. Note that you need to pull the embedding model first before using it.
@@ -12,8 +12,27 @@ In the example below, we're using the [`nomic-embed-text`](https://ollama.com/li
ollama pull nomic-embed-text ollama pull nomic-embed-text
``` ```
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/ollama
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/ollama
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/ollama
```
</Tabs>
```ts ```ts
import { OllamaEmbedding, Settings } from "llamaindex"; import { OllamaEmbedding } from "@llamaindex/ollama";
import { Document, Settings, VectorStoreIndex } from "llamaindex";
Settings.embedModel = new OllamaEmbedding({ model: "nomic-embed-text" }); Settings.embedModel = new OllamaEmbedding({ model: "nomic-embed-text" });
@@ -2,10 +2,29 @@
title: OpenAI title: OpenAI
--- ---
To use OpenAI embeddings, you need to import `OpenAIEmbedding` from `llamaindex`. To use OpenAI embeddings, you need to import `OpenAIEmbedding` from `@llamaindex/openai`.
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/openai
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/openai
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/openai
```
</Tabs>
```ts ```ts
import { OpenAIEmbedding, Settings } from "llamaindex"; import { OpenAIEmbedding } from "@llamaindex/openai";
import { Document, Settings, VectorStoreIndex } from "llamaindex";
Settings.embedModel = new OpenAIEmbedding(); Settings.embedModel = new OpenAIEmbedding();
@@ -2,10 +2,11 @@
title: Together title: Together
--- ---
To use together embeddings, you need to import `TogetherEmbedding` from `llamaindex`. To use together embeddings, you need to import `TogetherEmbedding` from `@llamaindex/together`.
```ts ```ts
import { TogetherEmbedding, Settings } from "llamaindex"; import { Settings } from "llamaindex";
import { TogetherEmbedding } from "@llamaindex/together";
Settings.embedModel = new TogetherEmbedding({ Settings.embedModel = new TogetherEmbedding({
apiKey: "<YOUR_API_KEY>", apiKey: "<YOUR_API_KEY>",
@@ -0,0 +1,46 @@
---
title: VoyageAI
---
To use VoyageAI embeddings, you need to import `VoyageAIEmbedding` from `@llamaindex/voyage-ai`.
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/voyage-ai
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/voyage-ai
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/voyage-ai
```
</Tabs>
```ts
import { VoyageAIEmbedding } from "@llamaindex/voyage-ai";
import { Document, Settings, VectorStoreIndex } from "llamaindex";
Settings.embedModel = new VoyageAIEmbedding();
const document = new Document({ text: essay, id_: "essay" });
const index = await VectorStoreIndex.fromDocuments([document]);
const queryEngine = index.asQueryEngine();
const query = "What is the meaning of life?";
const results = await queryEngine.query({
query,
});
```
## API Reference
- [VoyageAIEmbedding](/docs/api/classes/VoyageAIEmbedding)
@@ -6,8 +6,27 @@ The embedding model in LlamaIndex is responsible for creating numerical represen
This can be explicitly updated through `Settings` This can be explicitly updated through `Settings`
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/openai
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/openai
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/openai
```
</Tabs>
```typescript ```typescript
import { OpenAIEmbedding, Settings } from "llamaindex"; import { OpenAIEmbedding } from "@llamaindex/openai";
import { Settings } from "llamaindex";
Settings.embedModel = new OpenAIEmbedding({ Settings.embedModel = new OpenAIEmbedding({
model: "text-embedding-ada-002", model: "text-embedding-ada-002",
@@ -18,6 +37,31 @@ Settings.embedModel = new OpenAIEmbedding({
For local embeddings, you can use the [HuggingFace](/docs/llamaindex/modules/embeddings/available_embeddings/huggingface) embedding model. For local embeddings, you can use the [HuggingFace](/docs/llamaindex/modules/embeddings/available_embeddings/huggingface) embedding model.
## Local Ollama Embeddings With Remote Host
Ollama provides a way to run embedding models locally or connect to a remote Ollama instance. This is particularly useful when you need to:
- Run embeddings without relying on external API services
- Use custom embedding models
- Connect to a shared Ollama instance in your network
The ENV variable method you will find elsewhere sometimes may not work with the OllamaEmbedding class. Also note, you'll need to change the host
in the Ollama server to `0.0.0.0` to allow connections from other machines.
To use Ollama embeddings with a remote host, you need to specify the host URL in the configuration like this:
```typescript
import { OllamaEmbedding } from "@llamaindex/ollama";
import { Settings } from "llamaindex";
// Configure Ollama with a remote host
Settings.embedModel = new OllamaEmbedding({
model: "nomic-embed-text",
config: {
host: "http://your-ollama-host:11434"
}
});
```
## Available Embeddings ## Available Embeddings
Most available embeddings are listed in the sidebar on the left. Most available embeddings are listed in the sidebar on the left.
@@ -10,9 +10,21 @@ This is useful for measuring if the response was correct. The evaluator returns
Firstly, you need to install the package: Firstly, you need to install the package:
```bash import { Tab, Tabs } from "fumadocs-ui/components/tabs";
pnpm i llamaindex
``` <Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/openai
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/openai
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/openai
```
</Tabs>
Set the OpenAI API key: Set the OpenAI API key:
@@ -23,7 +35,8 @@ export OPENAI_API_KEY=your-api-key
Import the required modules: Import the required modules:
```ts ```ts
import { CorrectnessEvaluator, OpenAI, Settings, Response } from "llamaindex"; import { OpenAI } from "@llamaindex/openai";
import { CorrectnessEvaluator, Settings, Response } from "llamaindex";
``` ```
Let's setup gpt-4 for better results: Let's setup gpt-4 for better results:
@@ -12,9 +12,22 @@ This is useful for measuring if the response was hallucinated. The evaluator ret
Firstly, you need to install the package: Firstly, you need to install the package:
```bash import { Tab, Tabs } from "fumadocs-ui/components/tabs";
pnpm i llamaindex
``` <Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/openai
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/openai
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/openai
```
</Tabs>
Set the OpenAI API key: Set the OpenAI API key:
@@ -25,12 +38,12 @@ export OPENAI_API_KEY=your-api-key
Import the required modules: Import the required modules:
```ts ```ts
import { OpenAI } from "@llamaindex/openai";
import { import {
Document, Document,
FaithfulnessEvaluator, FaithfulnessEvaluator,
OpenAI,
VectorStoreIndex,
Settings, Settings,
VectorStoreIndex,
} from "llamaindex"; } from "llamaindex";
``` ```
@@ -10,9 +10,22 @@ It is useful for measuring if the response was relevant to the query. The evalua
Firstly, you need to install the package: Firstly, you need to install the package:
```bash import { Tab, Tabs } from "fumadocs-ui/components/tabs";
pnpm i llamaindex
``` <Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/openai
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/openai
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/openai
```
</Tabs>
Set the OpenAI API key: Set the OpenAI API key:
@@ -23,11 +36,11 @@ export OPENAI_API_KEY=your-api-key
Import the required modules: Import the required modules:
```ts ```ts
import { OpenAI } from "@llamaindex/openai";
import { import {
RelevancyEvaluator,
OpenAI,
Settings,
Document, Document,
RelevancyEvaluator,
Settings,
VectorStoreIndex, VectorStoreIndex,
} from "llamaindex"; } from "llamaindex";
``` ```
@@ -5,18 +5,35 @@ title: Ingestion Pipeline
An `IngestionPipeline` uses a concept of `Transformations` that are applied to input data. An `IngestionPipeline` uses a concept of `Transformations` that are applied to input data.
These `Transformations` are applied to your input data, and the resulting nodes are either returned or inserted into a vector database (if given). These `Transformations` are applied to your input data, and the resulting nodes are either returned or inserted into a vector database (if given).
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/openai @llamaindex/qdrant
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/openai @llamaindex/qdrant
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/openai @llamaindex/qdrant
```
</Tabs>
## Usage Pattern ## Usage Pattern
The simplest usage is to instantiate an IngestionPipeline like so: The simplest usage is to instantiate an IngestionPipeline like so:
```ts ```ts
import fs from "node:fs/promises"; import fs from "node:fs/promises";
import { OpenAI, OpenAIEmbedding } from "@llamaindex/openai";
import { import {
Document, Document,
IngestionPipeline, IngestionPipeline,
MetadataMode, MetadataMode,
OpenAIEmbedding,
TitleExtractor, TitleExtractor,
SentenceSplitter, SentenceSplitter,
} from "llamaindex"; } from "llamaindex";
@@ -58,14 +75,14 @@ Then, you can construct an index from that vector store later on.
```ts ```ts
import fs from "node:fs/promises"; import fs from "node:fs/promises";
import { OpenAIEmbedding } from "@llamaindex/openai";
import { QdrantVectorStore } from "@llamaindex/qdrant";
import { import {
Document, Document,
IngestionPipeline, IngestionPipeline,
MetadataMode, MetadataMode,
OpenAIEmbedding,
TitleExtractor, TitleExtractor,
SentenceSplitter, SentenceSplitter,
QdrantVectorStore,
VectorStoreIndex, VectorStoreIndex,
} from "llamaindex"; } from "llamaindex";
@@ -2,10 +2,29 @@
title: Anthropic title: Anthropic
--- ---
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/anthropic
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/anthropic
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/anthropic
```
</Tabs>
## Usage ## Usage
```ts ```ts
import { Anthropic, Settings } from "llamaindex"; import { Settings } from "llamaindex";
import { Anthropic } from "@llamaindex/anthropic";
Settings.llm = new Anthropic({ Settings.llm = new Anthropic({
apiKey: "<YOUR_API_KEY>", apiKey: "<YOUR_API_KEY>",
@@ -37,7 +56,8 @@ const results = await queryEngine.query({
## Full Example ## Full Example
```ts ```ts
import { Anthropic, Document, VectorStoreIndex, Settings } from "llamaindex"; import { Document, VectorStoreIndex, Settings } from "llamaindex";
import { Anthropic } from "@llamaindex/anthropic";
Settings.llm = new Anthropic({ Settings.llm = new Anthropic({
apiKey: "<YOUR_API_KEY>", apiKey: "<YOUR_API_KEY>",
@@ -14,10 +14,29 @@ export AZURE_OPENAI_ENDPOINT="<YOUR ENDPOINT, see https://learn.microsoft.com/en
export AZURE_OPENAI_DEPLOYMENT="gpt-4" # or some other deployment name export AZURE_OPENAI_DEPLOYMENT="gpt-4" # or some other deployment name
``` ```
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/openai
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/openai
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/openai
```
</Tabs>
## Usage ## Usage
```ts ```ts
import { OpenAI, Settings } from "llamaindex"; import { Settings } from "llamaindex";
import { OpenAI } from "@llamaindex/openai";
Settings.llm = new OpenAI({ model: "gpt-4", temperature: 0 }); Settings.llm = new OpenAI({ model: "gpt-4", temperature: 0 });
``` ```
@@ -47,7 +66,8 @@ const results = await queryEngine.query({
## Full Example ## Full Example
```ts ```ts
import { OpenAI, Document, VectorStoreIndex, Settings } from "llamaindex"; import { Document, VectorStoreIndex, Settings } from "llamaindex";
import { OpenAI } from "@llamaindex/openai";
Settings.llm = new OpenAI({ model: "gpt-4", temperature: 0 }); Settings.llm = new OpenAI({ model: "gpt-4", temperature: 0 });
@@ -2,6 +2,24 @@
title: Bedrock title: Bedrock
--- ---
## Installation
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
npm install llamaindex @llamaindex/community
```
```shell tab="yarn"
yarn add llamaindex @llamaindex/community
```
```shell tab="pnpm"
pnpm add llamaindex @llamaindex/community
```
</Tabs>
## Usage ## Usage
```ts ```ts
@@ -109,26 +127,21 @@ async function main() {
```ts ```ts
import { BEDROCK_MODELS, Bedrock } from "@llamaindex/community"; import { BEDROCK_MODELS, Bedrock } from "@llamaindex/community";
import { FunctionTool, LLMAgent } from "llamaindex"; import { FunctionTool, LLMAgent } from "llamaindex";
import { z } from "zod";
const sumNumbers = FunctionTool.from( const sumNumbers = FunctionTool.from(
({ a, b }: { a: number; b: number }) => `${a + b}`, ({ a, b }: { a: number; b: number }) => `${a + b}`,
{ {
name: "sumNumbers", name: "sumNumbers",
description: "Use this function to sum two numbers", description: "Use this function to sum two numbers",
parameters: { parameters: z.object({
type: "object", a: z.number({
properties: { description: "The first number",
a: { }),
type: "number", b: z.number({
description: "The first number", description: "The second number",
}, }),
b: { }),
type: "number",
description: "The second number",
},
},
required: ["a", "b"],
},
}, },
); );
@@ -137,20 +150,14 @@ const divideNumbers = FunctionTool.from(
{ {
name: "divideNumbers", name: "divideNumbers",
description: "Use this function to divide two numbers", description: "Use this function to divide two numbers",
parameters: { parameters: z.object({
type: "object", a: z.number({
properties: { description: "The dividend a to divide",
a: { }),
type: "number", b: z.number({
description: "The dividend a to divide", description: "The divisor b to divide by",
}, }),
b: { }),
type: "number",
description: "The divisor b to divide by",
},
},
required: ["a", "b"],
},
}, },
); );

Some files were not shown because too many files have changed in this diff Show More