diff --git a/apps/docs/docs/api/classes/BaseEmbedding.md b/apps/docs/docs/api/classes/BaseEmbedding.md index 4a40464bd7391d225b3a552348799a5571eba665..e809386ddf8ed14b593c61bdd79f950ef1ad8e27 100644 --- a/apps/docs/docs/api/classes/BaseEmbedding.md +++ b/apps/docs/docs/api/classes/BaseEmbedding.md @@ -20,9 +20,9 @@ custom_edit_url: null ## Methods -### aGetQueryEmbedding +### getQueryEmbedding -▸ `Abstract` **aGetQueryEmbedding**(`query`): `Promise`<`number`[]\> +▸ `Abstract` **getQueryEmbedding**(`query`): `Promise`<`number`[]\> #### Parameters @@ -36,13 +36,13 @@ custom_edit_url: null #### Defined in -[Embedding.ts:206](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L206) +[Embedding.ts:206](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Embedding.ts#L206) ___ -### aGetTextEmbedding +### getTextEmbedding -▸ `Abstract` **aGetTextEmbedding**(`text`): `Promise`<`number`[]\> +▸ `Abstract` **getTextEmbedding**(`text`): `Promise`<`number`[]\> #### Parameters @@ -56,7 +56,7 @@ ___ #### Defined in -[Embedding.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L205) +[Embedding.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Embedding.ts#L205) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L197) +[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 d1ac95413dcb76e5a6487b1768d4b4af005c22a0..bc72768b4cfca918594f11533a67c43e2d6fa561 100644 --- a/apps/docs/docs/api/classes/BaseIndex.md +++ b/apps/docs/docs/api/classes/BaseIndex.md @@ -19,10 +19,10 @@ they can be retrieved for our queries. - **`BaseIndex`** - ↳ [`VectorStoreIndex`](VectorStoreIndex.md) - ↳ [`ListIndex`](ListIndex.md) + ↳ [`VectorStoreIndex`](VectorStoreIndex.md) + ## Constructors ### constructor @@ -43,7 +43,7 @@ they can be retrieved for our queries. #### Defined in -[BaseIndex.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L80) +[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L76) ## Properties @@ -53,7 +53,7 @@ they can be retrieved for our queries. #### Defined in -[BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L75) +[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L71) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[BaseIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L77) +[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L73) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -[BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L78) +[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L74) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -[BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L73) +[indices/BaseIndex.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L69) ___ @@ -93,7 +93,7 @@ ___ #### Defined in -[BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L74) +[indices/BaseIndex.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L70) ___ @@ -103,7 +103,7 @@ ___ #### Defined in -[BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L76) +[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L72) ## Methods @@ -117,4 +117,4 @@ ___ #### Defined in -[BaseIndex.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L89) +[indices/BaseIndex.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L85) diff --git a/apps/docs/docs/api/classes/BaseNode.md b/apps/docs/docs/api/classes/BaseNode.md index 2489001e8f89869259f0e34492091f9360817060..dbf9ca6a3189ed9a2808e825505b15f07544ec5f 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/d73ac8e/packages/core/src/Node.ts#L48) +[Node.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L39) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L43) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L44) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L46) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L38) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L42) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L45) ## Accessors @@ -112,7 +112,7 @@ ___ #### Defined in -[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L104) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L84) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L58) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L94) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L72) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L62) ## Methods @@ -196,7 +196,7 @@ ___ #### Defined in -[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L124) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L54) +[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L54) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L116) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L55) +[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L55) ___ @@ -264,7 +264,7 @@ ___ #### Defined in -[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L52) +[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L52) ___ @@ -284,4 +284,4 @@ ___ #### Defined in -[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L56) +[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 876bcc0a5591d3745c754cc29ccfb0c18a57438f..f5f20678b32064f859ccd6218f1bddfdcc762158 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/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L68) +[callbacks/CallbackManager.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L65) +[callbacks/CallbackManager.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L66) +[callbacks/CallbackManager.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/callbacks/CallbackManager.ts#L66) diff --git a/apps/docs/docs/api/classes/ChatGPTLLMPredictor.md b/apps/docs/docs/api/classes/ChatGPTLLMPredictor.md index 5789572dead1e5b53fbb0bd690526c113544f592..d284e815ec3b84592d62f89212604cbd8f6e977b 100644 --- a/apps/docs/docs/api/classes/ChatGPTLLMPredictor.md +++ b/apps/docs/docs/api/classes/ChatGPTLLMPredictor.md @@ -26,7 +26,7 @@ ChatGPTLLMPredictor is a predictor that uses GPT. #### Defined in -[LLMPredictor.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L26) +[LLMPredictor.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L26) ## Properties @@ -36,7 +36,7 @@ ChatGPTLLMPredictor is a predictor that uses GPT. #### Defined in -[LLMPredictor.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L24) +[LLMPredictor.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L24) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[LLMPredictor.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L23) +[LLMPredictor.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L23) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[LLMPredictor.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L21) +[LLMPredictor.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L21) ___ @@ -66,48 +66,49 @@ ___ #### Defined in -[LLMPredictor.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L22) +[LLMPredictor.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L22) ## Methods -### apredict - -▸ **apredict**(`prompt`, `input?`, `parentEvent?`): `Promise`<`string`\> - -#### Parameters +### getLlmMetadata -| Name | Type | -| :------ | :------ | -| `prompt` | `string` \| [`SimplePrompt`](../modules.md#simpleprompt) | -| `input?` | `Record`<`string`, `string`\> | -| `parentEvent?` | [`Event`](../interfaces/Event.md) | +▸ **getLlmMetadata**(): `Promise`<`void`\> #### Returns -`Promise`<`string`\> +`Promise`<`void`\> #### Implementation of -[BaseLLMPredictor](../interfaces/BaseLLMPredictor.md).[apredict](../interfaces/BaseLLMPredictor.md#apredict) +[BaseLLMPredictor](../interfaces/BaseLLMPredictor.md).[getLlmMetadata](../interfaces/BaseLLMPredictor.md#getllmmetadata) #### Defined in -[LLMPredictor.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L49) +[LLMPredictor.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L45) ___ -### getLlmMetadata +### predict -▸ **getLlmMetadata**(): `Promise`<`void`\> +▸ **predict**(`prompt`, `input?`, `parentEvent?`, `logProgress?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `prompt` | `string` \| [`SimplePrompt`](../modules.md#simpleprompt) | `undefined` | +| `input?` | `Record`<`string`, `string`\> | `undefined` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | `undefined` | +| `logProgress` | `boolean` | `false` | #### Returns -`Promise`<`void`\> +`Promise`<`string`\> #### Implementation of -[BaseLLMPredictor](../interfaces/BaseLLMPredictor.md).[getLlmMetadata](../interfaces/BaseLLMPredictor.md#getllmmetadata) +[BaseLLMPredictor](../interfaces/BaseLLMPredictor.md).[predict](../interfaces/BaseLLMPredictor.md#predict) #### Defined in -[LLMPredictor.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L45) +[LLMPredictor.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L49) diff --git a/apps/docs/docs/api/classes/CompactAndRefine.md b/apps/docs/docs/api/classes/CompactAndRefine.md index 30da0122115c35c4b34bbdc4995bd2037ad54dbe..0a876d26d2c7418747a7e8fe623b472eb5d95e8f 100644 --- a/apps/docs/docs/api/classes/CompactAndRefine.md +++ b/apps/docs/docs/api/classes/CompactAndRefine.md @@ -34,7 +34,7 @@ CompactAndRefine is a slight variation of Refine that first compacts the text ch #### Defined in -[ResponseSynthesizer.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L66) +[ResponseSynthesizer.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L77) ## Properties @@ -48,7 +48,7 @@ CompactAndRefine is a slight variation of Refine that first compacts the text ch #### Defined in -[ResponseSynthesizer.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L64) +[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L75) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L62) +[ResponseSynthesizer.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L73) ___ @@ -76,13 +76,13 @@ ___ #### Defined in -[ResponseSynthesizer.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L63) +[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L74) ## Methods -### agetResponse +### getResponse -▸ **agetResponse**(`query`, `textChunks`, `prevResponse?`): `Promise`<`string`\> +▸ **getResponse**(`query`, `textChunks`, `parentEvent?`, `prevResponse?`): `Promise`<`string`\> #### Parameters @@ -90,7 +90,8 @@ ___ | :------ | :------ | | `query` | `string` | | `textChunks` | `string`[] | -| `prevResponse?` | `any` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | +| `prevResponse?` | `string` | #### Returns @@ -98,8 +99,8 @@ ___ #### Overrides -[Refine](Refine.md).[agetResponse](Refine.md#agetresponse) +[Refine](Refine.md).[getResponse](Refine.md#getresponse) #### Defined in -[ResponseSynthesizer.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L152) +[ResponseSynthesizer.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L178) diff --git a/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md b/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md index 91dd9a66b439452a22cb8ac67628a00b21cbc990..94c4d5bca542b18cff1026a0eeff8da159c77927 100644 --- a/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md +++ b/apps/docs/docs/api/classes/CondenseQuestionChatEngine.md @@ -6,7 +6,7 @@ sidebar_position: 0 custom_edit_url: null --- -CondenseQuestionChatEngine is used in conjunction with a Index (for example VectorIndex). +CondenseQuestionChatEngine is used in conjunction with a Index (for example VectorStoreIndex). It does two steps on taking a user's chat message: first, it condenses the chat message with the previous chat history into a question with more context. Then, it queries the underlying Index using the new question with context and returns @@ -37,7 +37,7 @@ data, or are very referential to previous context. #### Defined in -[ChatEngine.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L75) +[ChatEngine.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/ChatEngine.ts#L71) +[ChatEngine.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L71) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L73) +[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L73) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L70) +[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L70) ___ @@ -77,13 +77,13 @@ ___ #### Defined in -[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L72) +[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L72) ## Methods -### achat +### chat -▸ **achat**(`message`, `chatHistory?`): `Promise`<[`Response`](Response.md)\> +▸ **chat**(`message`, `chatHistory?`): `Promise`<[`Response`](Response.md)\> Send message along with the class's current chat history to the LLM. @@ -100,17 +100,17 @@ Send message along with the class's current chat history to the LLM. #### Implementation of -[ChatEngine](../interfaces/ChatEngine.md).[achat](../interfaces/ChatEngine.md#achat) +[ChatEngine](../interfaces/ChatEngine.md).[chat](../interfaces/ChatEngine.md#chat) #### Defined in -[ChatEngine.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L104) +[ChatEngine.ts:101](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L101) ___ -### acondenseQuestion +### condenseQuestion -▸ `Private` **acondenseQuestion**(`chatHistory`, `question`): `Promise`<`string`\> +▸ `Private` **condenseQuestion**(`chatHistory`, `question`): `Promise`<`string`\> #### Parameters @@ -125,7 +125,7 @@ ___ #### Defined in -[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L89) +[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L89) ___ @@ -145,4 +145,4 @@ Resets the chat history so that it's empty. #### Defined in -[ChatEngine.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L123) +[ChatEngine.ts:117](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L117) diff --git a/apps/docs/docs/api/classes/ContextChatEngine.md b/apps/docs/docs/api/classes/ContextChatEngine.md index 331f26de123c01e10edfaa1ddcd1f6ffff9df7a8..bbd9754005ba118f9f95087fa6242c0a80f0ad44 100644 --- a/apps/docs/docs/api/classes/ContextChatEngine.md +++ b/apps/docs/docs/api/classes/ContextChatEngine.md @@ -31,7 +31,7 @@ ideally allowing the appropriate context to be surfaced for each query. #### Defined in -[ChatEngine.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L138) +[ChatEngine.ts:132](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L132) ## Properties @@ -41,7 +41,7 @@ ideally allowing the appropriate context to be surfaced for each query. #### Defined in -[ChatEngine.ts:136](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L136) +[ChatEngine.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L130) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[ChatEngine.ts:135](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L135) +[ChatEngine.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L129) ___ @@ -61,13 +61,13 @@ ___ #### Defined in -[ChatEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L134) +[ChatEngine.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L128) ## Methods -### achat +### chat -▸ **achat**(`message`, `chatHistory?`): `Promise`<[`Response`](Response.md)\> +▸ **chat**(`message`, `chatHistory?`): `Promise`<[`Response`](Response.md)\> Send message along with the class's current chat history to the LLM. @@ -84,11 +84,11 @@ Send message along with the class's current chat history to the LLM. #### Implementation of -[ChatEngine](../interfaces/ChatEngine.md).[achat](../interfaces/ChatEngine.md#achat) +[ChatEngine](../interfaces/ChatEngine.md).[chat](../interfaces/ChatEngine.md#chat) #### Defined in -[ChatEngine.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L153) +[ChatEngine.ts:147](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L147) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[ChatEngine.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L149) +[ChatEngine.ts:143](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L143) ___ @@ -122,4 +122,4 @@ Resets the chat history so that it's empty. #### Defined in -[ChatEngine.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L191) +[ChatEngine.ts:185](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L185) diff --git a/apps/docs/docs/api/classes/Document.md b/apps/docs/docs/api/classes/Document.md index b920ca6c779e4522f0b7740970192424436d8a7f..df5333699f10fce7d0894da58dd2ee65df541c1e 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/d73ac8e/packages/core/src/Node.ts#L216) +[Node.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L139) +[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L139) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L44) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L46) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L38) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L42) ___ @@ -144,7 +144,7 @@ ___ #### Defined in -[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L142) +[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L142) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L45) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L138) +[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L138) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L137) +[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L104) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[Node.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L225) +[Node.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L225) ___ @@ -236,7 +236,7 @@ TextNode.nextNode #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L84) ___ @@ -254,7 +254,7 @@ TextNode.nodeId #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L58) ___ @@ -272,7 +272,7 @@ TextNode.parentNode #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L94) ___ @@ -290,7 +290,7 @@ TextNode.prevNode #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L72) ___ @@ -308,7 +308,7 @@ TextNode.sourceNode #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L124) ___ @@ -344,7 +344,7 @@ ___ #### Defined in -[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L149) +[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L149) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L157) +[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L157) ___ @@ -386,7 +386,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L116) ___ @@ -410,7 +410,7 @@ ___ #### Defined in -[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L162) +[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L162) ___ @@ -433,7 +433,7 @@ ___ #### Defined in -[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L187) +[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L187) ___ @@ -451,7 +451,7 @@ ___ #### Defined in -[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L191) +[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L191) ___ @@ -469,7 +469,7 @@ ___ #### Defined in -[Node.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L221) +[Node.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L221) ___ @@ -493,4 +493,4 @@ ___ #### Defined in -[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L183) +[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 dc387b2a173cc97828e36da22437bcdce8a10459..3051989d5804dce96138ce9d7ed0ee67a86b7f74 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/d73ac8e/packages/core/src/storage/FileSystem.ts#L25) +[storage/FileSystem.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/storage/FileSystem.ts#L38) +[storage/FileSystem.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/FileSystem.ts#L38) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L44) +[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/FileSystem.ts#L44) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L31) +[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/FileSystem.ts#L31) ___ @@ -126,4 +126,4 @@ ___ #### Defined in -[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L27) +[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 580ef2d79ca11245b31a43645deb0068acecbbd4..b5ecb42ccd416ae71521b192071d7ab02b481a4e 100644 --- a/apps/docs/docs/api/classes/IndexDict.md +++ b/apps/docs/docs/api/classes/IndexDict.md @@ -33,7 +33,7 @@ The underlying structure of each index. #### Defined in -[BaseIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L21) +[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L17) ## Properties @@ -43,7 +43,7 @@ The underlying structure of each index. #### Defined in -[BaseIndex.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L36) +[indices/BaseIndex.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L32) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L18) +[indices/BaseIndex.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L14) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[BaseIndex.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L35) +[indices/BaseIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L31) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L19) +[indices/BaseIndex.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L15) ## Methods @@ -102,7 +102,7 @@ ___ #### Defined in -[BaseIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L45) +[indices/BaseIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L41) ___ @@ -120,4 +120,4 @@ ___ #### Defined in -[BaseIndex.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L38) +[indices/BaseIndex.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L34) diff --git a/apps/docs/docs/api/classes/IndexList.md b/apps/docs/docs/api/classes/IndexList.md index 23e17f73b7889c179df978e9fac1738a7ed3944c..31fedbd865462c317777765ce63d2f6f272aa773 100644 --- a/apps/docs/docs/api/classes/IndexList.md +++ b/apps/docs/docs/api/classes/IndexList.md @@ -33,7 +33,7 @@ The underlying structure of each index. #### Defined in -[BaseIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L21) +[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L17) ## Properties @@ -47,7 +47,7 @@ The underlying structure of each index. #### Defined in -[BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L18) +[indices/BaseIndex.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L14) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[BaseIndex.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L52) +[indices/BaseIndex.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L48) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L19) +[indices/BaseIndex.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L15) ## Methods @@ -91,7 +91,7 @@ ___ #### Defined in -[BaseIndex.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L54) +[indices/BaseIndex.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L50) ___ @@ -109,4 +109,4 @@ ___ #### Defined in -[BaseIndex.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L26) +[indices/BaseIndex.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L22) diff --git a/apps/docs/docs/api/classes/IndexNode.md b/apps/docs/docs/api/classes/IndexNode.md index 38bd805fec3ee5d9cf94a3c2b0861f0572587d6c..ce1399c235776f3a57006aef9d534bf89d852428 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/d73ac8e/packages/core/src/Node.ts#L144) +[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L139) +[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L139) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L44) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L46) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L38) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[Node.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L205) +[Node.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L205) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L42) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L142) +[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L142) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L45) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L138) +[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L138) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L137) +[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L104) ___ @@ -232,7 +232,7 @@ TextNode.nextNode #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L84) ___ @@ -250,7 +250,7 @@ TextNode.nodeId #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L58) ___ @@ -268,7 +268,7 @@ TextNode.parentNode #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L94) ___ @@ -286,7 +286,7 @@ TextNode.prevNode #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L72) ___ @@ -304,7 +304,7 @@ TextNode.sourceNode #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L124) ___ @@ -340,7 +340,7 @@ ___ #### Defined in -[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L149) +[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L149) ___ @@ -364,7 +364,7 @@ ___ #### Defined in -[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L157) +[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L157) ___ @@ -382,7 +382,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L116) ___ @@ -406,7 +406,7 @@ ___ #### Defined in -[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L162) +[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L162) ___ @@ -429,7 +429,7 @@ ___ #### Defined in -[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L187) +[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L187) ___ @@ -447,7 +447,7 @@ ___ #### Defined in -[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L191) +[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L191) ___ @@ -465,7 +465,7 @@ ___ #### Defined in -[Node.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L207) +[Node.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L207) ___ @@ -489,4 +489,4 @@ ___ #### Defined in -[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L183) +[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 9babfc8f3f061e76cc85300fd79b32be73efa8c3..0fb2a9b80b2a420236b125f7c8c9937140909c2f 100644 --- a/apps/docs/docs/api/classes/IndexStruct.md +++ b/apps/docs/docs/api/classes/IndexStruct.md @@ -31,7 +31,7 @@ The underlying structure of each index. #### Defined in -[BaseIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L21) +[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L17) ## Properties @@ -41,7 +41,7 @@ The underlying structure of each index. #### Defined in -[BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L18) +[indices/BaseIndex.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L14) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L19) +[indices/BaseIndex.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L15) ## Methods @@ -65,4 +65,4 @@ ___ #### Defined in -[BaseIndex.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L26) +[indices/BaseIndex.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L22) diff --git a/apps/docs/docs/api/classes/LLMQuestionGenerator.md b/apps/docs/docs/api/classes/LLMQuestionGenerator.md index 40a0d019f1bbad83ef6aeade1e84340ce81d778b..48eb479a80e4495e524227f7ea7c8b6083d217da 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/d73ac8e/packages/core/src/QuestionGenerator.ts#L34) +[QuestionGenerator.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/QuestionGenerator.ts#L30) +[QuestionGenerator.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/QuestionGenerator.ts#L30) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QuestionGenerator.ts#L32) +[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/QuestionGenerator.ts#L32) ___ @@ -56,13 +56,13 @@ ___ #### Defined in -[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QuestionGenerator.ts#L31) +[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/QuestionGenerator.ts#L31) ## Methods -### agenerate +### generate -▸ **agenerate**(`tools`, `query`): `Promise`<[`SubQuestion`](../interfaces/SubQuestion.md)[]\> +▸ **generate**(`tools`, `query`): `Promise`<[`SubQuestion`](../interfaces/SubQuestion.md)[]\> #### Parameters @@ -77,8 +77,8 @@ ___ #### Implementation of -[BaseQuestionGenerator](../interfaces/BaseQuestionGenerator.md).[agenerate](../interfaces/BaseQuestionGenerator.md#agenerate) +[BaseQuestionGenerator](../interfaces/BaseQuestionGenerator.md).[generate](../interfaces/BaseQuestionGenerator.md#generate) #### Defined in -[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QuestionGenerator.ts#L40) +[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 278d53a64fc65a44a88e3c832b93b74420eab3f7..4351255322bc4cd0d1a58e7a172b2812fd0fb5c0 100644 --- a/apps/docs/docs/api/classes/ListIndex.md +++ b/apps/docs/docs/api/classes/ListIndex.md @@ -32,7 +32,7 @@ A ListIndex keeps nodes in a sequential list structure #### Defined in -[index/list/ListIndex.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L37) +[indices/list/ListIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndex.ts#L41) ## Properties @@ -46,7 +46,7 @@ A ListIndex keeps nodes in a sequential list structure #### Defined in -[BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L75) +[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L71) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[BaseIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L77) +[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L73) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L78) +[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L74) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L73) +[indices/BaseIndex.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L69) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L74) +[indices/BaseIndex.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L70) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L76) +[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L72) ## Methods @@ -136,7 +136,7 @@ ___ #### Defined in -[index/list/ListIndex.ts:140](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L140) +[indices/list/ListIndex.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndex.ts#L156) ___ @@ -156,19 +156,20 @@ ___ #### Defined in -[index/list/ListIndex.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L134) +[indices/list/ListIndex.ts:150](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndex.ts#L150) ___ ### asQueryEngine -▸ **asQueryEngine**(`mode?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) +▸ **asQueryEngine**(`mode?`, `responseSynthesizer?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) #### Parameters | Name | Type | Default value | | :------ | :------ | :------ | | `mode` | [`ListRetrieverMode`](../enums/ListRetrieverMode.md) | `ListRetrieverMode.DEFAULT` | +| `responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | `undefined` | #### Returns @@ -176,7 +177,7 @@ ___ #### Defined in -[index/list/ListIndex.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L113) +[indices/list/ListIndex.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndex.ts#L118) ___ @@ -200,7 +201,7 @@ ___ #### Defined in -[index/list/ListIndex.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L100) +[indices/list/ListIndex.ts:105](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndex.ts#L105) ___ @@ -214,7 +215,7 @@ ___ #### Defined in -[index/list/ListIndex.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L146) +[indices/list/ListIndex.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndex.ts#L162) ___ @@ -236,21 +237,22 @@ ___ #### Defined in -[index/list/ListIndex.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L119) +[indices/list/ListIndex.ts:135](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndex.ts#L135) ___ ### fromDocuments -▸ `Static` **fromDocuments**(`documents`, `storageContext?`, `serviceContext?`): `Promise`<[`ListIndex`](ListIndex.md)\> +▸ `Static` **fromDocuments**(`args`): `Promise`<[`ListIndex`](ListIndex.md)\> #### Parameters | Name | Type | | :------ | :------ | -| `documents` | [`Document`](Document.md)[] | -| `storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) | -| `serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | +| `args` | `Object` | +| `args.documents` | [`Document`](Document.md)[] | +| `args.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | +| `args.storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) | #### Returns @@ -258,7 +260,7 @@ ___ #### Defined in -[index/list/ListIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L77) +[indices/list/ListIndex.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndex.ts#L81) ___ @@ -278,4 +280,4 @@ ___ #### Defined in -[index/list/ListIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L41) +[indices/list/ListIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 a5d416cb83b14e9c1c74579aabb53ce441005329..d2a31e525c6dbab6fec0ece48ae0f3e5e2caff75 100644 --- a/apps/docs/docs/api/classes/ListIndexLLMRetriever.md +++ b/apps/docs/docs/api/classes/ListIndexLLMRetriever.md @@ -31,7 +31,7 @@ LLM retriever for ListIndex. #### Defined in -[index/list/ListIndexRetriever.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L67) +[indices/list/ListIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndexRetriever.ts#L64) ## Properties @@ -41,7 +41,7 @@ LLM retriever for ListIndex. #### Defined in -[index/list/ListIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L62) +[indices/list/ListIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndexRetriever.ts#L59) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[index/list/ListIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L61) +[indices/list/ListIndexRetriever.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndexRetriever.ts#L58) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[index/list/ListIndexRetriever.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L63) +[indices/list/ListIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndexRetriever.ts#L60) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[index/list/ListIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L60) +[indices/list/ListIndexRetriever.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndexRetriever.ts#L57) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[index/list/ListIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L64) +[indices/list/ListIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndexRetriever.ts#L61) ___ @@ -91,47 +91,47 @@ ___ #### Defined in -[index/list/ListIndexRetriever.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L65) +[indices/list/ListIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndexRetriever.ts#L62) ## Methods -### aretrieve - -▸ **aretrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\> - -#### Parameters +### getServiceContext -| Name | Type | -| :------ | :------ | -| `query` | `string` | -| `parentEvent?` | [`Event`](../interfaces/Event.md) | +▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) #### Returns -`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\> +[`ServiceContext`](../interfaces/ServiceContext.md) #### Implementation of -[BaseRetriever](../interfaces/BaseRetriever.md).[aretrieve](../interfaces/BaseRetriever.md#aretrieve) +[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext) #### Defined in -[index/list/ListIndexRetriever.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L84) +[indices/list/ListIndexRetriever.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndexRetriever.ts#L128) ___ -### getServiceContext +### retrieve -▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) +▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | #### Returns -[`ServiceContext`](../interfaces/ServiceContext.md) +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\> #### Implementation of -[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext) +[BaseRetriever](../interfaces/BaseRetriever.md).[retrieve](../interfaces/BaseRetriever.md#retrieve) #### Defined in -[index/list/ListIndexRetriever.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L134) +[indices/list/ListIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 0ddd041d68725c5543b7e69405fd6cb4f3e74d4b..546a1dc9e27d1bafc746ef136a11c7ce84c70ecb 100644 --- a/apps/docs/docs/api/classes/ListIndexRetriever.md +++ b/apps/docs/docs/api/classes/ListIndexRetriever.md @@ -26,7 +26,7 @@ Simple retriever for ListIndex that returns all nodes #### Defined in -[index/list/ListIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L22) +[indices/list/ListIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndexRetriever.ts#L22) ## Properties @@ -36,47 +36,47 @@ Simple retriever for ListIndex that returns all nodes #### Defined in -[index/list/ListIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L20) +[indices/list/ListIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndexRetriever.ts#L20) ## Methods -### aretrieve - -▸ **aretrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\> - -#### Parameters +### getServiceContext -| Name | Type | -| :------ | :------ | -| `query` | `string` | -| `parentEvent?` | [`Event`](../interfaces/Event.md) | +▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) #### Returns -`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\> +[`ServiceContext`](../interfaces/ServiceContext.md) #### Implementation of -[BaseRetriever](../interfaces/BaseRetriever.md).[aretrieve](../interfaces/BaseRetriever.md#aretrieve) +[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext) #### Defined in -[index/list/ListIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L26) +[indices/list/ListIndexRetriever.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndexRetriever.ts#L48) ___ -### getServiceContext +### retrieve -▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) +▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | #### Returns -[`ServiceContext`](../interfaces/ServiceContext.md) +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\> #### Implementation of -[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext) +[BaseRetriever](../interfaces/BaseRetriever.md).[retrieve](../interfaces/BaseRetriever.md#retrieve) #### Defined in -[index/list/ListIndexRetriever.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndexRetriever.ts#L51) +[indices/list/ListIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndexRetriever.ts#L26) diff --git a/apps/docs/docs/api/classes/OpenAI.md b/apps/docs/docs/api/classes/OpenAI.md index 07190def4b5bacd7c91f95b8312ae13da6fe3526..dea52ccaf83cd40fae6e8cefde38abe86a6eaccd 100644 --- a/apps/docs/docs/api/classes/OpenAI.md +++ b/apps/docs/docs/api/classes/OpenAI.md @@ -26,7 +26,7 @@ OpenAI LLM implementation #### Defined in -[LLM.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L76) +[LLM.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L76) ## Properties @@ -36,7 +36,7 @@ OpenAI LLM implementation #### Defined in -[LLM.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L74) +[LLM.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L74) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[LLM.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L69) +[LLM.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L69) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[LLM.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L71) +[LLM.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L71) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L66) +[LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L66) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[LLM.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L70) +[LLM.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L70) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[LLM.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L72) +[LLM.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L72) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L68) +[LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L68) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[LLM.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L73) +[LLM.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L73) ___ @@ -116,13 +116,13 @@ ___ #### Defined in -[LLM.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L67) +[LLM.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L67) ## Methods -### achat +### chat -▸ **achat**(`messages`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\> +▸ **chat**(`messages`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\> Get a chat response from the LLM @@ -139,17 +139,17 @@ Get a chat response from the LLM #### Implementation of -[LLM](../interfaces/LLM.md).[achat](../interfaces/LLM.md#achat) +[LLM](../interfaces/LLM.md).[chat](../interfaces/LLM.md#chat) #### Defined in -[LLM.ts:103](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L103) +[LLM.ts:103](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L103) ___ -### acomplete +### complete -▸ **acomplete**(`prompt`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\> +▸ **complete**(`prompt`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\> Get a prompt completion from the LLM @@ -166,11 +166,11 @@ Get a prompt completion from the LLM #### Implementation of -[LLM](../interfaces/LLM.md).[acomplete](../interfaces/LLM.md#acomplete) +[LLM](../interfaces/LLM.md).[complete](../interfaces/LLM.md#complete) #### Defined in -[LLM.ts:145](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L145) +[LLM.ts:145](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L145) ___ @@ -190,4 +190,4 @@ ___ #### Defined in -[LLM.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L88) +[LLM.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L88) diff --git a/apps/docs/docs/api/classes/OpenAIEmbedding.md b/apps/docs/docs/api/classes/OpenAIEmbedding.md index d82b7fad83749de6f798e83f793efe74ad8ef19b..ea5bc3ceaddfef9ddda96100dd00cf07d328577a 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/d73ac8e/packages/core/src/Embedding.ts#L217) +[Embedding.ts:217](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/Embedding.ts#L215) +[Embedding.ts:215](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Embedding.ts#L215) ___ @@ -44,13 +44,13 @@ ___ #### Defined in -[Embedding.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L214) +[Embedding.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Embedding.ts#L214) ## Methods -### \_aGetOpenAIEmbedding +### getOpenAIEmbedding -▸ `Private` **_aGetOpenAIEmbedding**(`input`): `Promise`<`number`[]\> +▸ `Private` **getOpenAIEmbedding**(`input`): `Promise`<`number`[]\> #### Parameters @@ -64,13 +64,13 @@ ___ #### Defined in -[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L224) +[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Embedding.ts#L224) ___ -### aGetQueryEmbedding +### getQueryEmbedding -▸ **aGetQueryEmbedding**(`query`): `Promise`<`number`[]\> +▸ **getQueryEmbedding**(`query`): `Promise`<`number`[]\> #### Parameters @@ -84,17 +84,17 @@ ___ #### Overrides -[BaseEmbedding](BaseEmbedding.md).[aGetQueryEmbedding](BaseEmbedding.md#agetqueryembedding) +[BaseEmbedding](BaseEmbedding.md).[getQueryEmbedding](BaseEmbedding.md#getqueryembedding) #### Defined in -[Embedding.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L240) +[Embedding.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Embedding.ts#L240) ___ -### aGetTextEmbedding +### getTextEmbedding -▸ **aGetTextEmbedding**(`text`): `Promise`<`number`[]\> +▸ **getTextEmbedding**(`text`): `Promise`<`number`[]\> #### Parameters @@ -108,11 +108,11 @@ ___ #### Overrides -[BaseEmbedding](BaseEmbedding.md).[aGetTextEmbedding](BaseEmbedding.md#agettextembedding) +[BaseEmbedding](BaseEmbedding.md).[getTextEmbedding](BaseEmbedding.md#gettextembedding) #### Defined in -[Embedding.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L236) +[Embedding.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Embedding.ts#L236) ___ @@ -138,4 +138,4 @@ ___ #### Defined in -[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L197) +[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Embedding.ts#L197) diff --git a/apps/docs/docs/api/classes/Refine.md b/apps/docs/docs/api/classes/Refine.md index 7566026d258ecdb3fa756136965e8da0365c7902..d02c001575123fe379780302b12e849393c6f2ce 100644 --- a/apps/docs/docs/api/classes/Refine.md +++ b/apps/docs/docs/api/classes/Refine.md @@ -34,7 +34,7 @@ A response builder that uses the query to ask the LLM generate a better response #### Defined in -[ResponseSynthesizer.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L66) +[ResponseSynthesizer.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L77) ## Properties @@ -44,7 +44,7 @@ A response builder that uses the query to ask the LLM generate a better response #### Defined in -[ResponseSynthesizer.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L64) +[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L75) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L62) +[ResponseSynthesizer.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L73) ___ @@ -64,13 +64,13 @@ ___ #### Defined in -[ResponseSynthesizer.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L63) +[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L74) ## Methods -### agetResponse +### getResponse -▸ **agetResponse**(`query`, `textChunks`, `prevResponse?`): `Promise`<`string`\> +▸ **getResponse**(`query`, `textChunks`, `parentEvent?`, `prevResponse?`): `Promise`<`string`\> #### Parameters @@ -78,7 +78,8 @@ ___ | :------ | :------ | | `query` | `string` | | `textChunks` | `string`[] | -| `prevResponse?` | `any` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | +| `prevResponse?` | `string` | #### Returns @@ -86,17 +87,17 @@ ___ #### Implementation of -BaseResponseBuilder.agetResponse +BaseResponseBuilder.getResponse #### Defined in -[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L76) +[ResponseSynthesizer.ts:87](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L87) ___ ### giveResponseSingle -▸ `Private` **giveResponseSingle**(`queryStr`, `textChunk`): `Promise`<`string`\> +▸ `Private` **giveResponseSingle**(`queryStr`, `textChunk`, `parentEvent?`): `Promise`<`string`\> #### Parameters @@ -104,6 +105,7 @@ ___ | :------ | :------ | | `queryStr` | `string` | | `textChunk` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | #### Returns @@ -111,13 +113,13 @@ ___ #### Defined in -[ResponseSynthesizer.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L95) +[ResponseSynthesizer.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L112) ___ ### refineResponseSingle -▸ `Private` **refineResponseSingle**(`response`, `queryStr`, `textChunk`): `Promise`<`string`\> +▸ `Private` **refineResponseSingle**(`response`, `queryStr`, `textChunk`, `parentEvent?`): `Promise`<`string`\> #### Parameters @@ -126,6 +128,7 @@ ___ | `response` | `string` | | `queryStr` | `string` | | `textChunk` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | #### Returns @@ -133,4 +136,4 @@ ___ #### Defined in -[ResponseSynthesizer.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L123) +[ResponseSynthesizer.ts:147](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L147) diff --git a/apps/docs/docs/api/classes/Response.md b/apps/docs/docs/api/classes/Response.md index de60886b2112751a39f8752f9f1fc223119bb57d..a62d7a242e289b2efdfb7067802bb354f1fed4a7 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/d73ac8e/packages/core/src/Response.ts#L10) +[Response.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/Response.ts#L7) +[Response.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Response.ts#L7) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Response.ts#L8) +[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Response.ts#L8) ## Methods @@ -57,7 +57,7 @@ ___ #### Defined in -[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Response.ts#L15) +[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Response.ts#L15) ___ @@ -71,4 +71,4 @@ ___ #### Defined in -[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Response.ts#L19) +[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 cfd18782f7243e7e462c05b17beb5de38064939b..29fe0f183a117c8f16aa64fe197760ba19b7f161 100644 --- a/apps/docs/docs/api/classes/ResponseSynthesizer.md +++ b/apps/docs/docs/api/classes/ResponseSynthesizer.md @@ -24,7 +24,7 @@ A ResponseSynthesizer is used to generate a response from a query and a list of #### Defined in -[ResponseSynthesizer.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L225) +[ResponseSynthesizer.ts:279](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L279) ## Properties @@ -34,23 +34,23 @@ A ResponseSynthesizer is used to generate a response from a query and a list of #### Defined in -[ResponseSynthesizer.ts:222](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L222) +[ResponseSynthesizer.ts:276](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L276) ___ ### serviceContext -• `Optional` **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) #### Defined in -[ResponseSynthesizer.ts:223](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L223) +[ResponseSynthesizer.ts:277](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L277) ## Methods -### asynthesize +### synthesize -▸ **asynthesize**(`query`, `nodes`, `parentEvent?`): `Promise`<[`Response`](Response.md)\> +▸ **synthesize**(`query`, `nodes`, `parentEvent?`): `Promise`<[`Response`](Response.md)\> #### Parameters @@ -66,4 +66,4 @@ ___ #### Defined in -[ResponseSynthesizer.ts:237](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L237) +[ResponseSynthesizer.ts:291](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L291) diff --git a/apps/docs/docs/api/classes/RetrieverQueryEngine.md b/apps/docs/docs/api/classes/RetrieverQueryEngine.md index 91b47c53fd861042b888d0d2d244210de2a6ab68..c71b32e7fce5f9dc2c286966f4984c0026ee0c12 100644 --- a/apps/docs/docs/api/classes/RetrieverQueryEngine.md +++ b/apps/docs/docs/api/classes/RetrieverQueryEngine.md @@ -16,17 +16,18 @@ A query engine that uses a retriever to query an index and then synthesizes the ### constructor -• **new RetrieverQueryEngine**(`retriever`) +• **new RetrieverQueryEngine**(`retriever`, `responseSynthesizer?`) #### Parameters | Name | Type | | :------ | :------ | | `retriever` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | +| `responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | #### Defined in -[QueryEngine.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L29) +[QueryEngine.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/QueryEngine.ts#L34) ## Properties @@ -36,7 +37,7 @@ A query engine that uses a retriever to query an index and then synthesizes the #### Defined in -[QueryEngine.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L27) +[QueryEngine.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/QueryEngine.ts#L32) ___ @@ -46,13 +47,15 @@ ___ #### Defined in -[QueryEngine.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L26) +[QueryEngine.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/QueryEngine.ts#L31) ## Methods -### aquery +### query -▸ **aquery**(`query`, `parentEvent?`): `Promise`<[`Response`](Response.md)\> +▸ **query**(`query`, `parentEvent?`): `Promise`<[`Response`](Response.md)\> + +Query the query engine and get a response. #### Parameters @@ -67,8 +70,8 @@ ___ #### Implementation of -[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[aquery](../interfaces/BaseQueryEngine.md#aquery) +[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[query](../interfaces/BaseQueryEngine.md#query) #### Defined in -[QueryEngine.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L36) +[QueryEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 82ac2b023903f77893c3e8659e81352024c59d14..eb4596a7937a63fe8746c23634c2419ef13d8b80 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/d73ac8e/packages/core/src/TextSplitter.ts#L33) +[TextSplitter.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/TextSplitter.ts#L26) +[TextSplitter.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/TextSplitter.ts#L26) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[TextSplitter.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L25) +[TextSplitter.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/TextSplitter.ts#L25) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L30) +[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/TextSplitter.ts#L30) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L29) +[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/TextSplitter.ts#L29) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L27) +[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/TextSplitter.ts#L27) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L28) +[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/TextSplitter.ts#L28) ## Methods @@ -108,7 +108,7 @@ ___ #### Defined in -[TextSplitter.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L153) +[TextSplitter.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/TextSplitter.ts#L153) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[TextSplitter.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L72) +[TextSplitter.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/TextSplitter.ts#L72) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -[TextSplitter.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L89) +[TextSplitter.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/TextSplitter.ts#L89) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[TextSplitter.ts:115](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L115) +[TextSplitter.ts:115](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/TextSplitter.ts#L115) ___ @@ -191,7 +191,7 @@ ___ #### Defined in -[TextSplitter.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L128) +[TextSplitter.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/TextSplitter.ts#L128) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[TextSplitter.ts:233](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L233) +[TextSplitter.ts:233](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/TextSplitter.ts#L233) ___ @@ -233,4 +233,4 @@ ___ #### Defined in -[TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/TextSplitter.ts#L205) +[TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 a7d04856587f9902ae392450d3addb91824d570c..fe9ef0f0863b94b4d080fa61fc8c55baddd4405f 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/d73ac8e/packages/core/src/ChatEngine.ts#L40) +[ChatEngine.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/ChatEngine.ts#L37) +[ChatEngine.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L37) ___ @@ -46,13 +46,13 @@ ___ #### Defined in -[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L38) +[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L38) ## Methods -### achat +### chat -▸ **achat**(`message`, `chatHistory?`): `Promise`<[`Response`](Response.md)\> +▸ **chat**(`message`, `chatHistory?`): `Promise`<[`Response`](Response.md)\> Send message along with the class's current chat history to the LLM. @@ -69,11 +69,11 @@ Send message along with the class's current chat history to the LLM. #### Implementation of -[ChatEngine](../interfaces/ChatEngine.md).[achat](../interfaces/ChatEngine.md#achat) +[ChatEngine](../interfaces/ChatEngine.md).[chat](../interfaces/ChatEngine.md#chat) #### Defined in -[ChatEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ChatEngine.ts#L45) +[ChatEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/ChatEngine.ts#L54) +[ChatEngine.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ChatEngine.ts#L54) diff --git a/apps/docs/docs/api/classes/SimpleNodeParser.md b/apps/docs/docs/api/classes/SimpleNodeParser.md index df9b88548fa6da7c0683a337b12f6c256601e7bd..51305c207164d9e35c38ddca952a4a3c9094efec 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/d73ac8e/packages/core/src/NodeParser.ts#L64) +[NodeParser.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/NodeParser.ts#L61) +[NodeParser.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/NodeParser.ts#L61) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[NodeParser.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/NodeParser.ts#L62) +[NodeParser.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/NodeParser.ts#L62) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[NodeParser.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/NodeParser.ts#L60) +[NodeParser.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/NodeParser.ts#L95) +[NodeParser.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/NodeParser.ts#L95) ___ @@ -111,4 +111,4 @@ ___ #### Defined in -[NodeParser.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/NodeParser.ts#L82) +[NodeParser.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 2587128343d97a4f097b8a354d958c356aec79e0..633812020a504fabfe92235614d8325e5b6a33f5 100644 --- a/apps/docs/docs/api/classes/SimpleResponseBuilder.md +++ b/apps/docs/docs/api/classes/SimpleResponseBuilder.md @@ -16,17 +16,17 @@ A response builder that just concatenates responses. ### constructor -• **new SimpleResponseBuilder**(`serviceContext?`) +• **new SimpleResponseBuilder**(`serviceContext`) #### Parameters | Name | Type | | :------ | :------ | -| `serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | #### Defined in -[ResponseSynthesizer.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L37) +[ResponseSynthesizer.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L49) ## Properties @@ -36,7 +36,7 @@ A response builder that just concatenates responses. #### Defined in -[ResponseSynthesizer.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L34) +[ResponseSynthesizer.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L46) ___ @@ -46,13 +46,13 @@ ___ #### Defined in -[ResponseSynthesizer.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L35) +[ResponseSynthesizer.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L47) ## Methods -### agetResponse +### getResponse -▸ **agetResponse**(`query`, `textChunks`, `parentEvent?`): `Promise`<`string`\> +▸ **getResponse**(`query`, `textChunks`, `parentEvent?`): `Promise`<`string`\> #### Parameters @@ -68,8 +68,8 @@ ___ #### Implementation of -BaseResponseBuilder.agetResponse +BaseResponseBuilder.getResponse #### Defined in -[ResponseSynthesizer.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L43) +[ResponseSynthesizer.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 e174b01637d19fc5a3b2b7bfc41fc0abb6164695..ef31c37a2324befa715624b6e7084b480bc10531 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/d73ac8e/packages/core/src/OutputParser.ts#L97) +[OutputParser.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/OutputParser.ts#L97) ___ @@ -64,4 +64,4 @@ ___ #### Defined in -[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/OutputParser.ts#L89) +[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 e1c856301dc118ae58094c3cbe091b318a1f3bc9..de43091df781c60dc96fffb793ee6f3e163c59e6 100644 --- a/apps/docs/docs/api/classes/SubQuestionQueryEngine.md +++ b/apps/docs/docs/api/classes/SubQuestionQueryEngine.md @@ -29,7 +29,7 @@ SubQuestionQueryEngine decomposes a question into subquestions and then #### Defined in -[QueryEngine.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L56) +[QueryEngine.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/QueryEngine.ts#L65) ## Properties @@ -39,7 +39,7 @@ SubQuestionQueryEngine decomposes a question into subquestions and then #### Defined in -[QueryEngine.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L54) +[QueryEngine.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/QueryEngine.ts#L63) ___ @@ -49,7 +49,7 @@ ___ #### Defined in -[QueryEngine.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L53) +[QueryEngine.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/QueryEngine.ts#L62) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -[QueryEngine.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L52) +[QueryEngine.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/QueryEngine.ts#L61) ___ @@ -69,13 +69,15 @@ ___ #### Defined in -[QueryEngine.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L51) +[QueryEngine.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/QueryEngine.ts#L60) ## Methods -### aquery +### query -▸ **aquery**(`query`): `Promise`<[`Response`](Response.md)\> +▸ **query**(`query`): `Promise`<[`Response`](Response.md)\> + +Query the query engine and get a response. #### Parameters @@ -89,17 +91,17 @@ ___ #### Implementation of -[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[aquery](../interfaces/BaseQueryEngine.md#aquery) +[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[query](../interfaces/BaseQueryEngine.md#query) #### Defined in -[QueryEngine.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L97) +[QueryEngine.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/QueryEngine.ts#L106) ___ -### aquerySubQ +### querySubQ -▸ `Private` **aquerySubQ**(`subQ`, `parentEvent?`): `Promise`<``null`` \| [`NodeWithScore`](../interfaces/NodeWithScore.md)\> +▸ `Private` **querySubQ**(`subQ`, `parentEvent?`): `Promise`<``null`` \| [`NodeWithScore`](../interfaces/NodeWithScore.md)\> #### Parameters @@ -114,7 +116,7 @@ ___ #### Defined in -[QueryEngine.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L128) +[QueryEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/QueryEngine.ts#L134) ___ @@ -138,4 +140,4 @@ ___ #### Defined in -[QueryEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L73) +[QueryEngine.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 59366c1917538113083f59b665d7bae268dd8ac7..5d9ec521a38952322a6ae66c66323899b08b4cb4 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/d73ac8e/packages/core/src/readers/SimpleDirectoryReader.ts#L12) +[readers/SimpleDirectoryReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 6a1ec8ac9fe1c5bca17fa9dd4c75ce878c9d46ef..78d0bc0da5892d89beda439960a312133e7d4f54 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/d73ac8e/packages/core/src/Node.ts#L144) +[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/Node.ts#L39) +[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L139) +[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L139) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L43) +[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L44) +[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L44) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L46) +[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L46) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L38) +[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L38) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L42) +[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L42) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L142) +[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L142) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L45) +[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L45) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L138) +[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L138) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L137) +[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/Node.ts#L104) +[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L104) ___ @@ -210,7 +210,7 @@ BaseNode.nextNode #### Defined in -[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L84) +[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L84) ___ @@ -228,7 +228,7 @@ BaseNode.nodeId #### Defined in -[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L58) +[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L58) ___ @@ -246,7 +246,7 @@ BaseNode.parentNode #### Defined in -[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L94) +[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L94) ___ @@ -264,7 +264,7 @@ BaseNode.prevNode #### Defined in -[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L72) +[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L72) ___ @@ -282,7 +282,7 @@ BaseNode.sourceNode #### Defined in -[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L62) +[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/Node.ts#L124) +[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L124) ___ @@ -314,7 +314,7 @@ ___ #### Defined in -[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L149) +[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L149) ___ @@ -338,7 +338,7 @@ ___ #### Defined in -[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L157) +[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L157) ___ @@ -356,7 +356,7 @@ ___ #### Defined in -[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L116) +[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L116) ___ @@ -380,7 +380,7 @@ ___ #### Defined in -[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L162) +[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L162) ___ @@ -399,7 +399,7 @@ ___ #### Defined in -[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L187) +[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L187) ___ @@ -413,7 +413,7 @@ ___ #### Defined in -[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L191) +[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L191) ___ @@ -431,7 +431,7 @@ ___ #### Defined in -[Node.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L153) +[Node.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L153) ___ @@ -455,4 +455,4 @@ ___ #### Defined in -[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L183) +[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 9d7e1b0d462fa7a0fd8cd3d3dff8339dcda9c73f..9f2497a04aa306524a97fef726211aa4d3b101e7 100644 --- a/apps/docs/docs/api/classes/TreeSummarize.md +++ b/apps/docs/docs/api/classes/TreeSummarize.md @@ -26,7 +26,7 @@ TreeSummarize repacks the text chunks into the smallest possible number of chunk #### Defined in -[ResponseSynthesizer.ts:177](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L177) +[ResponseSynthesizer.ts:209](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L209) ## Properties @@ -36,13 +36,13 @@ TreeSummarize repacks the text chunks into the smallest possible number of chunk #### Defined in -[ResponseSynthesizer.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L175) +[ResponseSynthesizer.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L207) ## Methods -### agetResponse +### getResponse -▸ **agetResponse**(`query`, `textChunks`): `Promise`<`string`\> +▸ **getResponse**(`query`, `textChunks`, `parentEvent?`): `Promise`<`string`\> #### Parameters @@ -50,6 +50,7 @@ TreeSummarize repacks the text chunks into the smallest possible number of chunk | :------ | :------ | | `query` | `string` | | `textChunks` | `string`[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | #### Returns @@ -57,8 +58,8 @@ TreeSummarize repacks the text chunks into the smallest possible number of chunk #### Implementation of -BaseResponseBuilder.agetResponse +BaseResponseBuilder.getResponse #### Defined in -[ResponseSynthesizer.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L181) +[ResponseSynthesizer.ts:213](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L213) diff --git a/apps/docs/docs/api/classes/VectorIndexRetriever.md b/apps/docs/docs/api/classes/VectorIndexRetriever.md index fd72888e592ff2f7e6da540c8628c61d990d8fdc..800889509ad243e864398db13a6afbe22f379914 100644 --- a/apps/docs/docs/api/classes/VectorIndexRetriever.md +++ b/apps/docs/docs/api/classes/VectorIndexRetriever.md @@ -26,7 +26,7 @@ VectorIndexRetriever retrieves nodes from a VectorIndex. #### Defined in -[Retriever.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L28) +[indices/vectorStore/VectorIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L22) ## Properties @@ -36,7 +36,7 @@ VectorIndexRetriever retrieves nodes from a VectorIndex. #### Defined in -[Retriever.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L24) +[indices/vectorStore/VectorIndexRetriever.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L18) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[Retriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L26) +[indices/vectorStore/VectorIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L20) ___ @@ -56,47 +56,47 @@ ___ #### Defined in -[Retriever.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L25) +[indices/vectorStore/VectorIndexRetriever.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L19) ## Methods -### aretrieve - -▸ **aretrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\> - -#### Parameters +### getServiceContext -| Name | Type | -| :------ | :------ | -| `query` | `string` | -| `parentEvent?` | [`Event`](../interfaces/Event.md) | +▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) #### Returns -`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\> +[`ServiceContext`](../interfaces/ServiceContext.md) #### Implementation of -[BaseRetriever](../interfaces/BaseRetriever.md).[aretrieve](../interfaces/BaseRetriever.md#aretrieve) +[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext) #### Defined in -[Retriever.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L33) +[indices/vectorStore/VectorIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L61) ___ -### getServiceContext +### retrieve -▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) +▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | #### Returns -[`ServiceContext`](../interfaces/ServiceContext.md) +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\> #### Implementation of -[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext) +[BaseRetriever](../interfaces/BaseRetriever.md).[retrieve](../interfaces/BaseRetriever.md#retrieve) #### Defined in -[Retriever.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L70) +[indices/vectorStore/VectorIndexRetriever.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L27) diff --git a/apps/docs/docs/api/classes/VectorStoreIndex.md b/apps/docs/docs/api/classes/VectorStoreIndex.md index 361ee94cb1972fe2f5f2820bc9b4a04187b46cd7..b5f95e4491130aa423c99b6a61e1a833bde7da8a 100644 --- a/apps/docs/docs/api/classes/VectorStoreIndex.md +++ b/apps/docs/docs/api/classes/VectorStoreIndex.md @@ -24,7 +24,7 @@ The VectorStoreIndex, an index that stores the nodes only according to their vec | Name | Type | | :------ | :------ | -| `init` | `VectorIndexConstructorProps` | +| `init` | [`VectorIndexConstructorProps`](../interfaces/VectorIndexConstructorProps.md) | #### Overrides @@ -32,7 +32,7 @@ The VectorStoreIndex, an index that stores the nodes only according to their vec #### Defined in -[BaseIndex.ts:109](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L109) +[indices/vectorStore/VectorStoreIndex.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L32) ## Properties @@ -46,7 +46,7 @@ The VectorStoreIndex, an index that stores the nodes only according to their vec #### Defined in -[BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L75) +[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L71) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[BaseIndex.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L77) +[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L73) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L78) +[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L74) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L73) +[indices/BaseIndex.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L69) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L74) +[indices/BaseIndex.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L70) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[BaseIndex.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L107) +[indices/vectorStore/VectorStoreIndex.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L30) ## Methods @@ -134,7 +134,7 @@ NOTE: if you are using a custom query engine you don't have to use this method. #### Defined in -[BaseIndex.ts:252](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L252) +[indices/vectorStore/VectorStoreIndex.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L175) ___ @@ -158,31 +158,7 @@ retriever for the index #### Defined in -[BaseIndex.ts:242](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L242) - -___ - -### agetNodeEmbeddingResults - -▸ `Static` **agetNodeEmbeddingResults**(`nodes`, `serviceContext`, `logProgress?`): `Promise`<[`NodeWithEmbedding`](../interfaces/NodeWithEmbedding.md)[]\> - -Get the embeddings for nodes. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `nodes` | [`BaseNode`](BaseNode.md)[] | `undefined` | | -| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | `undefined` | | -| `logProgress` | `boolean` | `false` | log progress to console (useful for debugging) | - -#### Returns - -`Promise`<[`NodeWithEmbedding`](../interfaces/NodeWithEmbedding.md)[]\> - -#### Defined in - -[BaseIndex.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L159) +[indices/vectorStore/VectorStoreIndex.ts:165](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L165) ___ @@ -206,7 +182,7 @@ Get embeddings for nodes and place them into the index. #### Defined in -[BaseIndex.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L187) +[indices/vectorStore/VectorStoreIndex.ts:110](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L110) ___ @@ -230,7 +206,31 @@ High level API: split documents, get embeddings, and build index. #### Defined in -[BaseIndex.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L214) +[indices/vectorStore/VectorStoreIndex.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L137) + +___ + +### getNodeEmbeddingResults + +▸ `Static` **getNodeEmbeddingResults**(`nodes`, `serviceContext`, `logProgress?`): `Promise`<[`NodeWithEmbedding`](../interfaces/NodeWithEmbedding.md)[]\> + +Get the embeddings for nodes. + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `nodes` | [`BaseNode`](BaseNode.md)[] | `undefined` | | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | `undefined` | | +| `logProgress` | `boolean` | `false` | log progress to console (useful for debugging) | + +#### Returns + +`Promise`<[`NodeWithEmbedding`](../interfaces/NodeWithEmbedding.md)[]\> + +#### Defined in + +[indices/vectorStore/VectorStoreIndex.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L82) ___ @@ -250,4 +250,4 @@ ___ #### Defined in -[BaseIndex.ts:114](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L114) +[indices/vectorStore/VectorStoreIndex.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L37) diff --git a/apps/docs/docs/api/enums/ListRetrieverMode.md b/apps/docs/docs/api/enums/ListRetrieverMode.md index deb4cc7af1dcfdb3e34e5b3cdf05d133ba4aad7e..60fa8907c9eceee2c4493afb074db5ba84a7b0d7 100644 --- a/apps/docs/docs/api/enums/ListRetrieverMode.md +++ b/apps/docs/docs/api/enums/ListRetrieverMode.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[index/list/ListIndex.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L21) +[indices/list/ListIndex.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/list/ListIndex.ts#L25) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[index/list/ListIndex.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/index/list/ListIndex.ts#L23) +[indices/list/ListIndex.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 a86c4332b37ea0e3d66b442c842f892eade58c7c..9728a001d36263760c1424c54874c5b13005d7a6 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/d73ac8e/packages/core/src/Node.ts#L19) +[Node.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L19) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L20) +[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L20) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L21) +[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L21) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L22) +[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 367146248ea49da0d89ab949881c4a5b4920a0f5..d82bb0fb02631225c4c87c4fd0237bc6d230b45b 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/d73ac8e/packages/core/src/Node.ts#L8) +[Node.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L8) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L6) +[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L6) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L7) +[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L7) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L5) +[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L5) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[Node.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L4) +[Node.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 7a5b1feaca1629520110842dc89be787c5406d30..136a77e71fcc5e4c7103824cb59be0354feeff8f 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/d73ac8e/packages/core/src/Node.ts#L15) +[Node.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L15) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L13) +[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L13) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L14) +[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L14) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[Node.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L12) +[Node.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 a18b930a97ed7aa767a953dab825e95c6ff66613..5e1a377112feb049f20eba1ff429ff63199c5587 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/d73ac8e/packages/core/src/Embedding.ts#L10) +[Embedding.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Embedding.ts#L10) ___ @@ -27,7 +27,7 @@ ___ #### Defined in -[Embedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L11) +[Embedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Embedding.ts#L11) ___ @@ -37,4 +37,4 @@ ___ #### Defined in -[Embedding.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L12) +[Embedding.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Embedding.ts#L12) diff --git a/apps/docs/docs/api/index.md b/apps/docs/docs/api/index.md index 871c2f819d8df4447e2a19f9b9f7422058d3310c..3b39b6eb26309bb4f8c869df779764eb36359514 100644 --- a/apps/docs/docs/api/index.md +++ b/apps/docs/docs/api/index.md @@ -75,6 +75,7 @@ npx ts-node example.ts - [ChatEngine](packages/core/src/ChatEngine.ts): A ChatEngine helps you build a chatbot that will interact with your Indexes. +- [SimplePrompt](packages/core/src/Prompt.ts): A simple standardized function call definition that takes in inputs and puts them in a prebuilt template. ## Contributing: diff --git a/apps/docs/docs/api/interfaces/BaseIndexInit.md b/apps/docs/docs/api/interfaces/BaseIndexInit.md index 628a39a0b52880fef2b386db1c93226d3cef2f3d..ca4a3ad6c2578a84653b8379ffe489fc0e10964f 100644 --- a/apps/docs/docs/api/interfaces/BaseIndexInit.md +++ b/apps/docs/docs/api/interfaces/BaseIndexInit.md @@ -12,6 +12,12 @@ custom_edit_url: null | :------ | | `T` | +## Hierarchy + +- **`BaseIndexInit`** + + ↳ [`VectorIndexConstructorProps`](VectorIndexConstructorProps.md) + ## Properties ### docStore @@ -20,7 +26,7 @@ custom_edit_url: null #### Defined in -[BaseIndex.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L62) +[indices/BaseIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L58) ___ @@ -30,7 +36,7 @@ ___ #### Defined in -[BaseIndex.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L64) +[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L60) ___ @@ -40,7 +46,7 @@ ___ #### Defined in -[BaseIndex.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L65) +[indices/BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L61) ___ @@ -50,7 +56,7 @@ ___ #### Defined in -[BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L60) +[indices/BaseIndex.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L56) ___ @@ -60,7 +66,7 @@ ___ #### Defined in -[BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L61) +[indices/BaseIndex.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L57) ___ @@ -70,4 +76,4 @@ ___ #### Defined in -[BaseIndex.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L63) +[indices/BaseIndex.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L59) diff --git a/apps/docs/docs/api/interfaces/BaseLLMPredictor.md b/apps/docs/docs/api/interfaces/BaseLLMPredictor.md index 90e6a87177f8941d0e38d34cab0b9c8da8ecbeeb..d511db2a81cad6bba62a5fe5941e176aa3b8c589 100644 --- a/apps/docs/docs/api/interfaces/BaseLLMPredictor.md +++ b/apps/docs/docs/api/interfaces/BaseLLMPredictor.md @@ -14,36 +14,36 @@ LLM Predictors are an abstraction to predict the response to a prompt. ## Methods -### apredict - -▸ **apredict**(`prompt`, `input?`, `parentEvent?`): `Promise`<`string`\> - -#### Parameters +### getLlmMetadata -| Name | Type | -| :------ | :------ | -| `prompt` | `string` \| [`SimplePrompt`](../modules.md#simpleprompt) | -| `input?` | `Record`<`string`, `string`\> | -| `parentEvent?` | [`Event`](Event.md) | +▸ **getLlmMetadata**(): `Promise`<`any`\> #### Returns -`Promise`<`string`\> +`Promise`<`any`\> #### Defined in -[LLMPredictor.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L10) +[LLMPredictor.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L9) ___ -### getLlmMetadata +### predict -▸ **getLlmMetadata**(): `Promise`<`any`\> +▸ **predict**(`prompt`, `input?`, `parentEvent?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `prompt` | `string` \| [`SimplePrompt`](../modules.md#simpleprompt) | +| `input?` | `Record`<`string`, `string`\> | +| `parentEvent?` | [`Event`](Event.md) | #### Returns -`Promise`<`any`\> +`Promise`<`string`\> #### Defined in -[LLMPredictor.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLMPredictor.ts#L9) +[LLMPredictor.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L10) diff --git a/apps/docs/docs/api/interfaces/BaseOutputParser.md b/apps/docs/docs/api/interfaces/BaseOutputParser.md index 53b7cf0303adca6b9da603ffa3896d5f31d49b25..f712679ca143a9401dc3b91790124e883c45e485 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/d73ac8e/packages/core/src/OutputParser.ts#L8) +[OutputParser.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/OutputParser.ts#L8) ___ @@ -56,4 +56,4 @@ ___ #### Defined in -[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/OutputParser.ts#L7) +[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 20ecde3e27973fbca23e4ea082acbb6cba9dd458..250bf22b462d1e5872673fe22165bdd9c6c95725 100644 --- a/apps/docs/docs/api/interfaces/BaseQueryEngine.md +++ b/apps/docs/docs/api/interfaces/BaseQueryEngine.md @@ -15,9 +15,11 @@ A query engine is a question answerer that can use one or more steps. ## Methods -### aquery +### query -▸ **aquery**(`query`, `parentEvent?`): `Promise`<[`Response`](../classes/Response.md)\> +▸ **query**(`query`, `parentEvent?`): `Promise`<[`Response`](../classes/Response.md)\> + +Query the query engine and get a response. #### Parameters @@ -32,4 +34,4 @@ A query engine is a question answerer that can use one or more steps. #### Defined in -[QueryEngine.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QueryEngine.ts#L19) +[QueryEngine.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 518a9f86528a5ccb632776be8ac7d0c20f546061..29d0203449c6fd3a84891e2dd60d3532c2ce515d 100644 --- a/apps/docs/docs/api/interfaces/BaseQuestionGenerator.md +++ b/apps/docs/docs/api/interfaces/BaseQuestionGenerator.md @@ -14,9 +14,9 @@ QuestionGenerators generate new questions for the LLM using tools and a user que ## Methods -### agenerate +### generate -▸ **agenerate**(`tools`, `query`): `Promise`<[`SubQuestion`](SubQuestion.md)[]\> +▸ **generate**(`tools`, `query`): `Promise`<[`SubQuestion`](SubQuestion.md)[]\> #### Parameters @@ -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/d73ac8e/packages/core/src/QuestionGenerator.ts#L23) +[QuestionGenerator.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 49f7d7220688d7107ba49e153d9035ffeef71331..8d3a15ee336bc77aa175ab97bf637866bdcd4ed3 100644 --- a/apps/docs/docs/api/interfaces/BaseReader.md +++ b/apps/docs/docs/api/interfaces/BaseReader.md @@ -30,4 +30,4 @@ A reader takes imports data into Document objects. #### Defined in -[readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/readers/base.ts#L7) +[readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 514ef4302d3e53409600052c65f1efdfe4f45eb5..7e312b83e39296a7ae74153432d1df406c3dbf71 100644 --- a/apps/docs/docs/api/interfaces/BaseRetriever.md +++ b/apps/docs/docs/api/interfaces/BaseRetriever.md @@ -16,35 +16,35 @@ Retrievers retrieve the nodes that most closely match our query in similarity. ## Methods -### aretrieve - -▸ **aretrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](NodeWithScore.md)[]\> - -#### Parameters +### getServiceContext -| Name | Type | -| :------ | :------ | -| `query` | `string` | -| `parentEvent?` | [`Event`](Event.md) | +▸ **getServiceContext**(): [`ServiceContext`](ServiceContext.md) #### Returns -`Promise`<[`NodeWithScore`](NodeWithScore.md)[]\> +[`ServiceContext`](ServiceContext.md) #### Defined in -[Retriever.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L16) +[Retriever.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Retriever.ts#L10) ___ -### getServiceContext +### retrieve -▸ **getServiceContext**(): [`ServiceContext`](ServiceContext.md) +▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](NodeWithScore.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `string` | +| `parentEvent?` | [`Event`](Event.md) | #### Returns -[`ServiceContext`](ServiceContext.md) +`Promise`<[`NodeWithScore`](NodeWithScore.md)[]\> #### Defined in -[Retriever.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Retriever.ts#L17) +[Retriever.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 8ec07d6447ea1311d516b5535bbe7b1c1664305f..0ca41789bae789b7baf0d5dd8164941dc8775679 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/d73ac8e/packages/core/src/Tool.ts#L12) +[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 852b26433108074f6d5fa55df9cd6d402619e936..5116afb0ac96c7da7515bc79c9f2077360e5069b 100644 --- a/apps/docs/docs/api/interfaces/ChatEngine.md +++ b/apps/docs/docs/api/interfaces/ChatEngine.md @@ -16,9 +16,9 @@ A ChatEngine is used to handle back and forth chats between the application and ## Methods -### achat +### chat -▸ **achat**(`message`, `chatHistory?`): `Promise`<[`Response`](../classes/Response.md)\> +▸ **chat**(`message`, `chatHistory?`): `Promise`<[`Response`](../classes/Response.md)\> Send message along with the class's current chat history to the LLM. @@ -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/d73ac8e/packages/core/src/ChatEngine.ts#L25) +[ChatEngine.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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/d73ac8e/packages/core/src/ChatEngine.ts#L30) +[ChatEngine.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 90aa08bd71916e0fb0dbb128f338491a98b3ac93..a1e2ab4dc5a3bac1d3ea6fe0a3b276468da7efa2 100644 --- a/apps/docs/docs/api/interfaces/ChatMessage.md +++ b/apps/docs/docs/api/interfaces/ChatMessage.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[LLM.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L14) +[LLM.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L14) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[LLM.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L15) +[LLM.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L15) diff --git a/apps/docs/docs/api/interfaces/ChatResponse.md b/apps/docs/docs/api/interfaces/ChatResponse.md index 8570acf3a838388499eb407c999c39dbf9676710..c3fef6fec00dfb031215130da71f5bb5cc3cd9df 100644 --- a/apps/docs/docs/api/interfaces/ChatResponse.md +++ b/apps/docs/docs/api/interfaces/ChatResponse.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[LLM.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L21) +[LLM.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L21) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[LLM.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L19) +[LLM.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L19) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[LLM.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L20) +[LLM.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L20) diff --git a/apps/docs/docs/api/interfaces/Event.md b/apps/docs/docs/api/interfaces/Event.md index 70fd5414edf3f2af0e8ccdd451828f981e3ac349..f1c7af6b10a7bfa90c5ddd9fe53631e8b85993a1 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/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L14) +[callbacks/CallbackManager.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/callbacks/CallbackManager.ts#L14) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L17) +[callbacks/CallbackManager.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/callbacks/CallbackManager.ts#L17) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L16) +[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/callbacks/CallbackManager.ts#L16) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L15) +[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 8c5113e125746c10606b1655b320ebb658d2d030..b307413b57ab4cfcca286b084f4037c9c97b5b02 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/d73ac8e/packages/core/src/storage/FileSystem.ts#L12) +[storage/FileSystem.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/FileSystem.ts#L12) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L13) +[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/FileSystem.ts#L13) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L11) +[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/FileSystem.ts#L11) ___ @@ -97,4 +97,4 @@ ___ #### Defined in -[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L10) +[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 7f94040f5bebe06decadb34e855d7a08ee4a72e7..855f0728777a5c8ec8fa340f1fd8415b67dad272 100644 --- a/apps/docs/docs/api/interfaces/LLM.md +++ b/apps/docs/docs/api/interfaces/LLM.md @@ -14,9 +14,9 @@ Unified language model interface ## Methods -### achat +### chat -▸ **achat**(`messages`): `Promise`<[`ChatResponse`](ChatResponse.md)\> +▸ **chat**(`messages`): `Promise`<[`ChatResponse`](ChatResponse.md)\> Get a chat response from the LLM @@ -32,13 +32,13 @@ Get a chat response from the LLM #### Defined in -[LLM.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L35) +[LLM.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L35) ___ -### acomplete +### complete -▸ **acomplete**(`prompt`): `Promise`<[`ChatResponse`](ChatResponse.md)\> +▸ **complete**(`prompt`): `Promise`<[`ChatResponse`](ChatResponse.md)\> Get a prompt completion from the LLM @@ -54,4 +54,4 @@ Get a prompt completion from the LLM #### Defined in -[LLM.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L41) +[LLM.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L41) diff --git a/apps/docs/docs/api/interfaces/NodeParser.md b/apps/docs/docs/api/interfaces/NodeParser.md index 4434714b0238302a3bd88143272a13eec715622b..a26af2f9d4b39d55720b95da69275380521e1d0e 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/d73ac8e/packages/core/src/NodeParser.ts#L53) +[NodeParser.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 a2573c3b7c74bf9dc600ae3f5fdabb9d812a724f..f2fccee3c6e8cc3562b80656be31980f02008173 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/d73ac8e/packages/core/src/Node.ts#L247) +[Node.ts:247](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L247) ___ @@ -26,4 +26,4 @@ ___ #### Defined in -[Node.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L246) +[Node.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 9a618b0cd45f699986849bb05b4d02c08af9f8db..fa63ce659a942ddaac6a50fb872b951b7c67a08c 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/d73ac8e/packages/core/src/Node.ts#L238) +[Node.ts:238](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L238) ___ @@ -26,4 +26,4 @@ ___ #### Defined in -[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L239) +[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 0582d42c54d07b2e3c0e30204d3169b5d6571e41..a5f81f41cf6b8dfe5c501c8c5c38e6205daaea0b 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/d73ac8e/packages/core/src/Tool.ts#L12) +[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Tool.ts#L12) ___ @@ -36,4 +36,4 @@ ___ #### Defined in -[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Tool.ts#L19) +[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 2393bbdb3b31f75c2999ec4b262b47e8fa3aad1d..c3076d433e55127d378b836a0e2306c9f51f045f 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/d73ac8e/packages/core/src/Node.ts#L29) +[Node.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L29) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L28) +[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L28) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L26) +[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L26) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L27) +[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 d603e5a3ac9dffa762c3dc9d1b7372d52d57d733..d9d72d08ddc17cf754aff222abd21afccde8e997 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/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L21) +[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/callbacks/CallbackManager.ts#L21) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L47) +[callbacks/CallbackManager.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/callbacks/CallbackManager.ts#L47) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L46) +[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 1eb18bc6590a73dc2641872fad70c87bbed11b2f..8a45c79a370a2fe226db10bb9a15ab1363500451 100644 --- a/apps/docs/docs/api/interfaces/ServiceContext.md +++ b/apps/docs/docs/api/interfaces/ServiceContext.md @@ -16,7 +16,7 @@ The ServiceContext is a collection of components that are used in different part #### Defined in -[ServiceContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L16) +[ServiceContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ServiceContext.ts#L16) ___ @@ -26,7 +26,7 @@ ___ #### Defined in -[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L14) +[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ServiceContext.ts#L14) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L12) +[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ServiceContext.ts#L12) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L15) +[ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ServiceContext.ts#L15) ___ @@ -56,4 +56,4 @@ ___ #### Defined in -[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L13) +[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ServiceContext.ts#L13) diff --git a/apps/docs/docs/api/interfaces/ServiceContextOptions.md b/apps/docs/docs/api/interfaces/ServiceContextOptions.md index 179a3229ecbf1d81f0e4ab44f7295ef3a3d1067b..87ba793c9fdfe43f28c923a8bef9811388a590fe 100644 --- a/apps/docs/docs/api/interfaces/ServiceContextOptions.md +++ b/apps/docs/docs/api/interfaces/ServiceContextOptions.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L26) +[ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ServiceContext.ts#L26) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[ServiceContext.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L29) +[ServiceContext.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ServiceContext.ts#L29) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[ServiceContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L28) +[ServiceContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ServiceContext.ts#L28) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L24) +[ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ServiceContext.ts#L24) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L22) +[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ServiceContext.ts#L22) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L21) +[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ServiceContext.ts#L21) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[ServiceContext.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L25) +[ServiceContext.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ServiceContext.ts#L25) ___ @@ -84,4 +84,4 @@ ___ #### Defined in -[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L23) +[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ServiceContext.ts#L23) diff --git a/apps/docs/docs/api/interfaces/StorageContext.md b/apps/docs/docs/api/interfaces/StorageContext.md index ba2774a4f4ed7b4a343768c00cc583e67406b22d..3a27f3d468ba0b6cb47a9550abfe1f47fb061b9f 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/d73ac8e/packages/core/src/storage/StorageContext.ts#L15) +[storage/StorageContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/StorageContext.ts#L15) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/StorageContext.ts#L16) +[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/StorageContext.ts#L16) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/StorageContext.ts#L17) +[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 d99c1c3fe90c6454d611421f5676a02f21039fa5..577705b39000807cd5c0c11de2e0acef0da10855 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/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L21) +[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/callbacks/CallbackManager.ts#L21) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L40) +[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/callbacks/CallbackManager.ts#L40) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L41) +[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/callbacks/CallbackManager.ts#L41) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L42) +[callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 0bf3aded9dda2dc886ad8a671e3a39bff9e9641a..1f894481e2499153a0d4b40f2866919a30a69464 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/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L29) +[callbacks/CallbackManager.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/callbacks/CallbackManager.ts#L29) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L27) +[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/callbacks/CallbackManager.ts#L27) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L25) +[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/callbacks/CallbackManager.ts#L25) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L28) +[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/callbacks/CallbackManager.ts#L28) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L26) +[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 57a4d6179f2f06cc060148ef5efa08ab4da228b8..f8920b5d12953fce4bf7ac66b882b771e360e7b3 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/d73ac8e/packages/core/src/OutputParser.ts#L16) +[OutputParser.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/OutputParser.ts#L16) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/OutputParser.ts#L15) +[OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 6e18cb9f57ea7296aa8323f92b85dfc20f472ff7..9203480313a3aedcbfecf5160ec8e66dd988fba5 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/d73ac8e/packages/core/src/QuestionGenerator.ts#L15) +[QuestionGenerator.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/QuestionGenerator.ts#L15) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/QuestionGenerator.ts#L16) +[QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/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 f29208437e4ba9f9e789252fa4239413a58b4371..a3b2f80118bf2b491b894abb0d852b4de43256f3 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/d73ac8e/packages/core/src/Tool.ts#L4) +[Tool.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Tool.ts#L4) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Tool.ts#L5) +[Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Tool.ts#L5) diff --git a/apps/docs/docs/api/interfaces/VectorIndexConstructorProps.md b/apps/docs/docs/api/interfaces/VectorIndexConstructorProps.md new file mode 100644 index 0000000000000000000000000000000000000000..c760b1979a8f87d1e042025bdbdb2d7dce8dc733 --- /dev/null +++ b/apps/docs/docs/api/interfaces/VectorIndexConstructorProps.md @@ -0,0 +1,97 @@ +--- +id: "VectorIndexConstructorProps" +title: "Interface: VectorIndexConstructorProps" +sidebar_label: "VectorIndexConstructorProps" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- [`BaseIndexInit`](BaseIndexInit.md)<[`IndexDict`](../classes/IndexDict.md)\> + + ↳ **`VectorIndexConstructorProps`** + +## Properties + +### docStore + +• **docStore**: `BaseDocumentStore` + +#### Inherited from + +[BaseIndexInit](BaseIndexInit.md).[docStore](BaseIndexInit.md#docstore) + +#### Defined in + +[indices/BaseIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L58) + +___ + +### indexStore + +• `Optional` **indexStore**: `BaseIndexStore` + +#### Inherited from + +[BaseIndexInit](BaseIndexInit.md).[indexStore](BaseIndexInit.md#indexstore) + +#### Defined in + +[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L60) + +___ + +### indexStruct + +• **indexStruct**: [`IndexDict`](../classes/IndexDict.md) + +#### Inherited from + +[BaseIndexInit](BaseIndexInit.md).[indexStruct](BaseIndexInit.md#indexstruct) + +#### Defined in + +[indices/BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L61) + +___ + +### serviceContext + +• **serviceContext**: [`ServiceContext`](ServiceContext.md) + +#### Inherited from + +[BaseIndexInit](BaseIndexInit.md).[serviceContext](BaseIndexInit.md#servicecontext) + +#### Defined in + +[indices/BaseIndex.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L56) + +___ + +### storageContext + +• **storageContext**: [`StorageContext`](StorageContext.md) + +#### Inherited from + +[BaseIndexInit](BaseIndexInit.md).[storageContext](BaseIndexInit.md#storagecontext) + +#### Defined in + +[indices/BaseIndex.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L57) + +___ + +### vectorStore + +• **vectorStore**: `VectorStore` + +#### Overrides + +[BaseIndexInit](BaseIndexInit.md).[vectorStore](BaseIndexInit.md#vectorstore) + +#### Defined in + +[indices/BaseIndex.ts:96](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L96) diff --git a/apps/docs/docs/api/interfaces/VectorIndexOptions.md b/apps/docs/docs/api/interfaces/VectorIndexOptions.md index 666b55092576502f2fb351ff8abf1b11a30f209d..596d67dd9fc7411b43e01845a36289909c487770 100644 --- a/apps/docs/docs/api/interfaces/VectorIndexOptions.md +++ b/apps/docs/docs/api/interfaces/VectorIndexOptions.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[BaseIndex.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L94) +[indices/BaseIndex.ts:90](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L90) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[BaseIndex.ts:93](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L93) +[indices/BaseIndex.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L89) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[BaseIndex.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L95) +[indices/BaseIndex.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L91) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[BaseIndex.ts:96](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/BaseIndex.ts#L96) +[indices/BaseIndex.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/indices/BaseIndex.ts#L92) diff --git a/apps/docs/docs/api/interfaces/WalkableFileSystem.md b/apps/docs/docs/api/interfaces/WalkableFileSystem.md index 28dc7451085242b1f3cc9476d5308b4017ba5407..b4bd7ba8ad7988fccc0d4f520dfe46113985f985 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/d73ac8e/packages/core/src/storage/FileSystem.ts#L17) +[storage/FileSystem.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/FileSystem.ts#L17) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L18) +[storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/FileSystem.ts#L18) diff --git a/apps/docs/docs/api/modules.md b/apps/docs/docs/api/modules.md index 7fd00351a1e6c4065e362e9f8380ac958dbc1f03..1a5a5d5684b800aaea104f1ccb434b608e3f28fe 100644 --- a/apps/docs/docs/api/modules.md +++ b/apps/docs/docs/api/modules.md @@ -82,6 +82,7 @@ custom_edit_url: null - [StructuredOutput](interfaces/StructuredOutput.md) - [SubQuestion](interfaces/SubQuestion.md) - [ToolMetadata](interfaces/ToolMetadata.md) +- [VectorIndexConstructorProps](interfaces/VectorIndexConstructorProps.md) - [VectorIndexOptions](interfaces/VectorIndexOptions.md) - [WalkableFileSystem](interfaces/WalkableFileSystem.md) @@ -93,7 +94,7 @@ custom_edit_url: null #### Defined in -[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L49) +[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/FileSystem.ts#L49) ___ @@ -103,7 +104,7 @@ ___ #### Defined in -[LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L25) +[LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L25) ___ @@ -113,7 +114,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L11) +[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/callbacks/CallbackManager.ts#L11) ___ @@ -123,7 +124,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/callbacks/CallbackManager.ts#L12) +[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/callbacks/CallbackManager.ts#L12) ___ @@ -133,7 +134,7 @@ ___ #### Defined in -[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Node.ts#L32) +[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Node.ts#L32) ___ @@ -152,7 +153,7 @@ ___ #### Defined in -[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/readers/SimpleDirectoryReader.ts#L26) +[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/readers/SimpleDirectoryReader.ts#L26) ___ @@ -180,7 +181,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/d73ac8e/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Prompt.ts#L10) ## Variables @@ -201,7 +202,7 @@ We currently support GPT-3.5 and GPT-4 models #### Defined in -[LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L57) +[LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L57) ___ @@ -211,7 +212,7 @@ ___ #### Defined in -[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L5) +[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/constants.ts#L5) ___ @@ -221,7 +222,7 @@ ___ #### Defined in -[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L6) +[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/constants.ts#L6) ___ @@ -231,7 +232,7 @@ ___ #### Defined in -[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L4) +[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/constants.ts#L4) ___ @@ -241,7 +242,7 @@ ___ #### Defined in -[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/constants.ts#L1) +[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/constants.ts#L1) ___ @@ -251,7 +252,7 @@ ___ #### Defined in -[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L1) +[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/constants.ts#L1) ___ @@ -261,7 +262,7 @@ ___ #### Defined in -[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/constants.ts#L4) +[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/constants.ts#L4) ___ @@ -271,7 +272,7 @@ ___ #### Defined in -[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L10) +[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/constants.ts#L10) ___ @@ -281,7 +282,7 @@ ___ #### Defined in -[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L62) +[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/FileSystem.ts#L62) ___ @@ -291,7 +292,7 @@ ___ #### Defined in -[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/constants.ts#L6) +[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/constants.ts#L6) ___ @@ -301,7 +302,7 @@ ___ #### Defined in -[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/constants.ts#L3) +[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/constants.ts#L3) ___ @@ -311,7 +312,7 @@ ___ #### Defined in -[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/constants.ts#L7) +[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/constants.ts#L7) ___ @@ -321,7 +322,7 @@ ___ #### Defined in -[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L2) +[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/constants.ts#L2) ___ @@ -331,7 +332,7 @@ ___ #### Defined in -[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L11) +[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/constants.ts#L11) ___ @@ -341,7 +342,7 @@ ___ #### Defined in -[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/constants.ts#L2) +[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/constants.ts#L2) ___ @@ -351,7 +352,7 @@ ___ #### Defined in -[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/constants.ts#L7) +[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/constants.ts#L7) ___ @@ -361,7 +362,7 @@ ___ #### Defined in -[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/constants.ts#L5) +[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/constants.ts#L5) ___ @@ -378,7 +379,7 @@ ___ #### Defined in -[LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L44) +[LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L44) ___ @@ -395,7 +396,7 @@ ___ #### Defined in -[LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/LLM.ts#L49) +[LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLM.ts#L49) ___ @@ -405,7 +406,7 @@ ___ #### Defined in -[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/GlobalsHelper.ts#L42) +[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/GlobalsHelper.ts#L42) ## Functions @@ -425,7 +426,7 @@ ___ #### Defined in -[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Prompt.ts#L198) +[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Prompt.ts#L198) ___ @@ -449,7 +450,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/d73ac8e/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Prompt.ts#L10) ___ @@ -473,7 +474,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/d73ac8e/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Prompt.ts#L10) ___ @@ -497,7 +498,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/d73ac8e/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Prompt.ts#L10) ___ @@ -521,7 +522,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/d73ac8e/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Prompt.ts#L10) ___ @@ -545,7 +546,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/d73ac8e/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Prompt.ts#L10) ___ @@ -569,7 +570,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/d73ac8e/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Prompt.ts#L10) ___ @@ -593,7 +594,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/d73ac8e/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Prompt.ts#L10) ___ @@ -619,7 +620,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/d73ac8e/packages/core/src/storage/FileSystem.ts#L74) +[storage/FileSystem.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/FileSystem.ts#L74) ___ @@ -633,7 +634,7 @@ ___ #### Defined in -[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/FileSystem.ts#L51) +[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/FileSystem.ts#L51) ___ @@ -656,27 +657,28 @@ ___ #### Defined in -[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/NodeParser.ts#L15) +[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/NodeParser.ts#L15) ___ ### getResponseBuilder -▸ **getResponseBuilder**(`serviceContext?`): [`SimpleResponseBuilder`](classes/SimpleResponseBuilder.md) +▸ **getResponseBuilder**(`serviceContext`, `responseMode?`): `BaseResponseBuilder` #### Parameters | Name | Type | | :------ | :------ | -| `serviceContext?` | [`ServiceContext`](interfaces/ServiceContext.md) | +| `serviceContext` | [`ServiceContext`](interfaces/ServiceContext.md) | +| `responseMode?` | `ResponseMode` | #### Returns -[`SimpleResponseBuilder`](classes/SimpleResponseBuilder.md) +`BaseResponseBuilder` #### Defined in -[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ResponseSynthesizer.ts#L212) +[ResponseSynthesizer.ts:256](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ResponseSynthesizer.ts#L256) ___ @@ -697,7 +699,7 @@ ___ #### Defined in -[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/NodeParser.ts#L5) +[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/NodeParser.ts#L5) ___ @@ -723,7 +725,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/d73ac8e/packages/core/src/Embedding.ts#L77) +[Embedding.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Embedding.ts#L77) ___ @@ -747,7 +749,7 @@ ___ #### Defined in -[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L119) +[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Embedding.ts#L119) ___ @@ -773,7 +775,7 @@ ___ #### Defined in -[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Embedding.ts#L131) +[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Embedding.ts#L131) ___ @@ -793,7 +795,7 @@ ___ #### Defined in -[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/Prompt.ts#L300) +[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Prompt.ts#L300) ___ @@ -813,7 +815,7 @@ ___ #### Defined in -[ServiceContext.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L32) +[ServiceContext.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ServiceContext.ts#L32) ___ @@ -842,7 +844,7 @@ ___ #### Defined in -[ServiceContext.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/ServiceContext.ts#L52) +[ServiceContext.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/ServiceContext.ts#L52) ___ @@ -868,7 +870,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/d73ac8e/packages/core/src/Embedding.ts#L22) +[Embedding.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/Embedding.ts#L22) ___ @@ -888,7 +890,7 @@ ___ #### Defined in -[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d73ac8e/packages/core/src/storage/StorageContext.ts#L28) +[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/StorageContext.ts#L28) ___ @@ -911,4 +913,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/d73ac8e/packages/core/src/storage/FileSystem.ts#L91) +[storage/FileSystem.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/storage/FileSystem.ts#L91)