diff --git a/apps/docs/docs/api/classes/BaseEmbedding.md b/apps/docs/docs/api/classes/BaseEmbedding.md index 511c212db8372aa90d0c33800dd6cf01c5a872b8..785435355bf71849f04351b104d3eaa33df177d8 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/f264211/packages/core/src/Embedding.ts#L206) +[Embedding.ts:206](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Embedding.ts#L206) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[Embedding.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L205) +[Embedding.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Embedding.ts#L205) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L197) +[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 81edb4c1030ca9f23a22dd6307e38df2942ba376..8e687186bc4961745c42f417490002149eaa3bc4 100644 --- a/apps/docs/docs/api/classes/BaseIndex.md +++ b/apps/docs/docs/api/classes/BaseIndex.md @@ -43,7 +43,7 @@ they can be retrieved for our queries. #### Defined in -[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L76) +[indices/BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L78) ## Properties @@ -53,7 +53,7 @@ they can be retrieved for our queries. #### Defined in -[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L71) +[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L73) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L73) +[indices/BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L75) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L74) +[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L76) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L69) +[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L71) ___ @@ -93,7 +93,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L70) +[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L72) ___ @@ -103,13 +103,46 @@ ___ #### Defined in -[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L72) +[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L74) ## Methods +### asQueryEngine + +▸ `Abstract` **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +Create a new query engine from the index. It will also create a retriever +and response synthezier if they are not provided. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer | +| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - | +| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - | + +#### Returns + +[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +#### Defined in + +[indices/BaseIndex.ts:98](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L98) + +___ + ### asRetriever -▸ `Abstract` **asRetriever**(): [`BaseRetriever`](../interfaces/BaseRetriever.md) +▸ `Abstract` **asRetriever**(`options?`): [`BaseRetriever`](../interfaces/BaseRetriever.md) + +Create a new retriever from the index. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | `any` | #### Returns @@ -117,4 +150,4 @@ ___ #### Defined in -[indices/BaseIndex.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L85) +[indices/BaseIndex.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L91) diff --git a/apps/docs/docs/api/classes/BaseNode.md b/apps/docs/docs/api/classes/BaseNode.md index ab25c9fb606cf5a9ac7ffe4603f042304f5351b2..3b0b8f3ef796deb8214b7075bc18c37c02262227 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/f264211/packages/core/src/Node.ts#L48) +[Node.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L39) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L43) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L44) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L46) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L38) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L42) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L45) ## Accessors @@ -112,7 +112,7 @@ ___ #### Defined in -[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L104) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L84) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L58) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L94) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L72) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L62) ## Methods @@ -196,7 +196,7 @@ ___ #### Defined in -[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L124) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L54) +[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L54) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L116) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L55) +[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L55) ___ @@ -264,7 +264,7 @@ ___ #### Defined in -[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L52) +[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L52) ___ @@ -284,4 +284,4 @@ ___ #### Defined in -[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L56) +[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 21dc23a93dc1bf56bb66bc907352f1435147c7e1..639eee5b95eb5b580321ef1a6529a1de9d9f20fa 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/f264211/packages/core/src/callbacks/CallbackManager.ts#L68) +[callbacks/CallbackManager.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/callbacks/CallbackManager.ts#L65) +[callbacks/CallbackManager.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/callbacks/CallbackManager.ts#L66) +[callbacks/CallbackManager.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 2295d8412476b138e337338c2b8078c2ad59ef6e..06a0755b459b970b89c642cbbfd7654bf1231a5a 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/f264211/packages/core/src/ResponseSynthesizer.ts#L78) +[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ResponseSynthesizer.ts#L76) +[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ResponseSynthesizer.ts#L76) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L74) +[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ResponseSynthesizer.ts#L74) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L75) +[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ResponseSynthesizer.ts#L75) ## Methods @@ -103,4 +103,4 @@ ___ #### Defined in -[ResponseSynthesizer.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L181) +[ResponseSynthesizer.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 ac122966878fb6570cfa7334849828771d742159..5a3ebda185a232052c7078dcb4d534e1decaf601 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/f264211/packages/core/src/ChatEngine.ts#L75) +[ChatEngine.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ChatEngine.ts#L71) +[ChatEngine.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ChatEngine.ts#L71) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L73) +[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ChatEngine.ts#L73) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L70) +[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ChatEngine.ts#L70) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L72) +[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ChatEngine.ts#L100) +[ChatEngine.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ChatEngine.ts#L100) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L89) +[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ChatEngine.ts#L118) +[ChatEngine.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 7b3aa64552e397383e9b95ff9fae99f0bb100b9d..44b9b9d7cde5524eb99ce078ebed62974c4bfee1 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/f264211/packages/core/src/ChatEngine.ts#L133) +[ChatEngine.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ChatEngine.ts#L131) +[ChatEngine.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ChatEngine.ts#L131) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[ChatEngine.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L130) +[ChatEngine.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ChatEngine.ts#L130) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[ChatEngine.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L129) +[ChatEngine.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ChatEngine.ts#L129) ## Methods @@ -88,21 +88,7 @@ Send message along with the class's current chat history to the LLM. #### Defined in -[ChatEngine.ts:148](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L148) - -___ - -### chatRepl - -▸ **chatRepl**(): `void` - -#### Returns - -`void` - -#### Defined in - -[ChatEngine.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L144) +[ChatEngine.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ChatEngine.ts#L144) ___ @@ -122,4 +108,4 @@ Resets the chat history so that it's empty. #### Defined in -[ChatEngine.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L186) +[ChatEngine.ts:182](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 161776f5863ab0cc3ff9fb5b48c8f7885e34baa0..ee073f24a50351b4e5f943718579eb712a776efb 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/f264211/packages/core/src/Node.ts#L216) +[Node.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L139) +[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L139) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L44) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L46) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L38) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L42) ___ @@ -144,7 +144,7 @@ ___ #### Defined in -[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L142) +[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L142) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L45) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L138) +[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L138) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L137) +[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L104) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[Node.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L225) +[Node.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L225) ___ @@ -236,7 +236,7 @@ TextNode.nextNode #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L84) ___ @@ -254,7 +254,7 @@ TextNode.nodeId #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L58) ___ @@ -272,7 +272,7 @@ TextNode.parentNode #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L94) ___ @@ -290,7 +290,7 @@ TextNode.prevNode #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L72) ___ @@ -308,7 +308,7 @@ TextNode.sourceNode #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L124) ___ @@ -344,7 +344,7 @@ ___ #### Defined in -[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L149) +[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L149) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L157) +[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L157) ___ @@ -386,7 +386,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L116) ___ @@ -410,7 +410,7 @@ ___ #### Defined in -[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L162) +[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L162) ___ @@ -433,7 +433,7 @@ ___ #### Defined in -[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L187) +[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L187) ___ @@ -451,7 +451,7 @@ ___ #### Defined in -[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L191) +[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L191) ___ @@ -469,7 +469,7 @@ ___ #### Defined in -[Node.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L221) +[Node.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L221) ___ @@ -493,4 +493,4 @@ ___ #### Defined in -[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L183) +[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 00d51a0214f556ca0ee093504fa5116aec715378..f938a9ab871e021168117af5ac4c17eb144a80cc 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/f264211/packages/core/src/storage/FileSystem.ts#L25) +[storage/FileSystem.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/storage/FileSystem.ts#L38) +[storage/FileSystem.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/FileSystem.ts#L38) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L44) +[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/FileSystem.ts#L44) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L31) +[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/FileSystem.ts#L31) ___ @@ -126,4 +126,4 @@ ___ #### Defined in -[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L27) +[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 cca94e3f37b2971a1c50c0d8b8419b13c395ef05..98d11784c9a3bf0ddab68363462aac265e8051a6 100644 --- a/apps/docs/docs/api/classes/IndexDict.md +++ b/apps/docs/docs/api/classes/IndexDict.md @@ -33,7 +33,7 @@ The underlying structure of each index. #### Defined in -[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L17) +[indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L19) ## Properties @@ -43,7 +43,7 @@ The underlying structure of each index. #### Defined in -[indices/BaseIndex.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L32) +[indices/BaseIndex.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L34) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L14) +[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L16) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L31) +[indices/BaseIndex.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L33) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L15) +[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L17) ## Methods @@ -102,7 +102,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L41) +[indices/BaseIndex.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L43) ___ @@ -120,4 +120,4 @@ ___ #### Defined in -[indices/BaseIndex.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L34) +[indices/BaseIndex.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L36) diff --git a/apps/docs/docs/api/classes/IndexList.md b/apps/docs/docs/api/classes/IndexList.md index 475b16d82c59ce747d75995799eff6beaef06d41..4c649a0ba7ea66de8a632eb94c0a841109bff0d0 100644 --- a/apps/docs/docs/api/classes/IndexList.md +++ b/apps/docs/docs/api/classes/IndexList.md @@ -33,7 +33,7 @@ The underlying structure of each index. #### Defined in -[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L17) +[indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L19) ## Properties @@ -47,7 +47,7 @@ The underlying structure of each index. #### Defined in -[indices/BaseIndex.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L14) +[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L16) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L48) +[indices/BaseIndex.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L50) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L15) +[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L17) ## Methods @@ -91,7 +91,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L50) +[indices/BaseIndex.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L52) ___ @@ -109,4 +109,4 @@ ___ #### Defined in -[indices/BaseIndex.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L22) +[indices/BaseIndex.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L24) diff --git a/apps/docs/docs/api/classes/IndexNode.md b/apps/docs/docs/api/classes/IndexNode.md index 8eb64b321788541994cf3841f2e52834100f6d5a..c0afb758e85f35d1d77d1267cada9dcfa5a42a8e 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/f264211/packages/core/src/Node.ts#L144) +[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L139) +[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L139) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L44) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L46) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L38) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[Node.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L205) +[Node.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L205) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L42) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L142) +[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L142) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L45) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L138) +[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L138) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L137) +[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L104) ___ @@ -232,7 +232,7 @@ TextNode.nextNode #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L84) ___ @@ -250,7 +250,7 @@ TextNode.nodeId #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L58) ___ @@ -268,7 +268,7 @@ TextNode.parentNode #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L94) ___ @@ -286,7 +286,7 @@ TextNode.prevNode #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L72) ___ @@ -304,7 +304,7 @@ TextNode.sourceNode #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L124) ___ @@ -340,7 +340,7 @@ ___ #### Defined in -[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L149) +[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L149) ___ @@ -364,7 +364,7 @@ ___ #### Defined in -[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L157) +[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L157) ___ @@ -382,7 +382,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L116) ___ @@ -406,7 +406,7 @@ ___ #### Defined in -[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L162) +[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L162) ___ @@ -429,7 +429,7 @@ ___ #### Defined in -[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L187) +[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L187) ___ @@ -447,7 +447,7 @@ ___ #### Defined in -[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L191) +[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L191) ___ @@ -465,7 +465,7 @@ ___ #### Defined in -[Node.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L207) +[Node.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L207) ___ @@ -489,4 +489,4 @@ ___ #### Defined in -[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L183) +[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 407284a8cb10014ed3d791d377519cfbb846904f..40c8de5452b7b4c884312c890a18f3275023aa40 100644 --- a/apps/docs/docs/api/classes/IndexStruct.md +++ b/apps/docs/docs/api/classes/IndexStruct.md @@ -31,7 +31,7 @@ The underlying structure of each index. #### Defined in -[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L17) +[indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L19) ## Properties @@ -41,7 +41,7 @@ The underlying structure of each index. #### Defined in -[indices/BaseIndex.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L14) +[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L16) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L15) +[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L17) ## Methods @@ -65,4 +65,4 @@ ___ #### Defined in -[indices/BaseIndex.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L22) +[indices/BaseIndex.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L24) diff --git a/apps/docs/docs/api/classes/LLMQuestionGenerator.md b/apps/docs/docs/api/classes/LLMQuestionGenerator.md index 98ea228a40bc441e8840bc5181c8c0d87a82bd08..ff6fe76e8672ab3e28957e7db8e5404c1dca17c3 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/f264211/packages/core/src/QuestionGenerator.ts#L34) +[QuestionGenerator.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/QuestionGenerator.ts#L30) +[QuestionGenerator.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/QuestionGenerator.ts#L30) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QuestionGenerator.ts#L32) +[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/QuestionGenerator.ts#L32) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QuestionGenerator.ts#L31) +[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/QuestionGenerator.ts#L31) ## Methods @@ -81,4 +81,4 @@ ___ #### Defined in -[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QuestionGenerator.ts#L40) +[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 36b28ca1d192d4e8fa65ce5b34d23acbd93c14ec..8184f4c811eb8166c9cc15adcac97c68cb12a93a 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/f264211/packages/core/src/indices/list/ListIndex.ts#L41) +[indices/list/ListIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/list/ListIndex.ts#L41) ## Properties @@ -46,7 +46,7 @@ A ListIndex keeps nodes in a sequential list structure #### Defined in -[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L71) +[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L73) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L73) +[indices/BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L75) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L74) +[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L76) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L69) +[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L71) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L70) +[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L72) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L72) +[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L74) ## Methods @@ -136,7 +136,7 @@ ___ #### Defined in -[indices/list/ListIndex.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L156) +[indices/list/ListIndex.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/list/ListIndex.ts#L160) ___ @@ -156,40 +156,51 @@ ___ #### Defined in -[indices/list/ListIndex.ts:150](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L150) +[indices/list/ListIndex.ts:154](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/list/ListIndex.ts#L154) ___ ### asQueryEngine -▸ **asQueryEngine**(`mode?`, `responseSynthesizer?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) +▸ **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +Create a new query engine from the index. It will also create a retriever +and response synthezier if they are not provided. #### Parameters -| Name | Type | Default value | +| Name | Type | Description | | :------ | :------ | :------ | -| `mode` | [`ListRetrieverMode`](../enums/ListRetrieverMode.md) | `ListRetrieverMode.DEFAULT` | -| `responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | `undefined` | +| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer | +| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - | +| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - | #### Returns [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) +#### Overrides + +[BaseIndex](BaseIndex.md).[asQueryEngine](BaseIndex.md#asqueryengine) + #### Defined in -[indices/list/ListIndex.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L118) +[indices/list/ListIndex.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/list/ListIndex.ts#L118) ___ ### asRetriever -▸ **asRetriever**(`mode?`): [`BaseRetriever`](../interfaces/BaseRetriever.md) +▸ **asRetriever**(`options?`): [`BaseRetriever`](../interfaces/BaseRetriever.md) + +Create a new retriever from the index. #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `mode` | [`ListRetrieverMode`](../enums/ListRetrieverMode.md) | `ListRetrieverMode.DEFAULT` | +| Name | Type | +| :------ | :------ | +| `options?` | `Object` | +| `options.mode` | [`ListRetrieverMode`](../enums/ListRetrieverMode.md) | #### Returns @@ -201,7 +212,7 @@ ___ #### Defined in -[indices/list/ListIndex.ts:105](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L105) +[indices/list/ListIndex.ts:105](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/list/ListIndex.ts#L105) ___ @@ -215,7 +226,7 @@ ___ #### Defined in -[indices/list/ListIndex.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L162) +[indices/list/ListIndex.ts:166](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/list/ListIndex.ts#L166) ___ @@ -237,7 +248,7 @@ ___ #### Defined in -[indices/list/ListIndex.ts:135](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L135) +[indices/list/ListIndex.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/list/ListIndex.ts#L139) ___ @@ -260,7 +271,7 @@ ___ #### Defined in -[indices/list/ListIndex.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L81) +[indices/list/ListIndex.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/list/ListIndex.ts#L81) ___ @@ -280,4 +291,4 @@ ___ #### Defined in -[indices/list/ListIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L45) +[indices/list/ListIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/list/ListIndex.ts#L45) diff --git a/apps/docs/docs/api/classes/ListIndexLLMRetriever.md b/apps/docs/docs/api/classes/ListIndexLLMRetriever.md index 2711d295d1f7c554849b8ca2d481d90e06117c5a..70b995399570f5b97ab663d5d7eeb2e8fa446c7d 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/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L64) +[indices/list/ListIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L59) +[indices/list/ListIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L58) +[indices/list/ListIndexRetriever.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L60) +[indices/list/ListIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L57) +[indices/list/ListIndexRetriever.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L61) +[indices/list/ListIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L62) +[indices/list/ListIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L127) +[indices/list/ListIndexRetriever.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L81) +[indices/list/ListIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 e35e9954e09a5590fb92603d388c22d5ef06fbd3..9afe3d113f8997bce46826040dc88ea047e8a744 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/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L22) +[indices/list/ListIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L20) +[indices/list/ListIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L48) +[indices/list/ListIndexRetriever.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/indices/list/ListIndexRetriever.ts#L26) +[indices/list/ListIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 e1c4c8495c6375ad20e12df80b6e0342c7d495dd..fbc45d982441a221b651268b80c5d418cf9e36ce 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/f264211/packages/core/src/llm/LLM.ts#L179) +[llm/LLM.ts:179](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/llm/LLM.ts#L176) +[llm/LLM.ts:176](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L176) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[llm/LLM.ts:174](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L174) +[llm/LLM.ts:174](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L174) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[llm/LLM.ts:177](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L177) +[llm/LLM.ts:177](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L177) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[llm/LLM.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L175) +[llm/LLM.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/llm/LLM.ts#L199) +[llm/LLM.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/llm/LLM.ts#L224) +[llm/LLM.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L224) ___ @@ -140,4 +140,4 @@ ___ #### Defined in -[llm/LLM.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L186) +[llm/LLM.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 f54abe67b7b9498298ca57d8a6f657ff842fe5ed..7c6c68f4310500c44cab83537ece638637c5d2b2 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/f264211/packages/core/src/llm/LLM.ts#L75) +[llm/LLM.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/llm/LLM.ts#L73) +[llm/LLM.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L73) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[llm/LLM.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L71) +[llm/LLM.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L71) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[llm/LLM.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L69) +[llm/LLM.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L69) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[llm/LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L66) +[llm/LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L66) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[llm/LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L68) +[llm/LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L68) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[llm/LLM.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L72) +[llm/LLM.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L72) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[llm/LLM.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L70) +[llm/LLM.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L70) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[llm/LLM.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L67) +[llm/LLM.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/llm/LLM.ts#L102) +[llm/LLM.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/llm/LLM.ts#L144) +[llm/LLM.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L144) ___ @@ -180,4 +180,4 @@ ___ #### Defined in -[llm/LLM.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L85) +[llm/LLM.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 5f888dcbeadcae95ff1460132d46ad100bf5e3f9..309d74772f7dbbe81128f26e0f09d7beae5c4301 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/f264211/packages/core/src/Embedding.ts#L217) +[Embedding.ts:217](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Embedding.ts#L215) +[Embedding.ts:215](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Embedding.ts#L215) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[Embedding.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L214) +[Embedding.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Embedding.ts#L214) ## Methods @@ -64,7 +64,7 @@ ___ #### Defined in -[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L224) +[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Embedding.ts#L224) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Embedding.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L240) +[Embedding.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Embedding.ts#L240) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[Embedding.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L236) +[Embedding.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Embedding.ts#L236) ___ @@ -138,4 +138,4 @@ ___ #### Defined in -[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L197) +[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 1a356ea6a6bf58d63cae49fbd28bb35b836deee8..916cf5f3a080612bbe526b884b8128dc95bfff10 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/f264211/packages/core/src/readers/PDFReader.ts#L12) +[readers/PDFReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 998ecf778af3f5aca951fb8556a2ddbeee5f5338..3027c82d022d244d0359074030bb7f6b105b4d2b 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/f264211/packages/core/src/ResponseSynthesizer.ts#L78) +[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ResponseSynthesizer.ts#L76) +[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ResponseSynthesizer.ts#L76) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L74) +[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ResponseSynthesizer.ts#L74) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L75) +[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ResponseSynthesizer.ts#L88) +[ResponseSynthesizer.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ResponseSynthesizer.ts#L88) ___ @@ -113,7 +113,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L113) +[ResponseSynthesizer.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ResponseSynthesizer.ts#L113) ___ @@ -136,4 +136,4 @@ ___ #### Defined in -[ResponseSynthesizer.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L149) +[ResponseSynthesizer.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 f00b21c418b8323c11cde84c79131d5ef255b27e..f364e8ec584e2bf2ca1c66f0151b5cdb7f03e30b 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/f264211/packages/core/src/Response.ts#L10) +[Response.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Response.ts#L7) +[Response.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Response.ts#L7) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Response.ts#L8) +[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Response.ts#L8) ## Methods @@ -57,7 +57,7 @@ ___ #### Defined in -[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Response.ts#L15) +[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Response.ts#L15) ___ @@ -71,4 +71,4 @@ ___ #### Defined in -[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Response.ts#L19) +[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 0b4660c416d5c46a2f963b8c9235f5d26374ea41..5c879ea290f779db47570c9782c4ab9574f994db 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/f264211/packages/core/src/ResponseSynthesizer.ts#L285) +[ResponseSynthesizer.ts:285](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ResponseSynthesizer.ts#L282) +[ResponseSynthesizer.ts:282](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ResponseSynthesizer.ts#L282) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:283](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L283) +[ResponseSynthesizer.ts:283](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ResponseSynthesizer.ts#L283) ## Methods @@ -66,4 +66,4 @@ ___ #### Defined in -[ResponseSynthesizer.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L297) +[ResponseSynthesizer.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 0247d102ade904ef1fbb4ab7c07764cd8d907229..a424e98a3928dfa59b7d61375849f9edd69e16d6 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/f264211/packages/core/src/QueryEngine.ts#L34) +[QueryEngine.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/QueryEngine.ts#L32) +[QueryEngine.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/QueryEngine.ts#L32) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[QueryEngine.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L31) +[QueryEngine.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/QueryEngine.ts#L45) +[QueryEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 d97aa68389c0812f43ca247ff3fc18e31788b8c0..0b6ad4d0ebe50d8bfbeea7b1ff7d6c8d9a96514e 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/f264211/packages/core/src/TextSplitter.ts#L33) +[TextSplitter.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/TextSplitter.ts#L26) +[TextSplitter.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/TextSplitter.ts#L26) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[TextSplitter.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L25) +[TextSplitter.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/TextSplitter.ts#L25) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L30) +[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/TextSplitter.ts#L30) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L29) +[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/TextSplitter.ts#L29) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L27) +[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/TextSplitter.ts#L27) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L28) +[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/TextSplitter.ts#L28) ## Methods @@ -108,7 +108,7 @@ ___ #### Defined in -[TextSplitter.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L153) +[TextSplitter.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/TextSplitter.ts#L153) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[TextSplitter.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L72) +[TextSplitter.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/TextSplitter.ts#L72) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -[TextSplitter.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L89) +[TextSplitter.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/TextSplitter.ts#L89) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[TextSplitter.ts:115](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L115) +[TextSplitter.ts:115](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/TextSplitter.ts#L115) ___ @@ -191,7 +191,7 @@ ___ #### Defined in -[TextSplitter.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L128) +[TextSplitter.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/TextSplitter.ts#L128) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[TextSplitter.ts:233](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L233) +[TextSplitter.ts:233](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/TextSplitter.ts#L233) ___ @@ -233,4 +233,4 @@ ___ #### Defined in -[TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/TextSplitter.ts#L205) +[TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 4f6eccd7abac4dd395800ad227318e7d89deb996..afcf5876475f4ed50205ef788b2f4c1275d0c633 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/f264211/packages/core/src/ChatEngine.ts#L40) +[ChatEngine.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ChatEngine.ts#L37) +[ChatEngine.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ChatEngine.ts#L37) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ChatEngine.ts#L38) +[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ChatEngine.ts#L45) +[ChatEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ChatEngine.ts#L54) +[ChatEngine.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 8d9a9e1488b704d3778b2aa4a3c955d5a51911a3..f7d4fe0066e4131c85b6891a8e1c3b6d3ae2bbe3 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/f264211/packages/core/src/readers/SimpleDirectoryReader.ts#L37) +[readers/SimpleDirectoryReader.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 602a0138671fef507dcbb36f9010c8c3a28f35b9..6ecb5269af21510caacef8b6da095046ec34212d 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/f264211/packages/core/src/NodeParser.ts#L64) +[NodeParser.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/NodeParser.ts#L61) +[NodeParser.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/NodeParser.ts#L61) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[NodeParser.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/NodeParser.ts#L62) +[NodeParser.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/NodeParser.ts#L62) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[NodeParser.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/NodeParser.ts#L60) +[NodeParser.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/NodeParser.ts#L95) +[NodeParser.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/NodeParser.ts#L95) ___ @@ -111,4 +111,4 @@ ___ #### Defined in -[NodeParser.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/NodeParser.ts#L82) +[NodeParser.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 5ea93f5d60a52bbe83d7ca78646e7ced88046dfc..5cab171c93e5fd6fe7df40f659989a4018162ad4 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/f264211/packages/core/src/ResponseSynthesizer.ts#L49) +[ResponseSynthesizer.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ResponseSynthesizer.ts#L46) +[ResponseSynthesizer.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ResponseSynthesizer.ts#L46) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L47) +[ResponseSynthesizer.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ResponseSynthesizer.ts#L54) +[ResponseSynthesizer.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 de7899287f3a3dcadc0215f247d771663a4dcfad..9128d9d2ea980fb398aa87f9cb5ad0fc3048a14a 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/f264211/packages/core/src/OutputParser.ts#L97) +[OutputParser.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/OutputParser.ts#L97) ___ @@ -64,4 +64,4 @@ ___ #### Defined in -[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/OutputParser.ts#L89) +[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 32e55ac9dd8c1460cfa5be64b03699fb67551480..cb45af42be10e05278a2744b255e5ee04694c34a 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/f264211/packages/core/src/QueryEngine.ts#L65) +[QueryEngine.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/QueryEngine.ts#L63) +[QueryEngine.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/QueryEngine.ts#L63) ___ @@ -49,7 +49,7 @@ ___ #### Defined in -[QueryEngine.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L62) +[QueryEngine.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/QueryEngine.ts#L62) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -[QueryEngine.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L61) +[QueryEngine.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/QueryEngine.ts#L61) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -[QueryEngine.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L60) +[QueryEngine.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/QueryEngine.ts#L106) +[QueryEngine.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/QueryEngine.ts#L106) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[QueryEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L134) +[QueryEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/QueryEngine.ts#L134) ___ @@ -140,4 +140,4 @@ ___ #### Defined in -[QueryEngine.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QueryEngine.ts#L82) +[QueryEngine.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 edd2dc7a249d7883aa8951c62ccb397ff927dd40..ecdda9c06e3911e837456c805007499a6665229a 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/f264211/packages/core/src/readers/SimpleDirectoryReader.ts#L12) +[readers/SimpleDirectoryReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 82ec187c8948396d49e694e05660169c43a3ec17..b928736afa6eae5ff111431b82458948644e537b 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/f264211/packages/core/src/Node.ts#L144) +[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L139) +[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L139) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L44) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L46) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L38) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L42) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L142) +[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L142) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L45) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L138) +[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L138) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L137) +[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L104) ___ @@ -210,7 +210,7 @@ BaseNode.nextNode #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L84) ___ @@ -228,7 +228,7 @@ BaseNode.nodeId #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L58) ___ @@ -246,7 +246,7 @@ BaseNode.parentNode #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L94) ___ @@ -264,7 +264,7 @@ BaseNode.prevNode #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L72) ___ @@ -282,7 +282,7 @@ BaseNode.sourceNode #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L124) ___ @@ -314,7 +314,7 @@ ___ #### Defined in -[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L149) +[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L149) ___ @@ -338,7 +338,7 @@ ___ #### Defined in -[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L157) +[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L157) ___ @@ -356,7 +356,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L116) ___ @@ -380,7 +380,7 @@ ___ #### Defined in -[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L162) +[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L162) ___ @@ -399,7 +399,7 @@ ___ #### Defined in -[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L187) +[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L187) ___ @@ -413,7 +413,7 @@ ___ #### Defined in -[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L191) +[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L191) ___ @@ -431,7 +431,7 @@ ___ #### Defined in -[Node.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L153) +[Node.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L153) ___ @@ -455,4 +455,4 @@ ___ #### Defined in -[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L183) +[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 3cd12138c3c5d9f2dfeae3301cb613ba79fe6b9a..2e86071c356f44968caa1c87e5d8e9699fe87c19 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/f264211/packages/core/src/ResponseSynthesizer.ts#L212) +[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ResponseSynthesizer.ts#L210) +[ResponseSynthesizer.ts:210](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ResponseSynthesizer.ts#L216) +[ResponseSynthesizer.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 20a56d02e07e196857421dc0576acc80d63273db..2711147413f4b25f851a29a6490906717cdd8fc0 100644 --- a/apps/docs/docs/api/classes/VectorIndexRetriever.md +++ b/apps/docs/docs/api/classes/VectorIndexRetriever.md @@ -16,17 +16,19 @@ VectorIndexRetriever retrieves nodes from a VectorIndex. ### constructor -• **new VectorIndexRetriever**(`index`) +• **new VectorIndexRetriever**(`«destructured»`) #### Parameters | Name | Type | | :------ | :------ | -| `index` | [`VectorStoreIndex`](VectorStoreIndex.md) | +| `«destructured»` | `Object` | +| › `index` | [`VectorStoreIndex`](VectorStoreIndex.md) | +| › `similarityTopK?` | `number` | #### Defined in -[indices/vectorStore/VectorIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L22) +[indices/vectorStore/VectorIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L22) ## Properties @@ -36,7 +38,7 @@ VectorIndexRetriever retrieves nodes from a VectorIndex. #### Defined in -[indices/vectorStore/VectorIndexRetriever.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L18) +[indices/vectorStore/VectorIndexRetriever.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L18) ___ @@ -46,17 +48,17 @@ ___ #### Defined in -[indices/vectorStore/VectorIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L20) +[indices/vectorStore/VectorIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L20) ___ ### similarityTopK -• **similarityTopK**: `number` = `DEFAULT_SIMILARITY_TOP_K` +• **similarityTopK**: `number` #### Defined in -[indices/vectorStore/VectorIndexRetriever.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L19) +[indices/vectorStore/VectorIndexRetriever.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L19) ## Methods @@ -74,7 +76,7 @@ ___ #### Defined in -[indices/vectorStore/VectorIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L61) +[indices/vectorStore/VectorIndexRetriever.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L69) ___ @@ -99,4 +101,4 @@ ___ #### Defined in -[indices/vectorStore/VectorIndexRetriever.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L27) +[indices/vectorStore/VectorIndexRetriever.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 87ed38aa985c4aea3ac87b2c8119e44778116591..01a44a253575503957a8375973aadb34bdd75613 100644 --- a/apps/docs/docs/api/classes/VectorStoreIndex.md +++ b/apps/docs/docs/api/classes/VectorStoreIndex.md @@ -32,7 +32,7 @@ The VectorStoreIndex, an index that stores the nodes only according to their vec #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L32) +[indices/vectorStore/VectorStoreIndex.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L34) ## Properties @@ -46,7 +46,7 @@ The VectorStoreIndex, an index that stores the nodes only according to their vec #### Defined in -[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L71) +[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L73) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L73) +[indices/BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L75) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L74) +[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L76) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L69) +[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L71) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L70) +[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L72) ___ @@ -116,49 +116,62 @@ ___ #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L30) +[indices/vectorStore/VectorStoreIndex.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L32) ## Methods ### asQueryEngine -▸ **asQueryEngine**(): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) +▸ **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) -Get a retriever query engine for this index. +Create a new query engine from the index. It will also create a retriever +and response synthezier if they are not provided. -NOTE: if you are using a custom query engine you don't have to use this method. +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer | +| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - | +| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - | #### Returns [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) +#### Overrides + +[BaseIndex](BaseIndex.md).[asQueryEngine](BaseIndex.md#asqueryengine) + #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L175) +[indices/vectorStore/VectorStoreIndex.ts:165](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L165) ___ ### asRetriever -▸ **asRetriever**(): [`VectorIndexRetriever`](VectorIndexRetriever.md) +▸ **asRetriever**(`options?`): [`VectorIndexRetriever`](VectorIndexRetriever.md) -Get a VectorIndexRetriever for this index. +Create a new retriever from the index. -NOTE: if you want to use a custom retriever you don't have to use this method. +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | `any` | #### Returns [`VectorIndexRetriever`](VectorIndexRetriever.md) -retriever for the index - #### Overrides [BaseIndex](BaseIndex.md).[asRetriever](BaseIndex.md#asretriever) #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:165](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L165) +[indices/vectorStore/VectorStoreIndex.ts:161](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L161) ___ @@ -182,7 +195,7 @@ Get embeddings for nodes and place them into the index. #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:110](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L110) +[indices/vectorStore/VectorStoreIndex.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L112) ___ @@ -206,7 +219,7 @@ High level API: split documents, get embeddings, and build index. #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L137) +[indices/vectorStore/VectorStoreIndex.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L139) ___ @@ -230,7 +243,7 @@ Get the embeddings for nodes. #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L82) +[indices/vectorStore/VectorStoreIndex.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L84) ___ @@ -250,4 +263,4 @@ ___ #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L37) +[indices/vectorStore/VectorStoreIndex.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L39) diff --git a/apps/docs/docs/api/enums/ListRetrieverMode.md b/apps/docs/docs/api/enums/ListRetrieverMode.md index 94e6db2247444d610196c715705784a826c94191..1b30cb22ff91014dcc8f6765bda8751d763d22e3 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/f264211/packages/core/src/indices/list/ListIndex.ts#L25) +[indices/list/ListIndex.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/list/ListIndex.ts#L25) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[indices/list/ListIndex.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/list/ListIndex.ts#L27) +[indices/list/ListIndex.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/list/ListIndex.ts#L27) diff --git a/apps/docs/docs/api/enums/MetadataMode.md b/apps/docs/docs/api/enums/MetadataMode.md index b2ca339fb9d7119757203dbf3f943a9c8318b5d1..4dded349cbdfe18c76a040bf9fccc91a1238a808 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/f264211/packages/core/src/Node.ts#L19) +[Node.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L19) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L20) +[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L20) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L21) +[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L21) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L22) +[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 231e39f3922926767b542e3c39eb6978f25b00b2..8ba5591b3839843584f9f4b7dfa0fa811e3e5bce 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/f264211/packages/core/src/Node.ts#L8) +[Node.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L8) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L6) +[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L6) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L7) +[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L7) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L5) +[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L5) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[Node.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L4) +[Node.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 3f8ec10b8c04e16aef74ce801422dc1c8d0d2ecb..680829461ed0557a32aa8097b8b34212363707e0 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/f264211/packages/core/src/Node.ts#L15) +[Node.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L15) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L13) +[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L13) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L14) +[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L14) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[Node.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L12) +[Node.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 13831dca5dd93996f3f5cfa0748a74592f2abd3c..f8329ea334815d9c7783887d896ed88b21545c8c 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/f264211/packages/core/src/Embedding.ts#L10) +[Embedding.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Embedding.ts#L10) ___ @@ -27,7 +27,7 @@ ___ #### Defined in -[Embedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L11) +[Embedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Embedding.ts#L11) ___ @@ -37,4 +37,4 @@ ___ #### Defined in -[Embedding.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L12) +[Embedding.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Embedding.ts#L12) diff --git a/apps/docs/docs/api/index.md b/apps/docs/docs/api/index.md index 3b39b6eb26309bb4f8c869df779764eb36359514..5821873a5bfda96795f7a3e833d72286f1f32ce5 100644 --- a/apps/docs/docs/api/index.md +++ b/apps/docs/docs/api/index.md @@ -63,19 +63,21 @@ Then you can run it using npx ts-node example.ts ``` -## Core concepts: +## Core concepts for getting started: - [Document](packages/core/src/Node.ts): A document represents a text file, PDF file or other contiguous piece of data. - [Node](packages/core/src/Node.ts): The basic data building block. Most commonly, these are parts of the document split into manageable pieces that are small enough to be fed into an embedding model and LLM. -- Indexes: indexes store the Nodes and the embeddings of those nodes. +- [Embedding](packages/core/src/Embedding.ts): Embeddings are sets of floating point numbers which represent the data in a Node. By comparing the similarity of embeddings, we can derive an understanding of the similarity of two pieces of data. One use case is to compare the embedding of a question with the embeddings of our Nodes to see which Nodes may contain the data needed to answer that quesiton. -- [QueryEngine](packages/core/src/QueryEngine.ts): Query engines are what generate the query you put in and give you back the result. Query engines generally combine a pre-built prompt with selected nodes from your Index to give the LLM the context it needs to answer your query. +- [Indices](packages/core/src/indices/): Indices store the Nodes and the embeddings of those nodes. QueryEngines retrieve Nodes from these Indices using embedding similarity. -- [ChatEngine](packages/core/src/ChatEngine.ts): A ChatEngine helps you build a chatbot that will interact with your Indexes. +- [QueryEngine](packages/core/src/QueryEngine.ts): Query engines are what generate the query you put in and give you back the result. Query engines generally combine a pre-built prompt with selected Nodes from your Index to give the LLM the context it needs to answer your query. -- [SimplePrompt](packages/core/src/Prompt.ts): A simple standardized function call definition that takes in inputs and puts them in a prebuilt template. +- [ChatEngine](packages/core/src/ChatEngine.ts): A ChatEngine helps you build a chatbot that will interact with your Indices. + +- [SimplePrompt](packages/core/src/Prompt.ts): A simple standardized function call definition that takes in inputs and formats them in a template literal. SimplePrompts can be specialized using currying and combined using other SimplePrompt functions. ## Contributing: diff --git a/apps/docs/docs/api/interfaces/BaseIndexInit.md b/apps/docs/docs/api/interfaces/BaseIndexInit.md index 8c1e409327de3c854c5d6fc7c4dad9ab660acc6b..6db7d5dbd3c5992f879ee98298cabcb176ce1854 100644 --- a/apps/docs/docs/api/interfaces/BaseIndexInit.md +++ b/apps/docs/docs/api/interfaces/BaseIndexInit.md @@ -26,7 +26,7 @@ custom_edit_url: null #### Defined in -[indices/BaseIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L58) +[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L60) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L60) +[indices/BaseIndex.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L62) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L61) +[indices/BaseIndex.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L63) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L56) +[indices/BaseIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L58) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L57) +[indices/BaseIndex.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L59) ___ @@ -76,4 +76,4 @@ ___ #### Defined in -[indices/BaseIndex.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L59) +[indices/BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L61) diff --git a/apps/docs/docs/api/interfaces/BaseOutputParser.md b/apps/docs/docs/api/interfaces/BaseOutputParser.md index d152eb3654cdca3277a2c357b1e2cdf0c5b9b384..d4aa10f03ffacfb05e435523d459fada594ab97b 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/f264211/packages/core/src/OutputParser.ts#L8) +[OutputParser.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/OutputParser.ts#L8) ___ @@ -56,4 +56,4 @@ ___ #### Defined in -[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/OutputParser.ts#L7) +[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 412eb88861bdd8bce992d20ce7d7a43267cc2c03..fbe5d50d60906a0a62c80e186607d7f296df10d4 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/f264211/packages/core/src/QueryEngine.ts#L24) +[QueryEngine.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 551007cf55b54135d18e748206f3fe9963acdbec..019c032475ad8107326febd640a5e7f707296cf7 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/f264211/packages/core/src/QuestionGenerator.ts#L23) +[QuestionGenerator.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 95883f128b8a70ed6fa933cfa964779d6dc00e6e..e001b99e08e1bead06bcc92508a7bc52a6504a4e 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/f264211/packages/core/src/readers/base.ts#L7) +[readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 a8648bb34cc41e55f19d7b42ce5736d242479276..a7a214a00820ce2c9f74034a44fac89684b2d6bc 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/f264211/packages/core/src/Retriever.ts#L10) +[Retriever.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Retriever.ts#L10) ___ @@ -47,4 +47,4 @@ ___ #### Defined in -[Retriever.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Retriever.ts#L9) +[Retriever.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 f2478e33657c0a742c8b952d62ed7e35a24ad025..fbfc4aa9e58b8e343fe3beea541456d0c0d33079 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/f264211/packages/core/src/Tool.ts#L12) +[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 d5957a238b3c4625a5f5f6453f8df8aa85905665..0b984b83a4c42e4ca0177430ebabb2219b655f3e 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/f264211/packages/core/src/ChatEngine.ts#L25) +[ChatEngine.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/ChatEngine.ts#L30) +[ChatEngine.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 edca7bbc56cc5d675f471788169750eabbbad627..d33e0a55058820d1b92ca7edd33f68ff4a99f2b7 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/f264211/packages/core/src/llm/LLM.ts#L14) +[llm/LLM.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L14) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[llm/LLM.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L15) +[llm/LLM.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 5b6f4e7a2f21beb3bc66a84168a2d3013db31429..60ee6319e0ad511175d78e77a9c8c04f378f5cd1 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/f264211/packages/core/src/llm/LLM.ts#L21) +[llm/LLM.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L21) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[llm/LLM.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L19) +[llm/LLM.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L19) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[llm/LLM.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L20) +[llm/LLM.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 58ac06c44ac7aaea76c514c8f59dcc9382c934af..c1264d49f73f6972b423395c8db91e5e2d0d1344 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/f264211/packages/core/src/callbacks/CallbackManager.ts#L14) +[callbacks/CallbackManager.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/callbacks/CallbackManager.ts#L14) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L17) +[callbacks/CallbackManager.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/callbacks/CallbackManager.ts#L17) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L16) +[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/callbacks/CallbackManager.ts#L16) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L15) +[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 9bab00e7284d5eaf85aef7658490bed0f8bbdd66..dbef9a716bb90bf91321e8088d811b3cbdb64468 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/f264211/packages/core/src/storage/FileSystem.ts#L12) +[storage/FileSystem.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/FileSystem.ts#L12) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L13) +[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/FileSystem.ts#L13) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L11) +[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/FileSystem.ts#L11) ___ @@ -97,4 +97,4 @@ ___ #### Defined in -[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L10) +[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 d988fea096207272b075ed19101144673ac25047..8438c8c344e4f9bb4cf6864555cb996815cee778 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/f264211/packages/core/src/llm/LLM.ts#L35) +[llm/LLM.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/llm/LLM.ts#L41) +[llm/LLM.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 2a501f61374a4ffffb85877a6660c351debcf44d..9932b706e16bc270cb526dc23c5575629209331c 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/f264211/packages/core/src/NodeParser.ts#L53) +[NodeParser.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 247012fdc512faab314a98827aab95431151c6cc..773e18f890181a4aa7ca2ba7aefb8bf41edd56fa 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/f264211/packages/core/src/Node.ts#L247) +[Node.ts:247](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L247) ___ @@ -26,4 +26,4 @@ ___ #### Defined in -[Node.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L246) +[Node.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 c08052fa2e4f1b25d81b0fab6432f4c4f20eb47a..fe8802166c398f912afdb18084091075ec4a0ac9 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/f264211/packages/core/src/Node.ts#L238) +[Node.ts:238](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L238) ___ @@ -26,4 +26,4 @@ ___ #### Defined in -[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L239) +[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 4d195d14c6faf89a5d0313bfab7d5ba94c64981a..da6895d34a158d1de8fac57092f1796ba04fb93e 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/f264211/packages/core/src/Tool.ts#L12) +[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Tool.ts#L12) ___ @@ -36,4 +36,4 @@ ___ #### Defined in -[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Tool.ts#L19) +[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 bf6e35c449c43cf18e8c234d33ab2dc285f2daaa..d306994f5206fc399f9fc40421fa68241c27191e 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/f264211/packages/core/src/Node.ts#L29) +[Node.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L29) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L28) +[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L28) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L26) +[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L26) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L27) +[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 e374027b7948f41d75c8e467bdf4f90f483a3d57..9ea0bd6181946c50d2f58bd5da3f73dc326ce539 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/f264211/packages/core/src/callbacks/CallbackManager.ts#L21) +[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/callbacks/CallbackManager.ts#L21) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L47) +[callbacks/CallbackManager.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/callbacks/CallbackManager.ts#L47) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L46) +[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 d38a20968a677b14010122b2545c24c11a22ff47..a294b14ebc722e69c44e07578416ef26b80dff28 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/f264211/packages/core/src/ServiceContext.ts#L15) +[ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ServiceContext.ts#L15) ___ @@ -26,7 +26,7 @@ ___ #### Defined in -[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L13) +[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ServiceContext.ts#L13) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[ServiceContext.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L11) +[ServiceContext.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ServiceContext.ts#L11) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L14) +[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ServiceContext.ts#L14) ___ @@ -56,4 +56,4 @@ ___ #### Defined in -[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L12) +[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 aa740dfafd3ae24921f5b6fd6e27cd64cae9bd31..5e3ebf0e61fe86323bd1ce22264083d652a26e64 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/f264211/packages/core/src/ServiceContext.ts#L24) +[ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ServiceContext.ts#L24) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[ServiceContext.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L27) +[ServiceContext.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ServiceContext.ts#L27) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L26) +[ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ServiceContext.ts#L26) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L22) +[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ServiceContext.ts#L22) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[ServiceContext.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L20) +[ServiceContext.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ServiceContext.ts#L20) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L23) +[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ServiceContext.ts#L23) ___ @@ -74,4 +74,4 @@ ___ #### Defined in -[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L21) +[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 edc8119fa13fba33aa718100ff84bc234e12ecea..d61f91999d03ef6b59e716c62a66d28b1fda092e 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/f264211/packages/core/src/storage/StorageContext.ts#L15) +[storage/StorageContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/StorageContext.ts#L15) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/StorageContext.ts#L16) +[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/StorageContext.ts#L16) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/StorageContext.ts#L17) +[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 fbacbf2811a1bf7da1f2bb8b55608ef032cfb9b4..8e549fb8939716df9167ec526a78003d699d7809 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/f264211/packages/core/src/callbacks/CallbackManager.ts#L21) +[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/callbacks/CallbackManager.ts#L21) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L40) +[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/callbacks/CallbackManager.ts#L40) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L41) +[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/callbacks/CallbackManager.ts#L41) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L42) +[callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 2407e43e54b49f0231c5a26bf2e3e07997aeb9f7..0156ff897229b2e47148cd98d953c3e7deb7e5b1 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/f264211/packages/core/src/callbacks/CallbackManager.ts#L29) +[callbacks/CallbackManager.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/callbacks/CallbackManager.ts#L29) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L27) +[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/callbacks/CallbackManager.ts#L27) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L25) +[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/callbacks/CallbackManager.ts#L25) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L28) +[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/callbacks/CallbackManager.ts#L28) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L26) +[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 b4733e2b332f14e21af6eaa7a1675f6f7049fce0..166c4583770aaa9a7dee491ef65c7d7ff53b9b77 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/f264211/packages/core/src/OutputParser.ts#L16) +[OutputParser.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/OutputParser.ts#L16) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/OutputParser.ts#L15) +[OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 e988345960950515b17d760785ce61722064f227..231c46d9e0baac7f6c1a59d990c56e2d9519737e 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/f264211/packages/core/src/QuestionGenerator.ts#L15) +[QuestionGenerator.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/QuestionGenerator.ts#L15) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/QuestionGenerator.ts#L16) +[QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 9af56183f4f8d51b2e2610178a3f2d3872979b63..cad176602835342b71ebbd060642d4291f6561a4 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/f264211/packages/core/src/Tool.ts#L4) +[Tool.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Tool.ts#L4) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Tool.ts#L5) +[Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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 8513b65acf217b8c96d277e84a60970301ba5bc1..384744175c3267eed1b9dace583f4b5b4bda0998 100644 --- a/apps/docs/docs/api/interfaces/VectorIndexConstructorProps.md +++ b/apps/docs/docs/api/interfaces/VectorIndexConstructorProps.md @@ -24,7 +24,7 @@ custom_edit_url: null #### Defined in -[indices/BaseIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L58) +[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L60) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L60) +[indices/BaseIndex.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L62) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L61) +[indices/BaseIndex.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L63) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L56) +[indices/BaseIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L58) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L57) +[indices/BaseIndex.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L59) ___ @@ -94,4 +94,4 @@ ___ #### Defined in -[indices/BaseIndex.ts:96](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L96) +[indices/BaseIndex.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L112) diff --git a/apps/docs/docs/api/interfaces/VectorIndexOptions.md b/apps/docs/docs/api/interfaces/VectorIndexOptions.md index 0e8e0e1b4c4fad4c2d689d70d90aa60688e14ac8..4fb3cbfb134bf641815bd233ec99c168255a75e0 100644 --- a/apps/docs/docs/api/interfaces/VectorIndexOptions.md +++ b/apps/docs/docs/api/interfaces/VectorIndexOptions.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[indices/BaseIndex.ts:90](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L90) +[indices/BaseIndex.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L106) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L89) +[indices/BaseIndex.ts:105](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L105) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[indices/BaseIndex.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L91) +[indices/BaseIndex.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L107) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[indices/BaseIndex.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/indices/BaseIndex.ts#L92) +[indices/BaseIndex.ts:108](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/indices/BaseIndex.ts#L108) diff --git a/apps/docs/docs/api/interfaces/WalkableFileSystem.md b/apps/docs/docs/api/interfaces/WalkableFileSystem.md index 4ce1118c295cfce9542380bf9d2bef674cc79e64..d639082564a119efe809c42c275ac4a2d9465e7e 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/f264211/packages/core/src/storage/FileSystem.ts#L17) +[storage/FileSystem.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/FileSystem.ts#L17) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L18) +[storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/FileSystem.ts#L18) diff --git a/apps/docs/docs/api/modules.md b/apps/docs/docs/api/modules.md index 9b70628660796bf1a3edeb5442a448db916b770c..0d3fa6d6cf04e10488e30cc27b810f535ae7c1c3 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/f264211/packages/core/src/storage/FileSystem.ts#L49) +[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/FileSystem.ts#L49) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[llm/LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L25) +[llm/LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L25) ___ @@ -115,7 +115,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L11) +[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/callbacks/CallbackManager.ts#L11) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/callbacks/CallbackManager.ts#L12) +[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/callbacks/CallbackManager.ts#L12) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Node.ts#L32) +[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Node.ts#L32) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/readers/SimpleDirectoryReader.ts#L26) +[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/llm/LLM.ts#L152) +[llm/LLM.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/llm/LLM.ts#L57) +[llm/LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L57) ___ @@ -241,7 +241,7 @@ ___ #### Defined in -[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L5) +[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/constants.ts#L5) ___ @@ -251,7 +251,7 @@ ___ #### Defined in -[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L6) +[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/constants.ts#L6) ___ @@ -261,7 +261,7 @@ ___ #### Defined in -[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L4) +[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/constants.ts#L4) ___ @@ -271,7 +271,7 @@ ___ #### Defined in -[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/constants.ts#L1) +[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/constants.ts#L1) ___ @@ -281,7 +281,7 @@ ___ #### Defined in -[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L1) +[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/constants.ts#L1) ___ @@ -291,7 +291,7 @@ ___ #### Defined in -[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/constants.ts#L4) +[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/constants.ts#L4) ___ @@ -301,7 +301,7 @@ ___ #### Defined in -[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L10) +[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/constants.ts#L10) ___ @@ -311,7 +311,7 @@ ___ #### Defined in -[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L62) +[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/FileSystem.ts#L62) ___ @@ -321,7 +321,7 @@ ___ #### Defined in -[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/constants.ts#L6) +[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/constants.ts#L6) ___ @@ -331,7 +331,7 @@ ___ #### Defined in -[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/constants.ts#L3) +[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/constants.ts#L3) ___ @@ -341,7 +341,7 @@ ___ #### Defined in -[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/constants.ts#L7) +[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/constants.ts#L7) ___ @@ -351,7 +351,7 @@ ___ #### Defined in -[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L2) +[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/constants.ts#L2) ___ @@ -361,7 +361,7 @@ ___ #### Defined in -[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L11) +[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/constants.ts#L11) ___ @@ -371,7 +371,7 @@ ___ #### Defined in -[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/constants.ts#L2) +[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/constants.ts#L2) ___ @@ -381,7 +381,7 @@ ___ #### Defined in -[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/constants.ts#L7) +[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/constants.ts#L7) ___ @@ -391,7 +391,7 @@ ___ #### Defined in -[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/constants.ts#L5) +[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/constants.ts#L5) ___ @@ -410,7 +410,7 @@ ___ #### Defined in -[llm/LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L44) +[llm/LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L44) ___ @@ -429,7 +429,7 @@ ___ #### Defined in -[llm/LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/llm/LLM.ts#L49) +[llm/LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/llm/LLM.ts#L49) ___ @@ -439,7 +439,7 @@ ___ #### Defined in -[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/GlobalsHelper.ts#L42) +[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/GlobalsHelper.ts#L42) ## Functions @@ -459,7 +459,7 @@ ___ #### Defined in -[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Prompt.ts#L198) +[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/storage/FileSystem.ts#L74) +[storage/FileSystem.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/FileSystem.ts#L74) ___ @@ -667,7 +667,7 @@ ___ #### Defined in -[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/FileSystem.ts#L51) +[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/FileSystem.ts#L51) ___ @@ -690,7 +690,7 @@ ___ #### Defined in -[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/NodeParser.ts#L15) +[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/NodeParser.ts#L15) ___ @@ -711,7 +711,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:262](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ResponseSynthesizer.ts#L262) +[ResponseSynthesizer.ts:262](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ResponseSynthesizer.ts#L262) ___ @@ -732,7 +732,7 @@ ___ #### Defined in -[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/NodeParser.ts#L5) +[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Embedding.ts#L77) +[Embedding.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Embedding.ts#L77) ___ @@ -782,7 +782,7 @@ ___ #### Defined in -[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L119) +[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Embedding.ts#L119) ___ @@ -808,7 +808,7 @@ ___ #### Defined in -[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Embedding.ts#L131) +[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Embedding.ts#L131) ___ @@ -828,7 +828,7 @@ ___ #### Defined in -[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/Prompt.ts#L300) +[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Prompt.ts#L300) ___ @@ -848,7 +848,7 @@ ___ #### Defined in -[ServiceContext.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L30) +[ServiceContext.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/ServiceContext.ts#L30) ___ @@ -877,7 +877,7 @@ ___ #### Defined in -[ServiceContext.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/ServiceContext.ts#L48) +[ServiceContext.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/Embedding.ts#L22) +[Embedding.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/Embedding.ts#L22) ___ @@ -923,7 +923,7 @@ ___ #### Defined in -[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/f264211/packages/core/src/storage/StorageContext.ts#L28) +[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/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/f264211/packages/core/src/storage/FileSystem.ts#L91) +[storage/FileSystem.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/87925a3/packages/core/src/storage/FileSystem.ts#L91) diff --git a/packages/core/.gitignore b/packages/core/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..849ddff3b7ec917b5f4563e9a6d3ea63ea512a70 --- /dev/null +++ b/packages/core/.gitignore @@ -0,0 +1 @@ +dist/ diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 2c51735b8acec5568222c96e96ede06a01c8ea23..e2c28dae976a933847a1c5a2ee3084d624b0aa02 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -53,12 +53,24 @@ importers: '@mdx-js/react': specifier: ^1.6.22 version: 1.6.22(react@17.0.2) + autocomplete.js: + specifier: ^0.38.1 + version: 0.38.1 + classnames: + specifier: ^2.3.2 + version: 2.3.2 clsx: specifier: ^1.2.1 version: 1.2.1 docusaurus-lunr-search: specifier: ^2.3.2 version: 2.3.2(@docusaurus/core@2.4.1)(react-dom@17.0.2)(react@17.0.2) + hogan.js: + specifier: ^3.0.2 + version: 3.0.2 + lunr: + specifier: ^2.3.9 + version: 2.3.9 postcss: specifier: ^8.4.25 version: 8.4.25 @@ -4542,6 +4554,12 @@ packages: immediate: 3.3.0 dev: false + /autocomplete.js@0.38.1: + resolution: {integrity: sha512-6pSJzuRMY3pqpozt+SXThl2DmJfma8Bi3SVFbZHS0PW/N72bOUv+Db0jAh2cWOhTsA4X+GNmKvIl8wExJTnN9w==} + dependencies: + immediate: 3.3.0 + dev: false + /autoprefixer@10.4.14(postcss@8.4.25): resolution: {integrity: sha512-FQzyfOsTlwVzjHxKEqRIAdJx9niO6VCBCoEwax/VLSoQF29ggECcPuBqUMZ+u8jCZOPSy8b8/8KnuFbp0SaFZQ==} engines: {node: ^10 || ^12 || >=14}