From 8954a80e04afcc1e6d64a879d346fd8d418390c4 Mon Sep 17 00:00:00 2001
From: Logan Markewich <logan.markewich@live.com>
Date: Thu, 20 Jul 2023 17:05:26 -0600
Subject: [PATCH] add search bar
---
apps/docs/README-docusaurus.md | 8 +-
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/docs/api/classes/CompactAndRefine.md | 10 +-
.../api/classes/CondenseQuestionChatEngine.md | 16 +-
.../docs/api/classes/ContextChatEngine.md | 14 +-
apps/docs/docs/api/classes/Document.md | 56 +-
.../docs/api/classes/InMemoryFileSystem.md | 10 +-
apps/docs/docs/api/classes/IndexDict.md | 14 +-
apps/docs/docs/api/classes/IndexList.md | 12 +-
apps/docs/docs/api/classes/IndexNode.md | 56 +-
apps/docs/docs/api/classes/IndexStruct.md | 8 +-
.../docs/api/classes/LLMQuestionGenerator.md | 10 +-
apps/docs/docs/api/classes/ListIndex.md | 30 +-
.../docs/api/classes/ListIndexLLMRetriever.md | 18 +-
.../docs/api/classes/ListIndexRetriever.md | 8 +-
apps/docs/docs/api/classes/LlamaDeuce.md | 16 +-
apps/docs/docs/api/classes/OpenAI.md | 24 +-
apps/docs/docs/api/classes/OpenAIEmbedding.md | 14 +-
apps/docs/docs/api/classes/PDFReader.md | 2 +-
apps/docs/docs/api/classes/Refine.md | 14 +-
apps/docs/docs/api/classes/Response.md | 10 +-
.../docs/api/classes/ResponseSynthesizer.md | 8 +-
.../docs/api/classes/RetrieverQueryEngine.md | 8 +-
.../docs/docs/api/classes/SentenceSplitter.md | 28 +-
.../docs/docs/api/classes/SimpleChatEngine.md | 10 +-
.../docs/api/classes/SimpleDirectoryReader.md | 2 +-
.../docs/docs/api/classes/SimpleNodeParser.md | 12 +-
.../docs/api/classes/SimpleResponseBuilder.md | 8 +-
.../api/classes/SubQuestionOutputParser.md | 4 +-
.../api/classes/SubQuestionQueryEngine.md | 16 +-
apps/docs/docs/api/classes/TextFileReader.md | 2 +-
apps/docs/docs/api/classes/TextNode.md | 54 +-
apps/docs/docs/api/classes/TreeSummarize.md | 6 +-
.../docs/api/classes/VectorIndexRetriever.md | 12 +-
.../docs/docs/api/classes/VectorStoreIndex.md | 26 +-
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 | 6 +-
.../docs/docs/api/interfaces/BaseIndexInit.md | 12 +-
.../docs/api/interfaces/BaseOutputParser.md | 4 +-
.../docs/api/interfaces/BaseQueryEngine.md | 2 +-
.../api/interfaces/BaseQuestionGenerator.md | 2 +-
apps/docs/docs/api/interfaces/BaseReader.md | 2 +-
.../docs/docs/api/interfaces/BaseRetriever.md | 4 +-
apps/docs/docs/api/interfaces/BaseTool.md | 2 +-
apps/docs/docs/api/interfaces/ChatEngine.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 | 4 +-
apps/docs/docs/api/interfaces/NodeParser.md | 2 +-
.../docs/api/interfaces/NodeWithEmbedding.md | 4 +-
.../docs/docs/api/interfaces/NodeWithScore.md | 4 +-
.../docs/api/interfaces/QueryEngineTool.md | 4 +-
.../docs/api/interfaces/RelatedNodeInfo.md | 8 +-
.../interfaces/RetrievalCallbackResponse.md | 6 +-
.../docs/api/interfaces/ServiceContext.md | 10 +-
.../api/interfaces/ServiceContextOptions.md | 14 +-
.../docs/api/interfaces/StorageContext.md | 6 +-
.../api/interfaces/StreamCallbackResponse.md | 8 +-
apps/docs/docs/api/interfaces/StreamToken.md | 10 +-
.../docs/api/interfaces/StructuredOutput.md | 4 +-
apps/docs/docs/api/interfaces/SubQuestion.md | 4 +-
apps/docs/docs/api/interfaces/ToolMetadata.md | 4 +-
.../interfaces/VectorIndexConstructorProps.md | 12 +-
.../docs/api/interfaces/VectorIndexOptions.md | 8 +-
.../docs/api/interfaces/WalkableFileSystem.md | 4 +-
apps/docs/docs/api/modules.md | 100 ++--
apps/docs/docusaurus.config.js | 3 +-
apps/docs/package.json | 1 +
apps/docs/src/theme/SearchBar/DocSearch.js | 297 ++++++++++
apps/docs/src/theme/SearchBar/algolia.css | 526 ++++++++++++++++++
apps/docs/src/theme/SearchBar/index.js | 114 ++++
apps/docs/src/theme/SearchBar/lunar-search.js | 147 +++++
apps/docs/src/theme/SearchBar/styles.css | 33 ++
apps/docs/src/theme/SearchBar/templates.js | 112 ++++
apps/docs/src/theme/SearchBar/utils.js | 270 +++++++++
83 files changed, 1967 insertions(+), 460 deletions(-)
create mode 100644 apps/docs/src/theme/SearchBar/DocSearch.js
create mode 100644 apps/docs/src/theme/SearchBar/algolia.css
create mode 100644 apps/docs/src/theme/SearchBar/index.js
create mode 100644 apps/docs/src/theme/SearchBar/lunar-search.js
create mode 100644 apps/docs/src/theme/SearchBar/styles.css
create mode 100644 apps/docs/src/theme/SearchBar/templates.js
create mode 100644 apps/docs/src/theme/SearchBar/utils.js
diff --git a/apps/docs/README-docusaurus.md b/apps/docs/README-docusaurus.md
index aaba2fa1e..35202d6ca 100644
--- a/apps/docs/README-docusaurus.md
+++ b/apps/docs/README-docusaurus.md
@@ -14,7 +14,13 @@ $ yarn
$ yarn start
```
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+However, the searchbar may not function with `yarn start`. Instead, run `yarn build` and launch a server:
+
+```
+$ npx http-server ./build
+```
### Build
diff --git a/apps/docs/docs/api/classes/BaseEmbedding.md b/apps/docs/docs/api/classes/BaseEmbedding.md
index 0d583d1a6..511c212db 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:206](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L206)
+[Embedding.ts:206](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L206)
___
@@ -56,7 +56,7 @@ ___
#### Defined in
-[Embedding.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L205)
+[Embedding.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L205)
___
@@ -78,4 +78,4 @@ ___
#### Defined in
-[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L197)
+[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 b3676e8de..81edb4c10 100644
--- a/apps/docs/docs/api/classes/BaseIndex.md
+++ b/apps/docs/docs/api/classes/BaseIndex.md
@@ -43,7 +43,7 @@ they can be retrieved for our queries.
#### Defined in
-[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L76)
+[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L76)
## Properties
@@ -53,7 +53,7 @@ they can be retrieved for our queries.
#### Defined in
-[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L71)
+[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L71)
___
@@ -63,7 +63,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L73)
+[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L73)
___
@@ -73,7 +73,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L74)
+[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L74)
___
@@ -83,7 +83,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L69)
+[indices/BaseIndex.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L69)
___
@@ -93,7 +93,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L70)
+[indices/BaseIndex.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L70)
___
@@ -103,7 +103,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L72)
+[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L72)
## Methods
@@ -117,4 +117,4 @@ ___
#### Defined in
-[indices/BaseIndex.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L85)
+[indices/BaseIndex.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L85)
diff --git a/apps/docs/docs/api/classes/BaseNode.md b/apps/docs/docs/api/classes/BaseNode.md
index 1aaa070cf..ab25c9fb6 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/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L48)
+[Node.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L39)
+[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L39)
___
@@ -48,7 +48,7 @@ ___
#### Defined in
-[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L43)
+[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L43)
___
@@ -58,7 +58,7 @@ ___
#### Defined in
-[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L44)
+[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L44)
___
@@ -68,7 +68,7 @@ ___
#### Defined in
-[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L46)
+[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L46)
___
@@ -78,7 +78,7 @@ ___
#### Defined in
-[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L38)
+[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L38)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
-[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L42)
+[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L42)
___
@@ -98,7 +98,7 @@ ___
#### Defined in
-[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L45)
+[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L45)
## Accessors
@@ -112,7 +112,7 @@ ___
#### Defined in
-[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L104)
+[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L104)
___
@@ -126,7 +126,7 @@ ___
#### Defined in
-[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L84)
+[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L84)
___
@@ -140,7 +140,7 @@ ___
#### Defined in
-[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L58)
+[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L58)
___
@@ -154,7 +154,7 @@ ___
#### Defined in
-[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L94)
+[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L94)
___
@@ -168,7 +168,7 @@ ___
#### Defined in
-[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L72)
+[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L72)
___
@@ -182,7 +182,7 @@ ___
#### Defined in
-[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L62)
+[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L62)
## Methods
@@ -196,7 +196,7 @@ ___
#### Defined in
-[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L124)
+[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L124)
___
@@ -216,7 +216,7 @@ ___
#### Defined in
-[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L54)
+[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L54)
___
@@ -230,7 +230,7 @@ ___
#### Defined in
-[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L116)
+[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L116)
___
@@ -250,7 +250,7 @@ ___
#### Defined in
-[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L55)
+[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L55)
___
@@ -264,7 +264,7 @@ ___
#### Defined in
-[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L52)
+[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L52)
___
@@ -284,4 +284,4 @@ ___
#### Defined in
-[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L56)
+[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 c40c22cca..21dc23a93 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/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L68)
+[callbacks/CallbackManager.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L65)
+[callbacks/CallbackManager.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L65)
___
@@ -80,4 +80,4 @@ CallbackManagerMethods.onRetrieve
#### Defined in
-[callbacks/CallbackManager.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L66)
+[callbacks/CallbackManager.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L66)
diff --git a/apps/docs/docs/api/classes/CompactAndRefine.md b/apps/docs/docs/api/classes/CompactAndRefine.md
index 67af5807f..2295d8412 100644
--- a/apps/docs/docs/api/classes/CompactAndRefine.md
+++ b/apps/docs/docs/api/classes/CompactAndRefine.md
@@ -34,7 +34,7 @@ CompactAndRefine is a slight variation of Refine that first compacts the text ch
#### Defined in
-[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L78)
+[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L78)
## Properties
@@ -48,7 +48,7 @@ CompactAndRefine is a slight variation of Refine that first compacts the text ch
#### Defined in
-[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L76)
+[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L76)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L74)
+[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L74)
___
@@ -76,7 +76,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L75)
+[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L75)
## Methods
@@ -103,4 +103,4 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L181)
+[ResponseSynthesizer.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L181)
diff --git a/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md b/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md
index 70a0d40f0..ac1229668 100644
--- a/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md
+++ b/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md
@@ -37,7 +37,7 @@ data, or are very referential to previous context.
#### Defined in
-[ChatEngine.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L75)
+[ChatEngine.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L75)
## Properties
@@ -47,7 +47,7 @@ data, or are very referential to previous context.
#### Defined in
-[ChatEngine.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L71)
+[ChatEngine.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L71)
___
@@ -57,7 +57,7 @@ ___
#### Defined in
-[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L73)
+[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L73)
___
@@ -67,7 +67,7 @@ ___
#### Defined in
-[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L70)
+[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L70)
___
@@ -77,7 +77,7 @@ ___
#### Defined in
-[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L72)
+[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L72)
## Methods
@@ -104,7 +104,7 @@ Send message along with the class's current chat history to the LLM.
#### Defined in
-[ChatEngine.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L100)
+[ChatEngine.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L100)
___
@@ -125,7 +125,7 @@ ___
#### Defined in
-[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L89)
+[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L89)
___
@@ -145,4 +145,4 @@ Resets the chat history so that it's empty.
#### Defined in
-[ChatEngine.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L118)
+[ChatEngine.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L118)
diff --git a/apps/docs/docs/api/classes/ContextChatEngine.md b/apps/docs/docs/api/classes/ContextChatEngine.md
index ac163d51d..7b3aa6455 100644
--- a/apps/docs/docs/api/classes/ContextChatEngine.md
+++ b/apps/docs/docs/api/classes/ContextChatEngine.md
@@ -31,7 +31,7 @@ ideally allowing the appropriate context to be surfaced for each query.
#### Defined in
-[ChatEngine.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L133)
+[ChatEngine.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L133)
## Properties
@@ -41,7 +41,7 @@ ideally allowing the appropriate context to be surfaced for each query.
#### Defined in
-[ChatEngine.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L131)
+[ChatEngine.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L131)
___
@@ -51,7 +51,7 @@ ___
#### Defined in
-[ChatEngine.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L130)
+[ChatEngine.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L130)
___
@@ -61,7 +61,7 @@ ___
#### Defined in
-[ChatEngine.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L129)
+[ChatEngine.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L129)
## Methods
@@ -88,7 +88,7 @@ Send message along with the class's current chat history to the LLM.
#### Defined in
-[ChatEngine.ts:148](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L148)
+[ChatEngine.ts:148](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L148)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
-[ChatEngine.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L144)
+[ChatEngine.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L144)
___
@@ -122,4 +122,4 @@ Resets the chat history so that it's empty.
#### Defined in
-[ChatEngine.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L186)
+[ChatEngine.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L186)
diff --git a/apps/docs/docs/api/classes/Document.md b/apps/docs/docs/api/classes/Document.md
index 0de5f9f1c..161776f58 100644
--- a/apps/docs/docs/api/classes/Document.md
+++ b/apps/docs/docs/api/classes/Document.md
@@ -32,7 +32,7 @@ A document is just a special text node with a docId.
#### Defined in
-[Node.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L216)
+[Node.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L216)
## Properties
@@ -46,7 +46,7 @@ A document is just a special text node with a docId.
#### Defined in
-[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L39)
+[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L39)
___
@@ -60,7 +60,7 @@ ___
#### Defined in
-[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L139)
+[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L139)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
-[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L43)
+[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L43)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
-[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L44)
+[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L44)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
-[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L46)
+[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L46)
___
@@ -116,7 +116,7 @@ ___
#### Defined in
-[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L38)
+[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L38)
___
@@ -130,7 +130,7 @@ ___
#### Defined in
-[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L42)
+[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L42)
___
@@ -144,7 +144,7 @@ ___
#### Defined in
-[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L142)
+[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L142)
___
@@ -158,7 +158,7 @@ ___
#### Defined in
-[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L45)
+[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L45)
___
@@ -172,7 +172,7 @@ ___
#### Defined in
-[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L138)
+[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L138)
___
@@ -186,7 +186,7 @@ ___
#### Defined in
-[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L137)
+[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L137)
## Accessors
@@ -204,7 +204,7 @@ TextNode.childNodes
#### Defined in
-[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L104)
+[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L104)
___
@@ -218,7 +218,7 @@ ___
#### Defined in
-[Node.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L225)
+[Node.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L225)
___
@@ -236,7 +236,7 @@ TextNode.nextNode
#### Defined in
-[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L84)
+[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L84)
___
@@ -254,7 +254,7 @@ TextNode.nodeId
#### Defined in
-[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L58)
+[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L58)
___
@@ -272,7 +272,7 @@ TextNode.parentNode
#### Defined in
-[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L94)
+[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L94)
___
@@ -290,7 +290,7 @@ TextNode.prevNode
#### Defined in
-[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L72)
+[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L72)
___
@@ -308,7 +308,7 @@ TextNode.sourceNode
#### Defined in
-[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L62)
+[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L62)
## Methods
@@ -326,7 +326,7 @@ TextNode.sourceNode
#### Defined in
-[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L124)
+[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L124)
___
@@ -344,7 +344,7 @@ ___
#### Defined in
-[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L149)
+[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L149)
___
@@ -368,7 +368,7 @@ ___
#### Defined in
-[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L157)
+[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L157)
___
@@ -386,7 +386,7 @@ ___
#### Defined in
-[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L116)
+[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L116)
___
@@ -410,7 +410,7 @@ ___
#### Defined in
-[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L162)
+[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L162)
___
@@ -433,7 +433,7 @@ ___
#### Defined in
-[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L187)
+[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L187)
___
@@ -451,7 +451,7 @@ ___
#### Defined in
-[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L191)
+[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L191)
___
@@ -469,7 +469,7 @@ ___
#### Defined in
-[Node.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L221)
+[Node.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L221)
___
@@ -493,4 +493,4 @@ ___
#### Defined in
-[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L183)
+[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L183)
diff --git a/apps/docs/docs/api/classes/InMemoryFileSystem.md b/apps/docs/docs/api/classes/InMemoryFileSystem.md
index 087a7ed9e..00d51a021 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/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L25)
+[storage/FileSystem.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L38)
+[storage/FileSystem.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L38)
___
@@ -75,7 +75,7 @@ ___
#### Defined in
-[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L44)
+[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L44)
___
@@ -100,7 +100,7 @@ ___
#### Defined in
-[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L31)
+[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L31)
___
@@ -126,4 +126,4 @@ ___
#### Defined in
-[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L27)
+[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 720bd3322..cca94e3f3 100644
--- a/apps/docs/docs/api/classes/IndexDict.md
+++ b/apps/docs/docs/api/classes/IndexDict.md
@@ -33,7 +33,7 @@ The underlying structure of each index.
#### Defined in
-[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L17)
+[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L17)
## Properties
@@ -43,7 +43,7 @@ The underlying structure of each index.
#### Defined in
-[indices/BaseIndex.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L32)
+[indices/BaseIndex.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L32)
___
@@ -57,7 +57,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L14)
+[indices/BaseIndex.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L14)
___
@@ -67,7 +67,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L31)
+[indices/BaseIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L31)
___
@@ -81,7 +81,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L15)
+[indices/BaseIndex.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L15)
## Methods
@@ -102,7 +102,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L41)
+[indices/BaseIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L41)
___
@@ -120,4 +120,4 @@ ___
#### Defined in
-[indices/BaseIndex.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L34)
+[indices/BaseIndex.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L34)
diff --git a/apps/docs/docs/api/classes/IndexList.md b/apps/docs/docs/api/classes/IndexList.md
index 5f11cbf3f..475b16d82 100644
--- a/apps/docs/docs/api/classes/IndexList.md
+++ b/apps/docs/docs/api/classes/IndexList.md
@@ -33,7 +33,7 @@ The underlying structure of each index.
#### Defined in
-[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L17)
+[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L17)
## Properties
@@ -47,7 +47,7 @@ The underlying structure of each index.
#### Defined in
-[indices/BaseIndex.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L14)
+[indices/BaseIndex.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L14)
___
@@ -57,7 +57,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L48)
+[indices/BaseIndex.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L48)
___
@@ -71,7 +71,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L15)
+[indices/BaseIndex.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L15)
## Methods
@@ -91,7 +91,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L50)
+[indices/BaseIndex.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L50)
___
@@ -109,4 +109,4 @@ ___
#### Defined in
-[indices/BaseIndex.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L22)
+[indices/BaseIndex.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L22)
diff --git a/apps/docs/docs/api/classes/IndexNode.md b/apps/docs/docs/api/classes/IndexNode.md
index 8143a00df..8eb64b321 100644
--- a/apps/docs/docs/api/classes/IndexNode.md
+++ b/apps/docs/docs/api/classes/IndexNode.md
@@ -32,7 +32,7 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
#### Defined in
-[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L144)
+[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L144)
## Properties
@@ -46,7 +46,7 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
#### Defined in
-[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L39)
+[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L39)
___
@@ -60,7 +60,7 @@ ___
#### Defined in
-[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L139)
+[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L139)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
-[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L43)
+[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L43)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
-[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L44)
+[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L44)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
-[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L46)
+[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L46)
___
@@ -116,7 +116,7 @@ ___
#### Defined in
-[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L38)
+[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L38)
___
@@ -126,7 +126,7 @@ ___
#### Defined in
-[Node.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L205)
+[Node.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L205)
___
@@ -140,7 +140,7 @@ ___
#### Defined in
-[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L42)
+[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L42)
___
@@ -154,7 +154,7 @@ ___
#### Defined in
-[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L142)
+[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L142)
___
@@ -168,7 +168,7 @@ ___
#### Defined in
-[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L45)
+[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L45)
___
@@ -182,7 +182,7 @@ ___
#### Defined in
-[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L138)
+[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L138)
___
@@ -196,7 +196,7 @@ ___
#### Defined in
-[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L137)
+[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L137)
## Accessors
@@ -214,7 +214,7 @@ TextNode.childNodes
#### Defined in
-[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L104)
+[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L104)
___
@@ -232,7 +232,7 @@ TextNode.nextNode
#### Defined in
-[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L84)
+[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L84)
___
@@ -250,7 +250,7 @@ TextNode.nodeId
#### Defined in
-[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L58)
+[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L58)
___
@@ -268,7 +268,7 @@ TextNode.parentNode
#### Defined in
-[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L94)
+[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L94)
___
@@ -286,7 +286,7 @@ TextNode.prevNode
#### Defined in
-[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L72)
+[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L72)
___
@@ -304,7 +304,7 @@ TextNode.sourceNode
#### Defined in
-[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L62)
+[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L62)
## Methods
@@ -322,7 +322,7 @@ TextNode.sourceNode
#### Defined in
-[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L124)
+[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L124)
___
@@ -340,7 +340,7 @@ ___
#### Defined in
-[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L149)
+[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L149)
___
@@ -364,7 +364,7 @@ ___
#### Defined in
-[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L157)
+[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L157)
___
@@ -382,7 +382,7 @@ ___
#### Defined in
-[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L116)
+[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L116)
___
@@ -406,7 +406,7 @@ ___
#### Defined in
-[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L162)
+[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L162)
___
@@ -429,7 +429,7 @@ ___
#### Defined in
-[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L187)
+[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L187)
___
@@ -447,7 +447,7 @@ ___
#### Defined in
-[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L191)
+[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L191)
___
@@ -465,7 +465,7 @@ ___
#### Defined in
-[Node.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L207)
+[Node.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L207)
___
@@ -489,4 +489,4 @@ ___
#### Defined in
-[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L183)
+[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 83177a47a..407284a8c 100644
--- a/apps/docs/docs/api/classes/IndexStruct.md
+++ b/apps/docs/docs/api/classes/IndexStruct.md
@@ -31,7 +31,7 @@ The underlying structure of each index.
#### Defined in
-[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L17)
+[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L17)
## Properties
@@ -41,7 +41,7 @@ The underlying structure of each index.
#### Defined in
-[indices/BaseIndex.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L14)
+[indices/BaseIndex.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L14)
___
@@ -51,7 +51,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L15)
+[indices/BaseIndex.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L15)
## Methods
@@ -65,4 +65,4 @@ ___
#### Defined in
-[indices/BaseIndex.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L22)
+[indices/BaseIndex.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L22)
diff --git a/apps/docs/docs/api/classes/LLMQuestionGenerator.md b/apps/docs/docs/api/classes/LLMQuestionGenerator.md
index a72372067..98ea228a4 100644
--- a/apps/docs/docs/api/classes/LLMQuestionGenerator.md
+++ b/apps/docs/docs/api/classes/LLMQuestionGenerator.md
@@ -26,7 +26,7 @@ LLMQuestionGenerator uses the LLM to generate new questions for the LLM using to
#### Defined in
-[QuestionGenerator.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QuestionGenerator.ts#L34)
+[QuestionGenerator.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QuestionGenerator.ts#L34)
## Properties
@@ -36,7 +36,7 @@ LLMQuestionGenerator uses the LLM to generate new questions for the LLM using to
#### Defined in
-[QuestionGenerator.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QuestionGenerator.ts#L30)
+[QuestionGenerator.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QuestionGenerator.ts#L30)
___
@@ -46,7 +46,7 @@ ___
#### Defined in
-[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QuestionGenerator.ts#L32)
+[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QuestionGenerator.ts#L32)
___
@@ -56,7 +56,7 @@ ___
#### Defined in
-[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QuestionGenerator.ts#L31)
+[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QuestionGenerator.ts#L31)
## Methods
@@ -81,4 +81,4 @@ ___
#### Defined in
-[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QuestionGenerator.ts#L40)
+[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 e0dd719e7..36b28ca1d 100644
--- a/apps/docs/docs/api/classes/ListIndex.md
+++ b/apps/docs/docs/api/classes/ListIndex.md
@@ -32,7 +32,7 @@ A ListIndex keeps nodes in a sequential list structure
#### Defined in
-[indices/list/ListIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndex.ts#L41)
+[indices/list/ListIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L41)
## Properties
@@ -46,7 +46,7 @@ A ListIndex keeps nodes in a sequential list structure
#### Defined in
-[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L71)
+[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L71)
___
@@ -60,7 +60,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L73)
+[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L73)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L74)
+[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L74)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L69)
+[indices/BaseIndex.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L69)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L70)
+[indices/BaseIndex.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L70)
___
@@ -116,7 +116,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L72)
+[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L72)
## Methods
@@ -136,7 +136,7 @@ ___
#### Defined in
-[indices/list/ListIndex.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndex.ts#L156)
+[indices/list/ListIndex.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L156)
___
@@ -156,7 +156,7 @@ ___
#### Defined in
-[indices/list/ListIndex.ts:150](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndex.ts#L150)
+[indices/list/ListIndex.ts:150](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L150)
___
@@ -177,7 +177,7 @@ ___
#### Defined in
-[indices/list/ListIndex.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndex.ts#L118)
+[indices/list/ListIndex.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L118)
___
@@ -201,7 +201,7 @@ ___
#### Defined in
-[indices/list/ListIndex.ts:105](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndex.ts#L105)
+[indices/list/ListIndex.ts:105](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L105)
___
@@ -215,7 +215,7 @@ ___
#### Defined in
-[indices/list/ListIndex.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndex.ts#L162)
+[indices/list/ListIndex.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L162)
___
@@ -237,7 +237,7 @@ ___
#### Defined in
-[indices/list/ListIndex.ts:135](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndex.ts#L135)
+[indices/list/ListIndex.ts:135](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L135)
___
@@ -260,7 +260,7 @@ ___
#### Defined in
-[indices/list/ListIndex.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndex.ts#L81)
+[indices/list/ListIndex.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L81)
___
@@ -280,4 +280,4 @@ ___
#### Defined in
-[indices/list/ListIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndex.ts#L45)
+[indices/list/ListIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L45)
diff --git a/apps/docs/docs/api/classes/ListIndexLLMRetriever.md b/apps/docs/docs/api/classes/ListIndexLLMRetriever.md
index 3573cd806..2711d295d 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
-[indices/list/ListIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndexRetriever.ts#L64)
+[indices/list/ListIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L64)
## Properties
@@ -41,7 +41,7 @@ LLM retriever for ListIndex.
#### Defined in
-[indices/list/ListIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndexRetriever.ts#L59)
+[indices/list/ListIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L59)
___
@@ -51,7 +51,7 @@ ___
#### Defined in
-[indices/list/ListIndexRetriever.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndexRetriever.ts#L58)
+[indices/list/ListIndexRetriever.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L58)
___
@@ -61,7 +61,7 @@ ___
#### Defined in
-[indices/list/ListIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndexRetriever.ts#L60)
+[indices/list/ListIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L60)
___
@@ -71,7 +71,7 @@ ___
#### Defined in
-[indices/list/ListIndexRetriever.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndexRetriever.ts#L57)
+[indices/list/ListIndexRetriever.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L57)
___
@@ -81,7 +81,7 @@ ___
#### Defined in
-[indices/list/ListIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndexRetriever.ts#L61)
+[indices/list/ListIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L61)
___
@@ -91,7 +91,7 @@ ___
#### Defined in
-[indices/list/ListIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndexRetriever.ts#L62)
+[indices/list/ListIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L62)
## Methods
@@ -109,7 +109,7 @@ ___
#### Defined in
-[indices/list/ListIndexRetriever.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndexRetriever.ts#L127)
+[indices/list/ListIndexRetriever.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L127)
___
@@ -134,4 +134,4 @@ ___
#### Defined in
-[indices/list/ListIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndexRetriever.ts#L81)
+[indices/list/ListIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L81)
diff --git a/apps/docs/docs/api/classes/ListIndexRetriever.md b/apps/docs/docs/api/classes/ListIndexRetriever.md
index e29080a5f..e35e9954e 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
-[indices/list/ListIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndexRetriever.ts#L22)
+[indices/list/ListIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L22)
## Properties
@@ -36,7 +36,7 @@ Simple retriever for ListIndex that returns all nodes
#### Defined in
-[indices/list/ListIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndexRetriever.ts#L20)
+[indices/list/ListIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L20)
## Methods
@@ -54,7 +54,7 @@ Simple retriever for ListIndex that returns all nodes
#### Defined in
-[indices/list/ListIndexRetriever.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndexRetriever.ts#L48)
+[indices/list/ListIndexRetriever.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L48)
___
@@ -79,4 +79,4 @@ ___
#### Defined in
-[indices/list/ListIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndexRetriever.ts#L26)
+[indices/list/ListIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L26)
diff --git a/apps/docs/docs/api/classes/LlamaDeuce.md b/apps/docs/docs/api/classes/LlamaDeuce.md
index 87739d135..e1c4c8495 100644
--- a/apps/docs/docs/api/classes/LlamaDeuce.md
+++ b/apps/docs/docs/api/classes/LlamaDeuce.md
@@ -26,7 +26,7 @@ Llama2 LLM implementation
#### Defined in
-[llm/LLM.ts:179](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L179)
+[llm/LLM.ts:179](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L179)
## Properties
@@ -36,7 +36,7 @@ Llama2 LLM implementation
#### Defined in
-[llm/LLM.ts:176](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L176)
+[llm/LLM.ts:176](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L176)
___
@@ -46,7 +46,7 @@ ___
#### Defined in
-[llm/LLM.ts:174](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L174)
+[llm/LLM.ts:174](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L174)
___
@@ -56,7 +56,7 @@ ___
#### Defined in
-[llm/LLM.ts:177](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L177)
+[llm/LLM.ts:177](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L177)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
-[llm/LLM.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L175)
+[llm/LLM.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L175)
## Methods
@@ -93,7 +93,7 @@ Get a chat response from the LLM
#### Defined in
-[llm/LLM.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L199)
+[llm/LLM.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L199)
___
@@ -120,7 +120,7 @@ Get a prompt completion from the LLM
#### Defined in
-[llm/LLM.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L224)
+[llm/LLM.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L224)
___
@@ -140,4 +140,4 @@ ___
#### Defined in
-[llm/LLM.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L186)
+[llm/LLM.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L186)
diff --git a/apps/docs/docs/api/classes/OpenAI.md b/apps/docs/docs/api/classes/OpenAI.md
index f4e4c1207..f54abe67b 100644
--- a/apps/docs/docs/api/classes/OpenAI.md
+++ b/apps/docs/docs/api/classes/OpenAI.md
@@ -26,7 +26,7 @@ OpenAI LLM implementation
#### Defined in
-[llm/LLM.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L75)
+[llm/LLM.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L75)
## Properties
@@ -36,7 +36,7 @@ OpenAI LLM implementation
#### Defined in
-[llm/LLM.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L73)
+[llm/LLM.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L73)
___
@@ -46,7 +46,7 @@ ___
#### Defined in
-[llm/LLM.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L71)
+[llm/LLM.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L71)
___
@@ -56,7 +56,7 @@ ___
#### Defined in
-[llm/LLM.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L69)
+[llm/LLM.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L69)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
-[llm/LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L66)
+[llm/LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L66)
___
@@ -76,7 +76,7 @@ ___
#### Defined in
-[llm/LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L68)
+[llm/LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L68)
___
@@ -86,7 +86,7 @@ ___
#### Defined in
-[llm/LLM.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L72)
+[llm/LLM.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L72)
___
@@ -96,7 +96,7 @@ ___
#### Defined in
-[llm/LLM.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L70)
+[llm/LLM.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L70)
___
@@ -106,7 +106,7 @@ ___
#### Defined in
-[llm/LLM.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L67)
+[llm/LLM.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L67)
## Methods
@@ -133,7 +133,7 @@ Get a chat response from the LLM
#### Defined in
-[llm/LLM.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L102)
+[llm/LLM.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L102)
___
@@ -160,7 +160,7 @@ Get a prompt completion from the LLM
#### Defined in
-[llm/LLM.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L144)
+[llm/LLM.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L144)
___
@@ -180,4 +180,4 @@ ___
#### Defined in
-[llm/LLM.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L85)
+[llm/LLM.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L85)
diff --git a/apps/docs/docs/api/classes/OpenAIEmbedding.md b/apps/docs/docs/api/classes/OpenAIEmbedding.md
index f9cf56000..5f888dcbe 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:217](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L217)
+[Embedding.ts:217](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L217)
## Properties
@@ -34,7 +34,7 @@ custom_edit_url: null
#### Defined in
-[Embedding.ts:215](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L215)
+[Embedding.ts:215](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L215)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
-[Embedding.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L214)
+[Embedding.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L214)
## Methods
@@ -64,7 +64,7 @@ ___
#### Defined in
-[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L224)
+[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L224)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
-[Embedding.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L240)
+[Embedding.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L240)
___
@@ -112,7 +112,7 @@ ___
#### Defined in
-[Embedding.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L236)
+[Embedding.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L236)
___
@@ -138,4 +138,4 @@ ___
#### Defined in
-[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L197)
+[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L197)
diff --git a/apps/docs/docs/api/classes/PDFReader.md b/apps/docs/docs/api/classes/PDFReader.md
index 7f7e66f5a..1a356ea6a 100644
--- a/apps/docs/docs/api/classes/PDFReader.md
+++ b/apps/docs/docs/api/classes/PDFReader.md
@@ -41,4 +41,4 @@ Read the text of a PDF
#### Defined in
-[readers/PDFReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/readers/PDFReader.ts#L12)
+[readers/PDFReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/readers/PDFReader.ts#L12)
diff --git a/apps/docs/docs/api/classes/Refine.md b/apps/docs/docs/api/classes/Refine.md
index 7dd16d652..998ecf778 100644
--- a/apps/docs/docs/api/classes/Refine.md
+++ b/apps/docs/docs/api/classes/Refine.md
@@ -34,7 +34,7 @@ A response builder that uses the query to ask the LLM generate a better response
#### Defined in
-[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L78)
+[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L78)
## Properties
@@ -44,7 +44,7 @@ A response builder that uses the query to ask the LLM generate a better response
#### Defined in
-[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L76)
+[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L76)
___
@@ -54,7 +54,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L74)
+[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L74)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L75)
+[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L75)
## Methods
@@ -91,7 +91,7 @@ BaseResponseBuilder.getResponse
#### Defined in
-[ResponseSynthesizer.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L88)
+[ResponseSynthesizer.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L88)
___
@@ -113,7 +113,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L113)
+[ResponseSynthesizer.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L113)
___
@@ -136,4 +136,4 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L149)
+[ResponseSynthesizer.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L149)
diff --git a/apps/docs/docs/api/classes/Response.md b/apps/docs/docs/api/classes/Response.md
index 07d45d3d8..f00b21c41 100644
--- a/apps/docs/docs/api/classes/Response.md
+++ b/apps/docs/docs/api/classes/Response.md
@@ -23,7 +23,7 @@ Respone is the output of a LLM
#### Defined in
-[Response.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Response.ts#L10)
+[Response.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Response.ts#L10)
## Properties
@@ -33,7 +33,7 @@ Respone is the output of a LLM
#### Defined in
-[Response.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Response.ts#L7)
+[Response.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Response.ts#L7)
___
@@ -43,7 +43,7 @@ ___
#### Defined in
-[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Response.ts#L8)
+[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Response.ts#L8)
## Methods
@@ -57,7 +57,7 @@ ___
#### Defined in
-[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Response.ts#L15)
+[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Response.ts#L15)
___
@@ -71,4 +71,4 @@ ___
#### Defined in
-[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Response.ts#L19)
+[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 06370fe6d..0b4660c41 100644
--- a/apps/docs/docs/api/classes/ResponseSynthesizer.md
+++ b/apps/docs/docs/api/classes/ResponseSynthesizer.md
@@ -24,7 +24,7 @@ A ResponseSynthesizer is used to generate a response from a query and a list of
#### Defined in
-[ResponseSynthesizer.ts:285](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L285)
+[ResponseSynthesizer.ts:285](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L285)
## Properties
@@ -34,7 +34,7 @@ A ResponseSynthesizer is used to generate a response from a query and a list of
#### Defined in
-[ResponseSynthesizer.ts:282](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L282)
+[ResponseSynthesizer.ts:282](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L282)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:283](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L283)
+[ResponseSynthesizer.ts:283](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L283)
## Methods
@@ -66,4 +66,4 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L297)
+[ResponseSynthesizer.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L297)
diff --git a/apps/docs/docs/api/classes/RetrieverQueryEngine.md b/apps/docs/docs/api/classes/RetrieverQueryEngine.md
index 1a2c8c1b3..0247d102a 100644
--- a/apps/docs/docs/api/classes/RetrieverQueryEngine.md
+++ b/apps/docs/docs/api/classes/RetrieverQueryEngine.md
@@ -27,7 +27,7 @@ A query engine that uses a retriever to query an index and then synthesizes the
#### Defined in
-[QueryEngine.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QueryEngine.ts#L34)
+[QueryEngine.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L34)
## Properties
@@ -37,7 +37,7 @@ A query engine that uses a retriever to query an index and then synthesizes the
#### Defined in
-[QueryEngine.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QueryEngine.ts#L32)
+[QueryEngine.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L32)
___
@@ -47,7 +47,7 @@ ___
#### Defined in
-[QueryEngine.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QueryEngine.ts#L31)
+[QueryEngine.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L31)
## Methods
@@ -74,4 +74,4 @@ Query the query engine and get a response.
#### Defined in
-[QueryEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QueryEngine.ts#L45)
+[QueryEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L45)
diff --git a/apps/docs/docs/api/classes/SentenceSplitter.md b/apps/docs/docs/api/classes/SentenceSplitter.md
index b914cc67e..d97aa6838 100644
--- a/apps/docs/docs/api/classes/SentenceSplitter.md
+++ b/apps/docs/docs/api/classes/SentenceSplitter.md
@@ -27,7 +27,7 @@ SentenceSplitter is our default text splitter that supports splitting into sente
#### Defined in
-[TextSplitter.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/TextSplitter.ts#L33)
+[TextSplitter.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L33)
## Properties
@@ -37,7 +37,7 @@ SentenceSplitter is our default text splitter that supports splitting into sente
#### Defined in
-[TextSplitter.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/TextSplitter.ts#L26)
+[TextSplitter.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L26)
___
@@ -47,7 +47,7 @@ ___
#### Defined in
-[TextSplitter.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/TextSplitter.ts#L25)
+[TextSplitter.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L25)
___
@@ -57,7 +57,7 @@ ___
#### Defined in
-[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/TextSplitter.ts#L30)
+[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L30)
___
@@ -67,7 +67,7 @@ ___
#### Defined in
-[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/TextSplitter.ts#L29)
+[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L29)
___
@@ -77,7 +77,7 @@ ___
#### Defined in
-[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/TextSplitter.ts#L27)
+[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L27)
___
@@ -87,7 +87,7 @@ ___
#### Defined in
-[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/TextSplitter.ts#L28)
+[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L28)
## Methods
@@ -108,7 +108,7 @@ ___
#### Defined in
-[TextSplitter.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/TextSplitter.ts#L153)
+[TextSplitter.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L153)
___
@@ -128,7 +128,7 @@ ___
#### Defined in
-[TextSplitter.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/TextSplitter.ts#L72)
+[TextSplitter.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L72)
___
@@ -149,7 +149,7 @@ ___
#### Defined in
-[TextSplitter.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/TextSplitter.ts#L89)
+[TextSplitter.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L89)
___
@@ -170,7 +170,7 @@ ___
#### Defined in
-[TextSplitter.ts:115](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/TextSplitter.ts#L115)
+[TextSplitter.ts:115](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L115)
___
@@ -191,7 +191,7 @@ ___
#### Defined in
-[TextSplitter.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/TextSplitter.ts#L128)
+[TextSplitter.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L128)
___
@@ -212,7 +212,7 @@ ___
#### Defined in
-[TextSplitter.ts:233](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/TextSplitter.ts#L233)
+[TextSplitter.ts:233](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L233)
___
@@ -233,4 +233,4 @@ ___
#### Defined in
-[TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/TextSplitter.ts#L205)
+[TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 341a008c9..4f6eccd7a 100644
--- a/apps/docs/docs/api/classes/SimpleChatEngine.md
+++ b/apps/docs/docs/api/classes/SimpleChatEngine.md
@@ -26,7 +26,7 @@ SimpleChatEngine is the simplest possible chat engine. Useful for using your own
#### Defined in
-[ChatEngine.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L40)
+[ChatEngine.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L40)
## Properties
@@ -36,7 +36,7 @@ SimpleChatEngine is the simplest possible chat engine. Useful for using your own
#### Defined in
-[ChatEngine.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L37)
+[ChatEngine.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L37)
___
@@ -46,7 +46,7 @@ ___
#### Defined in
-[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L38)
+[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L38)
## Methods
@@ -73,7 +73,7 @@ Send message along with the class's current chat history to the LLM.
#### Defined in
-[ChatEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L45)
+[ChatEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L45)
___
@@ -93,4 +93,4 @@ Resets the chat history so that it's empty.
#### Defined in
-[ChatEngine.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L54)
+[ChatEngine.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L54)
diff --git a/apps/docs/docs/api/classes/SimpleDirectoryReader.md b/apps/docs/docs/api/classes/SimpleDirectoryReader.md
index fd88808cb..8d9a9e148 100644
--- a/apps/docs/docs/api/classes/SimpleDirectoryReader.md
+++ b/apps/docs/docs/api/classes/SimpleDirectoryReader.md
@@ -40,4 +40,4 @@ Read all of the documents in a directory. Currently supports PDF and TXT files.
#### Defined in
-[readers/SimpleDirectoryReader.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/readers/SimpleDirectoryReader.ts#L37)
+[readers/SimpleDirectoryReader.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/readers/SimpleDirectoryReader.ts#L37)
diff --git a/apps/docs/docs/api/classes/SimpleNodeParser.md b/apps/docs/docs/api/classes/SimpleNodeParser.md
index bd96ec020..602a01386 100644
--- a/apps/docs/docs/api/classes/SimpleNodeParser.md
+++ b/apps/docs/docs/api/classes/SimpleNodeParser.md
@@ -31,7 +31,7 @@ SimpleNodeParser is the default NodeParser. It splits documents into TextNodes u
#### Defined in
-[NodeParser.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/NodeParser.ts#L64)
+[NodeParser.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/NodeParser.ts#L64)
## Properties
@@ -41,7 +41,7 @@ SimpleNodeParser is the default NodeParser. It splits documents into TextNodes u
#### Defined in
-[NodeParser.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/NodeParser.ts#L61)
+[NodeParser.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/NodeParser.ts#L61)
___
@@ -51,7 +51,7 @@ ___
#### Defined in
-[NodeParser.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/NodeParser.ts#L62)
+[NodeParser.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/NodeParser.ts#L62)
___
@@ -61,7 +61,7 @@ ___
#### Defined in
-[NodeParser.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/NodeParser.ts#L60)
+[NodeParser.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/NodeParser.ts#L60)
## Methods
@@ -87,7 +87,7 @@ Generate Node objects from documents
#### Defined in
-[NodeParser.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/NodeParser.ts#L95)
+[NodeParser.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/NodeParser.ts#L95)
___
@@ -111,4 +111,4 @@ ___
#### Defined in
-[NodeParser.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/NodeParser.ts#L82)
+[NodeParser.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 fd106cc74..5ea93f5d6 100644
--- a/apps/docs/docs/api/classes/SimpleResponseBuilder.md
+++ b/apps/docs/docs/api/classes/SimpleResponseBuilder.md
@@ -26,7 +26,7 @@ A response builder that just concatenates responses.
#### Defined in
-[ResponseSynthesizer.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L49)
+[ResponseSynthesizer.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L49)
## Properties
@@ -36,7 +36,7 @@ A response builder that just concatenates responses.
#### Defined in
-[ResponseSynthesizer.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L46)
+[ResponseSynthesizer.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L46)
___
@@ -46,7 +46,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L47)
+[ResponseSynthesizer.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L47)
## Methods
@@ -72,4 +72,4 @@ BaseResponseBuilder.getResponse
#### Defined in
-[ResponseSynthesizer.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L54)
+[ResponseSynthesizer.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L54)
diff --git a/apps/docs/docs/api/classes/SubQuestionOutputParser.md b/apps/docs/docs/api/classes/SubQuestionOutputParser.md
index 2b41a5cee..de7899287 100644
--- a/apps/docs/docs/api/classes/SubQuestionOutputParser.md
+++ b/apps/docs/docs/api/classes/SubQuestionOutputParser.md
@@ -40,7 +40,7 @@ SubQuestionOutputParser is used to parse the output of the SubQuestionGenerator.
#### Defined in
-[OutputParser.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/OutputParser.ts#L97)
+[OutputParser.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/OutputParser.ts#L97)
___
@@ -64,4 +64,4 @@ ___
#### Defined in
-[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/OutputParser.ts#L89)
+[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/OutputParser.ts#L89)
diff --git a/apps/docs/docs/api/classes/SubQuestionQueryEngine.md b/apps/docs/docs/api/classes/SubQuestionQueryEngine.md
index 3ef7d1a0e..32e55ac9d 100644
--- a/apps/docs/docs/api/classes/SubQuestionQueryEngine.md
+++ b/apps/docs/docs/api/classes/SubQuestionQueryEngine.md
@@ -29,7 +29,7 @@ SubQuestionQueryEngine decomposes a question into subquestions and then
#### Defined in
-[QueryEngine.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QueryEngine.ts#L65)
+[QueryEngine.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L65)
## Properties
@@ -39,7 +39,7 @@ SubQuestionQueryEngine decomposes a question into subquestions and then
#### Defined in
-[QueryEngine.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QueryEngine.ts#L63)
+[QueryEngine.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L63)
___
@@ -49,7 +49,7 @@ ___
#### Defined in
-[QueryEngine.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QueryEngine.ts#L62)
+[QueryEngine.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L62)
___
@@ -59,7 +59,7 @@ ___
#### Defined in
-[QueryEngine.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QueryEngine.ts#L61)
+[QueryEngine.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L61)
___
@@ -69,7 +69,7 @@ ___
#### Defined in
-[QueryEngine.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QueryEngine.ts#L60)
+[QueryEngine.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L60)
## Methods
@@ -95,7 +95,7 @@ Query the query engine and get a response.
#### Defined in
-[QueryEngine.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QueryEngine.ts#L106)
+[QueryEngine.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L106)
___
@@ -116,7 +116,7 @@ ___
#### Defined in
-[QueryEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QueryEngine.ts#L134)
+[QueryEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L134)
___
@@ -140,4 +140,4 @@ ___
#### Defined in
-[QueryEngine.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QueryEngine.ts#L82)
+[QueryEngine.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L82)
diff --git a/apps/docs/docs/api/classes/TextFileReader.md b/apps/docs/docs/api/classes/TextFileReader.md
index 99f001878..edd2dc7a2 100644
--- a/apps/docs/docs/api/classes/TextFileReader.md
+++ b/apps/docs/docs/api/classes/TextFileReader.md
@@ -41,4 +41,4 @@ Read a .txt file
#### Defined in
-[readers/SimpleDirectoryReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/readers/SimpleDirectoryReader.ts#L12)
+[readers/SimpleDirectoryReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 33ccd4b3e..82ec187c8 100644
--- a/apps/docs/docs/api/classes/TextNode.md
+++ b/apps/docs/docs/api/classes/TextNode.md
@@ -36,7 +36,7 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
#### Defined in
-[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L144)
+[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L144)
## Properties
@@ -50,7 +50,7 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
#### Defined in
-[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L39)
+[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L39)
___
@@ -60,7 +60,7 @@ ___
#### Defined in
-[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L139)
+[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L139)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
-[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L43)
+[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L43)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
-[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L44)
+[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L44)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
-[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L46)
+[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L46)
___
@@ -116,7 +116,7 @@ ___
#### Defined in
-[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L38)
+[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L38)
___
@@ -130,7 +130,7 @@ ___
#### Defined in
-[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L42)
+[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L42)
___
@@ -140,7 +140,7 @@ ___
#### Defined in
-[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L142)
+[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L142)
___
@@ -154,7 +154,7 @@ ___
#### Defined in
-[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L45)
+[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L45)
___
@@ -164,7 +164,7 @@ ___
#### Defined in
-[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L138)
+[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L138)
___
@@ -174,7 +174,7 @@ ___
#### Defined in
-[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L137)
+[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L137)
## Accessors
@@ -192,7 +192,7 @@ BaseNode.childNodes
#### Defined in
-[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L104)
+[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L104)
___
@@ -210,7 +210,7 @@ BaseNode.nextNode
#### Defined in
-[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L84)
+[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L84)
___
@@ -228,7 +228,7 @@ BaseNode.nodeId
#### Defined in
-[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L58)
+[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L58)
___
@@ -246,7 +246,7 @@ BaseNode.parentNode
#### Defined in
-[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L94)
+[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L94)
___
@@ -264,7 +264,7 @@ BaseNode.prevNode
#### Defined in
-[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L72)
+[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L72)
___
@@ -282,7 +282,7 @@ BaseNode.sourceNode
#### Defined in
-[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L62)
+[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L62)
## Methods
@@ -300,7 +300,7 @@ BaseNode.sourceNode
#### Defined in
-[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L124)
+[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L124)
___
@@ -314,7 +314,7 @@ ___
#### Defined in
-[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L149)
+[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L149)
___
@@ -338,7 +338,7 @@ ___
#### Defined in
-[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L157)
+[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L157)
___
@@ -356,7 +356,7 @@ ___
#### Defined in
-[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L116)
+[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L116)
___
@@ -380,7 +380,7 @@ ___
#### Defined in
-[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L162)
+[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L162)
___
@@ -399,7 +399,7 @@ ___
#### Defined in
-[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L187)
+[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L187)
___
@@ -413,7 +413,7 @@ ___
#### Defined in
-[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L191)
+[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L191)
___
@@ -431,7 +431,7 @@ ___
#### Defined in
-[Node.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L153)
+[Node.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L153)
___
@@ -455,4 +455,4 @@ ___
#### Defined in
-[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L183)
+[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 5b0aaa2b5..3cd12138c 100644
--- a/apps/docs/docs/api/classes/TreeSummarize.md
+++ b/apps/docs/docs/api/classes/TreeSummarize.md
@@ -26,7 +26,7 @@ TreeSummarize repacks the text chunks into the smallest possible number of chunk
#### Defined in
-[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L212)
+[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L212)
## Properties
@@ -36,7 +36,7 @@ TreeSummarize repacks the text chunks into the smallest possible number of chunk
#### Defined in
-[ResponseSynthesizer.ts:210](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L210)
+[ResponseSynthesizer.ts:210](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L210)
## Methods
@@ -62,4 +62,4 @@ BaseResponseBuilder.getResponse
#### Defined in
-[ResponseSynthesizer.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L216)
+[ResponseSynthesizer.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L216)
diff --git a/apps/docs/docs/api/classes/VectorIndexRetriever.md b/apps/docs/docs/api/classes/VectorIndexRetriever.md
index f680bc748..20a56d02e 100644
--- a/apps/docs/docs/api/classes/VectorIndexRetriever.md
+++ b/apps/docs/docs/api/classes/VectorIndexRetriever.md
@@ -26,7 +26,7 @@ VectorIndexRetriever retrieves nodes from a VectorIndex.
#### Defined in
-[indices/vectorStore/VectorIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L22)
+[indices/vectorStore/VectorIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L22)
## Properties
@@ -36,7 +36,7 @@ VectorIndexRetriever retrieves nodes from a VectorIndex.
#### Defined in
-[indices/vectorStore/VectorIndexRetriever.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L18)
+[indices/vectorStore/VectorIndexRetriever.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L18)
___
@@ -46,7 +46,7 @@ ___
#### Defined in
-[indices/vectorStore/VectorIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L20)
+[indices/vectorStore/VectorIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L20)
___
@@ -56,7 +56,7 @@ ___
#### Defined in
-[indices/vectorStore/VectorIndexRetriever.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L19)
+[indices/vectorStore/VectorIndexRetriever.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L19)
## Methods
@@ -74,7 +74,7 @@ ___
#### Defined in
-[indices/vectorStore/VectorIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L61)
+[indices/vectorStore/VectorIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L61)
___
@@ -99,4 +99,4 @@ ___
#### Defined in
-[indices/vectorStore/VectorIndexRetriever.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L27)
+[indices/vectorStore/VectorIndexRetriever.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L27)
diff --git a/apps/docs/docs/api/classes/VectorStoreIndex.md b/apps/docs/docs/api/classes/VectorStoreIndex.md
index 14c5b5b44..87ed38aa9 100644
--- a/apps/docs/docs/api/classes/VectorStoreIndex.md
+++ b/apps/docs/docs/api/classes/VectorStoreIndex.md
@@ -32,7 +32,7 @@ The VectorStoreIndex, an index that stores the nodes only according to their vec
#### Defined in
-[indices/vectorStore/VectorStoreIndex.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L32)
+[indices/vectorStore/VectorStoreIndex.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L32)
## Properties
@@ -46,7 +46,7 @@ The VectorStoreIndex, an index that stores the nodes only according to their vec
#### Defined in
-[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L71)
+[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L71)
___
@@ -60,7 +60,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L73)
+[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L73)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L74)
+[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L74)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L69)
+[indices/BaseIndex.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L69)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L70)
+[indices/BaseIndex.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L70)
___
@@ -116,7 +116,7 @@ ___
#### Defined in
-[indices/vectorStore/VectorStoreIndex.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L30)
+[indices/vectorStore/VectorStoreIndex.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L30)
## Methods
@@ -134,7 +134,7 @@ NOTE: if you are using a custom query engine you don't have to use this method.
#### Defined in
-[indices/vectorStore/VectorStoreIndex.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L175)
+[indices/vectorStore/VectorStoreIndex.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L175)
___
@@ -158,7 +158,7 @@ retriever for the index
#### Defined in
-[indices/vectorStore/VectorStoreIndex.ts:165](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L165)
+[indices/vectorStore/VectorStoreIndex.ts:165](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L165)
___
@@ -182,7 +182,7 @@ Get embeddings for nodes and place them into the index.
#### Defined in
-[indices/vectorStore/VectorStoreIndex.ts:110](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L110)
+[indices/vectorStore/VectorStoreIndex.ts:110](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L110)
___
@@ -206,7 +206,7 @@ High level API: split documents, get embeddings, and build index.
#### Defined in
-[indices/vectorStore/VectorStoreIndex.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L137)
+[indices/vectorStore/VectorStoreIndex.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L137)
___
@@ -230,7 +230,7 @@ Get the embeddings for nodes.
#### Defined in
-[indices/vectorStore/VectorStoreIndex.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L82)
+[indices/vectorStore/VectorStoreIndex.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L82)
___
@@ -250,4 +250,4 @@ ___
#### Defined in
-[indices/vectorStore/VectorStoreIndex.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L37)
+[indices/vectorStore/VectorStoreIndex.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L37)
diff --git a/apps/docs/docs/api/enums/ListRetrieverMode.md b/apps/docs/docs/api/enums/ListRetrieverMode.md
index da3d7ecf1..94e6db224 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
-[indices/list/ListIndex.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndex.ts#L25)
+[indices/list/ListIndex.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L25)
___
@@ -24,4 +24,4 @@ ___
#### Defined in
-[indices/list/ListIndex.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/list/ListIndex.ts#L27)
+[indices/list/ListIndex.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L27)
diff --git a/apps/docs/docs/api/enums/MetadataMode.md b/apps/docs/docs/api/enums/MetadataMode.md
index acc89475b..b2ca339fb 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/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L19)
+[Node.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L19)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L20)
+[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L20)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L21)
+[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L21)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
-[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L22)
+[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 4900cf493..231e39f39 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/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L8)
+[Node.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L8)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L6)
+[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L6)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L7)
+[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L7)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
-[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L5)
+[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L5)
___
@@ -54,4 +54,4 @@ ___
#### Defined in
-[Node.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L4)
+[Node.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 77601e690..3f8ec10b8 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/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L15)
+[Node.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L15)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L13)
+[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L13)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L14)
+[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L14)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
-[Node.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L12)
+[Node.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 fba051252..13831dca5 100644
--- a/apps/docs/docs/api/enums/SimilarityType.md
+++ b/apps/docs/docs/api/enums/SimilarityType.md
@@ -17,7 +17,7 @@ Default is cosine similarity. Dot product and negative Euclidean distance are al
#### Defined in
-[Embedding.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L10)
+[Embedding.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L10)
___
@@ -27,7 +27,7 @@ ___
#### Defined in
-[Embedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L11)
+[Embedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L11)
___
@@ -37,4 +37,4 @@ ___
#### Defined in
-[Embedding.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L12)
+[Embedding.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 71e32445c..8c1e40932 100644
--- a/apps/docs/docs/api/interfaces/BaseIndexInit.md
+++ b/apps/docs/docs/api/interfaces/BaseIndexInit.md
@@ -26,7 +26,7 @@ custom_edit_url: null
#### Defined in
-[indices/BaseIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L58)
+[indices/BaseIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L58)
___
@@ -36,7 +36,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L60)
+[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L60)
___
@@ -46,7 +46,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L61)
+[indices/BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L61)
___
@@ -56,7 +56,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L56)
+[indices/BaseIndex.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L56)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L57)
+[indices/BaseIndex.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L57)
___
@@ -76,4 +76,4 @@ ___
#### Defined in
-[indices/BaseIndex.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L59)
+[indices/BaseIndex.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L59)
diff --git a/apps/docs/docs/api/interfaces/BaseOutputParser.md b/apps/docs/docs/api/interfaces/BaseOutputParser.md
index 5a0aadec7..d152eb365 100644
--- a/apps/docs/docs/api/interfaces/BaseOutputParser.md
+++ b/apps/docs/docs/api/interfaces/BaseOutputParser.md
@@ -36,7 +36,7 @@ An OutputParser is used to extract structured data from the raw output of the LL
#### Defined in
-[OutputParser.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/OutputParser.ts#L8)
+[OutputParser.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/OutputParser.ts#L8)
___
@@ -56,4 +56,4 @@ ___
#### Defined in
-[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/OutputParser.ts#L7)
+[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/OutputParser.ts#L7)
diff --git a/apps/docs/docs/api/interfaces/BaseQueryEngine.md b/apps/docs/docs/api/interfaces/BaseQueryEngine.md
index 31a8358b2..412eb8886 100644
--- a/apps/docs/docs/api/interfaces/BaseQueryEngine.md
+++ b/apps/docs/docs/api/interfaces/BaseQueryEngine.md
@@ -34,4 +34,4 @@ Query the query engine and get a response.
#### Defined in
-[QueryEngine.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QueryEngine.ts#L24)
+[QueryEngine.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L24)
diff --git a/apps/docs/docs/api/interfaces/BaseQuestionGenerator.md b/apps/docs/docs/api/interfaces/BaseQuestionGenerator.md
index 81a3a3760..551007cf5 100644
--- a/apps/docs/docs/api/interfaces/BaseQuestionGenerator.md
+++ b/apps/docs/docs/api/interfaces/BaseQuestionGenerator.md
@@ -31,4 +31,4 @@ QuestionGenerators generate new questions for the LLM using tools and a user que
#### Defined in
-[QuestionGenerator.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QuestionGenerator.ts#L23)
+[QuestionGenerator.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 02828b20a..95883f128 100644
--- a/apps/docs/docs/api/interfaces/BaseReader.md
+++ b/apps/docs/docs/api/interfaces/BaseReader.md
@@ -32,4 +32,4 @@ A reader takes imports data into Document objects.
#### Defined in
-[readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/readers/base.ts#L7)
+[readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 9464a89c9..a8648bb34 100644
--- a/apps/docs/docs/api/interfaces/BaseRetriever.md
+++ b/apps/docs/docs/api/interfaces/BaseRetriever.md
@@ -26,7 +26,7 @@ Retrievers retrieve the nodes that most closely match our query in similarity.
#### Defined in
-[Retriever.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Retriever.ts#L10)
+[Retriever.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Retriever.ts#L10)
___
@@ -47,4 +47,4 @@ ___
#### Defined in
-[Retriever.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Retriever.ts#L9)
+[Retriever.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Retriever.ts#L9)
diff --git a/apps/docs/docs/api/interfaces/BaseTool.md b/apps/docs/docs/api/interfaces/BaseTool.md
index ebdd67ea5..f2478e336 100644
--- a/apps/docs/docs/api/interfaces/BaseTool.md
+++ b/apps/docs/docs/api/interfaces/BaseTool.md
@@ -22,4 +22,4 @@ Simple Tool interface. Likely to change.
#### Defined in
-[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Tool.ts#L12)
+[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Tool.ts#L12)
diff --git a/apps/docs/docs/api/interfaces/ChatEngine.md b/apps/docs/docs/api/interfaces/ChatEngine.md
index f1d3797b7..d5957a238 100644
--- a/apps/docs/docs/api/interfaces/ChatEngine.md
+++ b/apps/docs/docs/api/interfaces/ChatEngine.md
@@ -35,7 +35,7 @@ Send message along with the class's current chat history to the LLM.
#### Defined in
-[ChatEngine.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L25)
+[ChatEngine.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L25)
___
@@ -51,4 +51,4 @@ Resets the chat history so that it's empty.
#### Defined in
-[ChatEngine.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ChatEngine.ts#L30)
+[ChatEngine.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L30)
diff --git a/apps/docs/docs/api/interfaces/ChatMessage.md b/apps/docs/docs/api/interfaces/ChatMessage.md
index 3bfe87d51..edca7bbc5 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/LLM.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L14)
+[llm/LLM.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L14)
___
@@ -24,4 +24,4 @@ ___
#### Defined in
-[llm/LLM.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L15)
+[llm/LLM.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L15)
diff --git a/apps/docs/docs/api/interfaces/ChatResponse.md b/apps/docs/docs/api/interfaces/ChatResponse.md
index 16f084737..5b6f4e7a2 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/LLM.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L21)
+[llm/LLM.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L21)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[llm/LLM.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L19)
+[llm/LLM.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L19)
___
@@ -34,4 +34,4 @@ ___
#### Defined in
-[llm/LLM.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L20)
+[llm/LLM.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L20)
diff --git a/apps/docs/docs/api/interfaces/Event.md b/apps/docs/docs/api/interfaces/Event.md
index 7492ae5b9..58ac06c44 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/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L14)
+[callbacks/CallbackManager.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L14)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L17)
+[callbacks/CallbackManager.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L17)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L16)
+[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L16)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L15)
+[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 6305606f8..9bab00e72 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/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L12)
+[storage/FileSystem.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L12)
___
@@ -54,7 +54,7 @@ ___
#### Defined in
-[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L13)
+[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L13)
___
@@ -75,7 +75,7 @@ ___
#### Defined in
-[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L11)
+[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L11)
___
@@ -97,4 +97,4 @@ ___
#### Defined in
-[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L10)
+[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 a0579889b..d988fea09 100644
--- a/apps/docs/docs/api/interfaces/LLM.md
+++ b/apps/docs/docs/api/interfaces/LLM.md
@@ -34,7 +34,7 @@ Get a chat response from the LLM
#### Defined in
-[llm/LLM.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L35)
+[llm/LLM.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L35)
___
@@ -57,4 +57,4 @@ Get a prompt completion from the LLM
#### Defined in
-[llm/LLM.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L41)
+[llm/LLM.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L41)
diff --git a/apps/docs/docs/api/interfaces/NodeParser.md b/apps/docs/docs/api/interfaces/NodeParser.md
index f766c4d9c..2a501f613 100644
--- a/apps/docs/docs/api/interfaces/NodeParser.md
+++ b/apps/docs/docs/api/interfaces/NodeParser.md
@@ -30,4 +30,4 @@ A node parser generates TextNodes from Documents
#### Defined in
-[NodeParser.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/NodeParser.ts#L53)
+[NodeParser.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 ad1f3db0e..247012fdc 100644
--- a/apps/docs/docs/api/interfaces/NodeWithEmbedding.md
+++ b/apps/docs/docs/api/interfaces/NodeWithEmbedding.md
@@ -16,7 +16,7 @@ A node with an embedding
#### Defined in
-[Node.ts:247](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L247)
+[Node.ts:247](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L247)
___
@@ -26,4 +26,4 @@ ___
#### Defined in
-[Node.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L246)
+[Node.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 1f455270b..c08052fa2 100644
--- a/apps/docs/docs/api/interfaces/NodeWithScore.md
+++ b/apps/docs/docs/api/interfaces/NodeWithScore.md
@@ -16,7 +16,7 @@ A node with a similarity score
#### Defined in
-[Node.ts:238](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L238)
+[Node.ts:238](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L238)
___
@@ -26,4 +26,4 @@ ___
#### Defined in
-[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L239)
+[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 22f42e8bb..4d195d14c 100644
--- a/apps/docs/docs/api/interfaces/QueryEngineTool.md
+++ b/apps/docs/docs/api/interfaces/QueryEngineTool.md
@@ -26,7 +26,7 @@ A Tool that uses a QueryEngine.
#### Defined in
-[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Tool.ts#L12)
+[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Tool.ts#L12)
___
@@ -36,4 +36,4 @@ ___
#### Defined in
-[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Tool.ts#L19)
+[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 c2271f60f..bf6e35c44 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/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L29)
+[Node.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L29)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L28)
+[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L28)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L26)
+[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L26)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
-[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L27)
+[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 0ed87526c..e374027b7 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/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L21)
+[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L21)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L47)
+[callbacks/CallbackManager.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L47)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L46)
+[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 74c287d04..d38a20968 100644
--- a/apps/docs/docs/api/interfaces/ServiceContext.md
+++ b/apps/docs/docs/api/interfaces/ServiceContext.md
@@ -16,7 +16,7 @@ The ServiceContext is a collection of components that are used in different part
#### Defined in
-[ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ServiceContext.ts#L15)
+[ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L15)
___
@@ -26,7 +26,7 @@ ___
#### Defined in
-[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ServiceContext.ts#L13)
+[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L13)
___
@@ -36,7 +36,7 @@ ___
#### Defined in
-[ServiceContext.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ServiceContext.ts#L11)
+[ServiceContext.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L11)
___
@@ -46,7 +46,7 @@ ___
#### Defined in
-[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ServiceContext.ts#L14)
+[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L14)
___
@@ -56,4 +56,4 @@ ___
#### Defined in
-[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ServiceContext.ts#L12)
+[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L12)
diff --git a/apps/docs/docs/api/interfaces/ServiceContextOptions.md b/apps/docs/docs/api/interfaces/ServiceContextOptions.md
index 6bd7ec81e..aa740dfaf 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:24](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ServiceContext.ts#L24)
+[ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L24)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[ServiceContext.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ServiceContext.ts#L27)
+[ServiceContext.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L27)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ServiceContext.ts#L26)
+[ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L26)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
-[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ServiceContext.ts#L22)
+[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L22)
___
@@ -54,7 +54,7 @@ ___
#### Defined in
-[ServiceContext.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ServiceContext.ts#L20)
+[ServiceContext.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L20)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
-[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ServiceContext.ts#L23)
+[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L23)
___
@@ -74,4 +74,4 @@ ___
#### Defined in
-[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ServiceContext.ts#L21)
+[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L21)
diff --git a/apps/docs/docs/api/interfaces/StorageContext.md b/apps/docs/docs/api/interfaces/StorageContext.md
index d18ef8b8a..edc8119fa 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/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/StorageContext.ts#L15)
+[storage/StorageContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/StorageContext.ts#L15)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/StorageContext.ts#L16)
+[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/StorageContext.ts#L16)
___
@@ -34,4 +34,4 @@ ___
#### Defined in
-[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/StorageContext.ts#L17)
+[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 cb2838eed..fbacbf281 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/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L21)
+[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L21)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L40)
+[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L40)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L41)
+[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L41)
___
@@ -54,4 +54,4 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L42)
+[callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 7b10a72c9..2407e43e5 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/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L29)
+[callbacks/CallbackManager.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L29)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L27)
+[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L27)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L25)
+[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L25)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L28)
+[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L28)
___
@@ -54,4 +54,4 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L26)
+[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 2c95f9394..b4733e2b3 100644
--- a/apps/docs/docs/api/interfaces/StructuredOutput.md
+++ b/apps/docs/docs/api/interfaces/StructuredOutput.md
@@ -22,7 +22,7 @@ StructuredOutput is just a combo of the raw output and the parsed output.
#### Defined in
-[OutputParser.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/OutputParser.ts#L16)
+[OutputParser.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/OutputParser.ts#L16)
___
@@ -32,4 +32,4 @@ ___
#### Defined in
-[OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/OutputParser.ts#L15)
+[OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 bea5ddf57..e98834596 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/LlamaIndexTS/blob/08c2d46/packages/core/src/QuestionGenerator.ts#L15)
+[QuestionGenerator.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QuestionGenerator.ts#L15)
___
@@ -24,4 +24,4 @@ ___
#### Defined in
-[QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/QuestionGenerator.ts#L16)
+[QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/f264211/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 7a64843b3..9af56183f 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/LlamaIndexTS/blob/08c2d46/packages/core/src/Tool.ts#L4)
+[Tool.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Tool.ts#L4)
___
@@ -24,4 +24,4 @@ ___
#### Defined in
-[Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Tool.ts#L5)
+[Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Tool.ts#L5)
diff --git a/apps/docs/docs/api/interfaces/VectorIndexConstructorProps.md b/apps/docs/docs/api/interfaces/VectorIndexConstructorProps.md
index 5f3f10dba..8513b65ac 100644
--- a/apps/docs/docs/api/interfaces/VectorIndexConstructorProps.md
+++ b/apps/docs/docs/api/interfaces/VectorIndexConstructorProps.md
@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
-[indices/BaseIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L58)
+[indices/BaseIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L58)
___
@@ -38,7 +38,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L60)
+[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L60)
___
@@ -52,7 +52,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L61)
+[indices/BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L61)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L56)
+[indices/BaseIndex.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L56)
___
@@ -80,7 +80,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L57)
+[indices/BaseIndex.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L57)
___
@@ -94,4 +94,4 @@ ___
#### Defined in
-[indices/BaseIndex.ts:96](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L96)
+[indices/BaseIndex.ts:96](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L96)
diff --git a/apps/docs/docs/api/interfaces/VectorIndexOptions.md b/apps/docs/docs/api/interfaces/VectorIndexOptions.md
index 9829c1415..0e8e0e1b4 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
-[indices/BaseIndex.ts:90](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L90)
+[indices/BaseIndex.ts:90](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L90)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L89)
+[indices/BaseIndex.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L89)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
-[indices/BaseIndex.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L91)
+[indices/BaseIndex.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L91)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
-[indices/BaseIndex.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/indices/BaseIndex.ts#L92)
+[indices/BaseIndex.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L92)
diff --git a/apps/docs/docs/api/interfaces/WalkableFileSystem.md b/apps/docs/docs/api/interfaces/WalkableFileSystem.md
index c38d0b4cc..4ce1118c2 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/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L17)
+[storage/FileSystem.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L17)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
-[storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L18)
+[storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L18)
diff --git a/apps/docs/docs/api/modules.md b/apps/docs/docs/api/modules.md
index ca6471c4e..9b7062866 100644
--- a/apps/docs/docs/api/modules.md
+++ b/apps/docs/docs/api/modules.md
@@ -95,7 +95,7 @@ custom_edit_url: null
#### Defined in
-[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L49)
+[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L49)
___
@@ -105,7 +105,7 @@ ___
#### Defined in
-[llm/LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L25)
+[llm/LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L25)
___
@@ -115,7 +115,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L11)
+[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L11)
___
@@ -125,7 +125,7 @@ ___
#### Defined in
-[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/callbacks/CallbackManager.ts#L12)
+[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L12)
___
@@ -135,7 +135,7 @@ ___
#### Defined in
-[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Node.ts#L32)
+[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L32)
___
@@ -154,7 +154,7 @@ ___
#### Defined in
-[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/readers/SimpleDirectoryReader.ts#L26)
+[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/readers/SimpleDirectoryReader.ts#L26)
___
@@ -182,7 +182,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/LlamaIndexTS/blob/08c2d46/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Prompt.ts#L10)
## Variables
@@ -206,7 +206,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
#### Defined in
-[llm/LLM.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L152)
+[llm/LLM.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L152)
___
@@ -231,7 +231,7 @@ We currently support GPT-3.5 and GPT-4 models
#### Defined in
-[llm/LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L57)
+[llm/LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L57)
___
@@ -241,7 +241,7 @@ ___
#### Defined in
-[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/constants.ts#L5)
+[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L5)
___
@@ -251,7 +251,7 @@ ___
#### Defined in
-[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/constants.ts#L6)
+[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L6)
___
@@ -261,7 +261,7 @@ ___
#### Defined in
-[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/constants.ts#L4)
+[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L4)
___
@@ -271,7 +271,7 @@ ___
#### Defined in
-[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/constants.ts#L1)
+[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/constants.ts#L1)
___
@@ -281,7 +281,7 @@ ___
#### Defined in
-[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/constants.ts#L1)
+[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L1)
___
@@ -291,7 +291,7 @@ ___
#### Defined in
-[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/constants.ts#L4)
+[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/constants.ts#L4)
___
@@ -301,7 +301,7 @@ ___
#### Defined in
-[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/constants.ts#L10)
+[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L10)
___
@@ -311,7 +311,7 @@ ___
#### Defined in
-[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L62)
+[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L62)
___
@@ -321,7 +321,7 @@ ___
#### Defined in
-[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/constants.ts#L6)
+[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/constants.ts#L6)
___
@@ -331,7 +331,7 @@ ___
#### Defined in
-[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/constants.ts#L3)
+[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/constants.ts#L3)
___
@@ -341,7 +341,7 @@ ___
#### Defined in
-[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/constants.ts#L7)
+[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/constants.ts#L7)
___
@@ -351,7 +351,7 @@ ___
#### Defined in
-[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/constants.ts#L2)
+[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L2)
___
@@ -361,7 +361,7 @@ ___
#### Defined in
-[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/constants.ts#L11)
+[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L11)
___
@@ -371,7 +371,7 @@ ___
#### Defined in
-[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/constants.ts#L2)
+[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/constants.ts#L2)
___
@@ -381,7 +381,7 @@ ___
#### Defined in
-[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/constants.ts#L7)
+[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L7)
___
@@ -391,7 +391,7 @@ ___
#### Defined in
-[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/constants.ts#L5)
+[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/constants.ts#L5)
___
@@ -410,7 +410,7 @@ ___
#### Defined in
-[llm/LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L44)
+[llm/LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L44)
___
@@ -429,7 +429,7 @@ ___
#### Defined in
-[llm/LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/llm/LLM.ts#L49)
+[llm/LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L49)
___
@@ -439,7 +439,7 @@ ___
#### Defined in
-[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/GlobalsHelper.ts#L42)
+[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/GlobalsHelper.ts#L42)
## Functions
@@ -459,7 +459,7 @@ ___
#### Defined in
-[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Prompt.ts#L198)
+[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Prompt.ts#L198)
___
@@ -483,7 +483,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/LlamaIndexTS/blob/08c2d46/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Prompt.ts#L10)
___
@@ -507,7 +507,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/LlamaIndexTS/blob/08c2d46/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Prompt.ts#L10)
___
@@ -531,7 +531,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/LlamaIndexTS/blob/08c2d46/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Prompt.ts#L10)
___
@@ -555,7 +555,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/LlamaIndexTS/blob/08c2d46/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Prompt.ts#L10)
___
@@ -579,7 +579,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/LlamaIndexTS/blob/08c2d46/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Prompt.ts#L10)
___
@@ -603,7 +603,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/LlamaIndexTS/blob/08c2d46/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Prompt.ts#L10)
___
@@ -627,7 +627,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/LlamaIndexTS/blob/08c2d46/packages/core/src/Prompt.ts#L10)
+[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Prompt.ts#L10)
___
@@ -653,7 +653,7 @@ A promise that resolves to true if the file exists, false otherwise.
#### Defined in
-[storage/FileSystem.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L74)
+[storage/FileSystem.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L74)
___
@@ -667,7 +667,7 @@ ___
#### Defined in
-[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L51)
+[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L51)
___
@@ -690,7 +690,7 @@ ___
#### Defined in
-[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/NodeParser.ts#L15)
+[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/NodeParser.ts#L15)
___
@@ -711,7 +711,7 @@ ___
#### Defined in
-[ResponseSynthesizer.ts:262](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ResponseSynthesizer.ts#L262)
+[ResponseSynthesizer.ts:262](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L262)
___
@@ -732,7 +732,7 @@ ___
#### Defined in
-[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/NodeParser.ts#L5)
+[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/NodeParser.ts#L5)
___
@@ -758,7 +758,7 @@ Get the top K embeddings from a list of embeddings ordered by similarity to the
#### Defined in
-[Embedding.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L77)
+[Embedding.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L77)
___
@@ -782,7 +782,7 @@ ___
#### Defined in
-[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L119)
+[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L119)
___
@@ -808,7 +808,7 @@ ___
#### Defined in
-[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L131)
+[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L131)
___
@@ -828,7 +828,7 @@ ___
#### Defined in
-[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Prompt.ts#L300)
+[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Prompt.ts#L300)
___
@@ -848,7 +848,7 @@ ___
#### Defined in
-[ServiceContext.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ServiceContext.ts#L30)
+[ServiceContext.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L30)
___
@@ -877,7 +877,7 @@ ___
#### Defined in
-[ServiceContext.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/ServiceContext.ts#L48)
+[ServiceContext.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L48)
___
@@ -903,7 +903,7 @@ similartiy score with higher numbers meaning the two embeddings are more similar
#### Defined in
-[Embedding.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/Embedding.ts#L22)
+[Embedding.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L22)
___
@@ -923,7 +923,7 @@ ___
#### Defined in
-[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/StorageContext.ts#L28)
+[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/StorageContext.ts#L28)
___
@@ -946,4 +946,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/LlamaIndexTS/blob/08c2d46/packages/core/src/storage/FileSystem.ts#L91)
+[storage/FileSystem.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L91)
diff --git a/apps/docs/docusaurus.config.js b/apps/docs/docusaurus.config.js
index 92bc1b39c..2adbdf704 100644
--- a/apps/docs/docusaurus.config.js
+++ b/apps/docs/docusaurus.config.js
@@ -21,7 +21,7 @@ const config = {
organizationName: "run-llama", // Usually your GitHub org/user name.
projectName: "LlamaIndex.TS", // Usually your repo name.
- onBrokenLinks: "throw",
+ onBrokenLinks: "warn",
onBrokenMarkdownLinks: "warn",
// Even if you don't use internalization, you can use this field to set useful
@@ -119,6 +119,7 @@ const config = {
},
}),
plugins: [
+ ["docusaurus-lunr-search", {}],
[
"docusaurus-plugin-typedoc",
{
diff --git a/apps/docs/package.json b/apps/docs/package.json
index 32e523978..4bb1d6dc7 100644
--- a/apps/docs/package.json
+++ b/apps/docs/package.json
@@ -20,6 +20,7 @@
"@docusaurus/remark-plugin-npm2yarn": "^2.4.1",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.2.1",
+ "docusaurus-lunr-search": "^2.3.2",
"postcss": "^8.4.25",
"prism-react-renderer": "^1.3.5",
"raw-loader": "^4.0.2",
diff --git a/apps/docs/src/theme/SearchBar/DocSearch.js b/apps/docs/src/theme/SearchBar/DocSearch.js
new file mode 100644
index 000000000..ec627d480
--- /dev/null
+++ b/apps/docs/src/theme/SearchBar/DocSearch.js
@@ -0,0 +1,297 @@
+import Hogan from "hogan.js";
+import LunrSearchAdapter from "./lunar-search";
+import autocomplete from "autocomplete.js";
+import templates from "./templates";
+import utils from "./utils";
+import $ from "autocomplete.js/zepto";
+
+class DocSearch {
+ constructor({
+ searchDocs,
+ searchIndex,
+ inputSelector,
+ debug = false,
+ baseUrl = '/',
+ queryDataCallback = null,
+ autocompleteOptions = {
+ debug: false,
+ hint: false,
+ autoselect: true
+ },
+ transformData = false,
+ queryHook = false,
+ handleSelected = false,
+ enhancedSearchInput = false,
+ layout = "collumns"
+ }) {
+ this.input = DocSearch.getInputFromSelector(inputSelector);
+ this.queryDataCallback = queryDataCallback || null;
+ const autocompleteOptionsDebug =
+ autocompleteOptions && autocompleteOptions.debug
+ ? autocompleteOptions.debug
+ : false;
+ // eslint-disable-next-line no-param-reassign
+ autocompleteOptions.debug = debug || autocompleteOptionsDebug;
+ this.autocompleteOptions = autocompleteOptions;
+ this.autocompleteOptions.cssClasses =
+ this.autocompleteOptions.cssClasses || {};
+ this.autocompleteOptions.cssClasses.prefix =
+ this.autocompleteOptions.cssClasses.prefix || "ds";
+ const inputAriaLabel =
+ this.input &&
+ typeof this.input.attr === "function" &&
+ this.input.attr("aria-label");
+ this.autocompleteOptions.ariaLabel =
+ this.autocompleteOptions.ariaLabel || inputAriaLabel || "search input";
+
+ this.isSimpleLayout = layout === "simple";
+
+ this.client = new LunrSearchAdapter(searchDocs, searchIndex, baseUrl);
+
+ if (enhancedSearchInput) {
+ this.input = DocSearch.injectSearchBox(this.input);
+ }
+ this.autocomplete = autocomplete(this.input, autocompleteOptions, [
+ {
+ source: this.getAutocompleteSource(transformData, queryHook),
+ templates: {
+ suggestion: DocSearch.getSuggestionTemplate(this.isSimpleLayout),
+ footer: templates.footer,
+ empty: DocSearch.getEmptyTemplate()
+ }
+ }
+ ]);
+
+ const customHandleSelected = handleSelected;
+ this.handleSelected = customHandleSelected || this.handleSelected;
+
+ // We prevent default link clicking if a custom handleSelected is defined
+ if (customHandleSelected) {
+ $(".algolia-autocomplete").on("click", ".ds-suggestions a", event => {
+ event.preventDefault();
+ });
+ }
+
+ this.autocomplete.on(
+ "autocomplete:selected",
+ this.handleSelected.bind(null, this.autocomplete.autocomplete)
+ );
+
+ this.autocomplete.on(
+ "autocomplete:shown",
+ this.handleShown.bind(null, this.input)
+ );
+
+ if (enhancedSearchInput) {
+ DocSearch.bindSearchBoxEvent();
+ }
+ }
+
+ static injectSearchBox(input) {
+ input.before(templates.searchBox);
+ const newInput = input
+ .prev()
+ .prev()
+ .find("input");
+ input.remove();
+ return newInput;
+ }
+
+ static bindSearchBoxEvent() {
+ $('.searchbox [type="reset"]').on("click", function () {
+ $("input#docsearch").focus();
+ $(this).addClass("hide");
+ autocomplete.autocomplete.setVal("");
+ });
+
+ $("input#docsearch").on("keyup", () => {
+ const searchbox = document.querySelector("input#docsearch");
+ const reset = document.querySelector('.searchbox [type="reset"]');
+ reset.className = "searchbox__reset";
+ if (searchbox.value.length === 0) {
+ reset.className += " hide";
+ }
+ });
+ }
+
+ /**
+ * Returns the matching input from a CSS selector, null if none matches
+ * @function getInputFromSelector
+ * @param {string} selector CSS selector that matches the search
+ * input of the page
+ * @returns {void}
+ */
+ static getInputFromSelector(selector) {
+ const input = $(selector).filter("input");
+ return input.length ? $(input[0]) : null;
+ }
+
+ /**
+ * Returns the `source` method to be passed to autocomplete.js. It will query
+ * the Algolia index and call the callbacks with the formatted hits.
+ * @function getAutocompleteSource
+ * @param {function} transformData An optional function to transform the hits
+ * @param {function} queryHook An optional function to transform the query
+ * @returns {function} Method to be passed as the `source` option of
+ * autocomplete
+ */
+ getAutocompleteSource(transformData, queryHook) {
+ return (query, callback) => {
+ if (queryHook) {
+ // eslint-disable-next-line no-param-reassign
+ query = queryHook(query) || query;
+ }
+ this.client.search(query).then(hits => {
+ if (
+ this.queryDataCallback &&
+ typeof this.queryDataCallback == "function"
+ ) {
+ this.queryDataCallback(hits);
+ }
+ if (transformData) {
+ hits = transformData(hits) || hits;
+ }
+ callback(DocSearch.formatHits(hits));
+ });
+ };
+ }
+
+ // Given a list of hits returned by the API, will reformat them to be used in
+ // a Hogan template
+ static formatHits(receivedHits) {
+ const clonedHits = utils.deepClone(receivedHits);
+ const hits = clonedHits.map(hit => {
+ if (hit._highlightResult) {
+ // eslint-disable-next-line no-param-reassign
+ hit._highlightResult = utils.mergeKeyWithParent(
+ hit._highlightResult,
+ "hierarchy"
+ );
+ }
+ return utils.mergeKeyWithParent(hit, "hierarchy");
+ });
+
+ // Group hits by category / subcategory
+ let groupedHits = utils.groupBy(hits, "lvl0");
+ $.each(groupedHits, (level, collection) => {
+ const groupedHitsByLvl1 = utils.groupBy(collection, "lvl1");
+ const flattenedHits = utils.flattenAndFlagFirst(
+ groupedHitsByLvl1,
+ "isSubCategoryHeader"
+ );
+ groupedHits[level] = flattenedHits;
+ });
+ groupedHits = utils.flattenAndFlagFirst(groupedHits, "isCategoryHeader");
+
+ // Translate hits into smaller objects to be send to the template
+ return groupedHits.map(hit => {
+ const url = DocSearch.formatURL(hit);
+ const category = utils.getHighlightedValue(hit, "lvl0");
+ const subcategory = utils.getHighlightedValue(hit, "lvl1") || category;
+ const displayTitle = utils
+ .compact([
+ utils.getHighlightedValue(hit, "lvl2") || subcategory,
+ utils.getHighlightedValue(hit, "lvl3"),
+ utils.getHighlightedValue(hit, "lvl4"),
+ utils.getHighlightedValue(hit, "lvl5"),
+ utils.getHighlightedValue(hit, "lvl6")
+ ])
+ .join(
+ '<span class="aa-suggestion-title-separator" aria-hidden="true"> › </span>'
+ );
+ const text = utils.getSnippetedValue(hit, "content");
+ const isTextOrSubcategoryNonEmpty =
+ (subcategory && subcategory !== "") ||
+ (displayTitle && displayTitle !== "");
+ const isLvl1EmptyOrDuplicate =
+ !subcategory || subcategory === "" || subcategory === category;
+ const isLvl2 =
+ displayTitle && displayTitle !== "" && displayTitle !== subcategory;
+ const isLvl1 =
+ !isLvl2 &&
+ (subcategory && subcategory !== "" && subcategory !== category);
+ const isLvl0 = !isLvl1 && !isLvl2;
+
+ return {
+ isLvl0,
+ isLvl1,
+ isLvl2,
+ isLvl1EmptyOrDuplicate,
+ isCategoryHeader: hit.isCategoryHeader,
+ isSubCategoryHeader: hit.isSubCategoryHeader,
+ isTextOrSubcategoryNonEmpty,
+ category,
+ subcategory,
+ title: displayTitle,
+ text,
+ url
+ };
+ });
+ }
+
+ static formatURL(hit) {
+ const { url, anchor } = hit;
+ if (url) {
+ const containsAnchor = url.indexOf("#") !== -1;
+ if (containsAnchor) return url;
+ else if (anchor) return `${hit.url}#${hit.anchor}`;
+ return url;
+ } else if (anchor) return `#${hit.anchor}`;
+ /* eslint-disable */
+ console.warn("no anchor nor url for : ", JSON.stringify(hit));
+ /* eslint-enable */
+ return null;
+ }
+
+ static getEmptyTemplate() {
+ return args => Hogan.compile(templates.empty).render(args);
+ }
+
+ static getSuggestionTemplate(isSimpleLayout) {
+ const stringTemplate = isSimpleLayout
+ ? templates.suggestionSimple
+ : templates.suggestion;
+ const template = Hogan.compile(stringTemplate);
+ return suggestion => template.render(suggestion);
+ }
+
+ handleSelected(input, event, suggestion, datasetNumber, context = {}) {
+ // Do nothing if click on the suggestion, as it's already a <a href>, the
+ // browser will take care of it. This allow Ctrl-Clicking on results and not
+ // having the main window being redirected as well
+ if (context.selectionMethod === "click") {
+ return;
+ }
+
+ input.setVal("");
+ window.location.assign(suggestion.url);
+ }
+
+ handleShown(input) {
+ const middleOfInput = input.offset().left + input.width() / 2;
+ let middleOfWindow = $(document).width() / 2;
+
+ if (isNaN(middleOfWindow)) {
+ middleOfWindow = 900;
+ }
+
+ const alignClass =
+ middleOfInput - middleOfWindow >= 0
+ ? "algolia-autocomplete-right"
+ : "algolia-autocomplete-left";
+ const otherAlignClass =
+ middleOfInput - middleOfWindow < 0
+ ? "algolia-autocomplete-right"
+ : "algolia-autocomplete-left";
+ const autocompleteWrapper = $(".algolia-autocomplete");
+ if (!autocompleteWrapper.hasClass(alignClass)) {
+ autocompleteWrapper.addClass(alignClass);
+ }
+
+ if (autocompleteWrapper.hasClass(otherAlignClass)) {
+ autocompleteWrapper.removeClass(otherAlignClass);
+ }
+ }
+}
+
+export default DocSearch;
diff --git a/apps/docs/src/theme/SearchBar/algolia.css b/apps/docs/src/theme/SearchBar/algolia.css
new file mode 100644
index 000000000..c5590cfa4
--- /dev/null
+++ b/apps/docs/src/theme/SearchBar/algolia.css
@@ -0,0 +1,526 @@
+/* Bottom border of each suggestion */
+.algolia-docsearch-suggestion {
+ border-bottom-color: #3a3dd1;
+}
+/* Main category headers */
+.algolia-docsearch-suggestion--category-header {
+ background-color: #4b54de;
+}
+/* Highlighted search terms */
+.algolia-docsearch-suggestion--highlight {
+ color: #3a33d1;
+}
+/* Highligted search terms in the main category headers */
+.algolia-docsearch-suggestion--category-header
+ .algolia-docsearch-suggestion--highlight {
+ background-color: #4d47d5;
+}
+/* Currently selected suggestion */
+.aa-cursor .algolia-docsearch-suggestion--content {
+ color: #272296;
+}
+.aa-cursor .algolia-docsearch-suggestion {
+ background: #ebebfb;
+}
+
+/* For bigger screens, when displaying results in two columns */
+@media (min-width: 768px) {
+ /* Bottom border of each suggestion */
+ .algolia-docsearch-suggestion {
+ border-bottom-color: #7671df;
+ }
+ /* Left column, with secondary category header */
+ .algolia-docsearch-suggestion--subcategory-column {
+ border-right-color: #7671df;
+ color: #4e4726;
+ }
+}
+
+.searchbox {
+ display: inline-block;
+ position: relative;
+ width: 200px;
+ height: 32px !important;
+ white-space: nowrap;
+ box-sizing: border-box;
+ visibility: visible !important;
+}
+
+.searchbox .algolia-autocomplete {
+ display: block;
+ width: 100%;
+ height: 100%;
+}
+
+.searchbox__wrapper {
+ width: 100%;
+ height: 100%;
+ z-index: 999;
+ position: relative;
+}
+
+.searchbox__input {
+ display: inline-block;
+ box-sizing: border-box;
+ -webkit-transition: box-shadow 0.4s ease, background 0.4s ease;
+ transition: box-shadow 0.4s ease, background 0.4s ease;
+ border: 0;
+ border-radius: 16px;
+ box-shadow: inset 0 0 0 1px #cccccc;
+ background: #ffffff !important;
+ padding: 0;
+ padding-right: 26px;
+ padding-left: 32px;
+ width: 100%;
+ height: 100%;
+ vertical-align: middle;
+ white-space: normal;
+ font-size: 12px;
+ -webkit-appearance: none;
+ -moz-appearance: none;
+ appearance: none;
+}
+
+.searchbox__input::-webkit-search-decoration,
+.searchbox__input::-webkit-search-cancel-button,
+.searchbox__input::-webkit-search-results-button,
+.searchbox__input::-webkit-search-results-decoration {
+ display: none;
+}
+
+.searchbox__input:hover {
+ box-shadow: inset 0 0 0 1px #b3b3b3;
+}
+
+.searchbox__input:focus,
+.searchbox__input:active {
+ outline: 0;
+ box-shadow: inset 0 0 0 1px #aaaaaa;
+ background: #ffffff;
+}
+
+.searchbox__input::-webkit-input-placeholder {
+ color: #aaaaaa;
+}
+
+.searchbox__input::-moz-placeholder {
+ color: #aaaaaa;
+}
+
+.searchbox__input:-ms-input-placeholder {
+ color: #aaaaaa;
+}
+
+.searchbox__input::placeholder {
+ color: #aaaaaa;
+}
+
+.searchbox__submit {
+ position: absolute;
+ top: 0;
+ margin: 0;
+ border: 0;
+ border-radius: 16px 0 0 16px;
+ background-color: rgba(69, 142, 225, 0);
+ padding: 0;
+ width: 32px;
+ height: 100%;
+ vertical-align: middle;
+ text-align: center;
+ font-size: inherit;
+ -webkit-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ right: inherit;
+ left: 0;
+}
+
+.searchbox__submit::before {
+ display: inline-block;
+ margin-right: -4px;
+ height: 100%;
+ vertical-align: middle;
+ content: '';
+}
+
+.searchbox__submit:hover,
+.searchbox__submit:active {
+ cursor: pointer;
+}
+
+.searchbox__submit:focus {
+ outline: 0;
+}
+
+.searchbox__submit svg {
+ width: 14px;
+ height: 14px;
+ vertical-align: middle;
+ fill: #6d7e96;
+}
+
+.searchbox__reset {
+ display: block;
+ position: absolute;
+ top: 8px;
+ right: 8px;
+ margin: 0;
+ border: 0;
+ background: none;
+ cursor: pointer;
+ padding: 0;
+ font-size: inherit;
+ -webkit-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ fill: rgba(0, 0, 0, 0.5);
+}
+
+.searchbox__reset.hide {
+ display: none;
+}
+
+.searchbox__reset:focus {
+ outline: 0;
+}
+
+.searchbox__reset svg {
+ display: block;
+ margin: 4px;
+ width: 8px;
+ height: 8px;
+}
+
+.searchbox__input:valid ~ .searchbox__reset {
+ display: block;
+ -webkit-animation-name: sbx-reset-in;
+ animation-name: sbx-reset-in;
+ -webkit-animation-duration: 0.15s;
+ animation-duration: 0.15s;
+}
+
+@-webkit-keyframes sbx-reset-in {
+ 0% {
+ -webkit-transform: translate3d(-20%, 0, 0);
+ transform: translate3d(-20%, 0, 0);
+ opacity: 0;
+ }
+ 100% {
+ -webkit-transform: none;
+ transform: none;
+ opacity: 1;
+ }
+}
+
+@keyframes sbx-reset-in {
+ 0% {
+ -webkit-transform: translate3d(-20%, 0, 0);
+ transform: translate3d(-20%, 0, 0);
+ opacity: 0;
+ }
+ 100% {
+ -webkit-transform: none;
+ transform: none;
+ opacity: 1;
+ }
+}
+
+.algolia-autocomplete .ds-dropdown-menu:before {
+ display: block;
+ position: absolute;
+ content: '';
+ width: 14px;
+ height: 14px;
+ background: #373940;
+ z-index: 1000;
+ top: -7px;
+ border-top: 1px solid #373940;
+ border-right: 1px solid #373940;
+ -webkit-transform: rotate(-45deg);
+ transform: rotate(-45deg);
+ border-radius: 2px;
+}
+
+.algolia-autocomplete .ds-dropdown-menu {
+ box-shadow: 0 1px 0 0 rgba(0, 0, 0, 0.2), 0 2px 3px 0 rgba(0, 0, 0, 0.1);
+}
+
+@media (min-width: 601px) {
+ .algolia-autocomplete.algolia-autocomplete-right .ds-dropdown-menu {
+ right: 0 !important;
+ left: inherit !important;
+ }
+
+ .algolia-autocomplete.algolia-autocomplete-right .ds-dropdown-menu:before {
+ right: 48px;
+ }
+
+ .algolia-autocomplete .ds-dropdown-menu {
+ position: relative;
+ top: -6px;
+ border-radius: 4px;
+ margin: 6px 0 0;
+ padding: 0;
+ text-align: left;
+ height: auto;
+ position: relative;
+ background: transparent;
+ border: none;
+ z-index: 999;
+ max-width: 600px;
+ min-width: 500px;
+ }
+}
+
+@media (max-width: 600px) {
+ .algolia-autocomplete .ds-dropdown-menu {
+ z-index: 100;
+ position: fixed !important;
+ top: 50px !important;
+ left: auto !important;
+ right: 1rem !important;
+ width: 600px;
+ max-width: calc(100% - 2rem);
+ max-height: calc(100% - 5rem);
+ display: block;
+ }
+
+ .algolia-autocomplete .ds-dropdown-menu:before {
+ right: 6rem;
+ }
+}
+
+.algolia-autocomplete .ds-dropdown-menu .ds-suggestions {
+ position: relative;
+ z-index: 1000;
+}
+
+.algolia-autocomplete .ds-dropdown-menu .ds-suggestion {
+ cursor: pointer;
+}
+
+.algolia-autocomplete .ds-dropdown-menu [class^='ds-dataset-'] {
+ position: relative;
+ border-radius: 4px;
+ overflow: auto;
+ padding: 0;
+ background: #ffffff;
+}
+
+.algolia-autocomplete .ds-dropdown-menu * {
+ box-sizing: border-box;
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion {
+ display: block;
+ position: relative;
+ padding: 0;
+ overflow: hidden;
+ text-decoration: none;
+}
+
+.algolia-autocomplete .ds-cursor .algolia-docsearch-suggestion--wrapper {
+ background: #f1f1f1;
+ box-shadow: inset -2px 0 0 #61dafb;
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--highlight {
+ background: #ffe564;
+ padding: 0.1em 0.05em;
+}
+
+.algolia-autocomplete
+ .algolia-docsearch-suggestion--category-header
+ .algolia-docsearch-suggestion--category-header-lvl0
+ .algolia-docsearch-suggestion--highlight,
+.algolia-autocomplete
+ .algolia-docsearch-suggestion--category-header
+ .algolia-docsearch-suggestion--category-header-lvl1
+ .algolia-docsearch-suggestion--highlight {
+ color: inherit;
+ background: inherit;
+}
+
+.algolia-autocomplete
+ .algolia-docsearch-suggestion--text
+ .algolia-docsearch-suggestion--highlight {
+ padding: 0 0 1px;
+ background: inherit;
+ box-shadow: inset 0 -2px 0 0 rgba(69, 142, 225, 0.8);
+ color: inherit;
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--content {
+ display: block;
+ float: right;
+ width: 70%;
+ position: relative;
+ padding: 5.33333px 0 5.33333px 10.66667px;
+ cursor: pointer;
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--content:before {
+ content: '';
+ position: absolute;
+ display: block;
+ top: 0;
+ height: 100%;
+ width: 1px;
+ background: #ececec;
+ left: -1px;
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--category-header {
+ position: relative;
+ display: none;
+ font-size: 14px;
+ letter-spacing: 0.08em;
+ font-weight: 700;
+ background-color: #373940;
+ text-transform: uppercase;
+ color: #fff;
+ margin: 0;
+ padding: 5px 8px;
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--wrapper {
+ background-color: #fff;
+ width: 100%;
+ float: left;
+ padding: 8px 0 0 0;
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column {
+ float: left;
+ width: 30%;
+ display: none;
+ padding-left: 0;
+ text-align: right;
+ position: relative;
+ padding: 5.33333px 10.66667px;
+ color: #777;
+ font-size: 0.9em;
+ word-wrap: break-word;
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column:before {
+ content: '';
+ position: absolute;
+ display: block;
+ top: 0;
+ height: 100%;
+ width: 1px;
+ background: #ececec;
+ right: 0;
+}
+
+.algolia-autocomplete
+ .algolia-docsearch-suggestion.algolia-docsearch-suggestion__main
+ .algolia-docsearch-suggestion--category-header,
+.algolia-autocomplete
+ .algolia-docsearch-suggestion.algolia-docsearch-suggestion__secondary {
+ display: block;
+}
+
+.algolia-autocomplete
+ .algolia-docsearch-suggestion--subcategory-column
+ .algolia-docsearch-suggestion--highlight {
+ background-color: inherit;
+ color: inherit;
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-inline {
+ display: none;
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--title {
+ margin-bottom: 4px;
+ color: #02060c;
+ font-size: 0.9em;
+ font-weight: bold;
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--text {
+ display: block;
+ line-height: 1.2em;
+ font-size: 0.85em;
+ color: #63676d;
+ padding-right: 2px;
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--no-results {
+ width: 100%;
+ padding: 8px 0;
+ text-align: center;
+ font-size: 1.2em;
+ background-color: #373940;
+ margin-top: -8px;
+}
+
+.algolia-autocomplete
+ .algolia-docsearch-suggestion--no-results
+ .algolia-docsearch-suggestion--text {
+ color: #ffffff;
+ margin-top: 4px;
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--no-results::before {
+ display: none;
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion code {
+ padding: 1px 5px;
+ font-size: 90%;
+ border: none;
+ color: #222222;
+ background-color: #ebebeb;
+ border-radius: 3px;
+ font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
+ monospace;
+}
+
+.algolia-autocomplete
+ .algolia-docsearch-suggestion
+ code
+ .algolia-docsearch-suggestion--highlight {
+ background: none;
+}
+
+.algolia-autocomplete
+ .algolia-docsearch-suggestion.algolia-docsearch-suggestion__main
+ .algolia-docsearch-suggestion--category-header {
+ color: white;
+ display: block;
+}
+
+.algolia-autocomplete
+ .algolia-docsearch-suggestion.algolia-docsearch-suggestion__secondary
+ .algolia-docsearch-suggestion--subcategory-column {
+ display: block;
+}
+
+.algolia-autocomplete .algolia-docsearch-footer {
+ background-color: #fff;
+ width: 100%;
+ height: 30px;
+ z-index: 2000;
+ float: right;
+ font-size: 0;
+ line-height: 0;
+}
+
+.algolia-autocomplete .algolia-docsearch-footer--logo {
+ background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 130 18'%3E%3Cdefs%3E%3ClinearGradient id='a' x1='-36.87%25' x2='129.43%25' y1='134.94%25' y2='-27.7%25'%3E%3Cstop stop-color='%252300AEFF' offset='0%25'/%3E%3Cstop stop-color='%25233369E7' offset='100%25'/%3E%3C/linearGradient%3E%3C/defs%3E%3Cg fill='none' fill-rule='evenodd'%3E%3Cpath fill='url(%2523a)' d='M59.4.02h13.3a2.37 2.37 0 0 1 2.38 2.37V15.6a2.37 2.37 0 0 1-2.38 2.36H59.4a2.37 2.37 0 0 1-2.38-2.36V2.38A2.37 2.37 0 0 1 59.4.02z'/%3E%3Cpath fill='%2523FFF' d='M66.26 4.56c-2.82 0-5.1 2.27-5.1 5.08 0 2.8 2.28 5.07 5.1 5.07 2.8 0 5.1-2.26 5.1-5.07 0-2.8-2.28-5.07-5.1-5.07zm0 8.65c-2 0-3.6-1.6-3.6-3.56 0-1.97 1.6-3.58 3.6-3.58 1.98 0 3.6 1.6 3.6 3.58a3.58 3.58 0 0 1-3.6 3.57zm0-6.4v2.66c0 .07.08.13.15.1l2.4-1.24c.04-.02.06-.1.03-.14a2.96 2.96 0 0 0-2.46-1.5c-.06 0-.1.05-.1.1zm-3.33-1.96l-.3-.3a.78.78 0 0 0-1.12 0l-.36.36a.77.77 0 0 0 0 1.1l.3.3c.05.05.13.04.17 0 .2-.25.4-.5.6-.7.23-.23.46-.43.7-.6.07-.04.07-.1.03-.16zm5-.8V3.4a.78.78 0 0 0-.78-.78h-1.83a.78.78 0 0 0-.78.78v.63c0 .07.06.12.14.1a5.74 5.74 0 0 1 1.58-.22c.52 0 1.04.07 1.54.2a.1.1 0 0 0 .13-.1z'/%3E%3Cpath fill='%2523182359' d='M102.16 13.76c0 1.46-.37 2.52-1.12 3.2-.75.67-1.9 1-3.44 1-.56 0-1.74-.1-2.67-.3l.34-1.7c.78.17 1.82.2 2.36.2.86 0 1.48-.16 1.84-.5.37-.36.55-.88.55-1.57v-.35a6.37 6.37 0 0 1-.84.3 4.15 4.15 0 0 1-1.2.17 4.5 4.5 0 0 1-1.6-.28 3.38 3.38 0 0 1-1.26-.82 3.74 3.74 0 0 1-.8-1.35c-.2-.54-.3-1.5-.3-2.2 0-.67.1-1.5.3-2.06a3.92 3.92 0 0 1 .9-1.43 4.12 4.12 0 0 1 1.45-.92 5.3 5.3 0 0 1 1.94-.37c.7 0 1.35.1 1.97.2a15.86 15.86 0 0 1 1.6.33v8.46zm-5.95-4.2c0 .9.2 1.88.6 2.3.4.4.9.62 1.53.62.34 0 .66-.05.96-.15a2.75 2.75 0 0 0 .73-.33V6.7a8.53 8.53 0 0 0-1.42-.17c-.76-.02-1.36.3-1.77.8-.4.5-.62 1.4-.62 2.23zm16.13 0c0 .72-.1 1.26-.32 1.85a4.4 4.4 0 0 1-.9 1.53c-.38.42-.85.75-1.4.98-.54.24-1.4.37-1.8.37-.43 0-1.27-.13-1.8-.36a4.1 4.1 0 0 1-1.4-.97 4.5 4.5 0 0 1-.92-1.52 5.04 5.04 0 0 1-.33-1.84c0-.72.1-1.4.32-2 .22-.6.53-1.1.92-1.5.4-.43.86-.75 1.4-.98a4.55 4.55 0 0 1 1.78-.34 4.7 4.7 0 0 1 1.8.34c.54.23 1 .55 1.4.97.38.42.68.92.9 1.5.23.6.35 1.3.35 2zm-2.2 0c0-.92-.2-1.7-.6-2.22-.38-.54-.94-.8-1.64-.8-.72 0-1.27.26-1.67.8-.4.54-.58 1.3-.58 2.22 0 .93.2 1.56.6 2.1.38.54.94.8 1.64.8s1.25-.26 1.65-.8c.4-.55.6-1.17.6-2.1zm6.97 4.7c-3.5.02-3.5-2.8-3.5-3.27L113.57.92l2.15-.34v10c0 .25 0 1.87 1.37 1.88v1.8zm3.77 0h-2.15v-9.2l2.15-.33v9.54zM119.8 3.74c.7 0 1.3-.58 1.3-1.3 0-.7-.58-1.3-1.3-1.3-.73 0-1.3.6-1.3 1.3 0 .72.58 1.3 1.3 1.3zm6.43 1c.7 0 1.3.1 1.78.27.5.18.88.42 1.17.73.28.3.5.74.6 1.18.13.46.2.95.2 1.5v5.47a25.24 25.24 0 0 1-1.5.25c-.67.1-1.42.15-2.25.15a6.83 6.83 0 0 1-1.52-.16 3.2 3.2 0 0 1-1.18-.5 2.46 2.46 0 0 1-.76-.9c-.18-.37-.27-.9-.27-1.44 0-.52.1-.85.3-1.2.2-.37.48-.67.83-.9a3.6 3.6 0 0 1 1.23-.5 7.07 7.07 0 0 1 2.2-.1l.83.16v-.35c0-.25-.03-.48-.1-.7a1.5 1.5 0 0 0-.3-.58c-.15-.18-.34-.3-.58-.4a2.54 2.54 0 0 0-.92-.17c-.5 0-.94.06-1.35.13-.4.08-.75.16-1 .25l-.27-1.74c.27-.1.67-.18 1.2-.28a9.34 9.34 0 0 1 1.65-.14zm.18 7.74c.66 0 1.15-.04 1.5-.1V10.2a5.1 5.1 0 0 0-2-.1c-.23.03-.45.1-.64.2a1.17 1.17 0 0 0-.47.38c-.13.17-.18.26-.18.52 0 .5.17.8.5.98.32.2.74.3 1.3.3zM84.1 4.8c.72 0 1.3.08 1.8.26.48.17.87.42 1.15.73.3.3.5.72.6 1.17.14.45.2.94.2 1.47v5.48a25.24 25.24 0 0 1-1.5.26c-.67.1-1.42.14-2.25.14a6.83 6.83 0 0 1-1.52-.16 3.2 3.2 0 0 1-1.18-.5 2.46 2.46 0 0 1-.76-.9c-.18-.38-.27-.9-.27-1.44 0-.53.1-.86.3-1.22.2-.36.5-.65.84-.88a3.6 3.6 0 0 1 1.24-.5 7.07 7.07 0 0 1 2.2-.1c.26.03.54.08.84.15v-.35c0-.24-.03-.48-.1-.7a1.5 1.5 0 0 0-.3-.58c-.15-.17-.34-.3-.58-.4a2.54 2.54 0 0 0-.9-.15c-.5 0-.96.05-1.37.12-.4.07-.75.15-1 .24l-.26-1.75c.27-.08.67-.17 1.18-.26a8.9 8.9 0 0 1 1.66-.15zm.2 7.73c.65 0 1.14-.04 1.48-.1v-2.17a5.1 5.1 0 0 0-1.98-.1c-.24.03-.46.1-.65.18a1.17 1.17 0 0 0-.47.4c-.12.17-.17.26-.17.52 0 .5.18.8.5.98.32.2.75.3 1.3.3zm8.68 1.74c-3.5 0-3.5-2.82-3.5-3.28L89.45.92 91.6.6v10c0 .25 0 1.87 1.38 1.88v1.8z'/%3E%3Cpath fill='%25231D3657' d='M5.03 11.03c0 .7-.26 1.24-.76 1.64-.5.4-1.2.6-2.1.6-.88 0-1.6-.14-2.17-.42v-1.2c.36.16.74.3 1.14.38.4.1.78.15 1.13.15.5 0 .88-.1 1.12-.3a.94.94 0 0 0 .35-.77.98.98 0 0 0-.33-.74c-.22-.2-.68-.44-1.37-.72-.72-.3-1.22-.62-1.52-1C.23 8.27.1 7.82.1 7.3c0-.65.22-1.17.7-1.55.46-.37 1.08-.56 1.86-.56.76 0 1.5.16 2.25.48l-.4 1.05c-.7-.3-1.32-.44-1.87-.44-.4 0-.73.08-.94.26a.9.9 0 0 0-.33.72c0 .2.04.38.12.52.08.15.22.3.42.4.2.14.55.3 1.06.52.58.24 1 .47 1.27.67.27.2.47.44.6.7.12.26.18.57.18.92zM9 13.27c-.92 0-1.64-.27-2.16-.8-.52-.55-.78-1.3-.78-2.24 0-.97.24-1.73.72-2.3.5-.54 1.15-.82 2-.82.78 0 1.4.25 1.85.72.46.48.7 1.14.7 1.97v.67H7.35c0 .58.17 1.02.46 1.33.3.3.7.47 1.24.47.36 0 .68-.04.98-.1a5.1 5.1 0 0 0 .98-.33v1.02a3.87 3.87 0 0 1-.94.32 5.72 5.72 0 0 1-1.08.1zm-.22-5.2c-.4 0-.73.12-.97.38s-.37.62-.42 1.1h2.7c0-.48-.13-.85-.36-1.1-.23-.26-.54-.38-.94-.38zm7.7 5.1l-.26-.84h-.05c-.28.36-.57.6-.86.74-.28.13-.65.2-1.1.2-.6 0-1.05-.16-1.38-.48-.32-.32-.5-.77-.5-1.34 0-.62.24-1.08.7-1.4.45-.3 1.14-.47 2.07-.5l1.02-.03V9.2c0-.37-.1-.65-.27-.84-.17-.2-.45-.28-.82-.28-.3 0-.6.04-.88.13a6.68 6.68 0 0 0-.8.33l-.4-.9a4.4 4.4 0 0 1 1.05-.4 4.86 4.86 0 0 1 1.08-.12c.76 0 1.33.18 1.7.5.4.33.6.85.6 1.56v4h-.9zm-1.9-.87c.47 0 .83-.13 1.1-.38.3-.26.43-.62.43-1.08v-.52l-.76.03c-.6.03-1.02.13-1.3.3s-.4.45-.4.82c0 .26.08.47.24.6.16.16.4.23.7.23zm7.57-5.2c.25 0 .46.03.62.06l-.12 1.18a2.38 2.38 0 0 0-.56-.06c-.5 0-.92.16-1.24.5-.3.32-.47.75-.47 1.27v3.1h-1.27V7.23h1l.16 1.05h.05c.2-.36.45-.64.77-.85a1.83 1.83 0 0 1 1.02-.3zm4.12 6.17c-.9 0-1.58-.27-2.05-.8-.47-.52-.7-1.27-.7-2.25 0-1 .24-1.77.73-2.3.5-.54 1.2-.8 2.12-.8.63 0 1.2.1 1.7.34l-.4 1c-.52-.2-.96-.3-1.3-.3-1.04 0-1.55.68-1.55 2.05 0 .67.13 1.17.38 1.5.26.34.64.5 1.13.5a3.23 3.23 0 0 0 1.6-.4v1.1a2.53 2.53 0 0 1-.73.28 4.36 4.36 0 0 1-.93.08zm8.28-.1h-1.27V9.5c0-.45-.1-.8-.28-1.02-.18-.23-.47-.34-.88-.34-.53 0-.9.16-1.16.48-.25.3-.38.85-.38 1.6v2.94h-1.26V4.8h1.26v2.12c0 .34-.02.7-.06 1.1h.08a1.76 1.76 0 0 1 .72-.67c.3-.16.66-.24 1.07-.24 1.43 0 2.15.74 2.15 2.2v3.86zM42.2 7.1c.74 0 1.32.28 1.73.82.4.53.62 1.3.62 2.26 0 .97-.2 1.73-.63 2.27-.42.54-1 .82-1.75.82s-1.33-.27-1.75-.8h-.08l-.23.7h-.94V4.8h1.26v2l-.02.64-.03.56h.05c.4-.6 1-.9 1.78-.9zm-.33 1.04c-.5 0-.88.15-1.1.45-.22.3-.34.8-.35 1.5v.08c0 .72.12 1.24.35 1.57.23.32.6.48 1.12.48.44 0 .78-.17 1-.53.24-.35.36-.87.36-1.53 0-1.35-.47-2.03-1.4-2.03zm3.24-.92h1.4l1.2 3.37c.18.47.3.92.36 1.34h.04l.18-.72 1.37-4H51l-2.53 6.73c-.46 1.23-1.23 1.85-2.3 1.85-.3 0-.56-.03-.83-.1v-1c.2.05.4.08.65.08.6 0 1.03-.36 1.28-1.06l.22-.56-2.4-5.94z'/%3E%3C/g%3E%3C/svg%3E");
+ background-repeat: no-repeat;
+ background-position: center;
+ background-size: 100%;
+ overflow: hidden;
+ text-indent: -9000px;
+ width: 110px;
+ height: 100%;
+ display: block;
+ margin-left: auto;
+ margin-right: 5px;
+}
diff --git a/apps/docs/src/theme/SearchBar/index.js b/apps/docs/src/theme/SearchBar/index.js
new file mode 100644
index 000000000..3c59678f8
--- /dev/null
+++ b/apps/docs/src/theme/SearchBar/index.js
@@ -0,0 +1,114 @@
+import React, { useRef, useCallback, useState } from "react";
+import classnames from "classnames";
+import { useHistory } from "@docusaurus/router";
+import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
+import { usePluginData } from '@docusaurus/useGlobalData';
+import useIsBrowser from "@docusaurus/useIsBrowser";
+const Search = props => {
+ const initialized = useRef(false);
+ const searchBarRef = useRef(null);
+ const [indexReady, setIndexReady] = useState(false);
+ const history = useHistory();
+ const { siteConfig = {} } = useDocusaurusContext();
+ const isBrowser = useIsBrowser();
+ const { baseUrl } = siteConfig;
+ const initAlgolia = (searchDocs, searchIndex, DocSearch) => {
+ new DocSearch({
+ searchDocs,
+ searchIndex,
+ baseUrl,
+ inputSelector: "#search_input_react",
+ // Override algolia's default selection event, allowing us to do client-side
+ // navigation and avoiding a full page refresh.
+ handleSelected: (_input, _event, suggestion) => {
+ const url = suggestion.url || "/";
+ // Use an anchor tag to parse the absolute url into a relative url
+ // Alternatively, we can use new URL(suggestion.url) but its not supported in IE
+ const a = document.createElement("a");
+ a.href = url;
+ // Algolia use closest parent element id #__docusaurus when a h1 page title does not have an id
+ // So, we can safely remove it. See https://github.com/facebook/docusaurus/issues/1828 for more details.
+
+ history.push(url);
+ }
+ });
+ };
+
+ const pluginData = usePluginData('docusaurus-lunr-search');
+ const getSearchDoc = () =>
+ process.env.NODE_ENV === "production"
+ ? fetch(`${baseUrl}${pluginData.fileNames.searchDoc}`).then((content) => content.json())
+ : Promise.resolve([]);
+
+ const getLunrIndex = () =>
+ process.env.NODE_ENV === "production"
+ ? fetch(`${baseUrl}${pluginData.fileNames.lunrIndex}`).then((content) => content.json())
+ : Promise.resolve([]);
+
+ const loadAlgolia = () => {
+ if (!initialized.current) {
+ Promise.all([
+ getSearchDoc(),
+ getLunrIndex(),
+ import("./DocSearch"),
+ import("./algolia.css")
+ ]).then(([searchDocs, searchIndex, { default: DocSearch }]) => {
+ if (searchDocs.length === 0) {
+ return;
+ }
+ initAlgolia(searchDocs, searchIndex, DocSearch);
+ setIndexReady(true);
+ });
+ initialized.current = true;
+ }
+ };
+
+ const toggleSearchIconClick = useCallback(
+ e => {
+ if (!searchBarRef.current.contains(e.target)) {
+ searchBarRef.current.focus();
+ }
+
+ props.handleSearchBarToggle && props.handleSearchBarToggle(!props.isSearchBarExpanded);
+ },
+ [props.isSearchBarExpanded]
+ );
+
+ if (isBrowser) {
+ loadAlgolia();
+ }
+
+ return (
+ <div className="navbar__search" key="search-box">
+ <span
+ aria-label="expand searchbar"
+ role="button"
+ className={classnames("search-icon", {
+ "search-icon-hidden": props.isSearchBarExpanded
+ })}
+ onClick={toggleSearchIconClick}
+ onKeyDown={toggleSearchIconClick}
+ tabIndex={0}
+ />
+ <input
+ id="search_input_react"
+ type="search"
+ placeholder={indexReady ? 'Search' : 'Loading...'}
+ aria-label="Search"
+ className={classnames(
+ "navbar__search-input",
+ { "search-bar-expanded": props.isSearchBarExpanded },
+ { "search-bar": !props.isSearchBarExpanded }
+ )}
+ onClick={loadAlgolia}
+ onMouseOver={loadAlgolia}
+ onFocus={toggleSearchIconClick}
+ onBlur={toggleSearchIconClick}
+ ref={searchBarRef}
+ disabled={!indexReady}
+ />
+ </div>
+ );
+};
+
+export default Search;
diff --git a/apps/docs/src/theme/SearchBar/lunar-search.js b/apps/docs/src/theme/SearchBar/lunar-search.js
new file mode 100644
index 000000000..25681f486
--- /dev/null
+++ b/apps/docs/src/theme/SearchBar/lunar-search.js
@@ -0,0 +1,147 @@
+import lunr from "@generated/lunr.client";
+lunr.tokenizer.separator = /[\s\-/]+/;
+
+class LunrSearchAdapter {
+ constructor(searchDocs, searchIndex, baseUrl = '/') {
+ this.searchDocs = searchDocs;
+ this.lunrIndex = lunr.Index.load(searchIndex);
+ this.baseUrl = baseUrl;
+ }
+
+ getLunrResult(input) {
+ return this.lunrIndex.query(function (query) {
+ const tokens = lunr.tokenizer(input);
+ query.term(tokens, {
+ boost: 10
+ });
+ query.term(tokens, {
+ wildcard: lunr.Query.wildcard.TRAILING
+ });
+ });
+ }
+
+ getHit(doc, formattedTitle, formattedContent) {
+ return {
+ hierarchy: {
+ lvl0: doc.pageTitle || doc.title,
+ lvl1: doc.type === 0 ? null : doc.title
+ },
+ url: doc.url,
+ _snippetResult: formattedContent ? {
+ content: {
+ value: formattedContent,
+ matchLevel: "full"
+ }
+ } : null,
+ _highlightResult: {
+ hierarchy: {
+ lvl0: {
+ value: doc.type === 0 ? formattedTitle || doc.title : doc.pageTitle,
+ },
+ lvl1:
+ doc.type === 0
+ ? null
+ : {
+ value: formattedTitle || doc.title
+ }
+ }
+ }
+ };
+ }
+ getTitleHit(doc, position, length) {
+ const start = position[0];
+ const end = position[0] + length;
+ let formattedTitle = doc.title.substring(0, start) + '<span class="algolia-docsearch-suggestion--highlight">' + doc.title.substring(start, end) + '</span>' + doc.title.substring(end, doc.title.length);
+ return this.getHit(doc, formattedTitle)
+ }
+
+ getKeywordHit(doc, position, length) {
+ const start = position[0];
+ const end = position[0] + length;
+ let formattedTitle = doc.title + '<br /><i>Keywords: ' + doc.keywords.substring(0, start) + '<span class="algolia-docsearch-suggestion--highlight">' + doc.keywords.substring(start, end) + '</span>' + doc.keywords.substring(end, doc.keywords.length) + '</i>'
+ return this.getHit(doc, formattedTitle)
+ }
+
+ getContentHit(doc, position) {
+ const start = position[0];
+ const end = position[0] + position[1];
+ let previewStart = start;
+ let previewEnd = end;
+ let ellipsesBefore = true;
+ let ellipsesAfter = true;
+ for (let k = 0; k < 3; k++) {
+ const nextSpace = doc.content.lastIndexOf(' ', previewStart - 2);
+ const nextDot = doc.content.lastIndexOf('.', previewStart - 2);
+ if ((nextDot > 0) && (nextDot > nextSpace)) {
+ previewStart = nextDot + 1;
+ ellipsesBefore = false;
+ break;
+ }
+ if (nextSpace < 0) {
+ previewStart = 0;
+ ellipsesBefore = false;
+ break;
+ }
+ previewStart = nextSpace + 1;
+ }
+ for (let k = 0; k < 10; k++) {
+ const nextSpace = doc.content.indexOf(' ', previewEnd + 1);
+ const nextDot = doc.content.indexOf('.', previewEnd + 1);
+ if ((nextDot > 0) && (nextDot < nextSpace)) {
+ previewEnd = nextDot;
+ ellipsesAfter = false;
+ break;
+ }
+ if (nextSpace < 0) {
+ previewEnd = doc.content.length;
+ ellipsesAfter = false;
+ break;
+ }
+ previewEnd = nextSpace;
+ }
+ let preview = doc.content.substring(previewStart, start);
+ if (ellipsesBefore) {
+ preview = '... ' + preview;
+ }
+ preview += '<span class="algolia-docsearch-suggestion--highlight">' + doc.content.substring(start, end) + '</span>';
+ preview += doc.content.substring(end, previewEnd);
+ if (ellipsesAfter) {
+ preview += ' ...';
+ }
+ return this.getHit(doc, null, preview);
+
+ }
+ search(input) {
+ return new Promise((resolve, rej) => {
+ const results = this.getLunrResult(input);
+ const hits = [];
+ results.length > 5 && (results.length = 5);
+ this.titleHitsRes = []
+ this.contentHitsRes = []
+ results.forEach(result => {
+ const doc = this.searchDocs[result.ref];
+ const { metadata } = result.matchData;
+ for (let i in metadata) {
+ if (metadata[i].title) {
+ if (!this.titleHitsRes.includes(result.ref)) {
+ const position = metadata[i].title.position[0]
+ hits.push(this.getTitleHit(doc, position, input.length));
+ this.titleHitsRes.push(result.ref);
+ }
+ } else if (metadata[i].content) {
+ const position = metadata[i].content.position[0]
+ hits.push(this.getContentHit(doc, position))
+ } else if (metadata[i].keywords) {
+ const position = metadata[i].keywords.position[0]
+ hits.push(this.getKeywordHit(doc, position, input.length));
+ this.titleHitsRes.push(result.ref);
+ }
+ }
+ });
+ hits.length > 5 && (hits.length = 5);
+ resolve(hits);
+ });
+ }
+}
+
+export default LunrSearchAdapter;
diff --git a/apps/docs/src/theme/SearchBar/styles.css b/apps/docs/src/theme/SearchBar/styles.css
new file mode 100644
index 000000000..8dc3b0a12
--- /dev/null
+++ b/apps/docs/src/theme/SearchBar/styles.css
@@ -0,0 +1,33 @@
+.search-icon {
+ background-image: var(--ifm-navbar-search-input-icon);
+ height: auto;
+ width: 24px;
+ cursor: pointer;
+ padding: 8px;
+ line-height: 32px;
+ background-repeat: no-repeat;
+ background-position: center;
+ display: none;
+}
+
+.search-icon-hidden {
+ visibility: hidden;
+}
+
+@media (max-width: 360px) {
+ .search-bar {
+ width: 0 !important;
+ background: none !important;
+ padding: 0 !important;
+ transition: none !important;
+ }
+
+ .search-bar-expanded {
+ width: 9rem !important;
+ }
+
+ .search-icon {
+ display: inline;
+ vertical-align: sub;
+ }
+}
diff --git a/apps/docs/src/theme/SearchBar/templates.js b/apps/docs/src/theme/SearchBar/templates.js
new file mode 100644
index 000000000..1485e7858
--- /dev/null
+++ b/apps/docs/src/theme/SearchBar/templates.js
@@ -0,0 +1,112 @@
+const prefix = 'algolia-docsearch';
+const suggestionPrefix = `${prefix}-suggestion`;
+const footerPrefix = `${prefix}-footer`;
+
+const templates = {
+ suggestion: `
+ <a class="${suggestionPrefix}
+ {{#isCategoryHeader}}${suggestionPrefix}__main{{/isCategoryHeader}}
+ {{#isSubCategoryHeader}}${suggestionPrefix}__secondary{{/isSubCategoryHeader}}
+ "
+ aria-label="Link to the result"
+ href="{{{url}}}"
+ >
+ <div class="${suggestionPrefix}--category-header">
+ <span class="${suggestionPrefix}--category-header-lvl0">{{{category}}}</span>
+ </div>
+ <div class="${suggestionPrefix}--wrapper">
+ <div class="${suggestionPrefix}--subcategory-column">
+ <span class="${suggestionPrefix}--subcategory-column-text">{{{subcategory}}}</span>
+ </div>
+ {{#isTextOrSubcategoryNonEmpty}}
+ <div class="${suggestionPrefix}--content">
+ <div class="${suggestionPrefix}--subcategory-inline">{{{subcategory}}}</div>
+ <div class="${suggestionPrefix}--title">{{{title}}}</div>
+ {{#text}}<div class="${suggestionPrefix}--text">{{{text}}}</div>{{/text}}
+ </div>
+ {{/isTextOrSubcategoryNonEmpty}}
+ </div>
+ </a>
+ `,
+ suggestionSimple: `
+ <div class="${suggestionPrefix}
+ {{#isCategoryHeader}}${suggestionPrefix}__main{{/isCategoryHeader}}
+ {{#isSubCategoryHeader}}${suggestionPrefix}__secondary{{/isSubCategoryHeader}}
+ suggestion-layout-simple
+ ">
+ <div class="${suggestionPrefix}--category-header">
+ {{^isLvl0}}
+ <span class="${suggestionPrefix}--category-header-lvl0 ${suggestionPrefix}--category-header-item">{{{category}}}</span>
+ {{^isLvl1}}
+ {{^isLvl1EmptyOrDuplicate}}
+ <span class="${suggestionPrefix}--category-header-lvl1 ${suggestionPrefix}--category-header-item">
+ {{{subcategory}}}
+ </span>
+ {{/isLvl1EmptyOrDuplicate}}
+ {{/isLvl1}}
+ {{/isLvl0}}
+ <div class="${suggestionPrefix}--title ${suggestionPrefix}--category-header-item">
+ {{#isLvl2}}
+ {{{title}}}
+ {{/isLvl2}}
+ {{#isLvl1}}
+ {{{subcategory}}}
+ {{/isLvl1}}
+ {{#isLvl0}}
+ {{{category}}}
+ {{/isLvl0}}
+ </div>
+ </div>
+ <div class="${suggestionPrefix}--wrapper">
+ {{#text}}
+ <div class="${suggestionPrefix}--content">
+ <div class="${suggestionPrefix}--text">{{{text}}}</div>
+ </div>
+ {{/text}}
+ </div>
+ </div>
+ `,
+ footer: `
+ <div class="${footerPrefix}">
+ </div>
+ `,
+ empty: `
+ <div class="${suggestionPrefix}">
+ <div class="${suggestionPrefix}--wrapper">
+ <div class="${suggestionPrefix}--content ${suggestionPrefix}--no-results">
+ <div class="${suggestionPrefix}--title">
+ <div class="${suggestionPrefix}--text">
+ No results found for query <b>"{{query}}"</b>
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+ `,
+ searchBox: `
+ <form novalidate="novalidate" onsubmit="return false;" class="searchbox">
+ <div role="search" class="searchbox__wrapper">
+ <input id="docsearch" type="search" name="search" placeholder="Search the docs" autocomplete="off" required="required" class="searchbox__input"/>
+ <button type="submit" title="Submit your search query." class="searchbox__submit" >
+ <svg width=12 height=12 role="img" aria-label="Search">
+ <use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#sbx-icon-search-13"></use>
+ </svg>
+ </button>
+ <button type="reset" title="Clear the search query." class="searchbox__reset hide">
+ <svg width=12 height=12 role="img" aria-label="Reset">
+ <use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#sbx-icon-clear-3"></use>
+ </svg>
+ </button>
+ </div>
+</form>
+
+<div class="svg-icons" style="height: 0; width: 0; position: absolute; visibility: hidden">
+ <svg xmlns="http://www.w3.org/2000/svg">
+ <symbol id="sbx-icon-clear-3" viewBox="0 0 40 40"><path d="M16.228 20L1.886 5.657 0 3.772 3.772 0l1.885 1.886L20 16.228 34.343 1.886 36.228 0 40 3.772l-1.886 1.885L23.772 20l14.342 14.343L40 36.228 36.228 40l-1.885-1.886L20 23.772 5.657 38.114 3.772 40 0 36.228l1.886-1.885L16.228 20z" fill-rule="evenodd"></symbol>
+ <symbol id="sbx-icon-search-13" viewBox="0 0 40 40"><path d="M26.806 29.012a16.312 16.312 0 0 1-10.427 3.746C7.332 32.758 0 25.425 0 16.378 0 7.334 7.333 0 16.38 0c9.045 0 16.378 7.333 16.378 16.38 0 3.96-1.406 7.593-3.746 10.426L39.547 37.34c.607.608.61 1.59-.004 2.203a1.56 1.56 0 0 1-2.202.004L26.807 29.012zm-10.427.627c7.322 0 13.26-5.938 13.26-13.26 0-7.324-5.938-13.26-13.26-13.26-7.324 0-13.26 5.936-13.26 13.26 0 7.322 5.936 13.26 13.26 13.26z" fill-rule="evenodd"></symbol>
+ </svg>
+</div>
+ `,
+};
+
+export default templates;
diff --git a/apps/docs/src/theme/SearchBar/utils.js b/apps/docs/src/theme/SearchBar/utils.js
new file mode 100644
index 000000000..0807500d7
--- /dev/null
+++ b/apps/docs/src/theme/SearchBar/utils.js
@@ -0,0 +1,270 @@
+import $ from "autocomplete.js/zepto";
+
+const utils = {
+ /*
+ * Move the content of an object key one level higher.
+ * eg.
+ * {
+ * name: 'My name',
+ * hierarchy: {
+ * lvl0: 'Foo',
+ * lvl1: 'Bar'
+ * }
+ * }
+ * Will be converted to
+ * {
+ * name: 'My name',
+ * lvl0: 'Foo',
+ * lvl1: 'Bar'
+ * }
+ * @param {Object} object Main object
+ * @param {String} property Main object key to move up
+ * @return {Object}
+ * @throws Error when key is not an attribute of Object or is not an object itself
+ */
+ mergeKeyWithParent(object, property) {
+ if (object[property] === undefined) {
+ return object;
+ }
+ if (typeof object[property] !== 'object') {
+ return object;
+ }
+ const newObject = $.extend({}, object, object[property]);
+ delete newObject[property];
+ return newObject;
+ },
+ /*
+ * Group all objects of a collection by the value of the specified attribute
+ * If the attribute is a string, use the lowercase form.
+ *
+ * eg.
+ * groupBy([
+ * {name: 'Tim', category: 'dev'},
+ * {name: 'Vincent', category: 'dev'},
+ * {name: 'Ben', category: 'sales'},
+ * {name: 'Jeremy', category: 'sales'},
+ * {name: 'AlexS', category: 'dev'},
+ * {name: 'AlexK', category: 'sales'}
+ * ], 'category');
+ * =>
+ * {
+ * 'devs': [
+ * {name: 'Tim', category: 'dev'},
+ * {name: 'Vincent', category: 'dev'},
+ * {name: 'AlexS', category: 'dev'}
+ * ],
+ * 'sales': [
+ * {name: 'Ben', category: 'sales'},
+ * {name: 'Jeremy', category: 'sales'},
+ * {name: 'AlexK', category: 'sales'}
+ * ]
+ * }
+ * @param {array} collection Array of objects to group
+ * @param {String} property The attribute on which apply the grouping
+ * @return {array}
+ * @throws Error when one of the element does not have the specified property
+ */
+ groupBy(collection, property) {
+ const newCollection = {};
+ $.each(collection, (index, item) => {
+ if (item[property] === undefined) {
+ throw new Error(`[groupBy]: Object has no key ${property}`);
+ }
+ let key = item[property];
+ if (typeof key === 'string') {
+ key = key.toLowerCase();
+ }
+ // fix #171 the given data type of docsearch hits might be conflict with the properties of the native Object,
+ // such as the constructor, so we need to do this check.
+ if (!Object.prototype.hasOwnProperty.call(newCollection, key)) {
+ newCollection[key] = [];
+ }
+ newCollection[key].push(item);
+ });
+ return newCollection;
+ },
+ /*
+ * Return an array of all the values of the specified object
+ * eg.
+ * values({
+ * foo: 42,
+ * bar: true,
+ * baz: 'yep'
+ * })
+ * =>
+ * [42, true, yep]
+ * @param {object} object Object to extract values from
+ * @return {array}
+ */
+ values(object) {
+ return Object.keys(object).map(key => object[key]);
+ },
+ /*
+ * Flattens an array
+ * eg.
+ * flatten([1, 2, [3, 4], [5, 6]])
+ * =>
+ * [1, 2, 3, 4, 5, 6]
+ * @param {array} array Array to flatten
+ * @return {array}
+ */
+ flatten(array) {
+ const results = [];
+ array.forEach(value => {
+ if (!Array.isArray(value)) {
+ results.push(value);
+ return;
+ }
+ value.forEach(subvalue => {
+ results.push(subvalue);
+ });
+ });
+ return results;
+ },
+ /*
+ * Flatten all values of an object into an array, marking each first element of
+ * each group with a specific flag
+ * eg.
+ * flattenAndFlagFirst({
+ * 'devs': [
+ * {name: 'Tim', category: 'dev'},
+ * {name: 'Vincent', category: 'dev'},
+ * {name: 'AlexS', category: 'dev'}
+ * ],
+ * 'sales': [
+ * {name: 'Ben', category: 'sales'},
+ * {name: 'Jeremy', category: 'sales'},
+ * {name: 'AlexK', category: 'sales'}
+ * ]
+ * , 'isTop');
+ * =>
+ * [
+ * {name: 'Tim', category: 'dev', isTop: true},
+ * {name: 'Vincent', category: 'dev', isTop: false},
+ * {name: 'AlexS', category: 'dev', isTop: false},
+ * {name: 'Ben', category: 'sales', isTop: true},
+ * {name: 'Jeremy', category: 'sales', isTop: false},
+ * {name: 'AlexK', category: 'sales', isTop: false}
+ * ]
+ * @param {object} object Object to flatten
+ * @param {string} flag Flag to set to true on first element of each group
+ * @return {array}
+ */
+ flattenAndFlagFirst(object, flag) {
+ const values = this.values(object).map(collection =>
+ collection.map((item, index) => {
+ // eslint-disable-next-line no-param-reassign
+ item[flag] = index === 0;
+ return item;
+ })
+ );
+ return this.flatten(values);
+ },
+ /*
+ * Removes all empty strings, null, false and undefined elements array
+ * eg.
+ * compact([42, false, null, undefined, '', [], 'foo']);
+ * =>
+ * [42, [], 'foo']
+ * @param {array} array Array to compact
+ * @return {array}
+ */
+ compact(array) {
+ const results = [];
+ array.forEach(value => {
+ if (!value) {
+ return;
+ }
+ results.push(value);
+ });
+ return results;
+ },
+ /*
+ * Returns the highlighted value of the specified key in the specified object.
+ * If no highlighted value is available, will return the key value directly
+ * eg.
+ * getHighlightedValue({
+ * _highlightResult: {
+ * text: {
+ * value: '<mark>foo</mark>'
+ * }
+ * },
+ * text: 'foo'
+ * }, 'text');
+ * =>
+ * '<mark>foo</mark>'
+ * @param {object} object Hit object returned by the Algolia API
+ * @param {string} property Object key to look for
+ * @return {string}
+ **/
+ getHighlightedValue(object, property) {
+ if (
+ object._highlightResult &&
+ object._highlightResult.hierarchy_camel &&
+ object._highlightResult.hierarchy_camel[property] &&
+ object._highlightResult.hierarchy_camel[property].matchLevel &&
+ object._highlightResult.hierarchy_camel[property].matchLevel !== 'none' &&
+ object._highlightResult.hierarchy_camel[property].value
+ ) {
+ return object._highlightResult.hierarchy_camel[property].value;
+ }
+ if (
+ object._highlightResult &&
+ object._highlightResult &&
+ object._highlightResult[property] &&
+ object._highlightResult[property].value
+ ) {
+ return object._highlightResult[property].value;
+ }
+ return object[property];
+ },
+ /*
+ * Returns the snippeted value of the specified key in the specified object.
+ * If no highlighted value is available, will return the key value directly.
+ * Will add starting and ending ellipsis (…) if we detect that a sentence is
+ * incomplete
+ * eg.
+ * getSnippetedValue({
+ * _snippetResult: {
+ * text: {
+ * value: '<mark>This is an unfinished sentence</mark>'
+ * }
+ * },
+ * text: 'This is an unfinished sentence'
+ * }, 'text');
+ * =>
+ * '<mark>This is an unfinished sentence</mark>…'
+ * @param {object} object Hit object returned by the Algolia API
+ * @param {string} property Object key to look for
+ * @return {string}
+ **/
+ getSnippetedValue(object, property) {
+ if (
+ !object._snippetResult ||
+ !object._snippetResult[property] ||
+ !object._snippetResult[property].value
+ ) {
+ return object[property];
+ }
+ let snippet = object._snippetResult[property].value;
+
+ if (snippet[0] !== snippet[0].toUpperCase()) {
+ snippet = `…${snippet}`;
+ }
+ if (['.', '!', '?'].indexOf(snippet[snippet.length - 1]) === -1) {
+ snippet = `${snippet}…`;
+ }
+ return snippet;
+ },
+ /*
+ * Deep clone an object.
+ * Note: This will not clone functions and dates
+ * @param {object} object Object to clone
+ * @return {object}
+ */
+ deepClone(object) {
+ return JSON.parse(JSON.stringify(object));
+ },
+};
+
+export default utils;
--
GitLab