From 969e1683de752d5b9c59df1f84e97937c0dbf42d Mon Sep 17 00:00:00 2001 From: Lance Martin <122662504+rlancemartin@users.noreply.github.com> Date: Mon, 14 Aug 2023 17:20:38 -0700 Subject: [PATCH] Move graph use case to "more" section (#8997) Clean `use_cases` by moving the `GraphDB` to `integrations`. --------- Co-authored-by: Bagatur --- docs/docs_skeleton/vercel.json | 72 +++++++++++++++---- .../use_cases/agent_simulations/index.mdx | 4 ++ docs/extras/use_cases/agents/index.mdx | 4 ++ .../use_cases/autonomous_agents/index.mdx | 4 ++ docs/extras/use_cases/code_writing/index.mdx | 4 ++ docs/extras/use_cases/more/_category_.yml | 2 + .../{ => more}/graph/graph_arangodb_qa.ipynb | 0 .../{ => more}/graph/graph_cypher_qa.ipynb | 0 .../{ => more}/graph/graph_hugegraph_qa.ipynb | 0 .../{ => more}/graph/graph_kuzu_qa.ipynb | 0 .../{ => more}/graph/graph_nebula_qa.ipynb | 0 .../use_cases/{ => more}/graph/graph_qa.ipynb | 0 .../{ => more}/graph/graph_sparql_qa.ipynb | 0 .../use_cases/{ => more}/graph/index.mdx | 0 .../{ => more}/graph/neptune_cypher_qa.ipynb | 0 .../use_cases/{ => more}/graph/tot.ipynb | 0 .../use_cases/multi_modal/_category_.yml | 1 + .../use_cases/question_answering/index.mdx | 2 +- docs/extras/use_cases/self_check/index.mdx | 4 ++ 19 files changed, 84 insertions(+), 13 deletions(-) create mode 100644 docs/extras/use_cases/more/_category_.yml rename docs/extras/use_cases/{ => more}/graph/graph_arangodb_qa.ipynb (100%) rename docs/extras/use_cases/{ => more}/graph/graph_cypher_qa.ipynb (100%) rename docs/extras/use_cases/{ => more}/graph/graph_hugegraph_qa.ipynb (100%) rename docs/extras/use_cases/{ => more}/graph/graph_kuzu_qa.ipynb (100%) rename docs/extras/use_cases/{ => more}/graph/graph_nebula_qa.ipynb (100%) rename docs/extras/use_cases/{ => more}/graph/graph_qa.ipynb (100%) rename docs/extras/use_cases/{ => more}/graph/graph_sparql_qa.ipynb (100%) rename docs/extras/use_cases/{ => more}/graph/index.mdx (100%) rename docs/extras/use_cases/{ => more}/graph/neptune_cypher_qa.ipynb (100%) rename docs/extras/use_cases/{ => more}/graph/tot.ipynb (100%) diff --git a/docs/docs_skeleton/vercel.json b/docs/docs_skeleton/vercel.json index 224afa7ba48..49e9d0e5f66 100644 --- a/docs/docs_skeleton/vercel.json +++ b/docs/docs_skeleton/vercel.json @@ -1620,17 +1620,29 @@ "source": "/en/latest/modules/chains/examples/flare.html", "destination": "/docs/use_cases/question_answering/how_to/flare" }, + { + "source": "/docs/use_cases/graph/graph_cypher_qa", + "destination": "/docs/use_cases/more/graph/graph_cypher_qa" + }, { "source": "/en/latest/modules/chains/examples/graph_cypher_qa.html", - "destination": "/docs/use_cases/graph/graph_cypher_qa" + "destination": "/docs/use_cases/more/graph/graph_cypher_qa" + }, + { + "source": "/docs/use_cases/graph/graph_nebula_qa", + "destination": "/docs/use_cases/more/graph/graph_nebula_qa" }, { "source": "/en/latest/modules/chains/examples/graph_nebula_qa.html", - "destination": "/docs/use_cases/graph/graph_nebula_qa" + "destination": "/docs/use_cases/more/graph/graph_nebula_qa" + }, + { + "source": "/docs/use_cases/graph/graph_qa", + "destination": "/docs/use_cases/more/graph/graph_qa" }, { "source": "/en/latest/modules/chains/index_examples/graph_qa.html", - "destination": "/docs/use_cases/graph/graph_qa" + "destination": "/docs/use_cases/more/graph/graph_qa" }, { "source": "/en/latest/modules/chains/index_examples/hyde.html", @@ -3876,41 +3888,77 @@ "source": "/docs/modules/chains/additional/pal", "destination": "/docs/use_cases/code_writing/pal" }, + { + "source": "/docs/use_cases/graph/graph_arangodb_qa", + "destination": "/docs/use_cases/more/graph/graph_arangodb_qa" + }, { "source": "/docs/modules/chains/additional/graph_arangodb_qa", - "destination": "/docs/use_cases/graph/graph_arangodb_qa" + "destination": "/docs/use_cases/more/graph/graph_arangodb_qa" + }, + { + "source": "/docs/use_cases/graph/graph_cypher_qa", + "destination": "/docs/use_cases/more/graph/graph_cypher_qa" }, { "source": "/docs/modules/chains/additional/graph_cypher_qa", - "destination": "/docs/use_cases/graph/graph_cypher_qa" + "destination": "/docs/use_cases/more/graph/graph_cypher_qa" + }, + { + "source": "/docs/use_cases/graph/graph_hugegraph_qa", + "destination": "/docs/use_cases/more/graph/graph_hugegraph_qa" }, { "source": "/docs/modules/chains/additional/graph_hugegraph_qa", - "destination": "/docs/use_cases/graph/graph_hugegraph_qa" + "destination": "/docs/use_cases/more/graph/graph_hugegraph_qa" + }, + { + "source": "/docs/use_cases/graph/graph_kuzu_qa", + "destination": "/docs/use_cases/more/graph/graph_kuzu_qa" }, { "source": "/docs/modules/chains/additional/graph_kuzu_qa", - "destination": "/docs/use_cases/graph/graph_kuzu_qa" + "destination": "/docs/use_cases/more/graph/graph_kuzu_qa" + }, + { + "source": "/docs/use_cases/graph/graph_nebula_qa", + "destination": "/docs/use_cases/more/graph/graph_nebula_qa" }, { "source": "/docs/modules/chains/additional/graph_nebula_qa", - "destination": "/docs/use_cases/graph/graph_nebula_qa" + "destination": "/docs/use_cases/more/graph/graph_nebula_qa" + }, + { + "source": "/docs/use_cases/graph/graph_qa", + "destination": "/docs/use_cases/more/graph/graph_qa" }, { "source": "/docs/modules/chains/additional/graph_qa", - "destination": "/docs/use_cases/graph/graph_qa" + "destination": "/docs/use_cases/more/graph/graph_qa" + }, + { + "source": "/docs/use_cases/graph/graph_sparql_qa", + "destination": "/docs/use_cases/more/graph/graph_sparql_qa" }, { "source": "/docs/modules/chains/additional/graph_sparql_qa", - "destination": "/docs/use_cases/graph/graph_sparql_qa" + "destination": "/docs/use_cases/more/graph/graph_sparql_qa" + }, + { + "source": "/docs/use_cases/graph/neptune_cypher_qa", + "destination": "/docs/use_cases/more/graph/neptune_cypher_qa" }, { "source": "/docs/modules/chains/additional/neptune_cypher_qa", - "destination": "/docs/use_cases/graph/neptune_cypher_qa" + "destination": "/docs/use_cases/more/graph/neptune_cypher_qa" + }, + { + "source": "/docs/use_cases/graph/tot", + "destination": "/docs/use_cases/more/graph/tot" }, { "source": "/docs/modules/chains/additional/tot", - "destination": "/docs/use_cases/graph/tot" + "destination": "/docs/use_cases/more/graph/tot" }, { "source": "/docs/use_cases/question_answering//document-context-aware-QA", diff --git a/docs/extras/use_cases/agent_simulations/index.mdx b/docs/extras/use_cases/agent_simulations/index.mdx index c6af033e53f..4232231b85d 100644 --- a/docs/extras/use_cases/agent_simulations/index.mdx +++ b/docs/extras/use_cases/agent_simulations/index.mdx @@ -1,3 +1,7 @@ +--- +sidebar_position: 0 +--- + # Agent simulations Agent simulations involve interacting one of more agents with each other. diff --git a/docs/extras/use_cases/agents/index.mdx b/docs/extras/use_cases/agents/index.mdx index 7a6b4a36a28..6c4da5f0a7a 100644 --- a/docs/extras/use_cases/agents/index.mdx +++ b/docs/extras/use_cases/agents/index.mdx @@ -1,3 +1,7 @@ +--- +sidebar_position: 0 +--- + # Agents Agents can be used for a variety of tasks. diff --git a/docs/extras/use_cases/autonomous_agents/index.mdx b/docs/extras/use_cases/autonomous_agents/index.mdx index e930a97dbfb..bc2bb81af08 100644 --- a/docs/extras/use_cases/autonomous_agents/index.mdx +++ b/docs/extras/use_cases/autonomous_agents/index.mdx @@ -1,3 +1,7 @@ +--- +sidebar_position: 0 +--- + # Autonomous (long-running) agents Autonomous Agents are agents that designed to be more long running. diff --git a/docs/extras/use_cases/code_writing/index.mdx b/docs/extras/use_cases/code_writing/index.mdx index 218b4385159..4dd704b5a0a 100644 --- a/docs/extras/use_cases/code_writing/index.mdx +++ b/docs/extras/use_cases/code_writing/index.mdx @@ -1,3 +1,7 @@ +--- +sidebar_position: 0 +--- + # Code writing :::warning diff --git a/docs/extras/use_cases/more/_category_.yml b/docs/extras/use_cases/more/_category_.yml new file mode 100644 index 00000000000..5e1490ecde0 --- /dev/null +++ b/docs/extras/use_cases/more/_category_.yml @@ -0,0 +1,2 @@ +label: 'More' +position: 1 diff --git a/docs/extras/use_cases/graph/graph_arangodb_qa.ipynb b/docs/extras/use_cases/more/graph/graph_arangodb_qa.ipynb similarity index 100% rename from docs/extras/use_cases/graph/graph_arangodb_qa.ipynb rename to docs/extras/use_cases/more/graph/graph_arangodb_qa.ipynb diff --git a/docs/extras/use_cases/graph/graph_cypher_qa.ipynb b/docs/extras/use_cases/more/graph/graph_cypher_qa.ipynb similarity index 100% rename from docs/extras/use_cases/graph/graph_cypher_qa.ipynb rename to docs/extras/use_cases/more/graph/graph_cypher_qa.ipynb diff --git a/docs/extras/use_cases/graph/graph_hugegraph_qa.ipynb b/docs/extras/use_cases/more/graph/graph_hugegraph_qa.ipynb similarity index 100% rename from docs/extras/use_cases/graph/graph_hugegraph_qa.ipynb rename to docs/extras/use_cases/more/graph/graph_hugegraph_qa.ipynb diff --git a/docs/extras/use_cases/graph/graph_kuzu_qa.ipynb b/docs/extras/use_cases/more/graph/graph_kuzu_qa.ipynb similarity index 100% rename from docs/extras/use_cases/graph/graph_kuzu_qa.ipynb rename to docs/extras/use_cases/more/graph/graph_kuzu_qa.ipynb diff --git a/docs/extras/use_cases/graph/graph_nebula_qa.ipynb b/docs/extras/use_cases/more/graph/graph_nebula_qa.ipynb similarity index 100% rename from docs/extras/use_cases/graph/graph_nebula_qa.ipynb rename to docs/extras/use_cases/more/graph/graph_nebula_qa.ipynb diff --git a/docs/extras/use_cases/graph/graph_qa.ipynb b/docs/extras/use_cases/more/graph/graph_qa.ipynb similarity index 100% rename from docs/extras/use_cases/graph/graph_qa.ipynb rename to docs/extras/use_cases/more/graph/graph_qa.ipynb diff --git a/docs/extras/use_cases/graph/graph_sparql_qa.ipynb b/docs/extras/use_cases/more/graph/graph_sparql_qa.ipynb similarity index 100% rename from docs/extras/use_cases/graph/graph_sparql_qa.ipynb rename to docs/extras/use_cases/more/graph/graph_sparql_qa.ipynb diff --git a/docs/extras/use_cases/graph/index.mdx b/docs/extras/use_cases/more/graph/index.mdx similarity index 100% rename from docs/extras/use_cases/graph/index.mdx rename to docs/extras/use_cases/more/graph/index.mdx diff --git a/docs/extras/use_cases/graph/neptune_cypher_qa.ipynb b/docs/extras/use_cases/more/graph/neptune_cypher_qa.ipynb similarity index 100% rename from docs/extras/use_cases/graph/neptune_cypher_qa.ipynb rename to docs/extras/use_cases/more/graph/neptune_cypher_qa.ipynb diff --git a/docs/extras/use_cases/graph/tot.ipynb b/docs/extras/use_cases/more/graph/tot.ipynb similarity index 100% rename from docs/extras/use_cases/graph/tot.ipynb rename to docs/extras/use_cases/more/graph/tot.ipynb diff --git a/docs/extras/use_cases/multi_modal/_category_.yml b/docs/extras/use_cases/multi_modal/_category_.yml index e6d4e549eb4..96ce6ef2bbe 100644 --- a/docs/extras/use_cases/multi_modal/_category_.yml +++ b/docs/extras/use_cases/multi_modal/_category_.yml @@ -1 +1,2 @@ label: 'Multi-modal' +position: 0 diff --git a/docs/extras/use_cases/question_answering/index.mdx b/docs/extras/use_cases/question_answering/index.mdx index 65421737b72..a9d98d26413 100644 --- a/docs/extras/use_cases/question_answering/index.mdx +++ b/docs/extras/use_cases/question_answering/index.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 0 +sidebar_position: -1 --- # QA over Documents diff --git a/docs/extras/use_cases/self_check/index.mdx b/docs/extras/use_cases/self_check/index.mdx index a424ea43701..9880394eb5a 100644 --- a/docs/extras/use_cases/self_check/index.mdx +++ b/docs/extras/use_cases/self_check/index.mdx @@ -1,3 +1,7 @@ +--- +sidebar_position: 0 +--- + # Self-checking One of the main issues with using LLMs is that they can often hallucinate and make false claims. One of the surprisingly effective ways to remediate this is to use the LLM itself to check its own answers.