Skip to content
Snippets Groups Projects
Commit 8ee55035 authored by Logan Markewich's avatar Logan Markewich
Browse files

Revert "undo organization" 

This reverts commit abafa601.
parent da7199b3
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
apps/docs/docs/api/modules.md
+ 109
− 71
View file @ 8ee55035
......@@ -16,41 +16,79 @@ custom_edit_url: null
## Classes
- [BaseEmbedding](classes/BaseEmbedding.md)
- [BaseIndex](classes/BaseIndex.md)
- [BaseNode](classes/BaseNode.md)
### Callbacks
- [CallbackManager](classes/CallbackManager.md)
- [ChatGPTLLMPredictor](classes/ChatGPTLLMPredictor.md)
- [CompactAndRefine](classes/CompactAndRefine.md)
### Chat Engines
- [CondenseQuestionChatEngine](classes/CondenseQuestionChatEngine.md)
- [ContextChatEngine](classes/ContextChatEngine.md)
- [Document](classes/Document.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
- [IndexDict](classes/IndexDict.md)
- [IndexList](classes/IndexList.md)
- [IndexNode](classes/IndexNode.md)
- [IndexStruct](classes/IndexStruct.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)
### Responses
- [CompactAndRefine](classes/CompactAndRefine.md)
- [Refine](classes/Refine.md)
- [Response](classes/Response.md)
- [ResponseSynthesizer](classes/ResponseSynthesizer.md)
- [RetrieverQueryEngine](classes/RetrieverQueryEngine.md)
- [SentenceSplitter](classes/SentenceSplitter.md)
- [SimpleChatEngine](classes/SimpleChatEngine.md)
- [SimpleNodeParser](classes/SimpleNodeParser.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)
### Retrievers
- [ListIndexLLMRetriever](classes/ListIndexLLMRetriever.md)
- [ListIndexRetriever](classes/ListIndexRetriever.md)
- [VectorIndexRetriever](classes/VectorIndexRetriever.md)
- [VectorStoreIndex](classes/VectorStoreIndex.md)
### Text Splitters / Parsers
- [SentenceSplitter](classes/SentenceSplitter.md)
- [SimpleNodeParser](classes/SimpleNodeParser.md)
### Query Engines
- [RetrieverQueryEngine](classes/RetrieverQueryEngine.md)
- [SubQuestionQueryEngine](classes/SubQuestionQueryEngine.md)
### Utils
- [LLMQuestionGenerator](classes/LLMQuestionGenerator.md)
- [SubQuestionOutputParser](classes/SubQuestionOutputParser.md)
## Interfaces
......@@ -93,7 +131,7 @@ custom_edit_url: null
#### Defined in
[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/FileSystem.ts#L49)
[storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/FileSystem.ts#L49)
___
......@@ -103,7 +141,7 @@ ___
#### Defined in
[LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/LLM.ts#L25)
[LLM.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/LLM.ts#L25)
___
......@@ -113,7 +151,7 @@ ___
#### Defined in
[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/callbacks/CallbackManager.ts#L11)
[callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/callbacks/CallbackManager.ts#L11)
___
......@@ -123,7 +161,7 @@ ___
#### Defined in
[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/callbacks/CallbackManager.ts#L12)
[callbacks/CallbackManager.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/callbacks/CallbackManager.ts#L12)
___
......@@ -133,7 +171,7 @@ ___
#### Defined in
[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Node.ts#L32)
[Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Node.ts#L32)
___
......@@ -152,7 +190,7 @@ ___
#### Defined in
[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/readers/SimpleDirectoryReader.ts#L26)
[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/readers/SimpleDirectoryReader.ts#L26)
___
......@@ -180,7 +218,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/1a39403/packages/core/src/Prompt.ts#L10)
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10)
## Variables
......@@ -201,7 +239,7 @@ We currently support GPT-3.5 and GPT-4 models
#### Defined in
[LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/LLM.ts#L57)
[LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/LLM.ts#L57)
___
......@@ -211,7 +249,7 @@ ___
#### Defined in
[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L5)
[constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L5)
___
......@@ -221,7 +259,7 @@ ___
#### Defined in
[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L6)
[constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L6)
___
......@@ -231,7 +269,7 @@ ___
#### Defined in
[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L4)
[constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L4)
___
......@@ -241,7 +279,7 @@ ___
#### Defined in
[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/constants.ts#L1)
[storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/constants.ts#L1)
___
......@@ -251,7 +289,7 @@ ___
#### Defined in
[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L1)
[constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L1)
___
......@@ -261,7 +299,7 @@ ___
#### Defined in
[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/constants.ts#L4)
[storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/constants.ts#L4)
___
......@@ -271,7 +309,7 @@ ___
#### Defined in
[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L10)
[constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L10)
___
......@@ -281,7 +319,7 @@ ___
#### Defined in
[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/FileSystem.ts#L62)
[storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/FileSystem.ts#L62)
___
......@@ -291,7 +329,7 @@ ___
#### Defined in
[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/constants.ts#L6)
[storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/constants.ts#L6)
___
......@@ -301,7 +339,7 @@ ___
#### Defined in
[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/constants.ts#L3)
[storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/constants.ts#L3)
___
......@@ -311,7 +349,7 @@ ___
#### Defined in
[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/constants.ts#L7)
[storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/constants.ts#L7)
___
......@@ -321,7 +359,7 @@ ___
#### Defined in
[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L2)
[constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L2)
___
......@@ -331,7 +369,7 @@ ___
#### Defined in
[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L11)
[constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L11)
___
......@@ -341,7 +379,7 @@ ___
#### Defined in
[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/constants.ts#L2)
[storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/constants.ts#L2)
___
......@@ -351,7 +389,7 @@ ___
#### Defined in
[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/constants.ts#L7)
[constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/constants.ts#L7)
___
......@@ -361,7 +399,7 @@ ___
#### Defined in
[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/constants.ts#L5)
[storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/constants.ts#L5)
___
......@@ -378,7 +416,7 @@ ___
#### Defined in
[LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/LLM.ts#L44)
[LLM.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/LLM.ts#L44)
___
......@@ -395,7 +433,7 @@ ___
#### Defined in
[LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/LLM.ts#L49)
[LLM.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/LLM.ts#L49)
___
......@@ -405,7 +443,7 @@ ___
#### Defined in
[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/GlobalsHelper.ts#L42)
[GlobalsHelper.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/GlobalsHelper.ts#L42)
## Functions
......@@ -425,7 +463,7 @@ ___
#### Defined in
[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Prompt.ts#L198)
[Prompt.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L198)
___
......@@ -449,7 +487,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/1a39403/packages/core/src/Prompt.ts#L10)
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10)
___
......@@ -473,7 +511,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/1a39403/packages/core/src/Prompt.ts#L10)
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10)
___
......@@ -497,7 +535,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/1a39403/packages/core/src/Prompt.ts#L10)
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10)
___
......@@ -521,7 +559,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/1a39403/packages/core/src/Prompt.ts#L10)
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10)
___
......@@ -545,7 +583,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/1a39403/packages/core/src/Prompt.ts#L10)
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10)
___
......@@ -569,7 +607,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/1a39403/packages/core/src/Prompt.ts#L10)
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10)
___
......@@ -593,7 +631,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/1a39403/packages/core/src/Prompt.ts#L10)
[Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L10)
___
......@@ -619,7 +657,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/1a39403/packages/core/src/storage/FileSystem.ts#L74)
[storage/FileSystem.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/FileSystem.ts#L74)
___
......@@ -633,7 +671,7 @@ ___
#### Defined in
[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/FileSystem.ts#L51)
[storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/FileSystem.ts#L51)
___
......@@ -656,7 +694,7 @@ ___
#### Defined in
[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/NodeParser.ts#L15)
[NodeParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/NodeParser.ts#L15)
___
......@@ -676,7 +714,7 @@ ___
#### Defined in
[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/ResponseSynthesizer.ts#L212)
[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/ResponseSynthesizer.ts#L212)
___
......@@ -697,7 +735,7 @@ ___
#### Defined in
[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/NodeParser.ts#L5)
[NodeParser.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/NodeParser.ts#L5)
___
......@@ -723,7 +761,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/1a39403/packages/core/src/Embedding.ts#L77)
[Embedding.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Embedding.ts#L77)
___
......@@ -747,7 +785,7 @@ ___
#### Defined in
[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Embedding.ts#L119)
[Embedding.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Embedding.ts#L119)
___
......@@ -773,7 +811,7 @@ ___
#### Defined in
[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Embedding.ts#L131)
[Embedding.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Embedding.ts#L131)
___
......@@ -793,7 +831,7 @@ ___
#### Defined in
[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/Prompt.ts#L300)
[Prompt.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Prompt.ts#L300)
___
......@@ -813,7 +851,7 @@ ___
#### Defined in
[ServiceContext.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/ServiceContext.ts#L32)
[ServiceContext.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/ServiceContext.ts#L32)
___
......@@ -842,7 +880,7 @@ ___
#### Defined in
[ServiceContext.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/ServiceContext.ts#L52)
[ServiceContext.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/ServiceContext.ts#L52)
___
......@@ -868,7 +906,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/1a39403/packages/core/src/Embedding.ts#L22)
[Embedding.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/Embedding.ts#L22)
___
......@@ -888,7 +926,7 @@ ___
#### Defined in
[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/1a39403/packages/core/src/storage/StorageContext.ts#L28)
[storage/StorageContext.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/StorageContext.ts#L28)
___
......@@ -911,4 +949,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/1a39403/packages/core/src/storage/FileSystem.ts#L91)
[storage/FileSystem.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/07c5aeb/packages/core/src/storage/FileSystem.ts#L91)
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

:feet::heart: Strive to be the person your dogs believe you are :heart::feet: