From abafa6014c2d003ac74951679d4bef2b1855aa67 Mon Sep 17 00:00:00 2001 From: Logan Markewich <logan.markewich@live.com> Date: Mon, 17 Jul 2023 16:53:22 -0600 Subject: [PATCH] undo organization --- apps/docs/docs/api/modules.md | 180 ++++++++++++++-------------------- 1 file changed, 71 insertions(+), 109 deletions(-) diff --git a/apps/docs/docs/api/modules.md b/apps/docs/docs/api/modules.md index 13886d68e..1a7a44e01 100644 --- a/apps/docs/docs/api/modules.md +++ b/apps/docs/docs/api/modules.md @@ -16,79 +16,41 @@ custom_edit_url: null ## Classes -### Callbacks - +- [BaseEmbedding](classes/BaseEmbedding.md) +- [BaseIndex](classes/BaseIndex.md) +- [BaseNode](classes/BaseNode.md) - [CallbackManager](classes/CallbackManager.md) - -### Chat Engines - +- [ChatGPTLLMPredictor](classes/ChatGPTLLMPredictor.md) +- [CompactAndRefine](classes/CompactAndRefine.md) - [CondenseQuestionChatEngine](classes/CondenseQuestionChatEngine.md) - [ContextChatEngine](classes/ContextChatEngine.md) -- [SimpleChatEngine](classes/SimpleChatEngine.md) - -### Data Loaders - -- [InMemoryFileSystem](classes/InMemoryFileSystem.md) -- [TextFileReader](classes/TextFileReader.md) - -### Documents / Nodes - -- [BaseNode](classes/BaseNode.md) - [Document](classes/Document.md) -- [IndexNode](classes/IndexNode.md) -- [TextNode](classes/TextNode.md) - -### Embeddings - -- [BaseEmbedding](classes/BaseEmbedding.md) -- [OpenAIEmbedding](classes/OpenAIEmbedding.md) - -### LLMs - -- [ChatGPTLLMPredictor](classes/ChatGPTLLMPredictor.md) -- [OpenAI](classes/OpenAI.md) - -### Indices - -- [BaseIndex](classes/BaseIndex.md) -- [ListIndex](classes/ListIndex.md) -- [VectorStoreIndex](classes/VectorStoreIndex.md) - -### Index Structures - +- [InMemoryFileSystem](classes/InMemoryFileSystem.md) - [IndexDict](classes/IndexDict.md) - [IndexList](classes/IndexList.md) +- [IndexNode](classes/IndexNode.md) - [IndexStruct](classes/IndexStruct.md) - -### Responses - -- [CompactAndRefine](classes/CompactAndRefine.md) +- [LLMQuestionGenerator](classes/LLMQuestionGenerator.md) +- [ListIndex](classes/ListIndex.md) +- [ListIndexLLMRetriever](classes/ListIndexLLMRetriever.md) +- [ListIndexRetriever](classes/ListIndexRetriever.md) +- [OpenAI](classes/OpenAI.md) +- [OpenAIEmbedding](classes/OpenAIEmbedding.md) - [Refine](classes/Refine.md) - [Response](classes/Response.md) - [ResponseSynthesizer](classes/ResponseSynthesizer.md) -- [SimpleResponseBuilder](classes/SimpleResponseBuilder.md) -- [TreeSummarize](classes/TreeSummarize.md) - -### Retrievers - -- [ListIndexLLMRetriever](classes/ListIndexLLMRetriever.md) -- [ListIndexRetriever](classes/ListIndexRetriever.md) -- [VectorIndexRetriever](classes/VectorIndexRetriever.md) - -### Text Splitters / Parsers - +- [RetrieverQueryEngine](classes/RetrieverQueryEngine.md) - [SentenceSplitter](classes/SentenceSplitter.md) +- [SimpleChatEngine](classes/SimpleChatEngine.md) - [SimpleNodeParser](classes/SimpleNodeParser.md) - -### Query Engines - -- [RetrieverQueryEngine](classes/RetrieverQueryEngine.md) -- [SubQuestionQueryEngine](classes/SubQuestionQueryEngine.md) - -### Utils - -- [LLMQuestionGenerator](classes/LLMQuestionGenerator.md) +- [SimpleResponseBuilder](classes/SimpleResponseBuilder.md) - [SubQuestionOutputParser](classes/SubQuestionOutputParser.md) +- [SubQuestionQueryEngine](classes/SubQuestionQueryEngine.md) +- [TextFileReader](classes/TextFileReader.md) +- [TextNode](classes/TextNode.md) +- [TreeSummarize](classes/TreeSummarize.md) +- [VectorIndexRetriever](classes/VectorIndexRetriever.md) +- [VectorStoreIndex](classes/VectorStoreIndex.md) ## Interfaces @@ -131,7 +93,7 @@ custom_edit_url: null #### Defined in -[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/FileSystem.ts#L49) +[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/FileSystem.ts#L49) ___ @@ -141,7 +103,7 @@ ___ #### Defined in -[LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/LLM.ts#L25) +[LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/LLM.ts#L25) ___ @@ -151,7 +113,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/callbacks/CallbackManager.ts#L11) +[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/callbacks/CallbackManager.ts#L11) ___ @@ -161,7 +123,7 @@ ___ #### Defined in -[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/callbacks/CallbackManager.ts#L12) +[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/callbacks/CallbackManager.ts#L12) ___ @@ -171,7 +133,7 @@ ___ #### Defined in -[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Node.ts#L32) +[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Node.ts#L32) ___ @@ -190,7 +152,7 @@ ___ #### Defined in -[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/readers/SimpleDirectoryReader.ts#L26) +[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/readers/SimpleDirectoryReader.ts#L26) ___ @@ -218,7 +180,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Prompt.ts#L10) ## Variables @@ -239,7 +201,7 @@ We currently support GPT-3.5 and GPT-4 models #### Defined in -[LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/LLM.ts#L57) +[LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/LLM.ts#L57) ___ @@ -249,7 +211,7 @@ ___ #### Defined in -[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L5) +[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L5) ___ @@ -259,7 +221,7 @@ ___ #### Defined in -[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L6) +[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L6) ___ @@ -269,7 +231,7 @@ ___ #### Defined in -[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L4) +[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L4) ___ @@ -279,7 +241,7 @@ ___ #### Defined in -[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/constants.ts#L1) +[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/constants.ts#L1) ___ @@ -289,7 +251,7 @@ ___ #### Defined in -[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L1) +[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L1) ___ @@ -299,7 +261,7 @@ ___ #### Defined in -[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/constants.ts#L4) +[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/constants.ts#L4) ___ @@ -309,7 +271,7 @@ ___ #### Defined in -[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L10) +[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L10) ___ @@ -319,7 +281,7 @@ ___ #### Defined in -[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/FileSystem.ts#L62) +[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/FileSystem.ts#L62) ___ @@ -329,7 +291,7 @@ ___ #### Defined in -[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/constants.ts#L6) +[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/constants.ts#L6) ___ @@ -339,7 +301,7 @@ ___ #### Defined in -[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/constants.ts#L3) +[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/constants.ts#L3) ___ @@ -349,7 +311,7 @@ ___ #### Defined in -[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/constants.ts#L7) +[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/constants.ts#L7) ___ @@ -359,7 +321,7 @@ ___ #### Defined in -[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L2) +[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L2) ___ @@ -369,7 +331,7 @@ ___ #### Defined in -[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L11) +[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L11) ___ @@ -379,7 +341,7 @@ ___ #### Defined in -[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/constants.ts#L2) +[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/constants.ts#L2) ___ @@ -389,7 +351,7 @@ ___ #### Defined in -[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L7) +[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L7) ___ @@ -399,7 +361,7 @@ ___ #### Defined in -[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/constants.ts#L5) +[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/constants.ts#L5) ___ @@ -416,7 +378,7 @@ ___ #### Defined in -[LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/LLM.ts#L44) +[LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/LLM.ts#L44) ___ @@ -433,7 +395,7 @@ ___ #### Defined in -[LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/LLM.ts#L49) +[LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/LLM.ts#L49) ___ @@ -443,7 +405,7 @@ ___ #### Defined in -[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/GlobalsHelper.ts#L42) +[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/GlobalsHelper.ts#L42) ## Functions @@ -463,7 +425,7 @@ ___ #### Defined in -[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L198) +[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Prompt.ts#L198) ___ @@ -487,7 +449,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Prompt.ts#L10) ___ @@ -511,7 +473,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Prompt.ts#L10) ___ @@ -535,7 +497,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Prompt.ts#L10) ___ @@ -559,7 +521,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Prompt.ts#L10) ___ @@ -583,7 +545,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Prompt.ts#L10) ___ @@ -607,7 +569,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Prompt.ts#L10) ___ @@ -631,7 +593,7 @@ NOTE 2: we default to empty string to make it easy to calculate prompt sizes #### Defined in -[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10) +[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Prompt.ts#L10) ___ @@ -657,7 +619,7 @@ A promise that resolves to true if the file exists, false otherwise. #### Defined in -[storage/FileSystem.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/FileSystem.ts#L74) +[storage/FileSystem.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/FileSystem.ts#L74) ___ @@ -671,7 +633,7 @@ ___ #### Defined in -[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/FileSystem.ts#L51) +[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/FileSystem.ts#L51) ___ @@ -694,7 +656,7 @@ ___ #### Defined in -[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/NodeParser.ts#L15) +[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/NodeParser.ts#L15) ___ @@ -714,7 +676,7 @@ ___ #### Defined in -[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/ResponseSynthesizer.ts#L212) +[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/ResponseSynthesizer.ts#L212) ___ @@ -735,7 +697,7 @@ ___ #### Defined in -[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/NodeParser.ts#L5) +[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/NodeParser.ts#L5) ___ @@ -761,7 +723,7 @@ Get the top K embeddings from a list of embeddings ordered by similarity to the #### Defined in -[Embedding.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Embedding.ts#L77) +[Embedding.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Embedding.ts#L77) ___ @@ -785,7 +747,7 @@ ___ #### Defined in -[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Embedding.ts#L119) +[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Embedding.ts#L119) ___ @@ -811,7 +773,7 @@ ___ #### Defined in -[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Embedding.ts#L131) +[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Embedding.ts#L131) ___ @@ -831,7 +793,7 @@ ___ #### Defined in -[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L300) +[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Prompt.ts#L300) ___ @@ -851,7 +813,7 @@ ___ #### Defined in -[ServiceContext.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/ServiceContext.ts#L32) +[ServiceContext.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/ServiceContext.ts#L32) ___ @@ -880,7 +842,7 @@ ___ #### Defined in -[ServiceContext.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/ServiceContext.ts#L52) +[ServiceContext.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/ServiceContext.ts#L52) ___ @@ -906,7 +868,7 @@ similartiy score with higher numbers meaning the two embeddings are more similar #### Defined in -[Embedding.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Embedding.ts#L22) +[Embedding.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Embedding.ts#L22) ___ @@ -926,7 +888,7 @@ ___ #### Defined in -[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/StorageContext.ts#L28) +[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/StorageContext.ts#L28) ___ @@ -949,4 +911,4 @@ Recursively traverses a directory and yields all the paths to the files in it. #### Defined in -[storage/FileSystem.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/FileSystem.ts#L91) +[storage/FileSystem.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/FileSystem.ts#L91) -- GitLab