Added sourceNode property to TextNode class

.changeset/breezy-students-listen.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+Update storage exports (thanks @TomPenguin)

apps/docs/docs/.gitignore

@@ -1 +0,0 @@
-api/

apps/docs/docs/api/_category_.yml

@@ -0,0 +1,2 @@
+label: "API"
+position: 6

apps/docs/docs/api/classes/Anthropic.md

@@ -0,0 +1,193 @@
+---
+id: "Anthropic"
+title: "Class: Anthropic"
+sidebar_label: "Anthropic"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Anthropic LLM implementation
+
+## Implements
+
+- [`LLM`](../interfaces/LLM.md)
+
+## Constructors
+
+### constructor
+
+• **new Anthropic**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`Anthropic`](Anthropic.md)\> |
+
+#### Defined in
+
+[llm/LLM.ts:387](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L387)
+
+## Properties
+
+### apiKey
+
+• `Optional` **apiKey**: `string` = `undefined`
+
+#### Defined in
+
+[llm/LLM.ts:380](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L380)
+
+___
+
+### callbackManager
+
+• `Optional` **callbackManager**: [`CallbackManager`](CallbackManager.md)
+
+#### Defined in
+
+[llm/LLM.ts:385](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L385)
+
+___
+
+### maxRetries
+
+• **maxRetries**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:381](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L381)
+
+___
+
+### maxTokens
+
+• `Optional` **maxTokens**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:377](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L377)
+
+___
+
+### model
+
+• **model**: `string`
+
+#### Defined in
+
+[llm/LLM.ts:374](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L374)
+
+___
+
+### session
+
+• **session**: `AnthropicSession`
+
+#### Defined in
+
+[llm/LLM.ts:383](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L383)
+
+___
+
+### temperature
+
+• **temperature**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:375](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L375)
+
+___
+
+### timeout
+
+• `Optional` **timeout**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:382](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L382)
+
+___
+
+### topP
+
+• **topP**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:376](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L376)
+
+## Methods
+
+### chat
+
+▸ **chat**(`messages`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+Get a chat response from the LLM
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Implementation of
+
+[LLM](../interfaces/LLM.md).[chat](../interfaces/LLM.md#chat)
+
+#### Defined in
+
+[llm/LLM.ts:422](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L422)
+
+___
+
+### complete
+
+▸ **complete**(`prompt`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+Get a prompt completion from the LLM
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `prompt` | `string` | the prompt to complete |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) | - |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Implementation of
+
+[LLM](../interfaces/LLM.md).[complete](../interfaces/LLM.md#complete)
+
+#### Defined in
+
+[llm/LLM.ts:440](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L440)
+
+___
+
+### mapMessagesToPrompt
+
+▸ **mapMessagesToPrompt**(`messages`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[llm/LLM.ts:407](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L407)

apps/docs/docs/api/classes/BaseEmbedding.md

@@ -0,0 +1,81 @@
+---
+id: "BaseEmbedding"
+title: "Class: BaseEmbedding"
+sidebar_label: "BaseEmbedding"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Hierarchy
+
+- **`BaseEmbedding`**
+
+  ↳ [`OpenAIEmbedding`](OpenAIEmbedding.md)
+
+## Constructors
+
+### constructor
+
+• **new BaseEmbedding**()
+
+## Methods
+
+### getQueryEmbedding
+
+▸ `Abstract` **getQueryEmbedding**(`query`): `Promise`<`number`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+
+#### Returns
+
+`Promise`<`number`[]\>
+
+#### Defined in
+
+[Embedding.ts:213](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L213)
+
+___
+
+### getTextEmbedding
+
+▸ `Abstract` **getTextEmbedding**(`text`): `Promise`<`number`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `text` | `string` |
+
+#### Returns
+
+`Promise`<`number`[]\>
+
+#### Defined in
+
+[Embedding.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L212)
+
+___
+
+### similarity
+
+▸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `embedding1` | `number`[] | `undefined` |
+| `embedding2` | `number`[] | `undefined` |
+| `mode` | [`SimilarityType`](../enums/SimilarityType.md) | `SimilarityType.DEFAULT` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[Embedding.ts:204](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L204)

apps/docs/docs/api/classes/BaseIndex.md

@@ -0,0 +1,153 @@
+---
+id: "BaseIndex"
+title: "Class: BaseIndex<T>"
+sidebar_label: "BaseIndex"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Indexes are the data structure that we store our nodes and embeddings in so
+they can be retrieved for our queries.
+
+## Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+## Hierarchy
+
+- **`BaseIndex`**
+
+  ↳ [`ListIndex`](ListIndex.md)
+
+  ↳ [`VectorStoreIndex`](VectorStoreIndex.md)
+
+## Constructors
+
+### constructor
+
+• **new BaseIndex**<`T`\>(`init`)
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | [`BaseIndexInit`](../interfaces/BaseIndexInit.md)<`T`\> |
+
+#### Defined in
+
+[indices/BaseIndex.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L127)
+
+## Properties
+
+### docStore
+
+• **docStore**: `BaseDocumentStore`
+
+#### Defined in
+
+[indices/BaseIndex.ts:122](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L122)
+
+___
+
+### indexStore
+
+• `Optional` **indexStore**: `BaseIndexStore`
+
+#### Defined in
+
+[indices/BaseIndex.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L124)
+
+___
+
+### indexStruct
+
+• **indexStruct**: `T`
+
+#### Defined in
+
+[indices/BaseIndex.ts:125](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L125)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:120](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L120)
+
+___
+
+### storageContext
+
+• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:121](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L121)
+
+___
+
+### vectorStore
+
+• `Optional` **vectorStore**: [`VectorStore`](../interfaces/VectorStore.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L123)
+
+## Methods
+
+### asQueryEngine
+
+▸ `Abstract` **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+Create a new query engine from the index. It will also create a retriever
+and response synthezier if they are not provided.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer |
+| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - |
+| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - |
+
+#### Returns
+
+[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:147](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L147)
+
+___
+
+### asRetriever
+
+▸ `Abstract` **asRetriever**(`options?`): [`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+Create a new retriever from the index.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options?` | `any` |
+
+#### Returns
+
+[`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:140](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L140)

apps/docs/docs/api/classes/BaseNode.md

@@ -0,0 +1,303 @@
+---
+id: "BaseNode"
+title: "Class: BaseNode"
+sidebar_label: "BaseNode"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Generic abstract class for retrievable nodes
+
+## Hierarchy
+
+- **`BaseNode`**
+
+  ↳ [`TextNode`](TextNode.md)
+
+## Constructors
+
+### constructor
+
+• **new BaseNode**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`BaseNode`](BaseNode.md)\> |
+
+#### Defined in
+
+[Node.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L48)
+
+## Properties
+
+### embedding
+
+• `Optional` **embedding**: `number`[]
+
+#### Defined in
+
+[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L39)
+
+___
+
+### excludedEmbedMetadataKeys
+
+• **excludedEmbedMetadataKeys**: `string`[] = `[]`
+
+#### Defined in
+
+[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L43)
+
+___
+
+### excludedLlmMetadataKeys
+
+• **excludedLlmMetadataKeys**: `string`[] = `[]`
+
+#### Defined in
+
+[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L44)
+
+___
+
+### hash
+
+• **hash**: `string` = `""`
+
+#### Defined in
+
+[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L46)
+
+___
+
+### id\_
+
+• **id\_**: `string`
+
+#### Defined in
+
+[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L38)
+
+___
+
+### metadata
+
+• **metadata**: `Record`<`string`, `any`\> = `{}`
+
+#### Defined in
+
+[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L42)
+
+___
+
+### relationships
+
+• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../modules.md#relatednodetype)\>\> = `{}`
+
+#### Defined in
+
+[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L45)
+
+## Accessors
+
+### childNodes
+
+• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
+
+#### Defined in
+
+[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L104)
+
+___
+
+### nextNode
+
+• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Defined in
+
+[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L84)
+
+___
+
+### nodeId
+
+• `get` **nodeId**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L58)
+
+___
+
+### parentNode
+
+• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Defined in
+
+[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L94)
+
+___
+
+### prevNode
+
+• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Defined in
+
+[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L72)
+
+___
+
+### sourceNode
+
+• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Defined in
+
+[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L62)
+
+## Methods
+
+### asRelatedNodeInfo
+
+▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Defined in
+
+[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L124)
+
+___
+
+### getContent
+
+▸ `Abstract` **getContent**(`metadataMode`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L54)
+
+___
+
+### getEmbedding
+
+▸ **getEmbedding**(): `number`[]
+
+#### Returns
+
+`number`[]
+
+#### Defined in
+
+[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L116)
+
+___
+
+### getMetadataStr
+
+▸ `Abstract` **getMetadataStr**(`metadataMode`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L55)
+
+___
+
+### getType
+
+▸ `Abstract` **getType**(): [`ObjectType`](../enums/ObjectType.md)
+
+#### Returns
+
+[`ObjectType`](../enums/ObjectType.md)
+
+#### Defined in
+
+[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L52)
+
+___
+
+### setContent
+
+▸ `Abstract` **setContent**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `any` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L56)
+
+___
+
+### toJSON
+
+▸ **toJSON**(): `Record`<`string`, `any`\>
+
+Used with built in JSON.stringify
+
+#### Returns
+
+`Record`<`string`, `any`\>
+
+#### Defined in
+
+[Node.ts:136](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L136)

apps/docs/docs/api/classes/CallbackManager.md

@@ -0,0 +1,83 @@
+---
+id: "CallbackManager"
+title: "Class: CallbackManager"
+sidebar_label: "CallbackManager"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Implements
+
+- `CallbackManagerMethods`
+
+## Constructors
+
+### constructor
+
+• **new CallbackManager**(`handlers?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `handlers?` | `CallbackManagerMethods` |
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L67)
+
+## Properties
+
+### onLLMStream
+
+• `Optional` **onLLMStream**: (`params`: [`StreamCallbackResponse`](../interfaces/StreamCallbackResponse.md)) => `void` \| `Promise`<`void`\>
+
+#### Type declaration
+
+▸ (`params`): `void` \| `Promise`<`void`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | [`StreamCallbackResponse`](../interfaces/StreamCallbackResponse.md) |
+
+##### Returns
+
+`void` \| `Promise`<`void`\>
+
+#### Implementation of
+
+CallbackManagerMethods.onLLMStream
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L64)
+
+___
+
+### onRetrieve
+
+• `Optional` **onRetrieve**: (`params`: [`RetrievalCallbackResponse`](../interfaces/RetrievalCallbackResponse.md)) => `void` \| `Promise`<`void`\>
+
+#### Type declaration
+
+▸ (`params`): `void` \| `Promise`<`void`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | [`RetrievalCallbackResponse`](../interfaces/RetrievalCallbackResponse.md) |
+
+##### Returns
+
+`void` \| `Promise`<`void`\>
+
+#### Implementation of
+
+CallbackManagerMethods.onRetrieve
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L65)

apps/docs/docs/api/classes/CompactAndRefine.md

@@ -0,0 +1,106 @@
+---
+id: "CompactAndRefine"
+title: "Class: CompactAndRefine"
+sidebar_label: "CompactAndRefine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+CompactAndRefine is a slight variation of Refine that first compacts the text chunks into the smallest possible number of chunks.
+
+## Hierarchy
+
+- [`Refine`](Refine.md)
+
+  ↳ **`CompactAndRefine`**
+
+## Constructors
+
+### constructor
+
+• **new CompactAndRefine**(`serviceContext`, `textQATemplate?`, `refineTemplate?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+| `textQATemplate?` | [`SimplePrompt`](../modules.md#simpleprompt) |
+| `refineTemplate?` | [`SimplePrompt`](../modules.md#simpleprompt) |
+
+#### Inherited from
+
+[Refine](Refine.md).[constructor](Refine.md#constructor)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L78)
+
+## Properties
+
+### refineTemplate
+
+• **refineTemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Inherited from
+
+[Refine](Refine.md).[refineTemplate](Refine.md#refinetemplate)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L76)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Inherited from
+
+[Refine](Refine.md).[serviceContext](Refine.md#servicecontext)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L74)
+
+___
+
+### textQATemplate
+
+• **textQATemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Inherited from
+
+[Refine](Refine.md).[textQATemplate](Refine.md#textqatemplate)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L75)
+
+## Methods
+
+### getResponse
+
+▸ **getResponse**(`query`, `textChunks`, `parentEvent?`, `prevResponse?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `textChunks` | `string`[] |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+| `prevResponse?` | `string` |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Overrides
+
+[Refine](Refine.md).[getResponse](Refine.md#getresponse)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L181)

apps/docs/docs/api/classes/CondenseQuestionChatEngine.md

@@ -0,0 +1,148 @@
+---
+id: "CondenseQuestionChatEngine"
+title: "Class: CondenseQuestionChatEngine"
+sidebar_label: "CondenseQuestionChatEngine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+CondenseQuestionChatEngine is used in conjunction with a Index (for example VectorStoreIndex).
+It does two steps on taking a user's chat message: first, it condenses the chat message
+with the previous chat history into a question with more context.
+Then, it queries the underlying Index using the new question with context and returns
+the response.
+CondenseQuestionChatEngine performs well when the input is primarily questions about the
+underlying data. It performs less well when the chat messages are not questions about the
+data, or are very referential to previous context.
+
+## Implements
+
+- [`ChatEngine`](../interfaces/ChatEngine.md)
+
+## Constructors
+
+### constructor
+
+• **new CondenseQuestionChatEngine**(`init`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | `Object` |
+| `init.chatHistory` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+| `init.condenseMessagePrompt?` | [`SimplePrompt`](../modules.md#simpleprompt) |
+| `init.queryEngine` | [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) |
+| `init.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+
+#### Defined in
+
+[ChatEngine.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L75)
+
+## Properties
+
+### chatHistory
+
+• **chatHistory**: [`ChatMessage`](../interfaces/ChatMessage.md)[]
+
+#### Defined in
+
+[ChatEngine.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L71)
+
+___
+
+### condenseMessagePrompt
+
+• **condenseMessagePrompt**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Defined in
+
+[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L73)
+
+___
+
+### queryEngine
+
+• **queryEngine**: [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+#### Defined in
+
+[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L70)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Defined in
+
+[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L72)
+
+## Methods
+
+### chat
+
+▸ **chat**(`message`, `chatHistory?`): `Promise`<[`Response`](Response.md)\>
+
+Send message along with the class's current chat history to the LLM.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `message` | `string` |  |
+| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | optional chat history if you want to customize the chat history |
+
+#### Returns
+
+`Promise`<[`Response`](Response.md)\>
+
+#### Implementation of
+
+[ChatEngine](../interfaces/ChatEngine.md).[chat](../interfaces/ChatEngine.md#chat)
+
+#### Defined in
+
+[ChatEngine.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L100)
+
+___
+
+### condenseQuestion
+
+▸ `Private` **condenseQuestion**(`chatHistory`, `question`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `chatHistory` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+| `question` | `string` |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Defined in
+
+[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L89)
+
+___
+
+### reset
+
+▸ **reset**(): `void`
+
+Resets the chat history so that it's empty.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[ChatEngine](../interfaces/ChatEngine.md).[reset](../interfaces/ChatEngine.md#reset)
+
+#### Defined in
+
+[ChatEngine.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L118)

apps/docs/docs/api/classes/ContextChatEngine.md

@@ -0,0 +1,111 @@
+---
+id: "ContextChatEngine"
+title: "Class: ContextChatEngine"
+sidebar_label: "ContextChatEngine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+ContextChatEngine uses the Index to get the appropriate context for each query.
+The context is stored in the system prompt, and the chat history is preserved,
+ideally allowing the appropriate context to be surfaced for each query.
+
+## Implements
+
+- [`ChatEngine`](../interfaces/ChatEngine.md)
+
+## Constructors
+
+### constructor
+
+• **new ContextChatEngine**(`init`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | `Object` |
+| `init.chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+| `init.chatModel?` | [`OpenAI`](OpenAI.md) |
+| `init.retriever` | [`BaseRetriever`](../interfaces/BaseRetriever.md) |
+
+#### Defined in
+
+[ChatEngine.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L133)
+
+## Properties
+
+### chatHistory
+
+• **chatHistory**: [`ChatMessage`](../interfaces/ChatMessage.md)[]
+
+#### Defined in
+
+[ChatEngine.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L131)
+
+___
+
+### chatModel
+
+• **chatModel**: [`OpenAI`](OpenAI.md)
+
+#### Defined in
+
+[ChatEngine.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L130)
+
+___
+
+### retriever
+
+• **retriever**: [`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+#### Defined in
+
+[ChatEngine.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L129)
+
+## Methods
+
+### chat
+
+▸ **chat**(`message`, `chatHistory?`): `Promise`<[`Response`](Response.md)\>
+
+Send message along with the class's current chat history to the LLM.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `message` | `string` |  |
+| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | optional chat history if you want to customize the chat history |
+
+#### Returns
+
+`Promise`<[`Response`](Response.md)\>
+
+#### Implementation of
+
+[ChatEngine](../interfaces/ChatEngine.md).[chat](../interfaces/ChatEngine.md#chat)
+
+#### Defined in
+
+[ChatEngine.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L144)
+
+___
+
+### reset
+
+▸ **reset**(): `void`
+
+Resets the chat history so that it's empty.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[ChatEngine](../interfaces/ChatEngine.md).[reset](../interfaces/ChatEngine.md#reset)
+
+#### Defined in
+
+[ChatEngine.ts:182](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L182)

apps/docs/docs/api/classes/Document.md

@@ -0,0 +1,516 @@
+---
+id: "Document"
+title: "Class: Document"
+sidebar_label: "Document"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A document is just a special text node with a docId.
+
+## Hierarchy
+
+- [`TextNode`](TextNode.md)
+
+  ↳ **`Document`**
+
+## Constructors
+
+### constructor
+
+• **new Document**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`Document`](Document.md)\> |
+
+#### Overrides
+
+[TextNode](TextNode.md).[constructor](TextNode.md#constructor)
+
+#### Defined in
+
+[Node.ts:229](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L229)
+
+## Properties
+
+### embedding
+
+• `Optional` **embedding**: `number`[]
+
+#### Inherited from
+
+[TextNode](TextNode.md).[embedding](TextNode.md#embedding)
+
+#### Defined in
+
+[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L39)
+
+___
+
+### endCharIdx
+
+• `Optional` **endCharIdx**: `number`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[endCharIdx](TextNode.md#endcharidx)
+
+#### Defined in
+
+[Node.ts:147](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L147)
+
+___
+
+### excludedEmbedMetadataKeys
+
+• **excludedEmbedMetadataKeys**: `string`[] = `[]`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[excludedEmbedMetadataKeys](TextNode.md#excludedembedmetadatakeys)
+
+#### Defined in
+
+[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L43)
+
+___
+
+### excludedLlmMetadataKeys
+
+• **excludedLlmMetadataKeys**: `string`[] = `[]`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[excludedLlmMetadataKeys](TextNode.md#excludedllmmetadatakeys)
+
+#### Defined in
+
+[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L44)
+
+___
+
+### hash
+
+• **hash**: `string` = `""`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[hash](TextNode.md#hash)
+
+#### Defined in
+
+[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L46)
+
+___
+
+### id\_
+
+• **id\_**: `string`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[id_](TextNode.md#id_)
+
+#### Defined in
+
+[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L38)
+
+___
+
+### metadata
+
+• **metadata**: `Record`<`string`, `any`\> = `{}`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[metadata](TextNode.md#metadata)
+
+#### Defined in
+
+[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L42)
+
+___
+
+### metadataSeparator
+
+• **metadataSeparator**: `string` = `"\n"`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[metadataSeparator](TextNode.md#metadataseparator)
+
+#### Defined in
+
+[Node.ts:150](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L150)
+
+___
+
+### relationships
+
+• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../modules.md#relatednodetype)\>\> = `{}`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[relationships](TextNode.md#relationships)
+
+#### Defined in
+
+[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L45)
+
+___
+
+### startCharIdx
+
+• `Optional` **startCharIdx**: `number`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[startCharIdx](TextNode.md#startcharidx)
+
+#### Defined in
+
+[Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L146)
+
+___
+
+### text
+
+• **text**: `string` = `""`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[text](TextNode.md#text)
+
+#### Defined in
+
+[Node.ts:145](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L145)
+
+## Accessors
+
+### childNodes
+
+• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
+
+#### Inherited from
+
+TextNode.childNodes
+
+#### Defined in
+
+[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L104)
+
+___
+
+### docId
+
+• `get` **docId**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[Node.ts:238](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L238)
+
+___
+
+### nextNode
+
+• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Inherited from
+
+TextNode.nextNode
+
+#### Defined in
+
+[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L84)
+
+___
+
+### nodeId
+
+• `get` **nodeId**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+TextNode.nodeId
+
+#### Defined in
+
+[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L58)
+
+___
+
+### parentNode
+
+• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Inherited from
+
+TextNode.parentNode
+
+#### Defined in
+
+[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L94)
+
+___
+
+### prevNode
+
+• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Inherited from
+
+TextNode.prevNode
+
+#### Defined in
+
+[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L72)
+
+___
+
+### sourceNode
+
+• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Inherited from
+
+TextNode.sourceNode
+
+#### Defined in
+
+[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L62)
+
+## Methods
+
+### asRelatedNodeInfo
+
+▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Inherited from
+
+[TextNode](TextNode.md).[asRelatedNodeInfo](TextNode.md#asrelatednodeinfo)
+
+#### Defined in
+
+[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L124)
+
+___
+
+### generateHash
+
+▸ **generateHash**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[generateHash](TextNode.md#generatehash)
+
+#### Defined in
+
+[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L157)
+
+___
+
+### getContent
+
+▸ **getContent**(`metadataMode?`): `string`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` |
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[getContent](TextNode.md#getcontent)
+
+#### Defined in
+
+[Node.ts:165](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L165)
+
+___
+
+### getEmbedding
+
+▸ **getEmbedding**(): `number`[]
+
+#### Returns
+
+`number`[]
+
+#### Inherited from
+
+[TextNode](TextNode.md).[getEmbedding](TextNode.md#getembedding)
+
+#### Defined in
+
+[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L116)
+
+___
+
+### getMetadataStr
+
+▸ **getMetadataStr**(`metadataMode`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[getMetadataStr](TextNode.md#getmetadatastr)
+
+#### Defined in
+
+[Node.ts:170](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L170)
+
+___
+
+### getNodeInfo
+
+▸ **getNodeInfo**(): `Object`
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `end` | `undefined` \| `number` |
+| `start` | `undefined` \| `number` |
+
+#### Inherited from
+
+[TextNode](TextNode.md).[getNodeInfo](TextNode.md#getnodeinfo)
+
+#### Defined in
+
+[Node.ts:195](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L195)
+
+___
+
+### getText
+
+▸ **getText**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[getText](TextNode.md#gettext)
+
+#### Defined in
+
+[Node.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L199)
+
+___
+
+### getType
+
+▸ **getType**(): [`ObjectType`](../enums/ObjectType.md)
+
+#### Returns
+
+[`ObjectType`](../enums/ObjectType.md)
+
+#### Overrides
+
+[TextNode](TextNode.md).[getType](TextNode.md#gettype)
+
+#### Defined in
+
+[Node.ts:234](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L234)
+
+___
+
+### setContent
+
+▸ **setContent**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `string` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[setContent](TextNode.md#setcontent)
+
+#### Defined in
+
+[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L191)
+
+___
+
+### toJSON
+
+▸ **toJSON**(): `Record`<`string`, `any`\>
+
+Used with built in JSON.stringify
+
+#### Returns
+
+`Record`<`string`, `any`\>
+
+#### Inherited from
+
+[TextNode](TextNode.md).[toJSON](TextNode.md#tojson)
+
+#### Defined in
+
+[Node.ts:136](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L136)

apps/docs/docs/api/classes/InMemoryFileSystem.md

@@ -0,0 +1,129 @@
+---
+id: "InMemoryFileSystem"
+title: "Class: InMemoryFileSystem"
+sidebar_label: "InMemoryFileSystem"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A filesystem implementation that stores files in memory.
+
+## Implements
+
+- [`GenericFileSystem`](../interfaces/GenericFileSystem.md)
+
+## Constructors
+
+### constructor
+
+• **new InMemoryFileSystem**()
+
+## Properties
+
+### files
+
+• `Private` **files**: `Record`<`string`, `any`\> = `{}`
+
+#### Defined in
+
+[storage/FileSystem.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L25)
+
+## Methods
+
+### access
+
+▸ **access**(`path`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Implementation of
+
+[GenericFileSystem](../interfaces/GenericFileSystem.md).[access](../interfaces/GenericFileSystem.md#access)
+
+#### Defined in
+
+[storage/FileSystem.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L38)
+
+___
+
+### mkdir
+
+▸ **mkdir**(`path`, `options?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+| `options?` | `any` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Implementation of
+
+[GenericFileSystem](../interfaces/GenericFileSystem.md).[mkdir](../interfaces/GenericFileSystem.md#mkdir)
+
+#### Defined in
+
+[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L44)
+
+___
+
+### readFile
+
+▸ **readFile**(`path`, `options?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+| `options?` | `any` |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Implementation of
+
+[GenericFileSystem](../interfaces/GenericFileSystem.md).[readFile](../interfaces/GenericFileSystem.md#readfile)
+
+#### Defined in
+
+[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L31)
+
+___
+
+### writeFile
+
+▸ **writeFile**(`path`, `content`, `options?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+| `content` | `string` |
+| `options?` | `any` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Implementation of
+
+[GenericFileSystem](../interfaces/GenericFileSystem.md).[writeFile](../interfaces/GenericFileSystem.md#writefile)
+
+#### Defined in
+
+[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L27)

apps/docs/docs/api/classes/IndexDict.md

@@ -0,0 +1,151 @@
+---
+id: "IndexDict"
+title: "Class: IndexDict"
+sidebar_label: "IndexDict"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+The underlying structure of each index.
+
+## Hierarchy
+
+- [`IndexStruct`](IndexStruct.md)
+
+  ↳ **`IndexDict`**
+
+## Constructors
+
+### constructor
+
+• **new IndexDict**(`indexId?`, `summary?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `indexId` | `string` | `undefined` |
+| `summary` | `undefined` | `undefined` |
+
+#### Inherited from
+
+[IndexStruct](IndexStruct.md).[constructor](IndexStruct.md#constructor)
+
+#### Defined in
+
+[indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L19)
+
+## Properties
+
+### docStore
+
+• **docStore**: `Record`<`string`, [`Document`](Document.md)\> = `{}`
+
+#### Defined in
+
+[indices/BaseIndex.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L46)
+
+___
+
+### indexId
+
+• **indexId**: `string`
+
+#### Inherited from
+
+[IndexStruct](IndexStruct.md).[indexId](IndexStruct.md#indexid)
+
+#### Defined in
+
+[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L16)
+
+___
+
+### nodesDict
+
+• **nodesDict**: `Record`<`string`, [`BaseNode`](BaseNode.md)\> = `{}`
+
+#### Defined in
+
+[indices/BaseIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L45)
+
+___
+
+### summary
+
+• `Optional` **summary**: `string`
+
+#### Inherited from
+
+[IndexStruct](IndexStruct.md).[summary](IndexStruct.md#summary)
+
+#### Defined in
+
+[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L17)
+
+___
+
+### type
+
+• **type**: [`IndexStructType`](../enums/IndexStructType.md) = `IndexStructType.SIMPLE_DICT`
+
+#### Defined in
+
+[indices/BaseIndex.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L47)
+
+## Methods
+
+### addNode
+
+▸ **addNode**(`node`, `textId?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `node` | [`BaseNode`](BaseNode.md) |
+| `textId?` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[indices/BaseIndex.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L56)
+
+___
+
+### getSummary
+
+▸ **getSummary**(): `string`
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[IndexStruct](IndexStruct.md).[getSummary](IndexStruct.md#getsummary)
+
+#### Defined in
+
+[indices/BaseIndex.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L49)
+
+___
+
+### toJson
+
+▸ **toJson**(): `Record`<`string`, `unknown`\>
+
+#### Returns
+
+`Record`<`string`, `unknown`\>
+
+#### Overrides
+
+[IndexStruct](IndexStruct.md).[toJson](IndexStruct.md#tojson)
+
+#### Defined in
+
+[indices/BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L61)

apps/docs/docs/api/classes/IndexList.md

@@ -0,0 +1,140 @@
+---
+id: "IndexList"
+title: "Class: IndexList"
+sidebar_label: "IndexList"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+The underlying structure of each index.
+
+## Hierarchy
+
+- [`IndexStruct`](IndexStruct.md)
+
+  ↳ **`IndexList`**
+
+## Constructors
+
+### constructor
+
+• **new IndexList**(`indexId?`, `summary?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `indexId` | `string` | `undefined` |
+| `summary` | `undefined` | `undefined` |
+
+#### Inherited from
+
+[IndexStruct](IndexStruct.md).[constructor](IndexStruct.md#constructor)
+
+#### Defined in
+
+[indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L19)
+
+## Properties
+
+### indexId
+
+• **indexId**: `string`
+
+#### Inherited from
+
+[IndexStruct](IndexStruct.md).[indexId](IndexStruct.md#indexid)
+
+#### Defined in
+
+[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L16)
+
+___
+
+### nodes
+
+• **nodes**: `string`[] = `[]`
+
+#### Defined in
+
+[indices/BaseIndex.ts:90](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L90)
+
+___
+
+### summary
+
+• `Optional` **summary**: `string`
+
+#### Inherited from
+
+[IndexStruct](IndexStruct.md).[summary](IndexStruct.md#summary)
+
+#### Defined in
+
+[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L17)
+
+___
+
+### type
+
+• **type**: [`IndexStructType`](../enums/IndexStructType.md) = `IndexStructType.LIST`
+
+#### Defined in
+
+[indices/BaseIndex.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L91)
+
+## Methods
+
+### addNode
+
+▸ **addNode**(`node`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `node` | [`BaseNode`](BaseNode.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[indices/BaseIndex.ts:93](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L93)
+
+___
+
+### getSummary
+
+▸ **getSummary**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[IndexStruct](IndexStruct.md).[getSummary](IndexStruct.md#getsummary)
+
+#### Defined in
+
+[indices/BaseIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L31)
+
+___
+
+### toJson
+
+▸ **toJson**(): `Record`<`string`, `unknown`\>
+
+#### Returns
+
+`Record`<`string`, `unknown`\>
+
+#### Overrides
+
+[IndexStruct](IndexStruct.md).[toJson](IndexStruct.md#tojson)
+
+#### Defined in
+
+[indices/BaseIndex.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L97)

apps/docs/docs/api/classes/IndexNode.md

@@ -0,0 +1,512 @@
+---
+id: "IndexNode"
+title: "Class: IndexNode"
+sidebar_label: "IndexNode"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+TextNode is the default node type for text. Most common node type in LlamaIndex.TS
+
+## Hierarchy
+
+- [`TextNode`](TextNode.md)
+
+  ↳ **`IndexNode`**
+
+## Constructors
+
+### constructor
+
+• **new IndexNode**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`IndexNode`](IndexNode.md)\> |
+
+#### Overrides
+
+[TextNode](TextNode.md).[constructor](TextNode.md#constructor)
+
+#### Defined in
+
+[Node.ts:215](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L215)
+
+## Properties
+
+### embedding
+
+• `Optional` **embedding**: `number`[]
+
+#### Inherited from
+
+[TextNode](TextNode.md).[embedding](TextNode.md#embedding)
+
+#### Defined in
+
+[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L39)
+
+___
+
+### endCharIdx
+
+• `Optional` **endCharIdx**: `number`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[endCharIdx](TextNode.md#endcharidx)
+
+#### Defined in
+
+[Node.ts:147](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L147)
+
+___
+
+### excludedEmbedMetadataKeys
+
+• **excludedEmbedMetadataKeys**: `string`[] = `[]`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[excludedEmbedMetadataKeys](TextNode.md#excludedembedmetadatakeys)
+
+#### Defined in
+
+[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L43)
+
+___
+
+### excludedLlmMetadataKeys
+
+• **excludedLlmMetadataKeys**: `string`[] = `[]`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[excludedLlmMetadataKeys](TextNode.md#excludedllmmetadatakeys)
+
+#### Defined in
+
+[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L44)
+
+___
+
+### hash
+
+• **hash**: `string` = `""`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[hash](TextNode.md#hash)
+
+#### Defined in
+
+[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L46)
+
+___
+
+### id\_
+
+• **id\_**: `string`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[id_](TextNode.md#id_)
+
+#### Defined in
+
+[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L38)
+
+___
+
+### indexId
+
+• **indexId**: `string` = `""`
+
+#### Defined in
+
+[Node.ts:213](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L213)
+
+___
+
+### metadata
+
+• **metadata**: `Record`<`string`, `any`\> = `{}`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[metadata](TextNode.md#metadata)
+
+#### Defined in
+
+[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L42)
+
+___
+
+### metadataSeparator
+
+• **metadataSeparator**: `string` = `"\n"`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[metadataSeparator](TextNode.md#metadataseparator)
+
+#### Defined in
+
+[Node.ts:150](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L150)
+
+___
+
+### relationships
+
+• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../modules.md#relatednodetype)\>\> = `{}`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[relationships](TextNode.md#relationships)
+
+#### Defined in
+
+[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L45)
+
+___
+
+### startCharIdx
+
+• `Optional` **startCharIdx**: `number`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[startCharIdx](TextNode.md#startcharidx)
+
+#### Defined in
+
+[Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L146)
+
+___
+
+### text
+
+• **text**: `string` = `""`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[text](TextNode.md#text)
+
+#### Defined in
+
+[Node.ts:145](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L145)
+
+## Accessors
+
+### childNodes
+
+• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
+
+#### Inherited from
+
+TextNode.childNodes
+
+#### Defined in
+
+[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L104)
+
+___
+
+### nextNode
+
+• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Inherited from
+
+TextNode.nextNode
+
+#### Defined in
+
+[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L84)
+
+___
+
+### nodeId
+
+• `get` **nodeId**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+TextNode.nodeId
+
+#### Defined in
+
+[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L58)
+
+___
+
+### parentNode
+
+• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Inherited from
+
+TextNode.parentNode
+
+#### Defined in
+
+[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L94)
+
+___
+
+### prevNode
+
+• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Inherited from
+
+TextNode.prevNode
+
+#### Defined in
+
+[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L72)
+
+___
+
+### sourceNode
+
+• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Inherited from
+
+TextNode.sourceNode
+
+#### Defined in
+
+[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L62)
+
+## Methods
+
+### asRelatedNodeInfo
+
+▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Inherited from
+
+[TextNode](TextNode.md).[asRelatedNodeInfo](TextNode.md#asrelatednodeinfo)
+
+#### Defined in
+
+[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L124)
+
+___
+
+### generateHash
+
+▸ **generateHash**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[generateHash](TextNode.md#generatehash)
+
+#### Defined in
+
+[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L157)
+
+___
+
+### getContent
+
+▸ **getContent**(`metadataMode?`): `string`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` |
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[getContent](TextNode.md#getcontent)
+
+#### Defined in
+
+[Node.ts:165](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L165)
+
+___
+
+### getEmbedding
+
+▸ **getEmbedding**(): `number`[]
+
+#### Returns
+
+`number`[]
+
+#### Inherited from
+
+[TextNode](TextNode.md).[getEmbedding](TextNode.md#getembedding)
+
+#### Defined in
+
+[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L116)
+
+___
+
+### getMetadataStr
+
+▸ **getMetadataStr**(`metadataMode`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[getMetadataStr](TextNode.md#getmetadatastr)
+
+#### Defined in
+
+[Node.ts:170](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L170)
+
+___
+
+### getNodeInfo
+
+▸ **getNodeInfo**(): `Object`
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `end` | `undefined` \| `number` |
+| `start` | `undefined` \| `number` |
+
+#### Inherited from
+
+[TextNode](TextNode.md).[getNodeInfo](TextNode.md#getnodeinfo)
+
+#### Defined in
+
+[Node.ts:195](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L195)
+
+___
+
+### getText
+
+▸ **getText**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[getText](TextNode.md#gettext)
+
+#### Defined in
+
+[Node.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L199)
+
+___
+
+### getType
+
+▸ **getType**(): [`ObjectType`](../enums/ObjectType.md)
+
+#### Returns
+
+[`ObjectType`](../enums/ObjectType.md)
+
+#### Overrides
+
+[TextNode](TextNode.md).[getType](TextNode.md#gettype)
+
+#### Defined in
+
+[Node.ts:220](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L220)
+
+___
+
+### setContent
+
+▸ **setContent**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `string` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[TextNode](TextNode.md).[setContent](TextNode.md#setcontent)
+
+#### Defined in
+
+[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L191)
+
+___
+
+### toJSON
+
+▸ **toJSON**(): `Record`<`string`, `any`\>
+
+Used with built in JSON.stringify
+
+#### Returns
+
+`Record`<`string`, `any`\>
+
+#### Inherited from
+
+[TextNode](TextNode.md).[toJSON](TextNode.md#tojson)
+
+#### Defined in
+
+[Node.ts:136](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L136)

apps/docs/docs/api/classes/IndexStruct.md

@@ -0,0 +1,82 @@
+---
+id: "IndexStruct"
+title: "Class: IndexStruct"
+sidebar_label: "IndexStruct"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+The underlying structure of each index.
+
+## Hierarchy
+
+- **`IndexStruct`**
+
+  ↳ [`IndexDict`](IndexDict.md)
+
+  ↳ [`IndexList`](IndexList.md)
+
+## Constructors
+
+### constructor
+
+• **new IndexStruct**(`indexId?`, `summary?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `indexId` | `string` | `undefined` |
+| `summary` | `undefined` | `undefined` |
+
+#### Defined in
+
+[indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L19)
+
+## Properties
+
+### indexId
+
+• **indexId**: `string`
+
+#### Defined in
+
+[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L16)
+
+___
+
+### summary
+
+• `Optional` **summary**: `string`
+
+#### Defined in
+
+[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L17)
+
+## Methods
+
+### getSummary
+
+▸ **getSummary**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[indices/BaseIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L31)
+
+___
+
+### toJson
+
+▸ **toJson**(): `Record`<`string`, `unknown`\>
+
+#### Returns
+
+`Record`<`string`, `unknown`\>
+
+#### Defined in
+
+[indices/BaseIndex.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L24)

apps/docs/docs/api/classes/LLMQuestionGenerator.md

@@ -0,0 +1,84 @@
+---
+id: "LLMQuestionGenerator"
+title: "Class: LLMQuestionGenerator"
+sidebar_label: "LLMQuestionGenerator"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+LLMQuestionGenerator uses the LLM to generate new questions for the LLM using tools and a user query.
+
+## Implements
+
+- [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md)
+
+## Constructors
+
+### constructor
+
+• **new LLMQuestionGenerator**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`LLMQuestionGenerator`](LLMQuestionGenerator.md)\> |
+
+#### Defined in
+
+[QuestionGenerator.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QuestionGenerator.ts#L34)
+
+## Properties
+
+### llm
+
+• **llm**: [`LLM`](../interfaces/LLM.md)
+
+#### Defined in
+
+[QuestionGenerator.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QuestionGenerator.ts#L30)
+
+___
+
+### outputParser
+
+• **outputParser**: [`BaseOutputParser`](../interfaces/BaseOutputParser.md)<[`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>\>
+
+#### Defined in
+
+[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QuestionGenerator.ts#L32)
+
+___
+
+### prompt
+
+• **prompt**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Defined in
+
+[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QuestionGenerator.ts#L31)
+
+## Methods
+
+### generate
+
+▸ **generate**(`tools`, `query`): `Promise`<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `tools` | [`ToolMetadata`](../interfaces/ToolMetadata.md)[] |
+| `query` | `string` |
+
+#### Returns
+
+`Promise`<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>
+
+#### Implementation of
+
+[BaseQuestionGenerator](../interfaces/BaseQuestionGenerator.md).[generate](../interfaces/BaseQuestionGenerator.md#generate)
+
+#### Defined in
+
+[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QuestionGenerator.ts#L40)

apps/docs/docs/api/classes/ListIndex.md

@@ -0,0 +1,294 @@
+---
+id: "ListIndex"
+title: "Class: ListIndex"
+sidebar_label: "ListIndex"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A ListIndex keeps nodes in a sequential list structure
+
+## Hierarchy
+
+- [`BaseIndex`](BaseIndex.md)<[`IndexList`](IndexList.md)\>
+
+  ↳ **`ListIndex`**
+
+## Constructors
+
+### constructor
+
+• **new ListIndex**(`init`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | [`BaseIndexInit`](../interfaces/BaseIndexInit.md)<[`IndexList`](IndexList.md)\> |
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[constructor](BaseIndex.md#constructor)
+
+#### Defined in
+
+[indices/list/ListIndex.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L43)
+
+## Properties
+
+### docStore
+
+• **docStore**: `BaseDocumentStore`
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[docStore](BaseIndex.md#docstore)
+
+#### Defined in
+
+[indices/BaseIndex.ts:122](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L122)
+
+___
+
+### indexStore
+
+• `Optional` **indexStore**: `BaseIndexStore`
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[indexStore](BaseIndex.md#indexstore)
+
+#### Defined in
+
+[indices/BaseIndex.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L124)
+
+___
+
+### indexStruct
+
+• **indexStruct**: [`IndexList`](IndexList.md)
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[indexStruct](BaseIndex.md#indexstruct)
+
+#### Defined in
+
+[indices/BaseIndex.ts:125](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L125)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[serviceContext](BaseIndex.md#servicecontext)
+
+#### Defined in
+
+[indices/BaseIndex.ts:120](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L120)
+
+___
+
+### storageContext
+
+• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md)
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[storageContext](BaseIndex.md#storagecontext)
+
+#### Defined in
+
+[indices/BaseIndex.ts:121](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L121)
+
+___
+
+### vectorStore
+
+• `Optional` **vectorStore**: [`VectorStore`](../interfaces/VectorStore.md)
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[vectorStore](BaseIndex.md#vectorstore)
+
+#### Defined in
+
+[indices/BaseIndex.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L123)
+
+## Methods
+
+### \_deleteNode
+
+▸ `Protected` **_deleteNode**(`nodeId`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `nodeId` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[indices/list/ListIndex.ts:193](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L193)
+
+___
+
+### \_insert
+
+▸ `Protected` **_insert**(`nodes`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `nodes` | [`BaseNode`](BaseNode.md)[] |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[indices/list/ListIndex.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L187)
+
+___
+
+### asQueryEngine
+
+▸ **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+Create a new query engine from the index. It will also create a retriever
+and response synthezier if they are not provided.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer |
+| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - |
+| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - |
+
+#### Returns
+
+[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[asQueryEngine](BaseIndex.md#asqueryengine)
+
+#### Defined in
+
+[indices/list/ListIndex.ts:151](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L151)
+
+___
+
+### asRetriever
+
+▸ **asRetriever**(`options?`): [`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+Create a new retriever from the index.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options?` | `Object` |
+| `options.mode` | [`ListRetrieverMode`](../enums/ListRetrieverMode.md) |
+
+#### Returns
+
+[`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[asRetriever](BaseIndex.md#asretriever)
+
+#### Defined in
+
+[indices/list/ListIndex.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L138)
+
+___
+
+### getRefDocInfo
+
+▸ **getRefDocInfo**(): `Promise`<`Record`<`string`, `RefDocInfo`\>\>
+
+#### Returns
+
+`Promise`<`Record`<`string`, `RefDocInfo`\>\>
+
+#### Defined in
+
+[indices/list/ListIndex.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L199)
+
+___
+
+### \_buildIndexFromNodes
+
+▸ `Static` **_buildIndexFromNodes**(`nodes`, `docStore`, `indexStruct?`): `Promise`<[`IndexList`](IndexList.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `nodes` | [`BaseNode`](BaseNode.md)[] |
+| `docStore` | `BaseDocumentStore` |
+| `indexStruct?` | [`IndexList`](IndexList.md) |
+
+#### Returns
+
+`Promise`<[`IndexList`](IndexList.md)\>
+
+#### Defined in
+
+[indices/list/ListIndex.ts:172](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L172)
+
+___
+
+### fromDocuments
+
+▸ `Static` **fromDocuments**(`documents`, `args?`): `Promise`<[`ListIndex`](ListIndex.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `documents` | [`Document`](Document.md)[] |
+| `args` | `Object` |
+| `args.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+| `args.storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) |
+
+#### Returns
+
+`Promise`<[`ListIndex`](ListIndex.md)\>
+
+#### Defined in
+
+[indices/list/ListIndex.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L112)
+
+___
+
+### init
+
+▸ `Static` **init**(`options`): `Promise`<[`ListIndex`](ListIndex.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | `ListIndexOptions` |
+
+#### Returns
+
+`Promise`<[`ListIndex`](ListIndex.md)\>
+
+#### Defined in
+
+[indices/list/ListIndex.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L47)

apps/docs/docs/api/classes/ListIndexLLMRetriever.md

@@ -0,0 +1,137 @@
+---
+id: "ListIndexLLMRetriever"
+title: "Class: ListIndexLLMRetriever"
+sidebar_label: "ListIndexLLMRetriever"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+LLM retriever for ListIndex.
+
+## Implements
+
+- [`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+## Constructors
+
+### constructor
+
+• **new ListIndexLLMRetriever**(`index`, `choiceSelectPrompt?`, `choiceBatchSize?`, `formatNodeBatchFn?`, `parseChoiceSelectAnswerFn?`, `serviceContext?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `index` | [`ListIndex`](ListIndex.md) | `undefined` |
+| `choiceSelectPrompt?` | [`SimplePrompt`](../modules.md#simpleprompt) | `undefined` |
+| `choiceBatchSize` | `number` | `10` |
+| `formatNodeBatchFn?` | `NodeFormatterFunction` | `undefined` |
+| `parseChoiceSelectAnswerFn?` | `ChoiceSelectParserFunction` | `undefined` |
+| `serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | `undefined` |
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L64)
+
+## Properties
+
+### choiceBatchSize
+
+• **choiceBatchSize**: `number`
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L59)
+
+___
+
+### choiceSelectPrompt
+
+• **choiceSelectPrompt**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L58)
+
+___
+
+### formatNodeBatchFn
+
+• **formatNodeBatchFn**: `NodeFormatterFunction`
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L60)
+
+___
+
+### index
+
+• **index**: [`ListIndex`](ListIndex.md)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L57)
+
+___
+
+### parseChoiceSelectAnswerFn
+
+• **parseChoiceSelectAnswerFn**: `ChoiceSelectParserFunction`
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L61)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L62)
+
+## Methods
+
+### getServiceContext
+
+▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Returns
+
+[`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Implementation of
+
+[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L127)
+
+___
+
+### retrieve
+
+▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\>
+
+#### Implementation of
+
+[BaseRetriever](../interfaces/BaseRetriever.md).[retrieve](../interfaces/BaseRetriever.md#retrieve)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L81)

apps/docs/docs/api/classes/ListIndexRetriever.md

@@ -0,0 +1,82 @@
+---
+id: "ListIndexRetriever"
+title: "Class: ListIndexRetriever"
+sidebar_label: "ListIndexRetriever"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Simple retriever for ListIndex that returns all nodes
+
+## Implements
+
+- [`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+## Constructors
+
+### constructor
+
+• **new ListIndexRetriever**(`index`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `index` | [`ListIndex`](ListIndex.md) |
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L22)
+
+## Properties
+
+### index
+
+• **index**: [`ListIndex`](ListIndex.md)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L20)
+
+## Methods
+
+### getServiceContext
+
+▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Returns
+
+[`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Implementation of
+
+[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L48)
+
+___
+
+### retrieve
+
+▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\>
+
+#### Implementation of
+
+[BaseRetriever](../interfaces/BaseRetriever.md).[retrieve](../interfaces/BaseRetriever.md#retrieve)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L26)

apps/docs/docs/api/classes/LlamaDeuce.md

@@ -0,0 +1,224 @@
+---
+id: "LlamaDeuce"
+title: "Class: LlamaDeuce"
+sidebar_label: "LlamaDeuce"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Llama2 LLM implementation
+
+## Implements
+
+- [`LLM`](../interfaces/LLM.md)
+
+## Constructors
+
+### constructor
+
+• **new LlamaDeuce**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`LlamaDeuce`](LlamaDeuce.md)\> |
+
+#### Defined in
+
+[llm/LLM.ts:242](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L242)
+
+## Properties
+
+### chatStrategy
+
+• **chatStrategy**: [`DeuceChatStrategy`](../enums/DeuceChatStrategy.md)
+
+#### Defined in
+
+[llm/LLM.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L236)
+
+___
+
+### maxTokens
+
+• `Optional` **maxTokens**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L239)
+
+___
+
+### model
+
+• **model**: ``"Llama-2-70b-chat"`` \| ``"Llama-2-13b-chat"`` \| ``"Llama-2-7b-chat"``
+
+#### Defined in
+
+[llm/LLM.ts:235](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L235)
+
+___
+
+### replicateSession
+
+• **replicateSession**: `ReplicateSession`
+
+#### Defined in
+
+[llm/LLM.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L240)
+
+___
+
+### temperature
+
+• **temperature**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:237](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L237)
+
+___
+
+### topP
+
+• **topP**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:238](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L238)
+
+## Methods
+
+### chat
+
+▸ **chat**(`messages`, `_parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+Get a chat response from the LLM
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+| `_parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Implementation of
+
+[LLM](../interfaces/LLM.md).[chat](../interfaces/LLM.md#chat)
+
+#### Defined in
+
+[llm/LLM.ts:333](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L333)
+
+___
+
+### complete
+
+▸ **complete**(`prompt`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+Get a prompt completion from the LLM
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `prompt` | `string` | the prompt to complete |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) | - |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Implementation of
+
+[LLM](../interfaces/LLM.md).[complete](../interfaces/LLM.md#complete)
+
+#### Defined in
+
+[llm/LLM.ts:360](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L360)
+
+___
+
+### mapMessageTypeA16Z
+
+▸ **mapMessageTypeA16Z**(`messageType`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messageType` | [`MessageType`](../modules.md#messagetype) |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[llm/LLM.ts:274](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L274)
+
+___
+
+### mapMessagesToPrompt
+
+▸ **mapMessagesToPrompt**(`messages`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[llm/LLM.ts:251](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L251)
+
+___
+
+### mapMessagesToPromptA16Z
+
+▸ **mapMessagesToPromptA16Z**(`messages`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[llm/LLM.ts:263](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L263)
+
+___
+
+### mapMessagesToPromptMeta
+
+▸ **mapMessagesToPromptMeta**(`messages`, `withBos?`): `string`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | `undefined` |
+| `withBos` | `boolean` | `false` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[llm/LLM.ts:287](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L287)

apps/docs/docs/api/classes/OpenAI.md

@@ -0,0 +1,193 @@
+---
+id: "OpenAI"
+title: "Class: OpenAI"
+sidebar_label: "OpenAI"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+OpenAI LLM implementation
+
+## Implements
+
+- [`LLM`](../interfaces/LLM.md)
+
+## Constructors
+
+### constructor
+
+• **new OpenAI**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`OpenAI`](OpenAI.md)\> & { `azure?`: `AzureOpenAIConfig`  } |
+
+#### Defined in
+
+[llm/LLM.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L94)
+
+## Properties
+
+### apiKey
+
+• `Optional` **apiKey**: `string` = `undefined`
+
+#### Defined in
+
+[llm/LLM.ts:87](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L87)
+
+___
+
+### callbackManager
+
+• `Optional` **callbackManager**: [`CallbackManager`](CallbackManager.md)
+
+#### Defined in
+
+[llm/LLM.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L92)
+
+___
+
+### maxRetries
+
+• **maxRetries**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L88)
+
+___
+
+### maxTokens
+
+• `Optional` **maxTokens**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L84)
+
+___
+
+### model
+
+• **model**: ``"gpt-3.5-turbo"`` \| ``"gpt-3.5-turbo-16k"`` \| ``"gpt-4"`` \| ``"gpt-4-32k"``
+
+#### Defined in
+
+[llm/LLM.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L81)
+
+___
+
+### session
+
+• **session**: `OpenAISession`
+
+#### Defined in
+
+[llm/LLM.ts:90](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L90)
+
+___
+
+### temperature
+
+• **temperature**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L82)
+
+___
+
+### timeout
+
+• `Optional` **timeout**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L89)
+
+___
+
+### topP
+
+• **topP**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:83](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L83)
+
+## Methods
+
+### chat
+
+▸ **chat**(`messages`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+Get a chat response from the LLM
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Implementation of
+
+[LLM](../interfaces/LLM.md).[chat](../interfaces/LLM.md#chat)
+
+#### Defined in
+
+[llm/LLM.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L157)
+
+___
+
+### complete
+
+▸ **complete**(`prompt`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+Get a prompt completion from the LLM
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `prompt` | `string` | the prompt to complete |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) | - |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Implementation of
+
+[LLM](../interfaces/LLM.md).[complete](../interfaces/LLM.md#complete)
+
+#### Defined in
+
+[llm/LLM.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L197)
+
+___
+
+### mapMessageType
+
+▸ **mapMessageType**(`messageType`): ``"function"`` \| ``"user"`` \| ``"assistant"`` \| ``"system"``
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messageType` | [`MessageType`](../modules.md#messagetype) |
+
+#### Returns
+
+``"function"`` \| ``"user"`` \| ``"assistant"`` \| ``"system"``
+
+#### Defined in
+
+[llm/LLM.ts:140](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L140)

apps/docs/docs/api/classes/OpenAIEmbedding.md

@@ -0,0 +1,177 @@
+---
+id: "OpenAIEmbedding"
+title: "Class: OpenAIEmbedding"
+sidebar_label: "OpenAIEmbedding"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Hierarchy
+
+- [`BaseEmbedding`](BaseEmbedding.md)
+
+  ↳ **`OpenAIEmbedding`**
+
+## Constructors
+
+### constructor
+
+• **new OpenAIEmbedding**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`OpenAIEmbedding`](OpenAIEmbedding.md)\> & { `azure?`: `AzureOpenAIConfig`  } |
+
+#### Overrides
+
+[BaseEmbedding](BaseEmbedding.md).[constructor](BaseEmbedding.md#constructor)
+
+#### Defined in
+
+[Embedding.ts:229](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L229)
+
+## Properties
+
+### apiKey
+
+• `Optional` **apiKey**: `string` = `undefined`
+
+#### Defined in
+
+[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L224)
+
+___
+
+### maxRetries
+
+• **maxRetries**: `number`
+
+#### Defined in
+
+[Embedding.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L225)
+
+___
+
+### model
+
+• **model**: `TEXT_EMBED_ADA_002`
+
+#### Defined in
+
+[Embedding.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L221)
+
+___
+
+### session
+
+• **session**: `OpenAISession`
+
+#### Defined in
+
+[Embedding.ts:227](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L227)
+
+___
+
+### timeout
+
+• `Optional` **timeout**: `number`
+
+#### Defined in
+
+[Embedding.ts:226](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L226)
+
+## Methods
+
+### getOpenAIEmbedding
+
+▸ `Private` **getOpenAIEmbedding**(`input`): `Promise`<`number`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `input` | `string` |
+
+#### Returns
+
+`Promise`<`number`[]\>
+
+#### Defined in
+
+[Embedding.ts:270](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L270)
+
+___
+
+### getQueryEmbedding
+
+▸ **getQueryEmbedding**(`query`): `Promise`<`number`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+
+#### Returns
+
+`Promise`<`number`[]\>
+
+#### Overrides
+
+[BaseEmbedding](BaseEmbedding.md).[getQueryEmbedding](BaseEmbedding.md#getqueryembedding)
+
+#### Defined in
+
+[Embedding.ts:286](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L286)
+
+___
+
+### getTextEmbedding
+
+▸ **getTextEmbedding**(`text`): `Promise`<`number`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `text` | `string` |
+
+#### Returns
+
+`Promise`<`number`[]\>
+
+#### Overrides
+
+[BaseEmbedding](BaseEmbedding.md).[getTextEmbedding](BaseEmbedding.md#gettextembedding)
+
+#### Defined in
+
+[Embedding.ts:282](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L282)
+
+___
+
+### similarity
+
+▸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `embedding1` | `number`[] | `undefined` |
+| `embedding2` | `number`[] | `undefined` |
+| `mode` | [`SimilarityType`](../enums/SimilarityType.md) | `SimilarityType.DEFAULT` |
+
+#### Returns
+
+`number`
+
+#### Inherited from
+
+[BaseEmbedding](BaseEmbedding.md).[similarity](BaseEmbedding.md#similarity)
+
+#### Defined in
+
+[Embedding.ts:204](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L204)

apps/docs/docs/api/classes/PDFReader.md

@@ -0,0 +1,44 @@
+---
+id: "PDFReader"
+title: "Class: PDFReader"
+sidebar_label: "PDFReader"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Read the text of a PDF
+
+## Implements
+
+- [`BaseReader`](../interfaces/BaseReader.md)
+
+## Constructors
+
+### constructor
+
+• **new PDFReader**()
+
+## Methods
+
+### loadData
+
+▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)[]\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `file` | `string` | `undefined` |
+| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` |
+
+#### Returns
+
+`Promise`<[`Document`](Document.md)[]\>
+
+#### Implementation of
+
+[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata)
+
+#### Defined in
+
+[readers/PDFReader.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/PDFReader.ts#L11)

apps/docs/docs/api/classes/Refine.md

@@ -0,0 +1,139 @@
+---
+id: "Refine"
+title: "Class: Refine"
+sidebar_label: "Refine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A response builder that uses the query to ask the LLM generate a better response using multiple text chunks.
+
+## Hierarchy
+
+- **`Refine`**
+
+  ↳ [`CompactAndRefine`](CompactAndRefine.md)
+
+## Implements
+
+- `BaseResponseBuilder`
+
+## Constructors
+
+### constructor
+
+• **new Refine**(`serviceContext`, `textQATemplate?`, `refineTemplate?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+| `textQATemplate?` | [`SimplePrompt`](../modules.md#simpleprompt) |
+| `refineTemplate?` | [`SimplePrompt`](../modules.md#simpleprompt) |
+
+#### Defined in
+
+[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L78)
+
+## Properties
+
+### refineTemplate
+
+• **refineTemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L76)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L74)
+
+___
+
+### textQATemplate
+
+• **textQATemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L75)
+
+## Methods
+
+### getResponse
+
+▸ **getResponse**(`query`, `textChunks`, `parentEvent?`, `prevResponse?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `textChunks` | `string`[] |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+| `prevResponse?` | `string` |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Implementation of
+
+BaseResponseBuilder.getResponse
+
+#### Defined in
+
+[ResponseSynthesizer.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L88)
+
+___
+
+### giveResponseSingle
+
+▸ `Private` **giveResponseSingle**(`queryStr`, `textChunk`, `parentEvent?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `queryStr` | `string` |
+| `textChunk` | `string` |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[ResponseSynthesizer.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L113)
+
+___
+
+### refineResponseSingle
+
+▸ `Private` **refineResponseSingle**(`response`, `queryStr`, `textChunk`, `parentEvent?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `response` | `string` |
+| `queryStr` | `string` |
+| `textChunk` | `string` |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[ResponseSynthesizer.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L149)

apps/docs/docs/api/classes/Response.md

@@ -0,0 +1,74 @@
+---
+id: "Response"
+title: "Class: Response"
+sidebar_label: "Response"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Respone is the output of a LLM
+
+## Constructors
+
+### constructor
+
+• **new Response**(`response`, `sourceNodes?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `response` | `string` |
+| `sourceNodes?` | [`BaseNode`](BaseNode.md)[] |
+
+#### Defined in
+
+[Response.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Response.ts#L10)
+
+## Properties
+
+### response
+
+• **response**: `string`
+
+#### Defined in
+
+[Response.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Response.ts#L7)
+
+___
+
+### sourceNodes
+
+• `Optional` **sourceNodes**: [`BaseNode`](BaseNode.md)[]
+
+#### Defined in
+
+[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Response.ts#L8)
+
+## Methods
+
+### getFormattedSources
+
+▸ **getFormattedSources**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Response.ts#L15)
+
+___
+
+### toString
+
+▸ **toString**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Response.ts#L19)

apps/docs/docs/api/classes/ResponseSynthesizer.md

@@ -0,0 +1,69 @@
+---
+id: "ResponseSynthesizer"
+title: "Class: ResponseSynthesizer"
+sidebar_label: "ResponseSynthesizer"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A ResponseSynthesizer is used to generate a response from a query and a list of nodes.
+
+## Constructors
+
+### constructor
+
+• **new ResponseSynthesizer**(`«destructured»?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `responseBuilder?` | `BaseResponseBuilder` |
+| › `serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+
+#### Defined in
+
+[ResponseSynthesizer.ts:285](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L285)
+
+## Properties
+
+### responseBuilder
+
+• **responseBuilder**: `BaseResponseBuilder`
+
+#### Defined in
+
+[ResponseSynthesizer.ts:282](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L282)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:283](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L283)
+
+## Methods
+
+### synthesize
+
+▸ **synthesize**(`query`, `nodes`, `parentEvent?`): `Promise`<[`Response`](Response.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `nodes` | [`NodeWithScore`](../interfaces/NodeWithScore.md)[] |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`Response`](Response.md)\>
+
+#### Defined in
+
+[ResponseSynthesizer.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L297)

apps/docs/docs/api/classes/RetrieverQueryEngine.md

@@ -0,0 +1,77 @@
+---
+id: "RetrieverQueryEngine"
+title: "Class: RetrieverQueryEngine"
+sidebar_label: "RetrieverQueryEngine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A query engine that uses a retriever to query an index and then synthesizes the response.
+
+## Implements
+
+- [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+## Constructors
+
+### constructor
+
+• **new RetrieverQueryEngine**(`retriever`, `responseSynthesizer?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `retriever` | [`BaseRetriever`](../interfaces/BaseRetriever.md) |
+| `responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) |
+
+#### Defined in
+
+[QueryEngine.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L34)
+
+## Properties
+
+### responseSynthesizer
+
+• **responseSynthesizer**: [`ResponseSynthesizer`](ResponseSynthesizer.md)
+
+#### Defined in
+
+[QueryEngine.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L32)
+
+___
+
+### retriever
+
+• **retriever**: [`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+#### Defined in
+
+[QueryEngine.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L31)
+
+## Methods
+
+### query
+
+▸ **query**(`query`, `parentEvent?`): `Promise`<[`Response`](Response.md)\>
+
+Query the query engine and get a response.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`Response`](Response.md)\>
+
+#### Implementation of
+
+[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[query](../interfaces/BaseQueryEngine.md#query)
+
+#### Defined in
+
+[QueryEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L45)

apps/docs/docs/api/classes/SentenceSplitter.md

@@ -0,0 +1,238 @@
+---
+id: "SentenceSplitter"
+title: "Class: SentenceSplitter"
+sidebar_label: "SentenceSplitter"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+SentenceSplitter is our default text splitter that supports splitting into sentences, paragraphs, or fixed length chunks with overlap.
+
+One of the advantages of SentenceSplitter is that even in the fixed length chunks it will try to keep sentences together.
+
+## Constructors
+
+### constructor
+
+• **new SentenceSplitter**(`chunkSize?`, `chunkOverlap?`, `tokenizer?`, `tokenizerDecoder?`, `paragraphSeparator?`, `chunkingTokenizerFn?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `chunkSize` | `number` | `DEFAULT_CHUNK_SIZE` |
+| `chunkOverlap` | `number` | `DEFAULT_CHUNK_OVERLAP` |
+| `tokenizer` | `any` | `null` |
+| `tokenizerDecoder` | `any` | `null` |
+| `paragraphSeparator` | `string` | `"\n\n\n"` |
+| `chunkingTokenizerFn` | `any` | `undefined` |
+
+#### Defined in
+
+[TextSplitter.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L35)
+
+## Properties
+
+### chunkOverlap
+
+• `Private` **chunkOverlap**: `number`
+
+#### Defined in
+
+[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L28)
+
+___
+
+### chunkSize
+
+• `Private` **chunkSize**: `number`
+
+#### Defined in
+
+[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L27)
+
+___
+
+### chunkingTokenizerFn
+
+• `Private` **chunkingTokenizerFn**: `any`
+
+#### Defined in
+
+[TextSplitter.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L32)
+
+___
+
+### paragraphSeparator
+
+• `Private` **paragraphSeparator**: `string`
+
+#### Defined in
+
+[TextSplitter.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L31)
+
+___
+
+### tokenizer
+
+• `Private` **tokenizer**: `any`
+
+#### Defined in
+
+[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L29)
+
+___
+
+### tokenizerDecoder
+
+• `Private` **tokenizerDecoder**: `any`
+
+#### Defined in
+
+[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L30)
+
+## Methods
+
+### combineTextSplits
+
+▸ **combineTextSplits**(`newSentenceSplits`, `effectiveChunkSize`): `TextSplit`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `newSentenceSplits` | `SplitRep`[] |
+| `effectiveChunkSize` | `number` |
+
+#### Returns
+
+`TextSplit`[]
+
+#### Defined in
+
+[TextSplitter.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L155)
+
+___
+
+### getEffectiveChunkSize
+
+▸ `Private` **getEffectiveChunkSize**(`extraInfoStr?`): `number`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `extraInfoStr?` | `string` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[TextSplitter.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L74)
+
+___
+
+### getParagraphSplits
+
+▸ **getParagraphSplits**(`text`, `effectiveChunkSize?`): `string`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `text` | `string` |
+| `effectiveChunkSize?` | `number` |
+
+#### Returns
+
+`string`[]
+
+#### Defined in
+
+[TextSplitter.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L91)
+
+___
+
+### getSentenceSplits
+
+▸ **getSentenceSplits**(`text`, `effectiveChunkSize?`): `string`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `text` | `string` |
+| `effectiveChunkSize?` | `number` |
+
+#### Returns
+
+`string`[]
+
+#### Defined in
+
+[TextSplitter.ts:117](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L117)
+
+___
+
+### processSentenceSplits
+
+▸ `Private` **processSentenceSplits**(`sentenceSplits`, `effectiveChunkSize`): `SplitRep`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `sentenceSplits` | `string`[] |
+| `effectiveChunkSize` | `number` |
+
+#### Returns
+
+`SplitRep`[]
+
+#### Defined in
+
+[TextSplitter.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L130)
+
+___
+
+### splitText
+
+▸ **splitText**(`text`, `extraInfoStr?`): `string`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `text` | `string` |
+| `extraInfoStr?` | `string` |
+
+#### Returns
+
+`string`[]
+
+#### Defined in
+
+[TextSplitter.ts:247](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L247)
+
+___
+
+### splitTextWithOverlaps
+
+▸ **splitTextWithOverlaps**(`text`, `extraInfoStr?`): `TextSplit`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `text` | `string` |
+| `extraInfoStr?` | `string` |
+
+#### Returns
+
+`TextSplit`[]
+
+#### Defined in
+
+[TextSplitter.ts:219](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L219)

apps/docs/docs/api/classes/SimpleChatEngine.md

@@ -0,0 +1,96 @@
+---
+id: "SimpleChatEngine"
+title: "Class: SimpleChatEngine"
+sidebar_label: "SimpleChatEngine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+SimpleChatEngine is the simplest possible chat engine. Useful for using your own custom prompts.
+
+## Implements
+
+- [`ChatEngine`](../interfaces/ChatEngine.md)
+
+## Constructors
+
+### constructor
+
+• **new SimpleChatEngine**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`SimpleChatEngine`](SimpleChatEngine.md)\> |
+
+#### Defined in
+
+[ChatEngine.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L40)
+
+## Properties
+
+### chatHistory
+
+• **chatHistory**: [`ChatMessage`](../interfaces/ChatMessage.md)[]
+
+#### Defined in
+
+[ChatEngine.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L37)
+
+___
+
+### llm
+
+• **llm**: [`LLM`](../interfaces/LLM.md)
+
+#### Defined in
+
+[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L38)
+
+## Methods
+
+### chat
+
+▸ **chat**(`message`, `chatHistory?`): `Promise`<[`Response`](Response.md)\>
+
+Send message along with the class's current chat history to the LLM.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `message` | `string` |  |
+| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | optional chat history if you want to customize the chat history |
+
+#### Returns
+
+`Promise`<[`Response`](Response.md)\>
+
+#### Implementation of
+
+[ChatEngine](../interfaces/ChatEngine.md).[chat](../interfaces/ChatEngine.md#chat)
+
+#### Defined in
+
+[ChatEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L45)
+
+___
+
+### reset
+
+▸ **reset**(): `void`
+
+Resets the chat history so that it's empty.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[ChatEngine](../interfaces/ChatEngine.md).[reset](../interfaces/ChatEngine.md#reset)
+
+#### Defined in
+
+[ChatEngine.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L54)

apps/docs/docs/api/classes/SimpleDirectoryReader.md

@@ -0,0 +1,43 @@
+---
+id: "SimpleDirectoryReader"
+title: "Class: SimpleDirectoryReader"
+sidebar_label: "SimpleDirectoryReader"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Read all of the documents in a directory. Currently supports PDF and TXT files.
+
+## Implements
+
+- [`BaseReader`](../interfaces/BaseReader.md)
+
+## Constructors
+
+### constructor
+
+• **new SimpleDirectoryReader**()
+
+## Methods
+
+### loadData
+
+▸ **loadData**(`«destructured»`): `Promise`<[`Document`](Document.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | [`SimpleDirectoryReaderLoadDataProps`](../modules.md#simpledirectoryreaderloaddataprops) |
+
+#### Returns
+
+`Promise`<[`Document`](Document.md)[]\>
+
+#### Implementation of
+
+[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata)
+
+#### Defined in
+
+[readers/SimpleDirectoryReader.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/SimpleDirectoryReader.ts#L37)

apps/docs/docs/api/classes/SimpleNodeParser.md

@@ -0,0 +1,120 @@
+---
+id: "SimpleNodeParser"
+title: "Class: SimpleNodeParser"
+sidebar_label: "SimpleNodeParser"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+SimpleNodeParser is the default NodeParser. It splits documents into TextNodes using a splitter, by default SentenceSplitter
+
+## Implements
+
+- [`NodeParser`](../interfaces/NodeParser.md)
+
+## Constructors
+
+### constructor
+
+• **new SimpleNodeParser**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Object` |
+| `init.chunkOverlap?` | `number` |
+| `init.chunkSize?` | `number` |
+| `init.includeMetadata?` | `boolean` |
+| `init.includePrevNextRel?` | `boolean` |
+| `init.textSplitter?` | [`SentenceSplitter`](SentenceSplitter.md) |
+
+#### Defined in
+
+[NodeParser.ts:93](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/NodeParser.ts#L93)
+
+## Properties
+
+### includeMetadata
+
+• **includeMetadata**: `boolean`
+
+Whether to include metadata in the nodes.
+
+#### Defined in
+
+[NodeParser.ts:87](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/NodeParser.ts#L87)
+
+___
+
+### includePrevNextRel
+
+• **includePrevNextRel**: `boolean`
+
+Whether to include previous and next relationships in the nodes.
+
+#### Defined in
+
+[NodeParser.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/NodeParser.ts#L91)
+
+___
+
+### textSplitter
+
+• **textSplitter**: [`SentenceSplitter`](SentenceSplitter.md)
+
+The text splitter to use.
+
+#### Defined in
+
+[NodeParser.ts:83](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/NodeParser.ts#L83)
+
+## Methods
+
+### getNodesFromDocuments
+
+▸ **getNodesFromDocuments**(`documents`): [`TextNode`](TextNode.md)[]
+
+Generate Node objects from documents
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `documents` | [`Document`](Document.md)[] |
+
+#### Returns
+
+[`TextNode`](TextNode.md)[]
+
+#### Implementation of
+
+[NodeParser](../interfaces/NodeParser.md).[getNodesFromDocuments](../interfaces/NodeParser.md#getnodesfromdocuments)
+
+#### Defined in
+
+[NodeParser.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/NodeParser.ts#L124)
+
+___
+
+### fromDefaults
+
+▸ `Static` **fromDefaults**(`init?`): [`SimpleNodeParser`](SimpleNodeParser.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Object` |
+| `init.chunkOverlap?` | `number` |
+| `init.chunkSize?` | `number` |
+| `init.includeMetadata?` | `boolean` |
+| `init.includePrevNextRel?` | `boolean` |
+
+#### Returns
+
+[`SimpleNodeParser`](SimpleNodeParser.md)
+
+#### Defined in
+
+[NodeParser.ts:111](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/NodeParser.ts#L111)

apps/docs/docs/api/classes/SimpleResponseBuilder.md

@@ -0,0 +1,75 @@
+---
+id: "SimpleResponseBuilder"
+title: "Class: SimpleResponseBuilder"
+sidebar_label: "SimpleResponseBuilder"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A response builder that just concatenates responses.
+
+## Implements
+
+- `BaseResponseBuilder`
+
+## Constructors
+
+### constructor
+
+• **new SimpleResponseBuilder**(`serviceContext`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+
+#### Defined in
+
+[ResponseSynthesizer.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L49)
+
+## Properties
+
+### llm
+
+• **llm**: [`LLM`](../interfaces/LLM.md)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L46)
+
+___
+
+### textQATemplate
+
+• **textQATemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L47)
+
+## Methods
+
+### getResponse
+
+▸ **getResponse**(`query`, `textChunks`, `parentEvent?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `textChunks` | `string`[] |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Implementation of
+
+BaseResponseBuilder.getResponse
+
+#### Defined in
+
+[ResponseSynthesizer.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L54)

apps/docs/docs/api/classes/SubQuestionOutputParser.md

@@ -0,0 +1,67 @@
+---
+id: "SubQuestionOutputParser"
+title: "Class: SubQuestionOutputParser"
+sidebar_label: "SubQuestionOutputParser"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+SubQuestionOutputParser is used to parse the output of the SubQuestionGenerator.
+
+## Implements
+
+- [`BaseOutputParser`](../interfaces/BaseOutputParser.md)<[`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>\>
+
+## Constructors
+
+### constructor
+
+• **new SubQuestionOutputParser**()
+
+## Methods
+
+### format
+
+▸ **format**(`output`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `output` | `string` |
+
+#### Returns
+
+`string`
+
+#### Implementation of
+
+[BaseOutputParser](../interfaces/BaseOutputParser.md).[format](../interfaces/BaseOutputParser.md#format)
+
+#### Defined in
+
+[OutputParser.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/OutputParser.ts#L97)
+
+___
+
+### parse
+
+▸ **parse**(`output`): [`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `output` | `string` |
+
+#### Returns
+
+[`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>
+
+#### Implementation of
+
+[BaseOutputParser](../interfaces/BaseOutputParser.md).[parse](../interfaces/BaseOutputParser.md#parse)
+
+#### Defined in
+
+[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/OutputParser.ts#L89)

apps/docs/docs/api/classes/SubQuestionQueryEngine.md

@@ -0,0 +1,143 @@
+---
+id: "SubQuestionQueryEngine"
+title: "Class: SubQuestionQueryEngine"
+sidebar_label: "SubQuestionQueryEngine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+SubQuestionQueryEngine decomposes a question into subquestions and then
+
+## Implements
+
+- [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+## Constructors
+
+### constructor
+
+• **new SubQuestionQueryEngine**(`init`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | `Object` |
+| `init.queryEngineTools` | [`QueryEngineTool`](../interfaces/QueryEngineTool.md)[] |
+| `init.questionGen` | [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md) |
+| `init.responseSynthesizer` | [`ResponseSynthesizer`](ResponseSynthesizer.md) |
+
+#### Defined in
+
+[QueryEngine.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L65)
+
+## Properties
+
+### metadatas
+
+• **metadatas**: [`ToolMetadata`](../interfaces/ToolMetadata.md)[]
+
+#### Defined in
+
+[QueryEngine.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L63)
+
+___
+
+### queryEngines
+
+• **queryEngines**: `Record`<`string`, [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)\>
+
+#### Defined in
+
+[QueryEngine.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L62)
+
+___
+
+### questionGen
+
+• **questionGen**: [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md)
+
+#### Defined in
+
+[QueryEngine.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L61)
+
+___
+
+### responseSynthesizer
+
+• **responseSynthesizer**: [`ResponseSynthesizer`](ResponseSynthesizer.md)
+
+#### Defined in
+
+[QueryEngine.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L60)
+
+## Methods
+
+### query
+
+▸ **query**(`query`): `Promise`<[`Response`](Response.md)\>
+
+Query the query engine and get a response.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+
+#### Returns
+
+`Promise`<[`Response`](Response.md)\>
+
+#### Implementation of
+
+[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[query](../interfaces/BaseQueryEngine.md#query)
+
+#### Defined in
+
+[QueryEngine.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L106)
+
+___
+
+### querySubQ
+
+▸ `Private` **querySubQ**(`subQ`, `parentEvent?`): `Promise`<``null`` \| [`NodeWithScore`](../interfaces/NodeWithScore.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `subQ` | [`SubQuestion`](../interfaces/SubQuestion.md) |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<``null`` \| [`NodeWithScore`](../interfaces/NodeWithScore.md)\>
+
+#### Defined in
+
+[QueryEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L134)
+
+___
+
+### fromDefaults
+
+▸ `Static` **fromDefaults**(`init`): [`SubQuestionQueryEngine`](SubQuestionQueryEngine.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | `Object` |
+| `init.queryEngineTools` | [`QueryEngineTool`](../interfaces/QueryEngineTool.md)[] |
+| `init.questionGen?` | [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md) |
+| `init.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) |
+| `init.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+
+#### Returns
+
+[`SubQuestionQueryEngine`](SubQuestionQueryEngine.md)
+
+#### Defined in
+
+[QueryEngine.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L82)

apps/docs/docs/api/classes/TextFileReader.md

@@ -0,0 +1,44 @@
+---
+id: "TextFileReader"
+title: "Class: TextFileReader"
+sidebar_label: "TextFileReader"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Read a .txt file
+
+## Implements
+
+- [`BaseReader`](../interfaces/BaseReader.md)
+
+## Constructors
+
+### constructor
+
+• **new TextFileReader**()
+
+## Methods
+
+### loadData
+
+▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `file` | `string` |
+| `fs` | [`CompleteFileSystem`](../modules.md#completefilesystem) |
+
+#### Returns
+
+`Promise`<[`Document`](Document.md)[]\>
+
+#### Implementation of
+
+[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata)
+
+#### Defined in
+
+[readers/SimpleDirectoryReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/SimpleDirectoryReader.ts#L12)

apps/docs/docs/api/classes/TextNode.md

@@ -0,0 +1,478 @@
+---
+id: "TextNode"
+title: "Class: TextNode"
+sidebar_label: "TextNode"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+TextNode is the default node type for text. Most common node type in LlamaIndex.TS
+
+## Hierarchy
+
+- [`BaseNode`](BaseNode.md)
+
+  ↳ **`TextNode`**
+
+  ↳↳ [`IndexNode`](IndexNode.md)
+
+  ↳↳ [`Document`](Document.md)
+
+## Constructors
+
+### constructor
+
+• **new TextNode**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`TextNode`](TextNode.md)\> |
+
+#### Overrides
+
+[BaseNode](BaseNode.md).[constructor](BaseNode.md#constructor)
+
+#### Defined in
+
+[Node.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L152)
+
+## Properties
+
+### embedding
+
+• `Optional` **embedding**: `number`[]
+
+#### Inherited from
+
+[BaseNode](BaseNode.md).[embedding](BaseNode.md#embedding)
+
+#### Defined in
+
+[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L39)
+
+___
+
+### endCharIdx
+
+• `Optional` **endCharIdx**: `number`
+
+#### Defined in
+
+[Node.ts:147](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L147)
+
+___
+
+### excludedEmbedMetadataKeys
+
+• **excludedEmbedMetadataKeys**: `string`[] = `[]`
+
+#### Inherited from
+
+[BaseNode](BaseNode.md).[excludedEmbedMetadataKeys](BaseNode.md#excludedembedmetadatakeys)
+
+#### Defined in
+
+[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L43)
+
+___
+
+### excludedLlmMetadataKeys
+
+• **excludedLlmMetadataKeys**: `string`[] = `[]`
+
+#### Inherited from
+
+[BaseNode](BaseNode.md).[excludedLlmMetadataKeys](BaseNode.md#excludedllmmetadatakeys)
+
+#### Defined in
+
+[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L44)
+
+___
+
+### hash
+
+• **hash**: `string` = `""`
+
+#### Inherited from
+
+[BaseNode](BaseNode.md).[hash](BaseNode.md#hash)
+
+#### Defined in
+
+[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L46)
+
+___
+
+### id\_
+
+• **id\_**: `string`
+
+#### Inherited from
+
+[BaseNode](BaseNode.md).[id_](BaseNode.md#id_)
+
+#### Defined in
+
+[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L38)
+
+___
+
+### metadata
+
+• **metadata**: `Record`<`string`, `any`\> = `{}`
+
+#### Inherited from
+
+[BaseNode](BaseNode.md).[metadata](BaseNode.md#metadata)
+
+#### Defined in
+
+[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L42)
+
+___
+
+### metadataSeparator
+
+• **metadataSeparator**: `string` = `"\n"`
+
+#### Defined in
+
+[Node.ts:150](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L150)
+
+___
+
+### relationships
+
+• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../modules.md#relatednodetype)\>\> = `{}`
+
+#### Inherited from
+
+[BaseNode](BaseNode.md).[relationships](BaseNode.md#relationships)
+
+#### Defined in
+
+[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L45)
+
+___
+
+### startCharIdx
+
+• `Optional` **startCharIdx**: `number`
+
+#### Defined in
+
+[Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L146)
+
+___
+
+### text
+
+• **text**: `string` = `""`
+
+#### Defined in
+
+[Node.ts:145](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L145)
+
+## Accessors
+
+### childNodes
+
+• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
+
+#### Inherited from
+
+BaseNode.childNodes
+
+#### Defined in
+
+[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L104)
+
+___
+
+### nextNode
+
+• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Inherited from
+
+BaseNode.nextNode
+
+#### Defined in
+
+[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L84)
+
+___
+
+### nodeId
+
+• `get` **nodeId**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+BaseNode.nodeId
+
+#### Defined in
+
+[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L58)
+
+___
+
+### parentNode
+
+• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Inherited from
+
+BaseNode.parentNode
+
+#### Defined in
+
+[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L94)
+
+___
+
+### prevNode
+
+• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Inherited from
+
+BaseNode.prevNode
+
+#### Defined in
+
+[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L72)
+
+___
+
+### sourceNode
+
+• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Inherited from
+
+BaseNode.sourceNode
+
+#### Defined in
+
+[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L62)
+
+## Methods
+
+### asRelatedNodeInfo
+
+▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Inherited from
+
+[BaseNode](BaseNode.md).[asRelatedNodeInfo](BaseNode.md#asrelatednodeinfo)
+
+#### Defined in
+
+[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L124)
+
+___
+
+### generateHash
+
+▸ **generateHash**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L157)
+
+___
+
+### getContent
+
+▸ **getContent**(`metadataMode?`): `string`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` |
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[BaseNode](BaseNode.md).[getContent](BaseNode.md#getcontent)
+
+#### Defined in
+
+[Node.ts:165](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L165)
+
+___
+
+### getEmbedding
+
+▸ **getEmbedding**(): `number`[]
+
+#### Returns
+
+`number`[]
+
+#### Inherited from
+
+[BaseNode](BaseNode.md).[getEmbedding](BaseNode.md#getembedding)
+
+#### Defined in
+
+[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L116)
+
+___
+
+### getMetadataStr
+
+▸ **getMetadataStr**(`metadataMode`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[BaseNode](BaseNode.md).[getMetadataStr](BaseNode.md#getmetadatastr)
+
+#### Defined in
+
+[Node.ts:170](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L170)
+
+___
+
+### getNodeInfo
+
+▸ **getNodeInfo**(): `Object`
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `end` | `undefined` \| `number` |
+| `start` | `undefined` \| `number` |
+
+#### Defined in
+
+[Node.ts:195](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L195)
+
+___
+
+### getText
+
+▸ **getText**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[Node.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L199)
+
+___
+
+### getType
+
+▸ **getType**(): [`ObjectType`](../enums/ObjectType.md)
+
+#### Returns
+
+[`ObjectType`](../enums/ObjectType.md)
+
+#### Overrides
+
+[BaseNode](BaseNode.md).[getType](BaseNode.md#gettype)
+
+#### Defined in
+
+[Node.ts:161](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L161)
+
+___
+
+### setContent
+
+▸ **setContent**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `string` |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[BaseNode](BaseNode.md).[setContent](BaseNode.md#setcontent)
+
+#### Defined in
+
+[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L191)
+
+___
+
+### toJSON
+
+▸ **toJSON**(): `Record`<`string`, `any`\>
+
+Used with built in JSON.stringify
+
+#### Returns
+
+`Record`<`string`, `any`\>
+
+#### Inherited from
+
+[BaseNode](BaseNode.md).[toJSON](BaseNode.md#tojson)
+
+#### Defined in
+
+[Node.ts:136](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L136)

apps/docs/docs/api/classes/TreeSummarize.md

@@ -0,0 +1,65 @@
+---
+id: "TreeSummarize"
+title: "Class: TreeSummarize"
+sidebar_label: "TreeSummarize"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+TreeSummarize repacks the text chunks into the smallest possible number of chunks and then summarizes them, then recursively does so until there's one chunk left.
+
+## Implements
+
+- `BaseResponseBuilder`
+
+## Constructors
+
+### constructor
+
+• **new TreeSummarize**(`serviceContext`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+
+#### Defined in
+
+[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L212)
+
+## Properties
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:210](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L210)
+
+## Methods
+
+### getResponse
+
+▸ **getResponse**(`query`, `textChunks`, `parentEvent?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `textChunks` | `string`[] |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Implementation of
+
+BaseResponseBuilder.getResponse
+
+#### Defined in
+
+[ResponseSynthesizer.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L216)

apps/docs/docs/api/classes/VectorIndexRetriever.md

@@ -0,0 +1,104 @@
+---
+id: "VectorIndexRetriever"
+title: "Class: VectorIndexRetriever"
+sidebar_label: "VectorIndexRetriever"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+VectorIndexRetriever retrieves nodes from a VectorIndex.
+
+## Implements
+
+- [`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+## Constructors
+
+### constructor
+
+• **new VectorIndexRetriever**(`«destructured»`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `index` | [`VectorStoreIndex`](VectorStoreIndex.md) |
+| › `similarityTopK?` | `number` |
+
+#### Defined in
+
+[indices/vectorStore/VectorIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L22)
+
+## Properties
+
+### index
+
+• **index**: [`VectorStoreIndex`](VectorStoreIndex.md)
+
+#### Defined in
+
+[indices/vectorStore/VectorIndexRetriever.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L18)
+
+___
+
+### serviceContext
+
+• `Private` **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Defined in
+
+[indices/vectorStore/VectorIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L20)
+
+___
+
+### similarityTopK
+
+• **similarityTopK**: `number`
+
+#### Defined in
+
+[indices/vectorStore/VectorIndexRetriever.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L19)
+
+## Methods
+
+### getServiceContext
+
+▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Returns
+
+[`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Implementation of
+
+[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext)
+
+#### Defined in
+
+[indices/vectorStore/VectorIndexRetriever.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L69)
+
+___
+
+### retrieve
+
+▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\>
+
+#### Implementation of
+
+[BaseRetriever](../interfaces/BaseRetriever.md).[retrieve](../interfaces/BaseRetriever.md#retrieve)
+
+#### Defined in
+
+[indices/vectorStore/VectorIndexRetriever.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L35)

apps/docs/docs/api/classes/VectorStoreIndex.md

@@ -0,0 +1,271 @@
+---
+id: "VectorStoreIndex"
+title: "Class: VectorStoreIndex"
+sidebar_label: "VectorStoreIndex"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+The VectorStoreIndex, an index that stores the nodes only according to their vector embedings.
+
+## Hierarchy
+
+- [`BaseIndex`](BaseIndex.md)<[`IndexDict`](IndexDict.md)\>
+
+  ↳ **`VectorStoreIndex`**
+
+## Constructors
+
+### constructor
+
+• `Private` **new VectorStoreIndex**(`init`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | [`VectorIndexConstructorProps`](../interfaces/VectorIndexConstructorProps.md) |
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[constructor](BaseIndex.md#constructor)
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L36)
+
+## Properties
+
+### docStore
+
+• **docStore**: `BaseDocumentStore`
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[docStore](BaseIndex.md#docstore)
+
+#### Defined in
+
+[indices/BaseIndex.ts:122](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L122)
+
+___
+
+### indexStore
+
+• `Optional` **indexStore**: `BaseIndexStore`
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[indexStore](BaseIndex.md#indexstore)
+
+#### Defined in
+
+[indices/BaseIndex.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L124)
+
+___
+
+### indexStruct
+
+• **indexStruct**: [`IndexDict`](IndexDict.md)
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[indexStruct](BaseIndex.md#indexstruct)
+
+#### Defined in
+
+[indices/BaseIndex.ts:125](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L125)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[serviceContext](BaseIndex.md#servicecontext)
+
+#### Defined in
+
+[indices/BaseIndex.ts:120](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L120)
+
+___
+
+### storageContext
+
+• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md)
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[storageContext](BaseIndex.md#storagecontext)
+
+#### Defined in
+
+[indices/BaseIndex.ts:121](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L121)
+
+___
+
+### vectorStore
+
+• **vectorStore**: [`VectorStore`](../interfaces/VectorStore.md)
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[vectorStore](BaseIndex.md#vectorstore)
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L34)
+
+## Methods
+
+### asQueryEngine
+
+▸ **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+Create a new query engine from the index. It will also create a retriever
+and response synthezier if they are not provided.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer |
+| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - |
+| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - |
+
+#### Returns
+
+[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[asQueryEngine](BaseIndex.md#asqueryengine)
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:215](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L215)
+
+___
+
+### asRetriever
+
+▸ **asRetriever**(`options?`): [`VectorIndexRetriever`](VectorIndexRetriever.md)
+
+Create a new retriever from the index.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options?` | `any` |
+
+#### Returns
+
+[`VectorIndexRetriever`](VectorIndexRetriever.md)
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[asRetriever](BaseIndex.md#asretriever)
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:211](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L211)
+
+___
+
+### buildIndexFromNodes
+
+▸ `Static` **buildIndexFromNodes**(`nodes`, `serviceContext`, `vectorStore`, `docStore`): `Promise`<[`IndexDict`](IndexDict.md)\>
+
+Get embeddings for nodes and place them into the index.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `nodes` | [`BaseNode`](BaseNode.md)[] |
+| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+| `vectorStore` | [`VectorStore`](../interfaces/VectorStore.md) |
+| `docStore` | `BaseDocumentStore` |
+
+#### Returns
+
+`Promise`<[`IndexDict`](IndexDict.md)\>
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:151](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L151)
+
+___
+
+### fromDocuments
+
+▸ `Static` **fromDocuments**(`documents`, `args?`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\>
+
+High level API: split documents, get embeddings, and build index.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `documents` | [`Document`](Document.md)[] |
+| `args` | `Object` |
+| `args.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+| `args.storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) |
+
+#### Returns
+
+`Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\>
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L186)
+
+___
+
+### getNodeEmbeddingResults
+
+▸ `Static` **getNodeEmbeddingResults**(`nodes`, `serviceContext`, `logProgress?`): `Promise`<[`NodeWithEmbedding`](../interfaces/NodeWithEmbedding.md)[]\>
+
+Get the embeddings for nodes.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `nodes` | [`BaseNode`](BaseNode.md)[] | `undefined` |  |
+| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | `undefined` |  |
+| `logProgress` | `boolean` | `false` | log progress to console (useful for debugging) |
+
+#### Returns
+
+`Promise`<[`NodeWithEmbedding`](../interfaces/NodeWithEmbedding.md)[]\>
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L123)
+
+___
+
+### init
+
+▸ `Static` **init**(`options`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\>
+
+The async init function should be called after the constructor.
+This is needed to handle persistence.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | [`VectorIndexOptions`](../interfaces/VectorIndexOptions.md) |
+
+#### Returns
+
+`Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\>
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L47)

apps/docs/docs/api/classes/_category_.yml

@@ -0,0 +1,2 @@
+label: "Classes"
+position: 3

apps/docs/docs/api/enums/DeuceChatStrategy.md

@@ -0,0 +1,37 @@
+---
+id: "DeuceChatStrategy"
+title: "Enumeration: DeuceChatStrategy"
+sidebar_label: "DeuceChatStrategy"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Enumeration Members
+
+### A16Z
+
+• **A16Z** = ``"a16z"``
+
+#### Defined in
+
+[llm/LLM.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L224)
+
+___
+
+### META
+
+• **META** = ``"meta"``
+
+#### Defined in
+
+[llm/LLM.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L225)
+
+___
+
+### METAWBOS
+
+• **METAWBOS** = ``"metawbos"``
+
+#### Defined in
+
+[llm/LLM.ts:226](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L226)

apps/docs/docs/api/enums/IndexStructType.md

@@ -0,0 +1,27 @@
+---
+id: "IndexStructType"
+title: "Enumeration: IndexStructType"
+sidebar_label: "IndexStructType"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Enumeration Members
+
+### LIST
+
+• **LIST** = ``"list"``
+
+#### Defined in
+
+[indices/BaseIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L41)
+
+___
+
+### SIMPLE\_DICT
+
+• **SIMPLE\_DICT** = ``"simple_dict"``
+
+#### Defined in
+
+[indices/BaseIndex.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L40)

apps/docs/docs/api/enums/ListRetrieverMode.md

@@ -0,0 +1,27 @@
+---
+id: "ListRetrieverMode"
+title: "Enumeration: ListRetrieverMode"
+sidebar_label: "ListRetrieverMode"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Enumeration Members
+
+### DEFAULT
+
+• **DEFAULT** = ``"default"``
+
+#### Defined in
+
+[indices/list/ListIndex.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L26)
+
+___
+
+### LLM
+
+• **LLM** = ``"llm"``
+
+#### Defined in
+
+[indices/list/ListIndex.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L28)

apps/docs/docs/api/enums/MetadataMode.md

@@ -0,0 +1,47 @@
+---
+id: "MetadataMode"
+title: "Enumeration: MetadataMode"
+sidebar_label: "MetadataMode"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Enumeration Members
+
+### ALL
+
+• **ALL** = ``"ALL"``
+
+#### Defined in
+
+[Node.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L19)
+
+___
+
+### EMBED
+
+• **EMBED** = ``"EMBED"``
+
+#### Defined in
+
+[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L20)
+
+___
+
+### LLM
+
+• **LLM** = ``"LLM"``
+
+#### Defined in
+
+[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L21)
+
+___
+
+### NONE
+
+• **NONE** = ``"NONE"``
+
+#### Defined in
+
+[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L22)

apps/docs/docs/api/enums/NodeRelationship.md

@@ -0,0 +1,57 @@
+---
+id: "NodeRelationship"
+title: "Enumeration: NodeRelationship"
+sidebar_label: "NodeRelationship"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Enumeration Members
+
+### CHILD
+
+• **CHILD** = ``"CHILD"``
+
+#### Defined in
+
+[Node.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L8)
+
+___
+
+### NEXT
+
+• **NEXT** = ``"NEXT"``
+
+#### Defined in
+
+[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L6)
+
+___
+
+### PARENT
+
+• **PARENT** = ``"PARENT"``
+
+#### Defined in
+
+[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L7)
+
+___
+
+### PREVIOUS
+
+• **PREVIOUS** = ``"PREVIOUS"``
+
+#### Defined in
+
+[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L5)
+
+___
+
+### SOURCE
+
+• **SOURCE** = ``"SOURCE"``
+
+#### Defined in
+
+[Node.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L4)

apps/docs/docs/api/enums/ObjectType.md

@@ -0,0 +1,47 @@
+---
+id: "ObjectType"
+title: "Enumeration: ObjectType"
+sidebar_label: "ObjectType"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Enumeration Members
+
+### DOCUMENT
+
+• **DOCUMENT** = ``"DOCUMENT"``
+
+#### Defined in
+
+[Node.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L15)
+
+___
+
+### IMAGE
+
+• **IMAGE** = ``"IMAGE"``
+
+#### Defined in
+
+[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L13)
+
+___
+
+### INDEX
+
+• **INDEX** = ``"INDEX"``
+
+#### Defined in
+
+[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L14)
+
+___
+
+### TEXT
+
+• **TEXT** = ``"TEXT"``
+
+#### Defined in
+
+[Node.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L12)

apps/docs/docs/api/enums/SimilarityType.md

@@ -0,0 +1,40 @@
+---
+id: "SimilarityType"
+title: "Enumeration: SimilarityType"
+sidebar_label: "SimilarityType"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Similarity type
+Default is cosine similarity. Dot product and negative Euclidean distance are also supported.
+
+## Enumeration Members
+
+### DEFAULT
+
+• **DEFAULT** = ``"cosine"``
+
+#### Defined in
+
+[Embedding.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L17)
+
+___
+
+### DOT\_PRODUCT
+
+• **DOT\_PRODUCT** = ``"dot_product"``
+
+#### Defined in
+
+[Embedding.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L18)
+
+___
+
+### EUCLIDEAN
+
+• **EUCLIDEAN** = ``"euclidean"``
+
+#### Defined in
+
+[Embedding.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L19)

apps/docs/docs/api/enums/VectorStoreQueryMode.md

@@ -0,0 +1,77 @@
+---
+id: "VectorStoreQueryMode"
+title: "Enumeration: VectorStoreQueryMode"
+sidebar_label: "VectorStoreQueryMode"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Enumeration Members
+
+### DEFAULT
+
+• **DEFAULT** = ``"default"``
+
+#### Defined in
+
+[storage/vectorStore/types.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L12)
+
+___
+
+### HYBRID
+
+• **HYBRID** = ``"hybrid"``
+
+#### Defined in
+
+[storage/vectorStore/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L14)
+
+___
+
+### LINEAR\_REGRESSION
+
+• **LINEAR\_REGRESSION** = ``"linear_regression"``
+
+#### Defined in
+
+[storage/vectorStore/types.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L18)
+
+___
+
+### LOGISTIC\_REGRESSION
+
+• **LOGISTIC\_REGRESSION** = ``"logistic_regression"``
+
+#### Defined in
+
+[storage/vectorStore/types.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L17)
+
+___
+
+### MMR
+
+• **MMR** = ``"mmr"``
+
+#### Defined in
+
+[storage/vectorStore/types.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L20)
+
+___
+
+### SPARSE
+
+• **SPARSE** = ``"sparse"``
+
+#### Defined in
+
+[storage/vectorStore/types.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L13)
+
+___
+
+### SVM
+
+• **SVM** = ``"svm"``
+
+#### Defined in
+
+[storage/vectorStore/types.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L16)

apps/docs/docs/api/enums/_category_.yml

@@ -0,0 +1,2 @@
+label: "Enumerations"
+position: 2

apps/docs/docs/api/index.md

@@ -0,0 +1,107 @@
+---
+id: "index"
+title: "llamaindex"
+sidebar_label: "Readme"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+# LlamaIndex.TS
+
+LlamaIndex is a data framework for your LLM application.
+
+Use your own data with large language models (LLMs, OpenAI ChatGPT and others) in Typescript and Javascript.
+
+Documentation: https://ts.llamaindex.ai/
+
+## What is LlamaIndex.TS?
+
+LlamaIndex.TS aims to be a lightweight, easy to use set of libraries to help you integrate large language models into your applications with your own data.
+
+## Getting started with an example:
+
+LlamaIndex.TS requries Node v18 or higher. You can download it from https://nodejs.org or use https://nvm.sh (our preferred option).
+
+In a new folder:
+
+```bash
+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
+pnpm install llamaindex
+pnpm install @types/node
+```
+
+Create the file example.ts
+
+```ts
+// example.ts
+import fs from "fs/promises";
+import { Document, VectorStoreIndex } from "llamaindex";
+
+async function main() {
+  // Load essay from abramov.txt in Node
+  const essay = await fs.readFile(
+    "node_modules/llamaindex/examples/abramov.txt",
+    "utf-8"
+  );
+
+  // Create Document object with essay
+  const document = new Document({ text: essay });
+
+  // Split text and create embeddings. Store them in a VectorStoreIndex
+  const index = await VectorStoreIndex.fromDocuments([document]);
+
+  // 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());
+}
+
+main();
+```
+
+Then you can run it using
+
+```bash
+pnpm dlx ts-node example.ts
+```
+
+## Playground
+
+Check out our NextJS playground at https://llama-playground.vercel.app/. The source is available at https://github.com/run-llama/ts-playground
+
+## Core concepts for getting started:
+
+- [Document](/packages/core/src/Node.ts): A document represents a text file, PDF file or other contiguous piece of data.
+
+- [Node](/packages/core/src/Node.ts): The basic data building block. Most commonly, these are parts of the document split into manageable pieces that are small enough to be fed into an embedding model and LLM.
+
+- [Embedding](/packages/core/src/Embedding.ts): Embeddings are sets of floating point numbers which represent the data in a Node. By comparing the similarity of embeddings, we can derive an understanding of the similarity of two pieces of data. One use case is to compare the embedding of a question with the embeddings of our Nodes to see which Nodes may contain the data needed to answer that quesiton.
+
+- [Indices](/packages/core/src/indices/): Indices store the Nodes and the embeddings of those nodes. QueryEngines retrieve Nodes from these Indices using embedding similarity.
+
+- [QueryEngine](/packages/core/src/QueryEngine.ts): Query engines are what generate the query you put in and give you back the result. Query engines generally combine a pre-built prompt with selected Nodes from your Index to give the LLM the context it needs to answer your query.
+
+- [ChatEngine](/packages/core/src/ChatEngine.ts): A ChatEngine helps you build a chatbot that will interact with your Indices.
+
+- [SimplePrompt](/packages/core/src/Prompt.ts): A simple standardized function call definition that takes in inputs and formats them in a template literal. SimplePrompts can be specialized using currying and combined using other SimplePrompt functions.
+
+## Supported LLMs:
+
+- OpenAI GPT-3.5-turbo and GPT-4
+- Anthropic Claude Instant and Claude 2
+- Llama2 Chat LLMs (70B, 13B, and 7B parameters)
+
+## 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)
+
+## Bugs? Questions?
+
+Please join our Discord! https://discord.com/invite/eN6D2HQ4aX

apps/docs/docs/api/interfaces/BaseIndexInit.md

@@ -0,0 +1,79 @@
+---
+id: "BaseIndexInit"
+title: "Interface: BaseIndexInit<T>"
+sidebar_label: "BaseIndexInit"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+## Hierarchy
+
+- **`BaseIndexInit`**
+
+  ↳ [`VectorIndexConstructorProps`](VectorIndexConstructorProps.md)
+
+## Properties
+
+### docStore
+
+• **docStore**: `BaseDocumentStore`
+
+#### Defined in
+
+[indices/BaseIndex.ts:109](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L109)
+
+___
+
+### indexStore
+
+• `Optional` **indexStore**: `BaseIndexStore`
+
+#### Defined in
+
+[indices/BaseIndex.ts:111](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L111)
+
+___
+
+### indexStruct
+
+• **indexStruct**: `T`
+
+#### Defined in
+
+[indices/BaseIndex.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L112)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](ServiceContext.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L107)
+
+___
+
+### storageContext
+
+• **storageContext**: [`StorageContext`](StorageContext.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:108](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L108)
+
+___
+
+### vectorStore
+
+• `Optional` **vectorStore**: [`VectorStore`](VectorStore.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:110](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L110)

apps/docs/docs/api/interfaces/BaseOutputParser.md

@@ -0,0 +1,59 @@
+---
+id: "BaseOutputParser"
+title: "Interface: BaseOutputParser<T>"
+sidebar_label: "BaseOutputParser"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+An OutputParser is used to extract structured data from the raw output of the LLM.
+
+## Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+## Implemented by
+
+- [`SubQuestionOutputParser`](../classes/SubQuestionOutputParser.md)
+
+## Methods
+
+### format
+
+▸ **format**(`output`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `output` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[OutputParser.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/OutputParser.ts#L8)
+
+___
+
+### parse
+
+▸ **parse**(`output`): `T`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `output` | `string` |
+
+#### Returns
+
+`T`
+
+#### Defined in
+
+[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/OutputParser.ts#L7)

apps/docs/docs/api/interfaces/BaseQueryEngine.md

@@ -0,0 +1,37 @@
+---
+id: "BaseQueryEngine"
+title: "Interface: BaseQueryEngine"
+sidebar_label: "BaseQueryEngine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A query engine is a question answerer that can use one or more steps.
+
+## Implemented by
+
+- [`RetrieverQueryEngine`](../classes/RetrieverQueryEngine.md)
+- [`SubQuestionQueryEngine`](../classes/SubQuestionQueryEngine.md)
+
+## Methods
+
+### query
+
+▸ **query**(`query`, `parentEvent?`): `Promise`<[`Response`](../classes/Response.md)\>
+
+Query the query engine and get a response.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `parentEvent?` | [`Event`](Event.md) |
+
+#### Returns
+
+`Promise`<[`Response`](../classes/Response.md)\>
+
+#### Defined in
+
+[QueryEngine.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L24)

apps/docs/docs/api/interfaces/BaseQuestionGenerator.md

@@ -0,0 +1,34 @@
+---
+id: "BaseQuestionGenerator"
+title: "Interface: BaseQuestionGenerator"
+sidebar_label: "BaseQuestionGenerator"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+QuestionGenerators generate new questions for the LLM using tools and a user query.
+
+## Implemented by
+
+- [`LLMQuestionGenerator`](../classes/LLMQuestionGenerator.md)
+
+## Methods
+
+### generate
+
+▸ **generate**(`tools`, `query`): `Promise`<[`SubQuestion`](SubQuestion.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `tools` | [`ToolMetadata`](ToolMetadata.md)[] |
+| `query` | `string` |
+
+#### Returns
+
+`Promise`<[`SubQuestion`](SubQuestion.md)[]\>
+
+#### Defined in
+
+[QuestionGenerator.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QuestionGenerator.ts#L23)

apps/docs/docs/api/interfaces/BaseReader.md

@@ -0,0 +1,35 @@
+---
+id: "BaseReader"
+title: "Interface: BaseReader"
+sidebar_label: "BaseReader"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A reader takes imports data into Document objects.
+
+## Implemented by
+
+- [`PDFReader`](../classes/PDFReader.md)
+- [`SimpleDirectoryReader`](../classes/SimpleDirectoryReader.md)
+- [`TextFileReader`](../classes/TextFileReader.md)
+
+## Methods
+
+### loadData
+
+▸ **loadData**(`...args`): `Promise`<[`Document`](../classes/Document.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `...args` | `any`[] |
+
+#### Returns
+
+`Promise`<[`Document`](../classes/Document.md)[]\>
+
+#### Defined in
+
+[readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/base.ts#L7)

apps/docs/docs/api/interfaces/BaseRetriever.md

@@ -0,0 +1,50 @@
+---
+id: "BaseRetriever"
+title: "Interface: BaseRetriever"
+sidebar_label: "BaseRetriever"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Retrievers retrieve the nodes that most closely match our query in similarity.
+
+## Implemented by
+
+- [`ListIndexLLMRetriever`](../classes/ListIndexLLMRetriever.md)
+- [`ListIndexRetriever`](../classes/ListIndexRetriever.md)
+- [`VectorIndexRetriever`](../classes/VectorIndexRetriever.md)
+
+## Methods
+
+### getServiceContext
+
+▸ **getServiceContext**(): [`ServiceContext`](ServiceContext.md)
+
+#### Returns
+
+[`ServiceContext`](ServiceContext.md)
+
+#### Defined in
+
+[Retriever.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Retriever.ts#L10)
+
+___
+
+### retrieve
+
+▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](NodeWithScore.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `parentEvent?` | [`Event`](Event.md) |
+
+#### Returns
+
+`Promise`<[`NodeWithScore`](NodeWithScore.md)[]\>
+
+#### Defined in
+
+[Retriever.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Retriever.ts#L9)

apps/docs/docs/api/interfaces/BaseTool.md

@@ -0,0 +1,25 @@
+---
+id: "BaseTool"
+title: "Interface: BaseTool"
+sidebar_label: "BaseTool"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Simple Tool interface. Likely to change.
+
+## Hierarchy
+
+- **`BaseTool`**
+
+  ↳ [`QueryEngineTool`](QueryEngineTool.md)
+
+## Properties
+
+### metadata
+
+• **metadata**: [`ToolMetadata`](ToolMetadata.md)
+
+#### Defined in
+
+[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Tool.ts#L12)

apps/docs/docs/api/interfaces/ChatEngine.md

@@ -0,0 +1,54 @@
+---
+id: "ChatEngine"
+title: "Interface: ChatEngine"
+sidebar_label: "ChatEngine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A ChatEngine is used to handle back and forth chats between the application and the LLM.
+
+## Implemented by
+
+- [`CondenseQuestionChatEngine`](../classes/CondenseQuestionChatEngine.md)
+- [`ContextChatEngine`](../classes/ContextChatEngine.md)
+- [`SimpleChatEngine`](../classes/SimpleChatEngine.md)
+
+## Methods
+
+### chat
+
+▸ **chat**(`message`, `chatHistory?`): `Promise`<[`Response`](../classes/Response.md)\>
+
+Send message along with the class's current chat history to the LLM.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `message` | `string` |  |
+| `chatHistory?` | [`ChatMessage`](ChatMessage.md)[] | optional chat history if you want to customize the chat history |
+
+#### Returns
+
+`Promise`<[`Response`](../classes/Response.md)\>
+
+#### Defined in
+
+[ChatEngine.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L25)
+
+___
+
+### reset
+
+▸ **reset**(): `void`
+
+Resets the chat history so that it's empty.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[ChatEngine.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L30)

apps/docs/docs/api/interfaces/ChatMessage.md

@@ -0,0 +1,27 @@
+---
+id: "ChatMessage"
+title: "Interface: ChatMessage"
+sidebar_label: "ChatMessage"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### content
+
+• **content**: `string`
+
+#### Defined in
+
+[llm/LLM.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L28)
+
+___
+
+### role
+
+• **role**: [`MessageType`](../modules.md#messagetype)
+
+#### Defined in
+
+[llm/LLM.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L29)

apps/docs/docs/api/interfaces/ChatResponse.md

@@ -0,0 +1,37 @@
+---
+id: "ChatResponse"
+title: "Interface: ChatResponse"
+sidebar_label: "ChatResponse"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### delta
+
+• `Optional` **delta**: `string`
+
+#### Defined in
+
+[llm/LLM.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L35)
+
+___
+
+### message
+
+• **message**: [`ChatMessage`](ChatMessage.md)
+
+#### Defined in
+
+[llm/LLM.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L33)
+
+___
+
+### raw
+
+• `Optional` **raw**: `Record`<`string`, `any`\>
+
+#### Defined in
+
+[llm/LLM.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L34)

apps/docs/docs/api/interfaces/Event.md

@@ -0,0 +1,47 @@
+---
+id: "Event"
+title: "Interface: Event"
+sidebar_label: "Event"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L13)
+
+___
+
+### parentId
+
+• `Optional` **parentId**: `string`
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L16)
+
+___
+
+### tags
+
+• `Optional` **tags**: [`EventTag`](../modules.md#eventtag)[]
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L15)
+
+___
+
+### type
+
+• **type**: [`EventType`](../modules.md#eventtype)
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L14)

apps/docs/docs/api/interfaces/ExactMatchFilter.md

@@ -0,0 +1,37 @@
+---
+id: "ExactMatchFilter"
+title: "Interface: ExactMatchFilter"
+sidebar_label: "ExactMatchFilter"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### filterType
+
+• **filterType**: ``"ExactMatch"``
+
+#### Defined in
+
+[storage/vectorStore/types.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L24)
+
+___
+
+### key
+
+• **key**: `string`
+
+#### Defined in
+
+[storage/vectorStore/types.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L25)
+
+___
+
+### value
+
+• **value**: `string` \| `number`
+
+#### Defined in
+
+[storage/vectorStore/types.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L26)

apps/docs/docs/api/interfaces/GenericFileSystem.md

@@ -0,0 +1,100 @@
+---
+id: "GenericFileSystem"
+title: "Interface: GenericFileSystem"
+sidebar_label: "GenericFileSystem"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A filesystem interface that is meant to be compatible with
+the 'fs' module from Node.js.
+Allows for the use of similar inteface implementation on
+browsers.
+
+## Implemented by
+
+- [`InMemoryFileSystem`](../classes/InMemoryFileSystem.md)
+
+## Methods
+
+### access
+
+▸ **access**(`path`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[storage/FileSystem.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L12)
+
+___
+
+### mkdir
+
+▸ **mkdir**(`path`, `options?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+| `options?` | `any` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L13)
+
+___
+
+### readFile
+
+▸ **readFile**(`path`, `options?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+| `options?` | `any` |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L11)
+
+___
+
+### writeFile
+
+▸ **writeFile**(`path`, `content`, `options?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+| `content` | `string` |
+| `options?` | `any` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L10)

apps/docs/docs/api/interfaces/LLM.md

@@ -0,0 +1,61 @@
+---
+id: "LLM"
+title: "Interface: LLM"
+sidebar_label: "LLM"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Unified language model interface
+
+## Implemented by
+
+- [`Anthropic`](../classes/Anthropic.md)
+- [`LlamaDeuce`](../classes/LlamaDeuce.md)
+- [`OpenAI`](../classes/OpenAI.md)
+
+## Methods
+
+### chat
+
+▸ **chat**(`messages`, `parentEvent?`): `Promise`<[`ChatResponse`](ChatResponse.md)\>
+
+Get a chat response from the LLM
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messages` | [`ChatMessage`](ChatMessage.md)[] |
+| `parentEvent?` | [`Event`](Event.md) |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](ChatResponse.md)\>
+
+#### Defined in
+
+[llm/LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L49)
+
+___
+
+### complete
+
+▸ **complete**(`prompt`, `parentEvent?`): `Promise`<[`ChatResponse`](ChatResponse.md)\>
+
+Get a prompt completion from the LLM
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `prompt` | `string` | the prompt to complete |
+| `parentEvent?` | [`Event`](Event.md) | - |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](ChatResponse.md)\>
+
+#### Defined in
+
+[llm/LLM.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L55)

apps/docs/docs/api/interfaces/MetadataFilters.md

@@ -0,0 +1,17 @@
+---
+id: "MetadataFilters"
+title: "Interface: MetadataFilters"
+sidebar_label: "MetadataFilters"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### filters
+
+• **filters**: [`ExactMatchFilter`](ExactMatchFilter.md)[]
+
+#### Defined in
+
+[storage/vectorStore/types.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L30)

apps/docs/docs/api/interfaces/MetadataInfo.md

@@ -0,0 +1,37 @@
+---
+id: "MetadataInfo"
+title: "Interface: MetadataInfo"
+sidebar_label: "MetadataInfo"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### description
+
+• **description**: `string`
+
+#### Defined in
+
+[storage/vectorStore/types.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L42)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[storage/vectorStore/types.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L40)
+
+___
+
+### type
+
+• **type**: `string`
+
+#### Defined in
+
+[storage/vectorStore/types.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L41)

apps/docs/docs/api/interfaces/NodeParser.md

@@ -0,0 +1,37 @@
+---
+id: "NodeParser"
+title: "Interface: NodeParser"
+sidebar_label: "NodeParser"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A NodeParser generates TextNodes from Documents
+
+## Implemented by
+
+- [`SimpleNodeParser`](../classes/SimpleNodeParser.md)
+
+## Methods
+
+### getNodesFromDocuments
+
+▸ **getNodesFromDocuments**(`documents`): [`TextNode`](../classes/TextNode.md)[]
+
+Generates an array of nodes from an array of documents.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `documents` | [`Document`](../classes/Document.md)[] | The documents to generate nodes from. |
+
+#### Returns
+
+[`TextNode`](../classes/TextNode.md)[]
+
+An array of nodes.
+
+#### Defined in
+
+[NodeParser.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/NodeParser.ts#L73)

apps/docs/docs/api/interfaces/NodeWithEmbedding.md

@@ -0,0 +1,29 @@
+---
+id: "NodeWithEmbedding"
+title: "Interface: NodeWithEmbedding"
+sidebar_label: "NodeWithEmbedding"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A node with an embedding
+
+## Properties
+
+### embedding
+
+• **embedding**: `number`[]
+
+#### Defined in
+
+[Node.ts:277](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L277)
+
+___
+
+### node
+
+• **node**: [`BaseNode`](../classes/BaseNode.md)
+
+#### Defined in
+
+[Node.ts:276](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L276)

apps/docs/docs/api/interfaces/NodeWithScore.md

@@ -0,0 +1,29 @@
+---
+id: "NodeWithScore"
+title: "Interface: NodeWithScore"
+sidebar_label: "NodeWithScore"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A node with a similarity score
+
+## Properties
+
+### node
+
+• **node**: [`BaseNode`](../classes/BaseNode.md)
+
+#### Defined in
+
+[Node.ts:268](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L268)
+
+___
+
+### score
+
+• **score**: `number`
+
+#### Defined in
+
+[Node.ts:269](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L269)

apps/docs/docs/api/interfaces/QueryEngineTool.md

@@ -0,0 +1,39 @@
+---
+id: "QueryEngineTool"
+title: "Interface: QueryEngineTool"
+sidebar_label: "QueryEngineTool"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A Tool that uses a QueryEngine.
+
+## Hierarchy
+
+- [`BaseTool`](BaseTool.md)
+
+  ↳ **`QueryEngineTool`**
+
+## Properties
+
+### metadata
+
+• **metadata**: [`ToolMetadata`](ToolMetadata.md)
+
+#### Inherited from
+
+[BaseTool](BaseTool.md).[metadata](BaseTool.md#metadata)
+
+#### Defined in
+
+[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Tool.ts#L12)
+
+___
+
+### queryEngine
+
+• **queryEngine**: [`BaseQueryEngine`](BaseQueryEngine.md)
+
+#### Defined in
+
+[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Tool.ts#L19)

apps/docs/docs/api/interfaces/RelatedNodeInfo.md

@@ -0,0 +1,47 @@
+---
+id: "RelatedNodeInfo"
+title: "Interface: RelatedNodeInfo"
+sidebar_label: "RelatedNodeInfo"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### hash
+
+• `Optional` **hash**: `string`
+
+#### Defined in
+
+[Node.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L29)
+
+___
+
+### metadata
+
+• **metadata**: `Record`<`string`, `any`\>
+
+#### Defined in
+
+[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L28)
+
+___
+
+### nodeId
+
+• **nodeId**: `string`
+
+#### Defined in
+
+[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L26)
+
+___
+
+### nodeType
+
+• `Optional` **nodeType**: [`ObjectType`](../enums/ObjectType.md)
+
+#### Defined in
+
+[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L27)

apps/docs/docs/api/interfaces/RetrievalCallbackResponse.md

@@ -0,0 +1,47 @@
+---
+id: "RetrievalCallbackResponse"
+title: "Interface: RetrievalCallbackResponse"
+sidebar_label: "RetrievalCallbackResponse"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Hierarchy
+
+- `BaseCallbackResponse`
+
+  ↳ **`RetrievalCallbackResponse`**
+
+## Properties
+
+### event
+
+• **event**: [`Event`](Event.md)
+
+#### Inherited from
+
+BaseCallbackResponse.event
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L20)
+
+___
+
+### nodes
+
+• **nodes**: [`NodeWithScore`](NodeWithScore.md)[]
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L46)
+
+___
+
+### query
+
+• **query**: `string`
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L45)

apps/docs/docs/api/interfaces/ServiceContext.md

@@ -0,0 +1,59 @@
+---
+id: "ServiceContext"
+title: "Interface: ServiceContext"
+sidebar_label: "ServiceContext"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+The ServiceContext is a collection of components that are used in different parts of the application.
+
+## Properties
+
+### callbackManager
+
+• **callbackManager**: [`CallbackManager`](../classes/CallbackManager.md)
+
+#### Defined in
+
+[ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ServiceContext.ts#L15)
+
+___
+
+### embedModel
+
+• **embedModel**: [`BaseEmbedding`](../classes/BaseEmbedding.md)
+
+#### Defined in
+
+[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ServiceContext.ts#L13)
+
+___
+
+### llm
+
+• **llm**: [`LLM`](LLM.md)
+
+#### Defined in
+
+[ServiceContext.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ServiceContext.ts#L11)
+
+___
+
+### nodeParser
+
+• **nodeParser**: [`NodeParser`](NodeParser.md)
+
+#### Defined in
+
+[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ServiceContext.ts#L14)
+
+___
+
+### promptHelper
+
+• **promptHelper**: `PromptHelper`
+
+#### Defined in
+
+[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ServiceContext.ts#L12)

apps/docs/docs/api/interfaces/ServiceContextOptions.md

@@ -0,0 +1,77 @@
+---
+id: "ServiceContextOptions"
+title: "Interface: ServiceContextOptions"
+sidebar_label: "ServiceContextOptions"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### callbackManager
+
+• `Optional` **callbackManager**: [`CallbackManager`](../classes/CallbackManager.md)
+
+#### Defined in
+
+[ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ServiceContext.ts#L24)
+
+___
+
+### chunkOverlap
+
+• `Optional` **chunkOverlap**: `number`
+
+#### Defined in
+
+[ServiceContext.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ServiceContext.ts#L27)
+
+___
+
+### chunkSize
+
+• `Optional` **chunkSize**: `number`
+
+#### Defined in
+
+[ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ServiceContext.ts#L26)
+
+___
+
+### embedModel
+
+• `Optional` **embedModel**: [`BaseEmbedding`](../classes/BaseEmbedding.md)
+
+#### Defined in
+
+[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ServiceContext.ts#L22)
+
+___
+
+### llm
+
+• `Optional` **llm**: [`LLM`](LLM.md)
+
+#### Defined in
+
+[ServiceContext.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ServiceContext.ts#L20)
+
+___
+
+### nodeParser
+
+• `Optional` **nodeParser**: [`NodeParser`](NodeParser.md)
+
+#### Defined in
+
+[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ServiceContext.ts#L23)
+
+___
+
+### promptHelper
+
+• `Optional` **promptHelper**: `PromptHelper`
+
+#### Defined in
+
+[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ServiceContext.ts#L21)

apps/docs/docs/api/interfaces/StorageContext.md

@@ -0,0 +1,37 @@
+---
+id: "StorageContext"
+title: "Interface: StorageContext"
+sidebar_label: "StorageContext"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### docStore
+
+• **docStore**: `BaseDocumentStore`
+
+#### Defined in
+
+[storage/StorageContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/StorageContext.ts#L15)
+
+___
+
+### indexStore
+
+• **indexStore**: `BaseIndexStore`
+
+#### Defined in
+
+[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/StorageContext.ts#L16)
+
+___
+
+### vectorStore
+
+• **vectorStore**: [`VectorStore`](VectorStore.md)
+
+#### Defined in
+
+[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/StorageContext.ts#L17)

apps/docs/docs/api/interfaces/StreamCallbackResponse.md

@@ -0,0 +1,57 @@
+---
+id: "StreamCallbackResponse"
+title: "Interface: StreamCallbackResponse"
+sidebar_label: "StreamCallbackResponse"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Hierarchy
+
+- `BaseCallbackResponse`
+
+  ↳ **`StreamCallbackResponse`**
+
+## Properties
+
+### event
+
+• **event**: [`Event`](Event.md)
+
+#### Inherited from
+
+BaseCallbackResponse.event
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L20)
+
+___
+
+### index
+
+• **index**: `number`
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L39)
+
+___
+
+### isDone
+
+• `Optional` **isDone**: `boolean`
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L40)
+
+___
+
+### token
+
+• `Optional` **token**: [`StreamToken`](StreamToken.md)
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L41)

apps/docs/docs/api/interfaces/StreamToken.md

@@ -0,0 +1,57 @@
+---
+id: "StreamToken"
+title: "Interface: StreamToken"
+sidebar_label: "StreamToken"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### choices
+
+• **choices**: { `delta`: { `content?`: ``null`` \| `string` ; `role?`: ``"function"`` \| ``"user"`` \| ``"assistant"`` \| ``"system"``  } ; `finish_reason`: ``null`` \| `string` ; `index`: `number`  }[]
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L28)
+
+___
+
+### created
+
+• **created**: `number`
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L26)
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L24)
+
+___
+
+### model
+
+• **model**: `string`
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L27)
+
+___
+
+### object
+
+• **object**: `string`
+
+#### Defined in
+
+[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L25)

apps/docs/docs/api/interfaces/StructuredOutput.md

@@ -0,0 +1,35 @@
+---
+id: "StructuredOutput"
+title: "Interface: StructuredOutput<T>"
+sidebar_label: "StructuredOutput"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+StructuredOutput is just a combo of the raw output and the parsed output.
+
+## Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+## Properties
+
+### parsedOutput
+
+• **parsedOutput**: `T`
+
+#### Defined in
+
+[OutputParser.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/OutputParser.ts#L16)
+
+___
+
+### rawOutput
+
+• **rawOutput**: `string`
+
+#### Defined in
+
+[OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/OutputParser.ts#L15)

apps/docs/docs/api/interfaces/SubQuestion.md

@@ -0,0 +1,27 @@
+---
+id: "SubQuestion"
+title: "Interface: SubQuestion"
+sidebar_label: "SubQuestion"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### subQuestion
+
+• **subQuestion**: `string`
+
+#### Defined in
+
+[QuestionGenerator.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QuestionGenerator.ts#L15)
+
+___
+
+### toolName
+
+• **toolName**: `string`
+
+#### Defined in
+
+[QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QuestionGenerator.ts#L16)

apps/docs/docs/api/interfaces/ToolMetadata.md

@@ -0,0 +1,27 @@
+---
+id: "ToolMetadata"
+title: "Interface: ToolMetadata"
+sidebar_label: "ToolMetadata"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### description
+
+• **description**: `string`
+
+#### Defined in
+
+[Tool.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Tool.ts#L4)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Tool.ts#L5)

apps/docs/docs/api/interfaces/VectorIndexConstructorProps.md

@@ -0,0 +1,97 @@
+---
+id: "VectorIndexConstructorProps"
+title: "Interface: VectorIndexConstructorProps"
+sidebar_label: "VectorIndexConstructorProps"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Hierarchy
+
+- [`BaseIndexInit`](BaseIndexInit.md)<[`IndexDict`](../classes/IndexDict.md)\>
+
+  ↳ **`VectorIndexConstructorProps`**
+
+## Properties
+
+### docStore
+
+• **docStore**: `BaseDocumentStore`
+
+#### Inherited from
+
+[BaseIndexInit](BaseIndexInit.md).[docStore](BaseIndexInit.md#docstore)
+
+#### Defined in
+
+[indices/BaseIndex.ts:109](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L109)
+
+___
+
+### indexStore
+
+• `Optional` **indexStore**: `BaseIndexStore`
+
+#### Inherited from
+
+[BaseIndexInit](BaseIndexInit.md).[indexStore](BaseIndexInit.md#indexstore)
+
+#### Defined in
+
+[indices/BaseIndex.ts:111](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L111)
+
+___
+
+### indexStruct
+
+• **indexStruct**: [`IndexDict`](../classes/IndexDict.md)
+
+#### Inherited from
+
+[BaseIndexInit](BaseIndexInit.md).[indexStruct](BaseIndexInit.md#indexstruct)
+
+#### Defined in
+
+[indices/BaseIndex.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L112)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](ServiceContext.md)
+
+#### Inherited from
+
+[BaseIndexInit](BaseIndexInit.md).[serviceContext](BaseIndexInit.md#servicecontext)
+
+#### Defined in
+
+[indices/BaseIndex.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L107)
+
+___
+
+### storageContext
+
+• **storageContext**: [`StorageContext`](StorageContext.md)
+
+#### Inherited from
+
+[BaseIndexInit](BaseIndexInit.md).[storageContext](BaseIndexInit.md#storagecontext)
+
+#### Defined in
+
+[indices/BaseIndex.ts:108](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L108)
+
+___
+
+### vectorStore
+
+• **vectorStore**: [`VectorStore`](VectorStore.md)
+
+#### Overrides
+
+[BaseIndexInit](BaseIndexInit.md).[vectorStore](BaseIndexInit.md#vectorstore)
+
+#### Defined in
+
+[indices/BaseIndex.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L162)

apps/docs/docs/api/interfaces/VectorIndexOptions.md

@@ -0,0 +1,57 @@
+---
+id: "VectorIndexOptions"
+title: "Interface: VectorIndexOptions"
+sidebar_label: "VectorIndexOptions"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### indexId
+
+• `Optional` **indexId**: `string`
+
+#### Defined in
+
+[indices/BaseIndex.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L156)
+
+___
+
+### indexStruct
+
+• `Optional` **indexStruct**: [`IndexDict`](../classes/IndexDict.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L155)
+
+___
+
+### nodes
+
+• `Optional` **nodes**: [`BaseNode`](../classes/BaseNode.md)[]
+
+#### Defined in
+
+[indices/BaseIndex.ts:154](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L154)
+
+___
+
+### serviceContext
+
+• `Optional` **serviceContext**: [`ServiceContext`](ServiceContext.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L157)
+
+___
+
+### storageContext
+
+• `Optional` **storageContext**: [`StorageContext`](StorageContext.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:158](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L158)

apps/docs/docs/api/interfaces/VectorStore.md

@@ -0,0 +1,124 @@
+---
+id: "VectorStore"
+title: "Interface: VectorStore"
+sidebar_label: "VectorStore"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### isEmbeddingQuery
+
+• `Optional` **isEmbeddingQuery**: `boolean`
+
+#### Defined in
+
+[storage/vectorStore/types.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L63)
+
+___
+
+### storesText
+
+• **storesText**: `boolean`
+
+#### Defined in
+
+[storage/vectorStore/types.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L62)
+
+## Methods
+
+### add
+
+▸ **add**(`embeddingResults`): `Promise`<`string`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `embeddingResults` | [`NodeWithEmbedding`](NodeWithEmbedding.md)[] |
+
+#### Returns
+
+`Promise`<`string`[]\>
+
+#### Defined in
+
+[storage/vectorStore/types.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L65)
+
+___
+
+### client
+
+▸ **client**(): `any`
+
+#### Returns
+
+`any`
+
+#### Defined in
+
+[storage/vectorStore/types.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L64)
+
+___
+
+### delete
+
+▸ **delete**(`refDocId`, `deleteKwargs?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `refDocId` | `string` |
+| `deleteKwargs?` | `any` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[storage/vectorStore/types.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L66)
+
+___
+
+### persist
+
+▸ **persist**(`persistPath`, `fs?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `persistPath` | `string` |
+| `fs?` | [`GenericFileSystem`](GenericFileSystem.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[storage/vectorStore/types.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L68)
+
+___
+
+### query
+
+▸ **query**(`query`, `kwargs?`): `Promise`<[`VectorStoreQueryResult`](VectorStoreQueryResult.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | [`VectorStoreQuery`](VectorStoreQuery.md) |
+| `kwargs?` | `any` |
+
+#### Returns
+
+`Promise`<[`VectorStoreQueryResult`](VectorStoreQueryResult.md)\>
+
+#### Defined in
+
+[storage/vectorStore/types.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L67)

apps/docs/docs/api/interfaces/VectorStoreInfo.md

@@ -0,0 +1,27 @@
+---
+id: "VectorStoreInfo"
+title: "Interface: VectorStoreInfo"
+sidebar_label: "VectorStoreInfo"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### contentInfo
+
+• **contentInfo**: `string`
+
+#### Defined in
+
+[storage/vectorStore/types.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L47)
+
+___
+
+### metadataInfo
+
+• **metadataInfo**: [`MetadataInfo`](MetadataInfo.md)[]
+
+#### Defined in
+
+[storage/vectorStore/types.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L46)

apps/docs/docs/api/interfaces/VectorStoreQuery.md

@@ -0,0 +1,87 @@
+---
+id: "VectorStoreQuery"
+title: "Interface: VectorStoreQuery"
+sidebar_label: "VectorStoreQuery"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### alpha
+
+• `Optional` **alpha**: `number`
+
+#### Defined in
+
+[storage/vectorStore/types.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L56)
+
+___
+
+### docIds
+
+• `Optional` **docIds**: `string`[]
+
+#### Defined in
+
+[storage/vectorStore/types.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L53)
+
+___
+
+### filters
+
+• `Optional` **filters**: [`MetadataFilters`](MetadataFilters.md)
+
+#### Defined in
+
+[storage/vectorStore/types.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L57)
+
+___
+
+### mmrThreshold
+
+• `Optional` **mmrThreshold**: `number`
+
+#### Defined in
+
+[storage/vectorStore/types.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L58)
+
+___
+
+### mode
+
+• **mode**: [`VectorStoreQueryMode`](../enums/VectorStoreQueryMode.md)
+
+#### Defined in
+
+[storage/vectorStore/types.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L55)
+
+___
+
+### queryEmbedding
+
+• `Optional` **queryEmbedding**: `number`[]
+
+#### Defined in
+
+[storage/vectorStore/types.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L51)
+
+___
+
+### queryStr
+
+• `Optional` **queryStr**: `string`
+
+#### Defined in
+
+[storage/vectorStore/types.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L54)
+
+___
+
+### similarityTopK
+
+• **similarityTopK**: `number`
+
+#### Defined in
+
+[storage/vectorStore/types.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L52)

apps/docs/docs/api/interfaces/VectorStoreQueryResult.md

@@ -0,0 +1,37 @@
+---
+id: "VectorStoreQueryResult"
+title: "Interface: VectorStoreQueryResult"
+sidebar_label: "VectorStoreQueryResult"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### ids
+
+• **ids**: `string`[]
+
+#### Defined in
+
+[storage/vectorStore/types.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L8)
+
+___
+
+### nodes
+
+• `Optional` **nodes**: [`BaseNode`](../classes/BaseNode.md)[]
+
+#### Defined in
+
+[storage/vectorStore/types.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L6)
+
+___
+
+### similarities
+
+• **similarities**: `number`[]
+
+#### Defined in
+
+[storage/vectorStore/types.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L7)

apps/docs/docs/api/interfaces/VectorStoreQuerySpec.md

@@ -0,0 +1,37 @@
+---
+id: "VectorStoreQuerySpec"
+title: "Interface: VectorStoreQuerySpec"
+sidebar_label: "VectorStoreQuerySpec"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### filters
+
+• **filters**: [`ExactMatchFilter`](ExactMatchFilter.md)[]
+
+#### Defined in
+
+[storage/vectorStore/types.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L35)
+
+___
+
+### query
+
+• **query**: `string`
+
+#### Defined in
+
+[storage/vectorStore/types.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L34)
+
+___
+
+### topK
+
+• `Optional` **topK**: `number`
+
+#### Defined in
+
+[storage/vectorStore/types.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L36)

apps/docs/docs/api/interfaces/WalkableFileSystem.md

@@ -0,0 +1,47 @@
+---
+id: "WalkableFileSystem"
+title: "Interface: WalkableFileSystem"
+sidebar_label: "WalkableFileSystem"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Methods
+
+### readdir
+
+▸ **readdir**(`path`): `Promise`<`string`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+
+#### Returns
+
+`Promise`<`string`[]\>
+
+#### Defined in
+
+[storage/FileSystem.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L17)
+
+___
+
+### stat
+
+▸ **stat**(`path`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L18)

apps/docs/docs/api/interfaces/_category_.yml

@@ -0,0 +1,2 @@
+label: "Interfaces"
+position: 4

apps/docs/docusaurus.config.js

@@ -138,7 +138,7 @@ const config = {
       {
         entryPoints: ["../../packages/core/src/index.ts"],
         tsconfig: "../../packages/core/tsconfig.json",
-        readme: "none",
+        gitRevision: "main",
         sidebar: {
           position: 6,
         },

apps/docs/package.json

@@ -20,7 +20,7 @@
     "@docusaurus/remark-plugin-npm2yarn": "^2.4.1",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.2.1",
-    "postcss": "^8.4.28",
+    "postcss": "^8.4.27",
     "prism-react-renderer": "^1.3.5",
     "raw-loader": "^4.0.2",
     "react": "^17.0.2",

apps/simple/CHANGELOG.md

@@ -1,33 +1,5 @@
 # simple
 
-## 0.0.18
-
-### Patch Changes
-
-- Updated dependencies [b526a2d]
-- Updated dependencies [b526a2d]
-- Updated dependencies [b526a2d]
-  - llamaindex@0.0.20
-
-## 0.0.17
-
-### Patch Changes
-
-- Updated dependencies [a747f28]
-- Updated dependencies [355910b]
-- Updated dependencies [355910b]
-  - llamaindex@0.0.19
-
-## 0.0.16
-
-### Patch Changes
-
-- Updated dependencies [824c13c]
-- Updated dependencies [18b8915]
-- Updated dependencies [ade9d8f]
-- Updated dependencies [824c13c]
-  - llamaindex@0.0.18
-
 ## 0.0.15
 
 ### Patch Changes

apps/simple/chatEngine.ts

@@ -1,23 +1,22 @@
-import { stdin as input, stdout as output } from "node:process";
-// readline/promises is still experimental so not in @types/node yet
 // @ts-ignore
-import readline from "node:readline/promises";
-
+import * as readline from "node:readline/promises";
+// @ts-ignore
+import { stdin as input, stdout as output } from "node:process";
 import {
-  ContextChatEngine,
   Document,
-  serviceContextFromDefaults,
   VectorStoreIndex,
+  ContextChatEngine,
+  serviceContextFromDefaults,
 } from "llamaindex";
-
 import essay from "./essay";
 
 async function main() {
   const document = new Document({ text: essay });
   const serviceContext = serviceContextFromDefaults({ chunkSize: 512 });
-  const index = await VectorStoreIndex.fromDocuments([document], {
-    serviceContext,
-  });
+  const index = await VectorStoreIndex.fromDocuments(
+    [document],
+    { serviceContext }
+  );
   const retriever = index.asRetriever();
   retriever.similarityTopK = 5;
   const chatEngine = new ContextChatEngine({ retriever });

apps/simple/csv.ts

@@ -1,52 +0,0 @@
-import {
-  CompactAndRefine,
-  OpenAI,
-  PapaCSVReader,
-  ResponseSynthesizer,
-  serviceContextFromDefaults,
-  SimplePrompt,
-  VectorStoreIndex,
-} from "llamaindex";
-
-async function main() {
-  // Load CSV
-  const reader = new PapaCSVReader();
-  const path = "data/titanic_train.csv";
-  const documents = await reader.loadData(path);
-
-  const serviceContext = serviceContextFromDefaults({
-    llm: new OpenAI({ model: "gpt-4" }),
-  });
-
-  // Split text and create embeddings. Store them in a VectorStoreIndex
-  const index = await VectorStoreIndex.fromDocuments(documents, {
-    serviceContext,
-  });
-
-  const csvPrompt: SimplePrompt = (input) => {
-    const { context = "", query = "" } = input;
-
-    return `The following CSV file is loaded from ${path}
-\`\`\`csv
-${context}
-\`\`\`
-Given the CSV file, generate me Typescript code to answer the question: ${query}. You can use built in NodeJS functions but avoid using third party libraries.
-`;
-  };
-
-  const responseSynthesizer = new ResponseSynthesizer({
-    responseBuilder: new CompactAndRefine(serviceContext, csvPrompt),
-  });
-
-  const queryEngine = index.asQueryEngine({ responseSynthesizer });
-
-  // Query the index
-  const response = await queryEngine.query(
-    "What is the correlation between survival and age?",
-  );
-
-  // Output response
-  console.log(response.toString());
-}
-
-main().catch(console.error);

apps/simple/data/titanic_train.csv

@@ -1,715 +0,0 @@
-survived,pclass,name,sex,age,sibsp,parch,ticket,fare,cabin,embarked
-0,3,Braund,male,22,1,0,A/5 21171,7.25,,S
-1,1,Cumings,female,38,1,0,PC 17599,71.2833,C85,C
-1,3,Heikkinen,female,26,0,0,STON/O2. 3101282,7.925,,S
-1,1,Futrelle,female,35,1,0,113803,53.1,C123,S
-0,3,Allen,male,35,0,0,373450,8.05,,S
-0,1,McCarthy,male,54,0,0,17463,51.8625,E46,S
-0,3,Palsson,male,2,3,1,349909,21.075,,S
-1,3,Johnson,female,27,0,2,347742,11.1333,,S
-1,2,Nasser,female,14,1,0,237736,30.0708,,C
-1,3,Sandstrom,female,4,1,1,PP 9549,16.7,G6,S
-1,1,Bonnell,female,58,0,0,113783,26.55,C103,S
-0,3,Saundercock,male,20,0,0,A/5. 2151,8.05,,S
-0,3,Andersson,male,39,1,5,347082,31.275,,S
-0,3,Vestrom,female,14,0,0,350406,7.8542,,S
-1,2,Hewlett,female,55,0,0,248706,16,,S
-0,3,Rice,male,2,4,1,382652,29.125,,Q
-0,3,Vander,female,31,1,0,345763,18,,S
-0,2,Fynney,male,35,0,0,239865,26,,S
-1,2,Beesley,male,34,0,0,248698,13,D56,S
-1,3,McGowan,female,15,0,0,330923,8.0292,,Q
-1,1,Sloper,male,28,0,0,113788,35.5,A6,S
-0,3,Palsson,female,8,3,1,349909,21.075,,S
-1,3,Asplund,female,38,1,5,347077,31.3875,,S
-0,1,Fortune,male,19,3,2,19950,263,C23 C25 C27,S
-0,1,Uruchurtu,male,40,0,0,PC 17601,27.7208,,C
-0,2,Wheadon,male,66,0,0,C.A. 24579,10.5,,S
-0,1,Meyer,male,28,1,0,PC 17604,82.1708,,C
-0,1,Holverson,male,42,1,0,113789,52,,S
-0,3,Cann,male,21,0,0,A./5. 2152,8.05,,S
-0,3,Vander,female,18,2,0,345764,18,,S
-1,3,Nicola-Yarred,female,14,1,0,2651,11.2417,,C
-0,3,Ahlin,female,40,1,0,7546,9.475,,S
-0,2,Turpin,female,27,1,0,11668,21,,S
-1,2,Laroche,female,3,1,2,SC/Paris 2123,41.5792,,C
-1,3,Devaney,female,19,0,0,330958,7.8792,,Q
-0,3,Arnold-Franchi,female,18,1,0,349237,17.8,,S
-0,3,Panula,male,7,4,1,3101295,39.6875,,S
-0,3,Nosworthy,male,21,0,0,A/4. 39886,7.8,,S
-1,1,Harper,female,49,1,0,PC 17572,76.7292,D33,C
-1,2,Faunthorpe,female,29,1,0,2926,26,,S
-0,1,Ostby,male,65,0,1,113509,61.9792,B30,C
-1,2,Rugg,female,21,0,0,C.A. 31026,10.5,,S
-0,3,Novel,male,28.5,0,0,2697,7.2292,,C
-1,2,West,female,5,1,2,C.A. 34651,27.75,,S
-0,3,Goodwin,male,11,5,2,CA 2144,46.9,,S
-0,3,Sirayanian,male,22,0,0,2669,7.2292,,C
-1,1,Icard,female,38,0,0,113572,80,B28,
-0,1,Harris,male,45,1,0,36973,83.475,C83,S
-0,3,Skoog,male,4,3,2,347088,27.9,,S
-1,2,Nye,female,29,0,0,C.A. 29395,10.5,F33,S
-0,3,Crease,male,19,0,0,S.P. 3464,8.1583,,S
-1,3,Andersson,female,17,4,2,3101281,7.925,,S
-0,3,Kink,male,26,2,0,315151,8.6625,,S
-0,2,Jenkin,male,32,0,0,C.A. 33111,10.5,,S
-0,3,Goodwin,female,16,5,2,CA 2144,46.9,,S
-0,2,Hood,male,21,0,0,S.O.C. 14879,73.5,,S
-0,3,Chronopoulos,male,26,1,0,2680,14.4542,,C
-1,3,Bing,male,32,0,0,1601,56.4958,,S
-0,3,Moen,male,25,0,0,348123,7.65,F G73,S
-1,2,Caldwell,male,0.83,0,2,248738,29,,S
-1,3,Dowdell,female,30,0,0,364516,12.475,,S
-0,3,Waelens,male,22,0,0,345767,9,,S
-1,3,Sheerlinck,male,29,0,0,345779,9.5,,S
-0,1,Carrau,male,28,0,0,113059,47.1,,S
-1,2,Ilett,female,17,0,0,SO/C 14885,10.5,,S
-1,3,Backstrom,female,33,3,0,3101278,15.85,,S
-0,3,Ford,male,16,1,3,W./C. 6608,34.375,,S
-1,1,Fortune,female,23,3,2,19950,263,C23 C25 C27,S
-0,3,Celotti,male,24,0,0,343275,8.05,,S
-0,3,Christmann,male,29,0,0,343276,8.05,,S
-0,3,Andreasson,male,20,0,0,347466,7.8542,,S
-0,1,Chaffee,male,46,1,0,W.E.P. 5734,61.175,E31,S
-0,3,Dean,male,26,1,2,C.A. 2315,20.575,,S
-0,3,Coxon,male,59,0,0,364500,7.25,,S
-0,1,Goldschmidt,male,71,0,0,PC 17754,34.6542,A5,C
-1,1,Greenfield,male,23,0,1,PC 17759,63.3583,D10 D12,C
-1,2,Doling,female,34,0,1,231919,23,,S
-0,2,Kantor,male,34,1,0,244367,26,,S
-0,3,Petranec,female,28,0,0,349245,7.8958,,S
-0,1,White,male,21,0,1,35281,77.2875,D26,S
-0,3,Johansson,male,33,0,0,7540,8.6542,,S
-0,3,Gustafsson,male,37,2,0,3101276,7.925,,S
-0,3,Mionoff,male,28,0,0,349207,7.8958,,S
-1,3,Salkjelsvik,female,21,0,0,343120,7.65,,S
-0,3,Rekic,male,38,0,0,349249,7.8958,,S
-0,1,Porter,male,47,0,0,110465,52,C110,S
-0,3,Zabour,female,14.5,1,0,2665,14.4542,,C
-0,3,Barton,male,22,0,0,324669,8.05,,S
-0,3,Jussila,female,20,1,0,4136,9.825,,S
-0,3,Attalah,female,17,0,0,2627,14.4583,,C
-0,3,Pekoniemi,male,21,0,0,STON/O 2. 3101294,7.925,,S
-0,3,Connors,male,70.5,0,0,370369,7.75,,Q
-0,2,Turpin,male,29,1,0,11668,21,,S
-0,1,Baxter,male,24,0,1,PC 17558,247.5208,B58 B60,C
-0,3,Andersson,female,2,4,2,347082,31.275,,S
-0,2,Hickman,male,21,2,0,S.O.C. 14879,73.5,,S
-0,2,Nasser,male,32.5,1,0,237736,30.0708,,C
-1,2,Webber,female,32.5,0,0,27267,13,E101,S
-0,1,White,male,54,0,1,35281,77.2875,D26,S
-1,3,Nicola-Yarred,male,12,1,0,2651,11.2417,,C
-1,3,Madsen,male,24,0,0,C 17369,7.1417,,S
-0,3,Ekstrom,male,45,0,0,347061,6.975,,S
-0,3,Drazenoic,male,33,0,0,349241,7.8958,,C
-0,3,Coelho,male,20,0,0,SOTON/O.Q. 3101307,7.05,,S
-0,3,Robins,female,47,1,0,A/5. 3337,14.5,,S
-1,2,Weisz,female,29,1,0,228414,26,,S
-0,2,Sobey,male,25,0,0,C.A. 29178,13,,S
-0,2,Richard,male,23,0,0,SC/PARIS 2133,15.0458,,C
-1,1,Newsom,female,19,0,2,11752,26.2833,D47,S
-0,1,Futrelle,male,37,1,0,113803,53.1,C123,S
-0,3,Osen,male,16,0,0,7534,9.2167,,S
-0,1,Giglio,male,24,0,0,PC 17593,79.2,B86,C
-1,3,Nysten,female,22,0,0,347081,7.75,,S
-1,3,Hakkarainen,female,24,1,0,STON/O2. 3101279,15.85,,S
-0,3,Burke,male,19,0,0,365222,6.75,,Q
-0,2,Andrew,male,18,0,0,231945,11.5,,S
-0,2,Nicholls,male,19,1,1,C.A. 33112,36.75,,S
-1,3,Andersson,male,27,0,0,350043,7.7958,,S
-0,3,Ford,female,9,2,2,W./C. 6608,34.375,,S
-0,2,Navratil,male,36.5,0,2,230080,26,F2,S
-0,2,Byles,male,42,0,0,244310,13,,S
-0,2,Bateman,male,51,0,0,S.O.P. 1166,12.525,,S
-1,1,Pears,female,22,1,0,113776,66.6,C2,S
-0,3,Meo,male,55.5,0,0,A.5. 11206,8.05,,S
-0,3,van,male,40.5,0,2,A/5. 851,14.5,,S
-0,1,Williams,male,51,0,1,PC 17597,61.3792,,C
-1,3,Gilnagh,female,16,0,0,35851,7.7333,,Q
-0,3,Corn,male,30,0,0,SOTON/OQ 392090,8.05,,S
-0,3,Cribb,male,44,0,1,371362,16.1,,S
-1,2,Watt,female,40,0,0,C.A. 33595,15.75,,S
-0,3,Bengtsson,male,26,0,0,347068,7.775,,S
-0,3,Calic,male,17,0,0,315093,8.6625,,S
-0,3,Panula,male,1,4,1,3101295,39.6875,,S
-1,3,Goldsmith,male,9,0,2,363291,20.525,,S
-0,3,Skoog,female,45,1,4,347088,27.9,,S
-0,3,Ling,male,28,0,0,1601,56.4958,,S
-0,1,Van,male,61,0,0,111240,33.5,B19,S
-0,3,Rice,male,4,4,1,382652,29.125,,Q
-1,3,Johnson,female,1,1,1,347742,11.1333,,S
-0,3,Sivola,male,21,0,0,STON/O 2. 3101280,7.925,,S
-0,1,Smith,male,56,0,0,17764,30.6958,A7,C
-0,3,Klasen,male,18,1,1,350404,7.8542,,S
-0,1,Isham,female,50,0,0,PC 17595,28.7125,C49,C
-0,2,Hale,male,30,0,0,250653,13,,S
-0,3,Leonard,male,36,0,0,LINE,0,,S
-0,3,Asplund,male,9,4,2,347077,31.3875,,S
-1,2,Becker,male,1,2,1,230136,39,F4,S
-1,3,Kink-Heilmann,female,4,0,2,315153,22.025,,S
-1,1,Romaine,male,45,0,0,111428,26.55,,S
-0,3,Bourke,male,40,1,1,364849,15.5,,Q
-0,3,Turcin,male,36,0,0,349247,7.8958,,S
-1,2,Pinsky,female,32,0,0,234604,13,,S
-0,2,Carbines,male,19,0,0,28424,13,,S
-1,3,Andersen-Jensen,female,19,1,0,350046,7.8542,,S
-1,2,Navratil,male,3,1,1,230080,26,F2,S
-1,1,Brown,female,44,0,0,PC 17610,27.7208,B4,C
-1,1,Lurette,female,58,0,0,PC 17569,146.5208,B80,C
-0,3,Olsen,male,42,0,1,4579,8.4042,,S
-0,2,Yrois,female,24,0,0,248747,13,,S
-0,3,Vande,male,28,0,0,345770,9.5,,S
-0,3,Johanson,male,34,0,0,3101264,6.4958,,S
-0,3,Youseff,male,45.5,0,0,2628,7.225,,C
-1,3,Cohen,male,18,0,0,A/5 3540,8.05,,S
-0,3,Strom,female,2,0,1,347054,10.4625,G6,S
-0,3,Backstrom,male,32,1,0,3101278,15.85,,S
-1,3,Albimona,male,26,0,0,2699,18.7875,,C
-1,3,Carr,female,16,0,0,367231,7.75,,Q
-1,1,Blank,male,40,0,0,112277,31,A31,C
-0,3,Ali,male,24,0,0,SOTON/O.Q. 3101311,7.05,,S
-1,2,Cameron,female,35,0,0,F.C.C. 13528,21,,S
-0,3,Perkin,male,22,0,0,A/5 21174,7.25,,S
-0,2,Givard,male,30,0,0,250646,13,,S
-1,1,Newell,female,31,1,0,35273,113.275,D36,C
-1,3,Honkanen,female,27,0,0,STON/O2. 3101283,7.925,,S
-0,2,Jacobsohn,male,42,1,0,243847,27,,S
-1,1,Bazzani,female,32,0,0,11813,76.2917,D15,C
-0,2,Harris,male,30,0,0,W/C 14208,10.5,,S
-1,3,Sunderland,male,16,0,0,SOTON/OQ 392089,8.05,,S
-0,2,Bracken,male,27,0,0,220367,13,,S
-0,3,Green,male,51,0,0,21440,8.05,,S
-1,1,Hoyt,male,38,1,0,19943,90,C93,S
-0,3,Berglund,male,22,0,0,PP 4348,9.35,,S
-1,2,Mellors,male,19,0,0,SW/PP 751,10.5,,S
-0,3,Lovell,male,20.5,0,0,A/5 21173,7.25,,S
-0,2,Fahlstrom,male,18,0,0,236171,13,,S
-1,1,Harris,female,35,1,0,36973,83.475,C83,S
-0,3,Larsson,male,29,0,0,347067,7.775,,S
-0,2,Sjostedt,male,59,0,0,237442,13.5,,S
-1,3,Asplund,female,5,4,2,347077,31.3875,,S
-0,2,Leyson,male,24,0,0,C.A. 29566,10.5,,S
-0,2,Hold,male,44,1,0,26707,26,,S
-1,2,Collyer,female,8,0,2,C.A. 31921,26.25,,S
-0,2,Pengelly,male,19,0,0,28665,10.5,,S
-0,2,Hunt,male,33,0,0,SCO/W 1585,12.275,,S
-0,2,Coleridge,male,29,0,0,W./C. 14263,10.5,,S
-0,3,Maenpaa,male,22,0,0,STON/O 2. 3101275,7.125,,S
-0,3,Attalah,male,30,0,0,2694,7.225,,C
-0,1,Minahan,male,44,2,0,19928,90,C78,Q
-0,3,Lindahl,female,25,0,0,347071,7.775,,S
-1,2,Hamalainen,female,24,0,2,250649,14.5,,S
-1,1,Beckwith,male,37,1,1,11751,52.5542,D35,S
-0,2,Carter,male,54,1,0,244252,26,,S
-0,3,Strom,female,29,1,1,347054,10.4625,G6,S
-0,1,Stead,male,62,0,0,113514,26.55,C87,S
-0,3,Lobb,male,30,1,0,A/5. 3336,16.1,,S
-0,3,Rosblom,female,41,0,2,370129,20.2125,,S
-1,3,Touma,female,29,0,2,2650,15.2458,,C
-1,1,Cherry,female,30,0,0,110152,86.5,B77,S
-1,1,Ward,female,35,0,0,PC 17755,512.3292,,C
-1,2,Parrish,female,50,0,1,230433,26,,S
-1,3,Asplund,male,3,4,2,347077,31.3875,,S
-0,1,Taussig,male,52,1,1,110413,79.65,E67,S
-0,1,Harrison,male,40,0,0,112059,0,B94,S
-0,2,Reeves,male,36,0,0,C.A. 17248,10.5,,S
-0,3,Panula,male,16,4,1,3101295,39.6875,,S
-1,3,Persson,male,25,1,0,347083,7.775,,S
-1,1,Graham,female,58,0,1,PC 17582,153.4625,C125,S
-1,1,Bissette,female,35,0,0,PC 17760,135.6333,C99,S
-1,3,Tornquist,male,25,0,0,LINE,0,,S
-1,2,Mellinger,female,41,0,1,250644,19.5,,S
-0,1,Natsch,male,37,0,1,PC 17596,29.7,C118,C
-1,1,Andrews,female,63,1,0,13502,77.9583,D7,S
-0,3,Lindblom,female,45,0,0,347073,7.75,,S
-0,3,Rice,male,7,4,1,382652,29.125,,Q
-1,3,Abbott,female,35,1,1,C.A. 2673,20.25,,S
-0,3,Duane,male,65,0,0,336439,7.75,,Q
-0,3,Olsson,male,28,0,0,347464,7.8542,,S
-0,3,de,male,16,0,0,345778,9.5,,S
-1,3,Dorking,male,19,0,0,A/5. 10482,8.05,,S
-0,3,Stankovic,male,33,0,0,349239,8.6625,,C
-1,3,de,male,30,0,0,345774,9.5,,S
-0,3,Naidenoff,male,22,0,0,349206,7.8958,,S
-1,2,Hosono,male,42,0,0,237798,13,,S
-1,3,Connolly,female,22,0,0,370373,7.75,,Q
-1,1,Barber,female,26,0,0,19877,78.85,,S
-1,1,Bishop,female,19,1,0,11967,91.0792,B49,C
-0,2,Levy,male,36,0,0,SC/Paris 2163,12.875,D,C
-0,3,Haas,female,24,0,0,349236,8.85,,S
-0,3,Mineff,male,24,0,0,349233,7.8958,,S
-0,3,Hanna,male,23.5,0,0,2693,7.2292,,C
-0,1,Allison,female,2,1,2,113781,151.55,C22 C26,S
-1,1,Baxter,female,50,0,1,PC 17558,247.5208,B58 B60,C
-0,3,Johnson,male,19,0,0,LINE,0,,S
-1,1,Allison,male,0.92,1,2,113781,151.55,C22 C26,S
-1,1,Penasco,female,17,1,0,PC 17758,108.9,C65,C
-0,2,Abelson,male,30,1,0,P/PP 3381,24,,C
-1,1,Francatelli,female,30,0,0,PC 17485,56.9292,E36,C
-1,1,Hays,female,24,0,0,11767,83.1583,C54,C
-1,1,Ryerson,female,18,2,2,PC 17608,262.375,B57 B59 B63 B66,C
-0,2,Lahtinen,female,26,1,1,250651,26,,S
-0,3,Hendekovic,male,28,0,0,349243,7.8958,,S
-0,2,Hart,male,43,1,1,F.C.C. 13529,26.25,,S
-1,3,Nilsson,female,26,0,0,347470,7.8542,,S
-1,2,Kantor,female,24,1,0,244367,26,,S
-0,2,Moraweck,male,54,0,0,29011,14,,S
-1,1,Wick,female,31,0,2,36928,164.8667,C7,S
-1,1,Spedden,female,40,1,1,16966,134.5,E34,C
-0,3,Dennis,male,22,0,0,A/5 21172,7.25,,S
-0,3,Danoff,male,27,0,0,349219,7.8958,,S
-1,2,Slayter,female,30,0,0,234818,12.35,,Q
-1,2,Caldwell,female,22,1,1,248738,29,,S
-1,1,Young,female,36,0,0,PC 17760,135.6333,C32,C
-0,3,Nysveen,male,61,0,0,345364,6.2375,,S
-1,2,Ball,female,36,0,0,28551,13,D,S
-1,3,Goldsmith,female,31,1,1,363291,20.525,,S
-1,1,Hippach,female,16,0,1,111361,57.9792,B18,C
-0,1,Partner,male,45.5,0,0,113043,28.5,C124,S
-0,1,Graham,male,38,0,1,PC 17582,153.4625,C91,S
-0,3,Vander,male,16,2,0,345764,18,,S
-0,1,Pears,male,29,1,0,113776,66.6,C2,S
-1,1,Burns,female,41,0,0,16966,134.5,E40,C
-1,3,Dahl,male,45,0,0,7598,8.05,,S
-0,1,Blackwell,male,45,0,0,113784,35.5,T,S
-1,2,Navratil,male,2,1,1,230080,26,F2,S
-1,1,Fortune,female,24,3,2,19950,263,C23 C25 C27,S
-0,2,Collander,male,28,0,0,248740,13,,S
-0,2,Sedgwick,male,25,0,0,244361,13,,S
-0,2,Fox,male,36,0,0,229236,13,,S
-1,2,Brown,female,24,0,0,248733,13,F33,S
-1,2,Smith,female,40,0,0,31418,13,,S
-1,3,Coutts,male,3,1,1,C.A. 37671,15.9,,S
-0,3,Dimic,male,42,0,0,315088,8.6625,,S
-0,3,Odahl,male,23,0,0,7267,9.225,,S
-0,3,Elias,male,15,1,1,2695,7.2292,,C
-0,3,Arnold-Franchi,male,25,1,0,349237,17.8,,S
-0,3,Vanden,male,28,0,0,345783,9.5,,S
-1,1,Bowerman,female,22,0,1,113505,55,E33,S
-0,2,Funk,female,38,0,0,237671,13,,S
-0,3,Skoog,male,40,1,4,347088,27.9,,S
-0,2,del,male,29,1,0,SC/PARIS 2167,27.7208,,C
-0,3,Barbara,female,45,0,1,2691,14.4542,,C
-0,3,Asim,male,35,0,0,SOTON/O.Q. 3101310,7.05,,S
-0,3,Adahl,male,30,0,0,C 7076,7.25,,S
-1,1,Warren,female,60,1,0,110813,75.25,D37,C
-1,1,Aubart,female,24,0,0,PC 17477,69.3,B35,C
-1,1,Harder,male,25,1,0,11765,55.4417,E50,C
-0,3,Wiklund,male,18,1,0,3101267,6.4958,,S
-0,3,Beavan,male,19,0,0,323951,8.05,,S
-0,1,Ringhini,male,22,0,0,PC 17760,135.6333,,C
-0,3,Palsson,female,3,3,1,349909,21.075,,S
-1,3,Landergren,female,22,0,0,C 7077,7.25,,S
-0,1,Widener,male,27,0,2,113503,211.5,C82,C
-0,3,Betros,male,20,0,0,2648,4.0125,,C
-0,3,Gustafsson,male,19,0,0,347069,7.775,,S
-1,1,Bidois,female,42,0,0,PC 17757,227.525,,C
-1,3,Nakid,female,1,0,2,2653,15.7417,,C
-0,3,Tikkanen,male,32,0,0,STON/O 2. 3101293,7.925,,S
-1,1,Holverson,female,35,1,0,113789,52,,S
-0,2,Davies,male,18,0,0,S.O.C. 14879,73.5,,S
-0,3,Goodwin,male,1,5,2,CA 2144,46.9,,S
-1,2,Buss,female,36,0,0,27849,13,,S
-1,2,Lehmann,female,17,0,0,SC 1748,12,,C
-1,1,Carter,male,36,1,2,113760,120,B96 B98,S
-1,3,Jansson,male,21,0,0,350034,7.7958,,S
-0,3,Gustafsson,male,28,2,0,3101277,7.925,,S
-1,1,Newell,female,23,1,0,35273,113.275,D36,C
-1,3,Sandstrom,female,24,0,2,PP 9549,16.7,G6,S
-0,3,Johansson,male,22,0,0,350052,7.7958,,S
-0,3,Olsson,female,31,0,0,350407,7.8542,,S
-0,2,McKane,male,46,0,0,28403,26,,S
-0,2,Pain,male,23,0,0,244278,10.5,,S
-1,2,Trout,female,28,0,0,240929,12.65,,S
-1,3,Niskanen,male,39,0,0,STON/O 2. 3101289,7.925,,S
-0,3,Adams,male,26,0,0,341826,8.05,,S
-0,3,Jussila,female,21,1,0,4137,9.825,,S
-0,3,Hakkarainen,male,28,1,0,STON/O2. 3101279,15.85,,S
-0,3,Oreskovic,female,20,0,0,315096,8.6625,,S
-0,2,Gale,male,34,1,0,28664,21,,S
-0,3,Widegren,male,51,0,0,347064,7.75,,S
-1,2,Richards,male,3,1,1,29106,18.75,,S
-0,3,Birkeland,male,21,0,0,312992,7.775,,S
-1,1,Minahan,female,33,1,0,19928,90,C78,Q
-1,3,Sundman,male,44,0,0,STON/O 2. 3101269,7.925,,S
-1,2,Drew,female,34,1,1,28220,32.5,,S
-1,2,Silven,female,18,0,2,250652,13,,S
-0,2,Matthews,male,30,0,0,28228,13,,S
-0,3,Van,female,10,0,2,345773,24.15,,S
-0,3,Charters,male,21,0,0,A/5. 13032,7.7333,,Q
-0,3,Zimmerman,male,29,0,0,315082,7.875,,S
-0,3,Danbom,female,28,1,1,347080,14.4,,S
-0,3,Rosblom,male,18,1,1,370129,20.2125,,S
-1,2,Clarke,female,28,1,0,2003,26,,S
-1,2,Phillips,female,19,0,0,250655,26,,S
-1,3,Pickard,male,32,0,0,SOTON/O.Q. 392078,8.05,E10,S
-1,1,Bjornstrom-Steffansson,male,28,0,0,110564,26.55,C52,S
-1,2,Louch,female,42,1,0,SC/AH 3085,26,,S
-0,3,Kallio,male,17,0,0,STON/O 2. 3101274,7.125,,S
-0,1,Silvey,male,50,1,0,13507,55.9,E44,S
-1,1,Carter,female,14,1,2,113760,120,B96 B98,S
-0,3,Ford,female,21,2,2,W./C. 6608,34.375,,S
-1,2,Richards,female,24,2,3,29106,18.75,,S
-0,1,Fortune,male,64,1,4,19950,263,C23 C25 C27,S
-0,2,Kvillner,male,31,0,0,C.A. 18723,10.5,,S
-1,2,Hart,female,45,1,1,F.C.C. 13529,26.25,,S
-0,3,Hampe,male,20,0,0,345769,9.5,,S
-0,3,Petterson,male,25,1,0,347076,7.775,,S
-1,2,Reynaldo,female,28,0,0,230434,13,,S
-1,1,Dodge,male,4,0,2,33638,81.8583,A34,S
-1,2,Mellinger,female,13,0,1,250644,19.5,,S
-1,1,Seward,male,34,0,0,113794,26.55,,S
-1,3,Baclini,female,5,2,1,2666,19.2583,,C
-1,1,Peuchen,male,52,0,0,113786,30.5,C104,S
-0,2,West,male,36,1,2,C.A. 34651,27.75,,S
-0,1,Foreman,male,30,0,0,113051,27.75,C111,C
-1,1,Goldenberg,male,49,1,0,17453,89.1042,C92,C
-1,3,Jalsevac,male,29,0,0,349240,7.8958,,C
-0,1,Millet,male,65,0,0,13509,26.55,E38,S
-1,2,Toomey,female,50,0,0,F.C.C. 13531,10.5,,S
-1,1,Anderson,male,48,0,0,19952,26.55,E12,S
-0,3,Morley,male,34,0,0,364506,8.05,,S
-0,1,Gee,male,47,0,0,111320,38.5,E63,S
-0,2,Milling,male,48,0,0,234360,13,,S
-0,3,Goncalves,male,38,0,0,SOTON/O.Q. 3101306,7.05,,S
-0,1,Smart,male,56,0,0,113792,26.55,,S
-1,3,Baclini,female,0.75,2,1,2666,19.2583,,C
-0,3,Cacic,male,38,0,0,315089,8.6625,,S
-1,2,West,female,33,1,2,C.A. 34651,27.75,,S
-1,2,Jerwan,female,23,0,0,SC/AH Basle 541,13.7917,D,C
-0,3,Strandberg,female,22,0,0,7553,9.8375,,S
-0,2,Renouf,male,34,1,0,31027,21,,S
-0,3,Braund,male,29,1,0,3460,7.0458,,S
-0,3,Karlsson,male,22,0,0,350060,7.5208,,S
-1,3,Hirvonen,female,2,0,1,3101298,12.2875,,S
-0,3,Goodwin,male,9,5,2,CA 2144,46.9,,S
-0,3,Rouse,male,50,0,0,A/5 3594,8.05,,S
-1,3,Turkula,female,63,0,0,4134,9.5875,,S
-1,1,Bishop,male,25,1,0,11967,91.0792,B49,C
-1,1,Hoyt,female,35,1,0,19943,90,C93,S
-0,1,Kent,male,58,0,0,11771,29.7,B37,C
-0,3,Somerton,male,30,0,0,A.5. 18509,8.05,,S
-1,3,Coutts,male,9,1,1,C.A. 37671,15.9,,S
-0,3,Windelov,male,21,0,0,SOTON/OQ 3101317,7.25,,S
-0,1,Molson,male,55,0,0,113787,30.5,C30,S
-0,1,Artagaveytia,male,71,0,0,PC 17609,49.5042,,C
-0,3,Stanley,male,21,0,0,A/4 45380,8.05,,S
-1,1,Eustis,female,54,1,0,36947,78.2667,D20,C
-0,1,Allison,female,25,1,2,113781,151.55,C22 C26,S
-0,3,Svensson,male,24,0,0,350035,7.7958,,S
-0,3,Calic,male,17,0,0,315086,8.6625,,S
-0,3,Canavan,female,21,0,0,364846,7.75,,Q
-0,3,Laitinen,female,37,0,0,4135,9.5875,,S
-1,1,Maioni,female,16,0,0,110152,86.5,B79,S
-0,1,Penasco,male,18,1,0,PC 17758,108.9,C65,C
-1,2,Quick,female,33,0,2,26360,26,,S
-0,3,Olsen,male,28,0,0,C 4001,22.525,,S
-1,3,Lang,male,26,0,0,1601,56.4958,,S
-1,3,Daly,male,29,0,0,382651,7.75,,Q
-1,1,McGough,male,36,0,0,PC 17473,26.2875,E25,S
-1,1,Rothschild,female,54,1,0,PC 17603,59.4,,C
-0,3,Coleff,male,24,0,0,349209,7.4958,,S
-0,1,Walker,male,47,0,0,36967,34.0208,D46,S
-1,2,Lemore,female,34,0,0,C.A. 34260,10.5,F33,S
-1,2,Angle,female,36,1,0,226875,26,,S
-0,3,Pavlovic,male,32,0,0,349242,7.8958,,S
-1,1,Perreault,female,30,0,0,12749,93.5,B73,S
-0,3,Vovk,male,22,0,0,349252,7.8958,,S
-1,1,Hippach,female,44,0,1,111361,57.9792,B18,C
-0,3,Farrell,male,40.5,0,0,367232,7.75,,Q
-1,2,Ridsdale,female,50,0,0,W./C. 14258,10.5,,S
-0,3,Salonen,male,39,0,0,3101296,7.925,,S
-0,2,Hocking,male,23,2,1,29104,11.5,,S
-1,2,Quick,female,2,1,1,26360,26,,S
-0,3,Elias,male,17,1,1,2690,7.2292,,C
-0,3,Cacic,female,30,0,0,315084,8.6625,,S
-1,2,Hart,female,7,0,2,F.C.C. 13529,26.25,,S
-0,1,Butt,male,45,0,0,113050,26.55,B38,S
-1,1,LeRoy,female,30,0,0,PC 17761,106.425,,C
-1,1,Frolicher,female,22,0,2,13568,49.5,B39,C
-1,1,Crosby,female,36,0,2,WE/P 5735,71,B22,S
-0,3,Andersson,female,9,4,2,347082,31.275,,S
-0,3,Andersson,female,11,4,2,347082,31.275,,S
-1,2,Beane,male,32,1,0,2908,26,,S
-0,1,Douglas,male,50,1,0,PC 17761,106.425,C86,C
-0,1,Nicholson,male,64,0,0,693,26,,S
-1,2,Beane,female,19,1,0,2908,26,,S
-0,3,Goldsmith,male,33,1,1,363291,20.525,,S
-1,2,Davies,male,8,1,1,C.A. 33112,36.75,,S
-1,1,Thayer,male,17,0,2,17421,110.8833,C70,C
-0,2,Sharp,male,27,0,0,244358,26,,S
-1,3,Leeni,male,22,0,0,2620,7.225,,C
-1,3,Ohman,female,22,0,0,347085,7.775,,S
-0,1,Wright,male,62,0,0,113807,26.55,,S
-1,1,Duff,female,48,1,0,11755,39.6,A16,C
-1,1,Taussig,female,39,1,1,110413,79.65,E67,S
-1,3,de,female,36,1,0,345572,17.4,,S
-0,3,Sivic,male,40,0,0,349251,7.8958,,S
-0,2,Norman,male,28,0,0,218629,13.5,,S
-0,3,Davies,male,24,2,0,A/4 48871,24.15,,S
-0,3,Stoytcheff,male,19,0,0,349205,7.8958,,S
-0,3,Palsson,female,29,0,4,349909,21.075,,S
-1,3,Jonsson,male,32,0,0,350417,7.8542,,S
-1,2,Harris,male,62,0,0,S.W./PP 752,10.5,,S
-1,1,Appleton,female,53,2,0,11769,51.4792,C101,S
-1,1,Flynn,male,36,0,0,PC 17474,26.3875,E25,S
-0,3,Rush,male,16,0,0,A/4. 20589,8.05,,S
-0,3,Patchett,male,19,0,0,358585,14.5,,S
-1,2,Garside,female,34,0,0,243880,13,,S
-1,1,Silvey,female,39,1,0,13507,55.9,E44,S
-1,3,Jussila,male,32,0,0,STON/O 2. 3101286,7.925,,S
-1,2,Christy,female,25,1,1,237789,30,,S
-1,1,Thayer,female,39,1,1,17421,110.8833,C68,C
-0,2,Downton,male,54,0,0,28403,26,,S
-0,1,Ross,male,36,0,0,13049,40.125,A10,C
-1,1,Taussig,female,18,0,2,110413,79.65,E68,S
-0,2,Jarvis,male,47,0,0,237565,15,,S
-1,1,Frolicher-Stehli,male,60,1,1,13567,79.2,B41,C
-0,3,Gilinski,male,22,0,0,14973,8.05,,S
-0,3,Rintamaki,male,35,0,0,STON/O 2. 3101273,7.125,,S
-1,1,Stephenson,female,52,1,0,36947,78.2667,D20,C
-0,3,Elsbury,male,47,0,0,A/5 3902,7.25,,S
-0,2,Chapman,male,37,1,0,SC/AH 29037,26,,S
-0,3,Van,male,36,1,1,345773,24.15,,S
-0,3,Johnson,male,49,0,0,LINE,0,,S
-1,1,Duff,male,49,1,0,PC 17485,56.9292,A20,C
-1,2,Jacobsohn,female,24,2,1,243847,27,,S
-0,3,Torber,male,44,0,0,364511,8.05,,S
-1,1,Homer,male,35,0,0,111426,26.55,,C
-0,3,Lindell,male,36,1,0,349910,15.55,,S
-0,3,Karaic,male,30,0,0,349246,7.8958,,S
-1,1,Daniel,male,27,0,0,113804,30.5,,S
-1,2,Laroche,female,22,1,2,SC/Paris 2123,41.5792,,C
-1,1,Shutes,female,40,0,0,PC 17582,153.4625,C125,S
-0,3,Andersson,female,39,1,5,347082,31.275,,S
-0,3,Brocklebank,male,35,0,0,364512,8.05,,S
-1,2,Herman,female,24,1,2,220845,65,,S
-0,3,Danbom,male,34,1,1,347080,14.4,,S
-0,3,Lobb,female,26,1,0,A/5. 3336,16.1,,S
-1,2,Becker,female,4,2,1,230136,39,F4,S
-0,2,Gavey,male,26,0,0,31028,10.5,,S
-0,3,Yasbeck,male,27,1,0,2659,14.4542,,C
-1,1,Kimball,male,42,1,0,11753,52.5542,D19,S
-1,3,Nakid,male,20,1,1,2653,15.7417,,C
-0,3,Hansen,male,21,0,0,350029,7.8542,,S
-0,3,Bowen,male,21,0,0,54636,16.1,,S
-0,1,Sutton,male,61,0,0,36963,32.3208,D50,S
-0,2,Kirkland,male,57,0,0,219533,12.35,,Q
-1,1,Longley,female,21,0,0,13502,77.9583,D9,S
-0,3,Bostandyeff,male,26,0,0,349224,7.8958,,S
-1,1,Barkworth,male,80,0,0,27042,30,A23,S
-0,3,Lundahl,male,51,0,0,347743,7.0542,,S
-1,1,Stahelin-Maeglin,male,32,0,0,13214,30.5,B50,C
-0,3,Skoog,female,9,3,2,347088,27.9,,S
-1,2,Davis,female,28,0,0,237668,13,,S
-0,3,Leinonen,male,32,0,0,STON/O 2. 3101292,7.925,,S
-0,2,Collyer,male,31,1,1,C.A. 31921,26.25,,S
-0,3,Panula,female,41,0,5,3101295,39.6875,,S
-0,3,Jensen,male,20,0,0,350050,7.8542,,S
-1,1,Sagesser,female,24,0,0,PC 17477,69.3,B35,C
-0,3,Skoog,female,2,3,2,347088,27.9,,S
-1,3,Baclini,female,0.75,2,1,2666,19.2583,,C
-1,1,Harper,male,48,1,0,PC 17572,76.7292,D33,C
-0,3,Cor,male,19,0,0,349231,7.8958,,S
-1,1,Simonius-Blumer,male,56,0,0,13213,35.5,A26,C
-1,3,Stanley,female,23,0,0,CA. 2314,7.55,,S
-1,2,Doling,female,18,0,1,231919,23,,S
-0,3,Kalvik,male,21,0,0,8475,8.4333,,S
-0,3,Hegarty,female,18,0,0,365226,6.75,,Q
-0,2,Hickman,male,24,2,0,S.O.C. 14879,73.5,,S
-0,3,Bourke,female,32,1,1,364849,15.5,,Q
-0,2,Eitemiller,male,23,0,0,29751,13,,S
-0,1,Newell,male,58,0,2,35273,113.275,D48,C
-1,1,Frauenthal,male,50,2,0,PC 17611,133.65,,S
-0,3,Badt,male,40,0,0,2623,7.225,,C
-0,1,Colley,male,47,0,0,5727,25.5875,E58,S
-0,3,Coleff,male,36,0,0,349210,7.4958,,S
-1,3,Lindqvist,male,20,1,0,STON/O 2. 3101285,7.925,,S
-0,2,Hickman,male,32,2,0,S.O.C. 14879,73.5,,S
-0,2,Butler,male,25,0,0,234686,13,,S
-0,3,Cook,male,43,0,0,A/5 3536,8.05,,S
-1,2,Brown,female,40,1,1,29750,39,,S
-0,1,Davidson,male,31,1,0,F.C. 12750,52,B71,S
-0,2,Mitchell,male,70,0,0,C.A. 24580,10.5,,S
-1,2,Wilhelms,male,31,0,0,244270,13,,S
-0,3,Edvardsson,male,18,0,0,349912,7.775,,S
-0,3,Sawyer,male,24.5,0,0,342826,8.05,,S
-1,3,Turja,female,18,0,0,4138,9.8417,,S
-0,3,Goodwin,female,43,1,6,CA 2144,46.9,,S
-1,1,Cardeza,male,36,0,1,PC 17755,512.3292,B51 B53 B55,C
-1,1,Hassab,male,27,0,0,PC 17572,76.7292,D49,C
-0,3,Olsvigen,male,20,0,0,6563,9.225,,S
-0,3,Goodwin,male,14,5,2,CA 2144,46.9,,S
-0,2,Brown,male,60,1,1,29750,39,,S
-0,2,Laroche,male,25,1,2,SC/Paris 2123,41.5792,,C
-0,3,Panula,male,14,4,1,3101295,39.6875,,S
-0,3,Dakic,male,19,0,0,349228,10.1708,,S
-0,3,Fischer,male,18,0,0,350036,7.7958,,S
-1,1,Madill,female,15,0,1,24160,211.3375,B5,S
-1,1,Dick,male,31,1,0,17474,57,B20,S
-1,3,Karun,female,4,0,1,349256,13.4167,,C
-0,3,Saad,male,25,0,0,2672,7.225,,C
-0,1,Weir,male,60,0,0,113800,26.55,,S
-0,2,Chapman,male,52,0,0,248731,13.5,,S
-0,3,Kelly,male,44,0,0,363592,8.05,,S
-0,1,Thayer,male,49,1,1,17421,110.8833,C68,C
-0,3,Humblen,male,42,0,0,348121,7.65,F G63,S
-1,1,Astor,female,18,1,0,PC 17757,227.525,C62 C64,C
-1,1,Silverthorne,male,35,0,0,PC 17475,26.2875,E24,S
-0,3,Barbara,female,18,0,1,2691,14.4542,,C
-0,3,Gallagher,male,25,0,0,36864,7.7417,,Q
-0,3,Hansen,male,26,1,0,350025,7.8542,,S
-0,2,Morley,male,39,0,0,250655,26,,S
-1,2,Kelly,female,45,0,0,223596,13.5,,S
-1,1,Calderhead,male,42,0,0,PC 17476,26.2875,E24,S
-1,1,Cleaver,female,22,0,0,113781,151.55,,S
-1,1,Mayne,female,24,0,0,PC 17482,49.5042,C90,C
-1,1,Taylor,male,48,1,0,19996,52,C126,S
-0,3,Larsson,male,29,0,0,7545,9.4833,,S
-0,2,Greenberg,male,52,0,0,250647,13,,S
-0,3,Soholt,male,19,0,0,348124,7.65,F G73,S
-1,1,Endres,female,38,0,0,PC 17757,227.525,C45,C
-1,2,Troutt,female,27,0,0,34218,10.5,E101,S
-0,3,Johnson,male,33,0,0,347062,7.775,,S
-1,2,Harper,female,6,0,1,248727,33,,S
-0,3,Jensen,male,17,1,0,350048,7.0542,,S
-0,2,Gillespie,male,34,0,0,12233,13,,S
-0,2,Hodges,male,50,0,0,250643,13,,S
-1,1,Chambers,male,27,1,0,113806,53.1,E8,S
-0,3,Oreskovic,male,20,0,0,315094,8.6625,,S
-1,2,Renouf,female,30,3,0,31027,21,,S
-0,2,Bryhl,male,25,1,0,236853,26,,S
-0,3,Ilmakangas,female,25,1,0,STON/O2. 3101271,7.925,,S
-1,1,Allen,female,29,0,0,24160,211.3375,B5,S
-0,3,Hassan,male,11,0,0,2699,18.7875,,C
-0,2,Berriman,male,23,0,0,28425,13,,S
-0,2,Troupiansky,male,23,0,0,233639,13,,S
-0,3,Williams,male,28.5,0,0,54636,16.1,,S
-0,3,Ford,female,48,1,3,W./C. 6608,34.375,,S
-1,1,Lesurer,male,35,0,0,PC 17755,512.3292,B101,C
-0,1,Cavendish,male,36,1,0,19877,78.85,C46,S
-1,1,Ryerson,female,21,2,2,PC 17608,262.375,B57 B59 B63 B66,C
-0,3,McNamee,male,24,1,0,376566,16.1,,S
-1,3,Stranden,male,31,0,0,STON/O 2. 3101288,7.925,,S
-0,1,Crosby,male,70,1,1,WE/P 5735,71,B22,S
-0,3,Abbott,male,16,1,1,C.A. 2673,20.25,,S
-1,2,Sinkkonen,female,30,0,0,250648,13,,S
-0,1,Marvin,male,19,1,0,113773,53.1,D30,S
-0,3,Connaghton,male,31,0,0,335097,7.75,,Q
-1,2,Wells,female,4,1,1,29103,23,,S
-1,3,Moor,male,6,0,1,392096,12.475,E121,S
-0,3,Vande,male,33,0,0,345780,9.5,,S
-0,3,Jonkoff,male,23,0,0,349204,7.8958,,S
-1,2,Herman,female,48,1,2,220845,65,,S
-1,2,Hamalainen,male,0.67,1,1,250649,14.5,,S
-0,3,Carlsson,male,28,0,0,350042,7.7958,,S
-0,2,Bailey,male,18,0,0,29108,11.5,,S
-0,3,Theobald,male,34,0,0,363294,8.05,,S
-1,1,Rothes,female,33,0,0,110152,86.5,B77,S
-0,3,Nirva,male,41,0,0,SOTON/O2 3101272,7.125,,S
-1,3,Barah,male,20,0,0,2663,7.2292,,C
-1,1,Carter,female,36,1,2,113760,120,B96 B98,S
-0,3,Eklund,male,16,0,0,347074,7.775,,S
-1,1,Hogeboom,female,51,1,0,13502,77.9583,D11,S
-0,3,Mangan,female,30.5,0,0,364850,7.75,,Q
-0,3,Gronnestad,male,32,0,0,8471,8.3625,,S
-0,3,Lievens,male,24,0,0,345781,9.5,,S
-0,3,Jensen,male,48,0,0,350047,7.8542,,S
-0,2,Mack,female,57,0,0,S.O./P.P. 3,10.5,E77,S
-1,2,Hocking,female,54,1,3,29105,23,,S
-0,3,Myhrman,male,18,0,0,347078,7.75,,S
-1,3,Emanuel,female,5,0,0,364516,12.475,,S
-1,1,Robert,female,43,0,1,24160,211.3375,B3,S
-1,3,Ayoub,female,13,0,0,2687,7.2292,,C
-1,1,Dick,female,17,1,0,17474,57,B20,S
-0,1,Long,male,29,0,0,113501,30,D6,S
-0,3,Ali,male,25,0,0,SOTON/O.Q. 3101312,7.05,,S
-0,3,Harmer,male,25,0,0,374887,7.25,,S
-1,3,Sjoblom,female,18,0,0,3101265,7.4958,,S
-0,3,Rice,male,8,4,1,382652,29.125,,Q
-1,3,Dean,male,1,1,2,C.A. 2315,20.575,,S
-0,1,Guggenheim,male,46,0,0,PC 17593,79.2,B82 B84,C
-0,2,Gaskell,male,16,0,0,239865,26,,S
-0,3,Dantcheff,male,25,0,0,349203,7.8958,,S
-0,2,Otter,male,39,0,0,28213,13,,S
-1,1,Leader,female,49,0,0,17465,25.9292,D17,S
-1,3,Osman,female,31,0,0,349244,8.6833,,S
-0,3,Ibrahim,male,30,0,0,2685,7.2292,,C
-0,3,Van,female,30,1,1,345773,24.15,,S
-0,2,Ponesell,male,34,0,0,250647,13,,S
-1,2,Collyer,female,31,1,1,C.A. 31921,26.25,,S
-1,1,Carter,male,11,1,2,113760,120,B96 B98,S
-1,3,Thomas,male,0.42,0,1,2625,8.5167,,C
-1,3,Hedman,male,27,0,0,347089,6.975,,S
-0,3,Johansson,male,31,0,0,347063,7.775,,S
-0,1,Andrews,male,39,0,0,112050,0,A36,S
-0,3,Pettersson,female,18,0,0,347087,7.775,,S
-0,2,Meyer,male,39,0,0,248723,13,,S
-1,1,Chambers,female,33,1,0,113806,53.1,E8,S
-0,3,Alexander,male,26,0,0,3474,7.8875,,S
-0,3,Lester,male,39,0,0,A/4 48871,24.15,,S
-0,2,Slemen,male,35,0,0,28206,10.5,,S
-0,3,Andersson,female,6,4,2,347082,31.275,,S
-0,3,Tomlin,male,30.5,0,0,364499,8.05,,S
-0,3,Heininen,female,23,0,0,STON/O2. 3101290,7.925,,S
-0,2,Mallet,male,31,1,1,S.C./PARIS 2079,37.0042,,C
-0,3,Holm,male,43,0,0,C 7075,6.45,,S
-0,3,Skoog,male,10,3,2,347088,27.9,,S
-1,1,Hays,female,52,1,1,12749,93.5,B69,S
-1,3,Lulic,male,27,0,0,315098,8.6625,,S
-0,1,Reuchlin,male,38,0,0,19972,0,,S
-1,3,Moor,female,27,0,1,392096,12.475,E121,S
-0,3,Panula,male,2,4,1,3101295,39.6875,,S
-1,2,Mallet,male,1,0,2,S.C./PARIS 2079,37.0042,,C
-1,1,Stone,female,62,0,0,113572,80,B28,
-1,3,Yasbeck,female,15,1,0,2659,14.4542,,C
-1,2,Richards,male,0.83,1,1,29106,18.75,,S
-0,3,Augustsson,male,23,0,0,347468,7.8542,,S
-0,3,Allum,male,18,0,0,2223,8.3,,S
-1,1,Compton,female,39,1,1,PC 17756,83.1583,E49,C
-0,3,Pasic,male,21,0,0,315097,8.6625,,S
-1,3,Chip,male,32,0,0,1601,56.4958,,S
-0,3,Alhomaki,male,20,0,0,SOTON/O2 3101287,7.925,,S
-0,2,Mudd,male,16,0,0,S.O./P.P. 3,10.5,,S
-1,1,Serepeca,female,30,0,0,113798,31,,C
-0,3,Lemberopolous,male,34.5,0,0,2683,6.4375,,C
-0,3,Culumovic,male,17,0,0,315090,8.6625,,S
-0,3,Abbing,male,42,0,0,C.A. 5547,7.55,,S
-0,3,Markoff,male,35,0,0,349213,7.8958,,C
-0,2,Harper,male,28,0,1,248727,33,,S
-0,3,Andersson,male,4,4,2,347082,31.275,,S
-0,3,Svensson,male,74,0,0,347060,7.775,,S
-0,3,Boulos,female,9,1,1,2678,15.2458,,C
-1,1,Lines,female,16,0,1,PC 17592,39.4,D28,S
-0,2,Carter,female,44,1,0,244252,26,,S
-1,3,Aks,female,18,0,1,392091,9.35,,S
-1,1,Wick,female,45,1,1,36928,164.8667,,S
-1,1,Daly,male,51,0,0,113055,26.55,E17,S
-1,3,Baclini,female,24,0,3,2666,19.2583,,C
-0,3,Hansen,male,41,2,0,350026,14.1083,,S
-0,2,Giles,male,21,1,0,28134,11.5,,S
-1,1,Swift,female,48,0,0,17466,25.9292,D17,S
-0,2,Gill,male,24,0,0,233866,13,,S
-1,2,Bystrom,female,42,0,0,236852,13,,S
-1,2,Duran,female,27,1,0,SC/PARIS 2149,13.8583,,C
-0,1,Roebling,male,31,0,0,PC 17590,50.4958,A24,S
-1,3,Johnson,male,4,1,1,347742,11.1333,,S
-0,3,Balkic,male,26,0,0,349248,7.8958,,S
-1,1,Beckwith,female,47,1,1,11751,52.5542,D35,S
-0,1,Carlsson,male,33,0,0,695,5,B51 B53 B55,S
-0,3,Vander,male,47,0,0,345765,9,,S
-1,2,Abelson,female,28,1,0,P/PP 3381,24,,C
-1,3,Najib,female,15,0,0,2667,7.225,,C
-0,3,Gustafsson,male,20,0,0,7534,9.8458,,S
-0,3,Petroff,male,19,0,0,349212,7.8958,,S
-1,1,Potter,female,56,0,1,11767,83.1583,C50,C
-1,2,Shelley,female,25,0,1,230433,26,,S
-0,3,Markun,male,33,0,0,349257,7.8958,,S
-0,3,Dahlberg,female,22,0,0,7552,10.5167,,S
-0,2,Banfield,male,28,0,0,C.A./SOTON 34068,10.5,,S
-0,3,Sutehall,male,25,0,0,SOTON/OQ 392076,7.05,,S
-0,3,Rice,female,39,0,5,382652,29.125,,Q
-0,2,Montvila,male,27,0,0,211536,13,,S
-1,1,Graham,female,19,0,0,112053,30,B42,S
-1,1,Behr,male,26,0,0,111369,30,C148,C
-0,3,Dooley,male,32,0,0,370376,7.75,,Q

apps/simple/gptllama.ts

@@ -1,9 +1,7 @@
-import { stdin as input, stdout as output } from "node:process";
-// readline/promises is still experimental so not in @types/node yet
+import { OpenAI, LlamaDeuce, ChatMessage, DeuceChatStrategy } from "llamaindex";
 // @ts-ignore
-import readline from "node:readline/promises";
-
-import { ChatMessage, LlamaDeuce, OpenAI } from "llamaindex";
+import * as readline from "node:readline/promises";
+import { stdin as input, stdout as output } from "node:process";
 
 (async () => {
   const gpt4 = new OpenAI({ model: "gpt-4", temperature: 0.9 });
@@ -29,7 +27,7 @@ import { ChatMessage, LlamaDeuce, OpenAI } from "llamaindex";
       history.map(({ content, role }) => ({
         content,
         role: next === l2 ? role : role === "user" ? "assistant" : "user",
-      })),
+      }))
     );
     history.push({
       content: r.message.content,