From dc74b40c7a76a79ea2bf6c7363350e9920642c1c Mon Sep 17 00:00:00 2001 From: Logan Markewich <logan.markewich@live.com> Date: Tue, 18 Jul 2023 11:48:53 -0600 Subject: [PATCH] add end-to-end examples --- apps/docs/docs/api/classes/BaseEmbedding.md | 6 +- apps/docs/docs/api/classes/BaseIndex.md | 16 +-- apps/docs/docs/api/classes/BaseNode.md | 40 ++++---- apps/docs/docs/api/classes/CallbackManager.md | 6 +- .../docs/api/classes/ChatGPTLLMPredictor.md | 14 +-- .../docs/docs/api/classes/CompactAndRefine.md | 10 +- .../api/classes/CondenseQuestionChatEngine.md | 16 +-- .../docs/api/classes/ContextChatEngine.md | 14 +-- apps/docs/docs/api/classes/Document.md | 56 +++++------ .../docs/api/classes/InMemoryFileSystem.md | 10 +- apps/docs/docs/api/classes/IndexDict.md | 14 +-- apps/docs/docs/api/classes/IndexList.md | 12 +-- apps/docs/docs/api/classes/IndexNode.md | 56 +++++------ apps/docs/docs/api/classes/IndexStruct.md | 8 +- .../docs/api/classes/LLMQuestionGenerator.md | 10 +- apps/docs/docs/api/classes/ListIndex.md | 30 +++--- .../docs/api/classes/ListIndexLLMRetriever.md | 18 ++-- .../docs/api/classes/ListIndexRetriever.md | 8 +- apps/docs/docs/api/classes/OpenAI.md | 26 ++--- apps/docs/docs/api/classes/OpenAIEmbedding.md | 14 +-- apps/docs/docs/api/classes/Refine.md | 14 +-- apps/docs/docs/api/classes/Response.md | 10 +- .../docs/api/classes/ResponseSynthesizer.md | 8 +- .../docs/api/classes/RetrieverQueryEngine.md | 8 +- .../docs/docs/api/classes/SentenceSplitter.md | 28 +++--- .../docs/docs/api/classes/SimpleChatEngine.md | 10 +- .../docs/docs/api/classes/SimpleNodeParser.md | 12 +-- .../docs/api/classes/SimpleResponseBuilder.md | 8 +- .../api/classes/SubQuestionOutputParser.md | 4 +- .../api/classes/SubQuestionQueryEngine.md | 16 +-- apps/docs/docs/api/classes/TextFileReader.md | 2 +- apps/docs/docs/api/classes/TextNode.md | 54 +++++----- apps/docs/docs/api/classes/TreeSummarize.md | 6 +- .../docs/api/classes/VectorIndexRetriever.md | 12 +-- .../docs/docs/api/classes/VectorStoreIndex.md | 26 ++--- apps/docs/docs/api/enums/ListRetrieverMode.md | 4 +- apps/docs/docs/api/enums/MetadataMode.md | 8 +- apps/docs/docs/api/enums/NodeRelationship.md | 10 +- apps/docs/docs/api/enums/ObjectType.md | 8 +- apps/docs/docs/api/enums/SimilarityType.md | 6 +- .../docs/docs/api/interfaces/BaseIndexInit.md | 12 +-- .../docs/api/interfaces/BaseLLMPredictor.md | 4 +- .../docs/api/interfaces/BaseOutputParser.md | 4 +- .../docs/api/interfaces/BaseQueryEngine.md | 2 +- .../api/interfaces/BaseQuestionGenerator.md | 2 +- apps/docs/docs/api/interfaces/BaseReader.md | 2 +- .../docs/docs/api/interfaces/BaseRetriever.md | 4 +- apps/docs/docs/api/interfaces/BaseTool.md | 2 +- apps/docs/docs/api/interfaces/ChatEngine.md | 4 +- apps/docs/docs/api/interfaces/ChatMessage.md | 4 +- apps/docs/docs/api/interfaces/ChatResponse.md | 6 +- apps/docs/docs/api/interfaces/Event.md | 8 +- .../docs/api/interfaces/GenericFileSystem.md | 8 +- apps/docs/docs/api/interfaces/LLM.md | 4 +- apps/docs/docs/api/interfaces/NodeParser.md | 2 +- .../docs/api/interfaces/NodeWithEmbedding.md | 4 +- .../docs/docs/api/interfaces/NodeWithScore.md | 4 +- .../docs/api/interfaces/QueryEngineTool.md | 4 +- .../docs/api/interfaces/RelatedNodeInfo.md | 8 +- .../interfaces/RetrievalCallbackResponse.md | 6 +- .../docs/api/interfaces/ServiceContext.md | 10 +- .../api/interfaces/ServiceContextOptions.md | 16 +-- .../docs/api/interfaces/StorageContext.md | 6 +- .../api/interfaces/StreamCallbackResponse.md | 8 +- apps/docs/docs/api/interfaces/StreamToken.md | 10 +- .../docs/api/interfaces/StructuredOutput.md | 4 +- apps/docs/docs/api/interfaces/SubQuestion.md | 4 +- apps/docs/docs/api/interfaces/ToolMetadata.md | 4 +- .../docs/api/interfaces/VectorIndexOptions.md | 8 +- .../docs/api/interfaces/WalkableFileSystem.md | 4 +- apps/docs/docs/api/modules.md | 98 +++++++++---------- apps/docs/docs/end_to_end.md | 26 ++++- apps/docs/docs/introduction.md | 1 - .../docs/modules/high_level/chat_engine.md | 4 + .../docs/modules/high_level/data_index.md | 4 + .../modules/high_level/documents_and_nodes.md | 14 ++- .../docs/modules/high_level/query_engine.md | 4 + .../docs/modules/low_level/data_loader.md | 4 + apps/docs/docs/modules/low_level/embedding.md | 4 + apps/docs/docs/modules/low_level/llm.md | 4 + apps/docs/docs/modules/low_level/retriever.md | 4 + .../docs/modules/low_level/simple_prompt.md | 4 + apps/docs/docs/modules/low_level/storage.md | 4 + .../docs/modules/low_level/text_splitter.md | 4 + apps/docs/package-lock.json | 64 ++++++++++++ apps/docs/package.json | 1 + 86 files changed, 595 insertions(+), 455 deletions(-) diff --git a/apps/docs/docs/api/classes/BaseEmbedding.md b/apps/docs/docs/api/classes/BaseEmbedding.md index 7dd8b9373..f3fbc5454 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/e108757/packages/core/src/Embedding.ts#L206) +[Embedding.ts:206](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Embedding.ts#L206) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[Embedding.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Embedding.ts#L205) +[Embedding.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Embedding.ts#L205) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Embedding.ts#L197) +[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 285c2bc77..82bf0ecd2 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/e108757/packages/core/src/BaseIndex.ts#L80) +[BaseIndex.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/BaseIndex.ts#L75) +[BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L75) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[BaseIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L77) +[BaseIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L77) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -[BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L78) +[BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L78) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -[BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L73) +[BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L73) ___ @@ -93,7 +93,7 @@ ___ #### Defined in -[BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L74) +[BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L74) ___ @@ -103,7 +103,7 @@ ___ #### Defined in -[BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L76) +[BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L76) ## Methods @@ -117,4 +117,4 @@ ___ #### Defined in -[BaseIndex.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L89) +[BaseIndex.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 70af26062..971f08b86 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/e108757/packages/core/src/Node.ts#L48) +[Node.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L39) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L43) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L44) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L46) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L38) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L42) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L45) ## Accessors @@ -112,7 +112,7 @@ ___ #### Defined in -[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L104) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L84) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L58) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L94) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L72) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L62) ## Methods @@ -196,7 +196,7 @@ ___ #### Defined in -[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L124) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L54) +[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L54) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L116) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L55) +[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L55) ___ @@ -264,7 +264,7 @@ ___ #### Defined in -[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L52) +[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L52) ___ @@ -284,4 +284,4 @@ ___ #### Defined in -[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L56) +[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 5f88cfd6d..af52fbd89 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/e108757/packages/core/src/callbacks/CallbackManager.ts#L68) +[callbacks/CallbackManager.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/callbacks/CallbackManager.ts#L65) +[callbacks/CallbackManager.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/callbacks/CallbackManager.ts#L66) +[callbacks/CallbackManager.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 5cfea75a9..0983b4ecb 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/e108757/packages/core/src/LLMPredictor.ts#L26) +[LLMPredictor.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/LLMPredictor.ts#L24) +[LLMPredictor.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLMPredictor.ts#L24) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[LLMPredictor.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLMPredictor.ts#L23) +[LLMPredictor.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLMPredictor.ts#L23) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[LLMPredictor.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLMPredictor.ts#L21) +[LLMPredictor.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLMPredictor.ts#L21) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[LLMPredictor.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLMPredictor.ts#L22) +[LLMPredictor.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLMPredictor.ts#L22) ## Methods @@ -92,7 +92,7 @@ ___ #### Defined in -[LLMPredictor.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLMPredictor.ts#L49) +[LLMPredictor.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLMPredictor.ts#L49) ___ @@ -110,4 +110,4 @@ ___ #### Defined in -[LLMPredictor.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLMPredictor.ts#L45) +[LLMPredictor.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 34f2dfc8d..7c6454c3b 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/e108757/packages/core/src/ResponseSynthesizer.ts#L66) +[ResponseSynthesizer.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ResponseSynthesizer.ts#L64) +[ResponseSynthesizer.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ResponseSynthesizer.ts#L64) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ResponseSynthesizer.ts#L62) +[ResponseSynthesizer.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ResponseSynthesizer.ts#L62) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ResponseSynthesizer.ts#L63) +[ResponseSynthesizer.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ResponseSynthesizer.ts#L63) ## Methods @@ -102,4 +102,4 @@ ___ #### Defined in -[ResponseSynthesizer.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ResponseSynthesizer.ts#L152) +[ResponseSynthesizer.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 05deb9ade..88eeb0831 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/e108757/packages/core/src/ChatEngine.ts#L75) +[ChatEngine.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ChatEngine.ts#L71) +[ChatEngine.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ChatEngine.ts#L71) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ChatEngine.ts#L73) +[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ChatEngine.ts#L73) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ChatEngine.ts#L70) +[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ChatEngine.ts#L70) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ChatEngine.ts#L72) +[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ChatEngine.ts#L104) +[ChatEngine.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ChatEngine.ts#L104) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ChatEngine.ts#L89) +[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ChatEngine.ts#L123) +[ChatEngine.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 469acf48b..fc8030d03 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/e108757/packages/core/src/ChatEngine.ts#L138) +[ChatEngine.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ChatEngine.ts#L136) +[ChatEngine.ts:136](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ChatEngine.ts#L136) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[ChatEngine.ts:135](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ChatEngine.ts#L135) +[ChatEngine.ts:135](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ChatEngine.ts#L135) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[ChatEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ChatEngine.ts#L134) +[ChatEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ChatEngine.ts#L153) +[ChatEngine.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ChatEngine.ts#L153) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[ChatEngine.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ChatEngine.ts#L149) +[ChatEngine.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ChatEngine.ts#L191) +[ChatEngine.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 da85f2cb6..a83c3aa7b 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/e108757/packages/core/src/Node.ts#L216) +[Node.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L139) +[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L139) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L44) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L46) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L38) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L42) ___ @@ -144,7 +144,7 @@ ___ #### Defined in -[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L142) +[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L142) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L45) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L138) +[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L138) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L137) +[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L104) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[Node.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L225) +[Node.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L225) ___ @@ -236,7 +236,7 @@ TextNode.nextNode #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L84) ___ @@ -254,7 +254,7 @@ TextNode.nodeId #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L58) ___ @@ -272,7 +272,7 @@ TextNode.parentNode #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L94) ___ @@ -290,7 +290,7 @@ TextNode.prevNode #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L72) ___ @@ -308,7 +308,7 @@ TextNode.sourceNode #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L124) ___ @@ -344,7 +344,7 @@ ___ #### Defined in -[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L149) +[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L149) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L157) +[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L157) ___ @@ -386,7 +386,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L116) ___ @@ -410,7 +410,7 @@ ___ #### Defined in -[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L162) +[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L162) ___ @@ -433,7 +433,7 @@ ___ #### Defined in -[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L187) +[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L187) ___ @@ -451,7 +451,7 @@ ___ #### Defined in -[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L191) +[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L191) ___ @@ -469,7 +469,7 @@ ___ #### Defined in -[Node.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L221) +[Node.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L221) ___ @@ -493,4 +493,4 @@ ___ #### Defined in -[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L183) +[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 1ed57c8dd..798a997ed 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/e108757/packages/core/src/storage/FileSystem.ts#L25) +[storage/FileSystem.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/storage/FileSystem.ts#L38) +[storage/FileSystem.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/FileSystem.ts#L38) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/FileSystem.ts#L44) +[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/FileSystem.ts#L44) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/FileSystem.ts#L31) +[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/FileSystem.ts#L31) ___ @@ -126,4 +126,4 @@ ___ #### Defined in -[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/FileSystem.ts#L27) +[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 e5f63ecbe..3457bbfc6 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/e108757/packages/core/src/BaseIndex.ts#L21) +[BaseIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/BaseIndex.ts#L36) +[BaseIndex.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L36) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L18) +[BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L18) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[BaseIndex.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L35) +[BaseIndex.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L35) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L19) +[BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L19) ## Methods @@ -102,7 +102,7 @@ ___ #### Defined in -[BaseIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L45) +[BaseIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L45) ___ @@ -120,4 +120,4 @@ ___ #### Defined in -[BaseIndex.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L38) +[BaseIndex.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 f0ae54dc9..1a35e633b 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/e108757/packages/core/src/BaseIndex.ts#L21) +[BaseIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/BaseIndex.ts#L18) +[BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L18) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[BaseIndex.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L52) +[BaseIndex.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L52) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L19) +[BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L19) ## Methods @@ -91,7 +91,7 @@ ___ #### Defined in -[BaseIndex.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L54) +[BaseIndex.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L54) ___ @@ -109,4 +109,4 @@ ___ #### Defined in -[BaseIndex.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L26) +[BaseIndex.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 23950a2bd..5ca2a6f48 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/e108757/packages/core/src/Node.ts#L144) +[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L139) +[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L139) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L44) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L46) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L38) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[Node.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L205) +[Node.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L205) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L42) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L142) +[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L142) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L45) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L138) +[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L138) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L137) +[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L104) ___ @@ -232,7 +232,7 @@ TextNode.nextNode #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L84) ___ @@ -250,7 +250,7 @@ TextNode.nodeId #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L58) ___ @@ -268,7 +268,7 @@ TextNode.parentNode #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L94) ___ @@ -286,7 +286,7 @@ TextNode.prevNode #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L72) ___ @@ -304,7 +304,7 @@ TextNode.sourceNode #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L124) ___ @@ -340,7 +340,7 @@ ___ #### Defined in -[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L149) +[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L149) ___ @@ -364,7 +364,7 @@ ___ #### Defined in -[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L157) +[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L157) ___ @@ -382,7 +382,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L116) ___ @@ -406,7 +406,7 @@ ___ #### Defined in -[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L162) +[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L162) ___ @@ -429,7 +429,7 @@ ___ #### Defined in -[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L187) +[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L187) ___ @@ -447,7 +447,7 @@ ___ #### Defined in -[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L191) +[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L191) ___ @@ -465,7 +465,7 @@ ___ #### Defined in -[Node.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L207) +[Node.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L207) ___ @@ -489,4 +489,4 @@ ___ #### Defined in -[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L183) +[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 56e6e82be..c928f1e88 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/e108757/packages/core/src/BaseIndex.ts#L21) +[BaseIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/BaseIndex.ts#L18) +[BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L18) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L19) +[BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L19) ## Methods @@ -65,4 +65,4 @@ ___ #### Defined in -[BaseIndex.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L26) +[BaseIndex.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 dc01ac7fd..c3d0cf43e 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/e108757/packages/core/src/QuestionGenerator.ts#L34) +[QuestionGenerator.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/QuestionGenerator.ts#L30) +[QuestionGenerator.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/QuestionGenerator.ts#L30) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/QuestionGenerator.ts#L32) +[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/QuestionGenerator.ts#L32) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/QuestionGenerator.ts#L31) +[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/QuestionGenerator.ts#L31) ## Methods @@ -81,4 +81,4 @@ ___ #### Defined in -[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/QuestionGenerator.ts#L40) +[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 d930a3fac..0c1022639 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/e108757/packages/core/src/index/list/ListIndex.ts#L37) +[index/list/ListIndex.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/BaseIndex.ts#L75) +[BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L75) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[BaseIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L77) +[BaseIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L77) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L78) +[BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L78) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L73) +[BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L73) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L74) +[BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L74) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L76) +[BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndex.ts#L140) +[index/list/ListIndex.ts:140](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndex.ts#L134) +[index/list/ListIndex.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndex.ts#L113) +[index/list/ListIndex.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndex.ts#L100) +[index/list/ListIndex.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndex.ts#L146) +[index/list/ListIndex.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndex.ts#L119) +[index/list/ListIndex.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndex.ts#L77) +[index/list/ListIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndex.ts#L41) +[index/list/ListIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 0e3d1d103..266306aaf 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/e108757/packages/core/src/index/list/ListIndexRetriever.ts#L67) +[index/list/ListIndexRetriever.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndexRetriever.ts#L62) +[index/list/ListIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndexRetriever.ts#L61) +[index/list/ListIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndexRetriever.ts#L63) +[index/list/ListIndexRetriever.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndexRetriever.ts#L60) +[index/list/ListIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndexRetriever.ts#L64) +[index/list/ListIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndexRetriever.ts#L65) +[index/list/ListIndexRetriever.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndexRetriever.ts#L84) +[index/list/ListIndexRetriever.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndexRetriever.ts#L134) +[index/list/ListIndexRetriever.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 5c48d52b6..1e5ad3b0d 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/e108757/packages/core/src/index/list/ListIndexRetriever.ts#L22) +[index/list/ListIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndexRetriever.ts#L20) +[index/list/ListIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndexRetriever.ts#L26) +[index/list/ListIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndexRetriever.ts#L51) +[index/list/ListIndexRetriever.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 a57cc2974..1a3e74a1d 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/e108757/packages/core/src/LLM.ts#L76) +[LLM.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/LLM.ts#L74) +[LLM.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L74) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[LLM.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLM.ts#L69) +[LLM.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L69) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[LLM.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLM.ts#L71) +[LLM.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L71) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLM.ts#L66) +[LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L66) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[LLM.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLM.ts#L70) +[LLM.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L70) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[LLM.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLM.ts#L72) +[LLM.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L72) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLM.ts#L68) +[LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L68) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[LLM.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLM.ts#L73) +[LLM.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L73) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[LLM.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLM.ts#L67) +[LLM.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/LLM.ts#L103) +[LLM.ts:103](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/LLM.ts#L145) +[LLM.ts:145](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L145) ___ @@ -190,4 +190,4 @@ ___ #### Defined in -[LLM.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLM.ts#L88) +[LLM.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 57de4d141..bcc28874b 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/e108757/packages/core/src/Embedding.ts#L217) +[Embedding.ts:217](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Embedding.ts#L215) +[Embedding.ts:215](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Embedding.ts#L215) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[Embedding.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Embedding.ts#L214) +[Embedding.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Embedding.ts#L214) ## Methods @@ -64,7 +64,7 @@ ___ #### Defined in -[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Embedding.ts#L224) +[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Embedding.ts#L224) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Embedding.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Embedding.ts#L240) +[Embedding.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Embedding.ts#L240) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[Embedding.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Embedding.ts#L236) +[Embedding.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Embedding.ts#L236) ___ @@ -138,4 +138,4 @@ ___ #### Defined in -[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Embedding.ts#L197) +[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 a4534e016..e2296e78e 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/e108757/packages/core/src/ResponseSynthesizer.ts#L66) +[ResponseSynthesizer.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ResponseSynthesizer.ts#L64) +[ResponseSynthesizer.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ResponseSynthesizer.ts#L64) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ResponseSynthesizer.ts#L62) +[ResponseSynthesizer.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ResponseSynthesizer.ts#L62) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ResponseSynthesizer.ts#L63) +[ResponseSynthesizer.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ResponseSynthesizer.ts#L76) +[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ResponseSynthesizer.ts#L76) ___ @@ -111,7 +111,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ResponseSynthesizer.ts#L95) +[ResponseSynthesizer.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ResponseSynthesizer.ts#L95) ___ @@ -133,4 +133,4 @@ ___ #### Defined in -[ResponseSynthesizer.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ResponseSynthesizer.ts#L123) +[ResponseSynthesizer.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 7277e48c4..695e94b5f 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/e108757/packages/core/src/Response.ts#L10) +[Response.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Response.ts#L7) +[Response.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Response.ts#L7) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Response.ts#L8) +[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Response.ts#L8) ## Methods @@ -57,7 +57,7 @@ ___ #### Defined in -[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Response.ts#L15) +[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Response.ts#L15) ___ @@ -71,4 +71,4 @@ ___ #### Defined in -[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Response.ts#L19) +[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 49c91ae52..5d5ccddda 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/e108757/packages/core/src/ResponseSynthesizer.ts#L225) +[ResponseSynthesizer.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ResponseSynthesizer.ts#L222) +[ResponseSynthesizer.ts:222](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ResponseSynthesizer.ts#L222) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:223](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ResponseSynthesizer.ts#L223) +[ResponseSynthesizer.ts:223](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ResponseSynthesizer.ts#L223) ## Methods @@ -66,4 +66,4 @@ ___ #### Defined in -[ResponseSynthesizer.ts:237](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ResponseSynthesizer.ts#L237) +[ResponseSynthesizer.ts:237](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 0adedd64b..ddb2ab8cf 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/e108757/packages/core/src/QueryEngine.ts#L29) +[QueryEngine.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/QueryEngine.ts#L27) +[QueryEngine.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/QueryEngine.ts#L27) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[QueryEngine.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/QueryEngine.ts#L26) +[QueryEngine.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/QueryEngine.ts#L26) ## Methods @@ -71,4 +71,4 @@ ___ #### Defined in -[QueryEngine.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/QueryEngine.ts#L36) +[QueryEngine.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 243d5c884..6272a01a4 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/e108757/packages/core/src/TextSplitter.ts#L33) +[TextSplitter.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/TextSplitter.ts#L26) +[TextSplitter.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/TextSplitter.ts#L26) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[TextSplitter.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/TextSplitter.ts#L25) +[TextSplitter.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/TextSplitter.ts#L25) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/TextSplitter.ts#L30) +[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/TextSplitter.ts#L30) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/TextSplitter.ts#L29) +[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/TextSplitter.ts#L29) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/TextSplitter.ts#L27) +[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/TextSplitter.ts#L27) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/TextSplitter.ts#L28) +[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/TextSplitter.ts#L28) ## Methods @@ -108,7 +108,7 @@ ___ #### Defined in -[TextSplitter.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/TextSplitter.ts#L153) +[TextSplitter.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/TextSplitter.ts#L153) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[TextSplitter.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/TextSplitter.ts#L72) +[TextSplitter.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/TextSplitter.ts#L72) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -[TextSplitter.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/TextSplitter.ts#L89) +[TextSplitter.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/TextSplitter.ts#L89) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[TextSplitter.ts:115](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/TextSplitter.ts#L115) +[TextSplitter.ts:115](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/TextSplitter.ts#L115) ___ @@ -191,7 +191,7 @@ ___ #### Defined in -[TextSplitter.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/TextSplitter.ts#L128) +[TextSplitter.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/TextSplitter.ts#L128) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[TextSplitter.ts:233](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/TextSplitter.ts#L233) +[TextSplitter.ts:233](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/TextSplitter.ts#L233) ___ @@ -233,4 +233,4 @@ ___ #### Defined in -[TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/TextSplitter.ts#L205) +[TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 71fbd70ab..dbe5bbc27 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/e108757/packages/core/src/ChatEngine.ts#L40) +[ChatEngine.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ChatEngine.ts#L37) +[ChatEngine.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ChatEngine.ts#L37) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ChatEngine.ts#L38) +[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ChatEngine.ts#L45) +[ChatEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ChatEngine.ts#L54) +[ChatEngine.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 3a132f6cb..f9d060a25 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/e108757/packages/core/src/NodeParser.ts#L64) +[NodeParser.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/NodeParser.ts#L61) +[NodeParser.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/NodeParser.ts#L61) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[NodeParser.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/NodeParser.ts#L62) +[NodeParser.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/NodeParser.ts#L62) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[NodeParser.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/NodeParser.ts#L60) +[NodeParser.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/NodeParser.ts#L95) +[NodeParser.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/NodeParser.ts#L95) ___ @@ -111,4 +111,4 @@ ___ #### Defined in -[NodeParser.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/NodeParser.ts#L82) +[NodeParser.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 1b8523692..33ee026a1 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/e108757/packages/core/src/ResponseSynthesizer.ts#L37) +[ResponseSynthesizer.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ResponseSynthesizer.ts#L34) +[ResponseSynthesizer.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ResponseSynthesizer.ts#L34) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ResponseSynthesizer.ts#L35) +[ResponseSynthesizer.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ResponseSynthesizer.ts#L43) +[ResponseSynthesizer.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 a2dbbdfe9..40c39aadc 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/e108757/packages/core/src/OutputParser.ts#L97) +[OutputParser.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/OutputParser.ts#L97) ___ @@ -64,4 +64,4 @@ ___ #### Defined in -[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/OutputParser.ts#L89) +[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 d4b69dbf5..fd6c3a51b 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/e108757/packages/core/src/QueryEngine.ts#L56) +[QueryEngine.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/QueryEngine.ts#L54) +[QueryEngine.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/QueryEngine.ts#L54) ___ @@ -49,7 +49,7 @@ ___ #### Defined in -[QueryEngine.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/QueryEngine.ts#L53) +[QueryEngine.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/QueryEngine.ts#L53) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -[QueryEngine.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/QueryEngine.ts#L52) +[QueryEngine.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/QueryEngine.ts#L52) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -[QueryEngine.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/QueryEngine.ts#L51) +[QueryEngine.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/QueryEngine.ts#L51) ## Methods @@ -93,7 +93,7 @@ ___ #### Defined in -[QueryEngine.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/QueryEngine.ts#L97) +[QueryEngine.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/QueryEngine.ts#L97) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[QueryEngine.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/QueryEngine.ts#L128) +[QueryEngine.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/QueryEngine.ts#L128) ___ @@ -138,4 +138,4 @@ ___ #### Defined in -[QueryEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/QueryEngine.ts#L73) +[QueryEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 6439326f6..87cd0c116 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/e108757/packages/core/src/readers/SimpleDirectoryReader.ts#L12) +[readers/SimpleDirectoryReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 4832a66ac..c89377232 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/e108757/packages/core/src/Node.ts#L144) +[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L139) +[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L139) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L44) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L46) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L38) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L42) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L142) +[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L142) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L45) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L138) +[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L138) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L137) +[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L104) ___ @@ -210,7 +210,7 @@ BaseNode.nextNode #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L84) ___ @@ -228,7 +228,7 @@ BaseNode.nodeId #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L58) ___ @@ -246,7 +246,7 @@ BaseNode.parentNode #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L94) ___ @@ -264,7 +264,7 @@ BaseNode.prevNode #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L72) ___ @@ -282,7 +282,7 @@ BaseNode.sourceNode #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L124) ___ @@ -314,7 +314,7 @@ ___ #### Defined in -[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L149) +[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L149) ___ @@ -338,7 +338,7 @@ ___ #### Defined in -[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L157) +[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L157) ___ @@ -356,7 +356,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L116) ___ @@ -380,7 +380,7 @@ ___ #### Defined in -[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L162) +[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L162) ___ @@ -399,7 +399,7 @@ ___ #### Defined in -[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L187) +[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L187) ___ @@ -413,7 +413,7 @@ ___ #### Defined in -[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L191) +[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L191) ___ @@ -431,7 +431,7 @@ ___ #### Defined in -[Node.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L153) +[Node.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L153) ___ @@ -455,4 +455,4 @@ ___ #### Defined in -[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L183) +[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 7dda7cd17..5ea749bbc 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/e108757/packages/core/src/ResponseSynthesizer.ts#L177) +[ResponseSynthesizer.ts:177](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ResponseSynthesizer.ts#L175) +[ResponseSynthesizer.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ResponseSynthesizer.ts#L181) +[ResponseSynthesizer.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 3b4f14101..74f3a163f 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/e108757/packages/core/src/Retriever.ts#L28) +[Retriever.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Retriever.ts#L24) +[Retriever.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Retriever.ts#L24) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[Retriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Retriever.ts#L26) +[Retriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Retriever.ts#L26) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[Retriever.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Retriever.ts#L25) +[Retriever.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Retriever.ts#L25) ## Methods @@ -81,7 +81,7 @@ ___ #### Defined in -[Retriever.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Retriever.ts#L33) +[Retriever.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Retriever.ts#L33) ___ @@ -99,4 +99,4 @@ ___ #### Defined in -[Retriever.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Retriever.ts#L70) +[Retriever.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 58386ff14..67b722d26 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/e108757/packages/core/src/BaseIndex.ts#L109) +[BaseIndex.ts:109](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/BaseIndex.ts#L75) +[BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L75) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[BaseIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L77) +[BaseIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L77) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L78) +[BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L78) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L73) +[BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L73) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L74) +[BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L74) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[BaseIndex.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L107) +[BaseIndex.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/BaseIndex.ts#L252) +[BaseIndex.ts:252](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/BaseIndex.ts#L242) +[BaseIndex.ts:242](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/BaseIndex.ts#L159) +[BaseIndex.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/BaseIndex.ts#L187) +[BaseIndex.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/BaseIndex.ts#L214) +[BaseIndex.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L214) ___ @@ -250,4 +250,4 @@ ___ #### Defined in -[BaseIndex.ts:114](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L114) +[BaseIndex.ts:114](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 2cfda718e..a8ff1e568 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/e108757/packages/core/src/index/list/ListIndex.ts#L21) +[index/list/ListIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/index/list/ListIndex.ts#L23) +[index/list/ListIndex.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 6a3c1fab7..553aea75d 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/e108757/packages/core/src/Node.ts#L19) +[Node.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L19) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L20) +[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L20) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L21) +[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L21) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L22) +[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 edc1865cb..86795cb05 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/e108757/packages/core/src/Node.ts#L8) +[Node.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L8) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L6) +[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L6) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L7) +[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L7) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L5) +[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L5) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[Node.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L4) +[Node.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 31cf6042f..35f6e6c88 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/e108757/packages/core/src/Node.ts#L15) +[Node.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L15) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L13) +[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L13) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L14) +[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L14) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[Node.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L12) +[Node.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 384feabd7..0d42dab52 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/e108757/packages/core/src/Embedding.ts#L10) +[Embedding.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Embedding.ts#L10) ___ @@ -27,7 +27,7 @@ ___ #### Defined in -[Embedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Embedding.ts#L11) +[Embedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Embedding.ts#L11) ___ @@ -37,4 +37,4 @@ ___ #### Defined in -[Embedding.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Embedding.ts#L12) +[Embedding.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Embedding.ts#L12) diff --git a/apps/docs/docs/api/interfaces/BaseIndexInit.md b/apps/docs/docs/api/interfaces/BaseIndexInit.md index 23a713b5e..8032487cd 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/e108757/packages/core/src/BaseIndex.ts#L62) +[BaseIndex.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L62) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[BaseIndex.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L64) +[BaseIndex.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L64) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[BaseIndex.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L65) +[BaseIndex.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L65) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L60) +[BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L60) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L61) +[BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L61) ___ @@ -70,4 +70,4 @@ ___ #### Defined in -[BaseIndex.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L63) +[BaseIndex.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 3660a9089..f246925cf 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/e108757/packages/core/src/LLMPredictor.ts#L10) +[LLMPredictor.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLMPredictor.ts#L10) ___ @@ -46,4 +46,4 @@ ___ #### Defined in -[LLMPredictor.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLMPredictor.ts#L9) +[LLMPredictor.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 019878e0a..142839d3e 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/e108757/packages/core/src/OutputParser.ts#L8) +[OutputParser.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/OutputParser.ts#L8) ___ @@ -56,4 +56,4 @@ ___ #### Defined in -[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/OutputParser.ts#L7) +[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 840f6666c..a53d82277 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/e108757/packages/core/src/QueryEngine.ts#L19) +[QueryEngine.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 f03323099..0e46ba028 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/e108757/packages/core/src/QuestionGenerator.ts#L23) +[QuestionGenerator.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 6d751e9b3..d51b641c2 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/e108757/packages/core/src/readers/base.ts#L7) +[readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 89a1e786d..7e62bb2d6 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/e108757/packages/core/src/Retriever.ts#L16) +[Retriever.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Retriever.ts#L16) ___ @@ -47,4 +47,4 @@ ___ #### Defined in -[Retriever.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Retriever.ts#L17) +[Retriever.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 6f0285c92..b3371f911 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/e108757/packages/core/src/Tool.ts#L12) +[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 348f070c1..c51bcd6cb 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/e108757/packages/core/src/ChatEngine.ts#L25) +[ChatEngine.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/ChatEngine.ts#L30) +[ChatEngine.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 1f34d70df..daab4ca1e 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/e108757/packages/core/src/LLM.ts#L14) +[LLM.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L14) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[LLM.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLM.ts#L15) +[LLM.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 2ceee7f3e..d83aceb0b 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/e108757/packages/core/src/LLM.ts#L21) +[LLM.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L21) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[LLM.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLM.ts#L19) +[LLM.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L19) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[LLM.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLM.ts#L20) +[LLM.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 08382f89f..3ae0d8bac 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/e108757/packages/core/src/callbacks/CallbackManager.ts#L14) +[callbacks/CallbackManager.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/callbacks/CallbackManager.ts#L14) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/callbacks/CallbackManager.ts#L17) +[callbacks/CallbackManager.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/callbacks/CallbackManager.ts#L17) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/callbacks/CallbackManager.ts#L16) +[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/callbacks/CallbackManager.ts#L16) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/callbacks/CallbackManager.ts#L15) +[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 0d6d05724..b28816567 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/e108757/packages/core/src/storage/FileSystem.ts#L12) +[storage/FileSystem.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/FileSystem.ts#L12) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/FileSystem.ts#L13) +[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/FileSystem.ts#L13) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/FileSystem.ts#L11) +[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/FileSystem.ts#L11) ___ @@ -97,4 +97,4 @@ ___ #### Defined in -[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/FileSystem.ts#L10) +[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 352f20b45..2441b1a0e 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/e108757/packages/core/src/LLM.ts#L35) +[LLM.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/LLM.ts#L41) +[LLM.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 849dc7b76..dcc2140eb 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/e108757/packages/core/src/NodeParser.ts#L53) +[NodeParser.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 fbaee830f..3c7e5a1f6 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/e108757/packages/core/src/Node.ts#L247) +[Node.ts:247](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L247) ___ @@ -26,4 +26,4 @@ ___ #### Defined in -[Node.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L246) +[Node.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 cb803cc7b..ebd112faf 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/e108757/packages/core/src/Node.ts#L238) +[Node.ts:238](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L238) ___ @@ -26,4 +26,4 @@ ___ #### Defined in -[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L239) +[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 2ff9cd0cd..6122b665f 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/e108757/packages/core/src/Tool.ts#L12) +[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Tool.ts#L12) ___ @@ -36,4 +36,4 @@ ___ #### Defined in -[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Tool.ts#L19) +[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 9b1f60d39..a93cac48b 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/e108757/packages/core/src/Node.ts#L29) +[Node.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L29) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L28) +[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L28) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L26) +[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L26) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L27) +[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 48b83691c..ec6ba5d3e 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/e108757/packages/core/src/callbacks/CallbackManager.ts#L21) +[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/callbacks/CallbackManager.ts#L21) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/callbacks/CallbackManager.ts#L47) +[callbacks/CallbackManager.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/callbacks/CallbackManager.ts#L47) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/callbacks/CallbackManager.ts#L46) +[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 5ebe50917..37b3e834d 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/e108757/packages/core/src/ServiceContext.ts#L16) +[ServiceContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ServiceContext.ts#L16) ___ @@ -26,7 +26,7 @@ ___ #### Defined in -[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ServiceContext.ts#L14) +[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ServiceContext.ts#L14) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ServiceContext.ts#L12) +[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ServiceContext.ts#L12) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ServiceContext.ts#L15) +[ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ServiceContext.ts#L15) ___ @@ -56,4 +56,4 @@ ___ #### Defined in -[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ServiceContext.ts#L13) +[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 f23590103..dde1972b2 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/e108757/packages/core/src/ServiceContext.ts#L26) +[ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ServiceContext.ts#L26) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[ServiceContext.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ServiceContext.ts#L29) +[ServiceContext.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ServiceContext.ts#L29) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[ServiceContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ServiceContext.ts#L28) +[ServiceContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ServiceContext.ts#L28) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ServiceContext.ts#L24) +[ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ServiceContext.ts#L24) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ServiceContext.ts#L22) +[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ServiceContext.ts#L22) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ServiceContext.ts#L21) +[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ServiceContext.ts#L21) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[ServiceContext.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ServiceContext.ts#L25) +[ServiceContext.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ServiceContext.ts#L25) ___ @@ -84,4 +84,4 @@ ___ #### Defined in -[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ServiceContext.ts#L23) +[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 81cdb4425..961bd69f7 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/e108757/packages/core/src/storage/StorageContext.ts#L15) +[storage/StorageContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/StorageContext.ts#L15) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/StorageContext.ts#L16) +[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/StorageContext.ts#L16) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/StorageContext.ts#L17) +[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 f431eaebd..9ceb06e88 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/e108757/packages/core/src/callbacks/CallbackManager.ts#L21) +[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/callbacks/CallbackManager.ts#L21) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/callbacks/CallbackManager.ts#L40) +[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/callbacks/CallbackManager.ts#L40) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/callbacks/CallbackManager.ts#L41) +[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/callbacks/CallbackManager.ts#L41) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/callbacks/CallbackManager.ts#L42) +[callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 14b5b8896..043ec047b 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/e108757/packages/core/src/callbacks/CallbackManager.ts#L29) +[callbacks/CallbackManager.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/callbacks/CallbackManager.ts#L29) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/callbacks/CallbackManager.ts#L27) +[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/callbacks/CallbackManager.ts#L27) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/callbacks/CallbackManager.ts#L25) +[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/callbacks/CallbackManager.ts#L25) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/callbacks/CallbackManager.ts#L28) +[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/callbacks/CallbackManager.ts#L28) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/callbacks/CallbackManager.ts#L26) +[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 11621f3f3..5a2800dde 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/e108757/packages/core/src/OutputParser.ts#L16) +[OutputParser.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/OutputParser.ts#L16) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/OutputParser.ts#L15) +[OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 86a871f5d..b4fd33799 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/e108757/packages/core/src/QuestionGenerator.ts#L15) +[QuestionGenerator.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/QuestionGenerator.ts#L15) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/QuestionGenerator.ts#L16) +[QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 493d18a54..d0f3c7a8d 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/e108757/packages/core/src/Tool.ts#L4) +[Tool.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Tool.ts#L4) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Tool.ts#L5) +[Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 f9363b71d..251f1af46 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/e108757/packages/core/src/BaseIndex.ts#L94) +[BaseIndex.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L94) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[BaseIndex.ts:93](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L93) +[BaseIndex.ts:93](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L93) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[BaseIndex.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L95) +[BaseIndex.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/BaseIndex.ts#L95) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[BaseIndex.ts:96](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/BaseIndex.ts#L96) +[BaseIndex.ts:96](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 0491bcfc9..46c2f3801 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/e108757/packages/core/src/storage/FileSystem.ts#L17) +[storage/FileSystem.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/FileSystem.ts#L17) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/FileSystem.ts#L18) +[storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/FileSystem.ts#L18) diff --git a/apps/docs/docs/api/modules.md b/apps/docs/docs/api/modules.md index 9b898b546..a5419653d 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/e108757/packages/core/src/storage/FileSystem.ts#L49) +[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/FileSystem.ts#L49) ___ @@ -103,7 +103,7 @@ ___ #### Defined in -[LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLM.ts#L25) +[LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L25) ___ @@ -113,7 +113,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/callbacks/CallbackManager.ts#L11) +[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/callbacks/CallbackManager.ts#L11) ___ @@ -123,7 +123,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/callbacks/CallbackManager.ts#L12) +[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/callbacks/CallbackManager.ts#L12) ___ @@ -133,7 +133,7 @@ ___ #### Defined in -[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Node.ts#L32) +[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Node.ts#L32) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/readers/SimpleDirectoryReader.ts#L26) +[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/LLM.ts#L57) +[LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L57) ___ @@ -211,7 +211,7 @@ ___ #### Defined in -[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/constants.ts#L5) +[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/constants.ts#L5) ___ @@ -221,7 +221,7 @@ ___ #### Defined in -[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/constants.ts#L6) +[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/constants.ts#L6) ___ @@ -231,7 +231,7 @@ ___ #### Defined in -[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/constants.ts#L4) +[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/constants.ts#L4) ___ @@ -241,7 +241,7 @@ ___ #### Defined in -[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/constants.ts#L1) +[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/constants.ts#L1) ___ @@ -251,7 +251,7 @@ ___ #### Defined in -[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/constants.ts#L1) +[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/constants.ts#L1) ___ @@ -261,7 +261,7 @@ ___ #### Defined in -[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/constants.ts#L4) +[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/constants.ts#L4) ___ @@ -271,7 +271,7 @@ ___ #### Defined in -[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/constants.ts#L10) +[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/constants.ts#L10) ___ @@ -281,7 +281,7 @@ ___ #### Defined in -[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/FileSystem.ts#L62) +[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/FileSystem.ts#L62) ___ @@ -291,7 +291,7 @@ ___ #### Defined in -[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/constants.ts#L6) +[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/constants.ts#L6) ___ @@ -301,7 +301,7 @@ ___ #### Defined in -[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/constants.ts#L3) +[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/constants.ts#L3) ___ @@ -311,7 +311,7 @@ ___ #### Defined in -[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/constants.ts#L7) +[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/constants.ts#L7) ___ @@ -321,7 +321,7 @@ ___ #### Defined in -[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/constants.ts#L2) +[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/constants.ts#L2) ___ @@ -331,7 +331,7 @@ ___ #### Defined in -[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/constants.ts#L11) +[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/constants.ts#L11) ___ @@ -341,7 +341,7 @@ ___ #### Defined in -[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/constants.ts#L2) +[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/constants.ts#L2) ___ @@ -351,7 +351,7 @@ ___ #### Defined in -[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/constants.ts#L7) +[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/constants.ts#L7) ___ @@ -361,7 +361,7 @@ ___ #### Defined in -[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/constants.ts#L5) +[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/constants.ts#L5) ___ @@ -378,7 +378,7 @@ ___ #### Defined in -[LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLM.ts#L44) +[LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L44) ___ @@ -395,7 +395,7 @@ ___ #### Defined in -[LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/LLM.ts#L49) +[LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/LLM.ts#L49) ___ @@ -405,7 +405,7 @@ ___ #### Defined in -[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/GlobalsHelper.ts#L42) +[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/GlobalsHelper.ts#L42) ## Functions @@ -425,7 +425,7 @@ ___ #### Defined in -[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Prompt.ts#L198) +[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/storage/FileSystem.ts#L74) +[storage/FileSystem.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/FileSystem.ts#L74) ___ @@ -633,7 +633,7 @@ ___ #### Defined in -[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/FileSystem.ts#L51) +[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/storage/FileSystem.ts#L51) ___ @@ -656,7 +656,7 @@ ___ #### Defined in -[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/NodeParser.ts#L15) +[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/NodeParser.ts#L15) ___ @@ -676,7 +676,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ResponseSynthesizer.ts#L212) +[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ResponseSynthesizer.ts#L212) ___ @@ -697,7 +697,7 @@ ___ #### Defined in -[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/NodeParser.ts#L5) +[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Embedding.ts#L77) +[Embedding.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Embedding.ts#L77) ___ @@ -747,7 +747,7 @@ ___ #### Defined in -[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Embedding.ts#L119) +[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Embedding.ts#L119) ___ @@ -773,7 +773,7 @@ ___ #### Defined in -[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Embedding.ts#L131) +[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Embedding.ts#L131) ___ @@ -793,7 +793,7 @@ ___ #### Defined in -[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/Prompt.ts#L300) +[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Prompt.ts#L300) ___ @@ -813,7 +813,7 @@ ___ #### Defined in -[ServiceContext.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ServiceContext.ts#L32) +[ServiceContext.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/ServiceContext.ts#L32) ___ @@ -842,7 +842,7 @@ ___ #### Defined in -[ServiceContext.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/ServiceContext.ts#L52) +[ServiceContext.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/Embedding.ts#L22) +[Embedding.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/packages/core/src/Embedding.ts#L22) ___ @@ -888,7 +888,7 @@ ___ #### Defined in -[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/e108757/packages/core/src/storage/StorageContext.ts#L28) +[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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/e108757/packages/core/src/storage/FileSystem.ts#L91) +[storage/FileSystem.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/b6b2598/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 f77c6ae57..eb47c4727 100644 --- a/apps/docs/docs/end_to_end.md +++ b/apps/docs/docs/end_to_end.md @@ -1,3 +1,27 @@ # End to End Examples -TODO: Link to examples in repo \ No newline at end of file +We include several end-to-end examples using LlamaIndex.TS in the repository + +## [Chat Engine](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/chatEngine.ts) + +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. + +## [Vector Index](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/vectorIndex.ts) + +Create a vector index and query it. The vector index will use embeddings to fetch the top k most relevant nodes. By default, the top k is 2. + +## [OpenAI LLM](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/openai.ts) + +Create an OpenAI LLM and directly use it for chat. + +## [SubQuestionQueryEngine](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/subquestion.ts) + +Uses the `SubQuestionQueryEngine`, which breaks complex queries into multiple questions, and then aggreates a response across the answers to all sub-questions. + +## [Low Level Modules](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/lowlevel.ts) + +This example uses several low-level components, which removes the need for an actual query engine. These components can be used anywhere, in any application, or customized and sub-classed to meet your own needs. \ No newline at end of file diff --git a/apps/docs/docs/introduction.md b/apps/docs/docs/introduction.md index 0818fa504..74d1db5b4 100644 --- a/apps/docs/docs/introduction.md +++ b/apps/docs/docs/introduction.md @@ -1,6 +1,5 @@ --- sidebar_position: 0 -sidebar_label: Getting Started --- # What is LlamaIndex.TS? diff --git a/apps/docs/docs/modules/high_level/chat_engine.md b/apps/docs/docs/modules/high_level/chat_engine.md index a78c7cbb0..c928feddb 100644 --- a/apps/docs/docs/modules/high_level/chat_engine.md +++ b/apps/docs/docs/modules/high_level/chat_engine.md @@ -1 +1,5 @@ +--- +sidebar_position: 3 +--- + # ChatEngine \ No newline at end of file diff --git a/apps/docs/docs/modules/high_level/data_index.md b/apps/docs/docs/modules/high_level/data_index.md index 1630f8971..c28e771e1 100644 --- a/apps/docs/docs/modules/high_level/data_index.md +++ b/apps/docs/docs/modules/high_level/data_index.md @@ -1 +1,5 @@ +--- +sidebar_position: 1 +--- + # Index \ No newline at end of file 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 001da0ef8..20489b842 100644 --- a/apps/docs/docs/modules/high_level/documents_and_nodes.md +++ b/apps/docs/docs/modules/high_level/documents_and_nodes.md @@ -1 +1,13 @@ -# Documents and Nodes \ No newline at end of file +--- +sidebar_position: 0 +--- + +# Documents and Nodes + +`Document`s and `Node`s are the basic building blocks of any index. While the API for these objects is similar, `Document` objects represent entire files, while `Node`s are smaller pieces of that original document, that are suitable for an LLM and Q&A. + +## Usage Pattern + +```typescript + +``` \ No newline at end of file diff --git a/apps/docs/docs/modules/high_level/query_engine.md b/apps/docs/docs/modules/high_level/query_engine.md index 14c97b2ce..f44cdc40b 100644 --- a/apps/docs/docs/modules/high_level/query_engine.md +++ b/apps/docs/docs/modules/high_level/query_engine.md @@ -1 +1,5 @@ +--- +sidebar_position: 2 +--- + # QueryEngine \ No newline at end of file diff --git a/apps/docs/docs/modules/low_level/data_loader.md b/apps/docs/docs/modules/low_level/data_loader.md index a38fb424d..d603f12d9 100644 --- a/apps/docs/docs/modules/low_level/data_loader.md +++ b/apps/docs/docs/modules/low_level/data_loader.md @@ -1 +1,5 @@ +--- +sidebar_position: 2 +--- + # Reader / Loader \ No newline at end of file diff --git a/apps/docs/docs/modules/low_level/embedding.md b/apps/docs/docs/modules/low_level/embedding.md index 50418880b..e31780261 100644 --- a/apps/docs/docs/modules/low_level/embedding.md +++ b/apps/docs/docs/modules/low_level/embedding.md @@ -1 +1,5 @@ +--- +sidebar_position: 1 +--- + # Embedding \ No newline at end of file diff --git a/apps/docs/docs/modules/low_level/llm.md b/apps/docs/docs/modules/low_level/llm.md index 13ae8d124..dc14840bc 100644 --- a/apps/docs/docs/modules/low_level/llm.md +++ b/apps/docs/docs/modules/low_level/llm.md @@ -1 +1,5 @@ +--- +sidebar_position: 0 +--- + # LLM \ No newline at end of file diff --git a/apps/docs/docs/modules/low_level/retriever.md b/apps/docs/docs/modules/low_level/retriever.md index fcdeab75d..52c81fd51 100644 --- a/apps/docs/docs/modules/low_level/retriever.md +++ b/apps/docs/docs/modules/low_level/retriever.md @@ -1 +1,5 @@ +--- +sidebar_position: 5 +--- + # Retriever \ No newline at end of file diff --git a/apps/docs/docs/modules/low_level/simple_prompt.md b/apps/docs/docs/modules/low_level/simple_prompt.md index b003b53b0..f1960bcd3 100644 --- a/apps/docs/docs/modules/low_level/simple_prompt.md +++ b/apps/docs/docs/modules/low_level/simple_prompt.md @@ -1 +1,5 @@ +--- +sidebar_position: 4 +--- + # SimplePrompt diff --git a/apps/docs/docs/modules/low_level/storage.md b/apps/docs/docs/modules/low_level/storage.md index 19c72df0c..c6c26edfc 100644 --- a/apps/docs/docs/modules/low_level/storage.md +++ b/apps/docs/docs/modules/low_level/storage.md @@ -1 +1,5 @@ +--- +sidebar_position: 6 +--- + # Storage \ No newline at end of file diff --git a/apps/docs/docs/modules/low_level/text_splitter.md b/apps/docs/docs/modules/low_level/text_splitter.md index 895e43690..1c97febe0 100644 --- a/apps/docs/docs/modules/low_level/text_splitter.md +++ b/apps/docs/docs/modules/low_level/text_splitter.md @@ -1 +1,5 @@ +--- +sidebar_position: 3 +--- + # TextSplitter \ No newline at end of file diff --git a/apps/docs/package-lock.json b/apps/docs/package-lock.json index dddd8ea1f..79c9be476 100644 --- a/apps/docs/package-lock.json +++ b/apps/docs/package-lock.json @@ -10,14 +10,18 @@ "dependencies": { "@docusaurus/core": "2.4.1", "@docusaurus/preset-classic": "2.4.1", + "@docusaurus/remark-plugin-npm2yarn": "^2.4.1", "@mdx-js/react": "^1.6.22", "clsx": "^1.2.1", + "postcss": "^8.4.25", "prism-react-renderer": "^1.3.5", + "raw-loader": "^4.0.2", "react": "^17.0.2", "react-dom": "^17.0.2" }, "devDependencies": { "@docusaurus/module-type-aliases": "2.4.1", + "@docusaurus/types": "^2.4.1", "@tsconfig/docusaurus": "^1.0.5", "docusaurus-plugin-typedoc": "^0.19.2", "typedoc": "^0.24.8", @@ -2450,6 +2454,19 @@ "react": "*" } }, + "node_modules/@docusaurus/remark-plugin-npm2yarn": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/@docusaurus/remark-plugin-npm2yarn/-/remark-plugin-npm2yarn-2.4.1.tgz", + "integrity": "sha512-RTX4hGCrwibqjDVf6edWVNwdvWHjx+YmfKwxqXxfhNnYjypTCXWTAyKeIfCUW2DNdtqAI2ZM0zFhB1maua2JbQ==", + "dependencies": { + "npm-to-yarn": "^2.0.0", + "tslib": "^2.4.1", + "unist-util-visit": "^2.0.3" + }, + "engines": { + "node": ">=16.14" + } + }, "node_modules/@docusaurus/theme-classic": { "version": "2.4.1", "resolved": "https://registry.npmjs.org/@docusaurus/theme-classic/-/theme-classic-2.4.1.tgz", @@ -8261,6 +8278,17 @@ "node": ">=8" } }, + "node_modules/npm-to-yarn": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/npm-to-yarn/-/npm-to-yarn-2.0.0.tgz", + "integrity": "sha512-/IbjiJ7vqbxfxJxAZ+QI9CCRjnIbvGxn5KQcSY9xHh0lMKc/Sgqmm7yp7KPmd6TiTZX5/KiSBKlkGHo59ucZbg==", + "engines": { + "node": ">=6.0.0" + }, + "funding": { + "url": "https://github.com/nebrelbug/npm-to-yarn?sponsor=1" + } + }, "node_modules/nprogress": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/nprogress/-/nprogress-0.2.0.tgz", @@ -9506,6 +9534,42 @@ "node": ">= 0.8" } }, + "node_modules/raw-loader": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/raw-loader/-/raw-loader-4.0.2.tgz", + "integrity": "sha512-ZnScIV3ag9A4wPX/ZayxL/jZH+euYb6FcUinPcgiQW0+UBtEv0O6Q3lGd3cqJ+GHH+rksEv3Pj99oxJ3u3VIKA==", + "dependencies": { + "loader-utils": "^2.0.0", + "schema-utils": "^3.0.0" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^4.0.0 || ^5.0.0" + } + }, + "node_modules/raw-loader/node_modules/schema-utils": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", + "dependencies": { + "@types/json-schema": "^7.0.8", + "ajv": "^6.12.5", + "ajv-keywords": "^3.5.2" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, "node_modules/rc": { "version": "1.2.8", "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", diff --git a/apps/docs/package.json b/apps/docs/package.json index 813002d3b..32e523978 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -22,6 +22,7 @@ "clsx": "^1.2.1", "postcss": "^8.4.25", "prism-react-renderer": "^1.3.5", + "raw-loader": "^4.0.2", "react": "^17.0.2", "react-dom": "^17.0.2" }, -- GitLab