From acead0c542ee4f8fd2b7ddbfb270bc38093b9771 Mon Sep 17 00:00:00 2001
From: Logan <logan.markewich@live.com>
Date: Fri, 22 Mar 2024 13:43:22 -0600
Subject: [PATCH] add more redirects (#12185)
---
.../storage/graph_stores/neptune.md | 5 +++
.../storage/vector_store/kdbai.md | 4 ++
.../module_guides/deploying/agents/modules.md | 2 +-
.../deploying/query_engine/modules.md | 6 +--
.../putting_it_all_together/agents.md | 2 +-
.../putting_it_all_together/q_and_a.md | 4 +-
docs/mkdocs.yml | 38 +++++++++++++++++++
7 files changed, 54 insertions(+), 7 deletions(-)
create mode 100644 docs/docs/api_reference/storage/graph_stores/neptune.md
create mode 100644 docs/docs/api_reference/storage/vector_store/kdbai.md
diff --git a/docs/docs/api_reference/storage/graph_stores/neptune.md b/docs/docs/api_reference/storage/graph_stores/neptune.md
new file mode 100644
index 0000000000..8be441642f
--- /dev/null
+++ b/docs/docs/api_reference/storage/graph_stores/neptune.md
@@ -0,0 +1,5 @@
+::: llama_index.graph_stores.neptune
+ options:
+ members:
+ - NeptuneAnalyticsGraphStore
+ - NeptuneDatabaseGraphStore
diff --git a/docs/docs/api_reference/storage/vector_store/kdbai.md b/docs/docs/api_reference/storage/vector_store/kdbai.md
new file mode 100644
index 0000000000..a2bddfc7e8
--- /dev/null
+++ b/docs/docs/api_reference/storage/vector_store/kdbai.md
@@ -0,0 +1,4 @@
+::: llama_index.vector_stores.kdbai
+ options:
+ members:
+ - KDBAIVectorStore
diff --git a/docs/docs/module_guides/deploying/agents/modules.md b/docs/docs/module_guides/deploying/agents/modules.md
index 5e94c02cd8..5a6454c0dc 100644
--- a/docs/docs/module_guides/deploying/agents/modules.md
+++ b/docs/docs/module_guides/deploying/agents/modules.md
@@ -13,7 +13,7 @@ For more detailed guides on how to use specific tools, check out our [tools modu
- [Query Planning](../../../examples/agent/openai_agent_query_plan.ipynb)
- [Context Retrieval Agent](../../../examples/agent/openai_agent_context_retrieval.ipynb)
- [Recursive Retriever Agents](../../../examples/query_engine/recursive_retriever_agents.ipynb)
-- [Multi-Document Agents](../../../examples/agent/multi_document_agents.ipynb)
+- [Multi Document Agents](../../../examples/agent/multi_document_agents.ipynb)
- [Agent Builder](../../../examples/agent/agent_builder.ipynb)
- [Parallel Function Calling](../../../examples/agent/openai_agent_parallel_function_calling.ipynb)
diff --git a/docs/docs/module_guides/deploying/query_engine/modules.md b/docs/docs/module_guides/deploying/query_engine/modules.md
index 3a0115eb08..e1780c4afa 100644
--- a/docs/docs/module_guides/deploying/query_engine/modules.md
+++ b/docs/docs/module_guides/deploying/query_engine/modules.md
@@ -38,14 +38,14 @@ Then check out the rest of the sections below.
- [Recursive Agents](../../../examples/query_engine/recursive_retriever_agents.ipynb)
- [Ensemble Query Engine](../../../examples/query_engine/ensemble_query_engine.ipynb)
-### Advanced: Towards Multi-Document Querying/Analysis
+### Advanced: Towards Multi Document Querying/Analysis
This specific subsection showcases modules that help with querying multiple documents.
- [Sub-Question Query Engine](../../../examples/query_engine/sub_question_query_engine.ipynb)
- [Recursive Agents](../../../examples/query_engine/recursive_retriever_agents.ipynb)
-- [Multi-Document Agents](../../../examples/agent/multi_document_agents.ipynb)
-- [Improved Multi-Document Agents](../../../examples/agent/multi_document_agents-v1.ipynb)
+- [Multi Document Agents](../../../examples/agent/multi_document_agents.ipynb)
+- [Improved Multi Document Agents](../../../examples/agent/multi_document_agents-v1.ipynb)
## Experimental
diff --git a/docs/docs/understanding/putting_it_all_together/agents.md b/docs/docs/understanding/putting_it_all_together/agents.md
index 47d8450d08..16d63540e7 100644
--- a/docs/docs/understanding/putting_it_all_together/agents.md
+++ b/docs/docs/understanding/putting_it_all_together/agents.md
@@ -59,7 +59,7 @@ We have an `OpenAIAgent` implementation built on the [OpenAI API for function ca
LlamaIndex provides core modules capable of automated reasoning for different use cases over your data which makes them essentially Agents. Some of these core modules are shown below along with example tutorials.
-**SubQuestionQueryEngine for Multi-Document Analysis**
+**SubQuestionQueryEngine for Multi Document Analysis**
- [Sub Question Query Engine (Intro)](../../examples/query_engine/sub_question_query_engine.ipynb)
- [10Q Analysis (Uber)](../../examples/usecases/10q_sub_question.ipynb)
diff --git a/docs/docs/understanding/putting_it_all_together/q_and_a.md b/docs/docs/understanding/putting_it_all_together/q_and_a.md
index 28abcf6178..2b57b4860c 100644
--- a/docs/docs/understanding/putting_it_all_together/q_and_a.md
+++ b/docs/docs/understanding/putting_it_all_together/q_and_a.md
@@ -125,9 +125,9 @@ This module will help break down a complex query into a simpler one over your ex
- [Query Transformations](../../optimizing/advanced_retrieval/query_transformations.md)
-You can also rely on the LLM to _infer_ whether to perform compare/contrast queries (see Multi-Document Queries below).
+You can also rely on the LLM to _infer_ whether to perform compare/contrast queries (see Multi Document Queries below).
-## Multi-Document Queries
+## Multi Document Queries
Besides the explicit synthesis/routing flows described above, LlamaIndex can support more general multi-document queries as well.
It can do this through our `SubQuestionQueryEngine` class. Given a query, this query engine will generate a "query plan" containing
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index c57637c563..15e9f41381 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -1732,6 +1732,42 @@ plugins:
- ../llama-index-integrations/graph_stores/llama-index-graph-stores-neptune
- redirects:
redirect_maps:
+ ./module_guides/loading/documents_and_nodes/usage_documents.html: module_guides/loading/documents_and_nodes/usage_documents.md
+ ./getting_started/concepts.html: getting_started/concepts.md
+ ./understanding/loading/loading.html: module_guides/loading/index.md
+ ./module_guides/models/llms.html: module_guides/models/llms.md
+ ./use_cases/q_and_a/rag_cli.html: use_cases/q_and_a/rag_cli.md
+ ./module_guides/observability/instrumentation.html: module_guides/observability/instrumentation.md
+ ./end_to_end_tutorials/usage_pattern.html: understanding/index.md
+ ./end_to_end_tutorials/one_click_observability.html: module_guides/observability/index.md
+ ./end_to_end_tutorials/dev_practices/production_rag.html: optimizing/production_rag.md
+ ./end_to_end_tutorials/dev_practices/evaluation.html: optimizing/evaluation/evaluation.md
+ ./end_to_end_tutorials/discover_llamaindex.html: getting_started/discover_llamaindex.md
+ ./end_to_end_tutorials/finetuning.html: optimizing/fine-tuning/fine-tuning.md
+ ./end_to_end_tutorials/low_level/root.html: optimizing/building_rag_from_scratch.md
+ ./end_to_end_tutorials/use_cases.html: use_cases/q_and_a/index.md
+ ./core_modules/data_modules/connector.html: module_guides/loading/connector/index.md
+ ./core_modules/data_modules/documents_and_nodes/root.html: module_guides/loading/documents_and_nodes/index.md
+ ./core_modules/data_modules/node_parsers/root.html: module_guides/loading/node_parsers/index.md
+ ./core_modules/data_modules/storage/root.html: module_guides/storing/index.md
+ ./core_modules/data_modules/index/root.html: module_guides/indexing/index.md
+ ./core_modules/query_modules/query_engine/root.html: module_guides/deploying/query_engine/index.md
+ ./core_modules/query_modules/chat_engines/root.html: module_guides/deploying/chat_engines/index.md
+ ./core_modules/query_modules/retriever/root.html: module_guides/querying/retriever/index.md
+ ./core_modules/query_modules/router/root.html: module_guides/querying/router/index.md
+ ./core_modules/query_modules/node_postprocessors/root.html: module_guides/querying/node_postprocessors/index.md
+ ./core_modules/query_modules/response_synthesizers/root.html: module_guides/querying/response_synthesizers/index.md
+ ./core_modules/query_modules/structured_outputs/root.html: module_guides/querying/structured_outputs/index.md
+ ./core_modules/agent_modules/agents/root.html: module_guides/deploying/agents/index.md
+ ./core_modules/agent_modules/tools/root.html: module_guides/deploying/agents/tools/index.md
+ ./core_modules/model_modules/llms/root.html: module_guides/models/llms.md
+ ./core_modules/model_modules/embeddings/root.html: module_guides/models/embeddings.md
+ ./core_modules/model_modules/prompts.html: module_guides/models/prompts/index.md
+ ./core_modules/supporting_modules/service_context.html: module_guides/supporting_modules/settings.md
+ ./core_modules/supporting_modules/callbacks/root.html: module_guides/observability/callbacks/index.md
+ ./core_modules/supporting_modules/evaluation/root.html: module_guides/evaluating/index.md
+ ./core_modules/supporting_modules/cost_analysis/root.html: understanding/evaluating/cost_analysis/index.md
+ ./api/llama_index.vector_stores.MongoDBAtlasVectorSearch.html: api_reference/storage/vector_store/mongodb.md
./community/llama_packs/root.html: community/llama_packs/index.md
./examples/citation/pdf_page_reference.html: https://docs.llamaindex.ai/en/latest/examples/citation/pdf_page_reference/
./examples/vector_stores/TypesenseDemo.html: https://docs.llamaindex.ai/en/latest/examples/vector_stores/TypesenseDemo/
@@ -2196,6 +2232,8 @@ theme:
- navigation.footer
- toc.follow
- content.code.copy
+ - search.suggest
+ - search.highlight
logo: _static/assets/LlamaSquareBlack.svg
name: material
palette:
--
GitLab