Skip to content
Snippets Groups Projects
Commit 07c5aeba authored by Yi Ding's avatar Yi Ding
Browse files

built out the docs

parent d16113ad
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 282 additions and 180 deletions
CONTRIBUTING.md
+ 1
− 1
View file @ 07c5aeba
......@@ -6,7 +6,7 @@ This is a monorepo built with Turborepo
Right now there are two packages of importance:
packages/core which is the main NPM library @llamaindex/core
packages/core which is the main NPM library llamaindex
apps/simple is where the demo code lives
......
README.md
+ 72
− 5
View file @ 07c5aeba
# LlamaIndex
# LlamaIndex.TS
<!-- ![TS](assets/tslogo.svg) -->
Use your own data with large language models (LLMs, OpenAI ChatGPT and others) in Typescript and Javascript.
LlamaIndex.TS helps you use your data with LLMs.
## What is LlamaIndex.TS?
## Quick Start
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.
## Getting started with an example:
LlamaIndex.TS requries Node v18 or higher. You can download it from https://nodejs.org or use https://nvm.sh (our preferred option).
In a new folder:
```bash
export OPEN_AI_KEY="sk-......" # Replace with your key from https://platform.openai.com/account/api-keys
npx tsc –-init # if needed
pnpm install llamaindex
```
Create the file example.ts
```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.aquery(
"What did the author do in college?"
);
// Output response
console.log(response.toString());
}
```
npm install llamaindex
Then you can run it using
```bash
npx ts-node example.ts
```
## Core concepts:
- [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.
- Indexes: indexes store the Nodes and the embeddings of those nodes.
- [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 Indexes.
- [SimplePrompt](packages/core/src/Prompt.ts): A simple standardized function call definition that takes in inputs and puts them in a prebuilt template.
## 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/docs/advanced.md 0 → 100644
+ 23
− 0
View file @ 07c5aeba
---
sidebar_position: 3
---
# Advanced Features
## 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 apps/simple.
```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
apps/docs/docs/api/_category_.yml
+ 2
− 1
View file @ 07c5aeba
label: "API"
\ No newline at end of file
label: "API"
position: 4
\ No newline at end of file
apps/docs/docs/api/classes/BaseEmbedding.md
+ 3
− 3
View file @ 07c5aeba
......@@ -36,7 +36,7 @@ custom_edit_url: null
#### Defined in
[Embedding.ts:206](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L206)
[Embedding.ts:206](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L206)
___
......@@ -56,7 +56,7 @@ ___
#### Defined in
[Embedding.ts:205](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L205)
[Embedding.ts:205](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L205)
___
......@@ -78,4 +78,4 @@ ___
#### Defined in
[Embedding.ts:197](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L197)
[Embedding.ts:197](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L197)
apps/docs/docs/api/classes/BaseIndex.md
+ 11
− 8
View file @ 07c5aeba
......@@ -6,6 +6,9 @@ sidebar_position: 0
custom_edit_url: null
---
Indexes are the data structure that we store our nodes and embeddings in so
they can be retrieved for our queries.
## Type parameters
| Name |
......@@ -40,7 +43,7 @@ custom_edit_url: null
#### Defined in
[BaseIndex.ts:75](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L75)
[BaseIndex.ts:80](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L80)
## Properties
......@@ -50,7 +53,7 @@ custom_edit_url: null
#### Defined in
[BaseIndex.ts:70](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L70)
[BaseIndex.ts:75](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L75)
___
......@@ -60,7 +63,7 @@ ___
#### Defined in
[BaseIndex.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L72)
[BaseIndex.ts:77](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L77)
___
......@@ -70,7 +73,7 @@ ___
#### Defined in
[BaseIndex.ts:73](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L73)
[BaseIndex.ts:78](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L78)
___
......@@ -80,7 +83,7 @@ ___
#### Defined in
[BaseIndex.ts:68](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L68)
[BaseIndex.ts:73](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L73)
___
......@@ -90,7 +93,7 @@ ___
#### Defined in
[BaseIndex.ts:69](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L69)
[BaseIndex.ts:74](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L74)
___
......@@ -100,7 +103,7 @@ ___
#### Defined in
[BaseIndex.ts:71](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L71)
[BaseIndex.ts:76](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L76)
## Methods
......@@ -114,4 +117,4 @@ ___
#### Defined in
[BaseIndex.ts:84](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L84)
[BaseIndex.ts:89](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L89)
apps/docs/docs/api/classes/BaseNode.md
+ 20
− 20
View file @ 07c5aeba
......@@ -28,7 +28,7 @@ Generic abstract class for retrievable nodes
#### Defined in
[Node.ts:48](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L48)
[Node.ts:48](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L48)
## Properties
......@@ -38,7 +38,7 @@ Generic abstract class for retrievable nodes
#### Defined in
[Node.ts:39](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L39)
[Node.ts:39](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L39)
___
......@@ -48,7 +48,7 @@ ___
#### Defined in
[Node.ts:43](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L43)
[Node.ts:43](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L43)
___
......@@ -58,7 +58,7 @@ ___
#### Defined in
[Node.ts:44](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L44)
[Node.ts:44](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L44)
___
......@@ -68,7 +68,7 @@ ___
#### Defined in
[Node.ts:46](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L46)
[Node.ts:46](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L46)
___
......@@ -78,7 +78,7 @@ ___
#### Defined in
[Node.ts:38](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L38)
[Node.ts:38](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L38)
___
......@@ -88,7 +88,7 @@ ___
#### Defined in
[Node.ts:42](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L42)
[Node.ts:42](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L42)
___
......@@ -98,7 +98,7 @@ ___
#### Defined in
[Node.ts:45](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L45)
[Node.ts:45](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L45)
## Accessors
......@@ -112,7 +112,7 @@ ___
#### Defined in
[Node.ts:104](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L104)
[Node.ts:104](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L104)
___
......@@ -126,7 +126,7 @@ ___
#### Defined in
[Node.ts:84](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L84)
[Node.ts:84](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L84)
___
......@@ -140,7 +140,7 @@ ___
#### Defined in
[Node.ts:58](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L58)
[Node.ts:58](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L58)
___
......@@ -154,7 +154,7 @@ ___
#### Defined in
[Node.ts:94](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L94)
[Node.ts:94](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L94)
___
......@@ -168,7 +168,7 @@ ___
#### Defined in
[Node.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L72)
[Node.ts:72](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L72)
___
......@@ -182,7 +182,7 @@ ___
#### Defined in
[Node.ts:62](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L62)
[Node.ts:62](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L62)
## Methods
......@@ -196,7 +196,7 @@ ___
#### Defined in
[Node.ts:124](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L124)
[Node.ts:124](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L124)
___
......@@ -216,7 +216,7 @@ ___
#### Defined in
[Node.ts:54](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L54)
[Node.ts:54](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L54)
___
......@@ -230,7 +230,7 @@ ___
#### Defined in
[Node.ts:116](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L116)
[Node.ts:116](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L116)
___
......@@ -250,7 +250,7 @@ ___
#### Defined in
[Node.ts:55](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L55)
[Node.ts:55](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L55)
___
......@@ -264,7 +264,7 @@ ___
#### Defined in
[Node.ts:52](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L52)
[Node.ts:52](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L52)
___
......@@ -284,4 +284,4 @@ ___
#### Defined in
[Node.ts:56](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L56)
[Node.ts:56](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L56)
apps/docs/docs/api/classes/CallbackManager.md
+ 3
− 3
View file @ 07c5aeba
......@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
[callbacks/CallbackManager.ts:68](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L68)
[callbacks/CallbackManager.ts:68](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L68)
## Properties
......@@ -52,7 +52,7 @@ CallbackManagerMethods.onLLMStream
#### Defined in
[callbacks/CallbackManager.ts:65](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L65)
[callbacks/CallbackManager.ts:65](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L65)
___
......@@ -80,4 +80,4 @@ CallbackManagerMethods.onRetrieve
#### Defined in
[callbacks/CallbackManager.ts:66](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L66)
[callbacks/CallbackManager.ts:66](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L66)
apps/docs/docs/api/classes/ChatGPTLLMPredictor.md
+ 7
− 7
View file @ 07c5aeba
......@@ -26,7 +26,7 @@ ChatGPTLLMPredictor is a predictor that uses GPT.
#### Defined in
[LLMPredictor.ts:26](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L26)
[LLMPredictor.ts:26](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLMPredictor.ts#L26)
## Properties
......@@ -36,7 +36,7 @@ ChatGPTLLMPredictor is a predictor that uses GPT.
#### Defined in
[LLMPredictor.ts:24](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L24)
[LLMPredictor.ts:24](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLMPredictor.ts#L24)
___
......@@ -46,7 +46,7 @@ ___
#### Defined in
[LLMPredictor.ts:23](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L23)
[LLMPredictor.ts:23](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLMPredictor.ts#L23)
___
......@@ -56,7 +56,7 @@ ___
#### Defined in
[LLMPredictor.ts:21](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L21)
[LLMPredictor.ts:21](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLMPredictor.ts#L21)
___
......@@ -66,7 +66,7 @@ ___
#### Defined in
[LLMPredictor.ts:22](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L22)
[LLMPredictor.ts:22](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLMPredictor.ts#L22)
## Methods
......@@ -92,7 +92,7 @@ ___
#### Defined in
[LLMPredictor.ts:49](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L49)
[LLMPredictor.ts:49](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLMPredictor.ts#L49)
___
......@@ -110,4 +110,4 @@ ___
#### Defined in
[LLMPredictor.ts:45](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L45)
[LLMPredictor.ts:45](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLMPredictor.ts#L45)
apps/docs/docs/api/classes/CompactAndRefine.md
+ 5
− 5
View file @ 07c5aeba
......@@ -34,7 +34,7 @@ CompactAndRefine is a slight variation of Refine that first compacts the text ch
#### Defined in
[ResponseSynthesizer.ts:66](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L66)
[ResponseSynthesizer.ts:66](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L66)
## Properties
......@@ -48,7 +48,7 @@ CompactAndRefine is a slight variation of Refine that first compacts the text ch
#### Defined in
[ResponseSynthesizer.ts:64](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L64)
[ResponseSynthesizer.ts:64](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L64)
___
......@@ -62,7 +62,7 @@ ___
#### Defined in
[ResponseSynthesizer.ts:62](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L62)
[ResponseSynthesizer.ts:62](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L62)
___
......@@ -76,7 +76,7 @@ ___
#### Defined in
[ResponseSynthesizer.ts:63](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L63)
[ResponseSynthesizer.ts:63](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L63)
## Methods
......@@ -102,4 +102,4 @@ ___
#### Defined in
[ResponseSynthesizer.ts:152](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L152)
[ResponseSynthesizer.ts:152](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L152)
apps/docs/docs/api/classes/CondenseQuestionChatEngine.md
+ 19
− 15
View file @ 07c5aeba
......@@ -17,7 +17,7 @@ data, or are very referential to previous context.
## Implements
- `ChatEngine`
- [`ChatEngine`](../interfaces/ChatEngine.md)
## Constructors
......@@ -37,7 +37,7 @@ data, or are very referential to previous context.
#### Defined in
[ChatEngine.ts:75](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L75)
[ChatEngine.ts:75](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L75)
## Properties
......@@ -47,7 +47,7 @@ data, or are very referential to previous context.
#### Defined in
[ChatEngine.ts:71](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L71)
[ChatEngine.ts:71](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L71)
___
......@@ -57,7 +57,7 @@ ___
#### Defined in
[ChatEngine.ts:73](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L73)
[ChatEngine.ts:73](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L73)
___
......@@ -67,7 +67,7 @@ ___
#### Defined in
[ChatEngine.ts:70](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L70)
[ChatEngine.ts:70](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L70)
___
......@@ -77,7 +77,7 @@ ___
#### Defined in
[ChatEngine.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L72)
[ChatEngine.ts:72](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L72)
## Methods
......@@ -85,12 +85,14 @@ ___
▸ **achat**(`message`, `chatHistory?`): `Promise`<[`Response`](Response.md)\>
Send message along with the class's current chat history to the LLM.
#### Parameters
| Name | Type |
| :------ | :------ |
| `message` | `string` |
| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
| Name | Type | Description |
| :------ | :------ | :------ |
| `message` | `string` | |
| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | optional chat history if you want to customize the chat history |
#### Returns
......@@ -98,11 +100,11 @@ ___
#### Implementation of
ChatEngine.achat
[ChatEngine](../interfaces/ChatEngine.md).[achat](../interfaces/ChatEngine.md#achat)
#### Defined in
[ChatEngine.ts:104](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L104)
[ChatEngine.ts:104](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L104)
___
......@@ -123,7 +125,7 @@ ___
#### Defined in
[ChatEngine.ts:89](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L89)
[ChatEngine.ts:89](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L89)
___
......@@ -131,14 +133,16 @@ ___
▸ **reset**(): `void`
Resets the chat history so that it's empty.
#### Returns
`void`
#### Implementation of
ChatEngine.reset
[ChatEngine](../interfaces/ChatEngine.md).[reset](../interfaces/ChatEngine.md#reset)
#### Defined in
[ChatEngine.ts:123](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L123)
[ChatEngine.ts:123](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L123)
apps/docs/docs/api/classes/ContextChatEngine.md
+ 18
− 14
View file @ 07c5aeba
......@@ -12,7 +12,7 @@ ideally allowing the appropriate context to be surfaced for each query.
## Implements
- `ChatEngine`
- [`ChatEngine`](../interfaces/ChatEngine.md)
## Constructors
......@@ -31,7 +31,7 @@ ideally allowing the appropriate context to be surfaced for each query.
#### Defined in
[ChatEngine.ts:138](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L138)
[ChatEngine.ts:138](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L138)
## Properties
......@@ -41,7 +41,7 @@ ideally allowing the appropriate context to be surfaced for each query.
#### Defined in
[ChatEngine.ts:136](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L136)
[ChatEngine.ts:136](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L136)
___
......@@ -51,7 +51,7 @@ ___
#### Defined in
[ChatEngine.ts:135](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L135)
[ChatEngine.ts:135](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L135)
___
......@@ -61,7 +61,7 @@ ___
#### Defined in
[ChatEngine.ts:134](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L134)
[ChatEngine.ts:134](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L134)
## Methods
......@@ -69,12 +69,14 @@ ___
▸ **achat**(`message`, `chatHistory?`): `Promise`<[`Response`](Response.md)\>
Send message along with the class's current chat history to the LLM.
#### Parameters
| Name | Type |
| :------ | :------ |
| `message` | `string` |
| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
| Name | Type | Description |
| :------ | :------ | :------ |
| `message` | `string` | |
| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | optional chat history if you want to customize the chat history |
#### Returns
......@@ -82,11 +84,11 @@ ___
#### Implementation of
ChatEngine.achat
[ChatEngine](../interfaces/ChatEngine.md).[achat](../interfaces/ChatEngine.md#achat)
#### Defined in
[ChatEngine.ts:153](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L153)
[ChatEngine.ts:153](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L153)
___
......@@ -100,7 +102,7 @@ ___
#### Defined in
[ChatEngine.ts:149](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L149)
[ChatEngine.ts:149](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L149)
___
......@@ -108,14 +110,16 @@ ___
▸ **reset**(): `void`
Resets the chat history so that it's empty.
#### Returns
`void`
#### Implementation of
ChatEngine.reset
[ChatEngine](../interfaces/ChatEngine.md).[reset](../interfaces/ChatEngine.md#reset)
#### Defined in
[ChatEngine.ts:191](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L191)
[ChatEngine.ts:191](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L191)
apps/docs/docs/api/classes/Document.md
+ 28
− 28
View file @ 07c5aeba
......@@ -32,7 +32,7 @@ A document is just a special text node with a docId.
#### Defined in
[Node.ts:216](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L216)
[Node.ts:216](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L216)
## Properties
......@@ -46,7 +46,7 @@ A document is just a special text node with a docId.
#### Defined in
[Node.ts:39](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L39)
[Node.ts:39](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L39)
___
......@@ -60,7 +60,7 @@ ___
#### Defined in
[Node.ts:139](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L139)
[Node.ts:139](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L139)
___
......@@ -74,7 +74,7 @@ ___
#### Defined in
[Node.ts:43](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L43)
[Node.ts:43](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L43)
___
......@@ -88,7 +88,7 @@ ___
#### Defined in
[Node.ts:44](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L44)
[Node.ts:44](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L44)
___
......@@ -102,7 +102,7 @@ ___
#### Defined in
[Node.ts:46](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L46)
[Node.ts:46](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L46)
___
......@@ -116,7 +116,7 @@ ___
#### Defined in
[Node.ts:38](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L38)
[Node.ts:38](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L38)
___
......@@ -130,7 +130,7 @@ ___
#### Defined in
[Node.ts:42](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L42)
[Node.ts:42](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L42)
___
......@@ -144,7 +144,7 @@ ___
#### Defined in
[Node.ts:142](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L142)
[Node.ts:142](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L142)
___
......@@ -158,7 +158,7 @@ ___
#### Defined in
[Node.ts:45](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L45)
[Node.ts:45](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L45)
___
......@@ -172,7 +172,7 @@ ___
#### Defined in
[Node.ts:138](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L138)
[Node.ts:138](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L138)
___
......@@ -186,7 +186,7 @@ ___
#### Defined in
[Node.ts:137](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L137)
[Node.ts:137](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L137)
## Accessors
......@@ -204,7 +204,7 @@ TextNode.childNodes
#### Defined in
[Node.ts:104](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L104)
[Node.ts:104](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L104)
___
......@@ -218,7 +218,7 @@ ___
#### Defined in
[Node.ts:225](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L225)
[Node.ts:225](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L225)
___
......@@ -236,7 +236,7 @@ TextNode.nextNode
#### Defined in
[Node.ts:84](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L84)
[Node.ts:84](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L84)
___
......@@ -254,7 +254,7 @@ TextNode.nodeId
#### Defined in
[Node.ts:58](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L58)
[Node.ts:58](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L58)
___
......@@ -272,7 +272,7 @@ TextNode.parentNode
#### Defined in
[Node.ts:94](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L94)
[Node.ts:94](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L94)
___
......@@ -290,7 +290,7 @@ TextNode.prevNode
#### Defined in
[Node.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L72)
[Node.ts:72](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L72)
___
......@@ -308,7 +308,7 @@ TextNode.sourceNode
#### Defined in
[Node.ts:62](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L62)
[Node.ts:62](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L62)
## Methods
......@@ -326,7 +326,7 @@ TextNode.sourceNode
#### Defined in
[Node.ts:124](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L124)
[Node.ts:124](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L124)
___
......@@ -344,7 +344,7 @@ ___
#### Defined in
[Node.ts:149](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L149)
[Node.ts:149](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L149)
___
......@@ -368,7 +368,7 @@ ___
#### Defined in
[Node.ts:157](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L157)
[Node.ts:157](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L157)
___
......@@ -386,7 +386,7 @@ ___
#### Defined in
[Node.ts:116](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L116)
[Node.ts:116](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L116)
___
......@@ -410,7 +410,7 @@ ___
#### Defined in
[Node.ts:162](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L162)
[Node.ts:162](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L162)
___
......@@ -433,7 +433,7 @@ ___
#### Defined in
[Node.ts:187](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L187)
[Node.ts:187](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L187)
___
......@@ -451,7 +451,7 @@ ___
#### Defined in
[Node.ts:191](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L191)
[Node.ts:191](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L191)
___
......@@ -469,7 +469,7 @@ ___
#### Defined in
[Node.ts:221](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L221)
[Node.ts:221](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L221)
___
......@@ -493,4 +493,4 @@ ___
#### Defined in
[Node.ts:183](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L183)
[Node.ts:183](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L183)
apps/docs/docs/api/classes/InMemoryFileSystem.md
+ 5
− 5
View file @ 07c5aeba
......@@ -26,7 +26,7 @@ A filesystem implementation that stores files in memory.
#### Defined in
[storage/FileSystem.ts:25](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L25)
[storage/FileSystem.ts:25](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/FileSystem.ts#L25)
## Methods
......@@ -50,7 +50,7 @@ A filesystem implementation that stores files in memory.
#### Defined in
[storage/FileSystem.ts:38](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L38)
[storage/FileSystem.ts:38](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/FileSystem.ts#L38)
___
......@@ -75,7 +75,7 @@ ___
#### Defined in
[storage/FileSystem.ts:44](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L44)
[storage/FileSystem.ts:44](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/FileSystem.ts#L44)
___
......@@ -100,7 +100,7 @@ ___
#### Defined in
[storage/FileSystem.ts:31](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L31)
[storage/FileSystem.ts:31](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/FileSystem.ts#L31)
___
......@@ -126,4 +126,4 @@ ___
#### Defined in
[storage/FileSystem.ts:27](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L27)
[storage/FileSystem.ts:27](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/FileSystem.ts#L27)
apps/docs/docs/api/classes/IndexDict.md
+ 7
− 7
View file @ 07c5aeba
......@@ -33,7 +33,7 @@ The underlying structure of each index.
#### Defined in
[BaseIndex.ts:21](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L21)
[BaseIndex.ts:21](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L21)
## Properties
......@@ -43,7 +43,7 @@ The underlying structure of each index.
#### Defined in
[BaseIndex.ts:36](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L36)
[BaseIndex.ts:36](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L36)
___
......@@ -57,7 +57,7 @@ ___
#### Defined in
[BaseIndex.ts:18](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L18)
[BaseIndex.ts:18](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L18)
___
......@@ -67,7 +67,7 @@ ___
#### Defined in
[BaseIndex.ts:35](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L35)
[BaseIndex.ts:35](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L35)
___
......@@ -81,7 +81,7 @@ ___
#### Defined in
[BaseIndex.ts:19](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L19)
[BaseIndex.ts:19](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L19)
## Methods
......@@ -102,7 +102,7 @@ ___
#### Defined in
[BaseIndex.ts:45](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L45)
[BaseIndex.ts:45](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L45)
___
......@@ -120,4 +120,4 @@ ___
#### Defined in
[BaseIndex.ts:38](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L38)
[BaseIndex.ts:38](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L38)
apps/docs/docs/api/classes/IndexList.md
+ 6
− 6
View file @ 07c5aeba
......@@ -33,7 +33,7 @@ The underlying structure of each index.
#### Defined in
[BaseIndex.ts:21](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L21)
[BaseIndex.ts:21](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L21)
## Properties
......@@ -47,7 +47,7 @@ The underlying structure of each index.
#### Defined in
[BaseIndex.ts:18](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L18)
[BaseIndex.ts:18](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L18)
___
......@@ -57,7 +57,7 @@ ___
#### Defined in
[BaseIndex.ts:52](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L52)
[BaseIndex.ts:52](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L52)
___
......@@ -71,7 +71,7 @@ ___
#### Defined in
[BaseIndex.ts:19](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L19)
[BaseIndex.ts:19](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L19)
## Methods
......@@ -91,7 +91,7 @@ ___
#### Defined in
[BaseIndex.ts:54](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L54)
[BaseIndex.ts:54](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L54)
___
......@@ -109,4 +109,4 @@ ___
#### Defined in
[BaseIndex.ts:26](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L26)
[BaseIndex.ts:26](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L26)
apps/docs/docs/api/classes/IndexNode.md
+ 28
− 28
View file @ 07c5aeba
......@@ -32,7 +32,7 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
#### Defined in
[Node.ts:144](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L144)
[Node.ts:144](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L144)
## Properties
......@@ -46,7 +46,7 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
#### Defined in
[Node.ts:39](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L39)
[Node.ts:39](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L39)
___
......@@ -60,7 +60,7 @@ ___
#### Defined in
[Node.ts:139](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L139)
[Node.ts:139](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L139)
___
......@@ -74,7 +74,7 @@ ___
#### Defined in
[Node.ts:43](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L43)
[Node.ts:43](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L43)
___
......@@ -88,7 +88,7 @@ ___
#### Defined in
[Node.ts:44](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L44)
[Node.ts:44](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L44)
___
......@@ -102,7 +102,7 @@ ___
#### Defined in
[Node.ts:46](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L46)
[Node.ts:46](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L46)
___
......@@ -116,7 +116,7 @@ ___
#### Defined in
[Node.ts:38](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L38)
[Node.ts:38](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L38)
___
......@@ -126,7 +126,7 @@ ___
#### Defined in
[Node.ts:205](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L205)
[Node.ts:205](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L205)
___
......@@ -140,7 +140,7 @@ ___
#### Defined in
[Node.ts:42](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L42)
[Node.ts:42](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L42)
___
......@@ -154,7 +154,7 @@ ___
#### Defined in
[Node.ts:142](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L142)
[Node.ts:142](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L142)
___
......@@ -168,7 +168,7 @@ ___
#### Defined in
[Node.ts:45](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L45)
[Node.ts:45](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L45)
___
......@@ -182,7 +182,7 @@ ___
#### Defined in
[Node.ts:138](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L138)
[Node.ts:138](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L138)
___
......@@ -196,7 +196,7 @@ ___
#### Defined in
[Node.ts:137](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L137)
[Node.ts:137](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L137)
## Accessors
......@@ -214,7 +214,7 @@ TextNode.childNodes
#### Defined in
[Node.ts:104](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L104)
[Node.ts:104](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L104)
___
......@@ -232,7 +232,7 @@ TextNode.nextNode
#### Defined in
[Node.ts:84](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L84)
[Node.ts:84](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L84)
___
......@@ -250,7 +250,7 @@ TextNode.nodeId
#### Defined in
[Node.ts:58](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L58)
[Node.ts:58](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L58)
___
......@@ -268,7 +268,7 @@ TextNode.parentNode
#### Defined in
[Node.ts:94](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L94)
[Node.ts:94](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L94)
___
......@@ -286,7 +286,7 @@ TextNode.prevNode
#### Defined in
[Node.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L72)
[Node.ts:72](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L72)
___
......@@ -304,7 +304,7 @@ TextNode.sourceNode
#### Defined in
[Node.ts:62](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L62)
[Node.ts:62](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L62)
## Methods
......@@ -322,7 +322,7 @@ TextNode.sourceNode
#### Defined in
[Node.ts:124](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L124)
[Node.ts:124](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L124)
___
......@@ -340,7 +340,7 @@ ___
#### Defined in
[Node.ts:149](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L149)
[Node.ts:149](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L149)
___
......@@ -364,7 +364,7 @@ ___
#### Defined in
[Node.ts:157](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L157)
[Node.ts:157](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L157)
___
......@@ -382,7 +382,7 @@ ___
#### Defined in
[Node.ts:116](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L116)
[Node.ts:116](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L116)
___
......@@ -406,7 +406,7 @@ ___
#### Defined in
[Node.ts:162](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L162)
[Node.ts:162](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L162)
___
......@@ -429,7 +429,7 @@ ___
#### Defined in
[Node.ts:187](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L187)
[Node.ts:187](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L187)
___
......@@ -447,7 +447,7 @@ ___
#### Defined in
[Node.ts:191](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L191)
[Node.ts:191](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L191)
___
......@@ -465,7 +465,7 @@ ___
#### Defined in
[Node.ts:207](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L207)
[Node.ts:207](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L207)
___
......@@ -489,4 +489,4 @@ ___
#### Defined in
[Node.ts:183](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L183)
[Node.ts:183](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L183)
apps/docs/docs/api/classes/IndexStruct.md
+ 4
− 4
View file @ 07c5aeba
......@@ -31,7 +31,7 @@ The underlying structure of each index.
#### Defined in
[BaseIndex.ts:21](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L21)
[BaseIndex.ts:21](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L21)
## Properties
......@@ -41,7 +41,7 @@ The underlying structure of each index.
#### Defined in
[BaseIndex.ts:18](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L18)
[BaseIndex.ts:18](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L18)
___
......@@ -51,7 +51,7 @@ ___
#### Defined in
[BaseIndex.ts:19](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L19)
[BaseIndex.ts:19](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L19)
## Methods
......@@ -65,4 +65,4 @@ ___
#### Defined in
[BaseIndex.ts:26](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L26)
[BaseIndex.ts:26](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L26)
apps/docs/docs/api/classes/LLMQuestionGenerator.md
+ 5
− 5
View file @ 07c5aeba
......@@ -26,7 +26,7 @@ LLMQuestionGenerator uses the LLM to generate new questions for the LLM using to
#### Defined in
[QuestionGenerator.ts:34](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QuestionGenerator.ts#L34)
[QuestionGenerator.ts:34](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QuestionGenerator.ts#L34)
## Properties
......@@ -36,7 +36,7 @@ LLMQuestionGenerator uses the LLM to generate new questions for the LLM using to
#### Defined in
[QuestionGenerator.ts:30](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QuestionGenerator.ts#L30)
[QuestionGenerator.ts:30](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QuestionGenerator.ts#L30)
___
......@@ -46,7 +46,7 @@ ___
#### Defined in
[QuestionGenerator.ts:32](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QuestionGenerator.ts#L32)
[QuestionGenerator.ts:32](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QuestionGenerator.ts#L32)
___
......@@ -56,7 +56,7 @@ ___
#### Defined in
[QuestionGenerator.ts:31](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QuestionGenerator.ts#L31)
[QuestionGenerator.ts:31](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QuestionGenerator.ts#L31)
## Methods
......@@ -81,4 +81,4 @@ ___
#### Defined in
[QuestionGenerator.ts:40](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QuestionGenerator.ts#L40)
[QuestionGenerator.ts:40](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QuestionGenerator.ts#L40)
apps/docs/docs/api/classes/ListIndex.md
+ 15
− 15
View file @ 07c5aeba
......@@ -32,7 +32,7 @@ A ListIndex keeps nodes in a sequential list structure
#### Defined in
[index/list/ListIndex.ts:37](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L37)
[index/list/ListIndex.ts:37](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L37)
## Properties
......@@ -46,7 +46,7 @@ A ListIndex keeps nodes in a sequential list structure
#### Defined in
[BaseIndex.ts:70](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L70)
[BaseIndex.ts:75](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L75)
___
......@@ -60,7 +60,7 @@ ___
#### Defined in
[BaseIndex.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L72)
[BaseIndex.ts:77](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L77)
___
......@@ -74,7 +74,7 @@ ___
#### Defined in
[BaseIndex.ts:73](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L73)
[BaseIndex.ts:78](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L78)
___
......@@ -88,7 +88,7 @@ ___
#### Defined in
[BaseIndex.ts:68](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L68)
[BaseIndex.ts:73](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L73)
___
......@@ -102,7 +102,7 @@ ___
#### Defined in
[BaseIndex.ts:69](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L69)
[BaseIndex.ts:74](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L74)
___
......@@ -116,7 +116,7 @@ ___
#### Defined in
[BaseIndex.ts:71](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L71)
[BaseIndex.ts:76](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L76)
## Methods
......@@ -136,7 +136,7 @@ ___
#### Defined in
[index/list/ListIndex.ts:140](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L140)
[index/list/ListIndex.ts:140](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L140)
___
......@@ -156,7 +156,7 @@ ___
#### Defined in
[index/list/ListIndex.ts:134](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L134)
[index/list/ListIndex.ts:134](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L134)
___
......@@ -176,7 +176,7 @@ ___
#### Defined in
[index/list/ListIndex.ts:113](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L113)
[index/list/ListIndex.ts:113](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L113)
___
......@@ -200,7 +200,7 @@ ___
#### Defined in
[index/list/ListIndex.ts:100](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L100)
[index/list/ListIndex.ts:100](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L100)
___
......@@ -214,7 +214,7 @@ ___
#### Defined in
[index/list/ListIndex.ts:146](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L146)
[index/list/ListIndex.ts:146](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L146)
___
......@@ -236,7 +236,7 @@ ___
#### Defined in
[index/list/ListIndex.ts:119](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L119)
[index/list/ListIndex.ts:119](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L119)
___
......@@ -258,7 +258,7 @@ ___
#### Defined in
[index/list/ListIndex.ts:77](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L77)
[index/list/ListIndex.ts:77](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L77)
___
......@@ -278,4 +278,4 @@ ___
#### Defined in
[index/list/ListIndex.ts:41](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L41)
[index/list/ListIndex.ts:41](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L41)
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

:feet::heart: Strive to be the person your dogs believe you are :heart::feet: