mirror of
https://github.com/run-llama/LlamaIndexTS.git
synced 2026-07-11 00:04:07 -04:00
Compare commits
50 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Yi Ding
|
7d2fe9c69f | ||
|
Yi Ding
|
68bdaaa657 | ||
|
Yi Ding
|
7db9bc0c63 | ||
|
Yi Ding
|
cd8d22b33f | ||
|
Yi Ding
|
802860050f | ||
|
Yi Ding
|
3fda1deece | ||
|
Yi Ding
|
fb7fb760a0 | ||
|
Logan
|
a4d6d7bc7d | ||
|
Yi Ding
|
f7cc69b5ec | ||
|
yisding
|
74b34a3730 | ||
|
Yi Ding
|
fc2a1b527e | ||
|
Logan
|
3e85a90b92 | ||
|
Logan Markewich
|
74ab98ddec | ||
|
Logan
|
bff788b484 | ||
|
Logan Markewich
|
3e1abd2c6c | ||
|
Yi Ding
|
79c76ea9d7 | ||
|
Yi Ding
|
6f2cb31d41 | ||
|
Yi Ding
|
cc88141772 | ||
|
Yi Ding
|
02d9bb0518 | ||
|
Yi Ding
|
5321fb3135 | ||
|
Yi Ding
|
ea5038e4b7 | ||
|
Yi Ding
|
b012207764 | ||
|
Yi Ding
|
9fa6d4a8a7 | ||
|
yisding
|
c77dd18f2d | ||
|
Yi Ding
|
bb7c0d7deb | ||
|
Yi Ding
|
80d3fc9482 | ||
|
Logan Markewich
|
79a721226d | ||
|
Logan Markewich
|
ed36d41024 | ||
|
Logan Markewich
|
9a15c8ece0 | ||
|
Logan Markewich
|
9c5220ce75 | ||
|
Logan Markewich
|
8c67635041 | ||
|
yisding
|
fc7f35141a | ||
|
Logan Markewich
|
fc65e6b97d | ||
|
Yi Ding
|
629bd3239a | ||
|
Yi Ding
|
31c99baf1c | ||
|
Yi Ding
|
b2810777ef | ||
|
Logan
|
805d6fb81d | ||
|
Logan Markewich
|
9c566b0530 | ||
|
Yi Ding
|
daa14b8a5f | ||
|
Yi Ding
|
ed4fe4ac22 | ||
|
Simon Suo
|
b76562061e | ||
|
Simon Suo
|
baa91540cf | ||
|
Simon Suo
|
a594e22d2d | ||
|
Simon Suo
|
91615a6602 | ||
|
Simon Suo
|
43144ae782 | ||
|
Logan
|
e927fc1800 | ||
|
Logan Markewich
|
a08e904834 | ||
|
Logan
|
90429ab63d | ||
|
Logan Markewich
|
abaab0caca | ||
|
Simon Suo
|
bc5c2e5c7b |
@@ -17,7 +17,7 @@ LlamaIndex.TS requries Node v18 or higher. You can download it from https://node
|
||||
In a new folder:
|
||||
|
||||
```bash
|
||||
export OPEN_AI_KEY="sk-......" # Replace with your key from https://platform.openai.com/account/api-keys
|
||||
export OPENAI_API_KEY="sk-......" # Replace with your key from https://platform.openai.com/account/api-keys
|
||||
pnpm init
|
||||
pnpm install typescript
|
||||
pnpm exec tsc –-init # if needed
|
||||
@@ -80,6 +80,10 @@ pnpm dlx ts-node example.ts
|
||||
|
||||
- [SimplePrompt](packages/core/src/Prompt.ts): A simple standardized function call definition that takes in inputs and formats them in a template literal. SimplePrompts can be specialized using currying and combined using other SimplePrompt functions.
|
||||
|
||||
## Playground
|
||||
|
||||
Check out our NextJS playground at https://llama-playground.vercel.app/. The source is available at https://github.com/run-llama/ts-playground
|
||||
|
||||
## Contributing:
|
||||
|
||||
We are in the very early days of LlamaIndex.TS. If you’re interested in hacking on it with us check out our [contributing guide](CONTRIBUTING.md)
|
||||
|
||||
@@ -36,7 +36,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:206](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L206)
|
||||
[Embedding.ts:206](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L206)
|
||||
|
||||
___
|
||||
|
||||
@@ -56,7 +56,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L205)
|
||||
[Embedding.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L205)
|
||||
|
||||
___
|
||||
|
||||
@@ -78,4 +78,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L197)
|
||||
[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L197)
|
||||
|
||||
@@ -43,7 +43,7 @@ they can be retrieved for our queries.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L78)
|
||||
[indices/BaseIndex.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L104)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -53,7 +53,7 @@ they can be retrieved for our queries.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L73)
|
||||
[indices/BaseIndex.ts:99](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L99)
|
||||
|
||||
___
|
||||
|
||||
@@ -63,7 +63,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L75)
|
||||
[indices/BaseIndex.ts:101](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L101)
|
||||
|
||||
___
|
||||
|
||||
@@ -73,7 +73,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L76)
|
||||
[indices/BaseIndex.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L102)
|
||||
|
||||
___
|
||||
|
||||
@@ -83,7 +83,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L71)
|
||||
[indices/BaseIndex.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L97)
|
||||
|
||||
___
|
||||
|
||||
@@ -93,7 +93,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L72)
|
||||
[indices/BaseIndex.ts:98](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L98)
|
||||
|
||||
___
|
||||
|
||||
@@ -103,7 +103,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L74)
|
||||
[indices/BaseIndex.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L100)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -128,7 +128,7 @@ and response synthezier if they are not provided.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:98](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L98)
|
||||
[indices/BaseIndex.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L124)
|
||||
|
||||
___
|
||||
|
||||
@@ -150,4 +150,4 @@ Create a new retriever from the index.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L91)
|
||||
[indices/BaseIndex.ts:117](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L117)
|
||||
|
||||
@@ -28,7 +28,7 @@ Generic abstract class for retrievable nodes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L48)
|
||||
[Node.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L48)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ Generic abstract class for retrievable nodes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L39)
|
||||
[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
@@ -48,7 +48,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L43)
|
||||
[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
@@ -58,7 +58,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L44)
|
||||
[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -68,7 +68,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L46)
|
||||
[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -78,7 +78,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L38)
|
||||
[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L42)
|
||||
[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,7 +98,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L45)
|
||||
[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L45)
|
||||
|
||||
## Accessors
|
||||
|
||||
@@ -112,7 +112,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L104)
|
||||
[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L104)
|
||||
|
||||
___
|
||||
|
||||
@@ -126,7 +126,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L84)
|
||||
[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L84)
|
||||
|
||||
___
|
||||
|
||||
@@ -140,7 +140,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L58)
|
||||
[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -154,7 +154,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L94)
|
||||
[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L94)
|
||||
|
||||
___
|
||||
|
||||
@@ -168,7 +168,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L72)
|
||||
[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
@@ -182,7 +182,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L62)
|
||||
[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L62)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -196,7 +196,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L124)
|
||||
[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L124)
|
||||
|
||||
___
|
||||
|
||||
@@ -216,7 +216,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L54)
|
||||
[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
@@ -230,7 +230,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L116)
|
||||
[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L116)
|
||||
|
||||
___
|
||||
|
||||
@@ -250,7 +250,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L55)
|
||||
[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
@@ -264,7 +264,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L52)
|
||||
[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -284,4 +284,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L56)
|
||||
[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L56)
|
||||
|
||||
@@ -24,7 +24,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L68)
|
||||
[callbacks/CallbackManager.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L68)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -52,7 +52,7 @@ CallbackManagerMethods.onLLMStream
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L65)
|
||||
[callbacks/CallbackManager.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,4 +80,4 @@ CallbackManagerMethods.onRetrieve
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L66)
|
||||
[callbacks/CallbackManager.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L66)
|
||||
|
||||
@@ -34,7 +34,7 @@ CompactAndRefine is a slight variation of Refine that first compacts the text ch
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L78)
|
||||
[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L78)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -48,7 +48,7 @@ CompactAndRefine is a slight variation of Refine that first compacts the text ch
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L76)
|
||||
[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L76)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L74)
|
||||
[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L74)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L75)
|
||||
[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L75)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -103,4 +103,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L181)
|
||||
[ResponseSynthesizer.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L181)
|
||||
|
||||
@@ -37,7 +37,7 @@ data, or are very referential to previous context.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L75)
|
||||
[ChatEngine.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L75)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -47,7 +47,7 @@ data, or are very referential to previous context.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L71)
|
||||
[ChatEngine.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
@@ -57,7 +57,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L73)
|
||||
[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L73)
|
||||
|
||||
___
|
||||
|
||||
@@ -67,7 +67,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L70)
|
||||
[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L70)
|
||||
|
||||
___
|
||||
|
||||
@@ -77,7 +77,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L72)
|
||||
[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L72)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -104,7 +104,7 @@ Send message along with the class's current chat history to the LLM.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L100)
|
||||
[ChatEngine.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L100)
|
||||
|
||||
___
|
||||
|
||||
@@ -125,7 +125,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L89)
|
||||
[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L89)
|
||||
|
||||
___
|
||||
|
||||
@@ -145,4 +145,4 @@ Resets the chat history so that it's empty.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L118)
|
||||
[ChatEngine.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L118)
|
||||
|
||||
@@ -31,7 +31,7 @@ ideally allowing the appropriate context to be surfaced for each query.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L133)
|
||||
[ChatEngine.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L133)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -41,7 +41,7 @@ ideally allowing the appropriate context to be surfaced for each query.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L131)
|
||||
[ChatEngine.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L131)
|
||||
|
||||
___
|
||||
|
||||
@@ -51,7 +51,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L130)
|
||||
[ChatEngine.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L130)
|
||||
|
||||
___
|
||||
|
||||
@@ -61,7 +61,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L129)
|
||||
[ChatEngine.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L129)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -88,7 +88,7 @@ Send message along with the class's current chat history to the LLM.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L144)
|
||||
[ChatEngine.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L144)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ Resets the chat history so that it's empty.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:182](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L182)
|
||||
[ChatEngine.ts:182](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L182)
|
||||
|
||||
@@ -32,7 +32,7 @@ A document is just a special text node with a docId.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L216)
|
||||
[Node.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L216)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -46,7 +46,7 @@ A document is just a special text node with a docId.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L39)
|
||||
[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
@@ -60,7 +60,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L139)
|
||||
[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L139)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L43)
|
||||
[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L44)
|
||||
[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -102,7 +102,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L46)
|
||||
[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +116,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L38)
|
||||
[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -130,7 +130,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L42)
|
||||
[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -144,7 +144,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L142)
|
||||
[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L142)
|
||||
|
||||
___
|
||||
|
||||
@@ -158,7 +158,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L45)
|
||||
[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -172,7 +172,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L138)
|
||||
[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L138)
|
||||
|
||||
___
|
||||
|
||||
@@ -186,7 +186,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L137)
|
||||
[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L137)
|
||||
|
||||
## Accessors
|
||||
|
||||
@@ -204,7 +204,7 @@ TextNode.childNodes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L104)
|
||||
[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L104)
|
||||
|
||||
___
|
||||
|
||||
@@ -218,7 +218,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L225)
|
||||
[Node.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L225)
|
||||
|
||||
___
|
||||
|
||||
@@ -236,7 +236,7 @@ TextNode.nextNode
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L84)
|
||||
[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L84)
|
||||
|
||||
___
|
||||
|
||||
@@ -254,7 +254,7 @@ TextNode.nodeId
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L58)
|
||||
[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -272,7 +272,7 @@ TextNode.parentNode
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L94)
|
||||
[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L94)
|
||||
|
||||
___
|
||||
|
||||
@@ -290,7 +290,7 @@ TextNode.prevNode
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L72)
|
||||
[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
@@ -308,7 +308,7 @@ TextNode.sourceNode
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L62)
|
||||
[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L62)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -326,7 +326,7 @@ TextNode.sourceNode
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L124)
|
||||
[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L124)
|
||||
|
||||
___
|
||||
|
||||
@@ -344,7 +344,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L149)
|
||||
[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L149)
|
||||
|
||||
___
|
||||
|
||||
@@ -368,7 +368,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L157)
|
||||
[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L157)
|
||||
|
||||
___
|
||||
|
||||
@@ -386,7 +386,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L116)
|
||||
[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L116)
|
||||
|
||||
___
|
||||
|
||||
@@ -410,7 +410,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L162)
|
||||
[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L162)
|
||||
|
||||
___
|
||||
|
||||
@@ -433,7 +433,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L187)
|
||||
[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L187)
|
||||
|
||||
___
|
||||
|
||||
@@ -451,7 +451,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L191)
|
||||
[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L191)
|
||||
|
||||
___
|
||||
|
||||
@@ -469,7 +469,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L221)
|
||||
[Node.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L221)
|
||||
|
||||
___
|
||||
|
||||
@@ -493,4 +493,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L183)
|
||||
[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L183)
|
||||
|
||||
@@ -26,7 +26,7 @@ A filesystem implementation that stores files in memory.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L25)
|
||||
[storage/FileSystem.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L25)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -50,7 +50,7 @@ A filesystem implementation that stores files in memory.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L38)
|
||||
[storage/FileSystem.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -75,7 +75,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L44)
|
||||
[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -100,7 +100,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L31)
|
||||
[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
@@ -126,4 +126,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L27)
|
||||
[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L27)
|
||||
|
||||
@@ -33,7 +33,7 @@ The underlying structure of each index.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L19)
|
||||
[indices/BaseIndex.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L20)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -43,7 +43,7 @@ The underlying structure of each index.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L34)
|
||||
[indices/BaseIndex.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -57,7 +57,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L16)
|
||||
[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
@@ -67,7 +67,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L33)
|
||||
[indices/BaseIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -81,7 +81,17 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L17)
|
||||
[indices/BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: `IndexStructType` = `IndexStructType.SIMPLE_DICT`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L43)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -102,7 +112,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L43)
|
||||
[indices/BaseIndex.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -120,4 +130,22 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L36)
|
||||
[indices/BaseIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
### toJson
|
||||
|
||||
▸ **toJson**(): `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`Record`<`string`, `unknown`\>
|
||||
|
||||
#### Overrides
|
||||
|
||||
[IndexStruct](IndexStruct.md).[toJson](IndexStruct.md#tojson)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L57)
|
||||
|
||||
@@ -33,7 +33,7 @@ The underlying structure of each index.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L19)
|
||||
[indices/BaseIndex.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L20)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -47,7 +47,7 @@ The underlying structure of each index.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L16)
|
||||
[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
@@ -57,7 +57,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L50)
|
||||
[indices/BaseIndex.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L67)
|
||||
|
||||
___
|
||||
|
||||
@@ -71,7 +71,17 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L17)
|
||||
[indices/BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: `IndexStructType` = `IndexStructType.LIST`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L68)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -91,7 +101,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L52)
|
||||
[indices/BaseIndex.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L70)
|
||||
|
||||
___
|
||||
|
||||
@@ -109,4 +119,22 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L24)
|
||||
[indices/BaseIndex.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
### toJson
|
||||
|
||||
▸ **toJson**(): `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`Record`<`string`, `unknown`\>
|
||||
|
||||
#### Overrides
|
||||
|
||||
[IndexStruct](IndexStruct.md).[toJson](IndexStruct.md#tojson)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L74)
|
||||
|
||||
@@ -32,7 +32,7 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L144)
|
||||
[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L144)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -46,7 +46,7 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L39)
|
||||
[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
@@ -60,7 +60,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L139)
|
||||
[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L139)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L43)
|
||||
[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L44)
|
||||
[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -102,7 +102,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L46)
|
||||
[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +116,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L38)
|
||||
[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -126,7 +126,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L205)
|
||||
[Node.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L205)
|
||||
|
||||
___
|
||||
|
||||
@@ -140,7 +140,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L42)
|
||||
[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -154,7 +154,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L142)
|
||||
[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L142)
|
||||
|
||||
___
|
||||
|
||||
@@ -168,7 +168,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L45)
|
||||
[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -182,7 +182,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L138)
|
||||
[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L138)
|
||||
|
||||
___
|
||||
|
||||
@@ -196,7 +196,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L137)
|
||||
[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L137)
|
||||
|
||||
## Accessors
|
||||
|
||||
@@ -214,7 +214,7 @@ TextNode.childNodes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L104)
|
||||
[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L104)
|
||||
|
||||
___
|
||||
|
||||
@@ -232,7 +232,7 @@ TextNode.nextNode
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L84)
|
||||
[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L84)
|
||||
|
||||
___
|
||||
|
||||
@@ -250,7 +250,7 @@ TextNode.nodeId
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L58)
|
||||
[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -268,7 +268,7 @@ TextNode.parentNode
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L94)
|
||||
[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L94)
|
||||
|
||||
___
|
||||
|
||||
@@ -286,7 +286,7 @@ TextNode.prevNode
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L72)
|
||||
[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
@@ -304,7 +304,7 @@ TextNode.sourceNode
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L62)
|
||||
[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L62)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -322,7 +322,7 @@ TextNode.sourceNode
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L124)
|
||||
[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L124)
|
||||
|
||||
___
|
||||
|
||||
@@ -340,7 +340,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L149)
|
||||
[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L149)
|
||||
|
||||
___
|
||||
|
||||
@@ -364,7 +364,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L157)
|
||||
[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L157)
|
||||
|
||||
___
|
||||
|
||||
@@ -382,7 +382,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L116)
|
||||
[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L116)
|
||||
|
||||
___
|
||||
|
||||
@@ -406,7 +406,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L162)
|
||||
[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L162)
|
||||
|
||||
___
|
||||
|
||||
@@ -429,7 +429,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L187)
|
||||
[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L187)
|
||||
|
||||
___
|
||||
|
||||
@@ -447,7 +447,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L191)
|
||||
[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L191)
|
||||
|
||||
___
|
||||
|
||||
@@ -465,7 +465,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L207)
|
||||
[Node.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L207)
|
||||
|
||||
___
|
||||
|
||||
@@ -489,4 +489,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L183)
|
||||
[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L183)
|
||||
|
||||
@@ -31,7 +31,7 @@ The underlying structure of each index.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L19)
|
||||
[indices/BaseIndex.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L20)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -41,7 +41,7 @@ The underlying structure of each index.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L16)
|
||||
[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
@@ -51,7 +51,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L17)
|
||||
[indices/BaseIndex.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L18)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -65,4 +65,18 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L24)
|
||||
[indices/BaseIndex.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
### toJson
|
||||
|
||||
▸ **toJson**(): `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L25)
|
||||
|
||||
@@ -26,7 +26,7 @@ LLMQuestionGenerator uses the LLM to generate new questions for the LLM using to
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QuestionGenerator.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QuestionGenerator.ts#L34)
|
||||
[QuestionGenerator.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QuestionGenerator.ts#L34)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -36,7 +36,7 @@ LLMQuestionGenerator uses the LLM to generate new questions for the LLM using to
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QuestionGenerator.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QuestionGenerator.ts#L30)
|
||||
[QuestionGenerator.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QuestionGenerator.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
@@ -46,7 +46,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QuestionGenerator.ts#L32)
|
||||
[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QuestionGenerator.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
@@ -56,7 +56,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QuestionGenerator.ts#L31)
|
||||
[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QuestionGenerator.ts#L31)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -81,4 +81,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QuestionGenerator.ts#L40)
|
||||
[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QuestionGenerator.ts#L40)
|
||||
|
||||
@@ -32,7 +32,7 @@ A ListIndex keeps nodes in a sequential list structure
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L41)
|
||||
[indices/list/ListIndex.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndex.ts#L43)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -46,7 +46,7 @@ A ListIndex keeps nodes in a sequential list structure
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L73)
|
||||
[indices/BaseIndex.ts:99](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L99)
|
||||
|
||||
___
|
||||
|
||||
@@ -60,7 +60,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L75)
|
||||
[indices/BaseIndex.ts:101](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L101)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L76)
|
||||
[indices/BaseIndex.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L102)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L71)
|
||||
[indices/BaseIndex.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L97)
|
||||
|
||||
___
|
||||
|
||||
@@ -102,7 +102,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L72)
|
||||
[indices/BaseIndex.ts:98](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L98)
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +116,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L74)
|
||||
[indices/BaseIndex.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L100)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -136,7 +136,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndex.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L160)
|
||||
[indices/list/ListIndex.ts:193](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndex.ts#L193)
|
||||
|
||||
___
|
||||
|
||||
@@ -156,7 +156,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndex.ts:154](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L154)
|
||||
[indices/list/ListIndex.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndex.ts#L187)
|
||||
|
||||
___
|
||||
|
||||
@@ -185,7 +185,7 @@ and response synthezier if they are not provided.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndex.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L118)
|
||||
[indices/list/ListIndex.ts:151](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndex.ts#L151)
|
||||
|
||||
___
|
||||
|
||||
@@ -212,7 +212,7 @@ Create a new retriever from the index.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndex.ts:105](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L105)
|
||||
[indices/list/ListIndex.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndex.ts#L138)
|
||||
|
||||
___
|
||||
|
||||
@@ -226,7 +226,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndex.ts:166](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L166)
|
||||
[indices/list/ListIndex.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndex.ts#L199)
|
||||
|
||||
___
|
||||
|
||||
@@ -248,20 +248,20 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndex.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L139)
|
||||
[indices/list/ListIndex.ts:172](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndex.ts#L172)
|
||||
|
||||
___
|
||||
|
||||
### fromDocuments
|
||||
|
||||
▸ `Static` **fromDocuments**(`args`): `Promise`<[`ListIndex`](ListIndex.md)\>
|
||||
▸ `Static` **fromDocuments**(`documents`, `args?`): `Promise`<[`ListIndex`](ListIndex.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `documents` | [`Document`](Document.md)[] |
|
||||
| `args` | `Object` |
|
||||
| `args.documents` | [`Document`](Document.md)[] |
|
||||
| `args.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
|
||||
| `args.storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) |
|
||||
|
||||
@@ -271,7 +271,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndex.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L81)
|
||||
[indices/list/ListIndex.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndex.ts#L112)
|
||||
|
||||
___
|
||||
|
||||
@@ -291,4 +291,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L45)
|
||||
[indices/list/ListIndex.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndex.ts#L47)
|
||||
|
||||
@@ -31,7 +31,7 @@ LLM retriever for ListIndex.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L64)
|
||||
[indices/list/ListIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndexRetriever.ts#L64)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -41,7 +41,7 @@ LLM retriever for ListIndex.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L59)
|
||||
[indices/list/ListIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndexRetriever.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
@@ -51,7 +51,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndexRetriever.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L58)
|
||||
[indices/list/ListIndexRetriever.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndexRetriever.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -61,7 +61,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L60)
|
||||
[indices/list/ListIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndexRetriever.ts#L60)
|
||||
|
||||
___
|
||||
|
||||
@@ -71,7 +71,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndexRetriever.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L57)
|
||||
[indices/list/ListIndexRetriever.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndexRetriever.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
@@ -81,7 +81,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L61)
|
||||
[indices/list/ListIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndexRetriever.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
@@ -91,7 +91,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L62)
|
||||
[indices/list/ListIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndexRetriever.ts#L62)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -109,7 +109,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndexRetriever.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L127)
|
||||
[indices/list/ListIndexRetriever.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndexRetriever.ts#L127)
|
||||
|
||||
___
|
||||
|
||||
@@ -134,4 +134,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L81)
|
||||
[indices/list/ListIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndexRetriever.ts#L81)
|
||||
|
||||
@@ -26,7 +26,7 @@ Simple retriever for ListIndex that returns all nodes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L22)
|
||||
[indices/list/ListIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndexRetriever.ts#L22)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -36,7 +36,7 @@ Simple retriever for ListIndex that returns all nodes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L20)
|
||||
[indices/list/ListIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndexRetriever.ts#L20)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -54,7 +54,7 @@ Simple retriever for ListIndex that returns all nodes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndexRetriever.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L48)
|
||||
[indices/list/ListIndexRetriever.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndexRetriever.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -79,4 +79,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L26)
|
||||
[indices/list/ListIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndexRetriever.ts#L26)
|
||||
|
||||
@@ -26,7 +26,7 @@ Llama2 LLM implementation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:179](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L179)
|
||||
[llm/LLM.ts:179](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L179)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -36,7 +36,7 @@ Llama2 LLM implementation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:176](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L176)
|
||||
[llm/LLM.ts:176](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L176)
|
||||
|
||||
___
|
||||
|
||||
@@ -46,7 +46,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:174](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L174)
|
||||
[llm/LLM.ts:174](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L174)
|
||||
|
||||
___
|
||||
|
||||
@@ -56,7 +56,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:177](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L177)
|
||||
[llm/LLM.ts:177](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L177)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L175)
|
||||
[llm/LLM.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L175)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -93,7 +93,7 @@ Get a chat response from the LLM
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L199)
|
||||
[llm/LLM.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L199)
|
||||
|
||||
___
|
||||
|
||||
@@ -120,7 +120,7 @@ Get a prompt completion from the LLM
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L224)
|
||||
[llm/LLM.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L224)
|
||||
|
||||
___
|
||||
|
||||
@@ -140,4 +140,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L186)
|
||||
[llm/LLM.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L186)
|
||||
|
||||
@@ -26,7 +26,7 @@ OpenAI LLM implementation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L75)
|
||||
[llm/LLM.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L75)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -36,7 +36,7 @@ OpenAI LLM implementation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L73)
|
||||
[llm/LLM.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L73)
|
||||
|
||||
___
|
||||
|
||||
@@ -46,7 +46,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L71)
|
||||
[llm/LLM.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
@@ -56,7 +56,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L69)
|
||||
[llm/LLM.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L66)
|
||||
[llm/LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L66)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L68)
|
||||
[llm/LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L68)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +86,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L72)
|
||||
[llm/LLM.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L70)
|
||||
[llm/LLM.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L70)
|
||||
|
||||
___
|
||||
|
||||
@@ -106,7 +106,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L67)
|
||||
[llm/LLM.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L67)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -133,7 +133,7 @@ Get a chat response from the LLM
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L102)
|
||||
[llm/LLM.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L102)
|
||||
|
||||
___
|
||||
|
||||
@@ -160,7 +160,7 @@ Get a prompt completion from the LLM
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L144)
|
||||
[llm/LLM.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L144)
|
||||
|
||||
___
|
||||
|
||||
@@ -180,4 +180,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L85)
|
||||
[llm/LLM.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L85)
|
||||
|
||||
@@ -24,7 +24,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:217](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L217)
|
||||
[Embedding.ts:217](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L217)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -34,7 +34,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:215](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L215)
|
||||
[Embedding.ts:215](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L215)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +44,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L214)
|
||||
[Embedding.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L214)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L224)
|
||||
[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L224)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L240)
|
||||
[Embedding.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L240)
|
||||
|
||||
___
|
||||
|
||||
@@ -112,7 +112,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L236)
|
||||
[Embedding.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L236)
|
||||
|
||||
___
|
||||
|
||||
@@ -138,4 +138,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L197)
|
||||
[Embedding.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L197)
|
||||
|
||||
@@ -41,4 +41,4 @@ Read the text of a PDF
|
||||
|
||||
#### Defined in
|
||||
|
||||
[readers/PDFReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/readers/PDFReader.ts#L12)
|
||||
[readers/PDFReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/readers/PDFReader.ts#L12)
|
||||
|
||||
@@ -34,7 +34,7 @@ A response builder that uses the query to ask the LLM generate a better response
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L78)
|
||||
[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L78)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -44,7 +44,7 @@ A response builder that uses the query to ask the LLM generate a better response
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L76)
|
||||
[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L76)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +54,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L74)
|
||||
[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L74)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L75)
|
||||
[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L75)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -91,7 +91,7 @@ BaseResponseBuilder.getResponse
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L88)
|
||||
[ResponseSynthesizer.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L88)
|
||||
|
||||
___
|
||||
|
||||
@@ -113,7 +113,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L113)
|
||||
[ResponseSynthesizer.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L113)
|
||||
|
||||
___
|
||||
|
||||
@@ -136,4 +136,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L149)
|
||||
[ResponseSynthesizer.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L149)
|
||||
|
||||
@@ -23,7 +23,7 @@ Respone is the output of a LLM
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Response.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Response.ts#L10)
|
||||
[Response.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Response.ts#L10)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -33,7 +33,7 @@ Respone is the output of a LLM
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Response.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Response.ts#L7)
|
||||
[Response.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Response.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
@@ -43,7 +43,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Response.ts#L8)
|
||||
[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Response.ts#L8)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -57,7 +57,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Response.ts#L15)
|
||||
[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Response.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
@@ -71,4 +71,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Response.ts#L19)
|
||||
[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Response.ts#L19)
|
||||
|
||||
@@ -24,7 +24,7 @@ A ResponseSynthesizer is used to generate a response from a query and a list of
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:285](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L285)
|
||||
[ResponseSynthesizer.ts:285](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L285)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -34,7 +34,7 @@ A ResponseSynthesizer is used to generate a response from a query and a list of
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:282](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L282)
|
||||
[ResponseSynthesizer.ts:282](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L282)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +44,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:283](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L283)
|
||||
[ResponseSynthesizer.ts:283](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L283)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -66,4 +66,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L297)
|
||||
[ResponseSynthesizer.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L297)
|
||||
|
||||
@@ -27,7 +27,7 @@ A query engine that uses a retriever to query an index and then synthesizes the
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QueryEngine.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L34)
|
||||
[QueryEngine.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QueryEngine.ts#L34)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -37,7 +37,7 @@ A query engine that uses a retriever to query an index and then synthesizes the
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QueryEngine.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L32)
|
||||
[QueryEngine.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QueryEngine.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
@@ -47,7 +47,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QueryEngine.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L31)
|
||||
[QueryEngine.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QueryEngine.ts#L31)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -74,4 +74,4 @@ Query the query engine and get a response.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QueryEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L45)
|
||||
[QueryEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QueryEngine.ts#L45)
|
||||
|
||||
@@ -27,7 +27,7 @@ SentenceSplitter is our default text splitter that supports splitting into sente
|
||||
|
||||
#### Defined in
|
||||
|
||||
[TextSplitter.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L33)
|
||||
[TextSplitter.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/TextSplitter.ts#L33)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -37,7 +37,7 @@ SentenceSplitter is our default text splitter that supports splitting into sente
|
||||
|
||||
#### Defined in
|
||||
|
||||
[TextSplitter.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L26)
|
||||
[TextSplitter.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/TextSplitter.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
@@ -47,7 +47,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[TextSplitter.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L25)
|
||||
[TextSplitter.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/TextSplitter.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
@@ -57,7 +57,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L30)
|
||||
[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/TextSplitter.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
@@ -67,7 +67,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L29)
|
||||
[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/TextSplitter.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -77,7 +77,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L27)
|
||||
[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/TextSplitter.ts#L27)
|
||||
|
||||
___
|
||||
|
||||
@@ -87,7 +87,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L28)
|
||||
[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/TextSplitter.ts#L28)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[TextSplitter.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L153)
|
||||
[TextSplitter.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/TextSplitter.ts#L153)
|
||||
|
||||
___
|
||||
|
||||
@@ -128,7 +128,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[TextSplitter.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L72)
|
||||
[TextSplitter.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/TextSplitter.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
@@ -149,7 +149,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[TextSplitter.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L89)
|
||||
[TextSplitter.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/TextSplitter.ts#L89)
|
||||
|
||||
___
|
||||
|
||||
@@ -170,7 +170,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[TextSplitter.ts:115](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L115)
|
||||
[TextSplitter.ts:115](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/TextSplitter.ts#L115)
|
||||
|
||||
___
|
||||
|
||||
@@ -191,7 +191,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[TextSplitter.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L128)
|
||||
[TextSplitter.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/TextSplitter.ts#L128)
|
||||
|
||||
___
|
||||
|
||||
@@ -212,7 +212,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[TextSplitter.ts:233](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L233)
|
||||
[TextSplitter.ts:233](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/TextSplitter.ts#L233)
|
||||
|
||||
___
|
||||
|
||||
@@ -233,4 +233,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L205)
|
||||
[TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/TextSplitter.ts#L205)
|
||||
|
||||
@@ -26,7 +26,7 @@ SimpleChatEngine is the simplest possible chat engine. Useful for using your own
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L40)
|
||||
[ChatEngine.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L40)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -36,7 +36,7 @@ SimpleChatEngine is the simplest possible chat engine. Useful for using your own
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L37)
|
||||
[ChatEngine.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -46,7 +46,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L38)
|
||||
[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L38)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -73,7 +73,7 @@ Send message along with the class's current chat history to the LLM.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L45)
|
||||
[ChatEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -93,4 +93,4 @@ Resets the chat history so that it's empty.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L54)
|
||||
[ChatEngine.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L54)
|
||||
|
||||
@@ -40,4 +40,4 @@ Read all of the documents in a directory. Currently supports PDF and TXT files.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[readers/SimpleDirectoryReader.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/readers/SimpleDirectoryReader.ts#L37)
|
||||
[readers/SimpleDirectoryReader.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/readers/SimpleDirectoryReader.ts#L37)
|
||||
|
||||
@@ -31,7 +31,7 @@ SimpleNodeParser is the default NodeParser. It splits documents into TextNodes u
|
||||
|
||||
#### Defined in
|
||||
|
||||
[NodeParser.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L64)
|
||||
[NodeParser.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/NodeParser.ts#L64)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -41,7 +41,7 @@ SimpleNodeParser is the default NodeParser. It splits documents into TextNodes u
|
||||
|
||||
#### Defined in
|
||||
|
||||
[NodeParser.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L61)
|
||||
[NodeParser.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/NodeParser.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
@@ -51,7 +51,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[NodeParser.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L62)
|
||||
[NodeParser.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/NodeParser.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
@@ -61,7 +61,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[NodeParser.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L60)
|
||||
[NodeParser.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/NodeParser.ts#L60)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -87,7 +87,7 @@ Generate Node objects from documents
|
||||
|
||||
#### Defined in
|
||||
|
||||
[NodeParser.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L95)
|
||||
[NodeParser.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/NodeParser.ts#L95)
|
||||
|
||||
___
|
||||
|
||||
@@ -111,4 +111,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[NodeParser.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L82)
|
||||
[NodeParser.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/NodeParser.ts#L82)
|
||||
|
||||
@@ -26,7 +26,7 @@ A response builder that just concatenates responses.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L49)
|
||||
[ResponseSynthesizer.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L49)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -36,7 +36,7 @@ A response builder that just concatenates responses.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L46)
|
||||
[ResponseSynthesizer.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -46,7 +46,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L47)
|
||||
[ResponseSynthesizer.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L47)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -72,4 +72,4 @@ BaseResponseBuilder.getResponse
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L54)
|
||||
[ResponseSynthesizer.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L54)
|
||||
|
||||
@@ -40,7 +40,7 @@ SubQuestionOutputParser is used to parse the output of the SubQuestionGenerator.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[OutputParser.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/OutputParser.ts#L97)
|
||||
[OutputParser.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/OutputParser.ts#L97)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,4 +64,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/OutputParser.ts#L89)
|
||||
[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/OutputParser.ts#L89)
|
||||
|
||||
@@ -29,7 +29,7 @@ SubQuestionQueryEngine decomposes a question into subquestions and then
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QueryEngine.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L65)
|
||||
[QueryEngine.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QueryEngine.ts#L65)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -39,7 +39,7 @@ SubQuestionQueryEngine decomposes a question into subquestions and then
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QueryEngine.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L63)
|
||||
[QueryEngine.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QueryEngine.ts#L63)
|
||||
|
||||
___
|
||||
|
||||
@@ -49,7 +49,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QueryEngine.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L62)
|
||||
[QueryEngine.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QueryEngine.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
@@ -59,7 +59,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QueryEngine.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L61)
|
||||
[QueryEngine.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QueryEngine.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
@@ -69,7 +69,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QueryEngine.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L60)
|
||||
[QueryEngine.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QueryEngine.ts#L60)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -95,7 +95,7 @@ Query the query engine and get a response.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QueryEngine.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L106)
|
||||
[QueryEngine.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QueryEngine.ts#L106)
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +116,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QueryEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L134)
|
||||
[QueryEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QueryEngine.ts#L134)
|
||||
|
||||
___
|
||||
|
||||
@@ -140,4 +140,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QueryEngine.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L82)
|
||||
[QueryEngine.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QueryEngine.ts#L82)
|
||||
|
||||
@@ -41,4 +41,4 @@ Read a .txt file
|
||||
|
||||
#### Defined in
|
||||
|
||||
[readers/SimpleDirectoryReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/readers/SimpleDirectoryReader.ts#L12)
|
||||
[readers/SimpleDirectoryReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/readers/SimpleDirectoryReader.ts#L12)
|
||||
|
||||
@@ -36,7 +36,7 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L144)
|
||||
[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L144)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -50,7 +50,7 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L39)
|
||||
[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
@@ -60,7 +60,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L139)
|
||||
[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L139)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L43)
|
||||
[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L44)
|
||||
[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -102,7 +102,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L46)
|
||||
[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +116,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L38)
|
||||
[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -130,7 +130,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L42)
|
||||
[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -140,7 +140,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L142)
|
||||
[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L142)
|
||||
|
||||
___
|
||||
|
||||
@@ -154,7 +154,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L45)
|
||||
[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -164,7 +164,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L138)
|
||||
[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L138)
|
||||
|
||||
___
|
||||
|
||||
@@ -174,7 +174,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L137)
|
||||
[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L137)
|
||||
|
||||
## Accessors
|
||||
|
||||
@@ -192,7 +192,7 @@ BaseNode.childNodes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L104)
|
||||
[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L104)
|
||||
|
||||
___
|
||||
|
||||
@@ -210,7 +210,7 @@ BaseNode.nextNode
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L84)
|
||||
[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L84)
|
||||
|
||||
___
|
||||
|
||||
@@ -228,7 +228,7 @@ BaseNode.nodeId
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L58)
|
||||
[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -246,7 +246,7 @@ BaseNode.parentNode
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L94)
|
||||
[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L94)
|
||||
|
||||
___
|
||||
|
||||
@@ -264,7 +264,7 @@ BaseNode.prevNode
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L72)
|
||||
[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
@@ -282,7 +282,7 @@ BaseNode.sourceNode
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L62)
|
||||
[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L62)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -300,7 +300,7 @@ BaseNode.sourceNode
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L124)
|
||||
[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L124)
|
||||
|
||||
___
|
||||
|
||||
@@ -314,7 +314,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L149)
|
||||
[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L149)
|
||||
|
||||
___
|
||||
|
||||
@@ -338,7 +338,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L157)
|
||||
[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L157)
|
||||
|
||||
___
|
||||
|
||||
@@ -356,7 +356,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L116)
|
||||
[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L116)
|
||||
|
||||
___
|
||||
|
||||
@@ -380,7 +380,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L162)
|
||||
[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L162)
|
||||
|
||||
___
|
||||
|
||||
@@ -399,7 +399,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L187)
|
||||
[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L187)
|
||||
|
||||
___
|
||||
|
||||
@@ -413,7 +413,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L191)
|
||||
[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L191)
|
||||
|
||||
___
|
||||
|
||||
@@ -431,7 +431,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L153)
|
||||
[Node.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L153)
|
||||
|
||||
___
|
||||
|
||||
@@ -455,4 +455,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L183)
|
||||
[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L183)
|
||||
|
||||
@@ -26,7 +26,7 @@ TreeSummarize repacks the text chunks into the smallest possible number of chunk
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L212)
|
||||
[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L212)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -36,7 +36,7 @@ TreeSummarize repacks the text chunks into the smallest possible number of chunk
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:210](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L210)
|
||||
[ResponseSynthesizer.ts:210](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L210)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -62,4 +62,4 @@ BaseResponseBuilder.getResponse
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L216)
|
||||
[ResponseSynthesizer.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L216)
|
||||
|
||||
@@ -28,7 +28,7 @@ VectorIndexRetriever retrieves nodes from a VectorIndex.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/vectorStore/VectorIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L22)
|
||||
[indices/vectorStore/VectorIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L22)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ VectorIndexRetriever retrieves nodes from a VectorIndex.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/vectorStore/VectorIndexRetriever.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L18)
|
||||
[indices/vectorStore/VectorIndexRetriever.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
@@ -48,7 +48,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/vectorStore/VectorIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L20)
|
||||
[indices/vectorStore/VectorIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
@@ -58,7 +58,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/vectorStore/VectorIndexRetriever.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L19)
|
||||
[indices/vectorStore/VectorIndexRetriever.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -76,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/vectorStore/VectorIndexRetriever.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L69)
|
||||
[indices/vectorStore/VectorIndexRetriever.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
@@ -101,4 +101,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/vectorStore/VectorIndexRetriever.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L35)
|
||||
[indices/vectorStore/VectorIndexRetriever.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L35)
|
||||
|
||||
@@ -32,7 +32,7 @@ The VectorStoreIndex, an index that stores the nodes only according to their vec
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/vectorStore/VectorStoreIndex.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L35)
|
||||
[indices/vectorStore/VectorStoreIndex.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L36)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -46,7 +46,7 @@ The VectorStoreIndex, an index that stores the nodes only according to their vec
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L73)
|
||||
[indices/BaseIndex.ts:99](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L99)
|
||||
|
||||
___
|
||||
|
||||
@@ -60,7 +60,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L75)
|
||||
[indices/BaseIndex.ts:101](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L101)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L76)
|
||||
[indices/BaseIndex.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L102)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L71)
|
||||
[indices/BaseIndex.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L97)
|
||||
|
||||
___
|
||||
|
||||
@@ -102,7 +102,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L72)
|
||||
[indices/BaseIndex.ts:98](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L98)
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +116,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/vectorStore/VectorStoreIndex.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L33)
|
||||
[indices/vectorStore/VectorStoreIndex.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L34)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -145,7 +145,7 @@ and response synthezier if they are not provided.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/vectorStore/VectorStoreIndex.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L181)
|
||||
[indices/vectorStore/VectorStoreIndex.ts:215](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L215)
|
||||
|
||||
___
|
||||
|
||||
@@ -171,7 +171,7 @@ Create a new retriever from the index.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/vectorStore/VectorStoreIndex.ts:177](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L177)
|
||||
[indices/vectorStore/VectorStoreIndex.ts:211](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L211)
|
||||
|
||||
___
|
||||
|
||||
@@ -196,13 +196,13 @@ Get embeddings for nodes and place them into the index.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/vectorStore/VectorStoreIndex.ts:120](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L120)
|
||||
[indices/vectorStore/VectorStoreIndex.ts:151](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L151)
|
||||
|
||||
___
|
||||
|
||||
### fromDocuments
|
||||
|
||||
▸ `Static` **fromDocuments**(`documents`, `storageContext?`, `serviceContext?`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\>
|
||||
▸ `Static` **fromDocuments**(`documents`, `args?`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\>
|
||||
|
||||
High level API: split documents, get embeddings, and build index.
|
||||
|
||||
@@ -211,8 +211,9 @@ High level API: split documents, get embeddings, and build index.
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `documents` | [`Document`](Document.md)[] |
|
||||
| `storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) |
|
||||
| `serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
|
||||
| `args` | `Object` |
|
||||
| `args.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
|
||||
| `args.storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -220,7 +221,7 @@ High level API: split documents, get embeddings, and build index.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/vectorStore/VectorStoreIndex.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L155)
|
||||
[indices/vectorStore/VectorStoreIndex.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L186)
|
||||
|
||||
___
|
||||
|
||||
@@ -244,7 +245,7 @@ Get the embeddings for nodes.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/vectorStore/VectorStoreIndex.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L92)
|
||||
[indices/vectorStore/VectorStoreIndex.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L123)
|
||||
|
||||
___
|
||||
|
||||
@@ -267,4 +268,4 @@ This is needed to handle persistence.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/vectorStore/VectorStoreIndex.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L46)
|
||||
[indices/vectorStore/VectorStoreIndex.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L47)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndex.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L25)
|
||||
[indices/list/ListIndex.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndex.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,4 +24,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/list/ListIndex.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L27)
|
||||
[indices/list/ListIndex.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/list/ListIndex.ts#L28)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L19)
|
||||
[Node.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L20)
|
||||
[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L21)
|
||||
[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L21)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,4 +44,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L22)
|
||||
[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L22)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L8)
|
||||
[Node.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L8)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L6)
|
||||
[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L6)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L7)
|
||||
[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +44,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L5)
|
||||
[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L5)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,4 +54,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L4)
|
||||
[Node.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L4)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L15)
|
||||
[Node.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L13)
|
||||
[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L14)
|
||||
[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,4 +44,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L12)
|
||||
[Node.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L12)
|
||||
|
||||
@@ -17,7 +17,7 @@ Default is cosine similarity. Dot product and negative Euclidean distance are al
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L10)
|
||||
[Embedding.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -27,7 +27,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L11)
|
||||
[Embedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
@@ -37,4 +37,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L12)
|
||||
[Embedding.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L12)
|
||||
|
||||
@@ -21,7 +21,7 @@ LlamaIndex.TS requries Node v18 or higher. You can download it from https://node
|
||||
In a new folder:
|
||||
|
||||
```bash
|
||||
export OPEN_AI_KEY="sk-......" # Replace with your key from https://platform.openai.com/account/api-keys
|
||||
export OPENAI_API_KEY="sk-......" # Replace with your key from https://platform.openai.com/account/api-keys
|
||||
npx tsc –-init # if needed
|
||||
pnpm install llamaindex
|
||||
```
|
||||
|
||||
@@ -26,7 +26,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L60)
|
||||
[indices/BaseIndex.ts:86](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L86)
|
||||
|
||||
___
|
||||
|
||||
@@ -36,7 +36,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L62)
|
||||
[indices/BaseIndex.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L88)
|
||||
|
||||
___
|
||||
|
||||
@@ -46,7 +46,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L63)
|
||||
[indices/BaseIndex.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L89)
|
||||
|
||||
___
|
||||
|
||||
@@ -56,7 +56,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L58)
|
||||
[indices/BaseIndex.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L84)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L59)
|
||||
[indices/BaseIndex.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,4 +76,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L61)
|
||||
[indices/BaseIndex.ts:87](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L87)
|
||||
|
||||
@@ -36,7 +36,7 @@ An OutputParser is used to extract structured data from the raw output of the LL
|
||||
|
||||
#### Defined in
|
||||
|
||||
[OutputParser.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/OutputParser.ts#L8)
|
||||
[OutputParser.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/OutputParser.ts#L8)
|
||||
|
||||
___
|
||||
|
||||
@@ -56,4 +56,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/OutputParser.ts#L7)
|
||||
[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/OutputParser.ts#L7)
|
||||
|
||||
@@ -34,4 +34,4 @@ Query the query engine and get a response.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QueryEngine.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L24)
|
||||
[QueryEngine.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QueryEngine.ts#L24)
|
||||
|
||||
@@ -31,4 +31,4 @@ QuestionGenerators generate new questions for the LLM using tools and a user que
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QuestionGenerator.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QuestionGenerator.ts#L23)
|
||||
[QuestionGenerator.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QuestionGenerator.ts#L23)
|
||||
|
||||
@@ -32,4 +32,4 @@ A reader takes imports data into Document objects.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/readers/base.ts#L7)
|
||||
[readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/readers/base.ts#L7)
|
||||
|
||||
@@ -26,7 +26,7 @@ Retrievers retrieve the nodes that most closely match our query in similarity.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Retriever.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Retriever.ts#L10)
|
||||
[Retriever.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Retriever.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -47,4 +47,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Retriever.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Retriever.ts#L9)
|
||||
[Retriever.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Retriever.ts#L9)
|
||||
|
||||
@@ -22,4 +22,4 @@ Simple Tool interface. Likely to change.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Tool.ts#L12)
|
||||
[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Tool.ts#L12)
|
||||
|
||||
@@ -35,7 +35,7 @@ Send message along with the class's current chat history to the LLM.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L25)
|
||||
[ChatEngine.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
@@ -51,4 +51,4 @@ Resets the chat history so that it's empty.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ChatEngine.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L30)
|
||||
[ChatEngine.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ChatEngine.ts#L30)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L14)
|
||||
[llm/LLM.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,4 +24,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L15)
|
||||
[llm/LLM.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L15)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L21)
|
||||
[llm/LLM.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L21)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L19)
|
||||
[llm/LLM.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,4 +34,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L20)
|
||||
[llm/LLM.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L20)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L14)
|
||||
[callbacks/CallbackManager.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L17)
|
||||
[callbacks/CallbackManager.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L16)
|
||||
[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,4 +44,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L15)
|
||||
[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L15)
|
||||
|
||||
@@ -33,7 +33,7 @@ browsers.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L12)
|
||||
[storage/FileSystem.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L12)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +54,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L13)
|
||||
[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
@@ -75,7 +75,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L11)
|
||||
[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
@@ -97,4 +97,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L10)
|
||||
[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L10)
|
||||
|
||||
@@ -34,7 +34,7 @@ Get a chat response from the LLM
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L35)
|
||||
[llm/LLM.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -57,4 +57,4 @@ Get a prompt completion from the LLM
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L41)
|
||||
[llm/LLM.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L41)
|
||||
|
||||
@@ -30,4 +30,4 @@ A node parser generates TextNodes from Documents
|
||||
|
||||
#### Defined in
|
||||
|
||||
[NodeParser.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L53)
|
||||
[NodeParser.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/NodeParser.ts#L53)
|
||||
|
||||
@@ -16,7 +16,7 @@ A node with an embedding
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:247](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L247)
|
||||
[Node.ts:247](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L247)
|
||||
|
||||
___
|
||||
|
||||
@@ -26,4 +26,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L246)
|
||||
[Node.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L246)
|
||||
|
||||
@@ -16,7 +16,7 @@ A node with a similarity score
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:238](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L238)
|
||||
[Node.ts:238](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L238)
|
||||
|
||||
___
|
||||
|
||||
@@ -26,4 +26,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L239)
|
||||
[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L239)
|
||||
|
||||
@@ -26,7 +26,7 @@ A Tool that uses a QueryEngine.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Tool.ts#L12)
|
||||
[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Tool.ts#L12)
|
||||
|
||||
___
|
||||
|
||||
@@ -36,4 +36,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Tool.ts#L19)
|
||||
[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Tool.ts#L19)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L29)
|
||||
[Node.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L28)
|
||||
[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L26)
|
||||
[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,4 +44,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L27)
|
||||
[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L27)
|
||||
|
||||
@@ -24,7 +24,7 @@ BaseCallbackResponse.event
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L21)
|
||||
[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L21)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L47)
|
||||
[callbacks/CallbackManager.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,4 +44,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L46)
|
||||
[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L46)
|
||||
|
||||
@@ -16,7 +16,7 @@ The ServiceContext is a collection of components that are used in different part
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L15)
|
||||
[ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ServiceContext.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
@@ -26,7 +26,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L13)
|
||||
[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ServiceContext.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
@@ -36,7 +36,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ServiceContext.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L11)
|
||||
[ServiceContext.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ServiceContext.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
@@ -46,7 +46,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L14)
|
||||
[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ServiceContext.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
@@ -56,4 +56,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L12)
|
||||
[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ServiceContext.ts#L12)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L24)
|
||||
[ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ServiceContext.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ServiceContext.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L27)
|
||||
[ServiceContext.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ServiceContext.ts#L27)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L26)
|
||||
[ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ServiceContext.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +44,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L22)
|
||||
[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ServiceContext.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +54,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ServiceContext.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L20)
|
||||
[ServiceContext.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ServiceContext.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L23)
|
||||
[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ServiceContext.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,4 +74,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L21)
|
||||
[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ServiceContext.ts#L21)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/StorageContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/StorageContext.ts#L15)
|
||||
[storage/StorageContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/StorageContext.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/StorageContext.ts#L16)
|
||||
[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/StorageContext.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,4 +34,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/StorageContext.ts#L17)
|
||||
[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/StorageContext.ts#L17)
|
||||
|
||||
@@ -24,7 +24,7 @@ BaseCallbackResponse.event
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L21)
|
||||
[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L21)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L40)
|
||||
[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +44,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L41)
|
||||
[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,4 +54,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L42)
|
||||
[callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L42)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L29)
|
||||
[callbacks/CallbackManager.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L27)
|
||||
[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L27)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L25)
|
||||
[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +44,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L28)
|
||||
[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,4 +54,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L26)
|
||||
[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L26)
|
||||
|
||||
@@ -22,7 +22,7 @@ StructuredOutput is just a combo of the raw output and the parsed output.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[OutputParser.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/OutputParser.ts#L16)
|
||||
[OutputParser.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/OutputParser.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
@@ -32,4 +32,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/OutputParser.ts#L15)
|
||||
[OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/OutputParser.ts#L15)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QuestionGenerator.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QuestionGenerator.ts#L15)
|
||||
[QuestionGenerator.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QuestionGenerator.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,4 +24,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QuestionGenerator.ts#L16)
|
||||
[QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/QuestionGenerator.ts#L16)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Tool.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Tool.ts#L4)
|
||||
[Tool.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Tool.ts#L4)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,4 +24,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Tool.ts#L5)
|
||||
[Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Tool.ts#L5)
|
||||
|
||||
@@ -24,7 +24,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L60)
|
||||
[indices/BaseIndex.ts:86](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L86)
|
||||
|
||||
___
|
||||
|
||||
@@ -38,7 +38,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L62)
|
||||
[indices/BaseIndex.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L88)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L63)
|
||||
[indices/BaseIndex.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L89)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L58)
|
||||
[indices/BaseIndex.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L84)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L59)
|
||||
[indices/BaseIndex.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,4 +94,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L112)
|
||||
[indices/BaseIndex.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L139)
|
||||
|
||||
@@ -8,13 +8,23 @@ custom_edit_url: null
|
||||
|
||||
## Properties
|
||||
|
||||
### indexId
|
||||
|
||||
• `Optional` **indexId**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L133)
|
||||
|
||||
___
|
||||
|
||||
### indexStruct
|
||||
|
||||
• `Optional` **indexStruct**: [`IndexDict`](../classes/IndexDict.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L106)
|
||||
[indices/BaseIndex.ts:132](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L132)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:105](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L105)
|
||||
[indices/BaseIndex.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L131)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +44,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L107)
|
||||
[indices/BaseIndex.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L134)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,4 +54,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[indices/BaseIndex.ts:108](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L108)
|
||||
[indices/BaseIndex.ts:135](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/indices/BaseIndex.ts#L135)
|
||||
|
||||
@@ -24,7 +24,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L17)
|
||||
[storage/FileSystem.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,4 +44,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L18)
|
||||
[storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L18)
|
||||
|
||||
@@ -95,7 +95,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L49)
|
||||
[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -105,7 +105,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L25)
|
||||
[llm/LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
@@ -115,7 +115,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L11)
|
||||
[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
@@ -125,7 +125,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L12)
|
||||
[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/callbacks/CallbackManager.ts#L12)
|
||||
|
||||
___
|
||||
|
||||
@@ -135,7 +135,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L32)
|
||||
[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Node.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
@@ -154,7 +154,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/readers/SimpleDirectoryReader.ts#L26)
|
||||
[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/readers/SimpleDirectoryReader.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
@@ -182,7 +182,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10)
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Prompt.ts#L10)
|
||||
|
||||
## Variables
|
||||
|
||||
@@ -206,7 +206,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L152)
|
||||
[llm/LLM.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L152)
|
||||
|
||||
___
|
||||
|
||||
@@ -231,7 +231,7 @@ We currently support GPT-3.5 and GPT-4 models
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L57)
|
||||
[llm/LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
@@ -241,7 +241,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L5)
|
||||
[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/constants.ts#L5)
|
||||
|
||||
___
|
||||
|
||||
@@ -251,7 +251,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L6)
|
||||
[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/constants.ts#L6)
|
||||
|
||||
___
|
||||
|
||||
@@ -261,7 +261,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L4)
|
||||
[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/constants.ts#L4)
|
||||
|
||||
___
|
||||
|
||||
@@ -271,7 +271,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/constants.ts#L1)
|
||||
[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/constants.ts#L1)
|
||||
|
||||
___
|
||||
|
||||
@@ -281,7 +281,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L1)
|
||||
[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/constants.ts#L1)
|
||||
|
||||
___
|
||||
|
||||
@@ -291,7 +291,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/constants.ts#L4)
|
||||
[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/constants.ts#L4)
|
||||
|
||||
___
|
||||
|
||||
@@ -301,7 +301,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L10)
|
||||
[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/constants.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -311,7 +311,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L62)
|
||||
[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
@@ -321,7 +321,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/constants.ts#L6)
|
||||
[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/constants.ts#L6)
|
||||
|
||||
___
|
||||
|
||||
@@ -331,7 +331,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/constants.ts#L3)
|
||||
[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/constants.ts#L3)
|
||||
|
||||
___
|
||||
|
||||
@@ -341,7 +341,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/constants.ts#L7)
|
||||
[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/constants.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
@@ -351,7 +351,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L2)
|
||||
[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/constants.ts#L2)
|
||||
|
||||
___
|
||||
|
||||
@@ -361,7 +361,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L11)
|
||||
[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/constants.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
@@ -371,7 +371,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/constants.ts#L2)
|
||||
[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/constants.ts#L2)
|
||||
|
||||
___
|
||||
|
||||
@@ -381,7 +381,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/constants.ts#L7)
|
||||
[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/constants.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
@@ -391,7 +391,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/constants.ts#L5)
|
||||
[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/constants.ts#L5)
|
||||
|
||||
___
|
||||
|
||||
@@ -410,7 +410,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L44)
|
||||
[llm/LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -429,7 +429,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[llm/LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L49)
|
||||
[llm/LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/llm/LLM.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -439,7 +439,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/GlobalsHelper.ts#L42)
|
||||
[GlobalsHelper.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/GlobalsHelper.ts#L50)
|
||||
|
||||
## Functions
|
||||
|
||||
@@ -459,7 +459,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L198)
|
||||
[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Prompt.ts#L198)
|
||||
|
||||
___
|
||||
|
||||
@@ -483,7 +483,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10)
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Prompt.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -507,7 +507,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10)
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Prompt.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -531,7 +531,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10)
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Prompt.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -555,7 +555,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10)
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Prompt.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -579,7 +579,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10)
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Prompt.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -603,7 +603,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10)
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Prompt.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -627,7 +627,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L10)
|
||||
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Prompt.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -653,7 +653,7 @@ A promise that resolves to true if the file exists, false otherwise.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L74)
|
||||
[storage/FileSystem.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L74)
|
||||
|
||||
___
|
||||
|
||||
@@ -667,7 +667,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L51)
|
||||
[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
@@ -690,7 +690,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L15)
|
||||
[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/NodeParser.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
@@ -711,7 +711,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ResponseSynthesizer.ts:262](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L262)
|
||||
[ResponseSynthesizer.ts:262](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ResponseSynthesizer.ts#L262)
|
||||
|
||||
___
|
||||
|
||||
@@ -732,7 +732,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L5)
|
||||
[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/NodeParser.ts#L5)
|
||||
|
||||
___
|
||||
|
||||
@@ -758,7 +758,7 @@ Get the top K embeddings from a list of embeddings ordered by similarity to the
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L77)
|
||||
[Embedding.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L77)
|
||||
|
||||
___
|
||||
|
||||
@@ -782,7 +782,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L119)
|
||||
[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L119)
|
||||
|
||||
___
|
||||
|
||||
@@ -808,7 +808,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L131)
|
||||
[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L131)
|
||||
|
||||
___
|
||||
|
||||
@@ -828,7 +828,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Prompt.ts#L300)
|
||||
[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Prompt.ts#L300)
|
||||
|
||||
___
|
||||
|
||||
@@ -848,7 +848,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ServiceContext.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L30)
|
||||
[ServiceContext.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ServiceContext.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
@@ -877,7 +877,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[ServiceContext.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L48)
|
||||
[ServiceContext.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/ServiceContext.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -903,7 +903,7 @@ similartiy score with higher numbers meaning the two embeddings are more similar
|
||||
|
||||
#### Defined in
|
||||
|
||||
[Embedding.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L22)
|
||||
[Embedding.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/Embedding.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
@@ -923,7 +923,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/StorageContext.ts#L28)
|
||||
[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/StorageContext.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
@@ -946,4 +946,4 @@ Recursively traverses a directory and yields all the paths to the files in it.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[storage/FileSystem.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L91)
|
||||
[storage/FileSystem.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/68bdaaa/packages/core/src/storage/FileSystem.ts#L91)
|
||||
|
||||
@@ -18,6 +18,10 @@ Create a list index and query it. This example also use the `LLMRetriever`, whic
|
||||
|
||||
Create a vector index and query it. The vector index will use embeddings to fetch the top k most relevant nodes. By default, the top k is 2.
|
||||
|
||||
## [Save / Load an Index](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/storageContext.ts)
|
||||
|
||||
Create and load a vector index. Persistance to disk in LlamaIndex.TS happens automatically once a storage context object is created.
|
||||
|
||||
## [Customized Vector Index](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/vectorIndexCustomize.ts)
|
||||
|
||||
Create a vector index and query it, while also configuring the the `LLM`, the `ServiceContext`, and the `similarity_top_k`.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_position: 0
|
||||
slug: /
|
||||
---
|
||||
|
||||
# What is LlamaIndex.TS?
|
||||
@@ -33,19 +34,19 @@ Our high-level API allows beginner users to use LlamaIndex.TS to ingest and quer
|
||||
For more complex applications, our lower-level APIs allow advanced users to customize and extend any module—data connectors, indices, retrievers, and query engines, to fit their needs.
|
||||
|
||||
## Getting Started
|
||||
|
||||
`npm install llamaindex`
|
||||
|
||||
Our documentation includes [Installation Instructions](./installation.md) and a [Starter Tutorial](./starter.md) to build your first application.
|
||||
|
||||
Once you're up and running, [High-Level Concepts](./concepts.md) has an overview of LlamaIndex's modular architecture. For more hands-on practical examples, look through our [End-to-End Tutorials](LINK TO EXAMPLES FOLDER).
|
||||
Once you're up and running, [High-Level Concepts](./concepts.md) has an overview of LlamaIndex's modular architecture. For more hands-on practical examples, look through our [End-to-End Tutorials](./end_to_end.md).
|
||||
|
||||
## 🗺️ Ecosystem
|
||||
|
||||
To download or contribute, find LlamaIndex on:
|
||||
|
||||
- Github: https://github.com/jerryjliu/llama_index
|
||||
- LlamaIndex (NPM): LINK TO NPM PACKAGE
|
||||
- LlamaIndex (Python): https://pypi.org/project/llama-index/.
|
||||
- Github: https://github.com/run-llama/LlamaIndexTS
|
||||
- NPM: https://www.npmjs.com/package/llamaindex
|
||||
|
||||
## Community
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ LlamaIndex.TS offers several core modules, seperated into high-level modules for
|
||||
|
||||
- [**Indexes**](./high_level/data_index.md): indexes store the Nodes and the embeddings of those nodes.
|
||||
|
||||
-[**QueryEngine**](./high_level/query_engine.md): Query engines are what generate the query you put in and give you back the result. Query engines generally combine a pre-built prompt with selected nodes from your Index to give the LLM the context it needs to answer your query.
|
||||
- [**QueryEngine**](./high_level/query_engine.md): Query engines are what generate the query you put in and give you back the result. Query engines generally combine a pre-built prompt with selected nodes from your Index to give the LLM the context it needs to answer your query.
|
||||
|
||||
- [**ChatEngine**](./high_level/chat_engine.md): A ChatEngine helps you build a chatbot that will interact with your Indexes.
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ import { Document, VectorStoreIndex, storageContextFromDefaults } from "./src";
|
||||
const storageContext = await storageContextFromDefaults({ persistDir: "./storage" });
|
||||
|
||||
const document = new Document({ text: "Test Text" });
|
||||
const index = await VectorStoreIndex.fromDocuments([document], storageContext);
|
||||
const index = await VectorStoreIndex.fromDocuments([document], { storageContext });
|
||||
```
|
||||
|
||||
## API Reference
|
||||
|
||||
@@ -11,7 +11,7 @@ In a new folder:
|
||||
```bash npm2yarn
|
||||
npm install typescript
|
||||
npm install @types/node
|
||||
npx tsc –-init # if needed
|
||||
npx tsc --init # if needed
|
||||
```
|
||||
|
||||
Create the file `example.ts`. This code will load some example data, create a document, index it (which creates embeddings using OpenAI), and then creates query engine to answer questions about the data.
|
||||
@@ -52,3 +52,5 @@ Then you can run it using
|
||||
```bash
|
||||
npx ts-node example.ts
|
||||
```
|
||||
|
||||
Ready to learn more? Check out our NextJS playground at https://llama-playground.vercel.app/. The source is available at https://github.com/run-llama/ts-playground
|
||||
|
||||
@@ -11,7 +11,7 @@ const config = {
|
||||
favicon: "img/favicon.png",
|
||||
|
||||
// Set the production url of your site here
|
||||
url: "https://your-docusaurus-test-site.com",
|
||||
url: "https://ts.llamaindex.ai",
|
||||
// Set the /<baseUrl>/ pathname under which your site is served
|
||||
// For GitHub pages deployment, it is often '/<projectName>/'
|
||||
baseUrl: "/",
|
||||
@@ -38,6 +38,7 @@ const config = {
|
||||
/** @type {import('@docusaurus/preset-classic').Options} */
|
||||
({
|
||||
docs: {
|
||||
routeBasePath: "/",
|
||||
sidebarPath: require.resolve("./sidebars.js"),
|
||||
// Please change this to your repo.
|
||||
// Remove this to remove the "edit this page" links.
|
||||
@@ -47,6 +48,7 @@ const config = {
|
||||
[require("@docusaurus/remark-plugin-npm2yarn"), { sync: true }],
|
||||
],
|
||||
},
|
||||
blog: false,
|
||||
}),
|
||||
],
|
||||
],
|
||||
@@ -117,9 +119,20 @@ const config = {
|
||||
theme: lightCodeTheme,
|
||||
darkTheme: darkCodeTheme,
|
||||
},
|
||||
algolia: {
|
||||
// The application ID provided by Algolia
|
||||
appId: "DYKPM6G4CX",
|
||||
|
||||
// Public API key: it is safe to commit it
|
||||
apiKey: "c4ff3789f20bb72a5d735082aef17719",
|
||||
|
||||
indexName: "ts-llamaindex",
|
||||
|
||||
// Optional: see doc section below
|
||||
contextualSearch: true,
|
||||
},
|
||||
}),
|
||||
plugins: [
|
||||
[require.resolve('docusaurus-lunr-search'), {}],
|
||||
[
|
||||
"docusaurus-plugin-typedoc",
|
||||
{
|
||||
|
||||
@@ -19,12 +19,7 @@
|
||||
"@docusaurus/preset-classic": "2.4.1",
|
||||
"@docusaurus/remark-plugin-npm2yarn": "^2.4.1",
|
||||
"@mdx-js/react": "^1.6.22",
|
||||
"autocomplete.js": "^0.38.1",
|
||||
"classnames": "^2.3.2",
|
||||
"clsx": "^1.2.1",
|
||||
"docusaurus-lunr-search": "^2.3.2",
|
||||
"hogan.js": "^3.0.2",
|
||||
"lunr": "^2.3.9",
|
||||
"postcss": "^8.4.26",
|
||||
"prism-react-renderer": "^1.3.5",
|
||||
"raw-loader": "^4.0.2",
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
import React from "react";
|
||||
import clsx from "clsx";
|
||||
import Link from "@docusaurus/Link";
|
||||
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
|
||||
import Layout from "@theme/Layout";
|
||||
import HomepageFeatures from "@site/src/components/HomepageFeatures";
|
||||
|
||||
import styles from "./index.module.css";
|
||||
|
||||
function HomepageHeader() {
|
||||
const { siteConfig } = useDocusaurusContext();
|
||||
return (
|
||||
<header className={clsx("hero hero--primary", styles.heroBanner)}>
|
||||
<div className="container">
|
||||
<h1 className="hero__title">{siteConfig.title}</h1>
|
||||
<p className="hero__subtitle">{siteConfig.tagline}</p>
|
||||
<div className={styles.buttons}>Welcome to LlamaIndex.TS!</div>
|
||||
</div>
|
||||
</header>
|
||||
);
|
||||
}
|
||||
|
||||
export default function Home(): JSX.Element {
|
||||
const { siteConfig } = useDocusaurusContext();
|
||||
return (
|
||||
<Layout
|
||||
title={`Hello from ${siteConfig.title}`}
|
||||
description="Description will go into a meta tag in <head />"
|
||||
>
|
||||
<HomepageHeader />
|
||||
<main>
|
||||
<HomepageFeatures />
|
||||
</main>
|
||||
</Layout>
|
||||
);
|
||||
}
|
||||
@@ -1,297 +0,0 @@
|
||||
import Hogan from "hogan.js";
|
||||
import LunrSearchAdapter from "./lunar-search";
|
||||
import autocomplete from "autocomplete.js";
|
||||
import templates from "./templates";
|
||||
import utils from "./utils";
|
||||
import $ from "autocomplete.js/zepto";
|
||||
|
||||
class DocSearch {
|
||||
constructor({
|
||||
searchDocs,
|
||||
searchIndex,
|
||||
inputSelector,
|
||||
debug = false,
|
||||
baseUrl = '/',
|
||||
queryDataCallback = null,
|
||||
autocompleteOptions = {
|
||||
debug: false,
|
||||
hint: false,
|
||||
autoselect: true
|
||||
},
|
||||
transformData = false,
|
||||
queryHook = false,
|
||||
handleSelected = false,
|
||||
enhancedSearchInput = false,
|
||||
layout = "collumns"
|
||||
}) {
|
||||
this.input = DocSearch.getInputFromSelector(inputSelector);
|
||||
this.queryDataCallback = queryDataCallback || null;
|
||||
const autocompleteOptionsDebug =
|
||||
autocompleteOptions && autocompleteOptions.debug
|
||||
? autocompleteOptions.debug
|
||||
: false;
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
autocompleteOptions.debug = debug || autocompleteOptionsDebug;
|
||||
this.autocompleteOptions = autocompleteOptions;
|
||||
this.autocompleteOptions.cssClasses =
|
||||
this.autocompleteOptions.cssClasses || {};
|
||||
this.autocompleteOptions.cssClasses.prefix =
|
||||
this.autocompleteOptions.cssClasses.prefix || "ds";
|
||||
const inputAriaLabel =
|
||||
this.input &&
|
||||
typeof this.input.attr === "function" &&
|
||||
this.input.attr("aria-label");
|
||||
this.autocompleteOptions.ariaLabel =
|
||||
this.autocompleteOptions.ariaLabel || inputAriaLabel || "search input";
|
||||
|
||||
this.isSimpleLayout = layout === "simple";
|
||||
|
||||
this.client = new LunrSearchAdapter(searchDocs, searchIndex, baseUrl);
|
||||
|
||||
if (enhancedSearchInput) {
|
||||
this.input = DocSearch.injectSearchBox(this.input);
|
||||
}
|
||||
this.autocomplete = autocomplete(this.input, autocompleteOptions, [
|
||||
{
|
||||
source: this.getAutocompleteSource(transformData, queryHook),
|
||||
templates: {
|
||||
suggestion: DocSearch.getSuggestionTemplate(this.isSimpleLayout),
|
||||
footer: templates.footer,
|
||||
empty: DocSearch.getEmptyTemplate()
|
||||
}
|
||||
}
|
||||
]);
|
||||
|
||||
const customHandleSelected = handleSelected;
|
||||
this.handleSelected = customHandleSelected || this.handleSelected;
|
||||
|
||||
// We prevent default link clicking if a custom handleSelected is defined
|
||||
if (customHandleSelected) {
|
||||
$(".algolia-autocomplete").on("click", ".ds-suggestions a", event => {
|
||||
event.preventDefault();
|
||||
});
|
||||
}
|
||||
|
||||
this.autocomplete.on(
|
||||
"autocomplete:selected",
|
||||
this.handleSelected.bind(null, this.autocomplete.autocomplete)
|
||||
);
|
||||
|
||||
this.autocomplete.on(
|
||||
"autocomplete:shown",
|
||||
this.handleShown.bind(null, this.input)
|
||||
);
|
||||
|
||||
if (enhancedSearchInput) {
|
||||
DocSearch.bindSearchBoxEvent();
|
||||
}
|
||||
}
|
||||
|
||||
static injectSearchBox(input) {
|
||||
input.before(templates.searchBox);
|
||||
const newInput = input
|
||||
.prev()
|
||||
.prev()
|
||||
.find("input");
|
||||
input.remove();
|
||||
return newInput;
|
||||
}
|
||||
|
||||
static bindSearchBoxEvent() {
|
||||
$('.searchbox [type="reset"]').on("click", function () {
|
||||
$("input#docsearch").focus();
|
||||
$(this).addClass("hide");
|
||||
autocomplete.autocomplete.setVal("");
|
||||
});
|
||||
|
||||
$("input#docsearch").on("keyup", () => {
|
||||
const searchbox = document.querySelector("input#docsearch");
|
||||
const reset = document.querySelector('.searchbox [type="reset"]');
|
||||
reset.className = "searchbox__reset";
|
||||
if (searchbox.value.length === 0) {
|
||||
reset.className += " hide";
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the matching input from a CSS selector, null if none matches
|
||||
* @function getInputFromSelector
|
||||
* @param {string} selector CSS selector that matches the search
|
||||
* input of the page
|
||||
* @returns {void}
|
||||
*/
|
||||
static getInputFromSelector(selector) {
|
||||
const input = $(selector).filter("input");
|
||||
return input.length ? $(input[0]) : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the `source` method to be passed to autocomplete.js. It will query
|
||||
* the Algolia index and call the callbacks with the formatted hits.
|
||||
* @function getAutocompleteSource
|
||||
* @param {function} transformData An optional function to transform the hits
|
||||
* @param {function} queryHook An optional function to transform the query
|
||||
* @returns {function} Method to be passed as the `source` option of
|
||||
* autocomplete
|
||||
*/
|
||||
getAutocompleteSource(transformData, queryHook) {
|
||||
return (query, callback) => {
|
||||
if (queryHook) {
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
query = queryHook(query) || query;
|
||||
}
|
||||
this.client.search(query).then(hits => {
|
||||
if (
|
||||
this.queryDataCallback &&
|
||||
typeof this.queryDataCallback == "function"
|
||||
) {
|
||||
this.queryDataCallback(hits);
|
||||
}
|
||||
if (transformData) {
|
||||
hits = transformData(hits) || hits;
|
||||
}
|
||||
callback(DocSearch.formatHits(hits));
|
||||
});
|
||||
};
|
||||
}
|
||||
|
||||
// Given a list of hits returned by the API, will reformat them to be used in
|
||||
// a Hogan template
|
||||
static formatHits(receivedHits) {
|
||||
const clonedHits = utils.deepClone(receivedHits);
|
||||
const hits = clonedHits.map(hit => {
|
||||
if (hit._highlightResult) {
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
hit._highlightResult = utils.mergeKeyWithParent(
|
||||
hit._highlightResult,
|
||||
"hierarchy"
|
||||
);
|
||||
}
|
||||
return utils.mergeKeyWithParent(hit, "hierarchy");
|
||||
});
|
||||
|
||||
// Group hits by category / subcategory
|
||||
let groupedHits = utils.groupBy(hits, "lvl0");
|
||||
$.each(groupedHits, (level, collection) => {
|
||||
const groupedHitsByLvl1 = utils.groupBy(collection, "lvl1");
|
||||
const flattenedHits = utils.flattenAndFlagFirst(
|
||||
groupedHitsByLvl1,
|
||||
"isSubCategoryHeader"
|
||||
);
|
||||
groupedHits[level] = flattenedHits;
|
||||
});
|
||||
groupedHits = utils.flattenAndFlagFirst(groupedHits, "isCategoryHeader");
|
||||
|
||||
// Translate hits into smaller objects to be send to the template
|
||||
return groupedHits.map(hit => {
|
||||
const url = DocSearch.formatURL(hit);
|
||||
const category = utils.getHighlightedValue(hit, "lvl0");
|
||||
const subcategory = utils.getHighlightedValue(hit, "lvl1") || category;
|
||||
const displayTitle = utils
|
||||
.compact([
|
||||
utils.getHighlightedValue(hit, "lvl2") || subcategory,
|
||||
utils.getHighlightedValue(hit, "lvl3"),
|
||||
utils.getHighlightedValue(hit, "lvl4"),
|
||||
utils.getHighlightedValue(hit, "lvl5"),
|
||||
utils.getHighlightedValue(hit, "lvl6")
|
||||
])
|
||||
.join(
|
||||
'<span class="aa-suggestion-title-separator" aria-hidden="true"> › </span>'
|
||||
);
|
||||
const text = utils.getSnippetedValue(hit, "content");
|
||||
const isTextOrSubcategoryNonEmpty =
|
||||
(subcategory && subcategory !== "") ||
|
||||
(displayTitle && displayTitle !== "");
|
||||
const isLvl1EmptyOrDuplicate =
|
||||
!subcategory || subcategory === "" || subcategory === category;
|
||||
const isLvl2 =
|
||||
displayTitle && displayTitle !== "" && displayTitle !== subcategory;
|
||||
const isLvl1 =
|
||||
!isLvl2 &&
|
||||
(subcategory && subcategory !== "" && subcategory !== category);
|
||||
const isLvl0 = !isLvl1 && !isLvl2;
|
||||
|
||||
return {
|
||||
isLvl0,
|
||||
isLvl1,
|
||||
isLvl2,
|
||||
isLvl1EmptyOrDuplicate,
|
||||
isCategoryHeader: hit.isCategoryHeader,
|
||||
isSubCategoryHeader: hit.isSubCategoryHeader,
|
||||
isTextOrSubcategoryNonEmpty,
|
||||
category,
|
||||
subcategory,
|
||||
title: displayTitle,
|
||||
text,
|
||||
url
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
static formatURL(hit) {
|
||||
const { url, anchor } = hit;
|
||||
if (url) {
|
||||
const containsAnchor = url.indexOf("#") !== -1;
|
||||
if (containsAnchor) return url;
|
||||
else if (anchor) return `${hit.url}#${hit.anchor}`;
|
||||
return url;
|
||||
} else if (anchor) return `#${hit.anchor}`;
|
||||
/* eslint-disable */
|
||||
console.warn("no anchor nor url for : ", JSON.stringify(hit));
|
||||
/* eslint-enable */
|
||||
return null;
|
||||
}
|
||||
|
||||
static getEmptyTemplate() {
|
||||
return args => Hogan.compile(templates.empty).render(args);
|
||||
}
|
||||
|
||||
static getSuggestionTemplate(isSimpleLayout) {
|
||||
const stringTemplate = isSimpleLayout
|
||||
? templates.suggestionSimple
|
||||
: templates.suggestion;
|
||||
const template = Hogan.compile(stringTemplate);
|
||||
return suggestion => template.render(suggestion);
|
||||
}
|
||||
|
||||
handleSelected(input, event, suggestion, datasetNumber, context = {}) {
|
||||
// Do nothing if click on the suggestion, as it's already a <a href>, the
|
||||
// browser will take care of it. This allow Ctrl-Clicking on results and not
|
||||
// having the main window being redirected as well
|
||||
if (context.selectionMethod === "click") {
|
||||
return;
|
||||
}
|
||||
|
||||
input.setVal("");
|
||||
window.location.assign(suggestion.url);
|
||||
}
|
||||
|
||||
handleShown(input) {
|
||||
const middleOfInput = input.offset().left + input.width() / 2;
|
||||
let middleOfWindow = $(document).width() / 2;
|
||||
|
||||
if (isNaN(middleOfWindow)) {
|
||||
middleOfWindow = 900;
|
||||
}
|
||||
|
||||
const alignClass =
|
||||
middleOfInput - middleOfWindow >= 0
|
||||
? "algolia-autocomplete-right"
|
||||
: "algolia-autocomplete-left";
|
||||
const otherAlignClass =
|
||||
middleOfInput - middleOfWindow < 0
|
||||
? "algolia-autocomplete-right"
|
||||
: "algolia-autocomplete-left";
|
||||
const autocompleteWrapper = $(".algolia-autocomplete");
|
||||
if (!autocompleteWrapper.hasClass(alignClass)) {
|
||||
autocompleteWrapper.addClass(alignClass);
|
||||
}
|
||||
|
||||
if (autocompleteWrapper.hasClass(otherAlignClass)) {
|
||||
autocompleteWrapper.removeClass(otherAlignClass);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export default DocSearch;
|
||||
File diff suppressed because one or more lines are too long
@@ -1,114 +0,0 @@
|
||||
import React, { useRef, useCallback, useState } from "react";
|
||||
import classnames from "classnames";
|
||||
import { useHistory } from "@docusaurus/router";
|
||||
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
|
||||
import { usePluginData } from '@docusaurus/useGlobalData';
|
||||
import useIsBrowser from "@docusaurus/useIsBrowser";
|
||||
const Search = props => {
|
||||
const initialized = useRef(false);
|
||||
const searchBarRef = useRef(null);
|
||||
const [indexReady, setIndexReady] = useState(false);
|
||||
const history = useHistory();
|
||||
const { siteConfig = {} } = useDocusaurusContext();
|
||||
const isBrowser = useIsBrowser();
|
||||
const { baseUrl } = siteConfig;
|
||||
const initAlgolia = (searchDocs, searchIndex, DocSearch) => {
|
||||
new DocSearch({
|
||||
searchDocs,
|
||||
searchIndex,
|
||||
baseUrl,
|
||||
inputSelector: "#search_input_react",
|
||||
// Override algolia's default selection event, allowing us to do client-side
|
||||
// navigation and avoiding a full page refresh.
|
||||
handleSelected: (_input, _event, suggestion) => {
|
||||
const url = suggestion.url || "/";
|
||||
// Use an anchor tag to parse the absolute url into a relative url
|
||||
// Alternatively, we can use new URL(suggestion.url) but its not supported in IE
|
||||
const a = document.createElement("a");
|
||||
a.href = url;
|
||||
// Algolia use closest parent element id #__docusaurus when a h1 page title does not have an id
|
||||
// So, we can safely remove it. See https://github.com/facebook/docusaurus/issues/1828 for more details.
|
||||
|
||||
history.push(url);
|
||||
}
|
||||
});
|
||||
};
|
||||
|
||||
const pluginData = usePluginData('docusaurus-lunr-search');
|
||||
const getSearchDoc = () =>
|
||||
process.env.NODE_ENV === "production"
|
||||
? fetch(`${baseUrl}${pluginData.fileNames.searchDoc}`).then((content) => content.json())
|
||||
: Promise.resolve([]);
|
||||
|
||||
const getLunrIndex = () =>
|
||||
process.env.NODE_ENV === "production"
|
||||
? fetch(`${baseUrl}${pluginData.fileNames.lunrIndex}`).then((content) => content.json())
|
||||
: Promise.resolve([]);
|
||||
|
||||
const loadAlgolia = () => {
|
||||
if (!initialized.current) {
|
||||
Promise.all([
|
||||
getSearchDoc(),
|
||||
getLunrIndex(),
|
||||
import("./DocSearch"),
|
||||
import("./algolia.css")
|
||||
]).then(([searchDocs, searchIndex, { default: DocSearch }]) => {
|
||||
if (searchDocs.length === 0) {
|
||||
return;
|
||||
}
|
||||
initAlgolia(searchDocs, searchIndex, DocSearch);
|
||||
setIndexReady(true);
|
||||
});
|
||||
initialized.current = true;
|
||||
}
|
||||
};
|
||||
|
||||
const toggleSearchIconClick = useCallback(
|
||||
e => {
|
||||
if (!searchBarRef.current.contains(e.target)) {
|
||||
searchBarRef.current.focus();
|
||||
}
|
||||
|
||||
props.handleSearchBarToggle && props.handleSearchBarToggle(!props.isSearchBarExpanded);
|
||||
},
|
||||
[props.isSearchBarExpanded]
|
||||
);
|
||||
|
||||
if (isBrowser) {
|
||||
loadAlgolia();
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="navbar__search" key="search-box">
|
||||
<span
|
||||
aria-label="expand searchbar"
|
||||
role="button"
|
||||
className={classnames("search-icon", {
|
||||
"search-icon-hidden": props.isSearchBarExpanded
|
||||
})}
|
||||
onClick={toggleSearchIconClick}
|
||||
onKeyDown={toggleSearchIconClick}
|
||||
tabIndex={0}
|
||||
/>
|
||||
<input
|
||||
id="search_input_react"
|
||||
type="search"
|
||||
placeholder={indexReady ? 'Search' : 'Loading...'}
|
||||
aria-label="Search"
|
||||
className={classnames(
|
||||
"navbar__search-input",
|
||||
{ "search-bar-expanded": props.isSearchBarExpanded },
|
||||
{ "search-bar": !props.isSearchBarExpanded }
|
||||
)}
|
||||
onClick={loadAlgolia}
|
||||
onMouseOver={loadAlgolia}
|
||||
onFocus={toggleSearchIconClick}
|
||||
onBlur={toggleSearchIconClick}
|
||||
ref={searchBarRef}
|
||||
disabled={!indexReady}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
||||
export default Search;
|
||||
@@ -1,147 +0,0 @@
|
||||
import lunr from "@generated/lunr.client";
|
||||
lunr.tokenizer.separator = /[\s\-/]+/;
|
||||
|
||||
class LunrSearchAdapter {
|
||||
constructor(searchDocs, searchIndex, baseUrl = '/') {
|
||||
this.searchDocs = searchDocs;
|
||||
this.lunrIndex = lunr.Index.load(searchIndex);
|
||||
this.baseUrl = baseUrl;
|
||||
}
|
||||
|
||||
getLunrResult(input) {
|
||||
return this.lunrIndex.query(function (query) {
|
||||
const tokens = lunr.tokenizer(input);
|
||||
query.term(tokens, {
|
||||
boost: 10
|
||||
});
|
||||
query.term(tokens, {
|
||||
wildcard: lunr.Query.wildcard.TRAILING
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
getHit(doc, formattedTitle, formattedContent) {
|
||||
return {
|
||||
hierarchy: {
|
||||
lvl0: doc.pageTitle || doc.title,
|
||||
lvl1: doc.type === 0 ? null : doc.title
|
||||
},
|
||||
url: doc.url,
|
||||
_snippetResult: formattedContent ? {
|
||||
content: {
|
||||
value: formattedContent,
|
||||
matchLevel: "full"
|
||||
}
|
||||
} : null,
|
||||
_highlightResult: {
|
||||
hierarchy: {
|
||||
lvl0: {
|
||||
value: doc.type === 0 ? formattedTitle || doc.title : doc.pageTitle,
|
||||
},
|
||||
lvl1:
|
||||
doc.type === 0
|
||||
? null
|
||||
: {
|
||||
value: formattedTitle || doc.title
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
getTitleHit(doc, position, length) {
|
||||
const start = position[0];
|
||||
const end = position[0] + length;
|
||||
let formattedTitle = doc.title.substring(0, start) + '<span class="algolia-docsearch-suggestion--highlight">' + doc.title.substring(start, end) + '</span>' + doc.title.substring(end, doc.title.length);
|
||||
return this.getHit(doc, formattedTitle)
|
||||
}
|
||||
|
||||
getKeywordHit(doc, position, length) {
|
||||
const start = position[0];
|
||||
const end = position[0] + length;
|
||||
let formattedTitle = doc.title + '<br /><i>Keywords: ' + doc.keywords.substring(0, start) + '<span class="algolia-docsearch-suggestion--highlight">' + doc.keywords.substring(start, end) + '</span>' + doc.keywords.substring(end, doc.keywords.length) + '</i>'
|
||||
return this.getHit(doc, formattedTitle)
|
||||
}
|
||||
|
||||
getContentHit(doc, position) {
|
||||
const start = position[0];
|
||||
const end = position[0] + position[1];
|
||||
let previewStart = start;
|
||||
let previewEnd = end;
|
||||
let ellipsesBefore = true;
|
||||
let ellipsesAfter = true;
|
||||
for (let k = 0; k < 3; k++) {
|
||||
const nextSpace = doc.content.lastIndexOf(' ', previewStart - 2);
|
||||
const nextDot = doc.content.lastIndexOf('.', previewStart - 2);
|
||||
if ((nextDot > 0) && (nextDot > nextSpace)) {
|
||||
previewStart = nextDot + 1;
|
||||
ellipsesBefore = false;
|
||||
break;
|
||||
}
|
||||
if (nextSpace < 0) {
|
||||
previewStart = 0;
|
||||
ellipsesBefore = false;
|
||||
break;
|
||||
}
|
||||
previewStart = nextSpace + 1;
|
||||
}
|
||||
for (let k = 0; k < 10; k++) {
|
||||
const nextSpace = doc.content.indexOf(' ', previewEnd + 1);
|
||||
const nextDot = doc.content.indexOf('.', previewEnd + 1);
|
||||
if ((nextDot > 0) && (nextDot < nextSpace)) {
|
||||
previewEnd = nextDot;
|
||||
ellipsesAfter = false;
|
||||
break;
|
||||
}
|
||||
if (nextSpace < 0) {
|
||||
previewEnd = doc.content.length;
|
||||
ellipsesAfter = false;
|
||||
break;
|
||||
}
|
||||
previewEnd = nextSpace;
|
||||
}
|
||||
let preview = doc.content.substring(previewStart, start);
|
||||
if (ellipsesBefore) {
|
||||
preview = '... ' + preview;
|
||||
}
|
||||
preview += '<span class="algolia-docsearch-suggestion--highlight">' + doc.content.substring(start, end) + '</span>';
|
||||
preview += doc.content.substring(end, previewEnd);
|
||||
if (ellipsesAfter) {
|
||||
preview += ' ...';
|
||||
}
|
||||
return this.getHit(doc, null, preview);
|
||||
|
||||
}
|
||||
search(input) {
|
||||
return new Promise((resolve, rej) => {
|
||||
const results = this.getLunrResult(input);
|
||||
const hits = [];
|
||||
results.length > 5 && (results.length = 5);
|
||||
this.titleHitsRes = []
|
||||
this.contentHitsRes = []
|
||||
results.forEach(result => {
|
||||
const doc = this.searchDocs[result.ref];
|
||||
const { metadata } = result.matchData;
|
||||
for (let i in metadata) {
|
||||
if (metadata[i].title) {
|
||||
if (!this.titleHitsRes.includes(result.ref)) {
|
||||
const position = metadata[i].title.position[0]
|
||||
hits.push(this.getTitleHit(doc, position, input.length));
|
||||
this.titleHitsRes.push(result.ref);
|
||||
}
|
||||
} else if (metadata[i].content) {
|
||||
const position = metadata[i].content.position[0]
|
||||
hits.push(this.getContentHit(doc, position))
|
||||
} else if (metadata[i].keywords) {
|
||||
const position = metadata[i].keywords.position[0]
|
||||
hits.push(this.getKeywordHit(doc, position, input.length));
|
||||
this.titleHitsRes.push(result.ref);
|
||||
}
|
||||
}
|
||||
});
|
||||
hits.length > 5 && (hits.length = 5);
|
||||
resolve(hits);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
export default LunrSearchAdapter;
|
||||
@@ -1,33 +0,0 @@
|
||||
.search-icon {
|
||||
background-image: var(--ifm-navbar-search-input-icon);
|
||||
height: auto;
|
||||
width: 24px;
|
||||
cursor: pointer;
|
||||
padding: 8px;
|
||||
line-height: 32px;
|
||||
background-repeat: no-repeat;
|
||||
background-position: center;
|
||||
display: none;
|
||||
}
|
||||
|
||||
.search-icon-hidden {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
@media (max-width: 360px) {
|
||||
.search-bar {
|
||||
width: 0 !important;
|
||||
background: none !important;
|
||||
padding: 0 !important;
|
||||
transition: none !important;
|
||||
}
|
||||
|
||||
.search-bar-expanded {
|
||||
width: 9rem !important;
|
||||
}
|
||||
|
||||
.search-icon {
|
||||
display: inline;
|
||||
vertical-align: sub;
|
||||
}
|
||||
}
|
||||
@@ -1,112 +0,0 @@
|
||||
const prefix = 'algolia-docsearch';
|
||||
const suggestionPrefix = `${prefix}-suggestion`;
|
||||
const footerPrefix = `${prefix}-footer`;
|
||||
|
||||
const templates = {
|
||||
suggestion: `
|
||||
<a class="${suggestionPrefix}
|
||||
{{#isCategoryHeader}}${suggestionPrefix}__main{{/isCategoryHeader}}
|
||||
{{#isSubCategoryHeader}}${suggestionPrefix}__secondary{{/isSubCategoryHeader}}
|
||||
"
|
||||
aria-label="Link to the result"
|
||||
href="{{{url}}}"
|
||||
>
|
||||
<div class="${suggestionPrefix}--category-header">
|
||||
<span class="${suggestionPrefix}--category-header-lvl0">{{{category}}}</span>
|
||||
</div>
|
||||
<div class="${suggestionPrefix}--wrapper">
|
||||
<div class="${suggestionPrefix}--subcategory-column">
|
||||
<span class="${suggestionPrefix}--subcategory-column-text">{{{subcategory}}}</span>
|
||||
</div>
|
||||
{{#isTextOrSubcategoryNonEmpty}}
|
||||
<div class="${suggestionPrefix}--content">
|
||||
<div class="${suggestionPrefix}--subcategory-inline">{{{subcategory}}}</div>
|
||||
<div class="${suggestionPrefix}--title">{{{title}}}</div>
|
||||
{{#text}}<div class="${suggestionPrefix}--text">{{{text}}}</div>{{/text}}
|
||||
</div>
|
||||
{{/isTextOrSubcategoryNonEmpty}}
|
||||
</div>
|
||||
</a>
|
||||
`,
|
||||
suggestionSimple: `
|
||||
<div class="${suggestionPrefix}
|
||||
{{#isCategoryHeader}}${suggestionPrefix}__main{{/isCategoryHeader}}
|
||||
{{#isSubCategoryHeader}}${suggestionPrefix}__secondary{{/isSubCategoryHeader}}
|
||||
suggestion-layout-simple
|
||||
">
|
||||
<div class="${suggestionPrefix}--category-header">
|
||||
{{^isLvl0}}
|
||||
<span class="${suggestionPrefix}--category-header-lvl0 ${suggestionPrefix}--category-header-item">{{{category}}}</span>
|
||||
{{^isLvl1}}
|
||||
{{^isLvl1EmptyOrDuplicate}}
|
||||
<span class="${suggestionPrefix}--category-header-lvl1 ${suggestionPrefix}--category-header-item">
|
||||
{{{subcategory}}}
|
||||
</span>
|
||||
{{/isLvl1EmptyOrDuplicate}}
|
||||
{{/isLvl1}}
|
||||
{{/isLvl0}}
|
||||
<div class="${suggestionPrefix}--title ${suggestionPrefix}--category-header-item">
|
||||
{{#isLvl2}}
|
||||
{{{title}}}
|
||||
{{/isLvl2}}
|
||||
{{#isLvl1}}
|
||||
{{{subcategory}}}
|
||||
{{/isLvl1}}
|
||||
{{#isLvl0}}
|
||||
{{{category}}}
|
||||
{{/isLvl0}}
|
||||
</div>
|
||||
</div>
|
||||
<div class="${suggestionPrefix}--wrapper">
|
||||
{{#text}}
|
||||
<div class="${suggestionPrefix}--content">
|
||||
<div class="${suggestionPrefix}--text">{{{text}}}</div>
|
||||
</div>
|
||||
{{/text}}
|
||||
</div>
|
||||
</div>
|
||||
`,
|
||||
footer: `
|
||||
<div class="${footerPrefix}">
|
||||
</div>
|
||||
`,
|
||||
empty: `
|
||||
<div class="${suggestionPrefix}">
|
||||
<div class="${suggestionPrefix}--wrapper">
|
||||
<div class="${suggestionPrefix}--content ${suggestionPrefix}--no-results">
|
||||
<div class="${suggestionPrefix}--title">
|
||||
<div class="${suggestionPrefix}--text">
|
||||
No results found for query <b>"{{query}}"</b>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
`,
|
||||
searchBox: `
|
||||
<form novalidate="novalidate" onsubmit="return false;" class="searchbox">
|
||||
<div role="search" class="searchbox__wrapper">
|
||||
<input id="docsearch" type="search" name="search" placeholder="Search the docs" autocomplete="off" required="required" class="searchbox__input"/>
|
||||
<button type="submit" title="Submit your search query." class="searchbox__submit" >
|
||||
<svg width=12 height=12 role="img" aria-label="Search">
|
||||
<use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#sbx-icon-search-13"></use>
|
||||
</svg>
|
||||
</button>
|
||||
<button type="reset" title="Clear the search query." class="searchbox__reset hide">
|
||||
<svg width=12 height=12 role="img" aria-label="Reset">
|
||||
<use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#sbx-icon-clear-3"></use>
|
||||
</svg>
|
||||
</button>
|
||||
</div>
|
||||
</form>
|
||||
|
||||
<div class="svg-icons" style="height: 0; width: 0; position: absolute; visibility: hidden">
|
||||
<svg xmlns="http://www.w3.org/2000/svg">
|
||||
<symbol id="sbx-icon-clear-3" viewBox="0 0 40 40"><path d="M16.228 20L1.886 5.657 0 3.772 3.772 0l1.885 1.886L20 16.228 34.343 1.886 36.228 0 40 3.772l-1.886 1.885L23.772 20l14.342 14.343L40 36.228 36.228 40l-1.885-1.886L20 23.772 5.657 38.114 3.772 40 0 36.228l1.886-1.885L16.228 20z" fill-rule="evenodd"></symbol>
|
||||
<symbol id="sbx-icon-search-13" viewBox="0 0 40 40"><path d="M26.806 29.012a16.312 16.312 0 0 1-10.427 3.746C7.332 32.758 0 25.425 0 16.378 0 7.334 7.333 0 16.38 0c9.045 0 16.378 7.333 16.378 16.38 0 3.96-1.406 7.593-3.746 10.426L39.547 37.34c.607.608.61 1.59-.004 2.203a1.56 1.56 0 0 1-2.202.004L26.807 29.012zm-10.427.627c7.322 0 13.26-5.938 13.26-13.26 0-7.324-5.938-13.26-13.26-13.26-7.324 0-13.26 5.936-13.26 13.26 0 7.322 5.936 13.26 13.26 13.26z" fill-rule="evenodd"></symbol>
|
||||
</svg>
|
||||
</div>
|
||||
`,
|
||||
};
|
||||
|
||||
export default templates;
|
||||
@@ -1,270 +0,0 @@
|
||||
import $ from "autocomplete.js/zepto";
|
||||
|
||||
const utils = {
|
||||
/*
|
||||
* Move the content of an object key one level higher.
|
||||
* eg.
|
||||
* {
|
||||
* name: 'My name',
|
||||
* hierarchy: {
|
||||
* lvl0: 'Foo',
|
||||
* lvl1: 'Bar'
|
||||
* }
|
||||
* }
|
||||
* Will be converted to
|
||||
* {
|
||||
* name: 'My name',
|
||||
* lvl0: 'Foo',
|
||||
* lvl1: 'Bar'
|
||||
* }
|
||||
* @param {Object} object Main object
|
||||
* @param {String} property Main object key to move up
|
||||
* @return {Object}
|
||||
* @throws Error when key is not an attribute of Object or is not an object itself
|
||||
*/
|
||||
mergeKeyWithParent(object, property) {
|
||||
if (object[property] === undefined) {
|
||||
return object;
|
||||
}
|
||||
if (typeof object[property] !== 'object') {
|
||||
return object;
|
||||
}
|
||||
const newObject = $.extend({}, object, object[property]);
|
||||
delete newObject[property];
|
||||
return newObject;
|
||||
},
|
||||
/*
|
||||
* Group all objects of a collection by the value of the specified attribute
|
||||
* If the attribute is a string, use the lowercase form.
|
||||
*
|
||||
* eg.
|
||||
* groupBy([
|
||||
* {name: 'Tim', category: 'dev'},
|
||||
* {name: 'Vincent', category: 'dev'},
|
||||
* {name: 'Ben', category: 'sales'},
|
||||
* {name: 'Jeremy', category: 'sales'},
|
||||
* {name: 'AlexS', category: 'dev'},
|
||||
* {name: 'AlexK', category: 'sales'}
|
||||
* ], 'category');
|
||||
* =>
|
||||
* {
|
||||
* 'devs': [
|
||||
* {name: 'Tim', category: 'dev'},
|
||||
* {name: 'Vincent', category: 'dev'},
|
||||
* {name: 'AlexS', category: 'dev'}
|
||||
* ],
|
||||
* 'sales': [
|
||||
* {name: 'Ben', category: 'sales'},
|
||||
* {name: 'Jeremy', category: 'sales'},
|
||||
* {name: 'AlexK', category: 'sales'}
|
||||
* ]
|
||||
* }
|
||||
* @param {array} collection Array of objects to group
|
||||
* @param {String} property The attribute on which apply the grouping
|
||||
* @return {array}
|
||||
* @throws Error when one of the element does not have the specified property
|
||||
*/
|
||||
groupBy(collection, property) {
|
||||
const newCollection = {};
|
||||
$.each(collection, (index, item) => {
|
||||
if (item[property] === undefined) {
|
||||
throw new Error(`[groupBy]: Object has no key ${property}`);
|
||||
}
|
||||
let key = item[property];
|
||||
if (typeof key === 'string') {
|
||||
key = key.toLowerCase();
|
||||
}
|
||||
// fix #171 the given data type of docsearch hits might be conflict with the properties of the native Object,
|
||||
// such as the constructor, so we need to do this check.
|
||||
if (!Object.prototype.hasOwnProperty.call(newCollection, key)) {
|
||||
newCollection[key] = [];
|
||||
}
|
||||
newCollection[key].push(item);
|
||||
});
|
||||
return newCollection;
|
||||
},
|
||||
/*
|
||||
* Return an array of all the values of the specified object
|
||||
* eg.
|
||||
* values({
|
||||
* foo: 42,
|
||||
* bar: true,
|
||||
* baz: 'yep'
|
||||
* })
|
||||
* =>
|
||||
* [42, true, yep]
|
||||
* @param {object} object Object to extract values from
|
||||
* @return {array}
|
||||
*/
|
||||
values(object) {
|
||||
return Object.keys(object).map(key => object[key]);
|
||||
},
|
||||
/*
|
||||
* Flattens an array
|
||||
* eg.
|
||||
* flatten([1, 2, [3, 4], [5, 6]])
|
||||
* =>
|
||||
* [1, 2, 3, 4, 5, 6]
|
||||
* @param {array} array Array to flatten
|
||||
* @return {array}
|
||||
*/
|
||||
flatten(array) {
|
||||
const results = [];
|
||||
array.forEach(value => {
|
||||
if (!Array.isArray(value)) {
|
||||
results.push(value);
|
||||
return;
|
||||
}
|
||||
value.forEach(subvalue => {
|
||||
results.push(subvalue);
|
||||
});
|
||||
});
|
||||
return results;
|
||||
},
|
||||
/*
|
||||
* Flatten all values of an object into an array, marking each first element of
|
||||
* each group with a specific flag
|
||||
* eg.
|
||||
* flattenAndFlagFirst({
|
||||
* 'devs': [
|
||||
* {name: 'Tim', category: 'dev'},
|
||||
* {name: 'Vincent', category: 'dev'},
|
||||
* {name: 'AlexS', category: 'dev'}
|
||||
* ],
|
||||
* 'sales': [
|
||||
* {name: 'Ben', category: 'sales'},
|
||||
* {name: 'Jeremy', category: 'sales'},
|
||||
* {name: 'AlexK', category: 'sales'}
|
||||
* ]
|
||||
* , 'isTop');
|
||||
* =>
|
||||
* [
|
||||
* {name: 'Tim', category: 'dev', isTop: true},
|
||||
* {name: 'Vincent', category: 'dev', isTop: false},
|
||||
* {name: 'AlexS', category: 'dev', isTop: false},
|
||||
* {name: 'Ben', category: 'sales', isTop: true},
|
||||
* {name: 'Jeremy', category: 'sales', isTop: false},
|
||||
* {name: 'AlexK', category: 'sales', isTop: false}
|
||||
* ]
|
||||
* @param {object} object Object to flatten
|
||||
* @param {string} flag Flag to set to true on first element of each group
|
||||
* @return {array}
|
||||
*/
|
||||
flattenAndFlagFirst(object, flag) {
|
||||
const values = this.values(object).map(collection =>
|
||||
collection.map((item, index) => {
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
item[flag] = index === 0;
|
||||
return item;
|
||||
})
|
||||
);
|
||||
return this.flatten(values);
|
||||
},
|
||||
/*
|
||||
* Removes all empty strings, null, false and undefined elements array
|
||||
* eg.
|
||||
* compact([42, false, null, undefined, '', [], 'foo']);
|
||||
* =>
|
||||
* [42, [], 'foo']
|
||||
* @param {array} array Array to compact
|
||||
* @return {array}
|
||||
*/
|
||||
compact(array) {
|
||||
const results = [];
|
||||
array.forEach(value => {
|
||||
if (!value) {
|
||||
return;
|
||||
}
|
||||
results.push(value);
|
||||
});
|
||||
return results;
|
||||
},
|
||||
/*
|
||||
* Returns the highlighted value of the specified key in the specified object.
|
||||
* If no highlighted value is available, will return the key value directly
|
||||
* eg.
|
||||
* getHighlightedValue({
|
||||
* _highlightResult: {
|
||||
* text: {
|
||||
* value: '<mark>foo</mark>'
|
||||
* }
|
||||
* },
|
||||
* text: 'foo'
|
||||
* }, 'text');
|
||||
* =>
|
||||
* '<mark>foo</mark>'
|
||||
* @param {object} object Hit object returned by the Algolia API
|
||||
* @param {string} property Object key to look for
|
||||
* @return {string}
|
||||
**/
|
||||
getHighlightedValue(object, property) {
|
||||
if (
|
||||
object._highlightResult &&
|
||||
object._highlightResult.hierarchy_camel &&
|
||||
object._highlightResult.hierarchy_camel[property] &&
|
||||
object._highlightResult.hierarchy_camel[property].matchLevel &&
|
||||
object._highlightResult.hierarchy_camel[property].matchLevel !== 'none' &&
|
||||
object._highlightResult.hierarchy_camel[property].value
|
||||
) {
|
||||
return object._highlightResult.hierarchy_camel[property].value;
|
||||
}
|
||||
if (
|
||||
object._highlightResult &&
|
||||
object._highlightResult &&
|
||||
object._highlightResult[property] &&
|
||||
object._highlightResult[property].value
|
||||
) {
|
||||
return object._highlightResult[property].value;
|
||||
}
|
||||
return object[property];
|
||||
},
|
||||
/*
|
||||
* Returns the snippeted value of the specified key in the specified object.
|
||||
* If no highlighted value is available, will return the key value directly.
|
||||
* Will add starting and ending ellipsis (…) if we detect that a sentence is
|
||||
* incomplete
|
||||
* eg.
|
||||
* getSnippetedValue({
|
||||
* _snippetResult: {
|
||||
* text: {
|
||||
* value: '<mark>This is an unfinished sentence</mark>'
|
||||
* }
|
||||
* },
|
||||
* text: 'This is an unfinished sentence'
|
||||
* }, 'text');
|
||||
* =>
|
||||
* '<mark>This is an unfinished sentence</mark>…'
|
||||
* @param {object} object Hit object returned by the Algolia API
|
||||
* @param {string} property Object key to look for
|
||||
* @return {string}
|
||||
**/
|
||||
getSnippetedValue(object, property) {
|
||||
if (
|
||||
!object._snippetResult ||
|
||||
!object._snippetResult[property] ||
|
||||
!object._snippetResult[property].value
|
||||
) {
|
||||
return object[property];
|
||||
}
|
||||
let snippet = object._snippetResult[property].value;
|
||||
|
||||
if (snippet[0] !== snippet[0].toUpperCase()) {
|
||||
snippet = `…${snippet}`;
|
||||
}
|
||||
if (['.', '!', '?'].indexOf(snippet[snippet.length - 1]) === -1) {
|
||||
snippet = `${snippet}…`;
|
||||
}
|
||||
return snippet;
|
||||
},
|
||||
/*
|
||||
* Deep clone an object.
|
||||
* Note: This will not clone functions and dates
|
||||
* @param {object} object Object to clone
|
||||
* @return {object}
|
||||
*/
|
||||
deepClone(object) {
|
||||
return JSON.parse(JSON.stringify(object));
|
||||
},
|
||||
};
|
||||
|
||||
export default utils;
|
||||
@@ -1,5 +1,54 @@
|
||||
# simple
|
||||
|
||||
## 0.0.10
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [68bdaaa]
|
||||
- llamaindex@0.0.12
|
||||
|
||||
## 0.0.9
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [fb7fb76]
|
||||
- llamaindex@0.0.11
|
||||
|
||||
## 0.0.8
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [6f2cb31]
|
||||
- llamaindex@0.0.10
|
||||
|
||||
## 0.0.7
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [02d9bb0]
|
||||
- llamaindex@0.0.9
|
||||
|
||||
## 0.0.6
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [ea5038e]
|
||||
- llamaindex@0.0.8
|
||||
|
||||
## 0.0.5
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [9fa6d4a]
|
||||
- llamaindex@0.0.7
|
||||
|
||||
## 0.0.4
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies
|
||||
- llamaindex@0.0.6
|
||||
|
||||
## 0.0.3
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
# Simple Examples
|
||||
|
||||
Due to packaging, you will need to run `pnpm --filter llamaindex build` before running these examples.
|
||||
Due to packaging, you will need to run these commands to get started.
|
||||
```bash
|
||||
pnpm --filter llamaindex build
|
||||
pnpm install
|
||||
```
|
||||
|
||||
Run them with ts-node, for example `npx ts-node vectorIndex.ts`
|
||||
Then run the examples with `ts-node`, for example `npx ts-node vectorIndex.ts`
|
||||
|
||||
@@ -15,8 +15,7 @@ async function main() {
|
||||
const serviceContext = serviceContextFromDefaults({ chunkSize: 512 });
|
||||
const index = await VectorStoreIndex.fromDocuments(
|
||||
[document],
|
||||
undefined,
|
||||
serviceContext
|
||||
{ serviceContext }
|
||||
);
|
||||
const retriever = index.asRetriever();
|
||||
retriever.similarityTopK = 5;
|
||||
|
||||
Binary file not shown.
@@ -14,10 +14,10 @@ async function main() {
|
||||
}),
|
||||
});
|
||||
const document = new Document({ text: essay });
|
||||
const index = await ListIndex.fromDocuments({
|
||||
documents: [document],
|
||||
serviceContext,
|
||||
});
|
||||
const index = await ListIndex.fromDocuments(
|
||||
[document],
|
||||
{ serviceContext }
|
||||
);
|
||||
const queryEngine = index.asQueryEngine({
|
||||
retriever: index.asRetriever({ mode: ListRetrieverMode.LLM }),
|
||||
});
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { LlamaDeuce } from "llamaindex/src/llm/LLM";
|
||||
import { LlamaDeuce } from "llamaindex";
|
||||
|
||||
(async () => {
|
||||
const deuce = new LlamaDeuce();
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"version": "0.0.3",
|
||||
"version": "0.0.10",
|
||||
"private": true,
|
||||
"name": "simple",
|
||||
"dependencies": {
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
import fs from "fs/promises";
|
||||
import { Document, PDFReader, VectorStoreIndex } from "llamaindex";
|
||||
|
||||
async function main() {
|
||||
// Load PDF
|
||||
const reader = new PDFReader();
|
||||
const documents = await reader.loadData("examples/brk-2022.pdf");
|
||||
|
||||
// Split text and create embeddings. Store them in a VectorStoreIndex
|
||||
const index = await VectorStoreIndex.fromDocuments(documents);
|
||||
|
||||
// Query the index
|
||||
const queryEngine = index.asQueryEngine();
|
||||
const response = await queryEngine.query("What mistakes did they make?");
|
||||
|
||||
// Output response
|
||||
console.log(response.toString());
|
||||
}
|
||||
|
||||
main().catch(console.error);
|
||||
@@ -0,0 +1,32 @@
|
||||
import { Document, VectorStoreIndex, storageContextFromDefaults } from "llamaindex";
|
||||
import essay from "./essay";
|
||||
|
||||
|
||||
async function main() {
|
||||
// Create Document object with essay
|
||||
const document = new Document({ text: essay });
|
||||
|
||||
// Split text and create embeddings. Store them in a VectorStoreIndex
|
||||
// persist the vector store automatically with the storage context
|
||||
const storageContext = await storageContextFromDefaults({ persistDir: "./storage" });
|
||||
const index = await VectorStoreIndex.fromDocuments([document], { storageContext });
|
||||
|
||||
// Query the index
|
||||
const queryEngine = index.asQueryEngine();
|
||||
const response = await queryEngine.query(
|
||||
"What did the author do in college?"
|
||||
);
|
||||
|
||||
// Output response
|
||||
console.log(response.toString());
|
||||
|
||||
// load the index
|
||||
const loadedIndex = await VectorStoreIndex.init({ storageContext });
|
||||
const laodedQueryEngine = loadedIndex.asQueryEngine();
|
||||
const loadedResponse = await laodedQueryEngine.query(
|
||||
"What did the author do growing up?"
|
||||
);
|
||||
console.log(loadedResponse.toString());
|
||||
}
|
||||
|
||||
main().catch(console.error);
|
||||
@@ -9,7 +9,7 @@ async function main() {
|
||||
{ llm: new OpenAI({ model: "gpt-3.5-turbo", temperature: 0.0 }) }
|
||||
);
|
||||
|
||||
const index = await VectorStoreIndex.fromDocuments([document], undefined, serviceContext);
|
||||
const index = await VectorStoreIndex.fromDocuments([document], { serviceContext });
|
||||
|
||||
const retriever = index.asRetriever();
|
||||
retriever.similarityTopK = 5;
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user