From 0f64084c20512a00152bcc58ecb3ce7f19d21d7e Mon Sep 17 00:00:00 2001
From: Emanuel Ferreira <contatoferreirads@gmail.com>
Date: Thu, 1 Feb 2024 19:13:33 -0300
Subject: [PATCH] docs: update API references (#502)
---
.changeset/late-paws-help.md | 5 +++++
apps/docs/docs/modules/chat_engine.md | 4 ++--
apps/docs/docs/modules/data_index.md | 4 ++--
apps/docs/docs/modules/data_loader.md | 2 +-
apps/docs/docs/modules/documents_and_nodes/index.md | 4 ++--
apps/docs/docs/modules/embedding.md | 4 ++--
.../docs/modules/ingestion_pipeline/transformations.md | 2 +-
apps/docs/docs/modules/llm.md | 4 ++--
apps/docs/docs/modules/node_parser.md | 4 ++--
apps/docs/docs/modules/query_engines/index.md | 6 +++---
apps/docs/docs/modules/response_synthesizer.md | 10 +++++-----
apps/docs/docs/modules/retriever.md | 6 +++---
apps/docs/docs/modules/storage.md | 2 +-
13 files changed, 31 insertions(+), 26 deletions(-)
create mode 100644 .changeset/late-paws-help.md
diff --git a/.changeset/late-paws-help.md b/.changeset/late-paws-help.md
new file mode 100644
index 000000000..a4adc9b55
--- /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 41ce90720..b118f95c4 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 ad5a4dcd8..61212ebbc 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 1e3043b60..e05e5c0b8 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 d4a36ca6c..607d683a2 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 b3ca243f9..8be55616a 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 3d947628e..1674078a0 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 b2e19f7f4..d7e0234e0 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 3db49cd1c..c5679fafa 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 83d6e875b..5a2980ff7 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 ba416d82f..7e66fd22a 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 9ead0602d..d49fba12f 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 16bdc77fa..3844e8729 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)
--
GitLab