diff --git a/apps/docs/docs/api/classes/BaseEmbedding.md b/apps/docs/docs/api/classes/BaseEmbedding.md index cf05666f536441288b74e2132ab928e2771141c5..4f51bc57e83882f7226d2131193b7d7e4c48cf78 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/5a765aa/packages/core/src/Embedding.ts#L206) +[Embedding.ts:206](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Embedding.ts#L206) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[Embedding.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L205) +[Embedding.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Embedding.ts#L205) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L197) +[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 f9fcb2849b95dbce7e5eb89badd4618b311608e3..e6295630a1a8d501bec1bf3d325aaa10c78757ff 100644 --- a/apps/docs/docs/api/classes/BaseIndex.md +++ b/apps/docs/docs/api/classes/BaseIndex.md @@ -43,7 +43,7 @@ they can be retrieved for our queries. #### Defined in -[indices/BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L78) +[indices/BaseIndex.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L104) ## Properties @@ -53,7 +53,7 @@ they can be retrieved for our queries. #### Defined in -[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L73) +[indices/BaseIndex.ts:99](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L99) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L75) +[indices/BaseIndex.ts:101](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L101) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L76) +[indices/BaseIndex.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L102) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L71) +[indices/BaseIndex.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L97) ___ @@ -93,7 +93,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L72) +[indices/BaseIndex.ts:98](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L98) ___ @@ -103,7 +103,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L74) +[indices/BaseIndex.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L100) ## Methods @@ -128,7 +128,7 @@ and response synthezier if they are not provided. #### Defined in -[indices/BaseIndex.ts:98](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L98) +[indices/BaseIndex.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L124) ___ @@ -150,4 +150,4 @@ Create a new retriever from the index. #### Defined in -[indices/BaseIndex.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L91) +[indices/BaseIndex.ts:117](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L117) diff --git a/apps/docs/docs/api/classes/BaseNode.md b/apps/docs/docs/api/classes/BaseNode.md index ef35d7736b02a0be33f1fca367506812a80b3c51..e83d8a1ef8882eab15dc8ea6b0fd5e958b0ecae8 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/5a765aa/packages/core/src/Node.ts#L48) +[Node.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L39) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L43) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L44) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L46) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L38) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L42) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L45) ## Accessors @@ -112,7 +112,7 @@ ___ #### Defined in -[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L104) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L84) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L58) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L94) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L72) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L62) ## Methods @@ -196,7 +196,7 @@ ___ #### Defined in -[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L124) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L54) +[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L54) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L116) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L55) +[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L55) ___ @@ -264,7 +264,7 @@ ___ #### Defined in -[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L52) +[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L52) ___ @@ -284,4 +284,4 @@ ___ #### Defined in -[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L56) +[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 fb80e7e95c14fdefeebfa09916e251c2b82c463f..710a3cda5f35112777d8b201aa09b5fd997c4854 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/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L68) +[callbacks/CallbackManager.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L65) +[callbacks/CallbackManager.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L66) +[callbacks/CallbackManager.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/callbacks/CallbackManager.ts#L66) diff --git a/apps/docs/docs/api/classes/CompactAndRefine.md b/apps/docs/docs/api/classes/CompactAndRefine.md index 7fd736b2bffb8891b697a2ff64a5014a15d6be13..78175260872fe5d1a8d55d10dcda676d3b6aa74c 100644 --- a/apps/docs/docs/api/classes/CompactAndRefine.md +++ b/apps/docs/docs/api/classes/CompactAndRefine.md @@ -34,7 +34,7 @@ CompactAndRefine is a slight variation of Refine that first compacts the text ch #### Defined in -[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L78) +[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L78) ## Properties @@ -48,7 +48,7 @@ CompactAndRefine is a slight variation of Refine that first compacts the text ch #### Defined in -[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L76) +[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L76) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L74) +[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L74) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L75) +[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L75) ## Methods @@ -103,4 +103,4 @@ ___ #### Defined in -[ResponseSynthesizer.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L181) +[ResponseSynthesizer.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L181) diff --git a/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md b/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md index 868fca253fb358a3ac1d474508388d02ea3d14f0..bc5f26241b32a453a50f517eac151d6b951f9614 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/5a765aa/packages/core/src/ChatEngine.ts#L75) +[ChatEngine.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/ChatEngine.ts#L71) +[ChatEngine.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ChatEngine.ts#L71) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L73) +[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ChatEngine.ts#L73) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L70) +[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ChatEngine.ts#L70) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L72) +[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ChatEngine.ts#L72) ## Methods @@ -104,7 +104,7 @@ Send message along with the class's current chat history to the LLM. #### Defined in -[ChatEngine.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L100) +[ChatEngine.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ChatEngine.ts#L100) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L89) +[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ChatEngine.ts#L89) ___ @@ -145,4 +145,4 @@ Resets the chat history so that it's empty. #### Defined in -[ChatEngine.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L118) +[ChatEngine.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ChatEngine.ts#L118) diff --git a/apps/docs/docs/api/classes/ContextChatEngine.md b/apps/docs/docs/api/classes/ContextChatEngine.md index 9326ce483eda9d77908c109f038380dd0dd50f12..6ce35a08fa6ef7abcf65a1318f851d5e4eee688e 100644 --- a/apps/docs/docs/api/classes/ContextChatEngine.md +++ b/apps/docs/docs/api/classes/ContextChatEngine.md @@ -31,7 +31,7 @@ ideally allowing the appropriate context to be surfaced for each query. #### Defined in -[ChatEngine.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L133) +[ChatEngine.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ChatEngine.ts#L133) ## Properties @@ -41,7 +41,7 @@ ideally allowing the appropriate context to be surfaced for each query. #### Defined in -[ChatEngine.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L131) +[ChatEngine.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ChatEngine.ts#L131) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[ChatEngine.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L130) +[ChatEngine.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ChatEngine.ts#L130) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[ChatEngine.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L129) +[ChatEngine.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ChatEngine.ts#L129) ## Methods @@ -88,7 +88,7 @@ Send message along with the class's current chat history to the LLM. #### Defined in -[ChatEngine.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L144) +[ChatEngine.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ChatEngine.ts#L144) ___ @@ -108,4 +108,4 @@ Resets the chat history so that it's empty. #### Defined in -[ChatEngine.ts:182](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L182) +[ChatEngine.ts:182](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ChatEngine.ts#L182) diff --git a/apps/docs/docs/api/classes/Document.md b/apps/docs/docs/api/classes/Document.md index 69dd09a68588dd7520878dd5301fa0dd9cd4d3b3..1f6987ea085e5d7ed31faf0db42be0f1d35199f3 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/5a765aa/packages/core/src/Node.ts#L216) +[Node.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L139) +[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L139) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L44) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L46) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L38) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L42) ___ @@ -144,7 +144,7 @@ ___ #### Defined in -[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L142) +[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L142) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L45) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L138) +[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L138) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L137) +[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L104) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[Node.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L225) +[Node.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L225) ___ @@ -236,7 +236,7 @@ TextNode.nextNode #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L84) ___ @@ -254,7 +254,7 @@ TextNode.nodeId #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L58) ___ @@ -272,7 +272,7 @@ TextNode.parentNode #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L94) ___ @@ -290,7 +290,7 @@ TextNode.prevNode #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L72) ___ @@ -308,7 +308,7 @@ TextNode.sourceNode #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L124) ___ @@ -344,7 +344,7 @@ ___ #### Defined in -[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L149) +[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L149) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L157) +[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L157) ___ @@ -386,7 +386,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L116) ___ @@ -410,7 +410,7 @@ ___ #### Defined in -[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L162) +[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L162) ___ @@ -433,7 +433,7 @@ ___ #### Defined in -[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L187) +[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L187) ___ @@ -451,7 +451,7 @@ ___ #### Defined in -[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L191) +[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L191) ___ @@ -469,7 +469,7 @@ ___ #### Defined in -[Node.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L221) +[Node.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L221) ___ @@ -493,4 +493,4 @@ ___ #### Defined in -[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L183) +[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 2022e166745b16e96193d3a3309999058823507d..7625667092269d9581d63f33e78b13c99f3a6674 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/5a765aa/packages/core/src/storage/FileSystem.ts#L25) +[storage/FileSystem.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/storage/FileSystem.ts#L38) +[storage/FileSystem.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/FileSystem.ts#L38) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L44) +[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/FileSystem.ts#L44) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L31) +[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/FileSystem.ts#L31) ___ @@ -126,4 +126,4 @@ ___ #### Defined in -[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L27) +[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 7ecec6dce25211567b5e1b44f56f7f9ed4df0197..9ed4d5c3ca2c73801b12fd2031405e01266e5603 100644 --- a/apps/docs/docs/api/classes/IndexDict.md +++ b/apps/docs/docs/api/classes/IndexDict.md @@ -33,7 +33,7 @@ The underlying structure of each index. #### Defined in -[indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L19) +[indices/BaseIndex.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L20) ## Properties @@ -43,7 +43,7 @@ The underlying structure of each index. #### Defined in -[indices/BaseIndex.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L34) +[indices/BaseIndex.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L42) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L16) +[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L17) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L33) +[indices/BaseIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L41) ___ @@ -81,7 +81,17 @@ ___ #### Defined in -[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L17) +[indices/BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L18) + +___ + +### type + +• **type**: `IndexStructType` = `IndexStructType.SIMPLE_DICT` + +#### Defined in + +[indices/BaseIndex.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L43) ## Methods @@ -102,7 +112,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L43) +[indices/BaseIndex.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L52) ___ @@ -120,4 +130,22 @@ ___ #### Defined in -[indices/BaseIndex.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L36) +[indices/BaseIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L45) + +___ + +### toJson + +▸ **toJson**(): `Record`<`string`, `unknown`\> + +#### Returns + +`Record`<`string`, `unknown`\> + +#### Overrides + +[IndexStruct](IndexStruct.md).[toJson](IndexStruct.md#tojson) + +#### Defined in + +[indices/BaseIndex.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L57) diff --git a/apps/docs/docs/api/classes/IndexList.md b/apps/docs/docs/api/classes/IndexList.md index 009a3aae700226864fe655409c9b2773a75a7a9b..912f3665d69d42fa4478eda60d58beef623283db 100644 --- a/apps/docs/docs/api/classes/IndexList.md +++ b/apps/docs/docs/api/classes/IndexList.md @@ -33,7 +33,7 @@ The underlying structure of each index. #### Defined in -[indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L19) +[indices/BaseIndex.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L20) ## Properties @@ -47,7 +47,7 @@ The underlying structure of each index. #### Defined in -[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L16) +[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L17) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L50) +[indices/BaseIndex.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L67) ___ @@ -71,7 +71,17 @@ ___ #### Defined in -[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L17) +[indices/BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L18) + +___ + +### type + +• **type**: `IndexStructType` = `IndexStructType.LIST` + +#### Defined in + +[indices/BaseIndex.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L68) ## Methods @@ -91,7 +101,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L52) +[indices/BaseIndex.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L70) ___ @@ -109,4 +119,22 @@ ___ #### Defined in -[indices/BaseIndex.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L24) +[indices/BaseIndex.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L32) + +___ + +### toJson + +▸ **toJson**(): `Record`<`string`, `unknown`\> + +#### Returns + +`Record`<`string`, `unknown`\> + +#### Overrides + +[IndexStruct](IndexStruct.md).[toJson](IndexStruct.md#tojson) + +#### Defined in + +[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L74) diff --git a/apps/docs/docs/api/classes/IndexNode.md b/apps/docs/docs/api/classes/IndexNode.md index cc28b064046f39afefd7b23adf0fed0d78570ec3..1cbd45e03a42a9d90ffe12c5e175f24482df5afe 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/5a765aa/packages/core/src/Node.ts#L144) +[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L139) +[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L139) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L44) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L46) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L38) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[Node.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L205) +[Node.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L205) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L42) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L142) +[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L142) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L45) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L138) +[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L138) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L137) +[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L104) ___ @@ -232,7 +232,7 @@ TextNode.nextNode #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L84) ___ @@ -250,7 +250,7 @@ TextNode.nodeId #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L58) ___ @@ -268,7 +268,7 @@ TextNode.parentNode #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L94) ___ @@ -286,7 +286,7 @@ TextNode.prevNode #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L72) ___ @@ -304,7 +304,7 @@ TextNode.sourceNode #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L124) ___ @@ -340,7 +340,7 @@ ___ #### Defined in -[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L149) +[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L149) ___ @@ -364,7 +364,7 @@ ___ #### Defined in -[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L157) +[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L157) ___ @@ -382,7 +382,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L116) ___ @@ -406,7 +406,7 @@ ___ #### Defined in -[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L162) +[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L162) ___ @@ -429,7 +429,7 @@ ___ #### Defined in -[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L187) +[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L187) ___ @@ -447,7 +447,7 @@ ___ #### Defined in -[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L191) +[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L191) ___ @@ -465,7 +465,7 @@ ___ #### Defined in -[Node.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L207) +[Node.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L207) ___ @@ -489,4 +489,4 @@ ___ #### Defined in -[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L183) +[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 6330d7cb06382227d2c670cdc5e01f446281c314..9d310659013ff58f442449bed75644aeacc5dc46 100644 --- a/apps/docs/docs/api/classes/IndexStruct.md +++ b/apps/docs/docs/api/classes/IndexStruct.md @@ -31,7 +31,7 @@ The underlying structure of each index. #### Defined in -[indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L19) +[indices/BaseIndex.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L20) ## Properties @@ -41,7 +41,7 @@ The underlying structure of each index. #### Defined in -[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L16) +[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L17) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L17) +[indices/BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L18) ## Methods @@ -65,4 +65,18 @@ ___ #### Defined in -[indices/BaseIndex.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L24) +[indices/BaseIndex.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L32) + +___ + +### toJson + +▸ **toJson**(): `Record`<`string`, `unknown`\> + +#### Returns + +`Record`<`string`, `unknown`\> + +#### Defined in + +[indices/BaseIndex.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L25) diff --git a/apps/docs/docs/api/classes/LLMQuestionGenerator.md b/apps/docs/docs/api/classes/LLMQuestionGenerator.md index e7b1df56ba44617cfc670f1ea9db50f7436b3457..7135a311af56967a1cce0ec2d249c51e63a2acb7 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/5a765aa/packages/core/src/QuestionGenerator.ts#L34) +[QuestionGenerator.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/QuestionGenerator.ts#L30) +[QuestionGenerator.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QuestionGenerator.ts#L30) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QuestionGenerator.ts#L32) +[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QuestionGenerator.ts#L32) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QuestionGenerator.ts#L31) +[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QuestionGenerator.ts#L31) ## Methods @@ -81,4 +81,4 @@ ___ #### Defined in -[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QuestionGenerator.ts#L40) +[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 054e9a318e223aca2ba569ecda66574c2bebee8c..69ad615a23389a69949917dbc5e9a14298494f2b 100644 --- a/apps/docs/docs/api/classes/ListIndex.md +++ b/apps/docs/docs/api/classes/ListIndex.md @@ -32,7 +32,7 @@ A ListIndex keeps nodes in a sequential list structure #### Defined in -[indices/list/ListIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L41) +[indices/list/ListIndex.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndex.ts#L43) ## Properties @@ -46,7 +46,7 @@ A ListIndex keeps nodes in a sequential list structure #### Defined in -[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L73) +[indices/BaseIndex.ts:99](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L99) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L75) +[indices/BaseIndex.ts:101](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L101) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L76) +[indices/BaseIndex.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L102) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L71) +[indices/BaseIndex.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L97) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L72) +[indices/BaseIndex.ts:98](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L98) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L74) +[indices/BaseIndex.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L100) ## Methods @@ -136,7 +136,7 @@ ___ #### Defined in -[indices/list/ListIndex.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L160) +[indices/list/ListIndex.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndex.ts#L186) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[indices/list/ListIndex.ts:154](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L154) +[indices/list/ListIndex.ts:180](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndex.ts#L180) ___ @@ -185,7 +185,7 @@ and response synthezier if they are not provided. #### Defined in -[indices/list/ListIndex.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L118) +[indices/list/ListIndex.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndex.ts#L144) ___ @@ -212,7 +212,7 @@ Create a new retriever from the index. #### Defined in -[indices/list/ListIndex.ts:105](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L105) +[indices/list/ListIndex.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndex.ts#L131) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[indices/list/ListIndex.ts:166](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L166) +[indices/list/ListIndex.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndex.ts#L192) ___ @@ -248,20 +248,20 @@ ___ #### Defined in -[indices/list/ListIndex.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L139) +[indices/list/ListIndex.ts:165](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndex.ts#L165) ___ ### fromDocuments -▸ `Static` **fromDocuments**(`args`): `Promise`<[`ListIndex`](ListIndex.md)\> +▸ `Static` **fromDocuments**(`documents`, `args`): `Promise`<[`ListIndex`](ListIndex.md)\> #### Parameters | Name | Type | | :------ | :------ | +| `documents` | [`Document`](Document.md)[] | | `args` | `Object` | -| `args.documents` | [`Document`](Document.md)[] | | `args.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | | `args.storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) | @@ -271,7 +271,7 @@ ___ #### Defined in -[indices/list/ListIndex.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L81) +[indices/list/ListIndex.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndex.ts#L106) ___ @@ -291,4 +291,4 @@ ___ #### Defined in -[indices/list/ListIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L45) +[indices/list/ListIndex.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndex.ts#L47) diff --git a/apps/docs/docs/api/classes/ListIndexLLMRetriever.md b/apps/docs/docs/api/classes/ListIndexLLMRetriever.md index aa0cb4dc5d1562fe541d74e2dfe1d8658de7fa19..e2e6fe18b4d74c5dba3a847f76fd08426308c9d9 100644 --- a/apps/docs/docs/api/classes/ListIndexLLMRetriever.md +++ b/apps/docs/docs/api/classes/ListIndexLLMRetriever.md @@ -31,7 +31,7 @@ LLM retriever for ListIndex. #### Defined in -[indices/list/ListIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L64) +[indices/list/ListIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndexRetriever.ts#L64) ## Properties @@ -41,7 +41,7 @@ LLM retriever for ListIndex. #### Defined in -[indices/list/ListIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L59) +[indices/list/ListIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndexRetriever.ts#L59) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[indices/list/ListIndexRetriever.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L58) +[indices/list/ListIndexRetriever.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndexRetriever.ts#L58) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[indices/list/ListIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L60) +[indices/list/ListIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndexRetriever.ts#L60) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[indices/list/ListIndexRetriever.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L57) +[indices/list/ListIndexRetriever.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndexRetriever.ts#L57) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[indices/list/ListIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L61) +[indices/list/ListIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndexRetriever.ts#L61) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -[indices/list/ListIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L62) +[indices/list/ListIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndexRetriever.ts#L62) ## Methods @@ -109,7 +109,7 @@ ___ #### Defined in -[indices/list/ListIndexRetriever.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L127) +[indices/list/ListIndexRetriever.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndexRetriever.ts#L127) ___ @@ -134,4 +134,4 @@ ___ #### Defined in -[indices/list/ListIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L81) +[indices/list/ListIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndexRetriever.ts#L81) diff --git a/apps/docs/docs/api/classes/ListIndexRetriever.md b/apps/docs/docs/api/classes/ListIndexRetriever.md index 79be1a3af4cf545a7e660292104df647efdfd39a..23dfc2c76bdfaffacc1a09459d9d3d7d2e0a2817 100644 --- a/apps/docs/docs/api/classes/ListIndexRetriever.md +++ b/apps/docs/docs/api/classes/ListIndexRetriever.md @@ -26,7 +26,7 @@ Simple retriever for ListIndex that returns all nodes #### Defined in -[indices/list/ListIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L22) +[indices/list/ListIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndexRetriever.ts#L22) ## Properties @@ -36,7 +36,7 @@ Simple retriever for ListIndex that returns all nodes #### Defined in -[indices/list/ListIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L20) +[indices/list/ListIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndexRetriever.ts#L20) ## Methods @@ -54,7 +54,7 @@ Simple retriever for ListIndex that returns all nodes #### Defined in -[indices/list/ListIndexRetriever.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L48) +[indices/list/ListIndexRetriever.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndexRetriever.ts#L48) ___ @@ -79,4 +79,4 @@ ___ #### Defined in -[indices/list/ListIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L26) +[indices/list/ListIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndexRetriever.ts#L26) diff --git a/apps/docs/docs/api/classes/LlamaDeuce.md b/apps/docs/docs/api/classes/LlamaDeuce.md index d058e79e46f61a64e482705a3f74eb4950d6fe46..8d5e85430e45ec7956c64d72b0eff9576610b8e1 100644 --- a/apps/docs/docs/api/classes/LlamaDeuce.md +++ b/apps/docs/docs/api/classes/LlamaDeuce.md @@ -26,7 +26,7 @@ Llama2 LLM implementation #### Defined in -[llm/LLM.ts:179](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L179) +[llm/LLM.ts:179](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L179) ## Properties @@ -36,7 +36,7 @@ Llama2 LLM implementation #### Defined in -[llm/LLM.ts:176](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L176) +[llm/LLM.ts:176](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L176) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[llm/LLM.ts:174](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L174) +[llm/LLM.ts:174](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L174) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[llm/LLM.ts:177](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L177) +[llm/LLM.ts:177](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L177) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[llm/LLM.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L175) +[llm/LLM.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L175) ## Methods @@ -93,7 +93,7 @@ Get a chat response from the LLM #### Defined in -[llm/LLM.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L199) +[llm/LLM.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L199) ___ @@ -120,7 +120,7 @@ Get a prompt completion from the LLM #### Defined in -[llm/LLM.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L224) +[llm/LLM.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L224) ___ @@ -140,4 +140,4 @@ ___ #### Defined in -[llm/LLM.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L186) +[llm/LLM.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L186) diff --git a/apps/docs/docs/api/classes/OpenAI.md b/apps/docs/docs/api/classes/OpenAI.md index c798df07dba659e368c02767cf27cd4bc12c0c9c..e0444a0f08e661bef8ff0d91f5f1361df60a7b36 100644 --- a/apps/docs/docs/api/classes/OpenAI.md +++ b/apps/docs/docs/api/classes/OpenAI.md @@ -26,7 +26,7 @@ OpenAI LLM implementation #### Defined in -[llm/LLM.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L75) +[llm/LLM.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L75) ## Properties @@ -36,7 +36,7 @@ OpenAI LLM implementation #### Defined in -[llm/LLM.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L73) +[llm/LLM.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L73) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[llm/LLM.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L71) +[llm/LLM.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L71) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[llm/LLM.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L69) +[llm/LLM.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L69) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[llm/LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L66) +[llm/LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L66) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[llm/LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L68) +[llm/LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L68) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[llm/LLM.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L72) +[llm/LLM.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L72) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[llm/LLM.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L70) +[llm/LLM.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L70) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[llm/LLM.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L67) +[llm/LLM.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L67) ## Methods @@ -133,7 +133,7 @@ Get a chat response from the LLM #### Defined in -[llm/LLM.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L102) +[llm/LLM.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L102) ___ @@ -160,7 +160,7 @@ Get a prompt completion from the LLM #### Defined in -[llm/LLM.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L144) +[llm/LLM.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L144) ___ @@ -180,4 +180,4 @@ ___ #### Defined in -[llm/LLM.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L85) +[llm/LLM.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L85) diff --git a/apps/docs/docs/api/classes/OpenAIEmbedding.md b/apps/docs/docs/api/classes/OpenAIEmbedding.md index a647aceba29e3753721c7643499468aa41cdd714..35d955f57d7a9b8a62a360c37c5d3d1eebc6532b 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/5a765aa/packages/core/src/Embedding.ts#L217) +[Embedding.ts:217](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/Embedding.ts#L215) +[Embedding.ts:215](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Embedding.ts#L215) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[Embedding.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L214) +[Embedding.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Embedding.ts#L214) ## Methods @@ -64,7 +64,7 @@ ___ #### Defined in -[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L224) +[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Embedding.ts#L224) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Embedding.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L240) +[Embedding.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Embedding.ts#L240) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[Embedding.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L236) +[Embedding.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Embedding.ts#L236) ___ @@ -138,4 +138,4 @@ ___ #### Defined in -[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L197) +[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Embedding.ts#L197) diff --git a/apps/docs/docs/api/classes/PDFReader.md b/apps/docs/docs/api/classes/PDFReader.md index 7d53a8c646ffbc53ba9b58a02271cbde460a9c64..1ea1dd867c3c53b5b3ddb7fdaad51af0d183b769 100644 --- a/apps/docs/docs/api/classes/PDFReader.md +++ b/apps/docs/docs/api/classes/PDFReader.md @@ -41,4 +41,4 @@ Read the text of a PDF #### Defined in -[readers/PDFReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/readers/PDFReader.ts#L12) +[readers/PDFReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/readers/PDFReader.ts#L12) diff --git a/apps/docs/docs/api/classes/Refine.md b/apps/docs/docs/api/classes/Refine.md index b809f59dd80a2f0d91041395ff71412f027ce4f7..bb68876f3e59ee9f1f63b4439d4078b3d097d243 100644 --- a/apps/docs/docs/api/classes/Refine.md +++ b/apps/docs/docs/api/classes/Refine.md @@ -34,7 +34,7 @@ A response builder that uses the query to ask the LLM generate a better response #### Defined in -[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L78) +[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L78) ## Properties @@ -44,7 +44,7 @@ A response builder that uses the query to ask the LLM generate a better response #### Defined in -[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L76) +[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L76) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L74) +[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L74) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L75) +[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L75) ## Methods @@ -91,7 +91,7 @@ BaseResponseBuilder.getResponse #### Defined in -[ResponseSynthesizer.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L88) +[ResponseSynthesizer.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L88) ___ @@ -113,7 +113,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L113) +[ResponseSynthesizer.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L113) ___ @@ -136,4 +136,4 @@ ___ #### Defined in -[ResponseSynthesizer.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L149) +[ResponseSynthesizer.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L149) diff --git a/apps/docs/docs/api/classes/Response.md b/apps/docs/docs/api/classes/Response.md index c1b06f9b8a4de2683037bb8d704876c13702faf6..9a40f7232c7389751da915fc74104a1b7e8468b4 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/5a765aa/packages/core/src/Response.ts#L10) +[Response.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/Response.ts#L7) +[Response.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Response.ts#L7) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Response.ts#L8) +[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Response.ts#L8) ## Methods @@ -57,7 +57,7 @@ ___ #### Defined in -[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Response.ts#L15) +[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Response.ts#L15) ___ @@ -71,4 +71,4 @@ ___ #### Defined in -[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Response.ts#L19) +[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 bb23f4ebae7b332eb8d5b60f033c92c16b8f7e6a..b76848fb8289fd3616741603e8f5668b23de896b 100644 --- a/apps/docs/docs/api/classes/ResponseSynthesizer.md +++ b/apps/docs/docs/api/classes/ResponseSynthesizer.md @@ -24,7 +24,7 @@ A ResponseSynthesizer is used to generate a response from a query and a list of #### Defined in -[ResponseSynthesizer.ts:285](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L285) +[ResponseSynthesizer.ts:285](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L285) ## Properties @@ -34,7 +34,7 @@ A ResponseSynthesizer is used to generate a response from a query and a list of #### Defined in -[ResponseSynthesizer.ts:282](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L282) +[ResponseSynthesizer.ts:282](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L282) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:283](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L283) +[ResponseSynthesizer.ts:283](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L283) ## Methods @@ -66,4 +66,4 @@ ___ #### Defined in -[ResponseSynthesizer.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L297) +[ResponseSynthesizer.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L297) diff --git a/apps/docs/docs/api/classes/RetrieverQueryEngine.md b/apps/docs/docs/api/classes/RetrieverQueryEngine.md index d9de4d491e5629dd17bdeecbc3325aa5b0ddbc31..c9a99246275803dc95211db2f0099d09b9998327 100644 --- a/apps/docs/docs/api/classes/RetrieverQueryEngine.md +++ b/apps/docs/docs/api/classes/RetrieverQueryEngine.md @@ -27,7 +27,7 @@ A query engine that uses a retriever to query an index and then synthesizes the #### Defined in -[QueryEngine.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L34) +[QueryEngine.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QueryEngine.ts#L34) ## Properties @@ -37,7 +37,7 @@ A query engine that uses a retriever to query an index and then synthesizes the #### Defined in -[QueryEngine.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L32) +[QueryEngine.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QueryEngine.ts#L32) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[QueryEngine.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L31) +[QueryEngine.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QueryEngine.ts#L31) ## Methods @@ -74,4 +74,4 @@ Query the query engine and get a response. #### Defined in -[QueryEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L45) +[QueryEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QueryEngine.ts#L45) diff --git a/apps/docs/docs/api/classes/SentenceSplitter.md b/apps/docs/docs/api/classes/SentenceSplitter.md index 231b4f428d6099141a1b361d834eee0a073d726c..6a6f1c54f71489ee1cbd67ba14d496df94384d98 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/5a765aa/packages/core/src/TextSplitter.ts#L33) +[TextSplitter.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/TextSplitter.ts#L26) +[TextSplitter.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/TextSplitter.ts#L26) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[TextSplitter.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L25) +[TextSplitter.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/TextSplitter.ts#L25) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L30) +[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/TextSplitter.ts#L30) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L29) +[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/TextSplitter.ts#L29) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L27) +[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/TextSplitter.ts#L27) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L28) +[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/TextSplitter.ts#L28) ## Methods @@ -108,7 +108,7 @@ ___ #### Defined in -[TextSplitter.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L153) +[TextSplitter.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/TextSplitter.ts#L153) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[TextSplitter.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L72) +[TextSplitter.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/TextSplitter.ts#L72) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -[TextSplitter.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L89) +[TextSplitter.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/TextSplitter.ts#L89) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[TextSplitter.ts:115](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L115) +[TextSplitter.ts:115](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/TextSplitter.ts#L115) ___ @@ -191,7 +191,7 @@ ___ #### Defined in -[TextSplitter.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L128) +[TextSplitter.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/TextSplitter.ts#L128) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[TextSplitter.ts:233](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L233) +[TextSplitter.ts:233](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/TextSplitter.ts#L233) ___ @@ -233,4 +233,4 @@ ___ #### Defined in -[TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L205) +[TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 46a6ded835c7cd1e75cce2c3fd57e4a95fa8775e..845e0ea556762e923a5a0b99c3364dcb68ed5c53 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/5a765aa/packages/core/src/ChatEngine.ts#L40) +[ChatEngine.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/ChatEngine.ts#L37) +[ChatEngine.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ChatEngine.ts#L37) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L38) +[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/ChatEngine.ts#L45) +[ChatEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/ChatEngine.ts#L54) +[ChatEngine.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ChatEngine.ts#L54) diff --git a/apps/docs/docs/api/classes/SimpleDirectoryReader.md b/apps/docs/docs/api/classes/SimpleDirectoryReader.md index 4816b46f6d93b47c7707d7528c756193abd33ab0..4baceb06881a94c2063230027e8c50e428e0fc70 100644 --- a/apps/docs/docs/api/classes/SimpleDirectoryReader.md +++ b/apps/docs/docs/api/classes/SimpleDirectoryReader.md @@ -40,4 +40,4 @@ Read all of the documents in a directory. Currently supports PDF and TXT files. #### Defined in -[readers/SimpleDirectoryReader.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/readers/SimpleDirectoryReader.ts#L37) +[readers/SimpleDirectoryReader.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/readers/SimpleDirectoryReader.ts#L37) diff --git a/apps/docs/docs/api/classes/SimpleNodeParser.md b/apps/docs/docs/api/classes/SimpleNodeParser.md index 9a019bbfbe9a367b6ad1e430b7764bffdaa00c8b..a8d79f855c533e865d8fa1bb9e5fe247efb70291 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/5a765aa/packages/core/src/NodeParser.ts#L64) +[NodeParser.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/NodeParser.ts#L61) +[NodeParser.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/NodeParser.ts#L61) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[NodeParser.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L62) +[NodeParser.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/NodeParser.ts#L62) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[NodeParser.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L60) +[NodeParser.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/NodeParser.ts#L95) +[NodeParser.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/NodeParser.ts#L95) ___ @@ -111,4 +111,4 @@ ___ #### Defined in -[NodeParser.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L82) +[NodeParser.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 fc735e976a3154346502ab2bd4a218c21339032e..b867d2e5643c3a37e33a14e300d6162090ca498d 100644 --- a/apps/docs/docs/api/classes/SimpleResponseBuilder.md +++ b/apps/docs/docs/api/classes/SimpleResponseBuilder.md @@ -26,7 +26,7 @@ A response builder that just concatenates responses. #### Defined in -[ResponseSynthesizer.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L49) +[ResponseSynthesizer.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L49) ## Properties @@ -36,7 +36,7 @@ A response builder that just concatenates responses. #### Defined in -[ResponseSynthesizer.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L46) +[ResponseSynthesizer.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L46) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L47) +[ResponseSynthesizer.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L47) ## Methods @@ -72,4 +72,4 @@ BaseResponseBuilder.getResponse #### Defined in -[ResponseSynthesizer.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L54) +[ResponseSynthesizer.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L54) diff --git a/apps/docs/docs/api/classes/SubQuestionOutputParser.md b/apps/docs/docs/api/classes/SubQuestionOutputParser.md index 04e874fefbd7c720b946bcedc74b3e4d97e319fb..af7df9c9e658b78a0db9f67a75cd3eb1980a3e0f 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/5a765aa/packages/core/src/OutputParser.ts#L97) +[OutputParser.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/OutputParser.ts#L97) ___ @@ -64,4 +64,4 @@ ___ #### Defined in -[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/OutputParser.ts#L89) +[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 2bedc9a180cae14c5dcf1c6e203028c21166df65..afaa85becba69e70715fbd372d7ecc57c8637e97 100644 --- a/apps/docs/docs/api/classes/SubQuestionQueryEngine.md +++ b/apps/docs/docs/api/classes/SubQuestionQueryEngine.md @@ -29,7 +29,7 @@ SubQuestionQueryEngine decomposes a question into subquestions and then #### Defined in -[QueryEngine.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L65) +[QueryEngine.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QueryEngine.ts#L65) ## Properties @@ -39,7 +39,7 @@ SubQuestionQueryEngine decomposes a question into subquestions and then #### Defined in -[QueryEngine.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L63) +[QueryEngine.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QueryEngine.ts#L63) ___ @@ -49,7 +49,7 @@ ___ #### Defined in -[QueryEngine.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L62) +[QueryEngine.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QueryEngine.ts#L62) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -[QueryEngine.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L61) +[QueryEngine.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QueryEngine.ts#L61) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -[QueryEngine.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L60) +[QueryEngine.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QueryEngine.ts#L60) ## Methods @@ -95,7 +95,7 @@ Query the query engine and get a response. #### Defined in -[QueryEngine.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L106) +[QueryEngine.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QueryEngine.ts#L106) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[QueryEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L134) +[QueryEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QueryEngine.ts#L134) ___ @@ -140,4 +140,4 @@ ___ #### Defined in -[QueryEngine.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L82) +[QueryEngine.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QueryEngine.ts#L82) diff --git a/apps/docs/docs/api/classes/TextFileReader.md b/apps/docs/docs/api/classes/TextFileReader.md index ba85d8abb96e565bf00716ac7d76fc718c3fd98b..d58639ff75f3414fc12be742da8194f9e86b92a3 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/5a765aa/packages/core/src/readers/SimpleDirectoryReader.ts#L12) +[readers/SimpleDirectoryReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 25a8218b78be1af774cf922370375ff273c16d8f..2c00a59ec48ed0fab19ee78c9391350eacb28f69 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/5a765aa/packages/core/src/Node.ts#L144) +[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L139) +[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L139) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L44) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L46) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L38) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L42) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L142) +[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L142) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L45) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L138) +[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L138) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L137) +[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L104) ___ @@ -210,7 +210,7 @@ BaseNode.nextNode #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L84) ___ @@ -228,7 +228,7 @@ BaseNode.nodeId #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L58) ___ @@ -246,7 +246,7 @@ BaseNode.parentNode #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L94) ___ @@ -264,7 +264,7 @@ BaseNode.prevNode #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L72) ___ @@ -282,7 +282,7 @@ BaseNode.sourceNode #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L124) ___ @@ -314,7 +314,7 @@ ___ #### Defined in -[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L149) +[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L149) ___ @@ -338,7 +338,7 @@ ___ #### Defined in -[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L157) +[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L157) ___ @@ -356,7 +356,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L116) ___ @@ -380,7 +380,7 @@ ___ #### Defined in -[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L162) +[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L162) ___ @@ -399,7 +399,7 @@ ___ #### Defined in -[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L187) +[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L187) ___ @@ -413,7 +413,7 @@ ___ #### Defined in -[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L191) +[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L191) ___ @@ -431,7 +431,7 @@ ___ #### Defined in -[Node.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L153) +[Node.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L153) ___ @@ -455,4 +455,4 @@ ___ #### Defined in -[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L183) +[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 49f66b6bf868047781beaad04436a1e638897d60..eaa954e5c3c0785c1fbc3e679698e1bab114990a 100644 --- a/apps/docs/docs/api/classes/TreeSummarize.md +++ b/apps/docs/docs/api/classes/TreeSummarize.md @@ -26,7 +26,7 @@ TreeSummarize repacks the text chunks into the smallest possible number of chunk #### Defined in -[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L212) +[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L212) ## Properties @@ -36,7 +36,7 @@ TreeSummarize repacks the text chunks into the smallest possible number of chunk #### Defined in -[ResponseSynthesizer.ts:210](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L210) +[ResponseSynthesizer.ts:210](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L210) ## Methods @@ -62,4 +62,4 @@ BaseResponseBuilder.getResponse #### Defined in -[ResponseSynthesizer.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L216) +[ResponseSynthesizer.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L216) diff --git a/apps/docs/docs/api/classes/VectorIndexRetriever.md b/apps/docs/docs/api/classes/VectorIndexRetriever.md index bb9f3f57da007a1adb3d809050403e2653e56add..2a805fc034dcc31b15a352955c11af743d06977c 100644 --- a/apps/docs/docs/api/classes/VectorIndexRetriever.md +++ b/apps/docs/docs/api/classes/VectorIndexRetriever.md @@ -28,7 +28,7 @@ VectorIndexRetriever retrieves nodes from a VectorIndex. #### Defined in -[indices/vectorStore/VectorIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L22) +[indices/vectorStore/VectorIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L22) ## Properties @@ -38,7 +38,7 @@ VectorIndexRetriever retrieves nodes from a VectorIndex. #### Defined in -[indices/vectorStore/VectorIndexRetriever.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L18) +[indices/vectorStore/VectorIndexRetriever.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L18) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[indices/vectorStore/VectorIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L20) +[indices/vectorStore/VectorIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L20) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[indices/vectorStore/VectorIndexRetriever.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L19) +[indices/vectorStore/VectorIndexRetriever.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L19) ## Methods @@ -76,7 +76,7 @@ ___ #### Defined in -[indices/vectorStore/VectorIndexRetriever.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L69) +[indices/vectorStore/VectorIndexRetriever.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L69) ___ @@ -101,4 +101,4 @@ ___ #### Defined in -[indices/vectorStore/VectorIndexRetriever.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L35) +[indices/vectorStore/VectorIndexRetriever.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L35) diff --git a/apps/docs/docs/api/classes/VectorStoreIndex.md b/apps/docs/docs/api/classes/VectorStoreIndex.md index 0cfb0932d27f78cf904dc415fc4dc6d58090444d..4713e177e110c0e748bac0e674fcaec380137607 100644 --- a/apps/docs/docs/api/classes/VectorStoreIndex.md +++ b/apps/docs/docs/api/classes/VectorStoreIndex.md @@ -32,7 +32,7 @@ The VectorStoreIndex, an index that stores the nodes only according to their vec #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L35) +[indices/vectorStore/VectorStoreIndex.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L36) ## Properties @@ -46,7 +46,7 @@ The VectorStoreIndex, an index that stores the nodes only according to their vec #### Defined in -[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L73) +[indices/BaseIndex.ts:99](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L99) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L75) +[indices/BaseIndex.ts:101](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L101) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L76) +[indices/BaseIndex.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L102) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L71) +[indices/BaseIndex.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L97) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L72) +[indices/BaseIndex.ts:98](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L98) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L33) +[indices/vectorStore/VectorStoreIndex.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L34) ## Methods @@ -145,7 +145,7 @@ and response synthezier if they are not provided. #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L181) +[indices/vectorStore/VectorStoreIndex.ts:208](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L208) ___ @@ -171,7 +171,7 @@ Create a new retriever from the index. #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:177](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L177) +[indices/vectorStore/VectorStoreIndex.ts:204](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L204) ___ @@ -196,13 +196,13 @@ Get embeddings for nodes and place them into the index. #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:120](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L120) +[indices/vectorStore/VectorStoreIndex.ts:145](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L145) ___ ### fromDocuments -▸ `Static` **fromDocuments**(`documents`, `storageContext?`, `serviceContext?`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\> +▸ `Static` **fromDocuments**(`documents`, `args`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\> High level API: split documents, get embeddings, and build index. @@ -211,8 +211,9 @@ High level API: split documents, get embeddings, and build index. | Name | Type | | :------ | :------ | | `documents` | [`Document`](Document.md)[] | -| `storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) | -| `serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | +| `args` | `Object` | +| `args.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | +| `args.storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) | #### Returns @@ -220,7 +221,7 @@ High level API: split documents, get embeddings, and build index. #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L155) +[indices/vectorStore/VectorStoreIndex.ts:180](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L180) ___ @@ -244,7 +245,7 @@ Get the embeddings for nodes. #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L92) +[indices/vectorStore/VectorStoreIndex.ts:117](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L117) ___ @@ -267,4 +268,4 @@ This is needed to handle persistence. #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L46) +[indices/vectorStore/VectorStoreIndex.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L47) diff --git a/apps/docs/docs/api/enums/ListRetrieverMode.md b/apps/docs/docs/api/enums/ListRetrieverMode.md index eca7908749688c1ed1bb6ee93ba53bfce3b431a7..516cd15439722b98e1c5bbc90e9c427da5bdd3c8 100644 --- a/apps/docs/docs/api/enums/ListRetrieverMode.md +++ b/apps/docs/docs/api/enums/ListRetrieverMode.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[indices/list/ListIndex.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L25) +[indices/list/ListIndex.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndex.ts#L26) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[indices/list/ListIndex.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L27) +[indices/list/ListIndex.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/list/ListIndex.ts#L28) diff --git a/apps/docs/docs/api/enums/MetadataMode.md b/apps/docs/docs/api/enums/MetadataMode.md index 803e4125f583e3093422cbd98c1207615ee0cd55..3982955e37756bcb33d29c3548db02f8cf645840 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/5a765aa/packages/core/src/Node.ts#L19) +[Node.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L19) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L20) +[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L20) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L21) +[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L21) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L22) +[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 eec1b06a69c5e8c054866363292b50a1f4528ff4..c0cbccf45519f9d1bb2e936e8edf33dd5f849ce3 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/5a765aa/packages/core/src/Node.ts#L8) +[Node.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L8) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L6) +[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L6) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L7) +[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L7) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L5) +[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L5) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[Node.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L4) +[Node.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 0eaf63bce5a15891d0673f1ede24edbd9e935442..24598d62be1309bea0ec079699ada894dc0ba153 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/5a765aa/packages/core/src/Node.ts#L15) +[Node.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L15) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L13) +[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L13) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L14) +[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L14) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[Node.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L12) +[Node.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 aa8294889c9367967458932fc947ff5bf392a9c7..df47e887fe70a405b94dfd1a00f8006cccd08df4 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/5a765aa/packages/core/src/Embedding.ts#L10) +[Embedding.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Embedding.ts#L10) ___ @@ -27,7 +27,7 @@ ___ #### Defined in -[Embedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L11) +[Embedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Embedding.ts#L11) ___ @@ -37,4 +37,4 @@ ___ #### Defined in -[Embedding.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L12) +[Embedding.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 f618b8a28790b70718c40f734715064a90b64587..af3e6da6d4b0204f225f30dbe0f5234195b444b8 100644 --- a/apps/docs/docs/api/interfaces/BaseIndexInit.md +++ b/apps/docs/docs/api/interfaces/BaseIndexInit.md @@ -26,7 +26,7 @@ custom_edit_url: null #### Defined in -[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L60) +[indices/BaseIndex.ts:86](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L86) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L62) +[indices/BaseIndex.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L88) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L63) +[indices/BaseIndex.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L89) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L58) +[indices/BaseIndex.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L84) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L59) +[indices/BaseIndex.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L85) ___ @@ -76,4 +76,4 @@ ___ #### Defined in -[indices/BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L61) +[indices/BaseIndex.ts:87](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L87) diff --git a/apps/docs/docs/api/interfaces/BaseOutputParser.md b/apps/docs/docs/api/interfaces/BaseOutputParser.md index 142ada1a7159834bfeff93644870c3b53c99b45c..5c32c82d3f8148128d3bc65d1bf24b076dd02d5f 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/5a765aa/packages/core/src/OutputParser.ts#L8) +[OutputParser.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/OutputParser.ts#L8) ___ @@ -56,4 +56,4 @@ ___ #### Defined in -[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/OutputParser.ts#L7) +[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 e62a3a062b06fce56a311952176c71ba9ee026df..9ff637dbafc4a20b4846e983da25a3ba38001188 100644 --- a/apps/docs/docs/api/interfaces/BaseQueryEngine.md +++ b/apps/docs/docs/api/interfaces/BaseQueryEngine.md @@ -34,4 +34,4 @@ Query the query engine and get a response. #### Defined in -[QueryEngine.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L24) +[QueryEngine.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QueryEngine.ts#L24) diff --git a/apps/docs/docs/api/interfaces/BaseQuestionGenerator.md b/apps/docs/docs/api/interfaces/BaseQuestionGenerator.md index 7eab714f527fc701cac274129e315e84296e7eab..a6077c6d18bb9b750fe89eb2115b97bf76623c5a 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/5a765aa/packages/core/src/QuestionGenerator.ts#L23) +[QuestionGenerator.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 3c88022396ba5b671077867e8ef0cf0dbc89a434..961fae734984c47381c8496e9dccc2b9db6a3e09 100644 --- a/apps/docs/docs/api/interfaces/BaseReader.md +++ b/apps/docs/docs/api/interfaces/BaseReader.md @@ -32,4 +32,4 @@ A reader takes imports data into Document objects. #### Defined in -[readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/readers/base.ts#L7) +[readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 e843602a6c3f42ac6cfa27bdb4bc79417f3e0392..a3175dbc16cdd27e960a9d2b4706586045162074 100644 --- a/apps/docs/docs/api/interfaces/BaseRetriever.md +++ b/apps/docs/docs/api/interfaces/BaseRetriever.md @@ -26,7 +26,7 @@ Retrievers retrieve the nodes that most closely match our query in similarity. #### Defined in -[Retriever.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Retriever.ts#L10) +[Retriever.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Retriever.ts#L10) ___ @@ -47,4 +47,4 @@ ___ #### Defined in -[Retriever.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Retriever.ts#L9) +[Retriever.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Retriever.ts#L9) diff --git a/apps/docs/docs/api/interfaces/BaseTool.md b/apps/docs/docs/api/interfaces/BaseTool.md index b42a963762b2213e4e7d67232070bb708634bab6..88989f8fb09f6e60180b599b000af0792b59a44c 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/5a765aa/packages/core/src/Tool.ts#L12) +[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 6f0f2754f4ec707fe55f2fb09bc868c0f4b0e074..6603ead5cb8f75939b05e5d3c987c0ef17f99741 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/5a765aa/packages/core/src/ChatEngine.ts#L25) +[ChatEngine.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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/5a765aa/packages/core/src/ChatEngine.ts#L30) +[ChatEngine.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 500d90f38584d737f955b00d1fdbd983d0c1deb6..e5387d3ca81bf86f2203d193e9f2c83d07c8b478 100644 --- a/apps/docs/docs/api/interfaces/ChatMessage.md +++ b/apps/docs/docs/api/interfaces/ChatMessage.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[llm/LLM.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L14) +[llm/LLM.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L14) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[llm/LLM.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L15) +[llm/LLM.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L15) diff --git a/apps/docs/docs/api/interfaces/ChatResponse.md b/apps/docs/docs/api/interfaces/ChatResponse.md index 978f5e3449bb3a53b1598ee70ccee97a5d5068bf..bd1d258f0a5908fa37b6c6bd9b6e7d5f760144a4 100644 --- a/apps/docs/docs/api/interfaces/ChatResponse.md +++ b/apps/docs/docs/api/interfaces/ChatResponse.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[llm/LLM.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L21) +[llm/LLM.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L21) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[llm/LLM.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L19) +[llm/LLM.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L19) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[llm/LLM.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L20) +[llm/LLM.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L20) diff --git a/apps/docs/docs/api/interfaces/Event.md b/apps/docs/docs/api/interfaces/Event.md index 013ac7c4d53769d6456ec72e8e5e5983ab109107..1a05659a70000d42386f232c58ba5743b634da8b 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/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L14) +[callbacks/CallbackManager.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/callbacks/CallbackManager.ts#L14) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L17) +[callbacks/CallbackManager.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/callbacks/CallbackManager.ts#L17) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L16) +[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/callbacks/CallbackManager.ts#L16) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L15) +[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 55842e2a89abceaeb03a9eac096ac24bd6c6cce3..6aa620a5eca78269db5be36687bd69789997537b 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/5a765aa/packages/core/src/storage/FileSystem.ts#L12) +[storage/FileSystem.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/FileSystem.ts#L12) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L13) +[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/FileSystem.ts#L13) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L11) +[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/FileSystem.ts#L11) ___ @@ -97,4 +97,4 @@ ___ #### Defined in -[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L10) +[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 658404067137cb0e8f1eba6f8d3ee0a0a4e26be8..fe569bcf705638e5674000b6b17b6cdc94f75a38 100644 --- a/apps/docs/docs/api/interfaces/LLM.md +++ b/apps/docs/docs/api/interfaces/LLM.md @@ -34,7 +34,7 @@ Get a chat response from the LLM #### Defined in -[llm/LLM.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L35) +[llm/LLM.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L35) ___ @@ -57,4 +57,4 @@ Get a prompt completion from the LLM #### Defined in -[llm/LLM.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L41) +[llm/LLM.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L41) diff --git a/apps/docs/docs/api/interfaces/NodeParser.md b/apps/docs/docs/api/interfaces/NodeParser.md index c8e1a4c415d809d1ceaa9efc112ed8002bf10a0a..f8a1a10d3b7cd47ac2867a5999cb90988c5a6807 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/5a765aa/packages/core/src/NodeParser.ts#L53) +[NodeParser.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 8989978fd219ceb4e35fd29ce6b66c7191f48346..6052208188b2af528060ce32e53c904def0db603 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/5a765aa/packages/core/src/Node.ts#L247) +[Node.ts:247](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L247) ___ @@ -26,4 +26,4 @@ ___ #### Defined in -[Node.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L246) +[Node.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 c10ce6a8345692bef38da24e601d71da680f4283..e80342a862c4b49b31a8e8eb83b5660b2b05aebd 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/5a765aa/packages/core/src/Node.ts#L238) +[Node.ts:238](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L238) ___ @@ -26,4 +26,4 @@ ___ #### Defined in -[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L239) +[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 d0fb2461de6469f7114bf3e47224c58ac64519fa..c4c6e6ea9f834b309c203b413e5d5a33edb78f05 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/5a765aa/packages/core/src/Tool.ts#L12) +[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Tool.ts#L12) ___ @@ -36,4 +36,4 @@ ___ #### Defined in -[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Tool.ts#L19) +[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 d1d807ad95e40269e937b07a54da004c7e54d88a..c1b3b3c3d783a5db15819fd76ce5e56d40069eae 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/5a765aa/packages/core/src/Node.ts#L29) +[Node.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L29) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L28) +[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L28) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L26) +[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L26) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L27) +[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 f671f692fbcd344b724869536e998fa22cb86892..97255a10b55247e597ede5767d0fb35b644b268f 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/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L21) +[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/callbacks/CallbackManager.ts#L21) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L47) +[callbacks/CallbackManager.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/callbacks/CallbackManager.ts#L47) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L46) +[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 a5a5774ff6e4facad2430cbeb49ffbd94a4978a8..b07af37ff74d7a3fc0914fc192280c516ddee10c 100644 --- a/apps/docs/docs/api/interfaces/ServiceContext.md +++ b/apps/docs/docs/api/interfaces/ServiceContext.md @@ -16,7 +16,7 @@ The ServiceContext is a collection of components that are used in different part #### Defined in -[ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L15) +[ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ServiceContext.ts#L15) ___ @@ -26,7 +26,7 @@ ___ #### Defined in -[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L13) +[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ServiceContext.ts#L13) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[ServiceContext.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L11) +[ServiceContext.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ServiceContext.ts#L11) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L14) +[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ServiceContext.ts#L14) ___ @@ -56,4 +56,4 @@ ___ #### Defined in -[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L12) +[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ServiceContext.ts#L12) diff --git a/apps/docs/docs/api/interfaces/ServiceContextOptions.md b/apps/docs/docs/api/interfaces/ServiceContextOptions.md index 8c0d5f060e45b627073d01e6b63f0e9ce49a7b1c..c58026546c672d83e1cde7de0c558afc84fb2468 100644 --- a/apps/docs/docs/api/interfaces/ServiceContextOptions.md +++ b/apps/docs/docs/api/interfaces/ServiceContextOptions.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L24) +[ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ServiceContext.ts#L24) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[ServiceContext.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L27) +[ServiceContext.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ServiceContext.ts#L27) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L26) +[ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ServiceContext.ts#L26) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L22) +[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ServiceContext.ts#L22) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[ServiceContext.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L20) +[ServiceContext.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ServiceContext.ts#L20) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L23) +[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ServiceContext.ts#L23) ___ @@ -74,4 +74,4 @@ ___ #### Defined in -[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L21) +[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ServiceContext.ts#L21) diff --git a/apps/docs/docs/api/interfaces/StorageContext.md b/apps/docs/docs/api/interfaces/StorageContext.md index e7caa95b06d7bb667b53d66efb09a1d2a79453f6..98853c0dff1edee8e7672ab2b019999a12e7c231 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/5a765aa/packages/core/src/storage/StorageContext.ts#L15) +[storage/StorageContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/StorageContext.ts#L15) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/StorageContext.ts#L16) +[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/StorageContext.ts#L16) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/StorageContext.ts#L17) +[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 dce6333c6fd3a3285bc70a018dd176e240c10732..5e3bb62f601b2f7fc832104a88d4da0181227cd6 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/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L21) +[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/callbacks/CallbackManager.ts#L21) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L40) +[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/callbacks/CallbackManager.ts#L40) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L41) +[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/callbacks/CallbackManager.ts#L41) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L42) +[callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 c92e739a02f887e3e88947288bac78b65683a8b4..f58ef1002bb01d80445a8353a294fb3ff7628bd6 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/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L29) +[callbacks/CallbackManager.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/callbacks/CallbackManager.ts#L29) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L27) +[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/callbacks/CallbackManager.ts#L27) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L25) +[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/callbacks/CallbackManager.ts#L25) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L28) +[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/callbacks/CallbackManager.ts#L28) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L26) +[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 8ae49b96390a3aaf6832a45d459b46bbdc358eec..e07075783f9222b5d2e9dcfd7faf1c6a1e67f26e 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/5a765aa/packages/core/src/OutputParser.ts#L16) +[OutputParser.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/OutputParser.ts#L16) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/OutputParser.ts#L15) +[OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 20be556122b49f8571ba0b54b00ce6a11c4ec678..e4d6371f75fa84b10fabbde8d71768c96331038b 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/5a765aa/packages/core/src/QuestionGenerator.ts#L15) +[QuestionGenerator.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/QuestionGenerator.ts#L15) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QuestionGenerator.ts#L16) +[QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 9d0c371b4d96c3fadd9bbd50b9118bf57b296177..65b381d80152e04a3d183a1b82d4f05b62ed43f7 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/5a765aa/packages/core/src/Tool.ts#L4) +[Tool.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Tool.ts#L4) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Tool.ts#L5) +[Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Tool.ts#L5) diff --git a/apps/docs/docs/api/interfaces/VectorIndexConstructorProps.md b/apps/docs/docs/api/interfaces/VectorIndexConstructorProps.md index 6f157be1c6a735aa4555d0f3dbcb020d631d111d..60365b3bea8f590946d08f6fb0556184452b6bff 100644 --- a/apps/docs/docs/api/interfaces/VectorIndexConstructorProps.md +++ b/apps/docs/docs/api/interfaces/VectorIndexConstructorProps.md @@ -24,7 +24,7 @@ custom_edit_url: null #### Defined in -[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L60) +[indices/BaseIndex.ts:86](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L86) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L62) +[indices/BaseIndex.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L88) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L63) +[indices/BaseIndex.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L89) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L58) +[indices/BaseIndex.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L84) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L59) +[indices/BaseIndex.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L85) ___ @@ -94,4 +94,4 @@ ___ #### Defined in -[indices/BaseIndex.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L112) +[indices/BaseIndex.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L139) diff --git a/apps/docs/docs/api/interfaces/VectorIndexOptions.md b/apps/docs/docs/api/interfaces/VectorIndexOptions.md index 90a595c0d4166ecdd189811e0bcf3e1f7a7aedbe..f4577aa58f5edf25734813332b634b4e5c9c5187 100644 --- a/apps/docs/docs/api/interfaces/VectorIndexOptions.md +++ b/apps/docs/docs/api/interfaces/VectorIndexOptions.md @@ -8,13 +8,23 @@ custom_edit_url: null ## Properties +### indexId + +• `Optional` **indexId**: `string` + +#### Defined in + +[indices/BaseIndex.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L133) + +___ + ### indexStruct • `Optional` **indexStruct**: [`IndexDict`](../classes/IndexDict.md) #### Defined in -[indices/BaseIndex.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L106) +[indices/BaseIndex.ts:132](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L132) ___ @@ -24,7 +34,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:105](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L105) +[indices/BaseIndex.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L131) ___ @@ -34,7 +44,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L107) +[indices/BaseIndex.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L134) ___ @@ -44,4 +54,4 @@ ___ #### Defined in -[indices/BaseIndex.ts:108](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L108) +[indices/BaseIndex.ts:135](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/indices/BaseIndex.ts#L135) diff --git a/apps/docs/docs/api/interfaces/WalkableFileSystem.md b/apps/docs/docs/api/interfaces/WalkableFileSystem.md index 00ed9579903a2865da6cb39cced85437a6b9f896..94a8fc6bbc2e3e01df0e57b8e46758215c272339 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/5a765aa/packages/core/src/storage/FileSystem.ts#L17) +[storage/FileSystem.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/FileSystem.ts#L17) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L18) +[storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/FileSystem.ts#L18) diff --git a/apps/docs/docs/api/modules.md b/apps/docs/docs/api/modules.md index 8067de3eb72912d3753c0ceda8b4f7994b829602..c4ecd0fb9d8e9b6d2aa09f8006d1ca06a62ab5ff 100644 --- a/apps/docs/docs/api/modules.md +++ b/apps/docs/docs/api/modules.md @@ -95,7 +95,7 @@ custom_edit_url: null #### Defined in -[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L49) +[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/FileSystem.ts#L49) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[llm/LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L25) +[llm/LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L25) ___ @@ -115,7 +115,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L11) +[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/callbacks/CallbackManager.ts#L11) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L12) +[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/callbacks/CallbackManager.ts#L12) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L32) +[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Node.ts#L32) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/readers/SimpleDirectoryReader.ts#L26) +[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/readers/SimpleDirectoryReader.ts#L26) ___ @@ -182,7 +182,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Prompt.ts#L10) ## Variables @@ -206,7 +206,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[llm/LLM.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L152) +[llm/LLM.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L152) ___ @@ -231,7 +231,7 @@ We currently support GPT-3.5 and GPT-4 models #### Defined in -[llm/LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L57) +[llm/LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L57) ___ @@ -241,7 +241,7 @@ ___ #### Defined in -[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L5) +[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/constants.ts#L5) ___ @@ -251,7 +251,7 @@ ___ #### Defined in -[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L6) +[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/constants.ts#L6) ___ @@ -261,7 +261,7 @@ ___ #### Defined in -[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L4) +[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/constants.ts#L4) ___ @@ -271,7 +271,7 @@ ___ #### Defined in -[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/constants.ts#L1) +[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/constants.ts#L1) ___ @@ -281,7 +281,7 @@ ___ #### Defined in -[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L1) +[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/constants.ts#L1) ___ @@ -291,7 +291,7 @@ ___ #### Defined in -[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/constants.ts#L4) +[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/constants.ts#L4) ___ @@ -301,7 +301,7 @@ ___ #### Defined in -[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L10) +[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/constants.ts#L10) ___ @@ -311,7 +311,7 @@ ___ #### Defined in -[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L62) +[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/FileSystem.ts#L62) ___ @@ -321,7 +321,7 @@ ___ #### Defined in -[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/constants.ts#L6) +[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/constants.ts#L6) ___ @@ -331,7 +331,7 @@ ___ #### Defined in -[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/constants.ts#L3) +[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/constants.ts#L3) ___ @@ -341,7 +341,7 @@ ___ #### Defined in -[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/constants.ts#L7) +[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/constants.ts#L7) ___ @@ -351,7 +351,7 @@ ___ #### Defined in -[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L2) +[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/constants.ts#L2) ___ @@ -361,7 +361,7 @@ ___ #### Defined in -[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L11) +[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/constants.ts#L11) ___ @@ -371,7 +371,7 @@ ___ #### Defined in -[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/constants.ts#L2) +[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/constants.ts#L2) ___ @@ -381,7 +381,7 @@ ___ #### Defined in -[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L7) +[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/constants.ts#L7) ___ @@ -391,7 +391,7 @@ ___ #### Defined in -[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/constants.ts#L5) +[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/constants.ts#L5) ___ @@ -410,7 +410,7 @@ ___ #### Defined in -[llm/LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L44) +[llm/LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L44) ___ @@ -429,7 +429,7 @@ ___ #### Defined in -[llm/LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L49) +[llm/LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/llm/LLM.ts#L49) ___ @@ -439,7 +439,7 @@ ___ #### Defined in -[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/GlobalsHelper.ts#L42) +[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/GlobalsHelper.ts#L42) ## Functions @@ -459,7 +459,7 @@ ___ #### Defined in -[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L198) +[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Prompt.ts#L198) ___ @@ -483,7 +483,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Prompt.ts#L10) ___ @@ -507,7 +507,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Prompt.ts#L10) ___ @@ -531,7 +531,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Prompt.ts#L10) ___ @@ -555,7 +555,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Prompt.ts#L10) ___ @@ -579,7 +579,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Prompt.ts#L10) ___ @@ -603,7 +603,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Prompt.ts#L10) ___ @@ -627,7 +627,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Prompt.ts#L10) ___ @@ -653,7 +653,7 @@ A promise that resolves to true if the file exists, false otherwise. #### Defined in -[storage/FileSystem.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L74) +[storage/FileSystem.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/FileSystem.ts#L74) ___ @@ -667,7 +667,7 @@ ___ #### Defined in -[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L51) +[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/FileSystem.ts#L51) ___ @@ -690,7 +690,7 @@ ___ #### Defined in -[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L15) +[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/NodeParser.ts#L15) ___ @@ -711,7 +711,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:262](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L262) +[ResponseSynthesizer.ts:262](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ResponseSynthesizer.ts#L262) ___ @@ -732,7 +732,7 @@ ___ #### Defined in -[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L5) +[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/NodeParser.ts#L5) ___ @@ -758,7 +758,7 @@ Get the top K embeddings from a list of embeddings ordered by similarity to the #### Defined in -[Embedding.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L77) +[Embedding.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Embedding.ts#L77) ___ @@ -782,7 +782,7 @@ ___ #### Defined in -[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L119) +[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Embedding.ts#L119) ___ @@ -808,7 +808,7 @@ ___ #### Defined in -[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L131) +[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Embedding.ts#L131) ___ @@ -828,7 +828,7 @@ ___ #### Defined in -[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L300) +[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Prompt.ts#L300) ___ @@ -848,7 +848,7 @@ ___ #### Defined in -[ServiceContext.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L30) +[ServiceContext.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ServiceContext.ts#L30) ___ @@ -877,7 +877,7 @@ ___ #### Defined in -[ServiceContext.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L48) +[ServiceContext.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/ServiceContext.ts#L48) ___ @@ -903,7 +903,7 @@ similartiy score with higher numbers meaning the two embeddings are more similar #### Defined in -[Embedding.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L22) +[Embedding.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/Embedding.ts#L22) ___ @@ -923,7 +923,7 @@ ___ #### Defined in -[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/StorageContext.ts#L28) +[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/packages/core/src/storage/StorageContext.ts#L28) ___ @@ -946,4 +946,4 @@ Recursively traverses a directory and yields all the paths to the files in it. #### Defined in -[storage/FileSystem.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L91) +[storage/FileSystem.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/80d3fc9/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 1b4ca433804742e90d5b8239fea8ac462ac1263b..ec77b43fa81563d761126c7303b6b3e27e642102 100644 --- a/apps/docs/docs/end_to_end.md +++ b/apps/docs/docs/end_to_end.md @@ -18,6 +18,10 @@ Create a list index and query it. This example also use the `LLMRetriever`, whic 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. +## [Save / Load an Index](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/storageContext.ts) + +Create and load a vector index. Persistance to disk in LlamaIndex.TS happens automatically once a storage context object is created. + ## [Customized Vector Index](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/vectorIndexCustomize.ts) Create a vector index and query it, while also configuring the the `LLM`, the `ServiceContext`, and the `similarity_top_k`. diff --git a/apps/simple/CHANGELOG.md b/apps/simple/CHANGELOG.md index 08c31ab55b9971665109c784b4837fef88c3d740..7a910ee47f3eaf9351865d5df8841e6f6b969e48 100644 --- a/apps/simple/CHANGELOG.md +++ b/apps/simple/CHANGELOG.md @@ -1,5 +1,12 @@ # simple +## 0.0.4 + +### Patch Changes + +- Updated dependencies + - llamaindex@0.0.6 + ## 0.0.3 ### Patch Changes diff --git a/apps/simple/chatEngine.ts b/apps/simple/chatEngine.ts index a79bfd88c6065e09b87586da0a13020b4c93709b..7dabde5577a61911437ae7892a5025d21c32dfcd 100644 --- a/apps/simple/chatEngine.ts +++ b/apps/simple/chatEngine.ts @@ -15,8 +15,7 @@ async function main() { const serviceContext = serviceContextFromDefaults({ chunkSize: 512 }); const index = await VectorStoreIndex.fromDocuments( [document], - undefined, - serviceContext + { serviceContext } ); const retriever = index.asRetriever(); retriever.similarityTopK = 5; diff --git a/apps/simple/listIndex.ts b/apps/simple/listIndex.ts index 982f434717dc28141316603122aa5b70ee8c9f07..0271e9d6bfb4fc91626e276af62fd7893ee4708c 100644 --- a/apps/simple/listIndex.ts +++ b/apps/simple/listIndex.ts @@ -14,10 +14,10 @@ async function main() { }), }); const document = new Document({ text: essay }); - const index = await ListIndex.fromDocuments({ - documents: [document], - serviceContext, - }); + const index = await ListIndex.fromDocuments( + [document], + { serviceContext } + ); const queryEngine = index.asQueryEngine({ retriever: index.asRetriever({ mode: ListRetrieverMode.LLM }), }); diff --git a/apps/simple/package.json b/apps/simple/package.json index 71d2506a0dcdf603325a58bb34f774e75018ef5e..f44e21d52583fcfbe07b71b599b79a8b6ea2a806 100644 --- a/apps/simple/package.json +++ b/apps/simple/package.json @@ -1,5 +1,5 @@ { - "version": "0.0.3", + "version": "0.0.4", "private": true, "name": "simple", "dependencies": { diff --git a/examples/persist.ts b/apps/simple/storageContext.ts similarity index 61% rename from examples/persist.ts rename to apps/simple/storageContext.ts index 52e0e22be292c3eb30c42ea7b15764efeac73f69..56be8010a6f67032b4cbe630e8fc5b9000c0b4ff 100644 --- a/examples/persist.ts +++ b/apps/simple/storageContext.ts @@ -1,19 +1,15 @@ -import fs from "fs/promises"; import { Document, VectorStoreIndex, storageContextFromDefaults } from "llamaindex"; +import essay from "./essay"; -async function main() { - // Load essay from abramov.txt in Node - const essay = await fs.readFile( - "node_modules/llamaindex/examples/abramov.txt", - "utf-8" - ); +async function main() { // Create Document object with essay const document = new Document({ text: essay }); - // Split text and create embeddings. Store them in a VectorStoreIndex with persistence + // Split text and create embeddings. Store them in a VectorStoreIndex + // persist the vector store automatically with the storage context const storageContext = await storageContextFromDefaults({ persistDir: "./storage" }); - const index = await VectorStoreIndex.fromDocuments([document], storageContext); + const index = await VectorStoreIndex.fromDocuments([document], { storageContext }); // Query the index const queryEngine = index.asQueryEngine(); @@ -23,6 +19,14 @@ async function main() { // Output response console.log(response.toString()); + + // load the index + const loadedIndex = await VectorStoreIndex.init({ storageContext }); + const laodedQueryEngine = loadedIndex.asQueryEngine(); + const loadedResponse = await laodedQueryEngine.query( + "What did the author do growing up?" + ); + console.log(loadedResponse.toString()); } main().catch(console.error); diff --git a/apps/simple/vectorIndexCustomize.ts b/apps/simple/vectorIndexCustomize.ts index aa7ebc6ae0a0000d46f1686d8052ed2926d423e2..69e128dc849761e187b7b4b7f0e7eba9905e6fd6 100644 --- a/apps/simple/vectorIndexCustomize.ts +++ b/apps/simple/vectorIndexCustomize.ts @@ -9,7 +9,7 @@ async function main() { { llm: new OpenAI({ model: "gpt-3.5-turbo", temperature: 0.0 }) } ); - const index = await VectorStoreIndex.fromDocuments([document], undefined, serviceContext); + const index = await VectorStoreIndex.fromDocuments([document], { serviceContext }); const retriever = index.asRetriever(); retriever.similarityTopK = 5; diff --git a/examples/chatEngine.ts b/examples/chatEngine.ts index a79bfd88c6065e09b87586da0a13020b4c93709b..7dabde5577a61911437ae7892a5025d21c32dfcd 100644 --- a/examples/chatEngine.ts +++ b/examples/chatEngine.ts @@ -15,8 +15,7 @@ async function main() { const serviceContext = serviceContextFromDefaults({ chunkSize: 512 }); const index = await VectorStoreIndex.fromDocuments( [document], - undefined, - serviceContext + { serviceContext } ); const retriever = index.asRetriever(); retriever.similarityTopK = 5; diff --git a/examples/listIndex.ts b/examples/listIndex.ts index 982f434717dc28141316603122aa5b70ee8c9f07..0271e9d6bfb4fc91626e276af62fd7893ee4708c 100644 --- a/examples/listIndex.ts +++ b/examples/listIndex.ts @@ -14,10 +14,10 @@ async function main() { }), }); const document = new Document({ text: essay }); - const index = await ListIndex.fromDocuments({ - documents: [document], - serviceContext, - }); + const index = await ListIndex.fromDocuments( + [document], + { serviceContext } + ); const queryEngine = index.asQueryEngine({ retriever: index.asRetriever({ mode: ListRetrieverMode.LLM }), }); diff --git a/examples/package.json b/examples/package.json index bdd689b885947a14bc3ccd751e43fec1593c6f45..3387d027d2308af4bf2115e6b2a5bea0347bbbf9 100644 --- a/examples/package.json +++ b/examples/package.json @@ -3,7 +3,7 @@ "private": true, "name": "simple", "dependencies": { - "llamaindex": "0.0.5" + "llamaindex": "0.0.6" }, "devDependencies": { "@types/node": "^18" diff --git a/examples/storageContext.ts b/examples/storageContext.ts index eb71ceefc586b7dff3fbde32c1475d7934bae80b..56be8010a6f67032b4cbe630e8fc5b9000c0b4ff 100644 --- a/examples/storageContext.ts +++ b/examples/storageContext.ts @@ -1,20 +1,15 @@ -import fs from "fs/promises"; import { Document, VectorStoreIndex, storageContextFromDefaults } from "llamaindex"; +import essay from "./essay"; -async function main() { - // Load essay from abramov.txt in Node - const essay = await fs.readFile( - "node_modules/llamaindex/examples/abramov.txt", - "utf-8" - ); +async function main() { // Create Document object with essay const document = new Document({ text: essay }); // Split text and create embeddings. Store them in a VectorStoreIndex // persist the vector store automatically with the storage context const storageContext = await storageContextFromDefaults({ persistDir: "./storage" }); - const index = await VectorStoreIndex.fromDocuments([document], storageContext); + const index = await VectorStoreIndex.fromDocuments([document], { storageContext }); // Query the index const queryEngine = index.asQueryEngine(); @@ -26,7 +21,7 @@ async function main() { console.log(response.toString()); // load the index - const loadedIndex = await VectorStoreIndex.fromDocuments([], storageContext); + const loadedIndex = await VectorStoreIndex.init({ storageContext }); const laodedQueryEngine = loadedIndex.asQueryEngine(); const loadedResponse = await laodedQueryEngine.query( "What did the author do growing up?" diff --git a/examples/vectorIndexCustomize.ts b/examples/vectorIndexCustomize.ts index aa7ebc6ae0a0000d46f1686d8052ed2926d423e2..69e128dc849761e187b7b4b7f0e7eba9905e6fd6 100644 --- a/examples/vectorIndexCustomize.ts +++ b/examples/vectorIndexCustomize.ts @@ -9,7 +9,7 @@ async function main() { { llm: new OpenAI({ model: "gpt-3.5-turbo", temperature: 0.0 }) } ); - const index = await VectorStoreIndex.fromDocuments([document], undefined, serviceContext); + const index = await VectorStoreIndex.fromDocuments([document], { serviceContext }); const retriever = index.asRetriever(); retriever.similarityTopK = 5; diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md index dc7ecc856201132b7d081ead2eb490cce788b743..a9d9f9c24b253b751fe1f907592217695dd38c4d 100644 --- a/packages/core/CHANGELOG.md +++ b/packages/core/CHANGELOG.md @@ -1,5 +1,11 @@ # llamaindex +## 0.0.6 + +### Patch Changes + +- Better persistence interface (thanks Logan) + ## 0.0.5 ### Patch Changes diff --git a/packages/core/package.json b/packages/core/package.json index dab83e3f8b00bd69de31be0e8c49173fcb106dad..6ec7784be198ff0c4cf2026e18aac2b9d4582877 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "llamaindex", - "version": "0.0.5", + "version": "0.0.6", "dependencies": { "js-tiktoken": "^1.0.7", "lodash": "^4.17.21", diff --git a/packages/core/src/dataStructs.ts b/packages/core/src/dataStructs.ts index 82052c22fd56084a344224cddc0c8d92888c5f9f..e1d549f536338ca177f8c2bcff7c673950c2a72c 100644 --- a/packages/core/src/dataStructs.ts +++ b/packages/core/src/dataStructs.ts @@ -1,27 +1,26 @@ +import { IndexList, IndexDict } from "./indices"; + export enum IndexStructType { SIMPLE_DICT = "simple_dict", + LIST = "list", } export interface IndexStruct { readonly indexId: string; readonly summary?: string; - readonly type: IndexStructType; -} - -export function indexStructToJson(indexStruct: IndexStruct): { - [key: string]: any; -} { - return { - indexId: indexStruct.indexId, - summary: indexStruct.summary, - type: indexStruct.type, - }; + readonly toJson: () => Record<string, unknown>; } export function jsonToIndexStruct(json: any): IndexStruct { - return { - indexId: json.indexId, - summary: json.summary, - type: json.type, - }; + if (json.type === IndexStructType.LIST) { + const indexList = new IndexList(json.indexId, json.summary); + indexList.nodes = json.nodes; + return indexList; + } else if (json.type === IndexStructType.SIMPLE_DICT) { + const indexDict = new IndexDict(json.indexId, json.summary); + indexDict.nodesDict = json.nodesDict; + return indexDict; + } else { + throw new Error(`Unknown index struct type: ${json.type}`); + } } diff --git a/packages/core/src/indices/BaseIndex.ts b/packages/core/src/indices/BaseIndex.ts index 899ba8163ee44d1886d39a8c724be9761845fab6..db9867ea43de48d2aa4b304c055399ad3cff6a14 100644 --- a/packages/core/src/indices/BaseIndex.ts +++ b/packages/core/src/indices/BaseIndex.ts @@ -8,6 +8,7 @@ import { VectorStore } from "../storage/vectorStore/types"; import { BaseIndexStore } from "../storage/indexStore/types"; import { BaseQueryEngine } from "../QueryEngine"; import { ResponseSynthesizer } from "../ResponseSynthesizer"; +import { IndexStructType } from "../dataStructs"; /** * The underlying structure of each index. @@ -21,6 +22,13 @@ export abstract class IndexStruct { this.summary = summary; } + toJson(): Record<string, unknown> { + return { + indexId: this.indexId, + summary: this.summary, + }; + } + getSummary(): string { if (this.summary === undefined) { throw new Error("summary field of the index dict is not set"); @@ -32,6 +40,7 @@ export abstract class IndexStruct { export class IndexDict extends IndexStruct { nodesDict: Record<string, BaseNode> = {}; docStore: Record<string, Document> = {}; // FIXME: this should be implemented in storageContext + type: IndexStructType = IndexStructType.SIMPLE_DICT; getSummary(): string { if (this.summary === undefined) { @@ -44,14 +53,31 @@ export class IndexDict extends IndexStruct { const vectorId = textId ?? node.id_; this.nodesDict[vectorId] = node; } + + toJson(): Record<string, unknown> { + return { + ...super.toJson(), + nodesDict: this.nodesDict, + type: this.type, + }; + } } export class IndexList extends IndexStruct { nodes: string[] = []; + type: IndexStructType = IndexStructType.LIST; addNode(node: BaseNode) { this.nodes.push(node.id_); } + + toJson(): Record<string, unknown> { + return { + ...super.toJson(), + nodes: this.nodes, + type: this.type, + }; + } } export interface BaseIndexInit<T> { @@ -104,6 +130,7 @@ export abstract class BaseIndex<T> { export interface VectorIndexOptions { nodes?: BaseNode[]; indexStruct?: IndexDict; + indexId?: string; serviceContext?: ServiceContext; storageContext?: StorageContext; } diff --git a/packages/core/src/indices/list/ListIndex.ts b/packages/core/src/indices/list/ListIndex.ts index 048264b3ae73c0d98b8c2affaae5adb804da57c9..1c8f1809926d1017f576d6106e58898c1aedb291 100644 --- a/packages/core/src/indices/list/ListIndex.ts +++ b/packages/core/src/indices/list/ListIndex.ts @@ -20,6 +20,7 @@ import { ResponseSynthesizer, CompactAndRefine, } from "../../ResponseSynthesizer"; +import { IndexStructType } from "../../dataStructs"; export enum ListRetrieverMode { DEFAULT = "default", @@ -30,6 +31,7 @@ export enum ListRetrieverMode { export interface ListIndexOptions { nodes?: BaseNode[]; indexStruct?: IndexList; + indexId?: string; serviceContext?: ServiceContext; storageContext?: StorageContext; } @@ -49,14 +51,35 @@ export class ListIndex extends BaseIndex<IndexList> { options.serviceContext ?? serviceContextFromDefaults({}); const { docStore, indexStore } = storageContext; - let indexStruct: IndexList; + // Setup IndexStruct from storage + let indexStructs = await indexStore.getIndexStructs() as IndexList[]; + let indexStruct: IndexList | null; + + if (options.indexStruct && indexStructs.length > 0) { + throw new Error("Cannot initialize index with both indexStruct and indexStore"); + } + if (options.indexStruct) { + indexStruct = options.indexStruct; + } else if (indexStructs.length == 1) { + indexStruct = indexStructs[0]; + } else if (indexStructs.length > 1 && options.indexId) { + indexStruct = await indexStore.getIndexStruct(options.indexId) as IndexList; + } else { + indexStruct = null; + } + + // check indexStruct type + if (indexStruct && indexStruct.type !== IndexStructType.LIST) { + throw new Error("Attempting to initialize ListIndex with non-list indexStruct"); + } + + if (indexStruct) { if (options.nodes) { throw new Error( "Cannot initialize VectorStoreIndex with both nodes and indexStruct" ); } - indexStruct = options.indexStruct; } else { if (!options.nodes) { throw new Error( @@ -67,6 +90,8 @@ export class ListIndex extends BaseIndex<IndexList> { options.nodes, storageContext.docStore ); + + await indexStore.addIndexStruct(indexStruct); } return new ListIndex({ @@ -78,12 +103,13 @@ export class ListIndex extends BaseIndex<IndexList> { }); } - static async fromDocuments(args: { - documents: Document[]; - storageContext?: StorageContext; - serviceContext?: ServiceContext; + static async fromDocuments( + documents: Document[], + args: { + storageContext?: StorageContext; + serviceContext?: ServiceContext; }): Promise<ListIndex> { - let { documents, storageContext, serviceContext } = args; + let { storageContext, serviceContext } = args; storageContext = storageContext ?? (await storageContextFromDefaults({})); serviceContext = serviceContext ?? serviceContextFromDefaults({}); const docStore = storageContext.docStore; diff --git a/packages/core/src/indices/vectorStore/VectorStoreIndex.ts b/packages/core/src/indices/vectorStore/VectorStoreIndex.ts index 01648304e56aff2e0430ccf983702223b1ff3f83..a5a6c8938e6aa6435da1a94e4676885151c19bc8 100644 --- a/packages/core/src/indices/vectorStore/VectorStoreIndex.ts +++ b/packages/core/src/indices/vectorStore/VectorStoreIndex.ts @@ -24,6 +24,7 @@ import { import { BaseRetriever } from "../../Retriever"; import { ResponseSynthesizer } from "../../ResponseSynthesizer"; import { BaseDocumentStore } from "../../storage/docStore/types"; +import { IndexStructType } from "../../dataStructs"; /** * The VectorStoreIndex, an index that stores the nodes only according to their vector embedings. @@ -50,15 +51,37 @@ export class VectorStoreIndex extends BaseIndex<IndexDict> { options.serviceContext ?? serviceContextFromDefaults({}); const docStore = storageContext.docStore; const vectorStore = storageContext.vectorStore; + const indexStore = storageContext.indexStore; + + // Setup IndexStruct from storage + let indexStructs = await indexStore.getIndexStructs() as IndexDict[]; + let indexStruct: IndexDict | null; + + if (options.indexStruct && indexStructs.length > 0) { + throw new Error("Cannot initialize index with both indexStruct and indexStore"); + } - let indexStruct: IndexDict; if (options.indexStruct) { + indexStruct = options.indexStruct; + } else if (indexStructs.length == 1) { + indexStruct = indexStructs[0]; + } else if (indexStructs.length > 1 && options.indexId) { + indexStruct = await indexStore.getIndexStruct(options.indexId) as IndexDict; + } else { + indexStruct = null; + } + + // check indexStruct type + if (indexStruct && indexStruct.type !== IndexStructType.SIMPLE_DICT) { + throw new Error("Attempting to initialize VectorStoreIndex with non-vector indexStruct"); + } + + if (indexStruct) { if (options.nodes) { throw new Error( "Cannot initialize VectorStoreIndex with both nodes and indexStruct" ); } - indexStruct = options.indexStruct; } else { if (!options.nodes) { throw new Error( @@ -71,6 +94,8 @@ export class VectorStoreIndex extends BaseIndex<IndexDict> { vectorStore, docStore ); + + await indexStore.addIndexStruct(indexStruct); } return new VectorStoreIndex({ @@ -154,9 +179,11 @@ export class VectorStoreIndex extends BaseIndex<IndexDict> { */ static async fromDocuments( documents: Document[], - storageContext?: StorageContext, - serviceContext?: ServiceContext - ): Promise<VectorStoreIndex> { + args: { + storageContext?: StorageContext; + serviceContext?: ServiceContext; + }): Promise<VectorStoreIndex> { + let { storageContext, serviceContext } = args; storageContext = storageContext ?? (await storageContextFromDefaults({})); serviceContext = serviceContext ?? serviceContextFromDefaults({}); const docStore = storageContext.docStore; diff --git a/packages/core/src/storage/indexStore/KVIndexStore.ts b/packages/core/src/storage/indexStore/KVIndexStore.ts index a31452a2b21103dfb76a3a9a0c472119de5d7219..8011a51c87b0415380706b98e28f6c265d101590 100644 --- a/packages/core/src/storage/indexStore/KVIndexStore.ts +++ b/packages/core/src/storage/indexStore/KVIndexStore.ts @@ -1,7 +1,6 @@ import { BaseKVStore } from "../kvStore/types"; import { IndexStruct, - indexStructToJson, jsonToIndexStruct, } from "../../dataStructs"; import _ from "lodash"; @@ -20,7 +19,7 @@ export class KVIndexStore extends BaseIndexStore { async addIndexStruct(indexStruct: IndexStruct): Promise<void> { let key = indexStruct.indexId; - let data = indexStructToJson(indexStruct); + let data = indexStruct.toJson(); await this._kvStore.put(key, data, this._collection); } diff --git a/packages/core/src/tests/CallbackManager.test.ts b/packages/core/src/tests/CallbackManager.test.ts index cb82242af038d0a12413f68ed1caa7f0c45dadc4..ff04057da5de48b5f658840178d98a48e4a77be4 100644 --- a/packages/core/src/tests/CallbackManager.test.ts +++ b/packages/core/src/tests/CallbackManager.test.ts @@ -67,8 +67,7 @@ describe("CallbackManager: onLLMStream and onRetrieve", () => { test("For VectorStoreIndex w/ a SimpleResponseBuilder", async () => { const vectorStoreIndex = await VectorStoreIndex.fromDocuments( [document], - undefined, - serviceContext + { serviceContext } ); const queryEngine = vectorStoreIndex.asQueryEngine(); const query = "What is the author's name?"; @@ -138,10 +137,10 @@ describe("CallbackManager: onLLMStream and onRetrieve", () => { }); test("For ListIndex w/ a ListIndexRetriever", async () => { - const listIndex = await ListIndex.fromDocuments({ - documents: [document], - serviceContext, - }); + const listIndex = await ListIndex.fromDocuments( + [document], + { serviceContext }, + ); const responseBuilder = new SimpleResponseBuilder(serviceContext); const responseSynthesizer = new ResponseSynthesizer({ serviceContext: serviceContext,