diff --git a/apps/docs/docs/advanced.md b/apps/docs/docs/advanced.md deleted file mode 100644 index 805d0362410937db47154169bc9c162e1dfde8b9..0000000000000000000000000000000000000000 --- a/apps/docs/docs/advanced.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Advanced Features - -## Sub Question Query Engine - -The basic concept of the Sub Question Query Engine is that it splits a single query into multiple queries, gets an answer for each of those queries, and then combines those different answers into a single coherent response for the user. You can think of it as the "think this through step by step" prompt technique but iterating over your data sources! - -### Getting Started - -The easiest way to start trying the Sub Question Query Engine is running the subquestion.ts file in apps/simple. - -```bash -npx ts-node subquestion.ts -``` - -### Tools - -SubQuestionQueryEngine is implemented with Tools. The basic idea of Tools is that they are executable options for the large language model. In this case, our SubQuestionQueryEngine relies on QueryEngineTool, which as you guessed it is a tool to run queries on a QueryEngine. This allows us to give the model an option to query different documents for different questions for example. You could also imagine that the SubQuestionQueryEngine could use a Tool that searches for something on the web or gets an answer using Wolfram Alpha. - -You can learn more about Tools by taking a look at the LlamaIndex Python documentation https://gpt-index.readthedocs.io/en/latest/core_modules/agent_modules/tools/root.html - -## ListIndexLLMRetriever - -Todo: Insert text. diff --git a/apps/docs/docs/api/_category_.yml b/apps/docs/docs/api/_category_.yml index 79eb4b8a2939888be2393145205ffe6bc5fea186..01a5012291c203b622c44e6ed330e4b075c3291a 100644 --- a/apps/docs/docs/api/_category_.yml +++ b/apps/docs/docs/api/_category_.yml @@ -1,2 +1,2 @@ label: "API" -position: 6 \ No newline at end of file +position: 4 \ No newline at end of file diff --git a/apps/docs/docs/api/classes/BaseEmbedding.md b/apps/docs/docs/api/classes/BaseEmbedding.md index cab4ba366980637ff4ca70724080ade199ee3391..4a40464bd7391d225b3a552348799a5571eba665 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/f1d609d/packages/core/src/Embedding.ts#L206) +[Embedding.ts:206](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L206) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[Embedding.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Embedding.ts#L205) +[Embedding.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L205) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Embedding.ts#L197) +[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 04b093c46d163a73f5a4ed022056d7540ab809a9..d1ac95413dcb76e5a6487b1768d4b4af005c22a0 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 -[BaseIndex.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L80) +[BaseIndex.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L80) ## Properties @@ -53,7 +53,7 @@ they can be retrieved for our queries. #### Defined in -[BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L75) +[BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L75) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[BaseIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L77) +[BaseIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L77) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -[BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L78) +[BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L78) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -[BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L73) +[BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L73) ___ @@ -93,7 +93,7 @@ ___ #### Defined in -[BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L74) +[BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L74) ___ @@ -103,7 +103,7 @@ ___ #### Defined in -[BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L76) +[BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L76) ## Methods @@ -117,4 +117,4 @@ ___ #### Defined in -[BaseIndex.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L89) +[BaseIndex.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L89) diff --git a/apps/docs/docs/api/classes/BaseNode.md b/apps/docs/docs/api/classes/BaseNode.md index e4411d4408b86766dcba5fe8f6da7b4742969117..2489001e8f89869259f0e34492091f9360817060 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/f1d609d/packages/core/src/Node.ts#L48) +[Node.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L39) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L43) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L44) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L46) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L38) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L42) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L45) ## Accessors @@ -112,7 +112,7 @@ ___ #### Defined in -[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L104) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L84) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L58) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L94) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L72) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L62) ## Methods @@ -196,7 +196,7 @@ ___ #### Defined in -[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L124) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L54) +[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L54) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L116) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L55) +[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L55) ___ @@ -264,7 +264,7 @@ ___ #### Defined in -[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L52) +[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L52) ___ @@ -284,4 +284,4 @@ ___ #### Defined in -[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L56) +[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 62ec87c78c839135ddcb612c791c767b677c093e..876bcc0a5591d3745c754cc29ccfb0c18a57438f 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/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L68) +[callbacks/CallbackManager.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L65) +[callbacks/CallbackManager.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L66) +[callbacks/CallbackManager.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L66) diff --git a/apps/docs/docs/api/classes/ChatGPTLLMPredictor.md b/apps/docs/docs/api/classes/ChatGPTLLMPredictor.md index 8f9b271af7edb5dd2589268a04bae47e460d5d22..5789572dead1e5b53fbb0bd690526c113544f592 100644 --- a/apps/docs/docs/api/classes/ChatGPTLLMPredictor.md +++ b/apps/docs/docs/api/classes/ChatGPTLLMPredictor.md @@ -26,7 +26,7 @@ ChatGPTLLMPredictor is a predictor that uses GPT. #### Defined in -[LLMPredictor.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLMPredictor.ts#L26) +[LLMPredictor.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L26) ## Properties @@ -36,7 +36,7 @@ ChatGPTLLMPredictor is a predictor that uses GPT. #### Defined in -[LLMPredictor.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLMPredictor.ts#L24) +[LLMPredictor.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L24) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[LLMPredictor.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLMPredictor.ts#L23) +[LLMPredictor.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L23) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[LLMPredictor.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLMPredictor.ts#L21) +[LLMPredictor.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L21) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[LLMPredictor.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLMPredictor.ts#L22) +[LLMPredictor.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L22) ## Methods @@ -92,7 +92,7 @@ ___ #### Defined in -[LLMPredictor.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLMPredictor.ts#L49) +[LLMPredictor.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L49) ___ @@ -110,4 +110,4 @@ ___ #### Defined in -[LLMPredictor.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLMPredictor.ts#L45) +[LLMPredictor.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L45) diff --git a/apps/docs/docs/api/classes/CompactAndRefine.md b/apps/docs/docs/api/classes/CompactAndRefine.md index 1335b99f214138903e0e8da7d4c8c54bf9dafa3e..30da0122115c35c4b34bbdc4995bd2037ad54dbe 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:66](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L66) +[ResponseSynthesizer.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L66) ## Properties @@ -48,7 +48,7 @@ CompactAndRefine is a slight variation of Refine that first compacts the text ch #### Defined in -[ResponseSynthesizer.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L64) +[ResponseSynthesizer.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L64) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L62) +[ResponseSynthesizer.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L62) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L63) +[ResponseSynthesizer.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L63) ## Methods @@ -102,4 +102,4 @@ ___ #### Defined in -[ResponseSynthesizer.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L152) +[ResponseSynthesizer.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L152) diff --git a/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md b/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md index 8089232b53a565d08ef3ac166bcf7221465a2ba5..91dd9a66b439452a22cb8ac67628a00b21cbc990 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/f1d609d/packages/core/src/ChatEngine.ts#L75) +[ChatEngine.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/ChatEngine.ts#L71) +[ChatEngine.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L71) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ChatEngine.ts#L73) +[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L73) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ChatEngine.ts#L70) +[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L70) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ChatEngine.ts#L72) +[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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:104](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ChatEngine.ts#L104) +[ChatEngine.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L104) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ChatEngine.ts#L89) +[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L89) ___ @@ -145,4 +145,4 @@ Resets the chat history so that it's empty. #### Defined in -[ChatEngine.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ChatEngine.ts#L123) +[ChatEngine.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L123) diff --git a/apps/docs/docs/api/classes/ContextChatEngine.md b/apps/docs/docs/api/classes/ContextChatEngine.md index 2ff5c94af1ff40b6defaf1b8d418f6b2d15b93f2..331f26de123c01e10edfaa1ddcd1f6ffff9df7a8 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:138](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ChatEngine.ts#L138) +[ChatEngine.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L138) ## Properties @@ -41,7 +41,7 @@ ideally allowing the appropriate context to be surfaced for each query. #### Defined in -[ChatEngine.ts:136](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ChatEngine.ts#L136) +[ChatEngine.ts:136](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L136) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[ChatEngine.ts:135](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ChatEngine.ts#L135) +[ChatEngine.ts:135](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L135) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[ChatEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ChatEngine.ts#L134) +[ChatEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L134) ## Methods @@ -88,7 +88,7 @@ Send message along with the class's current chat history to the LLM. #### Defined in -[ChatEngine.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ChatEngine.ts#L153) +[ChatEngine.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L153) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[ChatEngine.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ChatEngine.ts#L149) +[ChatEngine.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L149) ___ @@ -122,4 +122,4 @@ Resets the chat history so that it's empty. #### Defined in -[ChatEngine.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ChatEngine.ts#L191) +[ChatEngine.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L191) diff --git a/apps/docs/docs/api/classes/Document.md b/apps/docs/docs/api/classes/Document.md index c3d007c7484ea2177acc6353404d9a73b9311ac4..b920ca6c779e4522f0b7740970192424436d8a7f 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/f1d609d/packages/core/src/Node.ts#L216) +[Node.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L139) +[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L139) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L44) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L46) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L38) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L42) ___ @@ -144,7 +144,7 @@ ___ #### Defined in -[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L142) +[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L142) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L45) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L138) +[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L138) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L137) +[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L104) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[Node.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L225) +[Node.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L225) ___ @@ -236,7 +236,7 @@ TextNode.nextNode #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L84) ___ @@ -254,7 +254,7 @@ TextNode.nodeId #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L58) ___ @@ -272,7 +272,7 @@ TextNode.parentNode #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L94) ___ @@ -290,7 +290,7 @@ TextNode.prevNode #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L72) ___ @@ -308,7 +308,7 @@ TextNode.sourceNode #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L124) ___ @@ -344,7 +344,7 @@ ___ #### Defined in -[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L149) +[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L149) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L157) +[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L157) ___ @@ -386,7 +386,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L116) ___ @@ -410,7 +410,7 @@ ___ #### Defined in -[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L162) +[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L162) ___ @@ -433,7 +433,7 @@ ___ #### Defined in -[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L187) +[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L187) ___ @@ -451,7 +451,7 @@ ___ #### Defined in -[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L191) +[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L191) ___ @@ -469,7 +469,7 @@ ___ #### Defined in -[Node.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L221) +[Node.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L221) ___ @@ -493,4 +493,4 @@ ___ #### Defined in -[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L183) +[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 3ae4315a5ed1f279d8274f2f57025557c3068661..dc387b2a173cc97828e36da22437bcdce8a10459 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/f1d609d/packages/core/src/storage/FileSystem.ts#L25) +[storage/FileSystem.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/storage/FileSystem.ts#L38) +[storage/FileSystem.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L38) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/FileSystem.ts#L44) +[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L44) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/FileSystem.ts#L31) +[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L31) ___ @@ -126,4 +126,4 @@ ___ #### Defined in -[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/FileSystem.ts#L27) +[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 e7155ace6d6947bcce8d6f407b916c7f29240519..580ef2d79ca11245b31a43645deb0068acecbbd4 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 -[BaseIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L21) +[BaseIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L21) ## Properties @@ -43,7 +43,7 @@ The underlying structure of each index. #### Defined in -[BaseIndex.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L36) +[BaseIndex.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L36) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L18) +[BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L18) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[BaseIndex.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L35) +[BaseIndex.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L35) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L19) +[BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L19) ## Methods @@ -102,7 +102,7 @@ ___ #### Defined in -[BaseIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L45) +[BaseIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L45) ___ @@ -120,4 +120,4 @@ ___ #### Defined in -[BaseIndex.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L38) +[BaseIndex.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L38) diff --git a/apps/docs/docs/api/classes/IndexList.md b/apps/docs/docs/api/classes/IndexList.md index bcfded26ec509bcb04d600553727e49a1c7a32dd..23e17f73b7889c179df978e9fac1738a7ed3944c 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 -[BaseIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L21) +[BaseIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L21) ## Properties @@ -47,7 +47,7 @@ The underlying structure of each index. #### Defined in -[BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L18) +[BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L18) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[BaseIndex.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L52) +[BaseIndex.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L52) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L19) +[BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L19) ## Methods @@ -91,7 +91,7 @@ ___ #### Defined in -[BaseIndex.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L54) +[BaseIndex.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L54) ___ @@ -109,4 +109,4 @@ ___ #### Defined in -[BaseIndex.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L26) +[BaseIndex.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L26) diff --git a/apps/docs/docs/api/classes/IndexNode.md b/apps/docs/docs/api/classes/IndexNode.md index 7652490f42eb3ad8824b04531b99b5292ef7aaf0..38bd805fec3ee5d9cf94a3c2b0861f0572587d6c 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/f1d609d/packages/core/src/Node.ts#L144) +[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L139) +[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L139) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L44) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L46) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L38) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[Node.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L205) +[Node.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L205) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L42) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L142) +[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L142) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L45) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L138) +[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L138) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L137) +[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L104) ___ @@ -232,7 +232,7 @@ TextNode.nextNode #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L84) ___ @@ -250,7 +250,7 @@ TextNode.nodeId #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L58) ___ @@ -268,7 +268,7 @@ TextNode.parentNode #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L94) ___ @@ -286,7 +286,7 @@ TextNode.prevNode #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L72) ___ @@ -304,7 +304,7 @@ TextNode.sourceNode #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L124) ___ @@ -340,7 +340,7 @@ ___ #### Defined in -[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L149) +[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L149) ___ @@ -364,7 +364,7 @@ ___ #### Defined in -[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L157) +[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L157) ___ @@ -382,7 +382,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L116) ___ @@ -406,7 +406,7 @@ ___ #### Defined in -[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L162) +[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L162) ___ @@ -429,7 +429,7 @@ ___ #### Defined in -[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L187) +[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L187) ___ @@ -447,7 +447,7 @@ ___ #### Defined in -[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L191) +[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L191) ___ @@ -465,7 +465,7 @@ ___ #### Defined in -[Node.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L207) +[Node.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L207) ___ @@ -489,4 +489,4 @@ ___ #### Defined in -[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L183) +[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 70e00ae495d07125c555af4775e3ddab210a4f15..9babfc8f3f061e76cc85300fd79b32be73efa8c3 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 -[BaseIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L21) +[BaseIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L21) ## Properties @@ -41,7 +41,7 @@ The underlying structure of each index. #### Defined in -[BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L18) +[BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L18) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L19) +[BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L19) ## Methods @@ -65,4 +65,4 @@ ___ #### Defined in -[BaseIndex.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L26) +[BaseIndex.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L26) diff --git a/apps/docs/docs/api/classes/LLMQuestionGenerator.md b/apps/docs/docs/api/classes/LLMQuestionGenerator.md index 425f82c6982d30ba1fa03c61ef92d1c31ee52f67..40a0d019f1bbad83ef6aeade1e84340ce81d778b 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/f1d609d/packages/core/src/QuestionGenerator.ts#L34) +[QuestionGenerator.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/QuestionGenerator.ts#L30) +[QuestionGenerator.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QuestionGenerator.ts#L30) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QuestionGenerator.ts#L32) +[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QuestionGenerator.ts#L32) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QuestionGenerator.ts#L31) +[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QuestionGenerator.ts#L31) ## Methods @@ -81,4 +81,4 @@ ___ #### Defined in -[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QuestionGenerator.ts#L40) +[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 5f01e88a6e6de0ee1a1abf516f2a0b478fa7c6dd..278d53a64fc65a44a88e3c832b93b74420eab3f7 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 -[index/list/ListIndex.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndex.ts#L37) +[index/list/ListIndex.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L37) ## Properties @@ -46,7 +46,7 @@ A ListIndex keeps nodes in a sequential list structure #### Defined in -[BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L75) +[BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L75) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[BaseIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L77) +[BaseIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L77) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L78) +[BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L78) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L73) +[BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L73) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L74) +[BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L74) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L76) +[BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L76) ## Methods @@ -136,7 +136,7 @@ ___ #### Defined in -[index/list/ListIndex.ts:140](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndex.ts#L140) +[index/list/ListIndex.ts:140](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L140) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[index/list/ListIndex.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndex.ts#L134) +[index/list/ListIndex.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L134) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[index/list/ListIndex.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndex.ts#L113) +[index/list/ListIndex.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L113) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[index/list/ListIndex.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndex.ts#L100) +[index/list/ListIndex.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L100) ___ @@ -214,7 +214,7 @@ ___ #### Defined in -[index/list/ListIndex.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndex.ts#L146) +[index/list/ListIndex.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L146) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[index/list/ListIndex.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndex.ts#L119) +[index/list/ListIndex.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L119) ___ @@ -258,7 +258,7 @@ ___ #### Defined in -[index/list/ListIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndex.ts#L77) +[index/list/ListIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L77) ___ @@ -278,4 +278,4 @@ ___ #### Defined in -[index/list/ListIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndex.ts#L41) +[index/list/ListIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L41) diff --git a/apps/docs/docs/api/classes/ListIndexLLMRetriever.md b/apps/docs/docs/api/classes/ListIndexLLMRetriever.md index 6dc94ee12d4e0a30f73077916a0ff3749400397d..a5d416cb83b14e9c1c74579aabb53ce441005329 100644 --- a/apps/docs/docs/api/classes/ListIndexLLMRetriever.md +++ b/apps/docs/docs/api/classes/ListIndexLLMRetriever.md @@ -31,7 +31,7 @@ LLM retriever for ListIndex. #### Defined in -[index/list/ListIndexRetriever.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndexRetriever.ts#L67) +[index/list/ListIndexRetriever.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L67) ## Properties @@ -41,7 +41,7 @@ LLM retriever for ListIndex. #### Defined in -[index/list/ListIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndexRetriever.ts#L62) +[index/list/ListIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L62) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[index/list/ListIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndexRetriever.ts#L61) +[index/list/ListIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L61) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[index/list/ListIndexRetriever.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndexRetriever.ts#L63) +[index/list/ListIndexRetriever.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L63) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[index/list/ListIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndexRetriever.ts#L60) +[index/list/ListIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L60) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[index/list/ListIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndexRetriever.ts#L64) +[index/list/ListIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L64) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -[index/list/ListIndexRetriever.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndexRetriever.ts#L65) +[index/list/ListIndexRetriever.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L65) ## Methods @@ -116,7 +116,7 @@ ___ #### Defined in -[index/list/ListIndexRetriever.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndexRetriever.ts#L84) +[index/list/ListIndexRetriever.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L84) ___ @@ -134,4 +134,4 @@ ___ #### Defined in -[index/list/ListIndexRetriever.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndexRetriever.ts#L134) +[index/list/ListIndexRetriever.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L134) diff --git a/apps/docs/docs/api/classes/ListIndexRetriever.md b/apps/docs/docs/api/classes/ListIndexRetriever.md index 4ec82eef220383bffd2f56d8fc407c03c04a020c..0ddd041d68725c5543b7e69405fd6cb4f3e74d4b 100644 --- a/apps/docs/docs/api/classes/ListIndexRetriever.md +++ b/apps/docs/docs/api/classes/ListIndexRetriever.md @@ -26,7 +26,7 @@ Simple retriever for ListIndex that returns all nodes #### Defined in -[index/list/ListIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndexRetriever.ts#L22) +[index/list/ListIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L22) ## Properties @@ -36,7 +36,7 @@ Simple retriever for ListIndex that returns all nodes #### Defined in -[index/list/ListIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndexRetriever.ts#L20) +[index/list/ListIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L20) ## Methods @@ -61,7 +61,7 @@ Simple retriever for ListIndex that returns all nodes #### Defined in -[index/list/ListIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndexRetriever.ts#L26) +[index/list/ListIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L26) ___ @@ -79,4 +79,4 @@ ___ #### Defined in -[index/list/ListIndexRetriever.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndexRetriever.ts#L51) +[index/list/ListIndexRetriever.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L51) diff --git a/apps/docs/docs/api/classes/OpenAI.md b/apps/docs/docs/api/classes/OpenAI.md index 83c5ae9e7d4775d26bb5c593f63a427024ee3fef..07190def4b5bacd7c91f95b8312ae13da6fe3526 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.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L76) +[LLM.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L76) ## Properties @@ -36,7 +36,7 @@ OpenAI LLM implementation #### Defined in -[LLM.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L74) +[LLM.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L74) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[LLM.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L69) +[LLM.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L69) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[LLM.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L71) +[LLM.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L71) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L66) +[LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L66) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[LLM.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L70) +[LLM.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L70) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[LLM.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L72) +[LLM.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L72) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L68) +[LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L68) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[LLM.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L73) +[LLM.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L73) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[LLM.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L67) +[LLM.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L67) ## Methods @@ -143,7 +143,7 @@ Get a chat response from the LLM #### Defined in -[LLM.ts:103](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L103) +[LLM.ts:103](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L103) ___ @@ -170,7 +170,7 @@ Get a prompt completion from the LLM #### Defined in -[LLM.ts:145](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L145) +[LLM.ts:145](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L145) ___ @@ -190,4 +190,4 @@ ___ #### Defined in -[LLM.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L88) +[LLM.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L88) diff --git a/apps/docs/docs/api/classes/OpenAIEmbedding.md b/apps/docs/docs/api/classes/OpenAIEmbedding.md index f7b805c9cb315b8de764d18ac4201371da24483b..d82b7fad83749de6f798e83f793efe74ad8ef19b 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/f1d609d/packages/core/src/Embedding.ts#L217) +[Embedding.ts:217](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/Embedding.ts#L215) +[Embedding.ts:215](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L215) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[Embedding.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Embedding.ts#L214) +[Embedding.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L214) ## Methods @@ -64,7 +64,7 @@ ___ #### Defined in -[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Embedding.ts#L224) +[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L224) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Embedding.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Embedding.ts#L240) +[Embedding.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L240) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[Embedding.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Embedding.ts#L236) +[Embedding.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L236) ___ @@ -138,4 +138,4 @@ ___ #### Defined in -[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Embedding.ts#L197) +[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L197) diff --git a/apps/docs/docs/api/classes/Refine.md b/apps/docs/docs/api/classes/Refine.md index f93ca3deb673e25c2203e75cf05a7dabd957d6f4..7566026d258ecdb3fa756136965e8da0365c7902 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:66](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L66) +[ResponseSynthesizer.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L66) ## Properties @@ -44,7 +44,7 @@ A response builder that uses the query to ask the LLM generate a better response #### Defined in -[ResponseSynthesizer.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L64) +[ResponseSynthesizer.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L64) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L62) +[ResponseSynthesizer.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L62) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L63) +[ResponseSynthesizer.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L63) ## Methods @@ -90,7 +90,7 @@ BaseResponseBuilder.agetResponse #### Defined in -[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L76) +[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L76) ___ @@ -111,7 +111,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L95) +[ResponseSynthesizer.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L95) ___ @@ -133,4 +133,4 @@ ___ #### Defined in -[ResponseSynthesizer.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L123) +[ResponseSynthesizer.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L123) diff --git a/apps/docs/docs/api/classes/Response.md b/apps/docs/docs/api/classes/Response.md index 7b3955299b49856d9a8735a198472c752e61eaf4..de60886b2112751a39f8752f9f1fc223119bb57d 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/f1d609d/packages/core/src/Response.ts#L10) +[Response.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/Response.ts#L7) +[Response.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Response.ts#L7) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Response.ts#L8) +[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Response.ts#L8) ## Methods @@ -57,7 +57,7 @@ ___ #### Defined in -[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Response.ts#L15) +[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Response.ts#L15) ___ @@ -71,4 +71,4 @@ ___ #### Defined in -[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Response.ts#L19) +[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 fd37d1bece31563b5c7a904c5776ed84b03cdb55..cfd18782f7243e7e462c05b17beb5de38064939b 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:225](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L225) +[ResponseSynthesizer.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L225) ## Properties @@ -34,7 +34,7 @@ A ResponseSynthesizer is used to generate a response from a query and a list of #### Defined in -[ResponseSynthesizer.ts:222](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L222) +[ResponseSynthesizer.ts:222](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L222) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:223](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L223) +[ResponseSynthesizer.ts:223](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L223) ## Methods @@ -66,4 +66,4 @@ ___ #### Defined in -[ResponseSynthesizer.ts:237](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L237) +[ResponseSynthesizer.ts:237](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L237) diff --git a/apps/docs/docs/api/classes/RetrieverQueryEngine.md b/apps/docs/docs/api/classes/RetrieverQueryEngine.md index 9ba3982ead2792cc988e177c42845e601e5283a7..91b47c53fd861042b888d0d2d244210de2a6ab68 100644 --- a/apps/docs/docs/api/classes/RetrieverQueryEngine.md +++ b/apps/docs/docs/api/classes/RetrieverQueryEngine.md @@ -26,7 +26,7 @@ A query engine that uses a retriever to query an index and then synthesizes the #### Defined in -[QueryEngine.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QueryEngine.ts#L29) +[QueryEngine.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L29) ## Properties @@ -36,7 +36,7 @@ A query engine that uses a retriever to query an index and then synthesizes the #### Defined in -[QueryEngine.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QueryEngine.ts#L27) +[QueryEngine.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L27) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[QueryEngine.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QueryEngine.ts#L26) +[QueryEngine.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L26) ## Methods @@ -71,4 +71,4 @@ ___ #### Defined in -[QueryEngine.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QueryEngine.ts#L36) +[QueryEngine.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L36) diff --git a/apps/docs/docs/api/classes/SentenceSplitter.md b/apps/docs/docs/api/classes/SentenceSplitter.md index a0435e9698eef81b5a78b1ba3155f97a5338c41e..82ac2b023903f77893c3e8659e81352024c59d14 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/f1d609d/packages/core/src/TextSplitter.ts#L33) +[TextSplitter.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/TextSplitter.ts#L26) +[TextSplitter.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L26) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[TextSplitter.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/TextSplitter.ts#L25) +[TextSplitter.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L25) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/TextSplitter.ts#L30) +[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L30) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/TextSplitter.ts#L29) +[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L29) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/TextSplitter.ts#L27) +[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L27) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/TextSplitter.ts#L28) +[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L28) ## Methods @@ -108,7 +108,7 @@ ___ #### Defined in -[TextSplitter.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/TextSplitter.ts#L153) +[TextSplitter.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L153) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[TextSplitter.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/TextSplitter.ts#L72) +[TextSplitter.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L72) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -[TextSplitter.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/TextSplitter.ts#L89) +[TextSplitter.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L89) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[TextSplitter.ts:115](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/TextSplitter.ts#L115) +[TextSplitter.ts:115](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L115) ___ @@ -191,7 +191,7 @@ ___ #### Defined in -[TextSplitter.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/TextSplitter.ts#L128) +[TextSplitter.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L128) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[TextSplitter.ts:233](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/TextSplitter.ts#L233) +[TextSplitter.ts:233](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L233) ___ @@ -233,4 +233,4 @@ ___ #### Defined in -[TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/TextSplitter.ts#L205) +[TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 dbde4e66e573e03963eed9d052b804d32fb9512d..a7d04856587f9902ae392450d3addb91824d570c 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/f1d609d/packages/core/src/ChatEngine.ts#L40) +[ChatEngine.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/ChatEngine.ts#L37) +[ChatEngine.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L37) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ChatEngine.ts#L38) +[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/ChatEngine.ts#L45) +[ChatEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/ChatEngine.ts#L54) +[ChatEngine.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L54) diff --git a/apps/docs/docs/api/classes/SimpleNodeParser.md b/apps/docs/docs/api/classes/SimpleNodeParser.md index e23fbe54cef998dd5469033d513f395751fffe1d..df9b88548fa6da7c0683a337b12f6c256601e7bd 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/f1d609d/packages/core/src/NodeParser.ts#L64) +[NodeParser.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/NodeParser.ts#L61) +[NodeParser.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/NodeParser.ts#L61) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[NodeParser.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/NodeParser.ts#L62) +[NodeParser.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/NodeParser.ts#L62) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[NodeParser.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/NodeParser.ts#L60) +[NodeParser.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/NodeParser.ts#L95) +[NodeParser.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/NodeParser.ts#L95) ___ @@ -111,4 +111,4 @@ ___ #### Defined in -[NodeParser.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/NodeParser.ts#L82) +[NodeParser.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 5a515d384b1d33888d4a79be1333d83c053f4b71..2587128343d97a4f097b8a354d958c356aec79e0 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:37](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L37) +[ResponseSynthesizer.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L37) ## Properties @@ -36,7 +36,7 @@ A response builder that just concatenates responses. #### Defined in -[ResponseSynthesizer.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L34) +[ResponseSynthesizer.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L34) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L35) +[ResponseSynthesizer.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L35) ## Methods @@ -72,4 +72,4 @@ BaseResponseBuilder.agetResponse #### Defined in -[ResponseSynthesizer.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L43) +[ResponseSynthesizer.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L43) diff --git a/apps/docs/docs/api/classes/SubQuestionOutputParser.md b/apps/docs/docs/api/classes/SubQuestionOutputParser.md index 0d29ff7599b330c8e28ca0780ecf52252f6869e6..e174b01637d19fc5a3b2b7bfc41fc0abb6164695 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/f1d609d/packages/core/src/OutputParser.ts#L97) +[OutputParser.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/OutputParser.ts#L97) ___ @@ -64,4 +64,4 @@ ___ #### Defined in -[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/OutputParser.ts#L89) +[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 226986019d460052dd0ab2cf5347a85e69e7c811..e1c856301dc118ae58094c3cbe091b318a1f3bc9 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:56](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QueryEngine.ts#L56) +[QueryEngine.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L56) ## Properties @@ -39,7 +39,7 @@ SubQuestionQueryEngine decomposes a question into subquestions and then #### Defined in -[QueryEngine.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QueryEngine.ts#L54) +[QueryEngine.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L54) ___ @@ -49,7 +49,7 @@ ___ #### Defined in -[QueryEngine.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QueryEngine.ts#L53) +[QueryEngine.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L53) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -[QueryEngine.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QueryEngine.ts#L52) +[QueryEngine.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L52) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -[QueryEngine.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QueryEngine.ts#L51) +[QueryEngine.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L51) ## Methods @@ -93,7 +93,7 @@ ___ #### Defined in -[QueryEngine.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QueryEngine.ts#L97) +[QueryEngine.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L97) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[QueryEngine.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QueryEngine.ts#L128) +[QueryEngine.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L128) ___ @@ -138,4 +138,4 @@ ___ #### Defined in -[QueryEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QueryEngine.ts#L73) +[QueryEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L73) diff --git a/apps/docs/docs/api/classes/TextFileReader.md b/apps/docs/docs/api/classes/TextFileReader.md index 6fa455c32176ceb5a62d328684af5d01707d5c30..59366c1917538113083f59b665d7bae268dd8ac7 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/f1d609d/packages/core/src/readers/SimpleDirectoryReader.ts#L12) +[readers/SimpleDirectoryReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 4230c4f9c03ceb20420ab708cf036f47eadf9c8f..6a1ec8ac9fe1c5bca17fa9dd4c75ce878c9d46ef 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/f1d609d/packages/core/src/Node.ts#L144) +[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L139) +[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L139) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L44) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L46) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L38) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L42) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L142) +[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L142) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L45) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L138) +[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L138) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L137) +[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L104) ___ @@ -210,7 +210,7 @@ BaseNode.nextNode #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L84) ___ @@ -228,7 +228,7 @@ BaseNode.nodeId #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L58) ___ @@ -246,7 +246,7 @@ BaseNode.parentNode #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L94) ___ @@ -264,7 +264,7 @@ BaseNode.prevNode #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L72) ___ @@ -282,7 +282,7 @@ BaseNode.sourceNode #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L124) ___ @@ -314,7 +314,7 @@ ___ #### Defined in -[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L149) +[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L149) ___ @@ -338,7 +338,7 @@ ___ #### Defined in -[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L157) +[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L157) ___ @@ -356,7 +356,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L116) ___ @@ -380,7 +380,7 @@ ___ #### Defined in -[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L162) +[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L162) ___ @@ -399,7 +399,7 @@ ___ #### Defined in -[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L187) +[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L187) ___ @@ -413,7 +413,7 @@ ___ #### Defined in -[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L191) +[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L191) ___ @@ -431,7 +431,7 @@ ___ #### Defined in -[Node.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L153) +[Node.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L153) ___ @@ -455,4 +455,4 @@ ___ #### Defined in -[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L183) +[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 b458dfbd8282445a43813bd90bea4461711cafdf..9d7e1b0d462fa7a0fd8cd3d3dff8339dcda9c73f 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:177](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L177) +[ResponseSynthesizer.ts:177](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L177) ## Properties @@ -36,7 +36,7 @@ TreeSummarize repacks the text chunks into the smallest possible number of chunk #### Defined in -[ResponseSynthesizer.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L175) +[ResponseSynthesizer.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L175) ## Methods @@ -61,4 +61,4 @@ BaseResponseBuilder.agetResponse #### Defined in -[ResponseSynthesizer.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L181) +[ResponseSynthesizer.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L181) diff --git a/apps/docs/docs/api/classes/VectorIndexRetriever.md b/apps/docs/docs/api/classes/VectorIndexRetriever.md index 07941410b7025d5209f480c9e5408406ddaac866..fd72888e592ff2f7e6da540c8628c61d990d8fdc 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 -[Retriever.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Retriever.ts#L28) +[Retriever.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L28) ## Properties @@ -36,7 +36,7 @@ VectorIndexRetriever retrieves nodes from a VectorIndex. #### Defined in -[Retriever.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Retriever.ts#L24) +[Retriever.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L24) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[Retriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Retriever.ts#L26) +[Retriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L26) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[Retriever.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Retriever.ts#L25) +[Retriever.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L25) ## Methods @@ -81,7 +81,7 @@ ___ #### Defined in -[Retriever.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Retriever.ts#L33) +[Retriever.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L33) ___ @@ -99,4 +99,4 @@ ___ #### Defined in -[Retriever.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Retriever.ts#L70) +[Retriever.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L70) diff --git a/apps/docs/docs/api/classes/VectorStoreIndex.md b/apps/docs/docs/api/classes/VectorStoreIndex.md index 52e8019fcd4c7c1dafd17f42ae9022982407e7dd..361ee94cb1972fe2f5f2820bc9b4a04187b46cd7 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 -[BaseIndex.ts:109](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L109) +[BaseIndex.ts:109](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L109) ## Properties @@ -46,7 +46,7 @@ The VectorStoreIndex, an index that stores the nodes only according to their vec #### Defined in -[BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L75) +[BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L75) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[BaseIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L77) +[BaseIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L77) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L78) +[BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L78) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L73) +[BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L73) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L74) +[BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L74) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[BaseIndex.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L107) +[BaseIndex.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L107) ## Methods @@ -134,7 +134,7 @@ NOTE: if you are using a custom query engine you don't have to use this method. #### Defined in -[BaseIndex.ts:252](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L252) +[BaseIndex.ts:252](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L252) ___ @@ -158,7 +158,7 @@ retriever for the index #### Defined in -[BaseIndex.ts:242](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L242) +[BaseIndex.ts:242](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L242) ___ @@ -182,7 +182,7 @@ Get the embeddings for nodes. #### Defined in -[BaseIndex.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L159) +[BaseIndex.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L159) ___ @@ -206,7 +206,7 @@ Get embeddings for nodes and place them into the index. #### Defined in -[BaseIndex.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L187) +[BaseIndex.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L187) ___ @@ -230,7 +230,7 @@ High level API: split documents, get embeddings, and build index. #### Defined in -[BaseIndex.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L214) +[BaseIndex.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L214) ___ @@ -250,4 +250,4 @@ ___ #### Defined in -[BaseIndex.ts:114](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L114) +[BaseIndex.ts:114](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L114) diff --git a/apps/docs/docs/api/enums/ListRetrieverMode.md b/apps/docs/docs/api/enums/ListRetrieverMode.md index ace7437a7a33ae9932836b6294928213972ba6fa..deb4cc7af1dcfdb3e34e5b3cdf05d133ba4aad7e 100644 --- a/apps/docs/docs/api/enums/ListRetrieverMode.md +++ b/apps/docs/docs/api/enums/ListRetrieverMode.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[index/list/ListIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndex.ts#L21) +[index/list/ListIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L21) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[index/list/ListIndex.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/index/list/ListIndex.ts#L23) +[index/list/ListIndex.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L23) diff --git a/apps/docs/docs/api/enums/MetadataMode.md b/apps/docs/docs/api/enums/MetadataMode.md index 83922eda33d2dfc4a517b8194161d39a6e815c50..a86c4332b37ea0e3d66b442c842f892eade58c7c 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/f1d609d/packages/core/src/Node.ts#L19) +[Node.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L19) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L20) +[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L20) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L21) +[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L21) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L22) +[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 11f8dd031799fcbbc8ae77b23ae5a6d7b3f0be0e..367146248ea49da0d89ab949881c4a5b4920a0f5 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/f1d609d/packages/core/src/Node.ts#L8) +[Node.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L8) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L6) +[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L6) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L7) +[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L7) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L5) +[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L5) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[Node.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L4) +[Node.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 2f495e8563fb7afd87ff5a58c4941d51598c832d..7a5b1feaca1629520110842dc89be787c5406d30 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/f1d609d/packages/core/src/Node.ts#L15) +[Node.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L15) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L13) +[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L13) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L14) +[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L14) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[Node.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L12) +[Node.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 ca133283f7e23442d013714da02b3408114f0649..a18b930a97ed7aa767a953dab825e95c6ff66613 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/f1d609d/packages/core/src/Embedding.ts#L10) +[Embedding.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L10) ___ @@ -27,7 +27,7 @@ ___ #### Defined in -[Embedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Embedding.ts#L11) +[Embedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L11) ___ @@ -37,4 +37,4 @@ ___ #### Defined in -[Embedding.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Embedding.ts#L12) +[Embedding.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L12) diff --git a/apps/docs/docs/api/index.md b/apps/docs/docs/api/index.md index 3b39b6eb26309bb4f8c869df779764eb36359514..871c2f819d8df4447e2a19f9b9f7422058d3310c 100644 --- a/apps/docs/docs/api/index.md +++ b/apps/docs/docs/api/index.md @@ -75,7 +75,6 @@ npx ts-node example.ts - [ChatEngine](packages/core/src/ChatEngine.ts): A ChatEngine helps you build a chatbot that will interact with your Indexes. -- [SimplePrompt](packages/core/src/Prompt.ts): A simple standardized function call definition that takes in inputs and puts them in a prebuilt template. ## Contributing: diff --git a/apps/docs/docs/api/interfaces/BaseIndexInit.md b/apps/docs/docs/api/interfaces/BaseIndexInit.md index f5bb6158c240741c955e8ef5165ada1de97f2bf2..628a39a0b52880fef2b386db1c93226d3cef2f3d 100644 --- a/apps/docs/docs/api/interfaces/BaseIndexInit.md +++ b/apps/docs/docs/api/interfaces/BaseIndexInit.md @@ -20,7 +20,7 @@ custom_edit_url: null #### Defined in -[BaseIndex.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L62) +[BaseIndex.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L62) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[BaseIndex.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L64) +[BaseIndex.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L64) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[BaseIndex.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L65) +[BaseIndex.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L65) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L60) +[BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L60) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L61) +[BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L61) ___ @@ -70,4 +70,4 @@ ___ #### Defined in -[BaseIndex.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L63) +[BaseIndex.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L63) diff --git a/apps/docs/docs/api/interfaces/BaseLLMPredictor.md b/apps/docs/docs/api/interfaces/BaseLLMPredictor.md index 8a3b8429d7ab444d9781f530d035d9c9d48c8b9a..90e6a87177f8941d0e38d34cab0b9c8da8ecbeeb 100644 --- a/apps/docs/docs/api/interfaces/BaseLLMPredictor.md +++ b/apps/docs/docs/api/interfaces/BaseLLMPredictor.md @@ -32,7 +32,7 @@ LLM Predictors are an abstraction to predict the response to a prompt. #### Defined in -[LLMPredictor.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLMPredictor.ts#L10) +[LLMPredictor.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L10) ___ @@ -46,4 +46,4 @@ ___ #### Defined in -[LLMPredictor.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLMPredictor.ts#L9) +[LLMPredictor.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L9) diff --git a/apps/docs/docs/api/interfaces/BaseOutputParser.md b/apps/docs/docs/api/interfaces/BaseOutputParser.md index f3c8b7aa834658fc6d30f63dc33e35d40b4d87b0..53b7cf0303adca6b9da603ffa3896d5f31d49b25 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/f1d609d/packages/core/src/OutputParser.ts#L8) +[OutputParser.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/OutputParser.ts#L8) ___ @@ -56,4 +56,4 @@ ___ #### Defined in -[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/OutputParser.ts#L7) +[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 3d2ae3dc51c3babb7ca601c19b513e3a708b1dc1..20ecde3e27973fbca23e4ea082acbb6cba9dd458 100644 --- a/apps/docs/docs/api/interfaces/BaseQueryEngine.md +++ b/apps/docs/docs/api/interfaces/BaseQueryEngine.md @@ -32,4 +32,4 @@ A query engine is a question answerer that can use one or more steps. #### Defined in -[QueryEngine.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QueryEngine.ts#L19) +[QueryEngine.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L19) diff --git a/apps/docs/docs/api/interfaces/BaseQuestionGenerator.md b/apps/docs/docs/api/interfaces/BaseQuestionGenerator.md index b7fefd7ab3da6cef0aeb62d3f1d659d0466d04cd..518a9f86528a5ccb632776be8ac7d0c20f546061 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/f1d609d/packages/core/src/QuestionGenerator.ts#L23) +[QuestionGenerator.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 cc7d15c6c4718fc5be2893724ff3c079aeda6f70..49f7d7220688d7107ba49e153d9035ffeef71331 100644 --- a/apps/docs/docs/api/interfaces/BaseReader.md +++ b/apps/docs/docs/api/interfaces/BaseReader.md @@ -30,4 +30,4 @@ A reader takes imports data into Document objects. #### Defined in -[readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/readers/base.ts#L7) +[readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 5bd2fdea45fd85118c8301f1f8d18e7099e56cdb..514ef4302d3e53409600052c65f1efdfe4f45eb5 100644 --- a/apps/docs/docs/api/interfaces/BaseRetriever.md +++ b/apps/docs/docs/api/interfaces/BaseRetriever.md @@ -33,7 +33,7 @@ Retrievers retrieve the nodes that most closely match our query in similarity. #### Defined in -[Retriever.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Retriever.ts#L16) +[Retriever.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L16) ___ @@ -47,4 +47,4 @@ ___ #### Defined in -[Retriever.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Retriever.ts#L17) +[Retriever.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L17) diff --git a/apps/docs/docs/api/interfaces/BaseTool.md b/apps/docs/docs/api/interfaces/BaseTool.md index a9c9e6ca184875a5c1f94d3cb6290b9f415b8268..8ec07d6447ea1311d516b5535bbe7b1c1664305f 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/f1d609d/packages/core/src/Tool.ts#L12) +[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 eee2788d1b665a850042b93477fce8213ba17ddf..852b26433108074f6d5fa55df9cd6d402619e936 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/f1d609d/packages/core/src/ChatEngine.ts#L25) +[ChatEngine.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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/f1d609d/packages/core/src/ChatEngine.ts#L30) +[ChatEngine.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 eedcfc78f1e4ede10834f1a65fe58dee69f4793f..90aa08bd71916e0fb0dbb128f338491a98b3ac93 100644 --- a/apps/docs/docs/api/interfaces/ChatMessage.md +++ b/apps/docs/docs/api/interfaces/ChatMessage.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[LLM.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L14) +[LLM.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L14) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[LLM.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L15) +[LLM.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L15) diff --git a/apps/docs/docs/api/interfaces/ChatResponse.md b/apps/docs/docs/api/interfaces/ChatResponse.md index 882110bf0e6bc7e48b9015378105b91529c26536..8570acf3a838388499eb407c999c39dbf9676710 100644 --- a/apps/docs/docs/api/interfaces/ChatResponse.md +++ b/apps/docs/docs/api/interfaces/ChatResponse.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[LLM.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L21) +[LLM.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L21) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[LLM.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L19) +[LLM.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L19) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[LLM.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L20) +[LLM.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L20) diff --git a/apps/docs/docs/api/interfaces/Event.md b/apps/docs/docs/api/interfaces/Event.md index 5a293347279f6f4b7d869e93cb8eddd0a012a2c4..70fd5414edf3f2af0e8ccdd451828f981e3ac349 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/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L14) +[callbacks/CallbackManager.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L14) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L17) +[callbacks/CallbackManager.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L17) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L16) +[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L16) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L15) +[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 63bcb3fae37cac4b76ac1f145f32c249c0f1f255..8c5113e125746c10606b1655b320ebb658d2d030 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/f1d609d/packages/core/src/storage/FileSystem.ts#L12) +[storage/FileSystem.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L12) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/FileSystem.ts#L13) +[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L13) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/FileSystem.ts#L11) +[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L11) ___ @@ -97,4 +97,4 @@ ___ #### Defined in -[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/FileSystem.ts#L10) +[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 a6f832b86135ec8e4ae4828cf505c77d154fefe7..7f94040f5bebe06decadb34e855d7a08ee4a72e7 100644 --- a/apps/docs/docs/api/interfaces/LLM.md +++ b/apps/docs/docs/api/interfaces/LLM.md @@ -32,7 +32,7 @@ Get a chat response from the LLM #### Defined in -[LLM.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L35) +[LLM.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L35) ___ @@ -54,4 +54,4 @@ Get a prompt completion from the LLM #### Defined in -[LLM.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L41) +[LLM.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L41) diff --git a/apps/docs/docs/api/interfaces/NodeParser.md b/apps/docs/docs/api/interfaces/NodeParser.md index f96312e92a600fc7a78f7ea2c24201a6d5f50277..4434714b0238302a3bd88143272a13eec715622b 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/f1d609d/packages/core/src/NodeParser.ts#L53) +[NodeParser.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 b828cabcd3bdb10c456b571221fdfcd388e18d4f..a2573c3b7c74bf9dc600ae3f5fdabb9d812a724f 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/f1d609d/packages/core/src/Node.ts#L247) +[Node.ts:247](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L247) ___ @@ -26,4 +26,4 @@ ___ #### Defined in -[Node.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L246) +[Node.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 135d5adecf710c1217d31a0412b124a6b72a9d83..9a618b0cd45f699986849bb05b4d02c08af9f8db 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/f1d609d/packages/core/src/Node.ts#L238) +[Node.ts:238](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L238) ___ @@ -26,4 +26,4 @@ ___ #### Defined in -[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L239) +[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 30657b3035fce9ccbf34b9f3bf8715a85178a2e1..0582d42c54d07b2e3c0e30204d3169b5d6571e41 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/f1d609d/packages/core/src/Tool.ts#L12) +[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Tool.ts#L12) ___ @@ -36,4 +36,4 @@ ___ #### Defined in -[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Tool.ts#L19) +[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 32b8e35289c18926d7ea8a54feb0dac6132453e6..2393bbdb3b31f75c2999ec4b262b47e8fa3aad1d 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/f1d609d/packages/core/src/Node.ts#L29) +[Node.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L29) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L28) +[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L28) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L26) +[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L26) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L27) +[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 4a438975210e2a1c0d27637460a403b3624bcb11..d603e5a3ac9dffa762c3dc9d1b7372d52d57d733 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/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L21) +[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L21) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L47) +[callbacks/CallbackManager.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L47) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L46) +[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 1b8b4f4d95d587c1f52221c361df4ffa923bac8d..1eb18bc6590a73dc2641872fad70c87bbed11b2f 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:16](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ServiceContext.ts#L16) +[ServiceContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L16) ___ @@ -26,7 +26,7 @@ ___ #### Defined in -[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ServiceContext.ts#L14) +[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L14) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ServiceContext.ts#L12) +[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L12) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ServiceContext.ts#L15) +[ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L15) ___ @@ -56,4 +56,4 @@ ___ #### Defined in -[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ServiceContext.ts#L13) +[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L13) diff --git a/apps/docs/docs/api/interfaces/ServiceContextOptions.md b/apps/docs/docs/api/interfaces/ServiceContextOptions.md index 85e5c99fa8dc01b258718dc85e928c16bb900a6e..179a3229ecbf1d81f0e4ab44f7295ef3a3d1067b 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:26](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ServiceContext.ts#L26) +[ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L26) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[ServiceContext.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ServiceContext.ts#L29) +[ServiceContext.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L29) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[ServiceContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ServiceContext.ts#L28) +[ServiceContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L28) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ServiceContext.ts#L24) +[ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L24) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ServiceContext.ts#L22) +[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L22) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ServiceContext.ts#L21) +[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L21) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[ServiceContext.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ServiceContext.ts#L25) +[ServiceContext.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L25) ___ @@ -84,4 +84,4 @@ ___ #### Defined in -[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ServiceContext.ts#L23) +[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L23) diff --git a/apps/docs/docs/api/interfaces/StorageContext.md b/apps/docs/docs/api/interfaces/StorageContext.md index a7ace27f37e7f6d61abfa85d370a0a04ed73cb2a..ba2774a4f4ed7b4a343768c00cc583e67406b22d 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/f1d609d/packages/core/src/storage/StorageContext.ts#L15) +[storage/StorageContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/StorageContext.ts#L15) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/StorageContext.ts#L16) +[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/StorageContext.ts#L16) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/StorageContext.ts#L17) +[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 5411d77980fbae8a5d7d77c3c457251d35e7f5ae..d99c1c3fe90c6454d611421f5676a02f21039fa5 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/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L21) +[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L21) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L40) +[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L40) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L41) +[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L41) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L42) +[callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 dcc7181be45068fce0b076d77ecf1a5b556fee1a..0bf3aded9dda2dc886ad8a671e3a39bff9e9641a 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/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L29) +[callbacks/CallbackManager.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L29) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L27) +[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L27) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L25) +[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L25) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L28) +[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L28) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L26) +[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 eab2b0bce263ce7c0562597098939d4b92140f39..57a4d6179f2f06cc060148ef5efa08ab4da228b8 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/f1d609d/packages/core/src/OutputParser.ts#L16) +[OutputParser.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/OutputParser.ts#L16) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/OutputParser.ts#L15) +[OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 20d016f44af59c9d00d2f5ca54f6ac517712575f..6e18cb9f57ea7296aa8323f92b85dfc20f472ff7 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/f1d609d/packages/core/src/QuestionGenerator.ts#L15) +[QuestionGenerator.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QuestionGenerator.ts#L15) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/QuestionGenerator.ts#L16) +[QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/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 8fef5ddd914944a88a3a638cd2f074ac5b926716..f29208437e4ba9f9e789252fa4239413a58b4371 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/f1d609d/packages/core/src/Tool.ts#L4) +[Tool.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Tool.ts#L4) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Tool.ts#L5) +[Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Tool.ts#L5) diff --git a/apps/docs/docs/api/interfaces/VectorIndexOptions.md b/apps/docs/docs/api/interfaces/VectorIndexOptions.md index 3ae41f330683a96dd386414b5fa2144e731bff63..666b55092576502f2fb351ff8abf1b11a30f209d 100644 --- a/apps/docs/docs/api/interfaces/VectorIndexOptions.md +++ b/apps/docs/docs/api/interfaces/VectorIndexOptions.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[BaseIndex.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L94) +[BaseIndex.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L94) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[BaseIndex.ts:93](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L93) +[BaseIndex.ts:93](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L93) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[BaseIndex.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L95) +[BaseIndex.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L95) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[BaseIndex.ts:96](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/BaseIndex.ts#L96) +[BaseIndex.ts:96](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L96) diff --git a/apps/docs/docs/api/interfaces/WalkableFileSystem.md b/apps/docs/docs/api/interfaces/WalkableFileSystem.md index 189fa6b068bc56e9444700a22fcab8c32053fbae..28dc7451085242b1f3cc9476d5308b4017ba5407 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/f1d609d/packages/core/src/storage/FileSystem.ts#L17) +[storage/FileSystem.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L17) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/FileSystem.ts#L18) +[storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L18) diff --git a/apps/docs/docs/api/modules.md b/apps/docs/docs/api/modules.md index 930c7d8ac0e4ce4d4c7a7a74e14b36952793431f..7fd00351a1e6c4065e362e9f8380ac958dbc1f03 100644 --- a/apps/docs/docs/api/modules.md +++ b/apps/docs/docs/api/modules.md @@ -93,7 +93,7 @@ custom_edit_url: null #### Defined in -[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/FileSystem.ts#L49) +[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L49) ___ @@ -103,7 +103,7 @@ ___ #### Defined in -[LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L25) +[LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L25) ___ @@ -113,7 +113,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L11) +[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L11) ___ @@ -123,7 +123,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/callbacks/CallbackManager.ts#L12) +[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L12) ___ @@ -133,7 +133,7 @@ ___ #### Defined in -[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Node.ts#L32) +[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L32) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/readers/SimpleDirectoryReader.ts#L26) +[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/readers/SimpleDirectoryReader.ts#L26) ___ @@ -180,7 +180,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/f1d609d/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Prompt.ts#L10) ## Variables @@ -201,7 +201,7 @@ We currently support GPT-3.5 and GPT-4 models #### Defined in -[LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L57) +[LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L57) ___ @@ -211,7 +211,7 @@ ___ #### Defined in -[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/constants.ts#L5) +[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L5) ___ @@ -221,7 +221,7 @@ ___ #### Defined in -[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/constants.ts#L6) +[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L6) ___ @@ -231,7 +231,7 @@ ___ #### Defined in -[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/constants.ts#L4) +[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L4) ___ @@ -241,7 +241,7 @@ ___ #### Defined in -[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/constants.ts#L1) +[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/constants.ts#L1) ___ @@ -251,7 +251,7 @@ ___ #### Defined in -[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/constants.ts#L1) +[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L1) ___ @@ -261,7 +261,7 @@ ___ #### Defined in -[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/constants.ts#L4) +[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/constants.ts#L4) ___ @@ -271,7 +271,7 @@ ___ #### Defined in -[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/constants.ts#L10) +[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L10) ___ @@ -281,7 +281,7 @@ ___ #### Defined in -[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/FileSystem.ts#L62) +[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L62) ___ @@ -291,7 +291,7 @@ ___ #### Defined in -[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/constants.ts#L6) +[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/constants.ts#L6) ___ @@ -301,7 +301,7 @@ ___ #### Defined in -[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/constants.ts#L3) +[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/constants.ts#L3) ___ @@ -311,7 +311,7 @@ ___ #### Defined in -[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/constants.ts#L7) +[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/constants.ts#L7) ___ @@ -321,7 +321,7 @@ ___ #### Defined in -[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/constants.ts#L2) +[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L2) ___ @@ -331,7 +331,7 @@ ___ #### Defined in -[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/constants.ts#L11) +[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L11) ___ @@ -341,7 +341,7 @@ ___ #### Defined in -[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/constants.ts#L2) +[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/constants.ts#L2) ___ @@ -351,7 +351,7 @@ ___ #### Defined in -[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/constants.ts#L7) +[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L7) ___ @@ -361,7 +361,7 @@ ___ #### Defined in -[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/constants.ts#L5) +[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/constants.ts#L5) ___ @@ -378,7 +378,7 @@ ___ #### Defined in -[LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L44) +[LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L44) ___ @@ -395,7 +395,7 @@ ___ #### Defined in -[LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/LLM.ts#L49) +[LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L49) ___ @@ -405,7 +405,7 @@ ___ #### Defined in -[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/GlobalsHelper.ts#L42) +[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/GlobalsHelper.ts#L42) ## Functions @@ -425,7 +425,7 @@ ___ #### Defined in -[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Prompt.ts#L198) +[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Prompt.ts#L198) ___ @@ -449,7 +449,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/f1d609d/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Prompt.ts#L10) ___ @@ -473,7 +473,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/f1d609d/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Prompt.ts#L10) ___ @@ -497,7 +497,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/f1d609d/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Prompt.ts#L10) ___ @@ -521,7 +521,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/f1d609d/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Prompt.ts#L10) ___ @@ -545,7 +545,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/f1d609d/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Prompt.ts#L10) ___ @@ -569,7 +569,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/f1d609d/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Prompt.ts#L10) ___ @@ -593,7 +593,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/f1d609d/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Prompt.ts#L10) ___ @@ -619,7 +619,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/f1d609d/packages/core/src/storage/FileSystem.ts#L74) +[storage/FileSystem.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L74) ___ @@ -633,7 +633,7 @@ ___ #### Defined in -[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/FileSystem.ts#L51) +[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L51) ___ @@ -656,7 +656,7 @@ ___ #### Defined in -[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/NodeParser.ts#L15) +[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/NodeParser.ts#L15) ___ @@ -676,7 +676,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ResponseSynthesizer.ts#L212) +[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L212) ___ @@ -697,7 +697,7 @@ ___ #### Defined in -[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/NodeParser.ts#L5) +[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/NodeParser.ts#L5) ___ @@ -723,7 +723,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/f1d609d/packages/core/src/Embedding.ts#L77) +[Embedding.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L77) ___ @@ -747,7 +747,7 @@ ___ #### Defined in -[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Embedding.ts#L119) +[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L119) ___ @@ -773,7 +773,7 @@ ___ #### Defined in -[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Embedding.ts#L131) +[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L131) ___ @@ -793,7 +793,7 @@ ___ #### Defined in -[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/Prompt.ts#L300) +[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Prompt.ts#L300) ___ @@ -813,7 +813,7 @@ ___ #### Defined in -[ServiceContext.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ServiceContext.ts#L32) +[ServiceContext.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L32) ___ @@ -842,7 +842,7 @@ ___ #### Defined in -[ServiceContext.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/ServiceContext.ts#L52) +[ServiceContext.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L52) ___ @@ -868,7 +868,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/f1d609d/packages/core/src/Embedding.ts#L22) +[Embedding.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L22) ___ @@ -888,7 +888,7 @@ ___ #### Defined in -[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/f1d609d/packages/core/src/storage/StorageContext.ts#L28) +[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/StorageContext.ts#L28) ___ @@ -911,4 +911,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/f1d609d/packages/core/src/storage/FileSystem.ts#L91) +[storage/FileSystem.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L91) diff --git a/apps/docs/docs/end_to_end.md b/apps/docs/docs/end_to_end.md index e4cc66696b93fc6c7969f6ae8a6f094ec08d218b..0b6e15cb389e4f9f4c5f717dfe515fe24d931474 100644 --- a/apps/docs/docs/end_to_end.md +++ b/apps/docs/docs/end_to_end.md @@ -12,7 +12,7 @@ Read a file and chat about it with the LLM. ## [List Index](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/listIndex.ts) -Create a list index and query it. The list index will read every piece of text within the index in order to find the answer and generate a response. +Create a list index and query it. This example also use the `LLMRetriever`, which will use the LLM to select the best nodes to use when generating answer. ## [Vector Index](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/vectorIndex.ts) diff --git a/apps/docs/docs/modules/high_level/chat_engine.md b/apps/docs/docs/modules/high_level/chat_engine.md index 5b00b89d7f0ea5d27ee3bf45daa6e2d38910b7f3..984e4525172b5c5110e98c533ed071f9d786f5ab 100644 --- a/apps/docs/docs/modules/high_level/chat_engine.md +++ b/apps/docs/docs/modules/high_level/chat_engine.md @@ -13,3 +13,8 @@ const chatEngine = new ContextChatEngine({ retriever }); // start chatting const response = await chatEngine.chat(query); ``` + +## Api References + +- [ContextChatEngine](../../api/classes/ContextChatEngine.md) +- [CondenseQuestionChatEngine](../../api/classes/ContextChatEngine.md) diff --git a/apps/docs/docs/modules/high_level/data_index.md b/apps/docs/docs/modules/high_level/data_index.md index 3645d34df32355acdca655602ec8f206b1fbc22e..bcb2ef4962bf526fa06253d4a85d4a4f65105a9f 100644 --- a/apps/docs/docs/modules/high_level/data_index.md +++ b/apps/docs/docs/modules/high_level/data_index.md @@ -20,4 +20,9 @@ const document = new Document({ text: "test" }); const index = await VectorStoreIndex.fromDocuments( [document] ); -``` \ No newline at end of file +``` + +## API Reference + +- [ListIndex](../../api/classes/ListIndex.md) +- [VectorStoreIndex](../../api/classes/VectorStoreIndex.md) \ No newline at end of file diff --git a/apps/docs/docs/modules/high_level/data_loader.md b/apps/docs/docs/modules/high_level/data_loader.md index 8943d37e2ec7f69d4b44d762b48eddce52775750..e2d4ec55b0e02862bbb1de3f124b86df1c285831 100644 --- a/apps/docs/docs/modules/high_level/data_loader.md +++ b/apps/docs/docs/modules/high_level/data_loader.md @@ -11,3 +11,7 @@ import { SimpleDirectoryReader } from "llamaindex"; documents = new SimpleDirectoryReader().loadData("./data"); ``` + +## API Reference + +- [SimpleDirectoryReader](../../api/classes/SimpleDirectoryReader.md) diff --git a/apps/docs/docs/modules/high_level/documents_and_nodes.md b/apps/docs/docs/modules/high_level/documents_and_nodes.md index 08ba6b73aba5982125fea0029253d34b82a26a9a..bb197ad5ba518d334a0802780a3bdf7846fe9d93 100644 --- a/apps/docs/docs/modules/high_level/documents_and_nodes.md +++ b/apps/docs/docs/modules/high_level/documents_and_nodes.md @@ -11,3 +11,8 @@ import { Document } from "llamaindex"; document = new Document({ text: "text", metadata: { "key": "val" }}); ``` + +## API Reference + +- [Document](../../api/classes/Document.md) +- [TextNode](../../api/classes/TextNode.md) diff --git a/apps/docs/docs/modules/high_level/query_engine.md b/apps/docs/docs/modules/high_level/query_engine.md index 88a926c76a8cec973cd81657d3a31f8008e2edba..20dbe35b2063163d3cbcbd8e693d5653051cf287 100644 --- a/apps/docs/docs/modules/high_level/query_engine.md +++ b/apps/docs/docs/modules/high_level/query_engine.md @@ -9,4 +9,28 @@ A query engine wraps a `Retriever` and a `ResponseSynthesizer` into a pipeline, ```typescript const queryEngine = index.asQueryEngine(); const response = queryEngine.query("query string"); -``` \ No newline at end of file +``` + +## Sub Question Query Engine + +The basic concept of the Sub Question Query Engine is that it splits a single query into multiple queries, gets an answer for each of those queries, and then combines those different answers into a single coherent response for the user. You can think of it as the "think this through step by step" prompt technique but iterating over your data sources! + +### Getting Started + +The easiest way to start trying the Sub Question Query Engine is running the subquestion.ts file in [apps/simple](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/subquestion.ts). + +```bash +npx ts-node subquestion.ts +``` + +### Tools + +SubQuestionQueryEngine is implemented with Tools. The basic idea of Tools is that they are executable options for the large language model. In this case, our SubQuestionQueryEngine relies on QueryEngineTool, which as you guessed it is a tool to run queries on a QueryEngine. This allows us to give the model an option to query different documents for different questions for example. You could also imagine that the SubQuestionQueryEngine could use a Tool that searches for something on the web or gets an answer using Wolfram Alpha. + +You can learn more about Tools by taking a look at the LlamaIndex Python documentation https://gpt-index.readthedocs.io/en/latest/core_modules/agent_modules/tools/root.html + +## API Reference + +- [RetrieverQueryEngine](../../api/classes/RetrieverQueryEngine.md) +- [SubQuestionQueryEngine](../../api/classes/SubQuestionQueryEngine.md) +- [QueryEngineTool](../../api/interfaces/QueryEngineTool.md) diff --git a/apps/docs/docs/modules/low_level/embedding.md b/apps/docs/docs/modules/low_level/embedding.md index edf16a925f2033483c3ab20f72802b28869eed41..645f33459cc5ac0a8487f428d60ea89396dacb7e 100644 --- a/apps/docs/docs/modules/low_level/embedding.md +++ b/apps/docs/docs/modules/low_level/embedding.md @@ -14,4 +14,9 @@ import { OpenAIEmbedding, ServiceContext } from "llamaindex"; const openaiEmbeds = new OpenAIEmbedding(); const serviceContext = new ServiceContext({ embedModel: openaiEmbeds }); -``` \ No newline at end of file +``` + +## API Reference + +- [OpenAIEmbedding](../../api/classes/OpenAIEmbedding.md) +- [ServiceContext](../../api/interfaces/ServiceContext.md) diff --git a/apps/docs/docs/modules/low_level/llm.md b/apps/docs/docs/modules/low_level/llm.md index ce943a85f0ea5f0d452742955e956e6fb9348599..29e8a8879104cff9a7bd57d4429dcfd59175f6dd 100644 --- a/apps/docs/docs/modules/low_level/llm.md +++ b/apps/docs/docs/modules/low_level/llm.md @@ -15,3 +15,8 @@ const openaiLLM = new ChatGPTLLMPredictor({ model: "gpt-3.5-turbo" }); const serviceContext = new ServiceContext({ llmPredictor: openaiLLM }); ``` + +## API Reference + +- [ChatGPTLLMPredictor](../../api/classes/ChatGPTLLMPredictor.md) +- [ServiceContext](../../api/interfaces/ServiceContext.md) \ No newline at end of file diff --git a/apps/docs/docs/modules/low_level/node_parser.md b/apps/docs/docs/modules/low_level/node_parser.md index dae6a5d71aecfad1006be1f19cc87c99c7f65f3a..b199a2ec17b04a6ec798246854e92b43c9e0bb0f 100644 --- a/apps/docs/docs/modules/low_level/node_parser.md +++ b/apps/docs/docs/modules/low_level/node_parser.md @@ -29,3 +29,8 @@ const splitter = new SentenceSplitter({ chunkSize: 1, }); const textSplits = splitter.splitText("Hello World"); ``` + +## API Reference + +- [SimpleNodeParser](../../api/classes/SimpleNodeParser.md) +- [SentenceSplitter](../../api/classes/SentenceSplitter.md) diff --git a/apps/docs/docs/modules/low_level/response_synthesizer.md b/apps/docs/docs/modules/low_level/response_synthesizer.md index e8b471b942f735f9f71dd42efe8f24e43abac5bf..e7966a0918cdb6291a04fd3cec4f43939c89f46f 100644 --- a/apps/docs/docs/modules/low_level/response_synthesizer.md +++ b/apps/docs/docs/modules/low_level/response_synthesizer.md @@ -45,4 +45,12 @@ const response = await responseSynthesizer.asynthesize( nodesWithScore ); console.log(response.response); -``` \ No newline at end of file +``` + +## API Reference + +- [ResponseSynthesizer](../../api/classes/ResponseSynthesizer.md) +- [Refine](../../api/classes/Refine.md) +- [CompactAndRefine](../../api/classes/CompactAndRefine.md) +- [TreeSummarize](../../api/classes/TreeSummarize.md) +- [SimpleResponseBuilder](../../api/classes/SimpleResponseBuilder.md) diff --git a/apps/docs/docs/modules/low_level/retriever.md b/apps/docs/docs/modules/low_level/retriever.md index 55eb7a2a5311ee4409ab53bdfaa424ab98eafef6..6814962e02dae2ff6484eb28cf6466f80fec29ac 100644 --- a/apps/docs/docs/modules/low_level/retriever.md +++ b/apps/docs/docs/modules/low_level/retriever.md @@ -13,3 +13,9 @@ retriever.similarityTopK = 3; // Fetch nodes! const nodesWithScore = await retriever.aretrieve("query string"); ``` + +## API Reference + +- [ListIndexRetriever](../../api/classes/ListIndexRetriever.md) +- [ListIndexLLMRetriever](../../api/classes/ListIndexLLMRetriever.md) +- [VectorIndexRetriever](../../api/classes/VectorIndexRetriever.md) diff --git a/apps/docs/docs/modules/low_level/storage.md b/apps/docs/docs/modules/low_level/storage.md index 45dfff552a472650659a365a7b5d3bb0e7ec4303..c494cad3dc69ec13f49d16ae5d6392e718c7e6d8 100644 --- a/apps/docs/docs/modules/low_level/storage.md +++ b/apps/docs/docs/modules/low_level/storage.md @@ -4,4 +4,8 @@ sidebar_position: 7 # Storage -Todo: Find out how this works. \ No newline at end of file +Todo: Find out how this works. + +## API Reference + +- [StorageContext](../../api/interfaces/StorageContext.md)