create-llama@0.0.12

Feat: Add MongoDB Vector DB support for Python projects in create-llama

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@2.3.1/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.github/ISSUE_TEMPLATE/bugfix.yml

@@ -0,0 +1,10 @@
+name: Bugfix
+title: ""
+description: Write something like "We notice ... behavior when ... happens instead of ..." If you would like to use sweep.dev prefix with "Sweep:"
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Details
+      description: More details about the bug
+      placeholder: The bug might be in ... file

.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,10 @@
+name: Feature Request
+title: ""
+description: Write something like "Write an api endpoint that does "..." in the "..." file". If you would like to use sweep.dev prefix with "Sweep:"
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Details
+      description: More details
+      placeholder: The new endpoint should use the ... class from ... file because it contains ... logic

.github/ISSUE_TEMPLATE/refactor.yml

@@ -0,0 +1,10 @@
+name: Refactor
+title: ""
+description: Write something like "Modify the ... api endpoint to use ... version and ... framework" If you would like to use sweep.dev prefix with "Sweep:"
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Details
+      description: More details
+      placeholder: We are migrating this function to ... version because ...

.github/workflows/e2e.yml

@@ -0,0 +1,47 @@
+name: E2E Tests
+on:
+  push:
+    branches: [main]
+  pull_request:
+    paths:
+      - "packages/create-llama/**"
+      - ".github/workflows/e2e.yml"
+    branches: [main]
+
+jobs:
+  e2e:
+    name: create-llama
+    timeout-minutes: 60
+    strategy:
+      fail-fast: true
+      matrix:
+        node-version: [18, 20]
+        os: [macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v2
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "pnpm"
+      - name: Install dependencies
+        run: pnpm install
+      - name: Install Playwright Browsers
+        run: pnpm exec playwright install --with-deps
+        working-directory: ./packages/create-llama
+      - name: Build create-llama
+        run: pnpm run build
+        working-directory: ./packages/create-llama
+      - name: Run Playwright tests
+        run: pnpm exec playwright test
+        env: 
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+        working-directory: ./packages/create-llama
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: playwright-report
+          path: ./packages/create-llama/playwright-report/
+          retention-days: 30

.github/workflows/lint_on_push_or_pull.yml

@@ -0,0 +1,25 @@
+name: Lint on push or pull request
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: "pnpm"
+      - name: Install dependencies
+        run: pnpm install
+      - name: Run lint
+        run: pnpm run lint

.github/workflows/test.yml

@@ -0,0 +1,20 @@
+name: Run Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: "pnpm"
+      - name: Install dependencies
+        run: pnpm install
+      - name: Run tests
+        run: pnpm run test

.gitignore

@@ -3,6 +3,7 @@
 # dependencies
 node_modules
 .pnp
+.pnpm-store
 .pnp.js
 
 # testing
@@ -34,3 +35,17 @@ yarn-error.log*
 
 # vercel
 .vercel
+
+dist/
+
+# vs code
+.vscode/launch.json
+
+.cache
+test-results/
+playwright-report/
+blob-report/
+playwright/.cache/
+
+# intellij
+**/.idea

.husky/pre-commit

@@ -2,3 +2,4 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 pnpm lint
+npx lint-staged

.nvmrc

@@ -0,0 +1 @@
+18

.vscode/settings.json

@@ -1,5 +1,12 @@
 {
   "editor.tabSize": 2,
   "editor.formatOnSave": true,
-  "editor.defaultFormatter": "esbenp.prettier-vscode"
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "[xml]": {
+    "editor.defaultFormatter": "redhat.vscode-xml"
+  },
+  "jest.rootPath": "./packages/core",
+  "[python]": {
+    "editor.defaultFormatter": "ms-python.black-formatter"
+  }
 }

CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing
+
+## Structure
+
+This is a monorepo built with Turborepo
+
+Right now there are two packages of importance:
+
+packages/core which is the main NPM library llamaindex
+
+apps/simple is where the demo code lives
+
+### Turborepo docs
+
+You can checkout how Turborepo works using the default [README-turborepo.md](/README-turborepo.md)
+
+## Getting Started
+
+Install NodeJS. Preferably v18 using nvm or n.
+
+Inside the LlamaIndexTS directory:
+
+```
+npm i -g pnpm ts-node
+pnpm install
+```
+
+Note: we use pnpm in this repo, which has a lot of the same functionality and CLI options as npm but it does do some things better in a monorepo, like centralizing dependencies and caching.
+
+PNPM's has documentation on its [workspace feature](https://pnpm.io/workspaces) and Turborepo had some [useful documentation also](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks).
+
+### Running Typescript
+
+When we publish to NPM we will have a tsc compiled version of the library in JS. For now, the easiest thing to do is use ts-node.
+
+### Test cases
+
+To run them, run
+
+```
+pnpm run test
+```
+
+To write new test cases write them in [packages/core/src/tests](/packages/core/src/tests)
+
+We use Jest https://jestjs.io/ to write our test cases. Jest comes with a bunch of built in assertions using the expect function: https://jestjs.io/docs/expect
+
+### Demo applications
+
+There is an existing ["simple"](/apps/simple/README.md) demos folder with mainly NodeJS scripts. Feel free to add additional demos to that folder. If you would like to try out your changes in the core package with a new demo, you need to run the build command in the README.
+
+You can create new demo applications in the apps folder. Just run pnpm init in the folder after you create it to create its own package.json
+
+### Installing packages
+
+To install packages for a specific package or demo application, run
+
+```
+pnpm add [NPM Package] --filter [package or application i.e. core or simple]
+```
+
+To install packages for every package or application run
+
+```
+pnpm add -w [NPM Package]
+```
+
+### Docs
+
+To contribute to the docs, go to the docs website folder and run the Docusaurus instance.
+
+```bash
+cd apps/docs
+pnpm install
+pnpm start
+```
+
+That should start a webserver which will serve the docs on https://localhost:3000
+
+Any changes you make should be reflected in the browser. If you need to regenerate the API docs and find that your TSDoc isn't getting the updates, feel free to remove apps/docs/api. It will automatically regenerate itself when you run pnpm start again.

README.md

@@ -1,64 +1,129 @@
-# LlamaScript: LlamaIndex for TS/JS
+# LlamaIndex.TS
 
-## Structure
+LlamaIndex is a data framework for your LLM application.
 
-This is a monorepo built with Turborepo
+Use your own data with large language models (LLMs, OpenAI ChatGPT and others) in Typescript and Javascript.
 
-Right now there are two packages of importance:
+Documentation: https://ts.llamaindex.ai/
 
-packages/core which is the main NPM library @llamaindex/core
+## What is LlamaIndex.TS?
 
-apps/simple is where the demo code lives
+LlamaIndex.TS aims to be a lightweight, easy to use set of libraries to help you integrate large language models into your applications with your own data.
 
-### Turborepo docs
+## Getting started with an example:
 
-You can checkout how Turborepo works using the built in [README-turborepo.md](README-turborepo.md)
+LlamaIndex.TS requires Node v18 or higher. You can download it from https://nodejs.org or use https://nvm.sh (our preferred option).
 
-## Getting Started
+In a new folder:
 
-Install NodeJS. Preferably v18 using nvm or n.
-
-Inside the llamascript directory:
-
-```
-npm i -g pnpm ts-node
-pnpm install
+```bash
+export OPENAI_API_KEY="sk-......" # Replace with your key from https://platform.openai.com/account/api-keys
+pnpm init
+pnpm install typescript
+pnpm exec tsc --init # if needed
+pnpm install llamaindex
+pnpm install @types/node
 ```
 
-Note: we use pnpm in this repo, which has a lot of the same functionality and CLI options as npm but it does do some things better in a monorepo, like centralizing dependencies and caching.
+Create the file example.ts
 
-PNPM's has documentation on its [workspace feature](https://pnpm.io/workspaces) and Turborepo had some [useful documentation also](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks).
+```ts
+// example.ts
+import fs from "fs/promises";
+import { Document, VectorStoreIndex } from "llamaindex";
 
-### Running Typescript
+async function main() {
+  // Load essay from abramov.txt in Node
+  const essay = await fs.readFile(
+    "node_modules/llamaindex/examples/abramov.txt",
+    "utf-8",
+  );
 
-When we publish to NPM we will have a tsc compiled version of the library in JS. For now, the easiest thing to do is use ts-node.
+  // Create Document object with essay
+  const document = new Document({ text: essay });
 
-### Test cases
+  // Split text and create embeddings. Store them in a VectorStoreIndex
+  const index = await VectorStoreIndex.fromDocuments([document]);
 
-To run them, run
+  // Query the index
+  const queryEngine = index.asQueryEngine();
+  const response = await queryEngine.query(
+    "What did the author do in college?",
+  );
 
-```
-pnpm run test
+  // Output response
+  console.log(response.toString());
+}
+
+main();
 ```
 
-To write new test cases write them in packages/core/src/tests
+Then you can run it using
 
-We use Jest https://jestjs.io/ to write our test cases. Jest comes with a bunch of built in assertions using the expect function: https://jestjs.io/docs/expect
-
-### Demo applications
-
-You can create new demo applications in the apps folder. Just run pnpm init in the folder after you create it to create its own package.json
-
-### Installing packages
-
-To install packages for a specific package or demo application, run
-
-```
-pnpm add [NPM Package] --filter [package or application i.e. core or simple]
+```bash
+pnpx ts-node example.ts
 ```
 
-To install packages for every package or application run
+## Playground
 
+Check out our NextJS playground at https://llama-playground.vercel.app/. The source is available at https://github.com/run-llama/ts-playground
+
+## Core concepts for getting started:
+
+- [Document](/packages/core/src/Node.ts): A document represents a text file, PDF file or other contiguous piece of data.
+
+- [Node](/packages/core/src/Node.ts): The basic data building block. Most commonly, these are parts of the document split into manageable pieces that are small enough to be fed into an embedding model and LLM.
+
+- [Embedding](/packages/core/src/Embedding.ts): Embeddings are sets of floating point numbers which represent the data in a Node. By comparing the similarity of embeddings, we can derive an understanding of the similarity of two pieces of data. One use case is to compare the embedding of a question with the embeddings of our Nodes to see which Nodes may contain the data needed to answer that quesiton.
+
+- [Indices](/packages/core/src/indices/): Indices store the Nodes and the embeddings of those nodes. QueryEngines retrieve Nodes from these Indices using embedding similarity.
+
+- [QueryEngine](/packages/core/src/QueryEngine.ts): Query engines are what generate the query you put in and give you back the result. Query engines generally combine a pre-built prompt with selected Nodes from your Index to give the LLM the context it needs to answer your query.
+
+- [ChatEngine](/packages/core/src/ChatEngine.ts): A ChatEngine helps you build a chatbot that will interact with your Indices.
+
+- [SimplePrompt](/packages/core/src/Prompt.ts): A simple standardized function call definition that takes in inputs and formats them in a template literal. SimplePrompts can be specialized using currying and combined using other SimplePrompt functions.
+
+## Note: NextJS:
+
+If you're using NextJS App Router, you'll need to use the NodeJS runtime (default) and add the following config to your next.config.js to have it use imports/exports in the same way Node does.
+
+```js
+export const runtime = "nodejs"; // default
 ```
-pnpm add -w [NPM Package]
+
+```js
+// next.config.js
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  webpack: (config) => {
+    config.resolve.alias = {
+      ...config.resolve.alias,
+      sharp$: false,
+      "onnxruntime-node$": false,
+      mongodb$: false,
+    };
+    return config;
+  },
+  experimental: {
+    serverComponentsExternalPackages: ["pdf-parse"], // Puts pdf-parse in actual NodeJS mode with NextJS App Router
+  },
+};
+
+module.exports = nextConfig;
 ```
+
+## Supported LLMs:
+
+- OpenAI GPT-3.5-turbo and GPT-4
+- Anthropic Claude Instant and Claude 2
+- Llama2 Chat LLMs (70B, 13B, and 7B parameters)
+- MistralAI Chat LLMs
+
+## Contributing:
+
+We are in the very early days of LlamaIndex.TS. If you’re interested in hacking on it with us check out our [contributing guide](/CONTRIBUTING.md)
+
+## Bugs? Questions?
+
+Please join our Discord! https://discord.com/invite/eN6D2HQ4aX

apps/docs/.eslintrc.js

@@ -1,4 +0,0 @@
-module.exports = {
-  root: true,
-  extends: ["custom"],
-};

apps/docs/.gitignore

@@ -1,34 +1,20 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
-# dependencies
+# Dependencies
 /node_modules
-/.pnp
-.pnp.js
 
-# testing
-/coverage
-
-# next.js
-/.next/
-/out/
-
-# production
+# Production
 /build
 
-# misc
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
 .DS_Store
-*.pem
-
-# debug
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# local env files
 .env.local
 .env.development.local
 .env.test.local
 .env.production.local
 
-# vercel
-.vercel
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

apps/docs/README-docusaurus.md

@@ -0,0 +1,47 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ pnpm
+```
+
+### Local Development
+
+```
+$ pnpm start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+However, the searchbar may not function with `yarn start`. Instead, run `yarn build` and launch a server:
+
+```
+$ npx http-server ./build
+```
+
+### Build
+
+```
+$ pnpm build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true pnpm deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> pnpm deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

apps/docs/README.md

@@ -1,30 +0,0 @@
-## Getting Started
-
-First, run the development server:
-
-```bash
-yarn dev
-```
-
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-
-You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
-
-[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
-
-The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
-
-## Learn More
-
-To learn more about Next.js, take a look at the following resources:
-
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn/foundations/about-nextjs) - an interactive Next.js tutorial.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
-
-## Deploy on Vercel
-
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_source=github.com&utm_medium=referral&utm_campaign=turborepo-readme) from the creators of Next.js.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

apps/docs/app/layout.tsx

@@ -1,11 +0,0 @@
-export default function RootLayout({
-  children,
-}: {
-  children: React.ReactNode;
-}) {
-  return (
-    <html lang="en">
-      <body>{children}</body>
-    </html>
-  );
-}

apps/docs/app/page.tsx

@@ -1,10 +0,0 @@
-import { Button, Header } from "ui";
-
-export default function Page() {
-  return (
-    <>
-      <Header text="Docs" />
-      <Button />
-    </>
-  );
-}

apps/docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
+};

apps/docs/docs/.gitignore

@@ -0,0 +1 @@
+api/

apps/docs/docs/concepts.md

@@ -0,0 +1,78 @@
+---
+sidebar_position: 3
+---
+
+# High-Level Concepts
+
+LlamaIndex.TS helps you build LLM-powered applications (e.g. Q&A, chatbot) over custom data.
+
+In this high-level concepts guide, you will learn:
+
+- how an LLM can answer questions using your own data.
+- key concepts and modules in LlamaIndex.TS for composing your own query pipeline.
+
+## Answering Questions Across Your Data
+
+LlamaIndex uses a two stage method when using an LLM with your data:
+
+1. **indexing stage**: preparing a knowledge base, and
+2. **querying stage**: retrieving relevant context from the knowledge to assist the LLM in responding to a question
+
+![](./_static/concepts/rag.jpg)
+
+This process is also known as Retrieval Augmented Generation (RAG).
+
+LlamaIndex.TS provides the essential toolkit for making both steps super easy.
+
+Let's explore each stage in detail.
+
+### Indexing Stage
+
+LlamaIndex.TS help you prepare the knowledge base with a suite of data connectors and indexes.
+
+![](./_static/concepts/indexing.jpg)
+
+[**Data Loaders**](./modules/high_level/data_loader.md):
+A data connector (i.e. `Reader`) ingest data from different data sources and data formats into a simple `Document` representation (text and simple metadata).
+
+[**Documents / Nodes**](./modules/high_level/documents_and_nodes.md): A `Document` is a generic container around any data source - for instance, a PDF, an API output, or retrieved data from a database. A `Node` is the atomic unit of data in LlamaIndex and represents a "chunk" of a source `Document`. It's a rich representation that includes metadata and relationships (to other nodes) to enable accurate and expressive retrieval operations.
+
+[**Data Indexes**](./modules/high_level/data_index.md):
+Once you've ingested your data, LlamaIndex helps you index data into a format that's easy to retrieve.
+
+Under the hood, LlamaIndex parses the raw documents into intermediate representations, calculates vector embeddings, and stores your data in-memory or to disk.
+
+### Querying Stage
+
+In the querying stage, the query pipeline retrieves the most relevant context given a user query,
+and pass that to the LLM (along with the query) to synthesize a response.
+
+This gives the LLM up-to-date knowledge that is not in its original training data,
+(also reducing hallucination).
+
+The key challenge in the querying stage is retrieval, orchestration, and reasoning over (potentially many) knowledge bases.
+
+LlamaIndex provides composable modules that help you build and integrate RAG pipelines for Q&A (query engine), chatbot (chat engine), or as part of an agent.
+
+These building blocks can be customized to reflect ranking preferences, as well as composed to reason over multiple knowledge bases in a structured way.
+
+![](./_static/concepts/querying.jpg)
+
+#### Building Blocks
+
+[**Retrievers**](./modules/low_level/retriever.md):
+A retriever defines how to efficiently retrieve relevant context from a knowledge base (i.e. index) when given a query.
+The specific retrieval logic differs for difference indices, the most popular being dense retrieval against a vector index.
+
+[**Response Synthesizers**](./modules/low_level/response_synthesizer.md):
+A response synthesizer generates a response from an LLM, using a user query and a given set of retrieved text chunks.
+
+#### Pipelines
+
+[**Query Engines**](./modules/high_level/query_engine.md):
+A query engine is an end-to-end pipeline that allow you to ask question over your data.
+It takes in a natural language query, and returns a response, along with reference context retrieved and passed to the LLM.
+
+[**Chat Engines**](./modules/high_level/chat_engine.md):
+A chat engine is an end-to-end pipeline for having a conversation with your data
+(multiple back-and-forth instead of a single question & answer).

apps/docs/docs/end_to_end.md

@@ -0,0 +1,49 @@
+---
+sidebar_position: 4
+---
+
+# End to End Examples
+
+We include several end-to-end examples using LlamaIndex.TS in the repository
+
+Check out the examples below or try them out and complete them in minutes with interactive Github Codespace tutorials provided by Dev-Docs [here](https://codespaces.new/team-dev-docs/lits-dev-docs-playground?devcontainer_path=.devcontainer%2Fjavascript_ltsquickstart%2Fdevcontainer.json):
+
+## [Chat Engine](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/chatEngine.ts)
+
+Read a file and chat about it with the LLM.
+
+## [Vector Index](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/vectorIndex.ts)
+
+Create a vector index and query it. The vector index will use embeddings to fetch the top k most relevant nodes. By default, the top k is 2.
+
+## [Summary Index](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/summaryIndex.ts)
+
+Create a list index and query it. This example also use the `LLMRetriever`, which will use the LLM to select the best nodes to use when generating answer.
+
+## [Save / Load an Index](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/storageContext.ts)
+
+Create and load a vector index. Persistance to disk in LlamaIndex.TS happens automatically once a storage context object is created.
+
+## [Customized Vector Index](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/vectorIndexCustomize.ts)
+
+Create a vector index and query it, while also configuring the the `LLM`, the `ServiceContext`, and the `similarity_top_k`.
+
+## [OpenAI LLM](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/openai.ts)
+
+Create an OpenAI LLM and directly use it for chat.
+
+## [Llama2 DeuceLLM](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/llamadeuce.ts)
+
+Create a Llama-2 LLM and directly use it for chat.
+
+## [SubQuestionQueryEngine](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/subquestion.ts)
+
+Uses the `SubQuestionQueryEngine`, which breaks complex queries into multiple questions, and then aggreates a response across the answers to all sub-questions.
+
+## [Low Level Modules](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/lowlevel.ts)
+
+This example uses several low-level components, which removes the need for an actual query engine. These components can be used anywhere, in any application, or customized and sub-classed to meet your own needs.
+
+## [JSON Entity Extraction](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/jsonExtract.ts)
+
+Features OpenAI's chat API (using [`json_mode`](https://platform.openai.com/docs/guides/text-generation/json-mode)) to extract a JSON object from a sales call transcript.

apps/docs/docs/environments.md

@@ -0,0 +1,29 @@
+---
+sidebar_position: 5
+---
+
+# Environments
+
+LlamaIndex currently officially supports NodeJS 18 and NodeJS 20.
+
+## NextJS App Router
+
+If you're using NextJS App Router route handlers/serverless functions, you'll need to use the NodeJS mode:
+
+```js
+export const runtime = "nodejs"; // default
+```
+
+and you'll need to add an exception for pdf-parse in your next.config.js
+
+```js
+// next.config.js
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  experimental: {
+    serverComponentsExternalPackages: ["pdf-parse"], // Puts pdf-parse in actual NodeJS mode with NextJS App Router
+  },
+};
+
+module.exports = nextConfig;
+```

apps/docs/docs/installation.mdx

@@ -0,0 +1,63 @@
+---
+sidebar_position: 1
+---
+
+# Installation and Setup
+
+Make sure you have NodeJS v18 or higher.
+
+## Using create-llama
+
+The easiest way to get started with LlamaIndex is by using `create-llama`. This CLI tool enables you to quickly start building a new LlamaIndex application, with everything set up for you.
+
+Just run
+
+<Tabs>
+<TabItem value="1" label="npm" default>
+
+```bash
+npx create-llama@latest
+```
+
+</TabItem>
+<TabItem value="2" label="Yarn">
+
+```bash
+yarn create llama
+```
+
+</TabItem>
+<TabItem value="3" label="pnpm">
+
+```bash
+pnpm create llama@latest
+```
+
+</TabItem>
+</Tabs>
+
+to get started. Once your app is generated, run
+
+```bash npm2yarn
+npm run dev
+```
+
+to start the development server. You can then visit [http://localhost:3000](http://localhost:3000) to see your app
+
+## Installation from NPM
+
+```bash npm2yarn
+npm install llamaindex
+```
+
+### Environment variables
+
+Our examples use OpenAI by default. You'll need to set up your Open AI key like so:
+
+```bash
+export OPENAI_API_KEY="sk-......" # Replace with your key from https://platform.openai.com/account/api-keys
+```
+
+If you want to have it automatically loaded every time, add it to your .zshrc/.bashrc.
+
+WARNING: do not check in your OpenAI key into version control.

apps/docs/docs/introduction.md

@@ -0,0 +1,56 @@
+---
+sidebar_position: 0
+slug: /
+---
+
+# What is LlamaIndex.TS?
+
+LlamaIndex.TS is a data framework for LLM applications to ingest, structure, and access private or domain-specific data. While a python package is also available (see [here](https://docs.llamaindex.ai/en/stable/)), LlamaIndex.TS offers core features in a simple package, optimized for usage with TypeScript.
+
+## 🚀 Why LlamaIndex.TS?
+
+At their core, LLMs offer a natural language interface between humans and inferred data. Widely available models come pre-trained on huge amounts of publicly available data, from Wikipedia and mailing lists to textbooks and source code.
+
+Applications built on top of LLMs often require augmenting these models with private or domain-specific data. Unfortunately, that data can be distributed across siloed applications and data stores. It's behind APIs, in SQL databases, or trapped in PDFs and slide decks.
+
+That's where **LlamaIndex.TS** comes in.
+
+## 🦙 How can LlamaIndex.TS help?
+
+LlamaIndex.TS provides the following tools:
+
+- **Data loading** ingest your existing `.txt`, `.pdf`, `.csv`, `.md` and `.docx` data directly
+- **Data indexes** structure your data in intermediate representations that are easy and performant for LLMs to consume.
+- **Engines** provide natural language access to your data. For example:
+  - Query engines are powerful retrieval interfaces for knowledge-augmented output.
+  - Chat engines are conversational interfaces for multi-message, "back and forth" interactions with your data.
+
+## 👨‍👩‍👧‍👦 Who is LlamaIndex for?
+
+LlamaIndex.TS provides a core set of tools, essential for anyone building LLM apps with JavaScript and TypeScript.
+
+Our high-level API allows beginner users to use LlamaIndex.TS to ingest and query their data.
+
+For more complex applications, our lower-level APIs allow advanced users to customize and extend any module—data connectors, indices, retrievers, and query engines, to fit their needs.
+
+## Getting Started
+
+`npm install llamaindex`
+
+Our documentation includes [Installation Instructions](./installation.md) and a [Starter Tutorial](./starter.md) to build your first application.
+
+Once you're up and running, [High-Level Concepts](./concepts.md) has an overview of LlamaIndex's modular architecture. For more hands-on practical examples, look through our [End-to-End Tutorials](./end_to_end.md).
+
+## 🗺️ Ecosystem
+
+To download or contribute, find LlamaIndex on:
+
+- Github: https://github.com/run-llama/LlamaIndexTS
+- NPM: https://www.npmjs.com/package/llamaindex
+
+## Community
+
+Need help? Have a feature suggestion? Join the LlamaIndex community:
+
+- Twitter: https://twitter.com/llama_index
+- Discord https://discord.gg/dGcwcsnxhU

apps/docs/docs/modules/_category_.yml

@@ -0,0 +1,3 @@
+label: "Modules"
+collapsed: false
+position: 5

apps/docs/docs/modules/high_level/_category_.yml

@@ -0,0 +1 @@
+label: High-Level Modules

apps/docs/docs/modules/high_level/chat_engine.md

@@ -0,0 +1,20 @@
+---
+sidebar_position: 4
+---
+
+# ChatEngine
+
+The chat engine is a quick and simple way to chat with the data in your index.
+
+```typescript
+const retriever = index.asRetriever();
+const chatEngine = new ContextChatEngine({ retriever });
+
+// start chatting
+const response = await chatEngine.chat(query);
+```
+
+## Api References
+
+- [ContextChatEngine](../../api/classes/ContextChatEngine.md)
+- [CondenseQuestionChatEngine](../../api/classes/ContextChatEngine.md)

apps/docs/docs/modules/high_level/data_index.md

@@ -0,0 +1,23 @@
+---
+sidebar_position: 2
+---
+
+# Index
+
+An index is the basic container and organization for your data. LlamaIndex.TS supports two indexes:
+
+- `VectorStoreIndex` - will send the top-k `Node`s to the LLM when generating a response. The default top-k is 2.
+- `SummaryIndex` - will send every `Node` in the index to the LLM in order to generate a response
+
+```typescript
+import { Document, VectorStoreIndex } from "llamaindex";
+
+const document = new Document({ text: "test" });
+
+const index = await VectorStoreIndex.fromDocuments([document]);
+```
+
+## API Reference
+
+- [SummaryIndex](../../api/classes/SummaryIndex.md)
+- [VectorStoreIndex](../../api/classes/VectorStoreIndex.md)

apps/docs/docs/modules/high_level/data_loader.md

@@ -0,0 +1,17 @@
+---
+sidebar_position: 1
+---
+
+# Reader / Loader
+
+LlamaIndex.TS supports easy loading of files from folders using the `SimpleDirectoryReader` class. Currently, `.txt`, `.pdf`, `.csv`, `.md` and `.docx` files are supported, with more planned in the future!
+
+```typescript
+import { SimpleDirectoryReader } from "llamaindex";
+
+documents = new SimpleDirectoryReader().loadData("./data");
+```
+
+## API Reference
+
+- [SimpleDirectoryReader](../../api/classes/SimpleDirectoryReader.md)

apps/docs/docs/modules/high_level/documents_and_nodes.md

@@ -0,0 +1,18 @@
+---
+sidebar_position: 0
+---
+
+# Documents and Nodes
+
+`Document`s and `Node`s are the basic building blocks of any index. While the API for these objects is similar, `Document` objects represent entire files, while `Node`s are smaller pieces of that original document, that are suitable for an LLM and Q&A.
+
+```typescript
+import { Document } from "llamaindex";
+
+document = new Document({ text: "text", metadata: { key: "val" } });
+```
+
+## API Reference
+
+- [Document](../../api/classes/Document.md)
+- [TextNode](../../api/classes/TextNode.md)

apps/docs/docs/modules/high_level/query_engine.md

@@ -0,0 +1,36 @@
+---
+sidebar_position: 3
+---
+
+# QueryEngine
+
+A query engine wraps a `Retriever` and a `ResponseSynthesizer` into a pipeline, that will use the query string to fetech nodes and then send them to the LLM to generate a response.
+
+```typescript
+const queryEngine = index.asQueryEngine();
+const response = await queryEngine.query("query string");
+```
+
+## Sub Question Query Engine
+
+The basic concept of the Sub Question Query Engine is that it splits a single query into multiple queries, gets an answer for each of those queries, and then combines those different answers into a single coherent response for the user. You can think of it as the "think this through step by step" prompt technique but iterating over your data sources!
+
+### Getting Started
+
+The easiest way to start trying the Sub Question Query Engine is running the subquestion.ts file in [examples](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/subquestion.ts).
+
+```bash
+npx ts-node subquestion.ts
+```
+
+### Tools
+
+SubQuestionQueryEngine is implemented with Tools. The basic idea of Tools is that they are executable options for the large language model. In this case, our SubQuestionQueryEngine relies on QueryEngineTool, which as you guessed it is a tool to run queries on a QueryEngine. This allows us to give the model an option to query different documents for different questions for example. You could also imagine that the SubQuestionQueryEngine could use a Tool that searches for something on the web or gets an answer using Wolfram Alpha.
+
+You can learn more about Tools by taking a look at the LlamaIndex Python documentation https://gpt-index.readthedocs.io/en/latest/core_modules/agent_modules/tools/root.html
+
+## API Reference
+
+- [RetrieverQueryEngine](../../api/classes/RetrieverQueryEngine.md)
+- [SubQuestionQueryEngine](../../api/classes/SubQuestionQueryEngine.md)
+- [QueryEngineTool](../../api/interfaces/QueryEngineTool.md)

apps/docs/docs/modules/index.md

@@ -0,0 +1,31 @@
+# Core Modules
+
+LlamaIndex.TS offers several core modules, seperated into high-level modules for quickly getting started, and low-level modules for customizing key components as you need.
+
+## High-Level Modules
+
+- [**Document**](./high_level/documents_and_nodes.md): A document represents a text file, PDF file or other contiguous piece of data.
+
+- [**Node**](./high_level/documents_and_nodes.md): The basic data building block. Most commonly, these are parts of the document split into manageable pieces that are small enough to be fed into an embedding model and LLM.
+
+- [**Reader/Loader**](./high_level/data_loader.md): A reader or loader is something that takes in a document in the real world and transforms into a Document class that can then be used in your Index and queries. We currently support plain text files and PDFs with many many more to come.
+
+- [**Indexes**](./high_level/data_index.md): indexes store the Nodes and the embeddings of those nodes.
+
+- [**QueryEngine**](./high_level/query_engine.md): Query engines are what generate the query you put in and give you back the result. Query engines generally combine a pre-built prompt with selected nodes from your Index to give the LLM the context it needs to answer your query.
+
+- [**ChatEngine**](./high_level/chat_engine.md): A ChatEngine helps you build a chatbot that will interact with your Indexes.
+
+## Low Level Module
+
+- [**LLM**](./low_level/llm.md): The LLM class is a unified interface over a large language model provider such as OpenAI GPT-4, Anthropic Claude, or Meta LLaMA. You can subclass it to write a connector to your own large language model.
+
+- [**Embedding**](./low_level/embedding.md): An embedding is represented as a vector of floating point numbers. OpenAI's text-embedding-ada-002 is our default embedding model and each embedding it generates consists of 1,536 floating point numbers. Another popular embedding model is BERT which uses 768 floating point numbers to represent each Node. We provide a number of utilities to work with embeddings including 3 similarity calculation options and Maximum Marginal Relevance
+
+- [**TextSplitter/NodeParser**](./low_level/node_parser.md): Text splitting strategies are incredibly important to the overall efficacy of the embedding search. Currently, while we do have a default, there's no one size fits all solution. Depending on the source documents, you may want to use different splitting sizes and strategies. Currently we support spliltting by fixed size, splitting by fixed size with overlapping sections, splitting by sentence, and splitting by paragraph. The text splitter is used by the NodeParser when splitting `Document`s into `Node`s.
+
+- [**Retriever**](./low_level/retriever.md): The Retriever is what actually chooses the Nodes to retrieve from the index. Here, you may wish to try retrieving more or fewer Nodes per query, changing your similarity function, or creating your own retriever for each individual use case in your application. For example, you may wish to have a separate retriever for code content vs. text content.
+
+- [**ResponseSynthesizer**](./low_level/response_synthesizer.md): The ResponseSynthesizer is responsible for taking a query string, and using a list of `Node`s to generate a response. This can take many forms, like iterating over all the context and refining an answer, or building a tree of summaries and returning the root summary.
+
+- [**Storage**](./low_level/storage.md): At some point you're going to want to store your indexes, data and vectors instead of re-running the embedding models every time. IndexStore, DocStore, VectorStore, and KVStore are abstractions that let you do that. Combined, they form the StorageContext. Currently, we allow you to persist your embeddings in files on the filesystem (or a virtual in memory file system), but we are also actively adding integrations to Vector Databases.

apps/docs/docs/modules/low_level/_category_.yml

@@ -0,0 +1 @@
+label: Low-Level Modules

apps/docs/docs/modules/low_level/embedding.md

@@ -0,0 +1,22 @@
+---
+sidebar_position: 1
+---
+
+# Embedding
+
+The embedding model in LlamaIndex is responsible for creating numerical representations of text. By default, LlamaIndex will use the `text-embedding-ada-002` model from OpenAI.
+
+This can be explicitly set in the `ServiceContext` object.
+
+```typescript
+import { OpenAIEmbedding, serviceContextFromDefaults } from "llamaindex";
+
+const openaiEmbeds = new OpenAIEmbedding();
+
+const serviceContext = serviceContextFromDefaults({ embedModel: openaiEmbeds });
+```
+
+## API Reference
+
+- [OpenAIEmbedding](../../api/classes/OpenAIEmbedding.md)
+- [ServiceContext](../../api/interfaces/ServiceContext.md)

apps/docs/docs/modules/low_level/llm.md

@@ -0,0 +1,22 @@
+---
+sidebar_position: 0
+---
+
+# LLM
+
+The LLM is responsible for reading text and generating natural language responses to queries. By default, LlamaIndex.TS uses `gpt-3.5-turbo`.
+
+The LLM can be explicitly set in the `ServiceContext` object.
+
+```typescript
+import { OpenAI, serviceContextFromDefaults } from "llamaindex";
+
+const openaiLLM = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0 });
+
+const serviceContext = serviceContextFromDefaults({ llm: openaiLLM });
+```
+
+## API Reference
+
+- [OpenAI](../../api/classes/OpenAI.md)
+- [ServiceContext](../../api/interfaces/ServiceContext.md)

apps/docs/docs/modules/low_level/node_parser.md

@@ -0,0 +1,33 @@
+---
+sidebar_position: 3
+---
+
+# NodeParser
+
+The `NodeParser` in LlamaIndex is responbile for splitting `Document` objects into more manageable `Node` objects. When you call `.fromDocuments()`, the `NodeParser` from the `ServiceContext` is used to do this automatically for you. Alternatively, you can use it to split documents ahead of time.
+
+```typescript
+import { Document, SimpleNodeParser } from "llamaindex";
+
+const nodeParser = new SimpleNodeParser();
+const nodes = nodeParser.getNodesFromDocuments([
+  new Document({ text: "I am 10 years old. John is 20 years old." }),
+]);
+```
+
+## TextSplitter
+
+The underlying text splitter will split text by sentences. It can also be used as a standalone module for splitting raw text.
+
+```typescript
+import { SentenceSplitter } from "llamaindex";
+
+const splitter = new SentenceSplitter({ chunkSize: 1 });
+
+const textSplits = splitter.splitText("Hello World");
+```
+
+## API Reference
+
+- [SimpleNodeParser](../../api/classes/SimpleNodeParser.md)
+- [SentenceSplitter](../../api/classes/SentenceSplitter.md)

apps/docs/docs/modules/low_level/response_synthesizer.md

@@ -0,0 +1,51 @@
+---
+sidebar_position: 6
+---
+
+# ResponseSynthesizer
+
+The ResponseSynthesizer is responsible for sending the query, nodes, and prompt templates to the LLM to generate a response. There are a few key modes for generating a response:
+
+- `Refine`: "create and refine" an answer by sequentially going through each retrieved text chunk.
+  This makes a separate LLM call per Node. Good for more detailed answers.
+- `CompactAndRefine` (default): "compact" the prompt during each LLM call by stuffing as
+  many text chunks that can fit within the maximum prompt size. If there are
+  too many chunks to stuff in one prompt, "create and refine" an answer by going through
+  multiple compact prompts. The same as `refine`, but should result in less LLM calls.
+- `TreeSummarize`: Given a set of text chunks and the query, recursively construct a tree
+  and return the root node as the response. Good for summarization purposes.
+- `SimpleResponseBuilder`: Given a set of text chunks and the query, apply the query to each text
+  chunk while accumulating the responses into an array. Returns a concatenated string of all
+  responses. Good for when you need to run the same query separately against each text
+  chunk.
+
+```typescript
+import { NodeWithScore, ResponseSynthesizer, TextNode } from "llamaindex";
+
+const responseSynthesizer = new ResponseSynthesizer();
+
+const nodesWithScore: NodeWithScore[] = [
+  {
+    node: new TextNode({ text: "I am 10 years old." }),
+    score: 1,
+  },
+  {
+    node: new TextNode({ text: "John is 20 years old." }),
+    score: 0.5,
+  },
+];
+
+const response = await responseSynthesizer.synthesize(
+  "What age am I?",
+  nodesWithScore,
+);
+console.log(response.response);
+```
+
+## API Reference
+
+- [ResponseSynthesizer](../../api/classes/ResponseSynthesizer.md)
+- [Refine](../../api/classes/Refine.md)
+- [CompactAndRefine](../../api/classes/CompactAndRefine.md)
+- [TreeSummarize](../../api/classes/TreeSummarize.md)
+- [SimpleResponseBuilder](../../api/classes/SimpleResponseBuilder.md)

apps/docs/docs/modules/low_level/retriever.md

@@ -0,0 +1,21 @@
+---
+sidebar_position: 5
+---
+
+# Retriever
+
+A retriever in LlamaIndex is what is used to fetch `Node`s from an index using a query string. Aa `VectorIndexRetriever` will fetch the top-k most similar nodes. Meanwhile, a `SummaryIndexRetriever` will fetch all nodes no matter the query.
+
+```typescript
+const retriever = vector_index.asRetriever();
+retriever.similarityTopK = 3;
+
+// Fetch nodes!
+const nodesWithScore = await retriever.retrieve("query string");
+```
+
+## API Reference
+
+- [SummaryIndexRetriever](../../api/classes/SummaryIndexRetriever.md)
+- [SummaryIndexLLMRetriever](../../api/classes/SummaryIndexLLMRetriever.md)
+- [VectorIndexRetriever](../../api/classes/VectorIndexRetriever.md)

apps/docs/docs/modules/low_level/storage.md

@@ -0,0 +1,26 @@
+---
+sidebar_position: 7
+---
+
+# Storage
+
+Storage in LlamaIndex.TS works automatically once you've configured a `StorageContext` object. Just configure the `persistDir` and attach it to an index.
+
+Right now, only saving and loading from disk is supported, with future integrations planned!
+
+```typescript
+import { Document, VectorStoreIndex, storageContextFromDefaults } from "./src";
+
+const storageContext = await storageContextFromDefaults({
+  persistDir: "./storage",
+});
+
+const document = new Document({ text: "Test Text" });
+const index = await VectorStoreIndex.fromDocuments([document], {
+  storageContext,
+});
+```
+
+## API Reference
+
+- [StorageContext](../../api/interfaces/StorageContext.md)

apps/docs/docs/starter.md

@@ -0,0 +1,56 @@
+---
+sidebar_position: 2
+---
+
+# Starter Tutorial
+
+Once you have [installed LlamaIndex.TS using NPM](installation) and set up your OpenAI key, you're ready to start your first app:
+
+In a new folder:
+
+```bash npm2yarn
+npm install typescript
+npm install @types/node
+npx tsc --init # if needed
+```
+
+Create the file `example.ts`. This code will load some example data, create a document, index it (which creates embeddings using OpenAI), and then creates query engine to answer questions about the data.
+
+```ts
+// example.ts
+import fs from "fs/promises";
+import { Document, VectorStoreIndex } from "llamaindex";
+
+async function main() {
+  // Load essay from abramov.txt in Node
+  const essay = await fs.readFile(
+    "node_modules/llamaindex/examples/abramov.txt",
+    "utf-8",
+  );
+
+  // Create Document object with essay
+  const document = new Document({ text: essay });
+
+  // Split text and create embeddings. Store them in a VectorStoreIndex
+  const index = await VectorStoreIndex.fromDocuments([document]);
+
+  // Query the index
+  const queryEngine = index.asQueryEngine();
+  const response = await queryEngine.query(
+    "What did the author do in college?",
+  );
+
+  // Output response
+  console.log(response.toString());
+}
+
+main();
+```
+
+Then you can run it using
+
+```bash
+npx ts-node example.ts
+```
+
+Ready to learn more? Check out our NextJS playground at https://llama-playground.vercel.app/. The source is available at https://github.com/run-llama/ts-playground

apps/docs/docusaurus.config.js

@@ -0,0 +1,176 @@
+// @ts-check
+// Note: type annotations allow type checking and IDEs autocompletion
+
+const lightCodeTheme = require("prism-react-renderer/themes/github");
+const darkCodeTheme = require("prism-react-renderer/themes/dracula");
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+  title: "LlamaIndex.TS",
+  tagline: "Unleash the power of LLMs over your data in TypeScript",
+  favicon: "img/favicon.png",
+
+  // Set the production url of your site here
+  url: "https://ts.llamaindex.ai",
+  // Set the /<baseUrl>/ pathname under which your site is served
+  // For GitHub pages deployment, it is often '/<projectName>/'
+  baseUrl: "/",
+
+  // GitHub pages deployment config.
+  // If you aren't using GitHub pages, you don't need these.
+  organizationName: "run-llama", // Usually your GitHub org/user name.
+  projectName: "LlamaIndex.TS", // Usually your repo name.
+
+  onBrokenLinks: "warn",
+  onBrokenMarkdownLinks: "warn",
+
+  // Even if you don't use internalization, you can use this field to set useful
+  // metadata like html lang. For example, if your site is Chinese, you may want
+  // to replace "en" with "zh-Hans".
+  i18n: {
+    defaultLocale: "en",
+    locales: [
+    "en", 
+    "zh-Hans", 
+    "es",
+    "fr",
+    "de",
+    "ja",
+    "ko",
+    "pt",
+    "ar",
+    "it",
+    "tr",
+    "pl",
+    "nl",
+    "vi",
+    "th",
+    ], // "fa", "ru", "ro", "sv", "hu", "cs", "el", "da", "fi", "he", "no", "hi", "in", "sl", "se", "sk", "uk", "bg", "hr", "lt", "lv", "et", "cat"
+  },
+
+  presets: [
+    [
+      "classic",
+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({
+        docs: {
+          routeBasePath: "/",
+          sidebarPath: require.resolve("./sidebars.js"),
+          // Please change this to your repo.
+          // Remove this to remove the "edit this page" links.
+          // editUrl:
+          //   "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
+          remarkPlugins: [
+            [require("@docusaurus/remark-plugin-npm2yarn"), { sync: true }],
+          ],
+        },
+        blog: false,
+        gtag: {
+          trackingID: 'G-NB9B8LW9W5',
+          anonymizeIP: true,
+        },
+    }),
+    ],
+  ],
+
+  themeConfig:
+    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+    ({
+      // Replace with your project's social card
+      image: "img/favicon.png", // TODO change this
+      navbar: {
+        title: "LlamaIndex.TS",
+        logo: {
+          alt: "LlamaIndex.TS",
+          src: "img/favicon.png",
+        },
+        items: [
+          {
+            type: "docSidebar",
+            sidebarId: "mySidebar",
+            position: "left",
+            label: "Docs",
+          },
+          {
+            type: "localeDropdown",
+            position: "left",
+          },
+          {
+            href: "https://github.com/run-llama/LlamaIndexTS",
+            label: "GitHub",
+            position: "right",
+          },
+        ],
+      },
+      footer: {
+        style: "dark",
+        links: [
+          {
+            title: "Docs",
+            items: [
+              {
+                label: "API",
+                to: "/api",
+              },
+            ],
+          },
+          {
+            title: "Community",
+            items: [
+              {
+                label: "Discord",
+                href: "https://discord.com/invite/eN6D2HQ4aX",
+              },
+              {
+                label: "Twitter",
+                href: "https://twitter.com/LlamaIndex",
+              },
+            ],
+          },
+          {
+            title: "More",
+            items: [
+              {
+                label: "GitHub",
+                href: "https://github.com/run-llama/LlamaIndexTS",
+              },
+            ],
+          },
+        ],
+        copyright: `Copyright © ${new Date().getFullYear()} LlamaIndex. Built with Docusaurus.`,
+      },
+      prism: {
+        theme: lightCodeTheme,
+        darkTheme: darkCodeTheme,
+      },
+      algolia: {
+        // The application ID provided by Algolia
+        appId: "DYKPM6G4CX",
+
+        // Public API key: it is safe to commit it
+        apiKey: "c4ff3789f20bb72a5d735082aef17719",
+
+        indexName: "ts-llamaindex",
+
+        // Optional: see doc section below
+        contextualSearch: true,
+      },
+    }),
+  plugins: [
+    [
+      "docusaurus-plugin-typedoc",
+      {
+        entryPoints: ["../../packages/core/src/index.ts"],
+        tsconfig: "../../packages/core/tsconfig.json",
+        readme: "none",
+        sourceLinkTemplate:
+          "https://github.com/run-llama/LlamaIndexTS/blob/{gitRevision}/{path}#L{line}",
+        sidebar: {
+          position: 6,
+        },
+      },
+    ],
+  ],
+};
+
+module.exports = config;

apps/docs/i18n/ar/docusaurus-plugin-content-docs/current/api

@@ -0,0 +1 @@
+../../../../docs/api

apps/docs/i18n/ar/docusaurus-plugin-content-docs/current/concepts.md

@@ -0,0 +1,86 @@
+---
+sidebar_position: 3
+---
+
+# المفاهيم على المستوى العالي
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+يساعدك LlamaIndex.TS في بناء تطبيقات قائمة على LLM (مثل Q&A و chatbot) على بيانات مخصصة.
+
+في هذا الدليل عن المفاهيم على المستوى العالي، ستتعلم:
+
+- كيف يمكن لـ LLM الإجابة على الأسئلة باستخدام بياناتك الخاصة.
+- المفاهيم الرئيسية والوحدات في LlamaIndex.TS لبناء خط أنابيب الاستعلام الخاص بك.
+
+## الإجابة على الأسئلة عبر بياناتك
+
+يستخدم LlamaIndex طريقة مكونة من مرحلتين عند استخدام LLM مع بياناتك:
+
+1. **مرحلة الفهرسة**: إعداد قاعدة المعرفة، و
+2. **مرحلة الاستعلام**: استرداد السياق ذي الصلة من المعرفة لمساعدة LLM في الاستجابة لسؤال
+
+![](./_static/concepts/rag.jpg)
+
+تُعرف هذه العملية أيضًا باسم "استرجاع معزز للتوليد" (RAG).
+
+يوفر LlamaIndex.TS أدوات أساسية لجعل كلا المرحلتين سهلتين للغاية.
+
+دعنا نستكشف كل مرحلة بالتفصيل.
+
+### مرحلة الفهرسة
+
+يساعدك LlamaIndex.TS في إعداد قاعدة المعرفة باستخدام مجموعة من موصلات البيانات والفهارس.
+
+![](./_static/concepts/indexing.jpg)
+
+[**محمّلات البيانات**](./modules/high_level/data_loader.md):
+موصل البيانات (أي `Reader`) يقوم بتجميع البيانات من مصادر بيانات مختلفة وتنسيقات بيانات مختلفة في تمثيل بسيط للـ `Document` (نص وبيانات تعريفية بسيطة).
+
+[**المستندات / العقد**](./modules/high_level/documents_and_nodes.md): المستند هو حاوية عامة حول أي مصدر بيانات - على سبيل المثال، ملف PDF، نتائج واجهة برمجة التطبيقات، أو بيانات استرداد من قاعدة بيانات. العقد هو الوحدة الذرية للبيانات في LlamaIndex ويمثل "قطعة" من المستند الأصلي. إنه تمثيل غني يتضمن بيانات تعريفية وعلاقات (مع عقد أخرى) لتمكين عمليات الاسترجاع الدقيقة والتعبيرية.
+
+[**فهارس البيانات**](./modules/high_level/data_index.md):
+بمجرد أن تقوم بتجميع بياناتك، يساعدك LlamaIndex في فهرسة البيانات في تنسيق سهل الاسترداد.
+
+تحت الغطاء، يقوم LlamaIndex بتحليل المستندات الخام إلى تمثيلات وسيطة، وحساب تضمينات الناقلات، وتخزين بياناتك في الذاكرة أو على القرص.
+
+"
+
+### مرحلة الاستعلام
+
+في مرحلة الاستعلام، يقوم خط الأنابيب للاستعلام بجلب السياق الأكثر صلة بناءً على استعلام المستخدم،
+ويمرر ذلك إلى LLM (جنبًا إلى جنب مع الاستعلام) لتوليد استجابة.
+
+يمنح ذلك LLM معرفة محدثة ليست موجودة في بيانات التدريب الأصلية لديه،
+(مما يقلل أيضًا من الهلوسة).
+
+التحدي الرئيسي في مرحلة الاستعلام هو الاسترجاع والتنسيق والاستدلال عبر قواعد المعرفة (المحتملة).
+
+يوفر LlamaIndex وحدات قابلة للتركيب تساعدك في بناء ودمج خطوط أنابيب RAG لـ Q&A (محرك الاستعلام)، chatbot (محرك الدردشة)، أو كجزء من وكيل.
+
+يمكن تخصيص هذه الكتل البنائية لتعكس تفضيلات التصنيف، وكذلك تركيبها للاستدلال عبر عدة قواعد معرفة بطريقة منظمة.
+
+![](./_static/concepts/querying.jpg)
+
+#### الكتل الأساسية
+
+[**مسترجعات**](./modules/low_level/retriever.md):
+يحدد المسترجع كيفية استرجاع السياق ذي الصلة بكفاءة من قاعدة المعرفة (أي الفهرس) عند إعطاء استعلام.
+تختلف منطق الاسترجاع المحددة حسب الفهارس المختلفة، والأكثر شيوعًا هو الاسترجاع الكثيف ضد فهرس الناقل.
+
+[**مركبات الاستجابة**](./modules/low_level/response_synthesizer.md):
+تقوم مركبة الاستجابة بتوليد استجابة من LLM باستخدام استعلام المستخدم ومجموعة معينة من أجزاء النص المسترجعة.
+
+"
+
+#### خطوط الأنابيب
+
+[**محركات الاستعلام**](./modules/high_level/query_engine.md):
+محرك الاستعلام هو خط أنابيب شامل يتيح لك طرح الأسئلة على بياناتك.
+يأخذ استعلامًا بلغة طبيعية ويعيد استجابة، جنبًا إلى جنب مع السياق المرجعي المسترجع والممرر إلى LLM.
+
+[**محركات الدردشة**](./modules/high_level/chat_engine.md):
+محرك الدردشة هو خط أنابيب شامل لإجراء محادثة مع بياناتك
+(عدة تفاعلات بدلاً من سؤال وجواب واحد).
+
+"

apps/docs/i18n/ar/docusaurus-plugin-content-docs/current/end_to_end.md

@@ -0,0 +1,61 @@
+---
+sidebar_position: 4
+---
+
+# أمثلة من البداية إلى النهاية
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+نقدم العديد من الأمثلة من البداية إلى النهاية باستخدام LlamaIndex.TS في المستودع
+
+تحقق من الأمثلة أدناه أو جربها وأكملها في دقائق مع دروس تفاعلية على Github Codespace المقدمة من Dev-Docs [هنا](https://codespaces.new/team-dev-docs/lits-dev-docs-playground?devcontainer_path=.devcontainer%2Fjavascript_ltsquickstart%2Fdevcontainer.json):
+
+## [محرك الدردشة](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/chatEngine.ts)
+
+اقرأ ملفًا وتحدث عنه مع LLM.
+
+## [فهرس الفيكتور](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/vectorIndex.ts)
+
+إنشاء فهرس فيكتور واستعلامه. سيستخدم فهرس الفيكتور التضمينات لاسترداد أعلى k عقد ذات صلة. بشكل افتراضي ، يكون k الأعلى هو 2.
+
+"
+
+## [مؤشر الملخص](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/summaryIndex.ts)
+
+إنشاء مؤشر قائمة واستعلامه. يستخدم هذا المثال أيضًا `LLMRetriever` ، الذي سيستخدم LLM لتحديد أفضل العقد لاستخدامها عند إنشاء الإجابة.
+
+"
+
+## [حفظ / تحميل فهرس](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/storageContext.ts)
+
+إنشاء وتحميل فهرس ناقل. يحدث التخزين المؤقت على القرص تلقائيًا في LlamaIndex.TS بمجرد إنشاء كائن سياق التخزين.
+
+"
+
+## [فهرس الناقل المخصص](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/vectorIndexCustomize.ts)
+
+إنشاء فهرس ناقل واستعلامه، مع تكوين `LLM` و `ServiceContext` و `similarity_top_k`.
+
+"
+
+## [OpenAI LLM](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/openai.ts)
+
+أنشئ OpenAI LLM واستخدمه مباشرة للدردشة.
+
+"
+
+## [Llama2 DeuceLLM](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/llamadeuce.ts)
+
+إنشاء Llama-2 LLM واستخدامه مباشرة للدردشة.
+
+"
+
+## [محرك استعلام الأسئلة الفرعية](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/subquestion.ts)
+
+يستخدم `محرك استعلام الأسئلة الفرعية` الذي يقسم الاستعلامات المعقدة إلى أسئلة فرعية متعددة، ثم يجمع الاستجابة عبر الإجابات على جميع الأسئلة الفرعية.
+
+"
+
+## [وحدات منخفضة المستوى](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/lowlevel.ts)
+
+يستخدم هذا المثال العديد من المكونات منخفضة المستوى، مما يزيل الحاجة إلى محرك استعلام فعلي. يمكن استخدام هذه المكونات في أي مكان، في أي تطبيق، أو تخصيصها وتصنيفها الفرعي لتلبية احتياجاتك الخاصة.

apps/docs/i18n/ar/docusaurus-plugin-content-docs/current/environments.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 5
+---
+
+# البيئات
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+يدعم LlamaIndex حاليًا رسميًا NodeJS 18 و NodeJS 20.
+
+## NextJS App Router
+
+إذا كنت تستخدم معالج الطرق / الوظائف الخادمة في NextJS App Router ، فستحتاج إلى استخدام وضع NodeJS:
+
+```js
+export const runtime = "nodejs"; // الافتراضي
+```
+
+وستحتاج أيضًا إلى إضافة استثناء لـ pdf-parse في next.config.js الخاص بك
+
+```js
+// next.config.js
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  experimental: {
+    serverComponentsExternalPackages: ["pdf-parse"], // يضع pdf-parse في وضع NodeJS الفعلي مع NextJS App Router
+  },
+};
+
+module.exports = nextConfig;
+```

apps/docs/i18n/ar/docusaurus-plugin-content-docs/current/installation.mdx

@@ -0,0 +1,71 @@
+---
+sidebar_position: 1
+---
+
+
+# التثبيت والإعداد
+
+```تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.```
+
+
+تأكد من أن لديك NodeJS v18 أو أحدث.
+
+
+## باستخدام create-llama
+
+أسهل طريقة للبدء مع LlamaIndex هي باستخدام `create-llama`. هذه الأداة سطر الأوامر تمكنك من بدء بناء تطبيق LlamaIndex جديد بسرعة، مع كل شيء معد لك.
+
+ما عليك سوى تشغيل
+
+<Tabs>
+<TabItem value="1" label="npm" default>
+
+```bash
+npx create-llama@latest
+```
+
+</TabItem>
+<TabItem value="2" label="Yarn">
+
+```bash
+yarn create llama
+```
+
+</TabItem>
+<TabItem value="3" label="pnpm">
+
+```bash
+pnpm create llama@latest
+```
+
+</TabItem>
+</Tabs>
+
+للبدء. بمجرد إنشاء التطبيق الخاص بك، قم بتشغيل
+
+```bash npm2yarn
+npm run dev
+```
+
+لبدء خادم التطوير. يمكنك ثم زيارة [http://localhost:3000](http://localhost:3000) لرؤية تطبيقك.
+## التثبيت من NPM
+
+```bash npm2yarn
+npm install llamaindex
+```
+
+
+### المتغيرات البيئية
+
+تستخدم أمثلتنا OpenAI افتراضيًا. ستحتاج إلى إعداد مفتاح Open AI الخاص بك على النحو التالي:
+
+```bash
+export OPENAI_API_KEY="sk-......" # استبدله بالمفتاح الخاص بك من https://platform.openai.com/account/api-keys
+```
+
+إذا كنت ترغب في تحميله تلقائيًا في كل مرة، قم بإضافته إلى ملف .zshrc/.bashrc الخاص بك.
+
+تحذير: لا تقم بإضافة مفتاح OpenAI الخاص بك إلى نظام التحكم في الإصدارات.
+
+
+"

apps/docs/i18n/ar/docusaurus-plugin-content-docs/current/introduction.md

@@ -0,0 +1,60 @@
+---
+sidebar_position: 0
+slug: /
+---
+
+# ما هو LlamaIndex.TS؟
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+LlamaIndex.TS هو إطار بيانات لتطبيقات LLM لاستيعاب وتنظيم والوصول إلى البيانات الخاصة أو الخاصة بالمجال. في حين أن حزمة Python متاحة أيضًا (انظر [هنا](https://docs.llamaindex.ai/en/stable/)), يوفر LlamaIndex.TS ميزات أساسية في حزمة بسيطة ، محسنة للاستخدام مع TypeScript.
+
+## 🚀 لماذا LlamaIndex.TS؟
+
+في جوهرها ، توفر LLMs واجهة لغة طبيعية بين البشر والبيانات المستنتجة. تأتي النماذج المتاحة على نطاق واسع محملة مسبقًا بكميات هائلة من البيانات المتاحة للجمهور ، من ويكيبيديا وقوائم البريد الإلكتروني إلى الكتب المدرسية وشفرة المصدر.
+
+غالبًا ما تتطلب التطبيقات المبنية على LLMs تعزيز هذه النماذج بالبيانات الخاصة أو الخاصة بالمجال. للأسف ، يمكن توزيع هذه البيانات عبر تطبيقات ومخازن بيانات معزولة. إنها خلف واجهات برمجة التطبيقات ، في قواعد البيانات SQL ، أو محبوسة في ملفات PDF وعروض تقديمية.
+
+هنا يأتي دور **LlamaIndex.TS**.
+
+## 🦙 كيف يمكن أن يساعد LlamaIndex.TS؟
+
+يوفر LlamaIndex.TS الأدوات التالية:
+
+- **تحميل البيانات**: استيعاب البيانات الحالية الخاصة بك بتنسيقات `.txt`, `.pdf`, `.csv`, `.md` و `.docx` مباشرة.
+- **فهارس البيانات**: تنظيم البيانات الخاصة بك في تمثيلات وسيطة سهلة وفعالة للاستخدام من قبل LLMs.
+- **المحركات**: توفر واجهات الوصول إلى اللغة الطبيعية لبياناتك. على سبيل المثال:
+  - محركات الاستعلام هي واجهات استرجاع قوية للإخراج المعزز بالمعرفة.
+  - محركات الدردشة هي واجهات محادثة للتفاعلات "ذهابًا وإيابًا" متعددة الرسائل مع بياناتك.
+
+## 👨‍👩‍👧‍👦 من أجل من هو LlamaIndex؟
+
+يوفر LlamaIndex.TS مجموعة أدوات أساسية ، ضرورية لأي شخص يقوم ببناء تطبيقات LLM باستخدام JavaScript و TypeScript.
+
+يتيح لنا واجهة برمجة التطبيقات على مستوى عالي استخدام LlamaIndex.TS لاستيعاب واستعلام البيانات الخاصة بهم.
+
+بالنسبة للتطبيقات المعقدة أكثر ، تتيح لنا واجهات برمجة التطبيقات على مستوى أدنى للمستخدمين المتقدمين تخصيص وتوسيع أي وحدة - موصلات البيانات والفهارس وأجهزة الاسترجاع ومحركات الاستعلام - لتناسب احتياجاتهم.
+
+## البدء
+
+`npm install llamaindex`
+
+تتضمن وثائقنا [تعليمات التثبيت](./installation.md) و[دليل البداية](./starter.md) لبناء تطبيقك الأول.
+
+بمجرد أن تكون جاهزًا وتعمل ، يحتوي [مفاهيم عالية المستوى](./concepts.md) على نظرة عامة على الهندسة المعمارية المتعددة المستويات لـ LlamaIndex. لمزيد من الأمثلة العملية التفصيلية ، يمكنك الاطلاع على [دروس النهاية إلى النهاية](./end_to_end.md).
+
+## 🗺️ النظام البيئي
+
+لتنزيل أو المساهمة ، ابحث عن LlamaIndex على:
+
+- Github: https://github.com/run-llama/LlamaIndexTS
+- NPM: https://www.npmjs.com/package/llamaindex
+
+"
+
+## المجتمع
+
+هل تحتاج إلى مساعدة؟ هل لديك اقتراح لميزة؟ انضم إلى مجتمع LlamaIndex:
+
+- تويتر: https://twitter.com/llama_index
+- ديسكورد: https://discord.gg/dGcwcsnxhU

apps/docs/i18n/ar/docusaurus-plugin-content-docs/current/modules/high_level/chat_engine.md

@@ -0,0 +1,22 @@
+---
+sidebar_position: 4
+---
+
+# محرك الدردشة (ChatEngine)
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+محرك الدردشة هو طريقة سريعة وبسيطة للدردشة مع البيانات في الفهرس الخاص بك.
+
+```typescript
+const retriever = index.asRetriever();
+const chatEngine = new ContextChatEngine({ retriever });
+
+// بدء الدردشة
+const response = await chatEngine.chat(query);
+```
+
+## مراجع الواجهة البرمجية
+
+- [محرك الدردشة السياقي (ContextChatEngine)](../../api/classes/ContextChatEngine.md)
+- [محرك الدردشة المكثف للأسئلة (CondenseQuestionChatEngine)](../../api/classes/ContextChatEngine.md)

apps/docs/i18n/ar/docusaurus-plugin-content-docs/current/modules/high_level/data_index.md

@@ -0,0 +1,27 @@
+---
+sidebar_position: 2
+---
+
+# الفهرس
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+الفهرس هو الحاوية الأساسية والتنظيم لبياناتك. يدعم LlamaIndex.TS نوعين من الفهارس:
+
+- `VectorStoreIndex` - سيقوم بإرسال أعلى `Node` الموجودة إلى LLM عند إنشاء استجابة. القيمة الافتراضية لأعلى `k` هي 2.
+- `SummaryIndex` - سيقوم بإرسال كل `Node` في الفهرس إلى LLM لإنشاء استجابة.
+
+```typescript
+import { Document, VectorStoreIndex } from "llamaindex";
+
+const document = new Document({ text: "اختبار" });
+
+const index = await VectorStoreIndex.fromDocuments([document]);
+```
+
+## مرجع الواجهة البرمجية
+
+- [SummaryIndex](../../api/classes/SummaryIndex.md)
+- [VectorStoreIndex](../../api/classes/VectorStoreIndex.md)
+
+"

apps/docs/i18n/ar/docusaurus-plugin-content-docs/current/modules/high_level/data_loader.md

@@ -0,0 +1,19 @@
+---
+sidebar_position: 1
+---
+
+# قارئ / محمل
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+يدعم LlamaIndex.TS تحميل الملفات بسهولة من المجلدات باستخدام فئة `SimpleDirectoryReader`. حاليًا ، يتم دعم الملفات `.txt` ، `.pdf` ، `.csv` ، `.md` و `.docx` ، مع المزيد المخطط له في المستقبل!
+
+```typescript
+import { SimpleDirectoryReader } from "llamaindex";
+
+documents = new SimpleDirectoryReader().loadData("./data");
+```
+
+## مرجع الواجهة البرمجية
+
+- [SimpleDirectoryReader](../../api/classes/SimpleDirectoryReader.md)

apps/docs/i18n/ar/docusaurus-plugin-content-docs/current/modules/high_level/documents_and_nodes.md

@@ -0,0 +1,22 @@
+---
+sidebar_position: 0
+---
+
+# المستندات والعقد
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+`المستندات` و `العقد` هما العناصر الأساسية لأي فهرس. بينما يكون واجهة برمجة التطبيق (API) لهذه الكائنات مشابهة، يُمثل كائن `المستند` ملفات كاملة، بينما تكون `العقد` قطعًا أصغر من ذلك المستند الأصلي، والتي تكون مناسبة لـ LLM و Q&A.
+
+```typescript
+import { Document } from "llamaindex";
+
+document = new Document({ text: "نص", metadata: { key: "val" } });
+```
+
+## مرجع الواجهة البرمجية
+
+- [المستند (Document)](../../api/classes/Document.md)
+- [نص العقد (TextNode)](../../api/classes/TextNode.md)
+
+"

apps/docs/i18n/ar/docusaurus-plugin-content-docs/current/modules/high_level/query_engine.md

@@ -0,0 +1,42 @@
+---
+sidebar_position: 3
+---
+
+# محرك الاستعلامات (QueryEngine)
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+يقوم محرك الاستعلامات بتجميع "Retriever" و "ResponseSynthesizer" في أنبوبة، والتي ستستخدم سلسلة الاستعلام لاسترداد العقد ومن ثم إرسالها إلى LLM لتوليد استجابة.
+
+```typescript
+const queryEngine = index.asQueryEngine();
+const response = await queryEngine.query("سلسلة الاستعلام");
+```
+
+## محرك الاستعلام للأسئلة الفرعية
+
+الفكرة الأساسية لمحرك الاستعلام للأسئلة الفرعية هي تقسيم استعلام واحد إلى استعلامات متعددة، والحصول على إجابة لكل من تلك الاستعلامات، ثم دمج تلك الإجابات المختلفة في استجابة واحدة متسقة للمستخدم. يمكنك أن تفكر فيها كتقنية "فكر في ذلك خطوة بخطوة" ولكن بتكرار مصادر البيانات الخاصة بك!
+
+### البدء
+
+أسهل طريقة لبدء تجربة محرك الاستعلام للأسئلة الفرعية هي تشغيل ملف subquestion.ts في [examples](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/subquestion.ts).
+
+```bash
+npx ts-node subquestion.ts
+```
+
+"
+
+### الأدوات
+
+يتم تنفيذ محرك الاستعلام للأسئلة الفرعية باستخدام الأدوات. الفكرة الأساسية للأدوات هي أنها خيارات قابلة للتنفيذ لنموذج اللغة الكبيرة. في هذه الحالة، يعتمد محرك الاستعلام للأسئلة الفرعية على أداة QueryEngineTool، والتي كما تخمن هي أداة لتشغيل استعلامات على محرك الاستعلام. يتيح لنا ذلك إعطاء النموذج خيارًا للاستعلام عن وثائق مختلفة لأسئلة مختلفة على سبيل المثال. يمكنك أيضًا أن تتخيل أن محرك الاستعلام للأسئلة الفرعية يمكنه استخدام أداة تبحث عن شيء ما على الويب أو تحصل على إجابة باستخدام Wolfram Alpha.
+
+يمكنك معرفة المزيد عن الأدوات من خلال الاطلاع على وثائق LlamaIndex Python https://gpt-index.readthedocs.io/en/latest/core_modules/agent_modules/tools/root.html
+
+"
+
+## مرجع واجهة برمجة التطبيق (API)
+
+- [محرك استعلام الاسترجاع (RetrieverQueryEngine)](../../api/classes/RetrieverQueryEngine.md)
+- [محرك استعلام السؤال الفرعي (SubQuestionQueryEngine)](../../api/classes/SubQuestionQueryEngine.md)
+- [أداة محرك الاستعلام (QueryEngineTool)](../../api/interfaces/QueryEngineTool.md)

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

@@ -0,0 +1,33 @@
+# الوحدات الأساسية
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+يوفر LlamaIndex.TS عدة وحدات أساسية، مقسمة إلى وحدات عالية المستوى للبدء السريع ووحدات منخفضة المستوى لتخصيص المكونات الرئيسية حسب الحاجة.
+
+## وحدات عالية المستوى
+
+- [**المستند**](./high_level/documents_and_nodes.md): يمثل المستند ملف نصي أو ملف PDF أو قطعة بيانات متتابعة أخرى.
+
+- [**العقدة**](./high_level/documents_and_nodes.md): هو البناء الأساسي للبيانات. في أغلب الأحيان، تكون هذه أجزاء من المستند المقسمة إلى قطع قابلة للإدارة وصغيرة بما يكفي ليتم تغذيتها إلى نموذج التضمين و LLM.
+
+- [**القارئ/المحمل**](./high_level/data_loader.md): القارئ أو المحمل هو شيء يأخذ المستند في العالم الحقيقي ويحوله إلى فئة المستند التي يمكن استخدامها في الفهرس الخاص بك والاستعلامات. ندعم حاليًا ملفات النص العادي وملفات PDF والمزيد الكثير.
+
+- [**الفهارس**](./high_level/data_index.md): تخزن الفهارس العقد وتضمينات تلك العقد.
+
+- [**محرك الاستعلامات**](./high_level/query_engine.md): محركات الاستعلامات هي التي تولد الاستعلام الذي تدخله وتعيد لك النتيجة. عمومًا، تجمع محركات الاستعلامات بين تعليمة مسبقة مبنية مع العقد المحددة من الفهرس الخاص بك لتعطي LLM السياق الذي يحتاجه للإجابة على استعلامك.
+
+- [**محرك الدردشة**](./high_level/chat_engine.md): يساعدك محرك الدردشة على بناء روبوت دردشة سيتفاعل مع فهرسك.
+
+## وحدة منخفضة المستوى
+
+- [**LLM**](./low_level/llm.md): فئة LLM هي واجهة موحدة فوق مزود نموذج لغة كبير مثل OpenAI GPT-4 أو Anthropic Claude أو Meta LLaMA. يمكنك توريثها لكتابة موصل إلى نموذج اللغة الخاص بك.
+
+- [**Embedding**](./low_level/embedding.md): يتم تمثيل التضمين كمتجه من الأرقام العائمة. نموذج التضمين الافتراضي لدينا هو text-embedding-ada-002 من OpenAI ويتكون كل تضمين يولده من 1,536 رقمًا عائمًا. نموذج التضمين الشائع الآخر هو BERT الذي يستخدم 768 رقمًا عائمًا لتمثيل كل عقدة. نوفر عددًا من الأدوات للعمل مع التضمين بما في ذلك 3 خيارات لحساب التشابه و Maximum Marginal Relevance.
+
+- [**TextSplitter/NodeParser**](./low_level/node_parser.md): تعتبر استراتيجيات تقسيم النصوص مهمة للغاية لفعالية البحث في التضمين. حاليًا، على الرغم من أن لدينا قيمة افتراضية، إلا أنه لا يوجد حلاً مناسبًا للجميع. اعتمادًا على وثائق المصدر، قد ترغب في استخدام أحجام واستراتيجيات تقسيم مختلفة. حاليًا، ندعم التقسيم حسب الحجم الثابت، التقسيم حسب الحجم الثابت مع أجزاء تتداخل، التقسيم حسب الجملة، والتقسيم حسب الفقرة. يتم استخدام مقسم النصوص بواسطة NodeParser عند تقسيم `Document` إلى `Node`.
+
+- [**Retriever**](./low_level/retriever.md): يقوم Retriever بتحديد العقد التي يتم استردادها من الفهرس. هنا، قد ترغب في محاولة استرداد عدد أكبر أو أقل من العقد لكل استعلام، تغيير وظيفة التشابه الخاصة بك، أو إنشاء استرداد خاص بك لكل حالة استخدام فردية في تطبيقك. على سبيل المثال، قد ترغب في وجود استرداد منفصل لمحتوى الشفرة مقابل محتوى النص.
+
+- [**ResponseSynthesizer**](./low_level/response_synthesizer.md): يتحمل ResponseSynthesizer مسؤولية أخذ سلسلة استعلام واستخدام قائمة من العقد لإنشاء استجابة. يمكن أن يأخذ هذا الشكل العديد من الأشكال، مثل التكرار عبر جميع السياق وتحسين الإجابة، أو بناء شجرة من الملخصات وإرجاع الملخص الجذري.
+
+- [**Storage**](./low_level/storage.md): في نقطة ما، سترغب في تخزين الفهارس والبيانات والمتجهات بدلاً من إعادة تشغيل نماذج التضمين في كل مرة. IndexStore و DocStore و VectorStore و KVStore هي تجريدات تتيح لك ذلك. مجتمعة، تشكل هذه التجريدات سياق التخزين. حاليًا، نسمح لك بالاحتفاظ بالتضمينات الخاصة بك في ملفات على نظام الملفات (أو نظام ملفات افتراضي في الذاكرة)، ولكننا نضيف أيضًا تكاملات مع قواعد بيانات المتجهات.

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

@@ -0,0 +1,26 @@
+---
+sidebar_position: 1
+---
+
+# تضمين
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+يتولى النموذج المضمن في LlamaIndex إنشاء تمثيلات رقمية للنص. بشكل افتراضي ، ستستخدم LlamaIndex نموذج `text-embedding-ada-002` من OpenAI.
+
+يمكن تعيين ذلك بشكل صريح في كائن `ServiceContext`.
+
+```typescript
+import { OpenAIEmbedding, serviceContextFromDefaults } from "llamaindex";
+
+const openaiEmbeds = new OpenAIEmbedding();
+
+const serviceContext = serviceContextFromDefaults({ embedModel: openaiEmbeds });
+```
+
+## مرجع الواجهة البرمجية
+
+- [OpenAIEmbedding](../../api/classes/OpenAIEmbedding.md)
+- [ServiceContext](../../api/interfaces/ServiceContext.md)
+
+"

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

@@ -0,0 +1,26 @@
+---
+sidebar_position: 0
+---
+
+# LLM
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+يتولى LLM قراءة النص وتوليد استجابات لغوية طبيعية للاستفسارات. بشكل افتراضي ، يستخدم LlamaIndex.TS `gpt-3.5-turbo`.
+
+يمكن تعيين LLM بشكل صريح في كائن `ServiceContext`.
+
+```typescript
+import { OpenAI, serviceContextFromDefaults } from "llamaindex";
+
+const openaiLLM = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0 });
+
+const serviceContext = serviceContextFromDefaults({ llm: openaiLLM });
+```
+
+## مرجع الواجهة البرمجية
+
+- [OpenAI](../../api/classes/OpenAI.md)
+- [ServiceContext](../../api/interfaces/ServiceContext.md)
+
+"

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

@@ -0,0 +1,37 @@
+---
+sidebar_position: 3
+---
+
+# NodeParser (محلل العقدة)
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+`NodeParser` في LlamaIndex مسؤول عن تقسيم كائنات `Document` إلى كائنات `Node` أكثر إدارة. عند استدعاء `.fromDocuments()`, يتم استخدام `NodeParser` من `ServiceContext` للقيام بذلك تلقائيًا بالنسبة لك. بدلاً من ذلك ، يمكنك استخدامه لتقسيم المستندات مسبقًا.
+
+```typescript
+import { Document, SimpleNodeParser } from "llamaindex";
+
+const nodeParser = new SimpleNodeParser();
+const nodes = nodeParser.getNodesFromDocuments([
+  new Document({ text: "أنا عمري 10 سنوات. جون عمره 20 سنة." }),
+]);
+```
+
+## TextSplitter (مقسم النص)
+
+سيقوم مقسم النص الأساسي بتقسيم النص إلى جمل. يمكن أيضًا استخدامه كوحدة مستقلة لتقسيم النص الخام.
+
+```typescript
+import { SentenceSplitter } from "llamaindex";
+
+const splitter = new SentenceSplitter({ chunkSize: 1 });
+
+const textSplits = splitter.splitText("مرحبًا بالعالم");
+```
+
+## مرجع الواجهة البرمجية
+
+- [SimpleNodeParser (محلل العقدة البسيط)](../../api/classes/SimpleNodeParser.md)
+- [SentenceSplitter (مقسم الجمل)](../../api/classes/SentenceSplitter.md)
+
+"

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

@@ -0,0 +1,45 @@
+---
+sidebar_position: 6
+---
+
+# مركب الاستجابة (ResponseSynthesizer)
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+مركب الاستجابة (ResponseSynthesizer) مسؤول عن إرسال الاستعلام والعقد وقوالب الاستفسار إلى LLM لتوليد استجابة. هناك بعض وسائط رئيسية لتوليد استجابة:
+
+- `تحسين`: "إنشاء وتحسين" إجابة عن طريق المرور تتاليًا عبر كل قطعة نص مُسترجعة. يتم إجراء استدعاء LLM منفصل لكل عقدة. جيد للإجابات المفصلة.
+- `مضغوط وتحسين` (الافتراضي): "ضغط" الاستفسار أثناء كل استدعاء LLM عن طريق حشو أكبر عدد ممكن من قطع النص التي يمكن أن تتناسب مع حجم الاستفسار الأقصى. إذا كان هناك الكثير من القطع لتعبئتها في استفسار واحد، "إنشاء وتحسين" إجابة عن طريق المرور بعدة استفسارات مضغوطة. نفس العملية كـ `تحسين`، ولكن يجب أن تؤدي إلى مزيد من استدعاءات LLM أقل.
+- `ملخص الشجرة`: بناء شجرة بشكل متكرر بناءً على مجموعة من قطع النص والاستعلام، وإرجاع العقدة الجذرية كاستجابة. جيد لأغراض التلخيص.
+- `منشئ الاستجابة البسيط`: تطبيق الاستعلام على كل قطعة نص وتجميع الاستجابات في مصفوفة. يعيد سلسلة متصلة من جميع الاستجابات. جيد عندما تحتاج إلى تشغيل نفس الاستعلام بشكل منفصل على كل قطعة نص.
+
+```typescript
+import { NodeWithScore, ResponseSynthesizer, TextNode } from "llamaindex";
+
+const responseSynthesizer = new ResponseSynthesizer();
+
+const nodesWithScore: NodeWithScore[] = [
+  {
+    node: new TextNode({ text: "أنا عمري 10 سنوات." }),
+    score: 1,
+  },
+  {
+    node: new TextNode({ text: "جون عمره 20 سنة." }),
+    score: 0.5,
+  },
+];
+
+const response = await responseSynthesizer.synthesize(
+  "ما هو عمري؟",
+  nodesWithScore,
+);
+console.log(response.response);
+```
+
+## مرجع الواجهة البرمجية
+
+- [مركب الاستجابة (ResponseSynthesizer)](../../api/classes/ResponseSynthesizer.md)
+- [تحسين (Refine)](../../api/classes/Refine.md)
+- [مضغوط وتحسين (CompactAndRefine)](../../api/classes/CompactAndRefine.md)
+- [ملخص الشجرة (TreeSummarize)](../../api/classes/TreeSummarize.md)
+- [منشئ الاستجابة البسيط (SimpleResponseBuilder)](../../api/classes/SimpleResponseBuilder.md)

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

@@ -0,0 +1,23 @@
+---
+sidebar_position: 5
+---
+
+# الباحث (Retriever)
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+الباحث في LlamaIndex هو ما يُستخدم لاسترداد العقد (`Node`) من فهرس باستخدام سلسلة الاستعلام. سيقوم الباحث `VectorIndexRetriever` بجلب أعلى k عقد مشابهة. بينما سيقوم الباحث `SummaryIndexRetriever` بجلب جميع العقد بغض النظر عن الاستعلام.
+
+```typescript
+const retriever = vector_index.asRetriever();
+retriever.similarityTopK = 3;
+
+// جلب العقد!
+const nodesWithScore = await retriever.retrieve("سلسلة الاستعلام");
+```
+
+## مرجع الواجهة البرمجية (API Reference)
+
+- [SummaryIndexRetriever](../../api/classes/SummaryIndexRetriever.md)
+- [SummaryIndexLLMRetriever](../../api/classes/SummaryIndexLLMRetriever.md)
+- [VectorIndexRetriever](../../api/classes/VectorIndexRetriever.md)

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

@@ -0,0 +1,30 @@
+---
+sidebar_position: 7
+---
+
+# التخزين
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+يعمل التخزين في LlamaIndex.TS تلقائيًا بمجرد تكوين كائن `StorageContext`. قم بتكوين `persistDir` وربطه بفهرس.
+
+في الوقت الحالي ، يتم دعم حفظ وتحميل البيانات من القرص فقط ، مع وجود تكاملات مستقبلية مخططة!
+
+```typescript
+import { Document, VectorStoreIndex, storageContextFromDefaults } from "./src";
+
+const storageContext = await storageContextFromDefaults({
+  persistDir: "./storage",
+});
+
+const document = new Document({ text: "نص اختبار" });
+const index = await VectorStoreIndex.fromDocuments([document], {
+  storageContext,
+});
+```
+
+## مرجع الواجهة البرمجية
+
+- [StorageContext](../../api/interfaces/StorageContext.md)
+
+"

apps/docs/i18n/ar/docusaurus-plugin-content-docs/current/starter.md

@@ -0,0 +1,58 @@
+---
+sidebar_position: 2
+---
+
+# دليل البداية
+
+`تمت ترجمة هذه الوثيقة تلقائيًا وقد تحتوي على أخطاء. لا تتردد في فتح طلب سحب لاقتراح تغييرات.`
+
+بمجرد [تثبيت LlamaIndex.TS باستخدام NPM](installation) وإعداد مفتاح OpenAI الخاص بك، أنت الآن جاهز لبدء تطبيقك الأول:
+
+في مجلد جديد:
+
+```bash npm2yarn
+npm install typescript
+npm install @types/node
+npx tsc --init # إذا لزم الأمر
+```
+
+أنشئ ملف `example.ts`. سيقوم هذا الكود بتحميل بعض البيانات المثالية، وإنشاء وثيقة، وفهرسة الوثيقة (مما ينشئ تضمينات باستخدام OpenAI)، ثم إنشاء محرك الاستعلام للإجابة على الأسئلة حول البيانات.
+
+```ts
+// example.ts
+import fs from "fs/promises";
+import { Document, VectorStoreIndex } from "llamaindex";
+
+async function main() {
+  // تحميل المقالة من abramov.txt في Node
+  const essay = await fs.readFile(
+    "node_modules/llamaindex/examples/abramov.txt",
+    "utf-8",
+  );
+
+  // إنشاء كائن Document بواسطة المقالة
+  const document = new Document({ text: essay });
+
+  // تقسيم النص وإنشاء التضمينات. تخزينها في VectorStoreIndex
+  const index = await VectorStoreIndex.fromDocuments([document]);
+
+  // استعلام الفهرس
+  const queryEngine = index.asQueryEngine();
+  const response = await queryEngine.query("ماذا فعل الكاتب في الكلية؟");
+
+  // إخراج الاستجابة
+  console.log(response.toString());
+}
+
+main();
+```
+
+ثم يمكنك تشغيله باستخدام
+
+```bash
+npx ts-node example.ts
+```
+
+هل أنت مستعد للمزيد من التعلم؟ تفضل بزيارة منصة NextJS الخاصة بنا على https://llama-playground.vercel.app/. يمكنك العثور على المصدر على https://github.com/run-llama/ts-playground
+
+"

apps/docs/i18n/bg/docusaurus-plugin-content-docs/current/api

@@ -0,0 +1 @@
+../../../../docs/api

apps/docs/i18n/bg/docusaurus-plugin-content-docs/current/concepts.md

@@ -0,0 +1,86 @@
+---
+sidebar_position: 3
+---
+
+# Високо ниво на концепции
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+LlamaIndex.TS ви помага да създавате приложения, базирани на LLM (например Q&A, чатбот) върху персонализирани данни.
+
+В това ръководство за високо ниво на концепции ще научите:
+
+- как LLM може да отговори на въпроси, използвайки вашите собствени данни.
+- ключови концепции и модули в LlamaIndex.TS за създаване на ваша собствена заявка.
+
+## Отговаряне на въпроси върху вашите данни
+
+LlamaIndex използва двустепенен метод при използване на LLM с вашите данни:
+
+1. **стъпка за индексиране**: подготовка на база от знания и
+2. **стъпка за заявка**: извличане на съответния контекст от знанията, за да помогне на LLM да отговори на въпрос
+
+![](./_static/concepts/rag.jpg)
+
+Този процес е известен също като Retrieval Augmented Generation (RAG).
+
+LlamaIndex.TS предоставя основния инструментариум, който прави и двете стъпки изключително лесни.
+
+Нека изследваме всяка стъпка подробно.
+
+### Стъпка на индексиране
+
+LlamaIndex.TS ви помага да подготвите базата от знания с помощта на набор от конектори за данни и индекси.
+
+![](./_static/concepts/indexing.jpg)
+
+[**Data Loaders**](./modules/high_level/data_loader.md):
+Конектор за данни (т.е. `Reader`) поема данни от различни източници на данни и формати на данни и ги превръща в просто представяне на `Document` (текст и прости метаданни).
+
+[**Documents / Nodes**](./modules/high_level/documents_and_nodes.md): `Document` е общ контейнер за всякакъв вид данни - например PDF, изход от API или извлечени данни от база данни. `Node` е атомарната единица от данни в LlamaIndex и представлява "част" от източниковия `Document`. Това е богато представяне, което включва метаданни и връзки (към други възли), за да позволи точни и изразителни операции за извличане.
+
+[**Data Indexes**](./modules/high_level/data_index.md):
+След като сте поели данните си, LlamaIndex ви помага да индексирате данните във формат, който е лесен за извличане.
+
+Под капака, LlamaIndex анализира суровите документи в промеждинни представяния, изчислява векторни вложения и съхранява данните в паметта или на диска.
+
+"
+
+### Стъпка за заявка
+
+В стъпката за заявка, конвейерът за заявки извлича най-съответния контекст, даден на потребителска заявка,
+и го предава на LLM (заедно със заявката), за да синтезира отговор.
+
+Това дава на LLM актуални познания, които не са в неговите оригинални обучаващи данни,
+(също така намалява халюцинацията).
+
+Основното предизвикателство в стъпката за заявка е извличането, организирането и резонирането върху (потенциално много) бази от знания.
+
+LlamaIndex предоставя модули, които могат да се комбинират и помагат за създаването и интегрирането на RAG конвейери за Q&A (заявки), чатбот (чат двигател) или като част от агент.
+
+Тези строителни блокове могат да бъдат персонализирани, за да отразяват предпочитанията за ранжиране, както и да бъдат комбинирани, за да резонират върху множество бази от знания по структуриран начин.
+
+![](./_static/concepts/querying.jpg)
+
+#### Строителни блокове
+
+[**Извличатели**](./modules/low_level/retriever.md):
+Извличател дефинира как да се извлича ефективно съответния контекст от база от знания (т.е. индекс), когато се предостави заявка.
+Конкретната логика за извличане се различава за различни индекси, като най-популярното е плътно извличане срещу векторен индекс.
+
+[**Синтезатори на отговори**](./modules/low_level/response_synthesizer.md):
+Синтезаторът на отговор генерира отговор от LLM, използвайки потребителска заявка и даден набор от извлечени текстови части.
+
+"
+
+#### Конвейери
+
+[**Заявки**](./modules/high_level/query_engine.md):
+Заявката е цялостен конвейер, който ви позволява да задавате въпроси относно вашите данни.
+Тя приема заявка на естествен език и връща отговор, заедно с извлечения контекст, предаден на LLM.
+
+[**Чат двигатели**](./modules/high_level/chat_engine.md):
+Чат двигателът е цялостен конвейер за провеждане на разговор с вашите данни
+(множество въпроси и отговори вместо единичен въпрос и отговор).
+
+"

apps/docs/i18n/bg/docusaurus-plugin-content-docs/current/end_to_end.md

@@ -0,0 +1,57 @@
+---
+sidebar_position: 4
+---
+
+# Примери от начало до край
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+Включени са няколко примера от начало до край, използвайки LlamaIndex.TS в хранилището
+
+Разгледайте примерите по-долу или ги опитайте и завършете за минути с интерактивни уроци на Github Codespace, предоставени от Dev-Docs [тук](https://codespaces.new/team-dev-docs/lits-dev-docs-playground?devcontainer_path=.devcontainer%2Fjavascript_ltsquickstart%2Fdevcontainer.json):
+
+## [Чат двигател (Chat Engine)](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/chatEngine.ts)
+
+Прочетете файл и обсъждайте го с LLM.
+
+## [Векторен индекс](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/vectorIndex.ts)
+
+Създайте векторен индекс и го запитайте. Векторният индекс ще използва вграждания, за да извлече най-релевантните k върха. По подразбиране, k е 2.
+
+"
+
+## [Summary Index](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/summaryIndex.ts)
+
+Създайте списъчен индекс и го заявете. Този пример също използва `LLMRetriever`, който използва LLM, за да избере най-добрите възли за използване при генериране на отговор.
+
+"
+
+## [Запазване / Зареждане на индекс](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/storageContext.ts)
+
+Създайте и заредете векторен индекс. Запазването на диска в LlamaIndex.TS става автоматично, веднага след като е създаден обект за контекст на съхранение.
+
+## [Персонализиран векторен индекс](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/vectorIndexCustomize.ts)
+
+Създайте векторен индекс и го заявете, като конфигурирате `LLM`, `ServiceContext` и `similarity_top_k`.
+
+"
+
+## [OpenAI LLM](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/openai.ts)
+
+Създайте OpenAI LLM и го използвайте директно за чат.
+
+## [Llama2 DeuceLLM](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/llamadeuce.ts)
+
+Създайте Llama-2 LLM и го използвайте директно за чат.
+
+## [SubQuestionQueryEngine](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/subquestion.ts)
+
+Използва `SubQuestionQueryEngine`, който разбива сложни заявки на множество въпроси и след това агрегира отговорите на всички под-въпроси.
+
+"
+
+## [Модули с ниско ниво](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/lowlevel.ts)
+
+Този пример използва няколко компонента с ниско ниво, които премахват нуждата от реален двигател за заявки. Тези компоненти могат да се използват навсякъде, във всяко приложение или да бъдат персонализирани и подкласирани, за да отговарят на вашите нужди.
+
+"

apps/docs/i18n/bg/docusaurus-plugin-content-docs/current/environments.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 5
+---
+
+# Среди
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+LlamaIndex в момента официално поддържа NodeJS 18 и NodeJS 20.
+
+## NextJS App Router
+
+Ако използвате обработчици на маршрути/сървърни функции на NextJS App Router, ще трябва да използвате режима на NodeJS:
+
+```js
+export const runtime = "nodejs"; // по подразбиране
+```
+
+и ще трябва да добавите изключение за pdf-parse във вашия next.config.js
+
+```js
+// next.config.js
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  experimental: {
+    serverComponentsExternalPackages: ["pdf-parse"], // Поставя pdf-parse в реален режим на NodeJS с NextJS App Router
+  },
+};
+
+module.exports = nextConfig;
+```

apps/docs/i18n/bg/docusaurus-plugin-content-docs/current/installation.mdx

@@ -0,0 +1,68 @@
+---
+sidebar_position: 1
+---
+
+
+# Инсталация и настройка
+
+```Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.```
+
+
+Уверете се, че имате NodeJS v18 или по-нова версия.
+
+
+## Използване на create-llama
+
+Най-лесният начин да започнете с LlamaIndex е чрез използването на `create-llama`. Този инструмент с команден ред ви позволява бързо да започнете да създавате ново приложение LlamaIndex, като всичко е настроено за вас.
+
+Просто изпълнете
+
+<Tabs>
+<TabItem value="1" label="npm" default>
+
+```bash
+npx create-llama@latest
+```
+
+</TabItem>
+<TabItem value="2" label="Yarn">
+
+```bash
+yarn create llama
+```
+
+</TabItem>
+<TabItem value="3" label="pnpm">
+
+```bash
+pnpm create llama@latest
+```
+
+</TabItem>
+</Tabs>
+
+за да започнете. След като приложението ви е генерирано, изпълнете
+
+```bash npm2yarn
+npm run dev
+```
+
+за да стартирате сървъра за разработка. След това можете да посетите [http://localhost:3000](http://localhost:3000), за да видите вашето приложение.
+## Инсталация от NPM
+
+```bash npm2yarn
+npm install llamaindex
+```
+
+
+### Променливи на средата
+
+Нашият пример използва OpenAI по подразбиране. Ще трябва да настроите вашия Open AI ключ по следния начин:
+
+```bash
+export OPENAI_API_KEY="sk-......" # Заменете с вашия ключ от https://platform.openai.com/account/api-keys
+```
+
+Ако искате да го зареждате автоматично всеки път, добавете го към вашия .zshrc/.bashrc.
+
+ВНИМАНИЕ: не добавяйте вашия OpenAI ключ в системата за контрол на версиите.

apps/docs/i18n/bg/docusaurus-plugin-content-docs/current/introduction.md

@@ -0,0 +1,62 @@
+---
+sidebar_position: 0
+slug: /
+---
+
+# Какво е LlamaIndex.TS?
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+LlamaIndex.TS е рамка за данни за приложения на LLM, която позволява внасяне, структуриране и достъп до частни или специфични за домейна данни. Въпреки че има наличен и пакет на Python (вижте [тук](https://docs.llamaindex.ai/en/stable/)), LlamaIndex.TS предлага основни функции в едно просто пакетиране, оптимизирано за използване с TypeScript.
+
+## 🚀 Защо LlamaIndex.TS?
+
+В основата си, LLM-ите предлагат естествен езиков интерфейс между хората и изводените данни. Широко разпространените модели са предварително обучени на голямо количество публично достъпни данни, от Уикипедия и списания до учебници и изходен код.
+
+Приложенията, построени върху LLM-и, често изискват допълване на тези модели с частни или специфични за домейна данни. За съжаление, тези данни могат да бъдат разпределени в различни приложения и хранилища на данни. Те се намират зад API-и, в SQL бази данни или са затворени в PDF файлове и презентации.
+
+Тук идва **LlamaIndex.TS**.
+
+## 🦙 Как може да помогне LlamaIndex.TS?
+
+LlamaIndex.TS предоставя следните инструменти:
+
+- **Зареждане на данни** - внасяйте вашите съществуващи данни във формат `.txt`, `.pdf`, `.csv`, `.md` и `.docx` директно
+- **Индекси на данни** - структурирайте данните си в промежуточни представяния, които са лесни и ефективни за консумация от LLM.
+- **Двигатели** - предоставят достъп до вашите данни чрез естествен език. Например:
+  - Заявителни двигатели са мощни интерфейси за извличане на знания.
+  - Чат двигатели са разговорни интерфейси за многократни, "напред и назад" взаимодействия с вашите данни.
+
+"
+
+## 👨‍👩‍👧‍👦 За кого е LlamaIndex?
+
+LlamaIndex.TS предоставя основен набор от инструменти, необходими за всеки, който създава LLM приложения с JavaScript и TypeScript.
+
+Нашето API на високо ниво позволява на начинаещите потребители да използват LlamaIndex.TS за внасяне и заявка на техните данни.
+
+За по-сложни приложения нашите API на по-ниско ниво позволяват на напредналите потребители да персонализират и разширят всяко модул - връзки с данни, индекси, извличатели и заявки, за да отговарят на техните нужди.
+
+## Започване
+
+`npm install llamaindex`
+
+Документацията ни включва [Инструкции за инсталиране](./installation.md) и [Урок за начинаещи](./starter.md), за да построите първото си приложение.
+
+След като сте готови, [Високо ниво концепции](./concepts.md) представя общ преглед на модулната архитектура на LlamaIndex. За повече практически примери, разгледайте нашите [Уроци от начало до край](./end_to_end.md).
+
+## 🗺️ Екосистема
+
+За да изтеглите или допринесете, намерете LlamaIndex на:
+
+- Github: https://github.com/run-llama/LlamaIndexTS
+- NPM: https://www.npmjs.com/package/llamaindex
+
+"
+
+## Общност
+
+Нуждаете се от помощ? Имате предложение за функционалност? Присъединете се към общността на LlamaIndex:
+
+- Twitter: https://twitter.com/llama_index
+- Discord: https://discord.gg/dGcwcsnxhU

apps/docs/i18n/bg/docusaurus-plugin-content-docs/current/modules/high_level/chat_engine.md

@@ -0,0 +1,24 @@
+---
+sidebar_position: 4
+---
+
+# Чат двигател (ChatEngine)
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+Чат двигателят е бърз и прост начин да чатите с данните във вашата индекс.
+
+```typescript
+const retriever = index.asRetriever();
+const chatEngine = new ContextChatEngine({ retriever });
+
+// започнете да чатите
+const response = await chatEngine.chat(query);
+```
+
+## Api Референции
+
+- [Чат двигател за контекст (ContextChatEngine)](../../api/classes/ContextChatEngine.md)
+- [Чат двигател за кондензиране на въпроси (CondenseQuestionChatEngine)](../../api/classes/ContextChatEngine.md)
+
+"

apps/docs/i18n/bg/docusaurus-plugin-content-docs/current/modules/high_level/data_index.md

@@ -0,0 +1,27 @@
+---
+sidebar_position: 2
+---
+
+# Индекс
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+Индексът е основният контейнер и организация за вашите данни. LlamaIndex.TS поддържа два вида индекси:
+
+- `VectorStoreIndex` - ще изпраща най-добрите `Node` до LLM при генериране на отговор. По подразбиране, най-добрите два.
+- `SummaryIndex` - ще изпраща всеки `Node` в индекса до LLM, за да генерира отговор.
+
+```typescript
+import { Document, VectorStoreIndex } from "llamaindex";
+
+const document = new Document({ text: "тест" });
+
+const index = await VectorStoreIndex.fromDocuments([document]);
+```
+
+## API Референция
+
+- [SummaryIndex](../../api/classes/SummaryIndex.md)
+- [VectorStoreIndex](../../api/classes/VectorStoreIndex.md)
+
+"

apps/docs/i18n/bg/docusaurus-plugin-content-docs/current/modules/high_level/data_loader.md

@@ -0,0 +1,21 @@
+---
+sidebar_position: 1
+---
+
+# Четец / Зареждач
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+LlamaIndex.TS поддържа лесно зареждане на файлове от папки с помощта на класа `SimpleDirectoryReader`. В момента се поддържат файлове с разширения `.txt`, `.pdf`, `.csv`, `.md` и `.docx`, с планове за добавяне на още в бъдеще!
+
+```typescript
+import { SimpleDirectoryReader } from "llamaindex";
+
+documents = new SimpleDirectoryReader().loadData("./data");
+```
+
+## API Референция
+
+- [SimpleDirectoryReader](../../api/classes/SimpleDirectoryReader.md)
+
+"

apps/docs/i18n/bg/docusaurus-plugin-content-docs/current/modules/high_level/documents_and_nodes.md

@@ -0,0 +1,22 @@
+---
+sidebar_position: 0
+---
+
+# Документи и Възли
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+`Документи` и `Възли` са основните строителни блокове на всяко индексиране. Въпреки че API-то за тези обекти е подобно, обектите `Документ` представляват цели файлове, докато `Възли` са по-малки части от оригиналния документ, които са подходящи за LLM и Q&A.
+
+```typescript
+import { Document } from "llamaindex";
+
+document = new Document({ text: "текст", metadata: { key: "val" } });
+```
+
+## API Референция
+
+- [Документ](../../api/classes/Document.md)
+- [ТекстовВъзел](../../api/classes/TextNode.md)
+
+"

apps/docs/i18n/bg/docusaurus-plugin-content-docs/current/modules/high_level/query_engine.md

@@ -0,0 +1,40 @@
+---
+sidebar_position: 3
+---
+
+# QueryEngine (Заявка на двигател)
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+Заявка на двигател обвива `Retriever` и `ResponseSynthesizer` в тръбопровод, който използва низа от заявки, за да извлече възли и след това ги изпраща към LLM, за да генерира отговор.
+
+```typescript
+const queryEngine = index.asQueryEngine();
+const response = await queryEngine.query("query string");
+```
+
+## Заявка на подзапитване на двигател
+
+Основната концепция на Заявка на подзапитване на двигател е, че тя разделя една заявка на множество заявки, получава отговор за всяка от тези заявки и след това комбинира тези различни отговори в един цялостен отговор за потребителя. Можете да си представите това като техника за "мислене стъпка по стъпка", но като итерира върху източниците на данни!
+
+### Започване
+
+Най-лесният начин да започнете да използвате Заявка на подзапитване на двигател е да стартирате файла subquestion.ts в [примерите](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/subquestion.ts).
+
+```bash
+npx ts-node subquestion.ts
+```
+
+### Инструменти
+
+Заявка на подзапитване на двигател е реализирана с инструменти. Основната идея на инструментите е, че те са изпълними опции за големия езиков модел. В този случай нашият Заявка на подзапитване на двигател разчита на QueryEngineTool, който, както се предполага, е инструмент за изпълнение на заявки върху QueryEngine. Това ни позволява да дадем на модела възможност да заявява различни документи за различни въпроси, например. Също така можем да си представим, че Заявка на подзапитване на двигател може да използва инструмент, който търси нещо в Интернет или получава отговор, използвайки Wolfram Alpha.
+
+Можете да научите повече за инструментите, като разгледате документацията на LlamaIndex Python https://gpt-index.readthedocs.io/en/latest/core_modules/agent_modules/tools/root.html
+
+## API Reference (API справка)
+
+- [RetrieverQueryEngine (Заявка на двигател за извличане)](../../api/classes/RetrieverQueryEngine.md)
+- [SubQuestionQueryEngine (Заявка на двигател за подзапитване)](../../api/classes/SubQuestionQueryEngine.md)
+- [QueryEngineTool (Инструмент за заявка на двигател)](../../api/interfaces/QueryEngineTool.md)
+
+"

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

@@ -0,0 +1,33 @@
+# Основни модули
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+LlamaIndex.TS предлага няколко основни модула, разделени на модули на високо ниво, за бързо стартиране, и модули на ниско ниво, за персонализиране на ключовите компоненти според вашите нужди.
+
+## Модули на високо ниво
+
+- [**Документ**](./high_level/documents_and_nodes.md): Документ представлява текстов файл, PDF файл или друг непрекъснат парче данни.
+
+- [**Възел**](./high_level/documents_and_nodes.md): Основният строителен блок от данни. Най-често това са части от документа, разделени на управляеми парчета, достатъчно малки, за да бъдат подадени на модел за вграждане и LLM.
+
+- [**Четец/Зареждач**](./high_level/data_loader.md): Четецът или зареждачът е нещо, което приема документ от реалния свят и го преобразува в клас Документ, който после може да се използва в индекса и заявките ви. В момента поддържаме обикновени текстови файлове и PDF файлове, с много други, които ще бъдат добавени.
+
+- [**Индекси**](./high_level/data_index.md): Индексите съхраняват Възлите и вгражданията на тези възли.
+
+- [**QueryEngine**](./high_level/query_engine.md): Заявките са това, което генерира заявката, която въвеждате и ви връща резултата. Заявките обикновено комбинират предварително изграден prompt със избрани възли от вашия индекс, за да предоставят на LLM контекста, от който се нуждае, за да отговори на вашата заявка.
+
+- [**ChatEngine**](./high_level/chat_engine.md): ChatEngine ви помага да построите чатбот, който ще взаимодейства с вашите индекси.
+
+## Модули на ниско ниво
+
+- [**LLM**](./low_level/llm.md): Класът LLM е обединен интерфейс над голям доставчик на модели на езика като OpenAI GPT-4, Anthropic Claude или Meta LLaMA. Можете да го наследите, за да напишете конектор към собствен модел на голям език.
+
+- [**Embedding**](./low_level/embedding.md): Вграждането се представя като вектор от числа с плаваща запетая. Нашето вграждане по подразбиране е OpenAI's text-embedding-ada-002 и всяко вграждане, което генерира, се състои от 1,536 числа с плаваща запетая. Друго популярно вграждане е BERT, което използва 768 числа с плаваща запетая, за да представи всеки възел. Предоставяме няколко помощни функции за работа с вграждания, включително 3 опции за изчисляване на подобие и Maximum Marginal Relevance.
+
+- [**TextSplitter/NodeParser**](./low_level/node_parser.md): Стратегиите за разделяне на текст са изключително важни за общата ефективност на търсенето на вграждания. В момента, въпреки че имаме стойност по подразбиране, няма универсално решение. В зависимост от източниците на документите, може да искате да използвате различни размери и стратегии за разделяне. В момента поддържаме разделяне по фиксиран размер, разделяне по фиксиран размер с препокриващи се секции, разделяне по изречение и разделяне по параграф. TextSplitter се използва от NodeParser при разделянето на `Document` на `Node`.
+
+- [**Retriever**](./low_level/retriever.md): Retriever е този, който наистина избира възлите за връщане от индекса. Тук може да желаете да опитате да вземете повече или по-малко възли за всяка заявка, да промените функцията за подобие или да създадете собствен retriever за всеки отделен случай в приложението си. Например може да желаете да имате отделен retriever за съдържание на код срещу текстово съдържание.
+
+- [**ResponseSynthesizer**](./low_level/response_synthesizer.md): ResponseSynthesizer е отговорен за вземането на низ от заявка и използването на списък от `Node`-и за генериране на отговор. Това може да бъде в различни форми, като обхождане на всички контексти и уточняване на отговор, или изграждане на дърво от резюмета и връщане на кореновото резюме.
+
+- [**Storage**](./low_level/storage.md): На някакъв етап ще искате да съхранявате индексите, данните и векторите си, вместо да изпълнявате моделите за вграждане всеки път. IndexStore, DocStore, VectorStore и KVStore са абстракции, които ви позволяват да го направите. Заедно те формират StorageContext. В момента ви позволяваме да запазвате вгражданията си във файлове на файловата система (или виртуална файлова система в паметта), но също така активно добавяме интеграции към Vector Databases.

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

@@ -0,0 +1,26 @@
+---
+sidebar_position: 1
+---
+
+# Вграждане (Embedding)
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+Моделът за вграждане в LlamaIndex е отговорен за създаването на числови представяния на текст. По подразбиране, LlamaIndex използва модела `text-embedding-ada-002` от OpenAI.
+
+Това може да бъде явно зададено в обекта `ServiceContext`.
+
+```typescript
+import { OpenAIEmbedding, serviceContextFromDefaults } from "llamaindex";
+
+const openaiEmbeds = new OpenAIEmbedding();
+
+const serviceContext = serviceContextFromDefaults({ embedModel: openaiEmbeds });
+```
+
+## API Референция
+
+- [OpenAIEmbedding](../../api/classes/OpenAIEmbedding.md)
+- [ServiceContext](../../api/interfaces/ServiceContext.md)
+
+"

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

@@ -0,0 +1,26 @@
+---
+sidebar_position: 0
+---
+
+# LLM
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+LLM е отговорен за четене на текст и генериране на отговори на естествен език на заявки. По подразбиране, LlamaIndex.TS използва `gpt-3.5-turbo`.
+
+LLM може да бъде явно зададен в обекта `ServiceContext`.
+
+```typescript
+import { OpenAI, serviceContextFromDefaults } from "llamaindex";
+
+const openaiLLM = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0 });
+
+const serviceContext = serviceContextFromDefaults({ llm: openaiLLM });
+```
+
+## API Референция
+
+- [OpenAI](../../api/classes/OpenAI.md)
+- [ServiceContext](../../api/interfaces/ServiceContext.md)
+
+"

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

@@ -0,0 +1,37 @@
+---
+sidebar_position: 3
+---
+
+# NodeParser (Анализатор на възли)
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+`NodeParser` в LlamaIndex е отговорен за разделянето на обекти от тип `Document` на по-лесни за управление обекти от тип `Node`. Когато извикате `.fromDocuments()`, `NodeParser` от `ServiceContext` се използва автоматично за това. Алтернативно, можете да го използвате, за да разделяте документи предварително.
+
+```typescript
+import { Document, SimpleNodeParser } from "llamaindex";
+
+const nodeParser = new SimpleNodeParser();
+const nodes = nodeParser.getNodesFromDocuments([
+  new Document({ text: "Аз съм на 10 години. Джон е на 20 години." }),
+]);
+```
+
+## TextSplitter (TextSplitter)
+
+Основният разделящ текст ще раздели текста на изречения. Той може също да се използва като самостоятелен модул за разделяне на суров текст.
+
+```typescript
+import { SentenceSplitter } from "llamaindex";
+
+const splitter = new SentenceSplitter({ chunkSize: 1 });
+
+const textSplits = splitter.splitText("Здравей, свят");
+```
+
+## API Reference (API справка)
+
+- [SimpleNodeParser (Прост анализатор на възли)](../../api/classes/SimpleNodeParser.md)
+- [SentenceSplitter (Разделяне на изречения)](../../api/classes/SentenceSplitter.md)
+
+"

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

@@ -0,0 +1,47 @@
+---
+sidebar_position: 6
+---
+
+# ResponseSynthesizer (Синтезатор на отговори)
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+ResponseSynthesizer е отговорен за изпращането на заявката, възлите и шаблоните за подсказки към LLM, за да генерира отговор. Има няколко ключови режима за генериране на отговор:
+
+- `Refine` (Подобряване): "създаване и подобряване" на отговор, като последователно се преминава през всеки извлечен текстов фрагмент. Това прави отделно LLM обаждане за всеки възел. Подходящо за по-подробни отговори.
+- `CompactAndRefine` (Компактно и подобряване) (по подразбиране): "компактиране" на подсказката по време на всяко LLM обаждане, като се пълни с колкото може повече текстови фрагменти, които могат да се поберат в максималния размер на подсказката. Ако има твърде много фрагменти, които не могат да се поберат в една подсказка, се "създава и подобрява" отговор, като се преминава през няколко компактни подсказки. Същото като `refine`, но трябва да доведе до по-малко LLM обаждания.
+- `TreeSummarize` (Сумиране на дърво): Дадени набор от текстови фрагменти и заявката, рекурсивно се конструира дърво и се връща кореновият възел като отговор. Подходящо за цели на сумиране.
+- `SimpleResponseBuilder` (Прост създател на отговори): Дадени набор от текстови фрагменти и заявката, се прилага заявката към всеки текстов фрагмент, като се натрупват отговорите в масив. Връща конкатениран низ от всички отговори. Подходящо, когато трябва да изпълните същата заявка отделно за всеки текстов фрагмент.
+
+```typescript
+import { NodeWithScore, ResponseSynthesizer, TextNode } from "llamaindex";
+
+const responseSynthesizer = new ResponseSynthesizer();
+
+const nodesWithScore: NodeWithScore[] = [
+  {
+    node: new TextNode({ text: "Аз съм на 10 години." }),
+    score: 1,
+  },
+  {
+    node: new TextNode({ text: "Джон е на 20 години." }),
+    score: 0.5,
+  },
+];
+
+const response = await responseSynthesizer.synthesize(
+  "Колко години съм?",
+  nodesWithScore,
+);
+console.log(response.response);
+```
+
+## API Референция
+
+- [ResponseSynthesizer (Синтезатор на отговори)](../../api/classes/ResponseSynthesizer.md)
+- [Refine (Подобряване)](../../api/classes/Refine.md)
+- [CompactAndRefine (Компактно и подобряване)](../../api/classes/CompactAndRefine.md)
+- [TreeSummarize (Сумиране на дърво)](../../api/classes/TreeSummarize.md)
+- [SimpleResponseBuilder (Прост създател на отговори)](../../api/classes/SimpleResponseBuilder.md)
+
+"

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

@@ -0,0 +1,25 @@
+---
+sidebar_position: 5
+---
+
+# Retriever (Извличател)
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+Извличател в LlamaIndex е това, което се използва за извличане на `Node` от индекс чрез заявка. `VectorIndexRetriever` ще извлече най-подобните k върха. В същото време, `SummaryIndexRetriever` ще извлече всички върхове, независимо от заявката.
+
+```typescript
+const retriever = vector_index.asRetriever();
+retriever.similarityTopK = 3;
+
+// Извличане на върхове!
+const nodesWithScore = await retriever.retrieve("query string");
+```
+
+## API Reference (API справка)
+
+- [SummaryIndexRetriever](../../api/classes/SummaryIndexRetriever.md)
+- [SummaryIndexLLMRetriever](../../api/classes/SummaryIndexLLMRetriever.md)
+- [VectorIndexRetriever](../../api/classes/VectorIndexRetriever.md)
+
+"

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

@@ -0,0 +1,30 @@
+---
+sidebar_position: 7
+---
+
+# Съхранение (Storage)
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+Съхранението в LlamaIndex.TS работи автоматично, след като сте конфигурирали обект `StorageContext`. Просто конфигурирайте `persistDir` и го свържете с индекс.
+
+В момента се поддържа само запазване и зареждане от диск, с планирани бъдещи интеграции!
+
+```typescript
+import { Document, VectorStoreIndex, storageContextFromDefaults } from "./src";
+
+const storageContext = await storageContextFromDefaults({
+  persistDir: "./storage",
+});
+
+const document = new Document({ text: "Тестов текст" });
+const index = await VectorStoreIndex.fromDocuments([document], {
+  storageContext,
+});
+```
+
+## API Референция
+
+- [StorageContext](../../api/interfaces/StorageContext.md)
+
+"

apps/docs/i18n/bg/docusaurus-plugin-content-docs/current/starter.md

@@ -0,0 +1,60 @@
+---
+sidebar_position: 2
+---
+
+# Начално ръководство
+
+`Тази документация е преведена автоматично и може да съдържа грешки. Не се колебайте да отворите Pull Request, за да предложите промени.`
+
+След като сте [инсталирали LlamaIndex.TS с помощта на NPM](installation) и сте настроили вашия OpenAI ключ, вие сте готови да стартирате първото си приложение:
+
+В нова папка:
+
+```bash npm2yarn
+npm install typescript
+npm install @types/node
+npx tsc --init # ако е необходимо
+```
+
+Създайте файла `example.ts`. Този код ще зареди някакви примерни данни, ще създаде документ, ще го индексира (което създава вграждания с помощта на OpenAI) и след това ще създаде търсачка, която да отговаря на въпроси относно данните.
+
+```ts
+// example.ts
+import fs from "fs/promises";
+import { Document, VectorStoreIndex } from "llamaindex";
+
+async function main() {
+  // Заредете есе от abramov.txt в Node
+  const essay = await fs.readFile(
+    "node_modules/llamaindex/examples/abramov.txt",
+    "utf-8",
+  );
+
+  // Създайте обект Document с есето
+  const document = new Document({ text: essay });
+
+  // Разделете текста и създайте вграждания. Запазете ги в VectorStoreIndex
+  const index = await VectorStoreIndex.fromDocuments([document]);
+
+  // Заявете индекса
+  const queryEngine = index.asQueryEngine();
+  const response = await queryEngine.query(
+    "Какво направи авторът по време на колеж?",
+  );
+
+  // Изведете отговора
+  console.log(response.toString());
+}
+
+main();
+```
+
+След това можете да го стартирате чрез
+
+```bash
+npx ts-node example.ts
+```
+
+Готови ли сте да научите още? Проверете нашия NextJS игрален площад на адрес https://llama-playground.vercel.app/. Изходният код е достъпен на адрес https://github.com/run-llama/ts-playground
+
+"

apps/docs/i18n/cat/docusaurus-plugin-content-docs/current/api

@@ -0,0 +1 @@
+../../../../docs/api

apps/docs/i18n/cat/docusaurus-plugin-content-docs/current/concepts.md

@@ -0,0 +1,86 @@
+---
+sidebar_position: 3
+---
+
+# Conceptes de Nivell Alt
+
+`Aquesta documentació s'ha traduït automàticament i pot contenir errors. No dubteu a obrir una Pull Request per suggerir canvis.`
+
+LlamaIndex.TS t'ajuda a construir aplicacions amb potència LLM (per exemple, Q&A, chatbot) sobre dades personalitzades.
+
+En aquesta guia de conceptes de nivell alt, aprendràs:
+
+- com un LLM pot respondre preguntes utilitzant les teves pròpies dades.
+- conceptes clau i mòduls en LlamaIndex.TS per compondre la teva pròpia canalització de consulta.
+
+## Resposta a preguntes a través de les teves dades
+
+LlamaIndex utilitza un mètode de dues etapes quan utilitza un LLM amb les teves dades:
+
+1. **etapa d'indexació**: preparació d'una base de coneixement, i
+2. **etapa de consulta**: recuperació de context rellevant de la base de coneixement per ajudar el LLM a respondre a una pregunta
+
+![](./_static/concepts/rag.jpg)
+
+Aquest procés també és conegut com a Generació Augmentada per Recuperació (RAG).
+
+LlamaIndex.TS proporciona les eines essencials per facilitar ambdós passos.
+
+Explorarem cada etapa en detall.
+
+### Etapa d'Indexació
+
+LlamaIndex.TS t'ajuda a preparar la base de coneixement amb una sèrie de connectors de dades i índexs.
+
+![](./_static/concepts/indexing.jpg)
+
+[**Carregadors de Dades**](./modules/high_level/data_loader.md):
+Un connector de dades (és a dir, `Reader`) ingestiona dades de diferents fonts de dades i formats de dades en una representació simple de `Document` (text i metadades simples).
+
+[**Documents / Nodes**](./modules/high_level/documents_and_nodes.md): Un `Document` és un contenidor genèric al voltant de qualsevol font de dades - per exemple, un PDF, una sortida d'API o dades recuperades d'una base de dades. Un `Node` és la unitat atòmica de dades en LlamaIndex i representa un "tros" d'un `Document` origen. És una representació completa que inclou metadades i relacions (amb altres nodes) per permetre operacions de recuperació precises i expressives.
+
+[**Índexs de Dades**](./modules/high_level/data_index.md):
+Un cop hagis ingestat les teves dades, LlamaIndex t'ajuda a indexar les dades en un format fàcil de recuperar.
+
+A sota dels panells, LlamaIndex analitza els documents en representacions intermèdies, calcula incrustacions vectorials i emmagatzema les teves dades a la memòria o al disc.
+
+"
+
+### Etapa de Consulta
+
+En l'etapa de consulta, la canalització de consulta recupera el context més rellevant donada una consulta de l'usuari,
+i ho passa al LLM (juntament amb la consulta) per sintetitzar una resposta.
+
+Això proporciona al LLM un coneixement actualitzat que no es troba en les seves dades d'entrenament originals,
+(i també redueix la al·lucinació).
+
+El repte clau en l'etapa de consulta és la recuperació, l'orquestració i el raonament sobre bases de coneixement (potencialment moltes).
+
+LlamaIndex proporciona mòduls componibles que t'ajuden a construir i integrar canalitzacions RAG per a Q&A (motor de consulta), chatbot (motor de xat) o com a part d'un agent.
+
+Aquests blocs de construcció es poden personalitzar per reflectir les preferències de classificació, així com compondre el raonament sobre múltiples bases de coneixement de manera estructurada.
+
+![](./_static/concepts/querying.jpg)
+
+#### Blocs de Construcció
+
+[**Recuperadors**](./modules/low_level/retriever.md):
+Un recuperador defineix com recuperar eficientment el context rellevant d'una base de coneixement (és a dir, índex) quan se li dóna una consulta.
+La lògica de recuperació específica difereix per a diferents índexs, sent la més popular la recuperació densa contra un índex vectorial.
+
+[**Sintetitzadors de Resposta**](./modules/low_level/response_synthesizer.md):
+Un sintetitzador de resposta genera una resposta a partir d'un LLM, utilitzant una consulta de l'usuari i un conjunt donat de trossos de text recuperats.
+
+"
+
+#### Canalitzacions
+
+[**Motor de Consulta**](./modules/high_level/query_engine.md):
+Un motor de consulta és una canalització de cap a cap que et permet fer preguntes sobre les teves dades.
+Rebutja una consulta en llenguatge natural i retorna una resposta, juntament amb el context de referència recuperat i passat al LLM.
+
+[**Motor de Xat**](./modules/high_level/chat_engine.md):
+Un motor de xat és una canalització de cap a cap per mantenir una conversa amb les teves dades
+(múltiples intercanvis en lloc d'una única pregunta i resposta).
+
+"

apps/docs/i18n/cat/docusaurus-plugin-content-docs/current/end_to_end.md

@@ -0,0 +1,59 @@
+---
+sidebar_position: 4
+---
+
+# Exemples de principi a fi
+
+`Aquesta documentació s'ha traduït automàticament i pot contenir errors. No dubteu a obrir una Pull Request per suggerir canvis.`
+
+Incluïm diversos exemples de principi a fi utilitzant LlamaIndex.TS en el repositori.
+
+Comproveu els exemples a continuació o proveu-los i completeu-los en qüestió de minuts amb els tutorials interactius de Github Codespace proporcionats per Dev-Docs [aquí](https://codespaces.new/team-dev-docs/lits-dev-docs-playground?devcontainer_path=.devcontainer%2Fjavascript_ltsquickstart%2Fdevcontainer.json):
+
+## [Motor de xat](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/chatEngine.ts)
+
+Llegeix un fitxer i xerra sobre això amb el LLM.
+
+## [Índex de vectors](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/vectorIndex.ts)
+
+Creeu un índex de vectors i consulteu-lo. L'índex de vectors utilitzarà incrustacions per obtenir els nodes més rellevants més importants. Per defecte, els nodes més importants són 2.
+
+"
+
+## [Índex de resum](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/summaryIndex.ts)
+
+Creeu un índex de llista i consulteu-lo. Aquest exemple també utilitza el `LLMRetriever`, que utilitzarà el LLM per seleccionar els millors nodes a utilitzar en la generació de la resposta.
+
+"
+
+## [Guardar / Carregar un Índex](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/storageContext.ts)
+
+Creeu i carregueu un índex de vectors. La persistència al disc en LlamaIndex.TS es produeix automàticament una vegada que es crea un objecte de context d'emmagatzematge.
+
+## [Índex de vectors personalitzat](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/vectorIndexCustomize.ts)
+
+Creeu un índex de vectors i consulteu-lo, mentre configureu el `LLM`, el `ServiceContext` i el `similarity_top_k`.
+
+## [OpenAI LLM](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/openai.ts)
+
+Crea un OpenAI LLM i utilitza'l directament per a xatejar.
+
+"
+
+## [Llama2 DeuceLLM](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/llamadeuce.ts)
+
+Crea un Llama-2 LLM i utilitza'l directament per a xatejar.
+
+"
+
+## [Motor de consulta de subpreguntes](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/subquestion.ts)
+
+Utilitza el `Motor de consulta de subpreguntes`, que descompon les consultes complexes en múltiples preguntes i després agrega una resposta a través de les respostes a totes les subpreguntes.
+
+"
+
+## [Mòduls de baix nivell](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/lowlevel.ts)
+
+Aquest exemple utilitza diversos components de baix nivell, el que elimina la necessitat d'un motor de consulta real. Aquests components es poden utilitzar en qualsevol lloc, en qualsevol aplicació, o personalitzar i sub-classificar per satisfer les vostres pròpies necessitats.
+
+"

apps/docs/i18n/cat/docusaurus-plugin-content-docs/current/environments.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 5
+---
+
+# Entorns
+
+`Aquesta documentació s'ha traduït automàticament i pot contenir errors. No dubteu a obrir una Pull Request per suggerir canvis.`
+
+LlamaIndex actualment suporta oficialment NodeJS 18 i NodeJS 20.
+
+## Enrutador d'aplicacions NextJS
+
+Si utilitzeu els gestors de rutes/funcions sense servidor de l'enrutador d'aplicacions NextJS, haureu d'utilitzar el mode NodeJS:
+
+```js
+export const runtime = "nodejs"; // per defecte
+```
+
+i haureu d'afegir una excepció per a pdf-parse al vostre next.config.js
+
+```js
+// next.config.js
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  experimental: {
+    serverComponentsExternalPackages: ["pdf-parse"], // Posiciona pdf-parse en el mode NodeJS real amb l'enrutador d'aplicacions NextJS
+  },
+};
+
+module.exports = nextConfig;
+```

apps/docs/i18n/cat/docusaurus-plugin-content-docs/current/installation.mdx

@@ -0,0 +1,68 @@
+---
+sidebar_position: 1
+---
+
+
+# Instal·lació i configuració
+
+```Aquesta documentació s'ha traduït automàticament i pot contenir errors. No dubteu a obrir una Pull Request per suggerir canvis.```
+
+
+Assegureu-vos de tenir NodeJS v18 o superior.
+
+
+## Utilitzant create-llama
+
+La manera més senzilla de començar amb LlamaIndex és utilitzant `create-llama`. Aquesta eina de línia de comandes us permet començar ràpidament a construir una nova aplicació LlamaIndex, amb tot configurat per a vosaltres.
+
+Simplement executeu
+
+<Tabs>
+<TabItem value="1" label="npm" default>
+
+```bash
+npx create-llama@latest
+```
+
+</TabItem>
+<TabItem value="2" label="Yarn">
+
+```bash
+yarn create llama
+```
+
+</TabItem>
+<TabItem value="3" label="pnpm">
+
+```bash
+pnpm create llama@latest
+```
+
+</TabItem>
+</Tabs>
+
+per començar. Un cop la vostra aplicació estigui generada, executeu
+
+```bash npm2yarn
+npm run dev
+```
+
+per iniciar el servidor de desenvolupament. A continuació, podeu visitar [http://localhost:3000](http://localhost:3000) per veure la vostra aplicació.
+## Instal·lació des de NPM
+
+```bash npm2yarn
+npm install llamaindex
+```
+
+
+### Variables d'entorn
+
+Els nostres exemples utilitzen OpenAI per defecte. Hauràs de configurar la teva clau d'Open AI de la següent manera:
+
+```bash
+export OPENAI_API_KEY="sk-......" # Reemplaça amb la teva clau de https://platform.openai.com/account/api-keys
+```
+
+Si vols que es carregui automàticament cada vegada, afegiu-la al teu .zshrc/.bashrc.
+
+ADVERTÈNCIA: no afegiu la vostra clau d'OpenAI al control de versions.

apps/docs/i18n/cat/docusaurus-plugin-content-docs/current/introduction.md

@@ -0,0 +1,60 @@
+---
+sidebar_position: 0
+slug: /
+---
+
+# Què és LlamaIndex.TS?
+
+`Aquesta documentació s'ha traduït automàticament i pot contenir errors. No dubteu a obrir una Pull Request per suggerir canvis.`
+
+LlamaIndex.TS és un marc de dades per a aplicacions LLM per a ingestió, estructuració i accés a dades privades o específiques del domini. Tot i que també hi ha un paquet de Python disponible (vegeu [aquí](https://docs.llamaindex.ai/en/stable/)), LlamaIndex.TS ofereix funcionalitats principals en un paquet senzill, optimitzat per a l'ús amb TypeScript.
+
+## 🚀 Per què LlamaIndex.TS?
+
+En el seu nucli, els LLM ofereixen una interfície de llenguatge natural entre els humans i les dades inferides. Els models àmpliament disponibles estan preentrenats amb grans quantitats de dades disponibles públicament, des de Wikipedia i llistes de correu fins a llibres de text i codi font.
+
+Les aplicacions construïdes sobre els LLM sovint requereixen augmentar aquests models amb dades privades o específiques del domini. Desafortunadament, aquestes dades es poden trobar distribuïdes en aplicacions i emmagatzematges de dades aïllats. Es troben darrere d'APIs, en bases de dades SQL o atrapades en PDFs i presentacions.
+
+Aquí és on entra en joc **LlamaIndex.TS**.
+
+## 🦙 Com pot ajudar LlamaIndex.TS?
+
+LlamaIndex.TS proporciona les següents eines:
+
+- **Càrrega de dades** per a la ingestió directa de les vostres dades en format `.txt`, `.pdf`, `.csv`, `.md` i `.docx`.
+- **Índexs de dades** per a l'estructuració de les vostres dades en representacions intermèdies que siguin fàcils i eficients per als LLM per a consumir.
+- **Motors** que proporcionen accés en llenguatge natural a les vostres dades. Per exemple:
+  - Els motors de consulta són interfícies de recuperació potents per a una sortida augmentada de coneixement.
+  - Els motors de xat són interfícies conversacionals per a interaccions de "anar i venir" amb múltiples missatges amb les vostres dades.
+
+## 👨‍👩‍👧‍👦 Per a qui és LlamaIndex?
+
+LlamaIndex.TS proporciona un conjunt d'eines bàsiques essencials per a qualsevol persona que construeixi aplicacions LLM amb JavaScript i TypeScript.
+
+La nostra API de nivell superior permet als usuaris principiants utilitzar LlamaIndex.TS per a la ingestió i consulta de les seves dades.
+
+Per a aplicacions més complexes, les nostres API de nivell inferior permeten als usuaris avançats personalitzar i ampliar qualsevol mòdul: connectors de dades, índexs, recuperadors i motors de consulta, per adaptar-se a les seves necessitats.
+
+## Començar
+
+`npm install llamaindex`
+
+La nostra documentació inclou [Instruccions d'Instal·lació](./installation.md) i un [Tutorial d'Inici](./starter.md) per a construir la vostra primera aplicació.
+
+Un cop tingueu tot a punt, [Conceptes de Nivell Alt](./concepts.md) ofereix una visió general de l'arquitectura modular de LlamaIndex. Per a més exemples pràctics, consulteu els nostres [Tutorials de Principi a Fi](./end_to_end.md).
+
+## 🗺️ Ecosistema
+
+Per descarregar o contribuir, troba LlamaIndex a:
+
+- Github: https://github.com/run-llama/LlamaIndexTS
+- NPM: https://www.npmjs.com/package/llamaindex
+
+"
+
+## Comunitat
+
+Necessiteu ajuda? Teniu alguna suggerència de funcionalitat? Uneix-te a la comunitat de LlamaIndex:
+
+- Twitter: https://twitter.com/llama_index
+- Discord: https://discord.gg/dGcwcsnxhU