From d16113adbb9958b41d642d13855cbeb4e69d3a46 Mon Sep 17 00:00:00 2001
From: Yi Ding <yi.s.ding@gmail.com>
Date: Fri, 14 Jul 2023 14:37:41 -0700
Subject: [PATCH] Added JSDoc to our classes
---
apps/docs/docs/api/classes/BaseEmbedding.md | 6 +-
apps/docs/docs/api/classes/BaseIndex.md | 16 +-
apps/docs/docs/api/classes/BaseNode.md | 40 +-
apps/docs/docs/api/classes/CallbackManager.md | 6 +-
.../docs/api/classes/ChatGPTLLMPredictor.md | 16 +-
.../docs/docs/api/classes/CompactAndRefine.md | 12 +-
.../api/classes/CondenseQuestionChatEngine.md | 47 +-
.../docs/api/classes/ContextChatEngine.md | 22 +-
apps/docs/docs/api/classes/Document.md | 60 +--
apps/docs/docs/api/classes/ImageDocument.md | 510 ------------------
apps/docs/docs/api/classes/ImageNode.md | 492 -----------------
.../docs/api/classes/InMemoryFileSystem.md | 10 +-
apps/docs/docs/api/classes/IndexDict.md | 16 +-
apps/docs/docs/api/classes/IndexList.md | 14 +-
apps/docs/docs/api/classes/IndexNode.md | 58 +-
apps/docs/docs/api/classes/IndexStruct.md | 10 +-
.../docs/api/classes/LLMQuestionGenerator.md | 12 +-
apps/docs/docs/api/classes/ListIndex.md | 36 +-
.../docs/api/classes/ListIndexLLMRetriever.md | 18 +-
.../docs/api/classes/ListIndexRetriever.md | 8 +-
apps/docs/docs/api/classes/OpenAI.md | 40 +-
apps/docs/docs/api/classes/OpenAIEmbedding.md | 14 +-
apps/docs/docs/api/classes/Refine.md | 16 +-
apps/docs/docs/api/classes/Response.md | 12 +-
.../docs/api/classes/ResponseSynthesizer.md | 10 +-
.../docs/api/classes/RetrieverQueryEngine.md | 74 +++
.../docs/docs/api/classes/SentenceSplitter.md | 30 +-
.../docs/docs/api/classes/SimpleChatEngine.md | 30 +-
.../docs/docs/api/classes/SimpleNodeParser.md | 14 +-
.../docs/api/classes/SimpleResponseBuilder.md | 10 +-
.../api/classes/SubQuestionOutputParser.md | 6 +-
.../api/classes/SubQuestionQueryEngine.md | 141 +++++
apps/docs/docs/api/classes/TextFileReader.md | 4 +-
apps/docs/docs/api/classes/TextNode.md | 58 +-
apps/docs/docs/api/classes/TreeSummarize.md | 8 +-
.../docs/api/classes/VectorIndexRetriever.md | 14 +-
.../docs/docs/api/classes/VectorStoreIndex.md | 32 +-
apps/docs/docs/api/enums/ListRetrieverMode.md | 4 +-
apps/docs/docs/api/enums/MetadataMode.md | 8 +-
apps/docs/docs/api/enums/NodeRelationship.md | 10 +-
apps/docs/docs/api/enums/ObjectType.md | 8 +-
apps/docs/docs/api/enums/SimilarityType.md | 9 +-
.../docs/docs/api/interfaces/BaseIndexInit.md | 12 +-
.../docs/api/interfaces/BaseLLMPredictor.md | 6 +-
.../docs/api/interfaces/BaseOutputParser.md | 6 +-
.../docs/api/interfaces/BaseQueryEngine.md | 35 ++
.../api/interfaces/BaseQuestionGenerator.md | 4 +-
apps/docs/docs/api/interfaces/BaseReader.md | 4 +-
.../docs/docs/api/interfaces/BaseRetriever.md | 6 +-
apps/docs/docs/api/interfaces/BaseTool.md | 4 +-
apps/docs/docs/api/interfaces/ChatMessage.md | 4 +-
apps/docs/docs/api/interfaces/ChatResponse.md | 6 +-
apps/docs/docs/api/interfaces/Event.md | 8 +-
.../docs/api/interfaces/GenericFileSystem.md | 8 +-
apps/docs/docs/api/interfaces/LLM.md | 16 +-
apps/docs/docs/api/interfaces/NodeParser.md | 4 +-
.../docs/api/interfaces/NodeWithEmbedding.md | 6 +-
.../docs/docs/api/interfaces/NodeWithScore.md | 6 +-
.../docs/api/interfaces/QueryEngineTool.md | 8 +-
.../docs/api/interfaces/RelatedNodeInfo.md | 8 +-
.../interfaces/RetrievalCallbackResponse.md | 6 +-
.../docs/api/interfaces/ServiceContext.md | 12 +-
.../api/interfaces/ServiceContextOptions.md | 16 +-
.../docs/api/interfaces/StorageContext.md | 6 +-
.../api/interfaces/StreamCallbackResponse.md | 8 +-
apps/docs/docs/api/interfaces/StreamToken.md | 10 +-
.../docs/api/interfaces/StructuredOutput.md | 6 +-
apps/docs/docs/api/interfaces/SubQuestion.md | 4 +-
apps/docs/docs/api/interfaces/ToolMetadata.md | 4 +-
.../docs/api/interfaces/VectorIndexOptions.md | 8 +-
.../docs/api/interfaces/WalkableFileSystem.md | 4 +-
apps/docs/docs/api/modules.md | 125 +++--
apps/docs/docusaurus.config.js | 4 +-
packages/core/src/BaseIndex.ts | 6 +
packages/core/src/ChatEngine.ts | 39 +-
packages/core/src/Embedding.ts | 20 +
packages/core/src/GlobalsHelper.ts | 3 +
packages/core/src/LLM.ts | 18 +
packages/core/src/LLMPredictor.ts | 8 +-
packages/core/src/Node.ts | 30 +-
packages/core/src/NodeParser.ts | 8 +-
packages/core/src/OutputParser.ts | 20 +
packages/core/src/PromptHelper.ts | 43 +-
packages/core/src/QueryEngine.ts | 9 +
packages/core/src/QuestionGenerator.ts | 6 +
packages/core/src/Response.ts | 3 +
packages/core/src/ResponseSynthesizer.ts | 27 +-
packages/core/src/Retriever.ts | 6 +
packages/core/src/ServiceContext.ts | 3 +
packages/core/src/TextSplitter.ts | 3 +
packages/core/src/Tool.ts | 6 +
packages/core/src/index.ts | 1 +
packages/core/src/index/list/ListIndex.ts | 3 +
packages/core/src/openai.ts | 3 +
packages/core/src/readers/PDFReader.ts | 3 +
.../core/src/readers/SimpleDirectoryReader.ts | 6 +
packages/core/src/readers/base.ts | 3 +
97 files changed, 1059 insertions(+), 1543 deletions(-)
delete mode 100644 apps/docs/docs/api/classes/ImageDocument.md
delete mode 100644 apps/docs/docs/api/classes/ImageNode.md
create mode 100644 apps/docs/docs/api/classes/RetrieverQueryEngine.md
create mode 100644 apps/docs/docs/api/classes/SubQuestionQueryEngine.md
create mode 100644 apps/docs/docs/api/interfaces/BaseQueryEngine.md
diff --git a/apps/docs/docs/api/classes/BaseEmbedding.md b/apps/docs/docs/api/classes/BaseEmbedding.md
index a634ab19e..1a672d743 100644
--- a/apps/docs/docs/api/classes/BaseEmbedding.md
+++ b/apps/docs/docs/api/classes/BaseEmbedding.md
@@ -36,7 +36,7 @@ custom_edit_url: null
#### Defined in
-[Embedding.ts:186](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L186)
+[Embedding.ts:206](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L206)
___
@@ -56,7 +56,7 @@ ___
#### Defined in
-[Embedding.ts:185](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L185)
+[Embedding.ts:205](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L205)
___
@@ -78,4 +78,4 @@ ___
#### Defined in
-[Embedding.ts:177](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L177)
+[Embedding.ts:197](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L197)
diff --git a/apps/docs/docs/api/classes/BaseIndex.md b/apps/docs/docs/api/classes/BaseIndex.md
index a8ee1142b..aed91361d 100644
--- a/apps/docs/docs/api/classes/BaseIndex.md
+++ b/apps/docs/docs/api/classes/BaseIndex.md
@@ -40,7 +40,7 @@ custom_edit_url: null
#### Defined in
-[BaseIndex.ts:72](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L72)
+[BaseIndex.ts:75](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L75)
## Properties
@@ -50,7 +50,7 @@ custom_edit_url: null
#### Defined in
-[BaseIndex.ts:67](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L67)
+[BaseIndex.ts:70](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L70)
___
@@ -60,7 +60,7 @@ ___
#### Defined in
-[BaseIndex.ts:69](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L69)
+[BaseIndex.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L72)
___
@@ -70,7 +70,7 @@ ___
#### Defined in
-[BaseIndex.ts:70](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L70)
+[BaseIndex.ts:73](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L73)
___
@@ -80,7 +80,7 @@ ___
#### Defined in
-[BaseIndex.ts:65](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L65)
+[BaseIndex.ts:68](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L68)
___
@@ -90,7 +90,7 @@ ___
#### Defined in
-[BaseIndex.ts:66](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L66)
+[BaseIndex.ts:69](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L69)
___
@@ -100,7 +100,7 @@ ___
#### Defined in
-[BaseIndex.ts:68](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L68)
+[BaseIndex.ts:71](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L71)
## Methods
@@ -114,4 +114,4 @@ ___
#### Defined in
-[BaseIndex.ts:81](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L81)
+[BaseIndex.ts:84](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L84)
diff --git a/apps/docs/docs/api/classes/BaseNode.md b/apps/docs/docs/api/classes/BaseNode.md
index 89319870e..1b39ef7cb 100644
--- a/apps/docs/docs/api/classes/BaseNode.md
+++ b/apps/docs/docs/api/classes/BaseNode.md
@@ -28,7 +28,7 @@ Generic abstract class for retrievable nodes
#### Defined in
-[Node.ts:48](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L48)
+[Node.ts:48](https://github.com/run-llama/llamascript/blob/4649536/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/df4b1ad/packages/core/src/Node.ts#L39)
+[Node.ts:39](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L39)
___
@@ -48,7 +48,7 @@ ___
#### Defined in
-[Node.ts:43](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L43)
+[Node.ts:43](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L43)
___
@@ -58,7 +58,7 @@ ___
#### Defined in
-[Node.ts:44](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L44)
+[Node.ts:44](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L44)
___
@@ -68,7 +68,7 @@ ___
#### Defined in
-[Node.ts:46](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L46)
+[Node.ts:46](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L46)
___
@@ -78,7 +78,7 @@ ___
#### Defined in
-[Node.ts:38](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L38)
+[Node.ts:38](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L38)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
-[Node.ts:42](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L42)
+[Node.ts:42](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L42)
___
@@ -98,7 +98,7 @@ ___
#### Defined in
-[Node.ts:45](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L45)
+[Node.ts:45](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L45)
## Accessors
@@ -112,7 +112,7 @@ ___
#### Defined in
-[Node.ts:104](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L104)
+[Node.ts:104](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L104)
___
@@ -126,7 +126,7 @@ ___
#### Defined in
-[Node.ts:84](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L84)
+[Node.ts:84](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L84)
___
@@ -140,7 +140,7 @@ ___
#### Defined in
-[Node.ts:58](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L58)
+[Node.ts:58](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L58)
___
@@ -154,7 +154,7 @@ ___
#### Defined in
-[Node.ts:94](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L94)
+[Node.ts:94](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L94)
___
@@ -168,7 +168,7 @@ ___
#### Defined in
-[Node.ts:72](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L72)
+[Node.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L72)
___
@@ -182,7 +182,7 @@ ___
#### Defined in
-[Node.ts:62](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L62)
+[Node.ts:62](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L62)
## Methods
@@ -196,7 +196,7 @@ ___
#### Defined in
-[Node.ts:124](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L124)
+[Node.ts:124](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L124)
___
@@ -216,7 +216,7 @@ ___
#### Defined in
-[Node.ts:54](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L54)
+[Node.ts:54](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L54)
___
@@ -230,7 +230,7 @@ ___
#### Defined in
-[Node.ts:116](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L116)
+[Node.ts:116](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L116)
___
@@ -250,7 +250,7 @@ ___
#### Defined in
-[Node.ts:55](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L55)
+[Node.ts:55](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L55)
___
@@ -264,7 +264,7 @@ ___
#### Defined in
-[Node.ts:52](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L52)
+[Node.ts:52](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L52)
___
@@ -284,4 +284,4 @@ ___
#### Defined in
-[Node.ts:56](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L56)
+[Node.ts:56](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L56)
diff --git a/apps/docs/docs/api/classes/CallbackManager.md b/apps/docs/docs/api/classes/CallbackManager.md
index 2b24e8e87..6fc5a3bef 100644
--- a/apps/docs/docs/api/classes/CallbackManager.md
+++ b/apps/docs/docs/api/classes/CallbackManager.md
@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
-[callbacks/CallbackManager.ts:68](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L68)
+[callbacks/CallbackManager.ts:68](https://github.com/run-llama/llamascript/blob/4649536/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/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L65)
+[callbacks/CallbackManager.ts:65](https://github.com/run-llama/llamascript/blob/4649536/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/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L66)
+[callbacks/CallbackManager.ts:66](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L66)
diff --git a/apps/docs/docs/api/classes/ChatGPTLLMPredictor.md b/apps/docs/docs/api/classes/ChatGPTLLMPredictor.md
index d27c807c6..daf7725ec 100644
--- a/apps/docs/docs/api/classes/ChatGPTLLMPredictor.md
+++ b/apps/docs/docs/api/classes/ChatGPTLLMPredictor.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+ChatGPTLLMPredictor is a predictor that uses GPT.
+
## Implements
- [`BaseLLMPredictor`](../interfaces/BaseLLMPredictor.md)
@@ -24,7 +26,7 @@ custom_edit_url: null
#### Defined in
-[LLMPredictor.ts:22](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLMPredictor.ts#L22)
+[LLMPredictor.ts:26](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L26)
## Properties
@@ -34,7 +36,7 @@ custom_edit_url: null
#### Defined in
-[LLMPredictor.ts:20](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLMPredictor.ts#L20)
+[LLMPredictor.ts:24](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L24)
___
@@ -44,7 +46,7 @@ ___
#### Defined in
-[LLMPredictor.ts:19](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLMPredictor.ts#L19)
+[LLMPredictor.ts:23](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L23)
___
@@ -54,7 +56,7 @@ ___
#### Defined in
-[LLMPredictor.ts:17](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLMPredictor.ts#L17)
+[LLMPredictor.ts:21](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L21)
___
@@ -64,7 +66,7 @@ ___
#### Defined in
-[LLMPredictor.ts:18](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLMPredictor.ts#L18)
+[LLMPredictor.ts:22](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L22)
## Methods
@@ -90,7 +92,7 @@ ___
#### Defined in
-[LLMPredictor.ts:45](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLMPredictor.ts#L45)
+[LLMPredictor.ts:49](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L49)
___
@@ -108,4 +110,4 @@ ___
#### Defined in
-[LLMPredictor.ts:41](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLMPredictor.ts#L41)
+[LLMPredictor.ts:45](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L45)
diff --git a/apps/docs/docs/api/classes/CompactAndRefine.md b/apps/docs/docs/api/classes/CompactAndRefine.md
index bcc9be8ae..27b0b7550 100644
--- a/apps/docs/docs/api/classes/CompactAndRefine.md
+++ b/apps/docs/docs/api/classes/CompactAndRefine.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+CompactAndRefine is a slight variation of Refine that first compacts the text chunks into the smallest possible number of chunks.
+
## Hierarchy
- [`Refine`](Refine.md)
@@ -32,7 +34,7 @@ custom_edit_url: null
#### Defined in
-[ResponseSynthesizer.ts:51](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L51)
+[ResponseSynthesizer.ts:66](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L66)
## Properties
@@ -46,7 +48,7 @@ custom_edit_url: null
#### Defined in
-[ResponseSynthesizer.ts:49](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L49)
+[ResponseSynthesizer.ts:64](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L64)
___
@@ -60,7 +62,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:47](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L47)
+[ResponseSynthesizer.ts:62](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L62)
___
@@ -74,7 +76,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:48](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L48)
+[ResponseSynthesizer.ts:63](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L63)
## Methods
@@ -100,4 +102,4 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:133](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L133)
+[ResponseSynthesizer.ts:152](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L152)
diff --git a/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md b/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md
index 767155154..a7e8df2f9 100644
--- a/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md
+++ b/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md
@@ -6,6 +6,15 @@ sidebar_position: 0
custom_edit_url: null
---
+CondenseQuestionChatEngine is used in conjunction with a Index (for example VectorIndex).
+It does two steps on taking a user's chat message: first, it condenses the chat message
+with the previous chat history into a question with more context.
+Then, it queries the underlying Index using the new question with context and returns
+the response.
+CondenseQuestionChatEngine performs well when the input is primarily questions about the
+underlying data. It performs less well when the chat messages are not questions about the
+data, or are very referential to previous context.
+
## Implements
- `ChatEngine`
@@ -23,12 +32,12 @@ custom_edit_url: null
| `init` | `Object` |
| `init.chatHistory` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
| `init.condenseMessagePrompt?` | [`SimplePrompt`](../modules.md#simpleprompt) |
-| `init.queryEngine` | `BaseQueryEngine` |
+| `init.queryEngine` | [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) |
| `init.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
#### Defined in
-[ChatEngine.ts:57](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L57)
+[ChatEngine.ts:75](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L75)
## Properties
@@ -38,7 +47,7 @@ custom_edit_url: null
#### Defined in
-[ChatEngine.ts:53](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L53)
+[ChatEngine.ts:71](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L71)
___
@@ -48,17 +57,17 @@ ___
#### Defined in
-[ChatEngine.ts:55](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L55)
+[ChatEngine.ts:73](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L73)
___
### queryEngine
-• **queryEngine**: `BaseQueryEngine`
+• **queryEngine**: [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
#### Defined in
-[ChatEngine.ts:52](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L52)
+[ChatEngine.ts:70](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L70)
___
@@ -68,7 +77,7 @@ ___
#### Defined in
-[ChatEngine.ts:54](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L54)
+[ChatEngine.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L72)
## Methods
@@ -93,7 +102,7 @@ ChatEngine.achat
#### Defined in
-[ChatEngine.ts:86](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L86)
+[ChatEngine.ts:104](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L104)
___
@@ -114,25 +123,7 @@ ___
#### Defined in
-[ChatEngine.ts:71](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L71)
-
-___
-
-### chatRepl
-
-â–¸ **chatRepl**(): `void`
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-ChatEngine.chatRepl
-
-#### Defined in
-
-[ChatEngine.ts:105](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L105)
+[ChatEngine.ts:89](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L89)
___
@@ -150,4 +141,4 @@ ChatEngine.reset
#### Defined in
-[ChatEngine.ts:109](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L109)
+[ChatEngine.ts:123](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L123)
diff --git a/apps/docs/docs/api/classes/ContextChatEngine.md b/apps/docs/docs/api/classes/ContextChatEngine.md
index f33662a59..5e770f83c 100644
--- a/apps/docs/docs/api/classes/ContextChatEngine.md
+++ b/apps/docs/docs/api/classes/ContextChatEngine.md
@@ -6,6 +6,10 @@ sidebar_position: 0
custom_edit_url: null
---
+ContextChatEngine uses the Index to get the appropriate context for each query.
+The context is stored in the system prompt, and the chat history is preserved,
+ideally allowing the appropriate context to be surfaced for each query.
+
## Implements
- `ChatEngine`
@@ -27,7 +31,7 @@ custom_edit_url: null
#### Defined in
-[ChatEngine.ts:119](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L119)
+[ChatEngine.ts:138](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L138)
## Properties
@@ -37,7 +41,7 @@ custom_edit_url: null
#### Defined in
-[ChatEngine.ts:117](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L117)
+[ChatEngine.ts:136](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L136)
___
@@ -47,7 +51,7 @@ ___
#### Defined in
-[ChatEngine.ts:116](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L116)
+[ChatEngine.ts:135](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L135)
___
@@ -57,7 +61,7 @@ ___
#### Defined in
-[ChatEngine.ts:115](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L115)
+[ChatEngine.ts:134](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L134)
## Methods
@@ -82,7 +86,7 @@ ChatEngine.achat
#### Defined in
-[ChatEngine.ts:134](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L134)
+[ChatEngine.ts:153](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L153)
___
@@ -94,13 +98,9 @@ ___
`void`
-#### Implementation of
-
-ChatEngine.chatRepl
-
#### Defined in
-[ChatEngine.ts:130](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L130)
+[ChatEngine.ts:149](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L149)
___
@@ -118,4 +118,4 @@ ChatEngine.reset
#### Defined in
-[ChatEngine.ts:172](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L172)
+[ChatEngine.ts:191](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L191)
diff --git a/apps/docs/docs/api/classes/Document.md b/apps/docs/docs/api/classes/Document.md
index a38cc94c0..bbc9bee2d 100644
--- a/apps/docs/docs/api/classes/Document.md
+++ b/apps/docs/docs/api/classes/Document.md
@@ -6,7 +6,7 @@ sidebar_position: 0
custom_edit_url: null
---
-Generic abstract class for retrievable nodes
+A document is just a special text node with a docId.
## Hierarchy
@@ -14,8 +14,6 @@ Generic abstract class for retrievable nodes
↳ **`Document`**
- ↳↳ [`ImageDocument`](ImageDocument.md)
-
## Constructors
### constructor
@@ -34,7 +32,7 @@ Generic abstract class for retrievable nodes
#### Defined in
-[Node.ts:210](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L210)
+[Node.ts:216](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L216)
## Properties
@@ -48,7 +46,7 @@ Generic abstract class for retrievable nodes
#### Defined in
-[Node.ts:39](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L39)
+[Node.ts:39](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L39)
___
@@ -62,7 +60,7 @@ ___
#### Defined in
-[Node.ts:136](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L136)
+[Node.ts:139](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L139)
___
@@ -76,7 +74,7 @@ ___
#### Defined in
-[Node.ts:43](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L43)
+[Node.ts:43](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L43)
___
@@ -90,7 +88,7 @@ ___
#### Defined in
-[Node.ts:44](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L44)
+[Node.ts:44](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L44)
___
@@ -104,7 +102,7 @@ ___
#### Defined in
-[Node.ts:46](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L46)
+[Node.ts:46](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L46)
___
@@ -118,7 +116,7 @@ ___
#### Defined in
-[Node.ts:38](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L38)
+[Node.ts:38](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L38)
___
@@ -132,7 +130,7 @@ ___
#### Defined in
-[Node.ts:42](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L42)
+[Node.ts:42](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L42)
___
@@ -146,7 +144,7 @@ ___
#### Defined in
-[Node.ts:139](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L139)
+[Node.ts:142](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L142)
___
@@ -160,7 +158,7 @@ ___
#### Defined in
-[Node.ts:45](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L45)
+[Node.ts:45](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L45)
___
@@ -174,7 +172,7 @@ ___
#### Defined in
-[Node.ts:135](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L135)
+[Node.ts:138](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L138)
___
@@ -188,7 +186,7 @@ ___
#### Defined in
-[Node.ts:134](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L134)
+[Node.ts:137](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L137)
## Accessors
@@ -206,7 +204,7 @@ TextNode.childNodes
#### Defined in
-[Node.ts:104](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L104)
+[Node.ts:104](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L104)
___
@@ -220,7 +218,7 @@ ___
#### Defined in
-[Node.ts:219](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L219)
+[Node.ts:225](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L225)
___
@@ -238,7 +236,7 @@ TextNode.nextNode
#### Defined in
-[Node.ts:84](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L84)
+[Node.ts:84](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L84)
___
@@ -256,7 +254,7 @@ TextNode.nodeId
#### Defined in
-[Node.ts:58](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L58)
+[Node.ts:58](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L58)
___
@@ -274,7 +272,7 @@ TextNode.parentNode
#### Defined in
-[Node.ts:94](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L94)
+[Node.ts:94](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L94)
___
@@ -292,7 +290,7 @@ TextNode.prevNode
#### Defined in
-[Node.ts:72](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L72)
+[Node.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L72)
___
@@ -310,7 +308,7 @@ TextNode.sourceNode
#### Defined in
-[Node.ts:62](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L62)
+[Node.ts:62](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L62)
## Methods
@@ -328,7 +326,7 @@ TextNode.sourceNode
#### Defined in
-[Node.ts:124](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L124)
+[Node.ts:124](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L124)
___
@@ -346,7 +344,7 @@ ___
#### Defined in
-[Node.ts:146](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L146)
+[Node.ts:149](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L149)
___
@@ -370,7 +368,7 @@ ___
#### Defined in
-[Node.ts:154](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L154)
+[Node.ts:157](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L157)
___
@@ -388,7 +386,7 @@ ___
#### Defined in
-[Node.ts:116](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L116)
+[Node.ts:116](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L116)
___
@@ -412,7 +410,7 @@ ___
#### Defined in
-[Node.ts:159](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L159)
+[Node.ts:162](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L162)
___
@@ -435,7 +433,7 @@ ___
#### Defined in
-[Node.ts:184](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L184)
+[Node.ts:187](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L187)
___
@@ -453,7 +451,7 @@ ___
#### Defined in
-[Node.ts:188](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L188)
+[Node.ts:191](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L191)
___
@@ -471,7 +469,7 @@ ___
#### Defined in
-[Node.ts:215](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L215)
+[Node.ts:221](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L221)
___
@@ -495,4 +493,4 @@ ___
#### Defined in
-[Node.ts:180](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L180)
+[Node.ts:183](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L183)
diff --git a/apps/docs/docs/api/classes/ImageDocument.md b/apps/docs/docs/api/classes/ImageDocument.md
deleted file mode 100644
index 0301fc1fc..000000000
--- a/apps/docs/docs/api/classes/ImageDocument.md
+++ /dev/null
@@ -1,510 +0,0 @@
----
-id: "ImageDocument"
-title: "Class: ImageDocument"
-sidebar_label: "ImageDocument"
-sidebar_position: 0
-custom_edit_url: null
----
-
-Generic abstract class for retrievable nodes
-
-## Hierarchy
-
-- [`Document`](Document.md)
-
- ↳ **`ImageDocument`**
-
-## Constructors
-
-### constructor
-
-• **new ImageDocument**(`init?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `init?` | `Partial`<[`Document`](Document.md)\> |
-
-#### Inherited from
-
-[Document](Document.md).[constructor](Document.md#constructor)
-
-#### Defined in
-
-[Node.ts:210](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L210)
-
-## Properties
-
-### embedding
-
-• `Optional` **embedding**: `number`[]
-
-#### Inherited from
-
-[Document](Document.md).[embedding](Document.md#embedding)
-
-#### Defined in
-
-[Node.ts:39](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L39)
-
-___
-
-### endCharIdx
-
-• `Optional` **endCharIdx**: `number`
-
-#### Inherited from
-
-[Document](Document.md).[endCharIdx](Document.md#endcharidx)
-
-#### Defined in
-
-[Node.ts:136](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L136)
-
-___
-
-### excludedEmbedMetadataKeys
-
-• **excludedEmbedMetadataKeys**: `string`[] = `[]`
-
-#### Inherited from
-
-[Document](Document.md).[excludedEmbedMetadataKeys](Document.md#excludedembedmetadatakeys)
-
-#### Defined in
-
-[Node.ts:43](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L43)
-
-___
-
-### excludedLlmMetadataKeys
-
-• **excludedLlmMetadataKeys**: `string`[] = `[]`
-
-#### Inherited from
-
-[Document](Document.md).[excludedLlmMetadataKeys](Document.md#excludedllmmetadatakeys)
-
-#### Defined in
-
-[Node.ts:44](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L44)
-
-___
-
-### hash
-
-• **hash**: `string` = `""`
-
-#### Inherited from
-
-[Document](Document.md).[hash](Document.md#hash)
-
-#### Defined in
-
-[Node.ts:46](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L46)
-
-___
-
-### id\_
-
-• **id\_**: `string`
-
-#### Inherited from
-
-[Document](Document.md).[id_](Document.md#id_)
-
-#### Defined in
-
-[Node.ts:38](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L38)
-
-___
-
-### image
-
-• `Optional` **image**: `string`
-
-#### Defined in
-
-[Node.ts:225](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L225)
-
-___
-
-### metadata
-
-• **metadata**: `Record`<`string`, `any`\> = `{}`
-
-#### Inherited from
-
-[Document](Document.md).[metadata](Document.md#metadata)
-
-#### Defined in
-
-[Node.ts:42](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L42)
-
-___
-
-### metadataSeparator
-
-• **metadataSeparator**: `string` = `"\n"`
-
-#### Inherited from
-
-[Document](Document.md).[metadataSeparator](Document.md#metadataseparator)
-
-#### Defined in
-
-[Node.ts:139](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L139)
-
-___
-
-### relationships
-
-• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../modules.md#relatednodetype)\>\> = `{}`
-
-#### Inherited from
-
-[Document](Document.md).[relationships](Document.md#relationships)
-
-#### Defined in
-
-[Node.ts:45](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L45)
-
-___
-
-### startCharIdx
-
-• `Optional` **startCharIdx**: `number`
-
-#### Inherited from
-
-[Document](Document.md).[startCharIdx](Document.md#startcharidx)
-
-#### Defined in
-
-[Node.ts:135](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L135)
-
-___
-
-### text
-
-• **text**: `string` = `""`
-
-#### Inherited from
-
-[Document](Document.md).[text](Document.md#text)
-
-#### Defined in
-
-[Node.ts:134](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L134)
-
-## Accessors
-
-### childNodes
-
-• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
-
-#### Inherited from
-
-Document.childNodes
-
-#### Defined in
-
-[Node.ts:104](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L104)
-
-___
-
-### docId
-
-• `get` **docId**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-Document.docId
-
-#### Defined in
-
-[Node.ts:219](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L219)
-
-___
-
-### nextNode
-
-• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-Document.nextNode
-
-#### Defined in
-
-[Node.ts:84](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L84)
-
-___
-
-### nodeId
-
-• `get` **nodeId**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-Document.nodeId
-
-#### Defined in
-
-[Node.ts:58](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L58)
-
-___
-
-### parentNode
-
-• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-Document.parentNode
-
-#### Defined in
-
-[Node.ts:94](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L94)
-
-___
-
-### prevNode
-
-• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-Document.prevNode
-
-#### Defined in
-
-[Node.ts:72](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L72)
-
-___
-
-### sourceNode
-
-• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-Document.sourceNode
-
-#### Defined in
-
-[Node.ts:62](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L62)
-
-## Methods
-
-### asRelatedNodeInfo
-
-â–¸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-[Document](Document.md).[asRelatedNodeInfo](Document.md#asrelatednodeinfo)
-
-#### Defined in
-
-[Node.ts:124](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L124)
-
-___
-
-### generateHash
-
-â–¸ **generateHash**(): `void`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Document](Document.md).[generateHash](Document.md#generatehash)
-
-#### Defined in
-
-[Node.ts:146](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L146)
-
-___
-
-### getContent
-
-â–¸ **getContent**(`metadataMode?`): `string`
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[Document](Document.md).[getContent](Document.md#getcontent)
-
-#### Defined in
-
-[Node.ts:154](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L154)
-
-___
-
-### getEmbedding
-
-â–¸ **getEmbedding**(): `number`[]
-
-#### Returns
-
-`number`[]
-
-#### Inherited from
-
-[Document](Document.md).[getEmbedding](Document.md#getembedding)
-
-#### Defined in
-
-[Node.ts:116](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L116)
-
-___
-
-### getMetadataStr
-
-â–¸ **getMetadataStr**(`metadataMode`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[Document](Document.md).[getMetadataStr](Document.md#getmetadatastr)
-
-#### Defined in
-
-[Node.ts:159](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L159)
-
-___
-
-### getNodeInfo
-
-â–¸ **getNodeInfo**(): `Object`
-
-#### Returns
-
-`Object`
-
-| Name | Type |
-| :------ | :------ |
-| `end` | `undefined` \| `number` |
-| `start` | `undefined` \| `number` |
-
-#### Inherited from
-
-[Document](Document.md).[getNodeInfo](Document.md#getnodeinfo)
-
-#### Defined in
-
-[Node.ts:184](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L184)
-
-___
-
-### getText
-
-â–¸ **getText**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[Document](Document.md).[getText](Document.md#gettext)
-
-#### Defined in
-
-[Node.ts:188](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L188)
-
-___
-
-### getType
-
-â–¸ **getType**(): [`ObjectType`](../enums/ObjectType.md)
-
-#### Returns
-
-[`ObjectType`](../enums/ObjectType.md)
-
-#### Inherited from
-
-[Document](Document.md).[getType](Document.md#gettype)
-
-#### Defined in
-
-[Node.ts:215](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L215)
-
-___
-
-### setContent
-
-â–¸ **setContent**(`value`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `string` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Document](Document.md).[setContent](Document.md#setcontent)
-
-#### Defined in
-
-[Node.ts:180](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L180)
diff --git a/apps/docs/docs/api/classes/ImageNode.md b/apps/docs/docs/api/classes/ImageNode.md
deleted file mode 100644
index 8430d228e..000000000
--- a/apps/docs/docs/api/classes/ImageNode.md
+++ /dev/null
@@ -1,492 +0,0 @@
----
-id: "ImageNode"
-title: "Class: ImageNode"
-sidebar_label: "ImageNode"
-sidebar_position: 0
-custom_edit_url: null
----
-
-Generic abstract class for retrievable nodes
-
-## Hierarchy
-
-- [`TextNode`](TextNode.md)
-
- ↳ **`ImageNode`**
-
-## Constructors
-
-### constructor
-
-• **new ImageNode**(`init?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `init?` | `Partial`<[`TextNode`](TextNode.md)\> |
-
-#### Inherited from
-
-[TextNode](TextNode.md).[constructor](TextNode.md#constructor)
-
-#### Defined in
-
-[Node.ts:141](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L141)
-
-## Properties
-
-### embedding
-
-• `Optional` **embedding**: `number`[]
-
-#### Inherited from
-
-[TextNode](TextNode.md).[embedding](TextNode.md#embedding)
-
-#### Defined in
-
-[Node.ts:39](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L39)
-
-___
-
-### endCharIdx
-
-• `Optional` **endCharIdx**: `number`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[endCharIdx](TextNode.md#endcharidx)
-
-#### Defined in
-
-[Node.ts:136](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L136)
-
-___
-
-### excludedEmbedMetadataKeys
-
-• **excludedEmbedMetadataKeys**: `string`[] = `[]`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[excludedEmbedMetadataKeys](TextNode.md#excludedembedmetadatakeys)
-
-#### Defined in
-
-[Node.ts:43](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L43)
-
-___
-
-### excludedLlmMetadataKeys
-
-• **excludedLlmMetadataKeys**: `string`[] = `[]`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[excludedLlmMetadataKeys](TextNode.md#excludedllmmetadatakeys)
-
-#### Defined in
-
-[Node.ts:44](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L44)
-
-___
-
-### hash
-
-• **hash**: `string` = `""`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[hash](TextNode.md#hash)
-
-#### Defined in
-
-[Node.ts:46](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L46)
-
-___
-
-### id\_
-
-• **id\_**: `string`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[id_](TextNode.md#id_)
-
-#### Defined in
-
-[Node.ts:38](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L38)
-
-___
-
-### image
-
-• **image**: `string` = `""`
-
-#### Defined in
-
-[Node.ts:194](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L194)
-
-___
-
-### metadata
-
-• **metadata**: `Record`<`string`, `any`\> = `{}`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[metadata](TextNode.md#metadata)
-
-#### Defined in
-
-[Node.ts:42](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L42)
-
-___
-
-### metadataSeparator
-
-• **metadataSeparator**: `string` = `"\n"`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[metadataSeparator](TextNode.md#metadataseparator)
-
-#### Defined in
-
-[Node.ts:139](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L139)
-
-___
-
-### relationships
-
-• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../modules.md#relatednodetype)\>\> = `{}`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[relationships](TextNode.md#relationships)
-
-#### Defined in
-
-[Node.ts:45](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L45)
-
-___
-
-### startCharIdx
-
-• `Optional` **startCharIdx**: `number`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[startCharIdx](TextNode.md#startcharidx)
-
-#### Defined in
-
-[Node.ts:135](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L135)
-
-___
-
-### text
-
-• **text**: `string` = `""`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[text](TextNode.md#text)
-
-#### Defined in
-
-[Node.ts:134](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L134)
-
-## Accessors
-
-### childNodes
-
-• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
-
-#### Inherited from
-
-TextNode.childNodes
-
-#### Defined in
-
-[Node.ts:104](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L104)
-
-___
-
-### nextNode
-
-• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-TextNode.nextNode
-
-#### Defined in
-
-[Node.ts:84](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L84)
-
-___
-
-### nodeId
-
-• `get` **nodeId**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-TextNode.nodeId
-
-#### Defined in
-
-[Node.ts:58](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L58)
-
-___
-
-### parentNode
-
-• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-TextNode.parentNode
-
-#### Defined in
-
-[Node.ts:94](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L94)
-
-___
-
-### prevNode
-
-• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-TextNode.prevNode
-
-#### Defined in
-
-[Node.ts:72](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L72)
-
-___
-
-### sourceNode
-
-• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-TextNode.sourceNode
-
-#### Defined in
-
-[Node.ts:62](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L62)
-
-## Methods
-
-### asRelatedNodeInfo
-
-â–¸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-[TextNode](TextNode.md).[asRelatedNodeInfo](TextNode.md#asrelatednodeinfo)
-
-#### Defined in
-
-[Node.ts:124](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L124)
-
-___
-
-### generateHash
-
-â–¸ **generateHash**(): `void`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[generateHash](TextNode.md#generatehash)
-
-#### Defined in
-
-[Node.ts:146](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L146)
-
-___
-
-### getContent
-
-â–¸ **getContent**(`metadataMode?`): `string`
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[getContent](TextNode.md#getcontent)
-
-#### Defined in
-
-[Node.ts:154](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L154)
-
-___
-
-### getEmbedding
-
-â–¸ **getEmbedding**(): `number`[]
-
-#### Returns
-
-`number`[]
-
-#### Inherited from
-
-[TextNode](TextNode.md).[getEmbedding](TextNode.md#getembedding)
-
-#### Defined in
-
-[Node.ts:116](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L116)
-
-___
-
-### getMetadataStr
-
-â–¸ **getMetadataStr**(`metadataMode`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[getMetadataStr](TextNode.md#getmetadatastr)
-
-#### Defined in
-
-[Node.ts:159](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L159)
-
-___
-
-### getNodeInfo
-
-â–¸ **getNodeInfo**(): `Object`
-
-#### Returns
-
-`Object`
-
-| Name | Type |
-| :------ | :------ |
-| `end` | `undefined` \| `number` |
-| `start` | `undefined` \| `number` |
-
-#### Inherited from
-
-[TextNode](TextNode.md).[getNodeInfo](TextNode.md#getnodeinfo)
-
-#### Defined in
-
-[Node.ts:184](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L184)
-
-___
-
-### getText
-
-â–¸ **getText**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[getText](TextNode.md#gettext)
-
-#### Defined in
-
-[Node.ts:188](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L188)
-
-___
-
-### getType
-
-â–¸ **getType**(): [`ObjectType`](../enums/ObjectType.md)
-
-#### Returns
-
-[`ObjectType`](../enums/ObjectType.md)
-
-#### Overrides
-
-[TextNode](TextNode.md).[getType](TextNode.md#gettype)
-
-#### Defined in
-
-[Node.ts:196](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L196)
-
-___
-
-### setContent
-
-â–¸ **setContent**(`value`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `string` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[setContent](TextNode.md#setcontent)
-
-#### Defined in
-
-[Node.ts:180](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L180)
diff --git a/apps/docs/docs/api/classes/InMemoryFileSystem.md b/apps/docs/docs/api/classes/InMemoryFileSystem.md
index 4c28c8f4e..986941e51 100644
--- a/apps/docs/docs/api/classes/InMemoryFileSystem.md
+++ b/apps/docs/docs/api/classes/InMemoryFileSystem.md
@@ -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/df4b1ad/packages/core/src/storage/FileSystem.ts#L25)
+[storage/FileSystem.ts:25](https://github.com/run-llama/llamascript/blob/4649536/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/df4b1ad/packages/core/src/storage/FileSystem.ts#L38)
+[storage/FileSystem.ts:38](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L38)
___
@@ -75,7 +75,7 @@ ___
#### Defined in
-[storage/FileSystem.ts:44](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/FileSystem.ts#L44)
+[storage/FileSystem.ts:44](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L44)
___
@@ -100,7 +100,7 @@ ___
#### Defined in
-[storage/FileSystem.ts:31](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/FileSystem.ts#L31)
+[storage/FileSystem.ts:31](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L31)
___
@@ -126,4 +126,4 @@ ___
#### Defined in
-[storage/FileSystem.ts:27](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/FileSystem.ts#L27)
+[storage/FileSystem.ts:27](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L27)
diff --git a/apps/docs/docs/api/classes/IndexDict.md b/apps/docs/docs/api/classes/IndexDict.md
index ee9845630..9ca4737dd 100644
--- a/apps/docs/docs/api/classes/IndexDict.md
+++ b/apps/docs/docs/api/classes/IndexDict.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+The underlying structure of each index.
+
## Hierarchy
- [`IndexStruct`](IndexStruct.md)
@@ -31,7 +33,7 @@ custom_edit_url: null
#### Defined in
-[BaseIndex.ts:18](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L18)
+[BaseIndex.ts:21](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L21)
## Properties
@@ -41,7 +43,7 @@ custom_edit_url: null
#### Defined in
-[BaseIndex.ts:33](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L33)
+[BaseIndex.ts:36](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L36)
___
@@ -55,7 +57,7 @@ ___
#### Defined in
-[BaseIndex.ts:15](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L15)
+[BaseIndex.ts:18](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L18)
___
@@ -65,7 +67,7 @@ ___
#### Defined in
-[BaseIndex.ts:32](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L32)
+[BaseIndex.ts:35](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L35)
___
@@ -79,7 +81,7 @@ ___
#### Defined in
-[BaseIndex.ts:16](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L16)
+[BaseIndex.ts:19](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L19)
## Methods
@@ -100,7 +102,7 @@ ___
#### Defined in
-[BaseIndex.ts:42](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L42)
+[BaseIndex.ts:45](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L45)
___
@@ -118,4 +120,4 @@ ___
#### Defined in
-[BaseIndex.ts:35](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L35)
+[BaseIndex.ts:38](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L38)
diff --git a/apps/docs/docs/api/classes/IndexList.md b/apps/docs/docs/api/classes/IndexList.md
index 327a642b9..766f2a4b7 100644
--- a/apps/docs/docs/api/classes/IndexList.md
+++ b/apps/docs/docs/api/classes/IndexList.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+The underlying structure of each index.
+
## Hierarchy
- [`IndexStruct`](IndexStruct.md)
@@ -31,7 +33,7 @@ custom_edit_url: null
#### Defined in
-[BaseIndex.ts:18](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L18)
+[BaseIndex.ts:21](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L21)
## Properties
@@ -45,7 +47,7 @@ custom_edit_url: null
#### Defined in
-[BaseIndex.ts:15](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L15)
+[BaseIndex.ts:18](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L18)
___
@@ -55,7 +57,7 @@ ___
#### Defined in
-[BaseIndex.ts:49](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L49)
+[BaseIndex.ts:52](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L52)
___
@@ -69,7 +71,7 @@ ___
#### Defined in
-[BaseIndex.ts:16](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L16)
+[BaseIndex.ts:19](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L19)
## Methods
@@ -89,7 +91,7 @@ ___
#### Defined in
-[BaseIndex.ts:51](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L51)
+[BaseIndex.ts:54](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L54)
___
@@ -107,4 +109,4 @@ ___
#### Defined in
-[BaseIndex.ts:23](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L23)
+[BaseIndex.ts:26](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L26)
diff --git a/apps/docs/docs/api/classes/IndexNode.md b/apps/docs/docs/api/classes/IndexNode.md
index f755479c0..8013f1a09 100644
--- a/apps/docs/docs/api/classes/IndexNode.md
+++ b/apps/docs/docs/api/classes/IndexNode.md
@@ -6,7 +6,7 @@ sidebar_position: 0
custom_edit_url: null
---
-Generic abstract class for retrievable nodes
+TextNode is the default node type for text. Most common node type in LlamaIndex.TS
## Hierarchy
@@ -32,7 +32,7 @@ Generic abstract class for retrievable nodes
#### Defined in
-[Node.ts:141](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L141)
+[Node.ts:144](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L144)
## Properties
@@ -46,7 +46,7 @@ Generic abstract class for retrievable nodes
#### Defined in
-[Node.ts:39](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L39)
+[Node.ts:39](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L39)
___
@@ -60,7 +60,7 @@ ___
#### Defined in
-[Node.ts:136](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L136)
+[Node.ts:139](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L139)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
-[Node.ts:43](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L43)
+[Node.ts:43](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L43)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
-[Node.ts:44](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L44)
+[Node.ts:44](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L44)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
-[Node.ts:46](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L46)
+[Node.ts:46](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L46)
___
@@ -116,7 +116,7 @@ ___
#### Defined in
-[Node.ts:38](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L38)
+[Node.ts:38](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L38)
___
@@ -126,7 +126,7 @@ ___
#### Defined in
-[Node.ts:202](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L202)
+[Node.ts:205](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L205)
___
@@ -140,7 +140,7 @@ ___
#### Defined in
-[Node.ts:42](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L42)
+[Node.ts:42](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L42)
___
@@ -154,7 +154,7 @@ ___
#### Defined in
-[Node.ts:139](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L139)
+[Node.ts:142](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L142)
___
@@ -168,7 +168,7 @@ ___
#### Defined in
-[Node.ts:45](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L45)
+[Node.ts:45](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L45)
___
@@ -182,7 +182,7 @@ ___
#### Defined in
-[Node.ts:135](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L135)
+[Node.ts:138](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L138)
___
@@ -196,7 +196,7 @@ ___
#### Defined in
-[Node.ts:134](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L134)
+[Node.ts:137](https://github.com/run-llama/llamascript/blob/4649536/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/df4b1ad/packages/core/src/Node.ts#L104)
+[Node.ts:104](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L104)
___
@@ -232,7 +232,7 @@ TextNode.nextNode
#### Defined in
-[Node.ts:84](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L84)
+[Node.ts:84](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L84)
___
@@ -250,7 +250,7 @@ TextNode.nodeId
#### Defined in
-[Node.ts:58](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L58)
+[Node.ts:58](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L58)
___
@@ -268,7 +268,7 @@ TextNode.parentNode
#### Defined in
-[Node.ts:94](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L94)
+[Node.ts:94](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L94)
___
@@ -286,7 +286,7 @@ TextNode.prevNode
#### Defined in
-[Node.ts:72](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L72)
+[Node.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L72)
___
@@ -304,7 +304,7 @@ TextNode.sourceNode
#### Defined in
-[Node.ts:62](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L62)
+[Node.ts:62](https://github.com/run-llama/llamascript/blob/4649536/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/df4b1ad/packages/core/src/Node.ts#L124)
+[Node.ts:124](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L124)
___
@@ -340,7 +340,7 @@ ___
#### Defined in
-[Node.ts:146](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L146)
+[Node.ts:149](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L149)
___
@@ -364,7 +364,7 @@ ___
#### Defined in
-[Node.ts:154](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L154)
+[Node.ts:157](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L157)
___
@@ -382,7 +382,7 @@ ___
#### Defined in
-[Node.ts:116](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L116)
+[Node.ts:116](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L116)
___
@@ -406,7 +406,7 @@ ___
#### Defined in
-[Node.ts:159](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L159)
+[Node.ts:162](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L162)
___
@@ -429,7 +429,7 @@ ___
#### Defined in
-[Node.ts:184](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L184)
+[Node.ts:187](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L187)
___
@@ -447,7 +447,7 @@ ___
#### Defined in
-[Node.ts:188](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L188)
+[Node.ts:191](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L191)
___
@@ -465,7 +465,7 @@ ___
#### Defined in
-[Node.ts:204](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L204)
+[Node.ts:207](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L207)
___
@@ -489,4 +489,4 @@ ___
#### Defined in
-[Node.ts:180](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L180)
+[Node.ts:183](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L183)
diff --git a/apps/docs/docs/api/classes/IndexStruct.md b/apps/docs/docs/api/classes/IndexStruct.md
index cec6be58b..98675ec72 100644
--- a/apps/docs/docs/api/classes/IndexStruct.md
+++ b/apps/docs/docs/api/classes/IndexStruct.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+The underlying structure of each index.
+
## Hierarchy
- **`IndexStruct`**
@@ -29,7 +31,7 @@ custom_edit_url: null
#### Defined in
-[BaseIndex.ts:18](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L18)
+[BaseIndex.ts:21](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L21)
## Properties
@@ -39,7 +41,7 @@ custom_edit_url: null
#### Defined in
-[BaseIndex.ts:15](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L15)
+[BaseIndex.ts:18](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L18)
___
@@ -49,7 +51,7 @@ ___
#### Defined in
-[BaseIndex.ts:16](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L16)
+[BaseIndex.ts:19](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L19)
## Methods
@@ -63,4 +65,4 @@ ___
#### Defined in
-[BaseIndex.ts:23](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L23)
+[BaseIndex.ts:26](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L26)
diff --git a/apps/docs/docs/api/classes/LLMQuestionGenerator.md b/apps/docs/docs/api/classes/LLMQuestionGenerator.md
index f66022725..96d39150e 100644
--- a/apps/docs/docs/api/classes/LLMQuestionGenerator.md
+++ b/apps/docs/docs/api/classes/LLMQuestionGenerator.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+LLMQuestionGenerator uses the LLM to generate new questions for the LLM using tools and a user query.
+
## Implements
- [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md)
@@ -24,7 +26,7 @@ custom_edit_url: null
#### Defined in
-[QuestionGenerator.ts:28](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/QuestionGenerator.ts#L28)
+[QuestionGenerator.ts:34](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QuestionGenerator.ts#L34)
## Properties
@@ -34,7 +36,7 @@ custom_edit_url: null
#### Defined in
-[QuestionGenerator.ts:24](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/QuestionGenerator.ts#L24)
+[QuestionGenerator.ts:30](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QuestionGenerator.ts#L30)
___
@@ -44,7 +46,7 @@ ___
#### Defined in
-[QuestionGenerator.ts:26](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/QuestionGenerator.ts#L26)
+[QuestionGenerator.ts:32](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QuestionGenerator.ts#L32)
___
@@ -54,7 +56,7 @@ ___
#### Defined in
-[QuestionGenerator.ts:25](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/QuestionGenerator.ts#L25)
+[QuestionGenerator.ts:31](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QuestionGenerator.ts#L31)
## Methods
@@ -79,4 +81,4 @@ ___
#### Defined in
-[QuestionGenerator.ts:34](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/QuestionGenerator.ts#L34)
+[QuestionGenerator.ts:40](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QuestionGenerator.ts#L40)
diff --git a/apps/docs/docs/api/classes/ListIndex.md b/apps/docs/docs/api/classes/ListIndex.md
index 2fe2f58f5..4eab46da4 100644
--- a/apps/docs/docs/api/classes/ListIndex.md
+++ b/apps/docs/docs/api/classes/ListIndex.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+A ListIndex keeps nodes in a sequential list structure
+
## Hierarchy
- [`BaseIndex`](BaseIndex.md)<[`IndexList`](IndexList.md)\>
@@ -30,7 +32,7 @@ custom_edit_url: null
#### Defined in
-[index/list/ListIndex.ts:34](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndex.ts#L34)
+[index/list/ListIndex.ts:37](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L37)
## Properties
@@ -44,7 +46,7 @@ custom_edit_url: null
#### Defined in
-[BaseIndex.ts:67](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L67)
+[BaseIndex.ts:70](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L70)
___
@@ -58,7 +60,7 @@ ___
#### Defined in
-[BaseIndex.ts:69](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L69)
+[BaseIndex.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L72)
___
@@ -72,7 +74,7 @@ ___
#### Defined in
-[BaseIndex.ts:70](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L70)
+[BaseIndex.ts:73](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L73)
___
@@ -86,7 +88,7 @@ ___
#### Defined in
-[BaseIndex.ts:65](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L65)
+[BaseIndex.ts:68](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L68)
___
@@ -100,7 +102,7 @@ ___
#### Defined in
-[BaseIndex.ts:66](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L66)
+[BaseIndex.ts:69](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L69)
___
@@ -114,7 +116,7 @@ ___
#### Defined in
-[BaseIndex.ts:68](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L68)
+[BaseIndex.ts:71](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L71)
## Methods
@@ -134,7 +136,7 @@ ___
#### Defined in
-[index/list/ListIndex.ts:137](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndex.ts#L137)
+[index/list/ListIndex.ts:140](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L140)
___
@@ -154,13 +156,13 @@ ___
#### Defined in
-[index/list/ListIndex.ts:131](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndex.ts#L131)
+[index/list/ListIndex.ts:134](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L134)
___
### asQueryEngine
-â–¸ **asQueryEngine**(`mode?`): `BaseQueryEngine`
+â–¸ **asQueryEngine**(`mode?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
#### Parameters
@@ -170,11 +172,11 @@ ___
#### Returns
-`BaseQueryEngine`
+[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
#### Defined in
-[index/list/ListIndex.ts:110](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndex.ts#L110)
+[index/list/ListIndex.ts:113](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L113)
___
@@ -198,7 +200,7 @@ ___
#### Defined in
-[index/list/ListIndex.ts:97](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndex.ts#L97)
+[index/list/ListIndex.ts:100](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L100)
___
@@ -212,7 +214,7 @@ ___
#### Defined in
-[index/list/ListIndex.ts:143](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndex.ts#L143)
+[index/list/ListIndex.ts:146](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L146)
___
@@ -234,7 +236,7 @@ ___
#### Defined in
-[index/list/ListIndex.ts:116](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndex.ts#L116)
+[index/list/ListIndex.ts:119](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L119)
___
@@ -256,7 +258,7 @@ ___
#### Defined in
-[index/list/ListIndex.ts:74](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndex.ts#L74)
+[index/list/ListIndex.ts:77](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L77)
___
@@ -276,4 +278,4 @@ ___
#### Defined in
-[index/list/ListIndex.ts:38](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndex.ts#L38)
+[index/list/ListIndex.ts:41](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L41)
diff --git a/apps/docs/docs/api/classes/ListIndexLLMRetriever.md b/apps/docs/docs/api/classes/ListIndexLLMRetriever.md
index 0e8c11969..51c859be6 100644
--- a/apps/docs/docs/api/classes/ListIndexLLMRetriever.md
+++ b/apps/docs/docs/api/classes/ListIndexLLMRetriever.md
@@ -31,7 +31,7 @@ LLM retriever for ListIndex.
#### Defined in
-[index/list/ListIndexRetriever.ts:67](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndexRetriever.ts#L67)
+[index/list/ListIndexRetriever.ts:67](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndexRetriever.ts#L67)
## Properties
@@ -41,7 +41,7 @@ LLM retriever for ListIndex.
#### Defined in
-[index/list/ListIndexRetriever.ts:62](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndexRetriever.ts#L62)
+[index/list/ListIndexRetriever.ts:62](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndexRetriever.ts#L62)
___
@@ -51,7 +51,7 @@ ___
#### Defined in
-[index/list/ListIndexRetriever.ts:61](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndexRetriever.ts#L61)
+[index/list/ListIndexRetriever.ts:61](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndexRetriever.ts#L61)
___
@@ -61,7 +61,7 @@ ___
#### Defined in
-[index/list/ListIndexRetriever.ts:63](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndexRetriever.ts#L63)
+[index/list/ListIndexRetriever.ts:63](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndexRetriever.ts#L63)
___
@@ -71,7 +71,7 @@ ___
#### Defined in
-[index/list/ListIndexRetriever.ts:60](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndexRetriever.ts#L60)
+[index/list/ListIndexRetriever.ts:60](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndexRetriever.ts#L60)
___
@@ -81,7 +81,7 @@ ___
#### Defined in
-[index/list/ListIndexRetriever.ts:64](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndexRetriever.ts#L64)
+[index/list/ListIndexRetriever.ts:64](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndexRetriever.ts#L64)
___
@@ -91,7 +91,7 @@ ___
#### Defined in
-[index/list/ListIndexRetriever.ts:65](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndexRetriever.ts#L65)
+[index/list/ListIndexRetriever.ts:65](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndexRetriever.ts#L65)
## Methods
@@ -116,7 +116,7 @@ ___
#### Defined in
-[index/list/ListIndexRetriever.ts:84](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndexRetriever.ts#L84)
+[index/list/ListIndexRetriever.ts:84](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndexRetriever.ts#L84)
___
@@ -134,4 +134,4 @@ ___
#### Defined in
-[index/list/ListIndexRetriever.ts:134](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndexRetriever.ts#L134)
+[index/list/ListIndexRetriever.ts:134](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndexRetriever.ts#L134)
diff --git a/apps/docs/docs/api/classes/ListIndexRetriever.md b/apps/docs/docs/api/classes/ListIndexRetriever.md
index 6b484dcc6..7eabc7a59 100644
--- a/apps/docs/docs/api/classes/ListIndexRetriever.md
+++ b/apps/docs/docs/api/classes/ListIndexRetriever.md
@@ -26,7 +26,7 @@ Simple retriever for ListIndex that returns all nodes
#### Defined in
-[index/list/ListIndexRetriever.ts:22](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndexRetriever.ts#L22)
+[index/list/ListIndexRetriever.ts:22](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndexRetriever.ts#L22)
## Properties
@@ -36,7 +36,7 @@ Simple retriever for ListIndex that returns all nodes
#### Defined in
-[index/list/ListIndexRetriever.ts:20](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndexRetriever.ts#L20)
+[index/list/ListIndexRetriever.ts:20](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndexRetriever.ts#L20)
## Methods
@@ -61,7 +61,7 @@ Simple retriever for ListIndex that returns all nodes
#### Defined in
-[index/list/ListIndexRetriever.ts:26](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndexRetriever.ts#L26)
+[index/list/ListIndexRetriever.ts:26](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndexRetriever.ts#L26)
___
@@ -79,4 +79,4 @@ ___
#### Defined in
-[index/list/ListIndexRetriever.ts:51](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndexRetriever.ts#L51)
+[index/list/ListIndexRetriever.ts:51](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndexRetriever.ts#L51)
diff --git a/apps/docs/docs/api/classes/OpenAI.md b/apps/docs/docs/api/classes/OpenAI.md
index 7e7ab3bf9..dcdfffd2b 100644
--- a/apps/docs/docs/api/classes/OpenAI.md
+++ b/apps/docs/docs/api/classes/OpenAI.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+OpenAI LLM implementation
+
## Implements
- [`LLM`](../interfaces/LLM.md)
@@ -24,7 +26,7 @@ custom_edit_url: null
#### Defined in
-[LLM.ts:58](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L58)
+[LLM.ts:76](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L76)
## Properties
@@ -34,7 +36,7 @@ custom_edit_url: null
#### Defined in
-[LLM.ts:56](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L56)
+[LLM.ts:74](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L74)
___
@@ -44,7 +46,7 @@ ___
#### Defined in
-[LLM.ts:51](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L51)
+[LLM.ts:69](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L69)
___
@@ -54,7 +56,7 @@ ___
#### Defined in
-[LLM.ts:53](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L53)
+[LLM.ts:71](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L71)
___
@@ -64,7 +66,7 @@ ___
#### Defined in
-[LLM.ts:48](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L48)
+[LLM.ts:66](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L66)
___
@@ -74,7 +76,7 @@ ___
#### Defined in
-[LLM.ts:52](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L52)
+[LLM.ts:70](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L70)
___
@@ -84,7 +86,7 @@ ___
#### Defined in
-[LLM.ts:54](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L54)
+[LLM.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L72)
___
@@ -94,7 +96,7 @@ ___
#### Defined in
-[LLM.ts:50](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L50)
+[LLM.ts:68](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L68)
___
@@ -104,7 +106,7 @@ ___
#### Defined in
-[LLM.ts:55](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L55)
+[LLM.ts:73](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L73)
___
@@ -114,7 +116,7 @@ ___
#### Defined in
-[LLM.ts:49](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L49)
+[LLM.ts:67](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L67)
## Methods
@@ -122,6 +124,8 @@ ___
â–¸ **achat**(`messages`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+Get a chat response from the LLM
+
#### Parameters
| Name | Type |
@@ -139,7 +143,7 @@ ___
#### Defined in
-[LLM.ts:85](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L85)
+[LLM.ts:103](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L103)
___
@@ -147,12 +151,14 @@ ___
â–¸ **acomplete**(`prompt`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+Get a prompt completion from the LLM
+
#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `prompt` | `string` |
-| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `prompt` | `string` | the prompt to complete |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) | - |
#### Returns
@@ -164,7 +170,7 @@ ___
#### Defined in
-[LLM.ts:127](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L127)
+[LLM.ts:145](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L145)
___
@@ -184,4 +190,4 @@ ___
#### Defined in
-[LLM.ts:70](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L70)
+[LLM.ts:88](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L88)
diff --git a/apps/docs/docs/api/classes/OpenAIEmbedding.md b/apps/docs/docs/api/classes/OpenAIEmbedding.md
index fd63c1509..89855324b 100644
--- a/apps/docs/docs/api/classes/OpenAIEmbedding.md
+++ b/apps/docs/docs/api/classes/OpenAIEmbedding.md
@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
-[Embedding.ts:197](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L197)
+[Embedding.ts:217](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L217)
## Properties
@@ -34,7 +34,7 @@ custom_edit_url: null
#### Defined in
-[Embedding.ts:195](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L195)
+[Embedding.ts:215](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L215)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
-[Embedding.ts:194](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L194)
+[Embedding.ts:214](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L214)
## Methods
@@ -64,7 +64,7 @@ ___
#### Defined in
-[Embedding.ts:204](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L204)
+[Embedding.ts:224](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L224)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
-[Embedding.ts:220](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L220)
+[Embedding.ts:240](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L240)
___
@@ -112,7 +112,7 @@ ___
#### Defined in
-[Embedding.ts:216](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L216)
+[Embedding.ts:236](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L236)
___
@@ -138,4 +138,4 @@ ___
#### Defined in
-[Embedding.ts:177](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L177)
+[Embedding.ts:197](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L197)
diff --git a/apps/docs/docs/api/classes/Refine.md b/apps/docs/docs/api/classes/Refine.md
index b909f6f43..bc688ca7a 100644
--- a/apps/docs/docs/api/classes/Refine.md
+++ b/apps/docs/docs/api/classes/Refine.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+A response builder that uses the query to ask the LLM generate a better response using multiple text chunks.
+
## Hierarchy
- **`Refine`**
@@ -32,7 +34,7 @@ custom_edit_url: null
#### Defined in
-[ResponseSynthesizer.ts:51](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L51)
+[ResponseSynthesizer.ts:66](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L66)
## Properties
@@ -42,7 +44,7 @@ custom_edit_url: null
#### Defined in
-[ResponseSynthesizer.ts:49](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L49)
+[ResponseSynthesizer.ts:64](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L64)
___
@@ -52,7 +54,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:47](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L47)
+[ResponseSynthesizer.ts:62](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L62)
___
@@ -62,7 +64,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:48](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L48)
+[ResponseSynthesizer.ts:63](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L63)
## Methods
@@ -88,7 +90,7 @@ BaseResponseBuilder.agetResponse
#### Defined in
-[ResponseSynthesizer.ts:61](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L61)
+[ResponseSynthesizer.ts:76](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L76)
___
@@ -109,7 +111,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:80](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L80)
+[ResponseSynthesizer.ts:95](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L95)
___
@@ -131,4 +133,4 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:108](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L108)
+[ResponseSynthesizer.ts:123](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L123)
diff --git a/apps/docs/docs/api/classes/Response.md b/apps/docs/docs/api/classes/Response.md
index 60b4d91b0..6a39861f6 100644
--- a/apps/docs/docs/api/classes/Response.md
+++ b/apps/docs/docs/api/classes/Response.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+Respone is the output of a LLM
+
## Constructors
### constructor
@@ -21,7 +23,7 @@ custom_edit_url: null
#### Defined in
-[Response.ts:7](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Response.ts#L7)
+[Response.ts:10](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Response.ts#L10)
## Properties
@@ -31,7 +33,7 @@ custom_edit_url: null
#### Defined in
-[Response.ts:4](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Response.ts#L4)
+[Response.ts:7](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Response.ts#L7)
___
@@ -41,7 +43,7 @@ ___
#### Defined in
-[Response.ts:5](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Response.ts#L5)
+[Response.ts:8](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Response.ts#L8)
## Methods
@@ -55,7 +57,7 @@ ___
#### Defined in
-[Response.ts:12](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Response.ts#L12)
+[Response.ts:15](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Response.ts#L15)
___
@@ -69,4 +71,4 @@ ___
#### Defined in
-[Response.ts:16](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Response.ts#L16)
+[Response.ts:19](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Response.ts#L19)
diff --git a/apps/docs/docs/api/classes/ResponseSynthesizer.md b/apps/docs/docs/api/classes/ResponseSynthesizer.md
index 4ddb7194f..d82299114 100644
--- a/apps/docs/docs/api/classes/ResponseSynthesizer.md
+++ b/apps/docs/docs/api/classes/ResponseSynthesizer.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+A ResponseSynthesizer is used to generate a response from a query and a list of nodes.
+
## Constructors
### constructor
@@ -22,7 +24,7 @@ custom_edit_url: null
#### Defined in
-[ResponseSynthesizer.ts:202](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L202)
+[ResponseSynthesizer.ts:225](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L225)
## Properties
@@ -32,7 +34,7 @@ custom_edit_url: null
#### Defined in
-[ResponseSynthesizer.ts:199](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L199)
+[ResponseSynthesizer.ts:222](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L222)
___
@@ -42,7 +44,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:200](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L200)
+[ResponseSynthesizer.ts:223](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L223)
## Methods
@@ -64,4 +66,4 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:214](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L214)
+[ResponseSynthesizer.ts:237](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L237)
diff --git a/apps/docs/docs/api/classes/RetrieverQueryEngine.md b/apps/docs/docs/api/classes/RetrieverQueryEngine.md
new file mode 100644
index 000000000..563fb37f8
--- /dev/null
+++ b/apps/docs/docs/api/classes/RetrieverQueryEngine.md
@@ -0,0 +1,74 @@
+---
+id: "RetrieverQueryEngine"
+title: "Class: RetrieverQueryEngine"
+sidebar_label: "RetrieverQueryEngine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A query engine that uses a retriever to query an index and then synthesizes the response.
+
+## Implements
+
+- [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+## Constructors
+
+### constructor
+
+• **new RetrieverQueryEngine**(`retriever`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `retriever` | [`BaseRetriever`](../interfaces/BaseRetriever.md) |
+
+#### Defined in
+
+[QueryEngine.ts:29](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QueryEngine.ts#L29)
+
+## Properties
+
+### responseSynthesizer
+
+• **responseSynthesizer**: [`ResponseSynthesizer`](ResponseSynthesizer.md)
+
+#### Defined in
+
+[QueryEngine.ts:27](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QueryEngine.ts#L27)
+
+___
+
+### retriever
+
+• **retriever**: [`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+#### Defined in
+
+[QueryEngine.ts:26](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QueryEngine.ts#L26)
+
+## Methods
+
+### aquery
+
+â–¸ **aquery**(`query`, `parentEvent?`): `Promise`<[`Response`](Response.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`Response`](Response.md)\>
+
+#### Implementation of
+
+[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[aquery](../interfaces/BaseQueryEngine.md#aquery)
+
+#### Defined in
+
+[QueryEngine.ts:36](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QueryEngine.ts#L36)
diff --git a/apps/docs/docs/api/classes/SentenceSplitter.md b/apps/docs/docs/api/classes/SentenceSplitter.md
index d3e3f4545..563b9c2ae 100644
--- a/apps/docs/docs/api/classes/SentenceSplitter.md
+++ b/apps/docs/docs/api/classes/SentenceSplitter.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+SentenceSplitter is our default text splitter that supports splitting into sentences, paragraphs, or fixed length chunks with overlap.
+
## Constructors
### constructor
@@ -25,7 +27,7 @@ custom_edit_url: null
#### Defined in
-[TextSplitter.ts:30](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/TextSplitter.ts#L30)
+[TextSplitter.ts:33](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/TextSplitter.ts#L33)
## Properties
@@ -35,7 +37,7 @@ custom_edit_url: null
#### Defined in
-[TextSplitter.ts:23](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/TextSplitter.ts#L23)
+[TextSplitter.ts:26](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/TextSplitter.ts#L26)
___
@@ -45,7 +47,7 @@ ___
#### Defined in
-[TextSplitter.ts:22](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/TextSplitter.ts#L22)
+[TextSplitter.ts:25](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/TextSplitter.ts#L25)
___
@@ -55,7 +57,7 @@ ___
#### Defined in
-[TextSplitter.ts:27](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/TextSplitter.ts#L27)
+[TextSplitter.ts:30](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/TextSplitter.ts#L30)
___
@@ -65,7 +67,7 @@ ___
#### Defined in
-[TextSplitter.ts:26](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/TextSplitter.ts#L26)
+[TextSplitter.ts:29](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/TextSplitter.ts#L29)
___
@@ -75,7 +77,7 @@ ___
#### Defined in
-[TextSplitter.ts:24](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/TextSplitter.ts#L24)
+[TextSplitter.ts:27](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/TextSplitter.ts#L27)
___
@@ -85,7 +87,7 @@ ___
#### Defined in
-[TextSplitter.ts:25](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/TextSplitter.ts#L25)
+[TextSplitter.ts:28](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/TextSplitter.ts#L28)
## Methods
@@ -106,7 +108,7 @@ ___
#### Defined in
-[TextSplitter.ts:150](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/TextSplitter.ts#L150)
+[TextSplitter.ts:153](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/TextSplitter.ts#L153)
___
@@ -126,7 +128,7 @@ ___
#### Defined in
-[TextSplitter.ts:69](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/TextSplitter.ts#L69)
+[TextSplitter.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/TextSplitter.ts#L72)
___
@@ -147,7 +149,7 @@ ___
#### Defined in
-[TextSplitter.ts:86](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/TextSplitter.ts#L86)
+[TextSplitter.ts:89](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/TextSplitter.ts#L89)
___
@@ -168,7 +170,7 @@ ___
#### Defined in
-[TextSplitter.ts:112](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/TextSplitter.ts#L112)
+[TextSplitter.ts:115](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/TextSplitter.ts#L115)
___
@@ -189,7 +191,7 @@ ___
#### Defined in
-[TextSplitter.ts:125](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/TextSplitter.ts#L125)
+[TextSplitter.ts:128](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/TextSplitter.ts#L128)
___
@@ -210,7 +212,7 @@ ___
#### Defined in
-[TextSplitter.ts:230](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/TextSplitter.ts#L230)
+[TextSplitter.ts:233](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/TextSplitter.ts#L233)
___
@@ -231,4 +233,4 @@ ___
#### Defined in
-[TextSplitter.ts:202](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/TextSplitter.ts#L202)
+[TextSplitter.ts:205](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/TextSplitter.ts#L205)
diff --git a/apps/docs/docs/api/classes/SimpleChatEngine.md b/apps/docs/docs/api/classes/SimpleChatEngine.md
index 1549de0b6..524395e37 100644
--- a/apps/docs/docs/api/classes/SimpleChatEngine.md
+++ b/apps/docs/docs/api/classes/SimpleChatEngine.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+SimpleChatEngine is the simplest possible chat engine. Useful for using your own custom prompts.
+
## Implements
- `ChatEngine`
@@ -24,7 +26,7 @@ custom_edit_url: null
#### Defined in
-[ChatEngine.ts:28](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L28)
+[ChatEngine.ts:40](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L40)
## Properties
@@ -34,7 +36,7 @@ custom_edit_url: null
#### Defined in
-[ChatEngine.ts:25](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L25)
+[ChatEngine.ts:37](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L37)
___
@@ -44,7 +46,7 @@ ___
#### Defined in
-[ChatEngine.ts:26](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L26)
+[ChatEngine.ts:38](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L38)
## Methods
@@ -69,25 +71,7 @@ ChatEngine.achat
#### Defined in
-[ChatEngine.ts:37](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L37)
-
-___
-
-### chatRepl
-
-â–¸ **chatRepl**(): `void`
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-ChatEngine.chatRepl
-
-#### Defined in
-
-[ChatEngine.ts:33](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L33)
+[ChatEngine.ts:45](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L45)
___
@@ -105,4 +89,4 @@ ChatEngine.reset
#### Defined in
-[ChatEngine.ts:46](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ChatEngine.ts#L46)
+[ChatEngine.ts:54](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ChatEngine.ts#L54)
diff --git a/apps/docs/docs/api/classes/SimpleNodeParser.md b/apps/docs/docs/api/classes/SimpleNodeParser.md
index 1db7f3995..254768a06 100644
--- a/apps/docs/docs/api/classes/SimpleNodeParser.md
+++ b/apps/docs/docs/api/classes/SimpleNodeParser.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+SimpleNodeParser is the default NodeParser. It splits documents into TextNodes using a splitter, by default SentenceSplitter
+
## Implements
- [`NodeParser`](../interfaces/NodeParser.md)
@@ -29,7 +31,7 @@ custom_edit_url: null
#### Defined in
-[NodeParser.ts:58](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/NodeParser.ts#L58)
+[NodeParser.ts:64](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/NodeParser.ts#L64)
## Properties
@@ -39,7 +41,7 @@ custom_edit_url: null
#### Defined in
-[NodeParser.ts:55](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/NodeParser.ts#L55)
+[NodeParser.ts:61](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/NodeParser.ts#L61)
___
@@ -49,7 +51,7 @@ ___
#### Defined in
-[NodeParser.ts:56](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/NodeParser.ts#L56)
+[NodeParser.ts:62](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/NodeParser.ts#L62)
___
@@ -59,7 +61,7 @@ ___
#### Defined in
-[NodeParser.ts:54](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/NodeParser.ts#L54)
+[NodeParser.ts:60](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/NodeParser.ts#L60)
## Methods
@@ -85,7 +87,7 @@ Generate Node objects from documents
#### Defined in
-[NodeParser.ts:89](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/NodeParser.ts#L89)
+[NodeParser.ts:95](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/NodeParser.ts#L95)
___
@@ -109,4 +111,4 @@ ___
#### Defined in
-[NodeParser.ts:76](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/NodeParser.ts#L76)
+[NodeParser.ts:82](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/NodeParser.ts#L82)
diff --git a/apps/docs/docs/api/classes/SimpleResponseBuilder.md b/apps/docs/docs/api/classes/SimpleResponseBuilder.md
index 08c06c8a3..af881034e 100644
--- a/apps/docs/docs/api/classes/SimpleResponseBuilder.md
+++ b/apps/docs/docs/api/classes/SimpleResponseBuilder.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+A response builder that just concatenates responses.
+
## Implements
- `BaseResponseBuilder`
@@ -24,7 +26,7 @@ custom_edit_url: null
#### Defined in
-[ResponseSynthesizer.ts:25](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L25)
+[ResponseSynthesizer.ts:37](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L37)
## Properties
@@ -34,7 +36,7 @@ custom_edit_url: null
#### Defined in
-[ResponseSynthesizer.ts:22](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L22)
+[ResponseSynthesizer.ts:34](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L34)
___
@@ -44,7 +46,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:23](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L23)
+[ResponseSynthesizer.ts:35](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L35)
## Methods
@@ -70,4 +72,4 @@ BaseResponseBuilder.agetResponse
#### Defined in
-[ResponseSynthesizer.ts:31](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L31)
+[ResponseSynthesizer.ts:43](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L43)
diff --git a/apps/docs/docs/api/classes/SubQuestionOutputParser.md b/apps/docs/docs/api/classes/SubQuestionOutputParser.md
index ddcd711f4..2744ef87d 100644
--- a/apps/docs/docs/api/classes/SubQuestionOutputParser.md
+++ b/apps/docs/docs/api/classes/SubQuestionOutputParser.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+SubQuestionOutputParser is used to parse the output of the SubQuestionGenerator.
+
## Implements
- [`BaseOutputParser`](../interfaces/BaseOutputParser.md)<[`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>\>
@@ -38,7 +40,7 @@ custom_edit_url: null
#### Defined in
-[OutputParser.ts:77](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/OutputParser.ts#L77)
+[OutputParser.ts:97](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/OutputParser.ts#L97)
___
@@ -62,4 +64,4 @@ ___
#### Defined in
-[OutputParser.ts:69](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/OutputParser.ts#L69)
+[OutputParser.ts:89](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/OutputParser.ts#L89)
diff --git a/apps/docs/docs/api/classes/SubQuestionQueryEngine.md b/apps/docs/docs/api/classes/SubQuestionQueryEngine.md
new file mode 100644
index 000000000..5a201c0cb
--- /dev/null
+++ b/apps/docs/docs/api/classes/SubQuestionQueryEngine.md
@@ -0,0 +1,141 @@
+---
+id: "SubQuestionQueryEngine"
+title: "Class: SubQuestionQueryEngine"
+sidebar_label: "SubQuestionQueryEngine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+SubQuestionQueryEngine decomposes a question into subquestions and then
+
+## Implements
+
+- [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+## Constructors
+
+### constructor
+
+• **new SubQuestionQueryEngine**(`init`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | `Object` |
+| `init.queryEngineTools` | [`QueryEngineTool`](../interfaces/QueryEngineTool.md)[] |
+| `init.questionGen` | [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md) |
+| `init.responseSynthesizer` | [`ResponseSynthesizer`](ResponseSynthesizer.md) |
+
+#### Defined in
+
+[QueryEngine.ts:56](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QueryEngine.ts#L56)
+
+## Properties
+
+### metadatas
+
+• **metadatas**: [`ToolMetadata`](../interfaces/ToolMetadata.md)[]
+
+#### Defined in
+
+[QueryEngine.ts:54](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QueryEngine.ts#L54)
+
+___
+
+### queryEngines
+
+• **queryEngines**: `Record`<`string`, [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)\>
+
+#### Defined in
+
+[QueryEngine.ts:53](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QueryEngine.ts#L53)
+
+___
+
+### questionGen
+
+• **questionGen**: [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md)
+
+#### Defined in
+
+[QueryEngine.ts:52](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QueryEngine.ts#L52)
+
+___
+
+### responseSynthesizer
+
+• **responseSynthesizer**: [`ResponseSynthesizer`](ResponseSynthesizer.md)
+
+#### Defined in
+
+[QueryEngine.ts:51](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QueryEngine.ts#L51)
+
+## Methods
+
+### aquery
+
+â–¸ **aquery**(`query`): `Promise`<[`Response`](Response.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+
+#### Returns
+
+`Promise`<[`Response`](Response.md)\>
+
+#### Implementation of
+
+[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[aquery](../interfaces/BaseQueryEngine.md#aquery)
+
+#### Defined in
+
+[QueryEngine.ts:97](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QueryEngine.ts#L97)
+
+___
+
+### aquerySubQ
+
+â–¸ `Private` **aquerySubQ**(`subQ`, `parentEvent?`): `Promise`<``null`` \| [`NodeWithScore`](../interfaces/NodeWithScore.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `subQ` | [`SubQuestion`](../interfaces/SubQuestion.md) |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<``null`` \| [`NodeWithScore`](../interfaces/NodeWithScore.md)\>
+
+#### Defined in
+
+[QueryEngine.ts:128](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QueryEngine.ts#L128)
+
+___
+
+### fromDefaults
+
+â–¸ `Static` **fromDefaults**(`init`): [`SubQuestionQueryEngine`](SubQuestionQueryEngine.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | `Object` |
+| `init.queryEngineTools` | [`QueryEngineTool`](../interfaces/QueryEngineTool.md)[] |
+| `init.questionGen?` | [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md) |
+| `init.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) |
+| `init.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+
+#### Returns
+
+[`SubQuestionQueryEngine`](SubQuestionQueryEngine.md)
+
+#### Defined in
+
+[QueryEngine.ts:73](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QueryEngine.ts#L73)
diff --git a/apps/docs/docs/api/classes/TextFileReader.md b/apps/docs/docs/api/classes/TextFileReader.md
index c67b78a6e..2c7484ae3 100644
--- a/apps/docs/docs/api/classes/TextFileReader.md
+++ b/apps/docs/docs/api/classes/TextFileReader.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+Read a .txt file
+
## Implements
- [`BaseReader`](../interfaces/BaseReader.md)
@@ -39,4 +41,4 @@ custom_edit_url: null
#### Defined in
-[readers/SimpleDirectoryReader.ts:9](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/readers/SimpleDirectoryReader.ts#L9)
+[readers/SimpleDirectoryReader.ts:12](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/readers/SimpleDirectoryReader.ts#L12)
diff --git a/apps/docs/docs/api/classes/TextNode.md b/apps/docs/docs/api/classes/TextNode.md
index 0fa829cf6..d26a90da8 100644
--- a/apps/docs/docs/api/classes/TextNode.md
+++ b/apps/docs/docs/api/classes/TextNode.md
@@ -6,7 +6,7 @@ sidebar_position: 0
custom_edit_url: null
---
-Generic abstract class for retrievable nodes
+TextNode is the default node type for text. Most common node type in LlamaIndex.TS
## Hierarchy
@@ -14,8 +14,6 @@ Generic abstract class for retrievable nodes
↳ **`TextNode`**
- ↳↳ [`ImageNode`](ImageNode.md)
-
↳↳ [`IndexNode`](IndexNode.md)
↳↳ [`Document`](Document.md)
@@ -38,7 +36,7 @@ Generic abstract class for retrievable nodes
#### Defined in
-[Node.ts:141](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L141)
+[Node.ts:144](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L144)
## Properties
@@ -52,7 +50,7 @@ Generic abstract class for retrievable nodes
#### Defined in
-[Node.ts:39](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L39)
+[Node.ts:39](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L39)
___
@@ -62,7 +60,7 @@ ___
#### Defined in
-[Node.ts:136](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L136)
+[Node.ts:139](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L139)
___
@@ -76,7 +74,7 @@ ___
#### Defined in
-[Node.ts:43](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L43)
+[Node.ts:43](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L43)
___
@@ -90,7 +88,7 @@ ___
#### Defined in
-[Node.ts:44](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L44)
+[Node.ts:44](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L44)
___
@@ -104,7 +102,7 @@ ___
#### Defined in
-[Node.ts:46](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L46)
+[Node.ts:46](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L46)
___
@@ -118,7 +116,7 @@ ___
#### Defined in
-[Node.ts:38](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L38)
+[Node.ts:38](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L38)
___
@@ -132,7 +130,7 @@ ___
#### Defined in
-[Node.ts:42](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L42)
+[Node.ts:42](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L42)
___
@@ -142,7 +140,7 @@ ___
#### Defined in
-[Node.ts:139](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L139)
+[Node.ts:142](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L142)
___
@@ -156,7 +154,7 @@ ___
#### Defined in
-[Node.ts:45](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L45)
+[Node.ts:45](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L45)
___
@@ -166,7 +164,7 @@ ___
#### Defined in
-[Node.ts:135](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L135)
+[Node.ts:138](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L138)
___
@@ -176,7 +174,7 @@ ___
#### Defined in
-[Node.ts:134](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L134)
+[Node.ts:137](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L137)
## Accessors
@@ -194,7 +192,7 @@ BaseNode.childNodes
#### Defined in
-[Node.ts:104](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L104)
+[Node.ts:104](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L104)
___
@@ -212,7 +210,7 @@ BaseNode.nextNode
#### Defined in
-[Node.ts:84](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L84)
+[Node.ts:84](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L84)
___
@@ -230,7 +228,7 @@ BaseNode.nodeId
#### Defined in
-[Node.ts:58](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L58)
+[Node.ts:58](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L58)
___
@@ -248,7 +246,7 @@ BaseNode.parentNode
#### Defined in
-[Node.ts:94](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L94)
+[Node.ts:94](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L94)
___
@@ -266,7 +264,7 @@ BaseNode.prevNode
#### Defined in
-[Node.ts:72](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L72)
+[Node.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L72)
___
@@ -284,7 +282,7 @@ BaseNode.sourceNode
#### Defined in
-[Node.ts:62](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L62)
+[Node.ts:62](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L62)
## Methods
@@ -302,7 +300,7 @@ BaseNode.sourceNode
#### Defined in
-[Node.ts:124](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L124)
+[Node.ts:124](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L124)
___
@@ -316,7 +314,7 @@ ___
#### Defined in
-[Node.ts:146](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L146)
+[Node.ts:149](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L149)
___
@@ -340,7 +338,7 @@ ___
#### Defined in
-[Node.ts:154](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L154)
+[Node.ts:157](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L157)
___
@@ -358,7 +356,7 @@ ___
#### Defined in
-[Node.ts:116](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L116)
+[Node.ts:116](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L116)
___
@@ -382,7 +380,7 @@ ___
#### Defined in
-[Node.ts:159](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L159)
+[Node.ts:162](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L162)
___
@@ -401,7 +399,7 @@ ___
#### Defined in
-[Node.ts:184](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L184)
+[Node.ts:187](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L187)
___
@@ -415,7 +413,7 @@ ___
#### Defined in
-[Node.ts:188](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L188)
+[Node.ts:191](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L191)
___
@@ -433,7 +431,7 @@ ___
#### Defined in
-[Node.ts:150](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L150)
+[Node.ts:153](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L153)
___
@@ -457,4 +455,4 @@ ___
#### Defined in
-[Node.ts:180](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L180)
+[Node.ts:183](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L183)
diff --git a/apps/docs/docs/api/classes/TreeSummarize.md b/apps/docs/docs/api/classes/TreeSummarize.md
index c520efb01..abde32dea 100644
--- a/apps/docs/docs/api/classes/TreeSummarize.md
+++ b/apps/docs/docs/api/classes/TreeSummarize.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+TreeSummarize repacks the text chunks into the smallest possible number of chunks and then summarizes them, then recursively does so until there's one chunk left.
+
## Implements
- `BaseResponseBuilder`
@@ -24,7 +26,7 @@ custom_edit_url: null
#### Defined in
-[ResponseSynthesizer.ts:156](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L156)
+[ResponseSynthesizer.ts:177](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L177)
## Properties
@@ -34,7 +36,7 @@ custom_edit_url: null
#### Defined in
-[ResponseSynthesizer.ts:154](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L154)
+[ResponseSynthesizer.ts:175](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L175)
## Methods
@@ -59,4 +61,4 @@ BaseResponseBuilder.agetResponse
#### Defined in
-[ResponseSynthesizer.ts:160](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L160)
+[ResponseSynthesizer.ts:181](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L181)
diff --git a/apps/docs/docs/api/classes/VectorIndexRetriever.md b/apps/docs/docs/api/classes/VectorIndexRetriever.md
index ab79c7acf..6a56cf82b 100644
--- a/apps/docs/docs/api/classes/VectorIndexRetriever.md
+++ b/apps/docs/docs/api/classes/VectorIndexRetriever.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+VectorIndexRetriever retrieves nodes from a VectorIndex.
+
## Implements
- [`BaseRetriever`](../interfaces/BaseRetriever.md)
@@ -24,7 +26,7 @@ custom_edit_url: null
#### Defined in
-[Retriever.ts:22](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Retriever.ts#L22)
+[Retriever.ts:28](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Retriever.ts#L28)
## Properties
@@ -34,7 +36,7 @@ custom_edit_url: null
#### Defined in
-[Retriever.ts:18](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Retriever.ts#L18)
+[Retriever.ts:24](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Retriever.ts#L24)
___
@@ -44,7 +46,7 @@ ___
#### Defined in
-[Retriever.ts:20](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Retriever.ts#L20)
+[Retriever.ts:26](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Retriever.ts#L26)
___
@@ -54,7 +56,7 @@ ___
#### Defined in
-[Retriever.ts:19](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Retriever.ts#L19)
+[Retriever.ts:25](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Retriever.ts#L25)
## Methods
@@ -79,7 +81,7 @@ ___
#### Defined in
-[Retriever.ts:27](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Retriever.ts#L27)
+[Retriever.ts:33](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Retriever.ts#L33)
___
@@ -97,4 +99,4 @@ ___
#### Defined in
-[Retriever.ts:64](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Retriever.ts#L64)
+[Retriever.ts:70](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Retriever.ts#L70)
diff --git a/apps/docs/docs/api/classes/VectorStoreIndex.md b/apps/docs/docs/api/classes/VectorStoreIndex.md
index 2d02b17e4..dbd037194 100644
--- a/apps/docs/docs/api/classes/VectorStoreIndex.md
+++ b/apps/docs/docs/api/classes/VectorStoreIndex.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+The VectorStoreIndex, an index that stores the nodes only according to their vector embedings.
+
## Hierarchy
- [`BaseIndex`](BaseIndex.md)<[`IndexDict`](IndexDict.md)\>
@@ -30,7 +32,7 @@ custom_edit_url: null
#### Defined in
-[BaseIndex.ts:98](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L98)
+[BaseIndex.ts:104](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L104)
## Properties
@@ -44,7 +46,7 @@ custom_edit_url: null
#### Defined in
-[BaseIndex.ts:67](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L67)
+[BaseIndex.ts:70](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L70)
___
@@ -58,7 +60,7 @@ ___
#### Defined in
-[BaseIndex.ts:69](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L69)
+[BaseIndex.ts:72](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L72)
___
@@ -72,7 +74,7 @@ ___
#### Defined in
-[BaseIndex.ts:70](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L70)
+[BaseIndex.ts:73](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L73)
___
@@ -86,7 +88,7 @@ ___
#### Defined in
-[BaseIndex.ts:65](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L65)
+[BaseIndex.ts:68](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L68)
___
@@ -100,7 +102,7 @@ ___
#### Defined in
-[BaseIndex.ts:66](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L66)
+[BaseIndex.ts:69](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L69)
___
@@ -114,21 +116,21 @@ ___
#### Defined in
-[BaseIndex.ts:96](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L96)
+[BaseIndex.ts:102](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L102)
## Methods
### asQueryEngine
-â–¸ **asQueryEngine**(): `BaseQueryEngine`
+â–¸ **asQueryEngine**(): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
#### Returns
-`BaseQueryEngine`
+[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
#### Defined in
-[BaseIndex.ts:208](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L208)
+[BaseIndex.ts:214](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L214)
___
@@ -146,7 +148,7 @@ ___
#### Defined in
-[BaseIndex.ts:204](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L204)
+[BaseIndex.ts:210](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L210)
___
@@ -168,7 +170,7 @@ ___
#### Defined in
-[BaseIndex.ts:141](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L141)
+[BaseIndex.ts:147](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L147)
___
@@ -190,7 +192,7 @@ ___
#### Defined in
-[BaseIndex.ts:162](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L162)
+[BaseIndex.ts:168](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L168)
___
@@ -212,7 +214,7 @@ ___
#### Defined in
-[BaseIndex.ts:182](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L182)
+[BaseIndex.ts:188](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L188)
___
@@ -232,4 +234,4 @@ ___
#### Defined in
-[BaseIndex.ts:103](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L103)
+[BaseIndex.ts:109](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L109)
diff --git a/apps/docs/docs/api/enums/ListRetrieverMode.md b/apps/docs/docs/api/enums/ListRetrieverMode.md
index b918b206d..1f15c98fd 100644
--- a/apps/docs/docs/api/enums/ListRetrieverMode.md
+++ b/apps/docs/docs/api/enums/ListRetrieverMode.md
@@ -14,7 +14,7 @@ custom_edit_url: null
#### Defined in
-[index/list/ListIndex.ts:21](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndex.ts#L21)
+[index/list/ListIndex.ts:21](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L21)
___
@@ -24,4 +24,4 @@ ___
#### Defined in
-[index/list/ListIndex.ts:23](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/index/list/ListIndex.ts#L23)
+[index/list/ListIndex.ts:23](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/index/list/ListIndex.ts#L23)
diff --git a/apps/docs/docs/api/enums/MetadataMode.md b/apps/docs/docs/api/enums/MetadataMode.md
index 326d6c5db..cec057afb 100644
--- a/apps/docs/docs/api/enums/MetadataMode.md
+++ b/apps/docs/docs/api/enums/MetadataMode.md
@@ -14,7 +14,7 @@ custom_edit_url: null
#### Defined in
-[Node.ts:19](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L19)
+[Node.ts:19](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L19)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[Node.ts:20](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L20)
+[Node.ts:20](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L20)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[Node.ts:21](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L21)
+[Node.ts:21](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L21)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
-[Node.ts:22](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L22)
+[Node.ts:22](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L22)
diff --git a/apps/docs/docs/api/enums/NodeRelationship.md b/apps/docs/docs/api/enums/NodeRelationship.md
index 42f71e273..1b4edadb3 100644
--- a/apps/docs/docs/api/enums/NodeRelationship.md
+++ b/apps/docs/docs/api/enums/NodeRelationship.md
@@ -14,7 +14,7 @@ custom_edit_url: null
#### Defined in
-[Node.ts:8](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L8)
+[Node.ts:8](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L8)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[Node.ts:6](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L6)
+[Node.ts:6](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L6)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[Node.ts:7](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L7)
+[Node.ts:7](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L7)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
-[Node.ts:5](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L5)
+[Node.ts:5](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L5)
___
@@ -54,4 +54,4 @@ ___
#### Defined in
-[Node.ts:4](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L4)
+[Node.ts:4](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L4)
diff --git a/apps/docs/docs/api/enums/ObjectType.md b/apps/docs/docs/api/enums/ObjectType.md
index b09aae402..2916bf475 100644
--- a/apps/docs/docs/api/enums/ObjectType.md
+++ b/apps/docs/docs/api/enums/ObjectType.md
@@ -14,7 +14,7 @@ custom_edit_url: null
#### Defined in
-[Node.ts:15](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L15)
+[Node.ts:15](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L15)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[Node.ts:13](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L13)
+[Node.ts:13](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L13)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[Node.ts:14](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L14)
+[Node.ts:14](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L14)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
-[Node.ts:12](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L12)
+[Node.ts:12](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L12)
diff --git a/apps/docs/docs/api/enums/SimilarityType.md b/apps/docs/docs/api/enums/SimilarityType.md
index 838ebe2ea..7a8326629 100644
--- a/apps/docs/docs/api/enums/SimilarityType.md
+++ b/apps/docs/docs/api/enums/SimilarityType.md
@@ -6,6 +6,9 @@ sidebar_position: 0
custom_edit_url: null
---
+Similarity type
+Default is cosine similarity. Dot product and negative Euclidean distance are also supported.
+
## Enumeration Members
### DEFAULT
@@ -14,7 +17,7 @@ custom_edit_url: null
#### Defined in
-[Embedding.ts:6](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L6)
+[Embedding.ts:10](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L10)
___
@@ -24,7 +27,7 @@ ___
#### Defined in
-[Embedding.ts:7](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L7)
+[Embedding.ts:11](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L11)
___
@@ -34,4 +37,4 @@ ___
#### Defined in
-[Embedding.ts:8](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L8)
+[Embedding.ts:12](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L12)
diff --git a/apps/docs/docs/api/interfaces/BaseIndexInit.md b/apps/docs/docs/api/interfaces/BaseIndexInit.md
index a5c23eee2..36f282281 100644
--- a/apps/docs/docs/api/interfaces/BaseIndexInit.md
+++ b/apps/docs/docs/api/interfaces/BaseIndexInit.md
@@ -20,7 +20,7 @@ custom_edit_url: null
#### Defined in
-[BaseIndex.ts:59](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L59)
+[BaseIndex.ts:62](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L62)
___
@@ -30,7 +30,7 @@ ___
#### Defined in
-[BaseIndex.ts:61](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L61)
+[BaseIndex.ts:64](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L64)
___
@@ -40,7 +40,7 @@ ___
#### Defined in
-[BaseIndex.ts:62](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L62)
+[BaseIndex.ts:65](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L65)
___
@@ -50,7 +50,7 @@ ___
#### Defined in
-[BaseIndex.ts:57](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L57)
+[BaseIndex.ts:60](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L60)
___
@@ -60,7 +60,7 @@ ___
#### Defined in
-[BaseIndex.ts:58](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L58)
+[BaseIndex.ts:61](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L61)
___
@@ -70,4 +70,4 @@ ___
#### Defined in
-[BaseIndex.ts:60](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L60)
+[BaseIndex.ts:63](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L63)
diff --git a/apps/docs/docs/api/interfaces/BaseLLMPredictor.md b/apps/docs/docs/api/interfaces/BaseLLMPredictor.md
index 8c9fd9660..869eb5da6 100644
--- a/apps/docs/docs/api/interfaces/BaseLLMPredictor.md
+++ b/apps/docs/docs/api/interfaces/BaseLLMPredictor.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+LLM Predictors are an abstraction to predict the response to a prompt.
+
## Implemented by
- [`ChatGPTLLMPredictor`](../classes/ChatGPTLLMPredictor.md)
@@ -30,7 +32,7 @@ custom_edit_url: null
#### Defined in
-[LLMPredictor.ts:8](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLMPredictor.ts#L8)
+[LLMPredictor.ts:10](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L10)
___
@@ -44,4 +46,4 @@ ___
#### Defined in
-[LLMPredictor.ts:7](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLMPredictor.ts#L7)
+[LLMPredictor.ts:9](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLMPredictor.ts#L9)
diff --git a/apps/docs/docs/api/interfaces/BaseOutputParser.md b/apps/docs/docs/api/interfaces/BaseOutputParser.md
index 84d9fa550..379c6c9d6 100644
--- a/apps/docs/docs/api/interfaces/BaseOutputParser.md
+++ b/apps/docs/docs/api/interfaces/BaseOutputParser.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+An OutputParser is used to extract structured data from the raw output of the LLM.
+
## Type parameters
| Name |
@@ -34,7 +36,7 @@ custom_edit_url: null
#### Defined in
-[OutputParser.ts:5](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/OutputParser.ts#L5)
+[OutputParser.ts:8](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/OutputParser.ts#L8)
___
@@ -54,4 +56,4 @@ ___
#### Defined in
-[OutputParser.ts:4](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/OutputParser.ts#L4)
+[OutputParser.ts:7](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/OutputParser.ts#L7)
diff --git a/apps/docs/docs/api/interfaces/BaseQueryEngine.md b/apps/docs/docs/api/interfaces/BaseQueryEngine.md
new file mode 100644
index 000000000..0d4e8da11
--- /dev/null
+++ b/apps/docs/docs/api/interfaces/BaseQueryEngine.md
@@ -0,0 +1,35 @@
+---
+id: "BaseQueryEngine"
+title: "Interface: BaseQueryEngine"
+sidebar_label: "BaseQueryEngine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A query engine is a question answerer that can use one or more steps.
+
+## Implemented by
+
+- [`RetrieverQueryEngine`](../classes/RetrieverQueryEngine.md)
+- [`SubQuestionQueryEngine`](../classes/SubQuestionQueryEngine.md)
+
+## Methods
+
+### aquery
+
+â–¸ **aquery**(`query`, `parentEvent?`): `Promise`<[`Response`](../classes/Response.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `parentEvent?` | [`Event`](Event.md) |
+
+#### Returns
+
+`Promise`<[`Response`](../classes/Response.md)\>
+
+#### Defined in
+
+[QueryEngine.ts:19](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QueryEngine.ts#L19)
diff --git a/apps/docs/docs/api/interfaces/BaseQuestionGenerator.md b/apps/docs/docs/api/interfaces/BaseQuestionGenerator.md
index e3c3b2a78..db30a8e3d 100644
--- a/apps/docs/docs/api/interfaces/BaseQuestionGenerator.md
+++ b/apps/docs/docs/api/interfaces/BaseQuestionGenerator.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+QuestionGenerators generate new questions for the LLM using tools and a user query.
+
## Implemented by
- [`LLMQuestionGenerator`](../classes/LLMQuestionGenerator.md)
@@ -29,4 +31,4 @@ custom_edit_url: null
#### Defined in
-[QuestionGenerator.ts:20](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/QuestionGenerator.ts#L20)
+[QuestionGenerator.ts:23](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QuestionGenerator.ts#L23)
diff --git a/apps/docs/docs/api/interfaces/BaseReader.md b/apps/docs/docs/api/interfaces/BaseReader.md
index e6c594c93..4e6d5564f 100644
--- a/apps/docs/docs/api/interfaces/BaseReader.md
+++ b/apps/docs/docs/api/interfaces/BaseReader.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+A reader takes imports data into Document objects.
+
## Implemented by
- [`TextFileReader`](../classes/TextFileReader.md)
@@ -28,4 +30,4 @@ custom_edit_url: null
#### Defined in
-[readers/base.ts:4](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/readers/base.ts#L4)
+[readers/base.ts:7](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/readers/base.ts#L7)
diff --git a/apps/docs/docs/api/interfaces/BaseRetriever.md b/apps/docs/docs/api/interfaces/BaseRetriever.md
index b3e81d8f0..6e0c545ec 100644
--- a/apps/docs/docs/api/interfaces/BaseRetriever.md
+++ b/apps/docs/docs/api/interfaces/BaseRetriever.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+Retrievers retrieve the nodes that most closely match our query in similarity.
+
## Implemented by
- [`ListIndexLLMRetriever`](../classes/ListIndexLLMRetriever.md)
@@ -31,7 +33,7 @@ custom_edit_url: null
#### Defined in
-[Retriever.ts:13](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Retriever.ts#L13)
+[Retriever.ts:16](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Retriever.ts#L16)
___
@@ -45,4 +47,4 @@ ___
#### Defined in
-[Retriever.ts:14](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Retriever.ts#L14)
+[Retriever.ts:17](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Retriever.ts#L17)
diff --git a/apps/docs/docs/api/interfaces/BaseTool.md b/apps/docs/docs/api/interfaces/BaseTool.md
index 987816823..6c6480c1b 100644
--- a/apps/docs/docs/api/interfaces/BaseTool.md
+++ b/apps/docs/docs/api/interfaces/BaseTool.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+Simple Tool interface. Likely to change.
+
## Hierarchy
- **`BaseTool`**
@@ -20,4 +22,4 @@ custom_edit_url: null
#### Defined in
-[Tool.ts:9](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Tool.ts#L9)
+[Tool.ts:12](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Tool.ts#L12)
diff --git a/apps/docs/docs/api/interfaces/ChatMessage.md b/apps/docs/docs/api/interfaces/ChatMessage.md
index 7fc2b0889..197bdfbbf 100644
--- a/apps/docs/docs/api/interfaces/ChatMessage.md
+++ b/apps/docs/docs/api/interfaces/ChatMessage.md
@@ -14,7 +14,7 @@ custom_edit_url: null
#### Defined in
-[LLM.ts:14](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L14)
+[LLM.ts:14](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L14)
___
@@ -24,4 +24,4 @@ ___
#### Defined in
-[LLM.ts:15](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L15)
+[LLM.ts:15](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L15)
diff --git a/apps/docs/docs/api/interfaces/ChatResponse.md b/apps/docs/docs/api/interfaces/ChatResponse.md
index c53660c2c..2c3ecb189 100644
--- a/apps/docs/docs/api/interfaces/ChatResponse.md
+++ b/apps/docs/docs/api/interfaces/ChatResponse.md
@@ -14,7 +14,7 @@ custom_edit_url: null
#### Defined in
-[LLM.ts:21](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L21)
+[LLM.ts:21](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L21)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[LLM.ts:19](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L19)
+[LLM.ts:19](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L19)
___
@@ -34,4 +34,4 @@ ___
#### Defined in
-[LLM.ts:20](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L20)
+[LLM.ts:20](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L20)
diff --git a/apps/docs/docs/api/interfaces/Event.md b/apps/docs/docs/api/interfaces/Event.md
index 477dbe823..1a96c489b 100644
--- a/apps/docs/docs/api/interfaces/Event.md
+++ b/apps/docs/docs/api/interfaces/Event.md
@@ -14,7 +14,7 @@ custom_edit_url: null
#### Defined in
-[callbacks/CallbackManager.ts:14](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L14)
+[callbacks/CallbackManager.ts:14](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L14)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:17](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L17)
+[callbacks/CallbackManager.ts:17](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L17)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:16](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L16)
+[callbacks/CallbackManager.ts:16](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L16)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:15](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L15)
+[callbacks/CallbackManager.ts:15](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L15)
diff --git a/apps/docs/docs/api/interfaces/GenericFileSystem.md b/apps/docs/docs/api/interfaces/GenericFileSystem.md
index cc2bb1df8..13fe23a33 100644
--- a/apps/docs/docs/api/interfaces/GenericFileSystem.md
+++ b/apps/docs/docs/api/interfaces/GenericFileSystem.md
@@ -33,7 +33,7 @@ browsers.
#### Defined in
-[storage/FileSystem.ts:12](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/FileSystem.ts#L12)
+[storage/FileSystem.ts:12](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L12)
___
@@ -54,7 +54,7 @@ ___
#### Defined in
-[storage/FileSystem.ts:13](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/FileSystem.ts#L13)
+[storage/FileSystem.ts:13](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L13)
___
@@ -75,7 +75,7 @@ ___
#### Defined in
-[storage/FileSystem.ts:11](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/FileSystem.ts#L11)
+[storage/FileSystem.ts:11](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L11)
___
@@ -97,4 +97,4 @@ ___
#### Defined in
-[storage/FileSystem.ts:10](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/FileSystem.ts#L10)
+[storage/FileSystem.ts:10](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L10)
diff --git a/apps/docs/docs/api/interfaces/LLM.md b/apps/docs/docs/api/interfaces/LLM.md
index 4c596f001..2d9aeb547 100644
--- a/apps/docs/docs/api/interfaces/LLM.md
+++ b/apps/docs/docs/api/interfaces/LLM.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+Unified language model interface
+
## Implemented by
- [`OpenAI`](../classes/OpenAI.md)
@@ -16,6 +18,8 @@ custom_edit_url: null
â–¸ **achat**(`messages`): `Promise`<[`ChatResponse`](ChatResponse.md)\>
+Get a chat response from the LLM
+
#### Parameters
| Name | Type |
@@ -28,7 +32,7 @@ custom_edit_url: null
#### Defined in
-[LLM.ts:28](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L28)
+[LLM.ts:35](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L35)
___
@@ -36,11 +40,13 @@ ___
â–¸ **acomplete**(`prompt`): `Promise`<[`ChatResponse`](ChatResponse.md)\>
+Get a prompt completion from the LLM
+
#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `prompt` | `string` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `prompt` | `string` | the prompt to complete |
#### Returns
@@ -48,4 +54,4 @@ ___
#### Defined in
-[LLM.ts:29](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L29)
+[LLM.ts:41](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L41)
diff --git a/apps/docs/docs/api/interfaces/NodeParser.md b/apps/docs/docs/api/interfaces/NodeParser.md
index 0f2cc112f..d330d120f 100644
--- a/apps/docs/docs/api/interfaces/NodeParser.md
+++ b/apps/docs/docs/api/interfaces/NodeParser.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+A node parser generates TextNodes from Documents
+
## Implemented by
- [`SimpleNodeParser`](../classes/SimpleNodeParser.md)
@@ -28,4 +30,4 @@ custom_edit_url: null
#### Defined in
-[NodeParser.ts:51](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/NodeParser.ts#L51)
+[NodeParser.ts:53](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/NodeParser.ts#L53)
diff --git a/apps/docs/docs/api/interfaces/NodeWithEmbedding.md b/apps/docs/docs/api/interfaces/NodeWithEmbedding.md
index f9aa17f64..209737e30 100644
--- a/apps/docs/docs/api/interfaces/NodeWithEmbedding.md
+++ b/apps/docs/docs/api/interfaces/NodeWithEmbedding.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+A node with an embedding
+
## Properties
### embedding
@@ -14,7 +16,7 @@ custom_edit_url: null
#### Defined in
-[Node.ts:235](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L235)
+[Node.ts:247](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L247)
___
@@ -24,4 +26,4 @@ ___
#### Defined in
-[Node.ts:234](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L234)
+[Node.ts:246](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L246)
diff --git a/apps/docs/docs/api/interfaces/NodeWithScore.md b/apps/docs/docs/api/interfaces/NodeWithScore.md
index 6cace3459..45b1d69b9 100644
--- a/apps/docs/docs/api/interfaces/NodeWithScore.md
+++ b/apps/docs/docs/api/interfaces/NodeWithScore.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+A node with a similarity score
+
## Properties
### node
@@ -14,7 +16,7 @@ custom_edit_url: null
#### Defined in
-[Node.ts:229](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L229)
+[Node.ts:238](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L238)
___
@@ -24,4 +26,4 @@ ___
#### Defined in
-[Node.ts:230](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L230)
+[Node.ts:239](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L239)
diff --git a/apps/docs/docs/api/interfaces/QueryEngineTool.md b/apps/docs/docs/api/interfaces/QueryEngineTool.md
index c509008eb..745f31172 100644
--- a/apps/docs/docs/api/interfaces/QueryEngineTool.md
+++ b/apps/docs/docs/api/interfaces/QueryEngineTool.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+A Tool that uses a QueryEngine.
+
## Hierarchy
- [`BaseTool`](BaseTool.md)
@@ -24,14 +26,14 @@ custom_edit_url: null
#### Defined in
-[Tool.ts:9](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Tool.ts#L9)
+[Tool.ts:12](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Tool.ts#L12)
___
### queryEngine
-• **queryEngine**: `BaseQueryEngine`
+• **queryEngine**: [`BaseQueryEngine`](BaseQueryEngine.md)
#### Defined in
-[Tool.ts:13](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Tool.ts#L13)
+[Tool.ts:19](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Tool.ts#L19)
diff --git a/apps/docs/docs/api/interfaces/RelatedNodeInfo.md b/apps/docs/docs/api/interfaces/RelatedNodeInfo.md
index 09b839d6b..1ba77eb1c 100644
--- a/apps/docs/docs/api/interfaces/RelatedNodeInfo.md
+++ b/apps/docs/docs/api/interfaces/RelatedNodeInfo.md
@@ -14,7 +14,7 @@ custom_edit_url: null
#### Defined in
-[Node.ts:29](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L29)
+[Node.ts:29](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L29)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[Node.ts:28](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L28)
+[Node.ts:28](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L28)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[Node.ts:26](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L26)
+[Node.ts:26](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L26)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
-[Node.ts:27](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L27)
+[Node.ts:27](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L27)
diff --git a/apps/docs/docs/api/interfaces/RetrievalCallbackResponse.md b/apps/docs/docs/api/interfaces/RetrievalCallbackResponse.md
index a6e70687a..8cb8eba28 100644
--- a/apps/docs/docs/api/interfaces/RetrievalCallbackResponse.md
+++ b/apps/docs/docs/api/interfaces/RetrievalCallbackResponse.md
@@ -24,7 +24,7 @@ BaseCallbackResponse.event
#### Defined in
-[callbacks/CallbackManager.ts:21](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L21)
+[callbacks/CallbackManager.ts:21](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L21)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:47](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L47)
+[callbacks/CallbackManager.ts:47](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L47)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:46](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L46)
+[callbacks/CallbackManager.ts:46](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L46)
diff --git a/apps/docs/docs/api/interfaces/ServiceContext.md b/apps/docs/docs/api/interfaces/ServiceContext.md
index 1c178db85..c071b2b70 100644
--- a/apps/docs/docs/api/interfaces/ServiceContext.md
+++ b/apps/docs/docs/api/interfaces/ServiceContext.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+The ServiceContext is a collection of components that are used in different parts of the application.
+
## Properties
### callbackManager
@@ -14,7 +16,7 @@ custom_edit_url: null
#### Defined in
-[ServiceContext.ts:13](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ServiceContext.ts#L13)
+[ServiceContext.ts:16](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ServiceContext.ts#L16)
___
@@ -24,7 +26,7 @@ ___
#### Defined in
-[ServiceContext.ts:11](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ServiceContext.ts#L11)
+[ServiceContext.ts:14](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ServiceContext.ts#L14)
___
@@ -34,7 +36,7 @@ ___
#### Defined in
-[ServiceContext.ts:9](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ServiceContext.ts#L9)
+[ServiceContext.ts:12](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ServiceContext.ts#L12)
___
@@ -44,7 +46,7 @@ ___
#### Defined in
-[ServiceContext.ts:12](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ServiceContext.ts#L12)
+[ServiceContext.ts:15](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ServiceContext.ts#L15)
___
@@ -54,4 +56,4 @@ ___
#### Defined in
-[ServiceContext.ts:10](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ServiceContext.ts#L10)
+[ServiceContext.ts:13](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ServiceContext.ts#L13)
diff --git a/apps/docs/docs/api/interfaces/ServiceContextOptions.md b/apps/docs/docs/api/interfaces/ServiceContextOptions.md
index 0c7106262..71369f21e 100644
--- a/apps/docs/docs/api/interfaces/ServiceContextOptions.md
+++ b/apps/docs/docs/api/interfaces/ServiceContextOptions.md
@@ -14,7 +14,7 @@ custom_edit_url: null
#### Defined in
-[ServiceContext.ts:23](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ServiceContext.ts#L23)
+[ServiceContext.ts:26](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ServiceContext.ts#L26)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[ServiceContext.ts:26](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ServiceContext.ts#L26)
+[ServiceContext.ts:29](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ServiceContext.ts#L29)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[ServiceContext.ts:25](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ServiceContext.ts#L25)
+[ServiceContext.ts:28](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ServiceContext.ts#L28)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
-[ServiceContext.ts:21](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ServiceContext.ts#L21)
+[ServiceContext.ts:24](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ServiceContext.ts#L24)
___
@@ -54,7 +54,7 @@ ___
#### Defined in
-[ServiceContext.ts:19](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ServiceContext.ts#L19)
+[ServiceContext.ts:22](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ServiceContext.ts#L22)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
-[ServiceContext.ts:18](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ServiceContext.ts#L18)
+[ServiceContext.ts:21](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ServiceContext.ts#L21)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
-[ServiceContext.ts:22](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ServiceContext.ts#L22)
+[ServiceContext.ts:25](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ServiceContext.ts#L25)
___
@@ -84,4 +84,4 @@ ___
#### Defined in
-[ServiceContext.ts:20](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ServiceContext.ts#L20)
+[ServiceContext.ts:23](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ServiceContext.ts#L23)
diff --git a/apps/docs/docs/api/interfaces/StorageContext.md b/apps/docs/docs/api/interfaces/StorageContext.md
index a7f6e9acc..dc8f5ec45 100644
--- a/apps/docs/docs/api/interfaces/StorageContext.md
+++ b/apps/docs/docs/api/interfaces/StorageContext.md
@@ -14,7 +14,7 @@ custom_edit_url: null
#### Defined in
-[storage/StorageContext.ts:15](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/StorageContext.ts#L15)
+[storage/StorageContext.ts:15](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/StorageContext.ts#L15)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[storage/StorageContext.ts:16](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/StorageContext.ts#L16)
+[storage/StorageContext.ts:16](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/StorageContext.ts#L16)
___
@@ -34,4 +34,4 @@ ___
#### Defined in
-[storage/StorageContext.ts:17](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/StorageContext.ts#L17)
+[storage/StorageContext.ts:17](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/StorageContext.ts#L17)
diff --git a/apps/docs/docs/api/interfaces/StreamCallbackResponse.md b/apps/docs/docs/api/interfaces/StreamCallbackResponse.md
index 0f939b363..fd6a2c522 100644
--- a/apps/docs/docs/api/interfaces/StreamCallbackResponse.md
+++ b/apps/docs/docs/api/interfaces/StreamCallbackResponse.md
@@ -24,7 +24,7 @@ BaseCallbackResponse.event
#### Defined in
-[callbacks/CallbackManager.ts:21](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L21)
+[callbacks/CallbackManager.ts:21](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L21)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:40](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L40)
+[callbacks/CallbackManager.ts:40](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L40)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:41](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L41)
+[callbacks/CallbackManager.ts:41](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L41)
___
@@ -54,4 +54,4 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:42](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L42)
+[callbacks/CallbackManager.ts:42](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L42)
diff --git a/apps/docs/docs/api/interfaces/StreamToken.md b/apps/docs/docs/api/interfaces/StreamToken.md
index b6fa4ebae..5bdcc39e6 100644
--- a/apps/docs/docs/api/interfaces/StreamToken.md
+++ b/apps/docs/docs/api/interfaces/StreamToken.md
@@ -14,7 +14,7 @@ custom_edit_url: null
#### Defined in
-[callbacks/CallbackManager.ts:29](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L29)
+[callbacks/CallbackManager.ts:29](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L29)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:27](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L27)
+[callbacks/CallbackManager.ts:27](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L27)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:25](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L25)
+[callbacks/CallbackManager.ts:25](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L25)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:28](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L28)
+[callbacks/CallbackManager.ts:28](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L28)
___
@@ -54,4 +54,4 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:26](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L26)
+[callbacks/CallbackManager.ts:26](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L26)
diff --git a/apps/docs/docs/api/interfaces/StructuredOutput.md b/apps/docs/docs/api/interfaces/StructuredOutput.md
index 308fd943c..259bed348 100644
--- a/apps/docs/docs/api/interfaces/StructuredOutput.md
+++ b/apps/docs/docs/api/interfaces/StructuredOutput.md
@@ -6,6 +6,8 @@ sidebar_position: 0
custom_edit_url: null
---
+StructuredOutput is just a combo of the raw output and the parsed output.
+
## Type parameters
| Name |
@@ -20,7 +22,7 @@ custom_edit_url: null
#### Defined in
-[OutputParser.ts:10](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/OutputParser.ts#L10)
+[OutputParser.ts:16](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/OutputParser.ts#L16)
___
@@ -30,4 +32,4 @@ ___
#### Defined in
-[OutputParser.ts:9](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/OutputParser.ts#L9)
+[OutputParser.ts:15](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/OutputParser.ts#L15)
diff --git a/apps/docs/docs/api/interfaces/SubQuestion.md b/apps/docs/docs/api/interfaces/SubQuestion.md
index 2b1079696..092be9168 100644
--- a/apps/docs/docs/api/interfaces/SubQuestion.md
+++ b/apps/docs/docs/api/interfaces/SubQuestion.md
@@ -14,7 +14,7 @@ custom_edit_url: null
#### Defined in
-[QuestionGenerator.ts:15](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/QuestionGenerator.ts#L15)
+[QuestionGenerator.ts:15](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QuestionGenerator.ts#L15)
___
@@ -24,4 +24,4 @@ ___
#### Defined in
-[QuestionGenerator.ts:16](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/QuestionGenerator.ts#L16)
+[QuestionGenerator.ts:16](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/QuestionGenerator.ts#L16)
diff --git a/apps/docs/docs/api/interfaces/ToolMetadata.md b/apps/docs/docs/api/interfaces/ToolMetadata.md
index f002dc41f..b8e6eb0dd 100644
--- a/apps/docs/docs/api/interfaces/ToolMetadata.md
+++ b/apps/docs/docs/api/interfaces/ToolMetadata.md
@@ -14,7 +14,7 @@ custom_edit_url: null
#### Defined in
-[Tool.ts:4](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Tool.ts#L4)
+[Tool.ts:4](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Tool.ts#L4)
___
@@ -24,4 +24,4 @@ ___
#### Defined in
-[Tool.ts:5](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Tool.ts#L5)
+[Tool.ts:5](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Tool.ts#L5)
diff --git a/apps/docs/docs/api/interfaces/VectorIndexOptions.md b/apps/docs/docs/api/interfaces/VectorIndexOptions.md
index 02535032f..cd15e56b5 100644
--- a/apps/docs/docs/api/interfaces/VectorIndexOptions.md
+++ b/apps/docs/docs/api/interfaces/VectorIndexOptions.md
@@ -14,7 +14,7 @@ custom_edit_url: null
#### Defined in
-[BaseIndex.ts:86](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L86)
+[BaseIndex.ts:89](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L89)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[BaseIndex.ts:85](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L85)
+[BaseIndex.ts:88](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L88)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[BaseIndex.ts:87](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L87)
+[BaseIndex.ts:90](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L90)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
-[BaseIndex.ts:88](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/BaseIndex.ts#L88)
+[BaseIndex.ts:91](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/BaseIndex.ts#L91)
diff --git a/apps/docs/docs/api/interfaces/WalkableFileSystem.md b/apps/docs/docs/api/interfaces/WalkableFileSystem.md
index 4ce27c4ce..76d47426f 100644
--- a/apps/docs/docs/api/interfaces/WalkableFileSystem.md
+++ b/apps/docs/docs/api/interfaces/WalkableFileSystem.md
@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
-[storage/FileSystem.ts:17](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/FileSystem.ts#L17)
+[storage/FileSystem.ts:17](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L17)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
-[storage/FileSystem.ts:18](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/FileSystem.ts#L18)
+[storage/FileSystem.ts:18](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L18)
diff --git a/apps/docs/docs/api/modules.md b/apps/docs/docs/api/modules.md
index 177db5f04..be9038205 100644
--- a/apps/docs/docs/api/modules.md
+++ b/apps/docs/docs/api/modules.md
@@ -25,8 +25,6 @@ custom_edit_url: null
- [CondenseQuestionChatEngine](classes/CondenseQuestionChatEngine.md)
- [ContextChatEngine](classes/ContextChatEngine.md)
- [Document](classes/Document.md)
-- [ImageDocument](classes/ImageDocument.md)
-- [ImageNode](classes/ImageNode.md)
- [InMemoryFileSystem](classes/InMemoryFileSystem.md)
- [IndexDict](classes/IndexDict.md)
- [IndexList](classes/IndexList.md)
@@ -41,11 +39,13 @@ custom_edit_url: null
- [Refine](classes/Refine.md)
- [Response](classes/Response.md)
- [ResponseSynthesizer](classes/ResponseSynthesizer.md)
+- [RetrieverQueryEngine](classes/RetrieverQueryEngine.md)
- [SentenceSplitter](classes/SentenceSplitter.md)
- [SimpleChatEngine](classes/SimpleChatEngine.md)
- [SimpleNodeParser](classes/SimpleNodeParser.md)
- [SimpleResponseBuilder](classes/SimpleResponseBuilder.md)
- [SubQuestionOutputParser](classes/SubQuestionOutputParser.md)
+- [SubQuestionQueryEngine](classes/SubQuestionQueryEngine.md)
- [TextFileReader](classes/TextFileReader.md)
- [TextNode](classes/TextNode.md)
- [TreeSummarize](classes/TreeSummarize.md)
@@ -57,6 +57,7 @@ custom_edit_url: null
- [BaseIndexInit](interfaces/BaseIndexInit.md)
- [BaseLLMPredictor](interfaces/BaseLLMPredictor.md)
- [BaseOutputParser](interfaces/BaseOutputParser.md)
+- [BaseQueryEngine](interfaces/BaseQueryEngine.md)
- [BaseQuestionGenerator](interfaces/BaseQuestionGenerator.md)
- [BaseReader](interfaces/BaseReader.md)
- [BaseRetriever](interfaces/BaseRetriever.md)
@@ -91,7 +92,7 @@ custom_edit_url: null
#### Defined in
-[storage/FileSystem.ts:49](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/FileSystem.ts#L49)
+[storage/FileSystem.ts:49](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L49)
___
@@ -101,7 +102,7 @@ ___
#### Defined in
-[LLM.ts:25](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L25)
+[LLM.ts:25](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L25)
___
@@ -111,7 +112,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:11](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L11)
+[callbacks/CallbackManager.ts:11](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L11)
___
@@ -121,7 +122,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:12](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/callbacks/CallbackManager.ts#L12)
+[callbacks/CallbackManager.ts:12](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/callbacks/CallbackManager.ts#L12)
___
@@ -131,7 +132,7 @@ ___
#### Defined in
-[Node.ts:32](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Node.ts#L32)
+[Node.ts:32](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Node.ts#L32)
___
@@ -150,7 +151,7 @@ ___
#### Defined in
-[readers/SimpleDirectoryReader.ts:23](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/readers/SimpleDirectoryReader.ts#L23)
+[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/readers/SimpleDirectoryReader.ts#L26)
___
@@ -178,7 +179,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
#### Defined in
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Prompt.ts#L10)
## Variables
@@ -186,6 +187,8 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
• `Const` **ALL\_AVAILABLE\_MODELS**: `Object`
+We currently support GPT-3.5 and GPT-4 models
+
#### Type declaration
| Name | Type |
@@ -197,7 +200,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
#### Defined in
-[LLM.ts:42](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L42)
+[LLM.ts:57](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L57)
___
@@ -207,7 +210,7 @@ ___
#### Defined in
-[constants.ts:5](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/constants.ts#L5)
+[constants.ts:5](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/constants.ts#L5)
___
@@ -217,7 +220,7 @@ ___
#### Defined in
-[constants.ts:6](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/constants.ts#L6)
+[constants.ts:6](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/constants.ts#L6)
___
@@ -227,7 +230,7 @@ ___
#### Defined in
-[constants.ts:4](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/constants.ts#L4)
+[constants.ts:4](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/constants.ts#L4)
___
@@ -237,7 +240,7 @@ ___
#### Defined in
-[storage/constants.ts:1](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/constants.ts#L1)
+[storage/constants.ts:1](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/constants.ts#L1)
___
@@ -247,7 +250,7 @@ ___
#### Defined in
-[constants.ts:1](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/constants.ts#L1)
+[constants.ts:1](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/constants.ts#L1)
___
@@ -257,7 +260,7 @@ ___
#### Defined in
-[storage/constants.ts:4](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/constants.ts#L4)
+[storage/constants.ts:4](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/constants.ts#L4)
___
@@ -267,7 +270,7 @@ ___
#### Defined in
-[constants.ts:10](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/constants.ts#L10)
+[constants.ts:10](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/constants.ts#L10)
___
@@ -277,7 +280,7 @@ ___
#### Defined in
-[storage/FileSystem.ts:62](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/FileSystem.ts#L62)
+[storage/FileSystem.ts:62](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L62)
___
@@ -287,7 +290,7 @@ ___
#### Defined in
-[storage/constants.ts:6](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/constants.ts#L6)
+[storage/constants.ts:6](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/constants.ts#L6)
___
@@ -297,7 +300,7 @@ ___
#### Defined in
-[storage/constants.ts:3](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/constants.ts#L3)
+[storage/constants.ts:3](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/constants.ts#L3)
___
@@ -307,7 +310,7 @@ ___
#### Defined in
-[storage/constants.ts:7](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/constants.ts#L7)
+[storage/constants.ts:7](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/constants.ts#L7)
___
@@ -317,7 +320,7 @@ ___
#### Defined in
-[constants.ts:2](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/constants.ts#L2)
+[constants.ts:2](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/constants.ts#L2)
___
@@ -327,7 +330,7 @@ ___
#### Defined in
-[constants.ts:11](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/constants.ts#L11)
+[constants.ts:11](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/constants.ts#L11)
___
@@ -337,7 +340,7 @@ ___
#### Defined in
-[storage/constants.ts:2](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/constants.ts#L2)
+[storage/constants.ts:2](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/constants.ts#L2)
___
@@ -347,7 +350,7 @@ ___
#### Defined in
-[constants.ts:7](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/constants.ts#L7)
+[constants.ts:7](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/constants.ts#L7)
___
@@ -357,7 +360,7 @@ ___
#### Defined in
-[storage/constants.ts:5](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/constants.ts#L5)
+[storage/constants.ts:5](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/constants.ts#L5)
___
@@ -374,7 +377,7 @@ ___
#### Defined in
-[LLM.ts:32](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L32)
+[LLM.ts:44](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L44)
___
@@ -391,7 +394,7 @@ ___
#### Defined in
-[LLM.ts:37](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/LLM.ts#L37)
+[LLM.ts:49](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/LLM.ts#L49)
___
@@ -401,7 +404,7 @@ ___
#### Defined in
-[GlobalsHelper.ts:39](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/GlobalsHelper.ts#L39)
+[GlobalsHelper.ts:42](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/GlobalsHelper.ts#L42)
## Functions
@@ -421,7 +424,7 @@ ___
#### Defined in
-[Prompt.ts:198](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Prompt.ts#L198)
+[Prompt.ts:198](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Prompt.ts#L198)
___
@@ -445,7 +448,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
#### Defined in
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Prompt.ts#L10)
___
@@ -469,7 +472,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
#### Defined in
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Prompt.ts#L10)
___
@@ -493,7 +496,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
#### Defined in
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Prompt.ts#L10)
___
@@ -517,7 +520,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
#### Defined in
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Prompt.ts#L10)
___
@@ -541,7 +544,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
#### Defined in
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Prompt.ts#L10)
___
@@ -565,7 +568,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
#### Defined in
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Prompt.ts#L10)
___
@@ -589,7 +592,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
#### Defined in
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Prompt.ts#L10)
___
@@ -615,7 +618,7 @@ A promise that resolves to true if the file exists, false otherwise.
#### Defined in
-[storage/FileSystem.ts:74](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/FileSystem.ts#L74)
+[storage/FileSystem.ts:74](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L74)
___
@@ -629,7 +632,7 @@ ___
#### Defined in
-[storage/FileSystem.ts:51](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/FileSystem.ts#L51)
+[storage/FileSystem.ts:51](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L51)
___
@@ -652,7 +655,7 @@ ___
#### Defined in
-[NodeParser.ts:15](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/NodeParser.ts#L15)
+[NodeParser.ts:15](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/NodeParser.ts#L15)
___
@@ -672,7 +675,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:191](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ResponseSynthesizer.ts#L191)
+[ResponseSynthesizer.ts:212](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ResponseSynthesizer.ts#L212)
___
@@ -693,7 +696,7 @@ ___
#### Defined in
-[NodeParser.ts:5](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/NodeParser.ts#L5)
+[NodeParser.ts:5](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/NodeParser.ts#L5)
___
@@ -701,15 +704,17 @@ ___
â–¸ **getTopKEmbeddings**(`queryEmbedding`, `embeddings`, `similarityTopK?`, `embeddingIds?`, `similarityCutoff?`): [`number`[], `any`[]]
+Get the top K embeddings from a list of embeddings ordered by similarity to the query.
+
#### Parameters
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `queryEmbedding` | `number`[] | `undefined` |
-| `embeddings` | `number`[][] | `undefined` |
-| `similarityTopK` | `number` | `DEFAULT_SIMILARITY_TOP_K` |
-| `embeddingIds` | ``null`` \| `any`[] | `null` |
-| `similarityCutoff` | ``null`` \| `number` | `null` |
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `queryEmbedding` | `number`[] | `undefined` | |
+| `embeddings` | `number`[][] | `undefined` | list of embeddings to consider |
+| `similarityTopK` | `number` | `DEFAULT_SIMILARITY_TOP_K` | max number of embeddings to return, default 2 |
+| `embeddingIds` | ``null`` \| `any`[] | `null` | ids of embeddings in the embeddings list |
+| `similarityCutoff` | ``null`` \| `number` | `null` | minimum similarity score |
#### Returns
@@ -717,7 +722,7 @@ ___
#### Defined in
-[Embedding.ts:57](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L57)
+[Embedding.ts:77](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L77)
___
@@ -741,7 +746,7 @@ ___
#### Defined in
-[Embedding.ts:99](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L99)
+[Embedding.ts:119](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L119)
___
@@ -767,7 +772,7 @@ ___
#### Defined in
-[Embedding.ts:111](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L111)
+[Embedding.ts:131](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L131)
___
@@ -787,7 +792,7 @@ ___
#### Defined in
-[Prompt.ts:300](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Prompt.ts#L300)
+[Prompt.ts:300](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Prompt.ts#L300)
___
@@ -807,7 +812,7 @@ ___
#### Defined in
-[ServiceContext.ts:29](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ServiceContext.ts#L29)
+[ServiceContext.ts:32](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ServiceContext.ts#L32)
___
@@ -836,7 +841,7 @@ ___
#### Defined in
-[ServiceContext.ts:49](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/ServiceContext.ts#L49)
+[ServiceContext.ts:52](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/ServiceContext.ts#L52)
___
@@ -844,6 +849,8 @@ ___
â–¸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number`
+The similarity between two embeddings.
+
#### Parameters
| Name | Type | Default value |
@@ -856,9 +863,11 @@ ___
`number`
+similartiy score with higher numbers meaning the two embeddings are more similar
+
#### Defined in
-[Embedding.ts:11](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/Embedding.ts#L11)
+[Embedding.ts:22](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/Embedding.ts#L22)
___
@@ -878,7 +887,7 @@ ___
#### Defined in
-[storage/StorageContext.ts:28](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/StorageContext.ts#L28)
+[storage/StorageContext.ts:28](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/StorageContext.ts#L28)
___
@@ -901,4 +910,4 @@ Recursively traverses a directory and yields all the paths to the files in it.
#### Defined in
-[storage/FileSystem.ts:91](https://github.com/run-llama/llamascript/blob/df4b1ad/packages/core/src/storage/FileSystem.ts#L91)
+[storage/FileSystem.ts:91](https://github.com/run-llama/llamascript/blob/4649536/packages/core/src/storage/FileSystem.ts#L91)
diff --git a/apps/docs/docusaurus.config.js b/apps/docs/docusaurus.config.js
index 4235f30e0..95d52c1a6 100644
--- a/apps/docs/docusaurus.config.js
+++ b/apps/docs/docusaurus.config.js
@@ -41,8 +41,8 @@ const config = {
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/",
+ // editUrl:
+ // "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
},
blog: {
showReadingTime: true,
diff --git a/packages/core/src/BaseIndex.ts b/packages/core/src/BaseIndex.ts
index 0889be758..1377d6ceb 100644
--- a/packages/core/src/BaseIndex.ts
+++ b/packages/core/src/BaseIndex.ts
@@ -11,6 +11,9 @@ import { BaseDocumentStore } from "./storage/docStore/types";
import { VectorStore } from "./storage/vectorStore/types";
import { BaseIndexStore } from "./storage/indexStore/types";
+/**
+ * The underlying structure of each index.
+ */
export abstract class IndexStruct {
indexId: string;
summary?: string;
@@ -92,6 +95,9 @@ interface VectorIndexConstructorProps extends BaseIndexInit<IndexDict> {
vectorStore: VectorStore;
}
+/**
+ * The VectorStoreIndex, an index that stores the nodes only according to their vector embedings.
+ */
export class VectorStoreIndex extends BaseIndex<IndexDict> {
vectorStore: VectorStore;
diff --git a/packages/core/src/ChatEngine.ts b/packages/core/src/ChatEngine.ts
index 00b73e6a8..9ea7d258f 100644
--- a/packages/core/src/ChatEngine.ts
+++ b/packages/core/src/ChatEngine.ts
@@ -13,14 +13,26 @@ import { ServiceContext, serviceContextFromDefaults } from "./ServiceContext";
import { v4 as uuidv4 } from "uuid";
import { Event } from "./callbacks/CallbackManager";
+/**
+ * A ChatEngine is used to handle back and forth chats between the application and the LLM.
+ */
interface ChatEngine {
- chatRepl(): void;
-
+ /**
+ * Send message along with the class's current chat history to the LLM.
+ * @param message
+ * @param chatHistory optional chat history if you want to customize the chat history
+ */
achat(message: string, chatHistory?: ChatMessage[]): Promise<Response>;
+ /**
+ * Resets the chat history so that it's empty.
+ */
reset(): void;
}
+/**
+ * SimpleChatEngine is the simplest possible chat engine. Useful for using your own custom prompts.
+ */
export class SimpleChatEngine implements ChatEngine {
chatHistory: ChatMessage[];
llm: LLM;
@@ -30,10 +42,6 @@ export class SimpleChatEngine implements ChatEngine {
this.llm = init?.llm ?? new OpenAI();
}
- chatRepl() {
- throw new Error("Method not implemented.");
- }
-
async achat(message: string, chatHistory?: ChatMessage[]): Promise<Response> {
chatHistory = chatHistory ?? this.chatHistory;
chatHistory.push({ content: message, role: "user" });
@@ -48,6 +56,16 @@ export class SimpleChatEngine implements ChatEngine {
}
}
+/**
+ * CondenseQuestionChatEngine is used in conjunction with a Index (for example VectorIndex).
+ * It does two steps on taking a user's chat message: first, it condenses the chat message
+ * with the previous chat history into a question with more context.
+ * Then, it queries the underlying Index using the new question with context and returns
+ * the response.
+ * CondenseQuestionChatEngine performs well when the input is primarily questions about the
+ * underlying data. It performs less well when the chat messages are not questions about the
+ * data, or are very referential to previous context.
+ */
export class CondenseQuestionChatEngine implements ChatEngine {
queryEngine: BaseQueryEngine;
chatHistory: ChatMessage[];
@@ -102,15 +120,16 @@ export class CondenseQuestionChatEngine implements ChatEngine {
return response;
}
- chatRepl() {
- throw new Error("Method not implemented.");
- }
-
reset() {
this.chatHistory = [];
}
}
+/**
+ * ContextChatEngine uses the Index to get the appropriate context for each query.
+ * The context is stored in the system prompt, and the chat history is preserved,
+ * ideally allowing the appropriate context to be surfaced for each query.
+ */
export class ContextChatEngine implements ChatEngine {
retriever: BaseRetriever;
chatModel: OpenAI;
diff --git a/packages/core/src/Embedding.ts b/packages/core/src/Embedding.ts
index bb824bc0e..d5719ac02 100644
--- a/packages/core/src/Embedding.ts
+++ b/packages/core/src/Embedding.ts
@@ -2,12 +2,23 @@ import { DEFAULT_SIMILARITY_TOP_K } from "./constants";
import { OpenAISession, getOpenAISession } from "./openai";
import { VectorStoreQueryMode } from "./storage/vectorStore/types";
+/**
+ * Similarity type
+ * Default is cosine similarity. Dot product and negative Euclidean distance are also supported.
+ */
export enum SimilarityType {
DEFAULT = "cosine",
DOT_PRODUCT = "dot_product",
EUCLIDEAN = "euclidean",
}
+/**
+ * The similarity between two embeddings.
+ * @param embedding1
+ * @param embedding2
+ * @param mode
+ * @returns similartiy score with higher numbers meaning the two embeddings are more similar
+ */
export function similarity(
embedding1: number[],
embedding2: number[],
@@ -54,6 +65,15 @@ export function similarity(
}
}
+/**
+ * Get the top K embeddings from a list of embeddings ordered by similarity to the query.
+ * @param queryEmbedding
+ * @param embeddings list of embeddings to consider
+ * @param similarityTopK max number of embeddings to return, default 2
+ * @param embeddingIds ids of embeddings in the embeddings list
+ * @param similarityCutoff minimum similarity score
+ * @returns
+ */
export function getTopKEmbeddings(
queryEmbedding: number[],
embeddings: number[][],
diff --git a/packages/core/src/GlobalsHelper.ts b/packages/core/src/GlobalsHelper.ts
index 58a154d33..32b76b643 100644
--- a/packages/core/src/GlobalsHelper.ts
+++ b/packages/core/src/GlobalsHelper.ts
@@ -1,6 +1,9 @@
import { Event, EventTag, EventType } from "./callbacks/CallbackManager";
import { v4 as uuidv4 } from "uuid";
+/**
+ * Helper class singleton
+ */
class GlobalsHelper {
defaultTokenizer: ((text: string) => string[]) | null = null;
diff --git a/packages/core/src/LLM.ts b/packages/core/src/LLM.ts
index 56d1d1935..f2ea0a11e 100644
--- a/packages/core/src/LLM.ts
+++ b/packages/core/src/LLM.ts
@@ -24,8 +24,20 @@ export interface ChatResponse {
// NOTE in case we need CompletionResponse to diverge from ChatResponse in the future
export type CompletionResponse = ChatResponse;
+/**
+ * Unified language model interface
+ */
export interface LLM {
+ /**
+ * Get a chat response from the LLM
+ * @param messages
+ */
achat(messages: ChatMessage[]): Promise<ChatResponse>;
+
+ /**
+ * Get a prompt completion from the LLM
+ * @param prompt the prompt to complete
+ */
acomplete(prompt: string): Promise<CompletionResponse>;
}
@@ -39,11 +51,17 @@ export const TURBO_MODELS = {
"gpt-3.5-turbo-16k": 16384,
};
+/**
+ * We currently support GPT-3.5 and GPT-4 models
+ */
export const ALL_AVAILABLE_MODELS = {
...GPT4_MODELS,
...TURBO_MODELS,
};
+/**
+ * OpenAI LLM implementation
+ */
export class OpenAI implements LLM {
model: keyof typeof ALL_AVAILABLE_MODELS;
temperature: number;
diff --git a/packages/core/src/LLMPredictor.ts b/packages/core/src/LLMPredictor.ts
index bb7d55573..69a6aa505 100644
--- a/packages/core/src/LLMPredictor.ts
+++ b/packages/core/src/LLMPredictor.ts
@@ -2,7 +2,9 @@ import { ALL_AVAILABLE_MODELS, OpenAI } from "./LLM";
import { SimplePrompt } from "./Prompt";
import { CallbackManager, Event } from "./callbacks/CallbackManager";
-// TODO change this to LLM class
+/**
+ * LLM Predictors are an abstraction to predict the response to a prompt.
+ */
export interface BaseLLMPredictor {
getLlmMetadata(): Promise<any>;
apredict(
@@ -12,7 +14,9 @@ export interface BaseLLMPredictor {
): Promise<string>;
}
-// TODO change this to LLM class
+/**
+ * ChatGPTLLMPredictor is a predictor that uses GPT.
+ */
export class ChatGPTLLMPredictor implements BaseLLMPredictor {
model: keyof typeof ALL_AVAILABLE_MODELS;
retryOnThrottling: boolean;
diff --git a/packages/core/src/Node.ts b/packages/core/src/Node.ts
index 95d3081c8..f47b9d158 100644
--- a/packages/core/src/Node.ts
+++ b/packages/core/src/Node.ts
@@ -130,6 +130,9 @@ export abstract class BaseNode {
}
}
+/**
+ * TextNode is the default node type for text. Most common node type in LlamaIndex.TS
+ */
export class TextNode extends BaseNode {
text: string = "";
startCharIdx?: number;
@@ -190,13 +193,13 @@ export class TextNode extends BaseNode {
}
}
-export class ImageNode extends TextNode {
- image: string = "";
+// export class ImageNode extends TextNode {
+// image: string = "";
- getType(): ObjectType {
- return ObjectType.IMAGE;
- }
-}
+// getType(): ObjectType {
+// return ObjectType.IMAGE;
+// }
+// }
export class IndexNode extends TextNode {
indexId: string = "";
@@ -206,6 +209,9 @@ export class IndexNode extends TextNode {
}
}
+/**
+ * A document is just a special text node with a docId.
+ */
export class Document extends TextNode {
constructor(init?: Partial<Document>) {
super(init);
@@ -221,15 +227,21 @@ export class Document extends TextNode {
}
}
-export class ImageDocument extends Document {
- image?: string;
-}
+// export class ImageDocument extends Document {
+// image?: string;
+// }
+/**
+ * A node with a similarity score
+ */
export interface NodeWithScore {
node: BaseNode;
score: number;
}
+/**
+ * A node with an embedding
+ */
export interface NodeWithEmbedding {
node: BaseNode;
embedding: number[];
diff --git a/packages/core/src/NodeParser.ts b/packages/core/src/NodeParser.ts
index f3e173f94..99f9daba6 100644
--- a/packages/core/src/NodeParser.ts
+++ b/packages/core/src/NodeParser.ts
@@ -46,10 +46,16 @@ export function getNodesFromDocument(
return nodes;
}
-
+/**
+ * A node parser generates TextNodes from Documents
+ */
export interface NodeParser {
getNodesFromDocuments(documents: Document[]): TextNode[];
}
+
+/**
+ * SimpleNodeParser is the default NodeParser. It splits documents into TextNodes using a splitter, by default SentenceSplitter
+ */
export class SimpleNodeParser implements NodeParser {
textSplitter: SentenceSplitter;
includeMetadata: boolean;
diff --git a/packages/core/src/OutputParser.ts b/packages/core/src/OutputParser.ts
index a5e0dded7..6d9b6600a 100644
--- a/packages/core/src/OutputParser.ts
+++ b/packages/core/src/OutputParser.ts
@@ -1,15 +1,27 @@
import { SubQuestion } from "./QuestionGenerator";
+/**
+ * An OutputParser is used to extract structured data from the raw output of the LLM.
+ */
export interface BaseOutputParser<T> {
parse(output: string): T;
format(output: string): string;
}
+/**
+ * StructuredOutput is just a combo of the raw output and the parsed output.
+ */
export interface StructuredOutput<T> {
rawOutput: string;
parsedOutput: T;
}
+/**
+ * Error class for output parsing. Due to the nature of LLMs, anytime we use LLM
+ * to generate structured output, it's possible that it will hallucinate something
+ * that doesn't match the expected output format. So make sure to catch these
+ * errors in production.
+ */
class OutputParserError extends Error {
cause: Error | undefined;
output: string | undefined;
@@ -36,6 +48,11 @@ class OutputParserError extends Error {
}
}
+/**
+ *
+ * @param text A markdown block with JSON
+ * @returns parsed JSON object
+ */
function parseJsonMarkdown(text: string) {
text = text.trim();
@@ -63,6 +80,9 @@ function parseJsonMarkdown(text: string) {
}
}
+/**
+ * SubQuestionOutputParser is used to parse the output of the SubQuestionGenerator.
+ */
export class SubQuestionOutputParser
implements BaseOutputParser<StructuredOutput<SubQuestion[]>>
{
diff --git a/packages/core/src/PromptHelper.ts b/packages/core/src/PromptHelper.ts
index e7ecd7124..3ead2e090 100644
--- a/packages/core/src/PromptHelper.ts
+++ b/packages/core/src/PromptHelper.ts
@@ -13,6 +13,12 @@ export function getEmptyPromptTxt(prompt: SimplePrompt) {
return prompt({});
}
+/**
+ * Get biggest empty prompt size from a list of prompts.
+ * Used to calculate the maximum size of inputs to the LLM.
+ * @param prompts
+ * @returns
+ */
export function getBiggestPrompt(prompts: SimplePrompt[]) {
const emptyPromptTexts = prompts.map(getEmptyPromptTxt);
const emptyPromptLengths = emptyPromptTexts.map((text) => text.length);
@@ -21,6 +27,9 @@ export function getBiggestPrompt(prompts: SimplePrompt[]) {
return prompts[maxEmptyPromptIndex];
}
+/**
+ * A collection of helper functions for working with prompts.
+ */
export class PromptHelper {
contextWindow = DEFAULT_CONTEXT_WINDOW;
numOutput = DEFAULT_NUM_OUTPUTS;
@@ -45,6 +54,11 @@ export class PromptHelper {
this.separator = separator;
}
+ /**
+ * Given a prompt, return the maximum size of the inputs to the prompt.
+ * @param prompt
+ * @returns
+ */
private getAvailableContextSize(prompt: SimplePrompt) {
const emptyPromptText = getEmptyPromptTxt(prompt);
const promptTokens = this.tokenizer(emptyPromptText);
@@ -53,6 +67,13 @@ export class PromptHelper {
return this.contextWindow - numPromptTokens - this.numOutput;
}
+ /**
+ * Find the maximum size of each chunk given a prompt.
+ * @param prompt
+ * @param numChunks
+ * @param padding
+ * @returns
+ */
private getAvailableChunkSize(
prompt: SimplePrompt,
numChunks = 1,
@@ -69,6 +90,13 @@ export class PromptHelper {
}
}
+ /**
+ * Creates a text splitter with the correct chunk sizes and overlaps given a prompt.
+ * @param prompt
+ * @param numChunks
+ * @param padding
+ * @returns
+ */
getTextSplitterGivenPrompt(
prompt: SimplePrompt,
numChunks = 1,
@@ -83,14 +111,13 @@ export class PromptHelper {
return textSplitter;
}
- truncate(
- prompt: SimplePrompt,
- textChunks: string[],
- padding = DEFAULT_PADDING
- ) {
- throw new Error("Not implemented yet");
- }
-
+ /**
+ * Repack resplits the strings based on the optimal text splitter.
+ * @param prompt
+ * @param textChunks
+ * @param padding
+ * @returns
+ */
repack(
prompt: SimplePrompt,
textChunks: string[],
diff --git a/packages/core/src/QueryEngine.ts b/packages/core/src/QueryEngine.ts
index 543305cad..8ea7378b3 100644
--- a/packages/core/src/QueryEngine.ts
+++ b/packages/core/src/QueryEngine.ts
@@ -12,10 +12,16 @@ import { Event } from "./callbacks/CallbackManager";
import { ServiceContext, serviceContextFromDefaults } from "./ServiceContext";
import { QueryEngineTool, ToolMetadata } from "./Tool";
+/**
+ * A query engine is a question answerer that can use one or more steps.
+ */
export interface BaseQueryEngine {
aquery(query: string, parentEvent?: Event): Promise<Response>;
}
+/**
+ * A query engine that uses a retriever to query an index and then synthesizes the response.
+ */
export class RetrieverQueryEngine implements BaseQueryEngine {
retriever: BaseRetriever;
responseSynthesizer: ResponseSynthesizer;
@@ -38,6 +44,9 @@ export class RetrieverQueryEngine implements BaseQueryEngine {
}
}
+/**
+ * SubQuestionQueryEngine decomposes a question into subquestions and then
+ */
export class SubQuestionQueryEngine implements BaseQueryEngine {
responseSynthesizer: ResponseSynthesizer;
questionGen: BaseQuestionGenerator;
diff --git a/packages/core/src/QuestionGenerator.ts b/packages/core/src/QuestionGenerator.ts
index fad1f9732..bf014e9f9 100644
--- a/packages/core/src/QuestionGenerator.ts
+++ b/packages/core/src/QuestionGenerator.ts
@@ -16,10 +16,16 @@ export interface SubQuestion {
toolName: string;
}
+/**
+ * QuestionGenerators generate new questions for the LLM using tools and a user query.
+ */
export interface BaseQuestionGenerator {
agenerate(tools: ToolMetadata[], query: string): Promise<SubQuestion[]>;
}
+/**
+ * LLMQuestionGenerator uses the LLM to generate new questions for the LLM using tools and a user query.
+ */
export class LLMQuestionGenerator implements BaseQuestionGenerator {
llmPredictor: BaseLLMPredictor;
prompt: SimplePrompt;
diff --git a/packages/core/src/Response.ts b/packages/core/src/Response.ts
index 6351ac90f..c5be11b89 100644
--- a/packages/core/src/Response.ts
+++ b/packages/core/src/Response.ts
@@ -1,5 +1,8 @@
import { BaseNode } from "./Node";
+/**
+ * Respone is the output of a LLM
+ */
export class Response {
response: string;
sourceNodes?: BaseNode[];
diff --git a/packages/core/src/ResponseSynthesizer.ts b/packages/core/src/ResponseSynthesizer.ts
index 4aeedb55e..beb97adf7 100644
--- a/packages/core/src/ResponseSynthesizer.ts
+++ b/packages/core/src/ResponseSynthesizer.ts
@@ -10,7 +10,16 @@ import { Response } from "./Response";
import { ServiceContext } from "./ServiceContext";
import { Event } from "./callbacks/CallbackManager";
+/**
+ * A ResponseBuilder is used in a response synthesizer to generate a response from multiple response chunks.
+ */
interface BaseResponseBuilder {
+ /**
+ * Get the response from a query and a list of text chunks.
+ * @param query
+ * @param textChunks
+ * @param parentEvent
+ */
agetResponse(
query: string,
textChunks: string[],
@@ -18,6 +27,9 @@ interface BaseResponseBuilder {
): Promise<string>;
}
+/**
+ * A response builder that just concatenates responses.
+ */
export class SimpleResponseBuilder implements BaseResponseBuilder {
llmPredictor: BaseLLMPredictor;
textQATemplate: SimplePrompt;
@@ -43,6 +55,9 @@ export class SimpleResponseBuilder implements BaseResponseBuilder {
}
}
+/**
+ * A response builder that uses the query to ask the LLM generate a better response using multiple text chunks.
+ */
export class Refine implements BaseResponseBuilder {
serviceContext: ServiceContext;
textQATemplate: SimplePrompt;
@@ -129,6 +144,10 @@ export class Refine implements BaseResponseBuilder {
return response;
}
}
+
+/**
+ * CompactAndRefine is a slight variation of Refine that first compacts the text chunks into the smallest possible number of chunks.
+ */
export class CompactAndRefine extends Refine {
async agetResponse(
query: string,
@@ -149,7 +168,9 @@ export class CompactAndRefine extends Refine {
return response;
}
}
-
+/**
+ * TreeSummarize repacks the text chunks into the smallest possible number of chunks and then summarizes them, then recursively does so until there's one chunk left.
+ */
export class TreeSummarize implements BaseResponseBuilder {
serviceContext: ServiceContext;
@@ -194,7 +215,9 @@ export function getResponseBuilder(
return new SimpleResponseBuilder(serviceContext);
}
-// TODO replace with Logan's new response_sythesizers/factory.py
+/**
+ * A ResponseSynthesizer is used to generate a response from a query and a list of nodes.
+ */
export class ResponseSynthesizer {
responseBuilder: BaseResponseBuilder;
serviceContext?: ServiceContext;
diff --git a/packages/core/src/Retriever.ts b/packages/core/src/Retriever.ts
index 428be6bb6..60fcf7d70 100644
--- a/packages/core/src/Retriever.ts
+++ b/packages/core/src/Retriever.ts
@@ -9,11 +9,17 @@ import {
VectorStoreQueryMode,
} from "./storage/vectorStore/types";
+/**
+ * Retrievers retrieve the nodes that most closely match our query in similarity.
+ */
export interface BaseRetriever {
aretrieve(query: string, parentEvent?: Event): Promise<NodeWithScore[]>;
getServiceContext(): ServiceContext;
}
+/**
+ * VectorIndexRetriever retrieves nodes from a VectorIndex.
+ */
export class VectorIndexRetriever implements BaseRetriever {
index: VectorStoreIndex;
similarityTopK = DEFAULT_SIMILARITY_TOP_K;
diff --git a/packages/core/src/ServiceContext.ts b/packages/core/src/ServiceContext.ts
index 931e5118c..01e13e963 100644
--- a/packages/core/src/ServiceContext.ts
+++ b/packages/core/src/ServiceContext.ts
@@ -5,6 +5,9 @@ import { NodeParser, SimpleNodeParser } from "./NodeParser";
import { PromptHelper } from "./PromptHelper";
import { CallbackManager } from "./callbacks/CallbackManager";
+/**
+ * The ServiceContext is a collection of components that are used in different parts of the application.
+ */
export interface ServiceContext {
llmPredictor: BaseLLMPredictor;
promptHelper: PromptHelper;
diff --git a/packages/core/src/TextSplitter.ts b/packages/core/src/TextSplitter.ts
index 3ec20da63..706506a10 100644
--- a/packages/core/src/TextSplitter.ts
+++ b/packages/core/src/TextSplitter.ts
@@ -18,6 +18,9 @@ class TextSplit {
type SplitRep = [text: string, numTokens: number];
+/**
+ * SentenceSplitter is our default text splitter that supports splitting into sentences, paragraphs, or fixed length chunks with overlap.
+ */
export class SentenceSplitter {
private chunkSize: number;
private chunkOverlap: number;
diff --git a/packages/core/src/Tool.ts b/packages/core/src/Tool.ts
index 5eaecb125..9474f358c 100644
--- a/packages/core/src/Tool.ts
+++ b/packages/core/src/Tool.ts
@@ -5,10 +5,16 @@ export interface ToolMetadata {
name: string;
}
+/**
+ * Simple Tool interface. Likely to change.
+ */
export interface BaseTool {
metadata: ToolMetadata;
}
+/**
+ * A Tool that uses a QueryEngine.
+ */
export interface QueryEngineTool extends BaseTool {
queryEngine: BaseQueryEngine;
}
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
index 762728da8..7bf8c8264 100644
--- a/packages/core/src/index.ts
+++ b/packages/core/src/index.ts
@@ -11,6 +11,7 @@ export * from "./NodeParser";
export * from "./OutputParser";
export * from "./Prompt";
export * from "./QuestionGenerator";
+export * from "./QueryEngine";
export * from "./Response";
export * from "./ResponseSynthesizer";
export * from "./Retriever";
diff --git a/packages/core/src/index/list/ListIndex.ts b/packages/core/src/index/list/ListIndex.ts
index 1b9026b9d..7b2aff279 100644
--- a/packages/core/src/index/list/ListIndex.ts
+++ b/packages/core/src/index/list/ListIndex.ts
@@ -30,6 +30,9 @@ export interface ListIndexOptions {
storageContext?: StorageContext;
}
+/**
+ * A ListIndex keeps nodes in a sequential list structure
+ */
export class ListIndex extends BaseIndex<IndexList> {
constructor(init: BaseIndexInit<IndexList>) {
super(init);
diff --git a/packages/core/src/openai.ts b/packages/core/src/openai.ts
index a97ed2b27..d94422d3e 100644
--- a/packages/core/src/openai.ts
+++ b/packages/core/src/openai.ts
@@ -15,6 +15,9 @@ import {
import { AxiosRequestConfig, AxiosResponse } from "axios";
import fetchAdapter from "./fetchAdapter";
+/**
+ * OpenAIWrapper is a wrapper around the OpenAI API that uses fetch instead of axios
+ */
export class OpenAIWrapper extends OpenAIApi {
createCompletion(
createCompletionRequest: CreateCompletionRequest,
diff --git a/packages/core/src/readers/PDFReader.ts b/packages/core/src/readers/PDFReader.ts
index 066043471..4c0d977b9 100644
--- a/packages/core/src/readers/PDFReader.ts
+++ b/packages/core/src/readers/PDFReader.ts
@@ -5,6 +5,9 @@ import { DEFAULT_FS } from "../storage/constants";
import { default as pdfParse } from "pdf-parse";
import _ from "lodash";
+/**
+ * Read the text of a PDF
+ */
export default class PDFReader implements BaseReader {
async loadData(
file: string,
diff --git a/packages/core/src/readers/SimpleDirectoryReader.ts b/packages/core/src/readers/SimpleDirectoryReader.ts
index ef5b2d8ec..99d1c4f99 100644
--- a/packages/core/src/readers/SimpleDirectoryReader.ts
+++ b/packages/core/src/readers/SimpleDirectoryReader.ts
@@ -5,6 +5,9 @@ import { CompleteFileSystem, walk } from "../storage/FileSystem";
import { DEFAULT_FS } from "../storage/constants";
import PDFReader from "./PDFReader";
+/**
+ * Read a .txt file
+ */
export class TextFileReader implements BaseReader {
async loadData(
file: string,
@@ -27,6 +30,9 @@ export type SimpleDirectoryReaderLoadDataProps = {
fileExtToReader?: Record<string, BaseReader>;
};
+/**
+ * Read all of the documents in a directory. Currently supports PDF and TXT files.
+ */
export default class SimpleDirectoryReader implements BaseReader {
async loadData({
directoryPath,
diff --git a/packages/core/src/readers/base.ts b/packages/core/src/readers/base.ts
index a57f2cdaa..35501d6dc 100644
--- a/packages/core/src/readers/base.ts
+++ b/packages/core/src/readers/base.ts
@@ -1,5 +1,8 @@
import { Document } from "../Node";
+/**
+ * A reader takes imports data into Document objects.
+ */
export interface BaseReader {
loadData(...args: any[]): Promise<Document[]>;
}
--
GitLab