From 8bfa53fe66e8d3bb438dc3176777df4f3d292a56 Mon Sep 17 00:00:00 2001 From: Yi Ding <yi.s.ding@gmail.com> Date: Wed, 16 Aug 2023 18:01:44 -0700 Subject: [PATCH] docs change --- .../docs/docs/api/classes/VectorStoreIndex.md | 24 +++++++++---------- .../docs/docs/api/interfaces/BaseIndexInit.md | 6 ----- apps/docs/docs/api/modules.md | 2 -- 3 files changed, 12 insertions(+), 20 deletions(-) diff --git a/apps/docs/docs/api/classes/VectorStoreIndex.md b/apps/docs/docs/api/classes/VectorStoreIndex.md index aaa264826..5d0507779 100644 --- a/apps/docs/docs/api/classes/VectorStoreIndex.md +++ b/apps/docs/docs/api/classes/VectorStoreIndex.md @@ -24,7 +24,7 @@ The VectorStoreIndex, an index that stores the nodes only according to their vec | Name | Type | | :------ | :------ | -| `init` | [`VectorIndexConstructorProps`](../interfaces/VectorIndexConstructorProps.md) | +| `init` | `VectorIndexConstructorProps` | #### Overrides @@ -32,7 +32,7 @@ The VectorStoreIndex, an index that stores the nodes only according to their vec #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L31) +[indices/vectorStore/VectorStoreIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L41) ## Properties @@ -116,7 +116,7 @@ ___ #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L29) +[indices/vectorStore/VectorStoreIndex.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L39) ## Methods @@ -145,7 +145,7 @@ and response synthezier if they are not provided. #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L216) +[indices/vectorStore/VectorStoreIndex.ts:226](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L226) ___ @@ -171,7 +171,7 @@ Create a new retriever from the index. #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L212) +[indices/vectorStore/VectorStoreIndex.ts:222](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L222) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:252](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L252) +[indices/vectorStore/VectorStoreIndex.ts:262](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L262) ___ @@ -246,7 +246,7 @@ ___ #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:227](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L227) +[indices/vectorStore/VectorStoreIndex.ts:237](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L237) ___ @@ -272,7 +272,7 @@ Get embeddings for nodes and place them into the index. #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:143](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L143) +[indices/vectorStore/VectorStoreIndex.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L153) ___ @@ -297,7 +297,7 @@ High level API: split documents, get embeddings, and build index. #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L187) +[indices/vectorStore/VectorStoreIndex.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L197) ___ @@ -321,7 +321,7 @@ Get the embeddings for nodes. #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:114](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L114) +[indices/vectorStore/VectorStoreIndex.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L124) ___ @@ -336,7 +336,7 @@ This is needed to handle persistence. | Name | Type | | :------ | :------ | -| `options` | [`VectorIndexOptions`](../interfaces/VectorIndexOptions.md) | +| `options` | `VectorIndexOptions` | #### Returns @@ -344,4 +344,4 @@ This is needed to handle persistence. #### Defined in -[indices/vectorStore/VectorStoreIndex.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L42) +[indices/vectorStore/VectorStoreIndex.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L52) diff --git a/apps/docs/docs/api/interfaces/BaseIndexInit.md b/apps/docs/docs/api/interfaces/BaseIndexInit.md index 0d25b4ba5..e027984e3 100644 --- a/apps/docs/docs/api/interfaces/BaseIndexInit.md +++ b/apps/docs/docs/api/interfaces/BaseIndexInit.md @@ -12,12 +12,6 @@ custom_edit_url: null | :------ | | `T` | -## Hierarchy - -- **`BaseIndexInit`** - - ↳ [`VectorIndexConstructorProps`](VectorIndexConstructorProps.md) - ## Properties ### docStore diff --git a/apps/docs/docs/api/modules.md b/apps/docs/docs/api/modules.md index 385aa8216..68c88649a 100644 --- a/apps/docs/docs/api/modules.md +++ b/apps/docs/docs/api/modules.md @@ -93,8 +93,6 @@ custom_edit_url: null - [StructuredOutput](interfaces/StructuredOutput.md) - [SubQuestion](interfaces/SubQuestion.md) - [ToolMetadata](interfaces/ToolMetadata.md) -- [VectorIndexConstructorProps](interfaces/VectorIndexConstructorProps.md) -- [VectorIndexOptions](interfaces/VectorIndexOptions.md) - [VectorStore](interfaces/VectorStore.md) - [VectorStoreInfo](interfaces/VectorStoreInfo.md) - [VectorStoreQuery](interfaces/VectorStoreQuery.md) -- GitLab