diff --git a/.changeset/late-paws-help.md b/.changeset/late-paws-help.md new file mode 100644 index 0000000000000000000000000000000000000000..a4adc9b55e0a5bcbcf66666cf15a9740db8986b8 --- /dev/null +++ b/.changeset/late-paws-help.md @@ -0,0 +1,5 @@ +--- +"docs": patch +--- + +docs: update API references diff --git a/apps/docs/docs/modules/chat_engine.md b/apps/docs/docs/modules/chat_engine.md index 41ce90720b092ca1ee21c744a3fccf359037405c..b118f95c4413f0bcf0bb0ab360f67b31c9e7d4e1 100644 --- a/apps/docs/docs/modules/chat_engine.md +++ b/apps/docs/docs/modules/chat_engine.md @@ -25,5 +25,5 @@ for await (const chunk of stream) { ## Api References -- [ContextChatEngine](../../api/classes/ContextChatEngine.md) -- [CondenseQuestionChatEngine](../../api/classes/ContextChatEngine.md) +- [ContextChatEngine](../api/classes/ContextChatEngine.md) +- [CondenseQuestionChatEngine](../api/classes/ContextChatEngine.md) diff --git a/apps/docs/docs/modules/data_index.md b/apps/docs/docs/modules/data_index.md index ad5a4dcd8932b7cc004665d4ef7aaa5bf6da7bc4..61212ebbc11c06f8c218997dc0e220a75b42bdb3 100644 --- a/apps/docs/docs/modules/data_index.md +++ b/apps/docs/docs/modules/data_index.md @@ -19,5 +19,5 @@ const index = await VectorStoreIndex.fromDocuments([document]); ## API Reference -- [SummaryIndex](../../api/classes/SummaryIndex.md) -- [VectorStoreIndex](../../api/classes/VectorStoreIndex.md) +- [SummaryIndex](../api/classes/SummaryIndex.md) +- [VectorStoreIndex](../api/classes/VectorStoreIndex.md) diff --git a/apps/docs/docs/modules/data_loader.md b/apps/docs/docs/modules/data_loader.md index 1e3043b60212294d5a039b3d539f68140789f58a..e05e5c0b8c5c3b5dd5b0c59600bb2660d0716d59 100644 --- a/apps/docs/docs/modules/data_loader.md +++ b/apps/docs/docs/modules/data_loader.md @@ -14,4 +14,4 @@ documents = new SimpleDirectoryReader().loadData("./data"); ## API Reference -- [SimpleDirectoryReader](../../api/classes/SimpleDirectoryReader.md) +- [SimpleDirectoryReader](../api/classes/SimpleDirectoryReader.md) diff --git a/apps/docs/docs/modules/documents_and_nodes/index.md b/apps/docs/docs/modules/documents_and_nodes/index.md index d4a36ca6c28a947de076edf59ae74423ae47ff0b..607d683a2e8ed99df98f4b33559fca65c6c97629 100644 --- a/apps/docs/docs/modules/documents_and_nodes/index.md +++ b/apps/docs/docs/modules/documents_and_nodes/index.md @@ -14,5 +14,5 @@ document = new Document({ text: "text", metadata: { key: "val" } }); ## API Reference -- [Document](../../api/classes/Document.md) -- [TextNode](../../api/classes/TextNode.md) +- [Document](../api/classes/Document.md) +- [TextNode](../api/classes/TextNode.md) diff --git a/apps/docs/docs/modules/embedding.md b/apps/docs/docs/modules/embedding.md index b3ca243f9ba8e587080902f95391e4966721227e..8be55616ace4e45c6d36718fec9d0a9e7878791c 100644 --- a/apps/docs/docs/modules/embedding.md +++ b/apps/docs/docs/modules/embedding.md @@ -18,5 +18,5 @@ const serviceContext = serviceContextFromDefaults({ embedModel: openaiEmbeds }); ## API Reference -- [OpenAIEmbedding](../../api/classes/OpenAIEmbedding.md) -- [ServiceContext](../../api/interfaces/ServiceContext.md) +- [OpenAIEmbedding](../api/classes/OpenAIEmbedding.md) +- [ServiceContext](../api/interfaces//ServiceContext.md) diff --git a/apps/docs/docs/modules/ingestion_pipeline/transformations.md b/apps/docs/docs/modules/ingestion_pipeline/transformations.md index 3d947628e279fbac4af4ef313f0e4f3037e80f5f..1674078a0c537f7af02515035a528703a7252802 100644 --- a/apps/docs/docs/modules/ingestion_pipeline/transformations.md +++ b/apps/docs/docs/modules/ingestion_pipeline/transformations.md @@ -4,7 +4,7 @@ A transformation is something that takes a list of nodes as an input, and return Currently, the following components are Transformation objects: -- [SimpleNodeParser](../../api/classes/SimpleNodeParser.md) +- [SimpleNodeParser](../api/classes/SimpleNodeParser.md) - [MetadataExtractor](../documents_and_nodes/metadata_extraction.md) - Embeddings diff --git a/apps/docs/docs/modules/llm.md b/apps/docs/docs/modules/llm.md index b2e19f7f449590c7c2a8aee8e31563628e0293b5..d7e0234e01cd8b8e7f6edb414258eda37b5d487c 100644 --- a/apps/docs/docs/modules/llm.md +++ b/apps/docs/docs/modules/llm.md @@ -30,5 +30,5 @@ export AZURE_OPENAI_DEPLOYMENT="gpt-4" # or some other deployment name ## API Reference -- [OpenAI](../../api/classes/OpenAI.md) -- [ServiceContext](../../api/interfaces/ServiceContext.md) +- [OpenAI](../api/classes/OpenAI.md) +- [ServiceContext](../api/interfaces//ServiceContext.md) diff --git a/apps/docs/docs/modules/node_parser.md b/apps/docs/docs/modules/node_parser.md index 3db49cd1c5e45a9103858382daab2faf0948fdb1..c5679fafa208f4953b97d25eb17e4a18263667b7 100644 --- a/apps/docs/docs/modules/node_parser.md +++ b/apps/docs/docs/modules/node_parser.md @@ -29,5 +29,5 @@ const textSplits = splitter.splitText("Hello World"); ## API Reference -- [SimpleNodeParser](../../api/classes/SimpleNodeParser.md) -- [SentenceSplitter](../../api/classes/SentenceSplitter.md) +- [SimpleNodeParser](../api/classes/SimpleNodeParser.md) +- [SentenceSplitter](../api/classes/SentenceSplitter.md) diff --git a/apps/docs/docs/modules/query_engines/index.md b/apps/docs/docs/modules/query_engines/index.md index 83d6e875bf3b7c4253f854d090e045f2f87d8eb9..5a2980ff799e2f7550a157d8471f89cc31028436 100644 --- a/apps/docs/docs/modules/query_engines/index.md +++ b/apps/docs/docs/modules/query_engines/index.md @@ -36,6 +36,6 @@ You can learn more about Tools by taking a look at the LlamaIndex Python documen ## API Reference -- [RetrieverQueryEngine](../../api/classes/RetrieverQueryEngine.md) -- [SubQuestionQueryEngine](../../api/classes/SubQuestionQueryEngine.md) -- [QueryEngineTool](../../api/interfaces/QueryEngineTool.md) +- [RetrieverQueryEngine](../api/classes/RetrieverQueryEngine.md) +- [SubQuestionQueryEngine](../api/classes/SubQuestionQueryEngine.md) +- [QueryEngineTool](../api/interfaces//QueryEngineTool.md) diff --git a/apps/docs/docs/modules/response_synthesizer.md b/apps/docs/docs/modules/response_synthesizer.md index ba416d82f868b034361d52f00b4d9bf7813b6c1d..7e66fd22a424648754746fbedd88733991a5d023 100644 --- a/apps/docs/docs/modules/response_synthesizer.md +++ b/apps/docs/docs/modules/response_synthesizer.md @@ -57,8 +57,8 @@ for await (const chunk of stream) { ## API Reference -- [ResponseSynthesizer](../../api/classes/ResponseSynthesizer.md) -- [Refine](../../api/classes/Refine.md) -- [CompactAndRefine](../../api/classes/CompactAndRefine.md) -- [TreeSummarize](../../api/classes/TreeSummarize.md) -- [SimpleResponseBuilder](../../api/classes/SimpleResponseBuilder.md) +- [ResponseSynthesizer](../api/classes/ResponseSynthesizer.md) +- [Refine](../api/classes/Refine.md) +- [CompactAndRefine](../api/classes/CompactAndRefine.md) +- [TreeSummarize](../api/classes/TreeSummarize.md) +- [SimpleResponseBuilder](../api/classes/SimpleResponseBuilder.md) diff --git a/apps/docs/docs/modules/retriever.md b/apps/docs/docs/modules/retriever.md index 9ead0602db47a3c28dbd432421c2934a221cf128..d49fba12f794179ca1d8a24101ca9009c69eacc0 100644 --- a/apps/docs/docs/modules/retriever.md +++ b/apps/docs/docs/modules/retriever.md @@ -16,6 +16,6 @@ const nodesWithScore = await retriever.retrieve("query string"); ## API Reference -- [SummaryIndexRetriever](../../api/classes/SummaryIndexRetriever.md) -- [SummaryIndexLLMRetriever](../../api/classes/SummaryIndexLLMRetriever.md) -- [VectorIndexRetriever](../../api/classes/VectorIndexRetriever.md) +- [SummaryIndexRetriever](../api/classes/SummaryIndexRetriever.md) +- [SummaryIndexLLMRetriever](../api/classes/SummaryIndexLLMRetriever.md) +- [VectorIndexRetriever](../api/classes/VectorIndexRetriever.md) diff --git a/apps/docs/docs/modules/storage.md b/apps/docs/docs/modules/storage.md index 16bdc77fa3f5181d81199fbd949f8d0d4a55c8e5..3844e8729e33c9afa0f560b849bcb8c0119dcca7 100644 --- a/apps/docs/docs/modules/storage.md +++ b/apps/docs/docs/modules/storage.md @@ -23,4 +23,4 @@ const index = await VectorStoreIndex.fromDocuments([document], { ## API Reference -- [StorageContext](../../api/interfaces/StorageContext.md) +- [StorageContext](../api/interfaces//StorageContext.md)