From 6f4b9f3372ac93b62ecfd6f224fcaae847b72cb0 Mon Sep 17 00:00:00 2001 From: Fabian Wimmer <github@insightby.ai> Date: Tue, 25 Jun 2024 04:10:16 +0200 Subject: [PATCH] docs: fix broken links, add API References (#962) --- .../starter_tutorial/retrieval_augmented_generation.mdx | 2 +- .../starter_tutorial/structured_data_extraction.mdx | 4 ++-- apps/docs/docs/modules/agent/index.md | 6 ++++++ apps/docs/docs/modules/documents_and_nodes/index.md | 4 ++-- .../modules/documents_and_nodes/metadata_extraction.md | 7 +++++++ .../modules/embeddings/available_embeddings/deepinfra.md | 4 ++++ .../docs/modules/embeddings/available_embeddings/gemini.md | 4 ++++ .../modules/embeddings/available_embeddings/huggingface.md | 4 ++++ .../docs/modules/embeddings/available_embeddings/jinaai.md | 4 ++++ .../modules/embeddings/available_embeddings/mistral.md | 4 ++++ .../docs/modules/embeddings/available_embeddings/ollama.md | 4 ++++ .../docs/modules/embeddings/available_embeddings/openai.md | 4 ++++ .../modules/embeddings/available_embeddings/together.md | 4 ++++ apps/docs/docs/modules/evaluation/modules/correctness.md | 4 ++++ apps/docs/docs/modules/evaluation/modules/faithfulness.md | 4 ++++ apps/docs/docs/modules/evaluation/modules/relevancy.md | 4 ++++ apps/docs/docs/modules/ingestion_pipeline/index.md | 4 ++++ .../docs/modules/ingestion_pipeline/transformations.md | 4 ++-- apps/docs/docs/modules/llms/available_llms/anthropic.md | 4 ++++ apps/docs/docs/modules/llms/available_llms/azure.md | 4 ++++ apps/docs/docs/modules/llms/available_llms/deepinfra.md | 4 ++++ apps/docs/docs/modules/llms/available_llms/fireworks.md | 4 ++++ apps/docs/docs/modules/llms/available_llms/gemini.md | 4 ++++ apps/docs/docs/modules/llms/available_llms/groq.mdx | 4 ++++ apps/docs/docs/modules/llms/available_llms/llama2.md | 5 +++++ apps/docs/docs/modules/llms/available_llms/mistral.md | 4 ++++ apps/docs/docs/modules/llms/available_llms/ollama.md | 4 ++++ apps/docs/docs/modules/llms/available_llms/openai.md | 4 ++++ apps/docs/docs/modules/llms/available_llms/portkey.md | 4 ++++ apps/docs/docs/modules/llms/available_llms/together.md | 4 ++++ apps/docs/docs/modules/llms/index.md | 2 +- apps/docs/docs/modules/node_parser.md | 1 + .../docs/modules/node_postprocessors/cohere_reranker.md | 4 ++++ apps/docs/docs/modules/node_postprocessors/index.md | 4 ++++ .../docs/modules/node_postprocessors/jinaai_reranker.md | 4 ++++ apps/docs/docs/modules/prompt/index.md | 6 ++++++ apps/docs/docs/modules/query_engines/index.md | 2 +- apps/docs/docs/modules/query_engines/metadata_filtering.md | 5 +++++ .../docs/docs/modules/query_engines/router_query_engine.md | 4 ++++ apps/docs/docs/modules/storage.md | 2 +- apps/docs/docs/modules/vector_stores/qdrant.md | 4 ++++ 41 files changed, 152 insertions(+), 10 deletions(-) diff --git a/apps/docs/docs/getting_started/starter_tutorial/retrieval_augmented_generation.mdx b/apps/docs/docs/getting_started/starter_tutorial/retrieval_augmented_generation.mdx index a618c83e0..a6d7e67cb 100644 --- a/apps/docs/docs/getting_started/starter_tutorial/retrieval_augmented_generation.mdx +++ b/apps/docs/docs/getting_started/starter_tutorial/retrieval_augmented_generation.mdx @@ -21,7 +21,7 @@ npm install -D typescript @types/node Then, check out the [installation](../installation) steps to install LlamaIndex.TS and prepare an OpenAI key. -You can use [other LLMs](../examples/other_llms) via their APIs; if you would prefer to use local models check out our [local LLM example](../../examples/local_llm). +You can use [other LLMs](../../examples/other_llms) via their APIs; if you would prefer to use local models check out our [local LLM example](../../examples/local_llm). ## Run queries diff --git a/apps/docs/docs/getting_started/starter_tutorial/structured_data_extraction.mdx b/apps/docs/docs/getting_started/starter_tutorial/structured_data_extraction.mdx index 66f2fa264..49ff74d75 100644 --- a/apps/docs/docs/getting_started/starter_tutorial/structured_data_extraction.mdx +++ b/apps/docs/docs/getting_started/starter_tutorial/structured_data_extraction.mdx @@ -7,9 +7,9 @@ import CodeSource from "!raw-loader!../../../../../examples/jsonExtract"; # Structured data extraction tutorial -Make sure you have installed LlamaIndex.TS and have an OpenAI key. If you haven't, check out the [installation](installation) guide. +Make sure you have installed LlamaIndex.TS and have an OpenAI key. If you haven't, check out the [installation](../installation) guide. -You can use [other LLMs](../examples/other_llms) via their APIs; if you would prefer to use local models check out our [local LLM example](../../examples/local_llm). +You can use [other LLMs](../../examples/other_llms) via their APIs; if you would prefer to use local models check out our [local LLM example](../../examples/local_llm). ## Set up diff --git a/apps/docs/docs/modules/agent/index.md b/apps/docs/docs/modules/agent/index.md index 65a3f8cd4..1941d1f50 100644 --- a/apps/docs/docs/modules/agent/index.md +++ b/apps/docs/docs/modules/agent/index.md @@ -18,3 +18,9 @@ LlamaIndex.TS comes with a few built-in agents, but you can also create your own ## Examples - [OpenAI Agent](../../examples/agent.mdx) + +## Api References + +- [OpenAIAgent](../../api/classes/OpenAIAgent.md) +- [AnthropicAgent](../../api/classes/AnthropicAgent.md) +- [ReActAgent](../../api/classes/ReActAgent.md) diff --git a/apps/docs/docs/modules/documents_and_nodes/index.md b/apps/docs/docs/modules/documents_and_nodes/index.md index 607d683a2..d4a36ca6c 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/documents_and_nodes/metadata_extraction.md b/apps/docs/docs/modules/documents_and_nodes/metadata_extraction.md index 754b5ae3e..002fd69d3 100644 --- a/apps/docs/docs/modules/documents_and_nodes/metadata_extraction.md +++ b/apps/docs/docs/modules/documents_and_nodes/metadata_extraction.md @@ -43,3 +43,10 @@ async function main() { main().then(() => console.log("done")); ``` + +## API Reference + +- [SummaryExtractor](../../api/classes/SummaryExtractor.md) +- [QuestionsAnsweredExtractor](../../api/classes/QuestionsAnsweredExtractor.md) +- [TitleExtractor](../../api/classes/TitleExtractor.md) +- [KeywordExtractor](../../api/classes/KeywordExtractor.md) diff --git a/apps/docs/docs/modules/embeddings/available_embeddings/deepinfra.md b/apps/docs/docs/modules/embeddings/available_embeddings/deepinfra.md index 6f049ea86..b7fe8e580 100644 --- a/apps/docs/docs/modules/embeddings/available_embeddings/deepinfra.md +++ b/apps/docs/docs/modules/embeddings/available_embeddings/deepinfra.md @@ -77,3 +77,7 @@ main(); ``` For questions or feedback, please contact us at [feedback@deepinfra.com](mailto:feedback@deepinfra.com) + +## API Reference + +- [DeepInfraEmbedding](../../../api/classes/DeepInfraEmbedding.md) diff --git a/apps/docs/docs/modules/embeddings/available_embeddings/gemini.md b/apps/docs/docs/modules/embeddings/available_embeddings/gemini.md index 0ba461fcc..c9d431e24 100644 --- a/apps/docs/docs/modules/embeddings/available_embeddings/gemini.md +++ b/apps/docs/docs/modules/embeddings/available_embeddings/gemini.md @@ -31,3 +31,7 @@ Settings.embedModel = new GeminiEmbedding({ model: GEMINI_MODEL.GEMINI_PRO_LATEST, }); ``` + +## API Reference + +- [GeminiEmbedding](../../../api/classes/GeminiEmbedding.md) diff --git a/apps/docs/docs/modules/embeddings/available_embeddings/huggingface.md b/apps/docs/docs/modules/embeddings/available_embeddings/huggingface.md index 41c0a0b41..bd71151ef 100644 --- a/apps/docs/docs/modules/embeddings/available_embeddings/huggingface.md +++ b/apps/docs/docs/modules/embeddings/available_embeddings/huggingface.md @@ -32,3 +32,7 @@ Settings.embedModel = new HuggingFaceEmbedding({ quantized: false, }); ``` + +## API Reference + +- [HuggingFaceEmbedding](../../../api/classes/HuggingFaceEmbedding.md) diff --git a/apps/docs/docs/modules/embeddings/available_embeddings/jinaai.md b/apps/docs/docs/modules/embeddings/available_embeddings/jinaai.md index d6d52263e..bb497a7d7 100644 --- a/apps/docs/docs/modules/embeddings/available_embeddings/jinaai.md +++ b/apps/docs/docs/modules/embeddings/available_embeddings/jinaai.md @@ -19,3 +19,7 @@ const results = await queryEngine.query({ query, }); ``` + +## API Reference + +- [JinaAIEmbedding](../../../api/classes/JinaAIEmbedding.md) diff --git a/apps/docs/docs/modules/embeddings/available_embeddings/mistral.md b/apps/docs/docs/modules/embeddings/available_embeddings/mistral.md index a747482ed..7a5343b4c 100644 --- a/apps/docs/docs/modules/embeddings/available_embeddings/mistral.md +++ b/apps/docs/docs/modules/embeddings/available_embeddings/mistral.md @@ -22,3 +22,7 @@ const results = await queryEngine.query({ query, }); ``` + +## API Reference + +- [MistralAIEmbedding](../../../api/classes/MistralAIEmbedding.md) diff --git a/apps/docs/docs/modules/embeddings/available_embeddings/ollama.md b/apps/docs/docs/modules/embeddings/available_embeddings/ollama.md index b9c9122f7..38f45bf18 100644 --- a/apps/docs/docs/modules/embeddings/available_embeddings/ollama.md +++ b/apps/docs/docs/modules/embeddings/available_embeddings/ollama.md @@ -27,3 +27,7 @@ const results = await queryEngine.query({ query, }); ``` + +## API Reference + +- [OllamaEmbedding](../../../api/classes/OllamaEmbedding.md) diff --git a/apps/docs/docs/modules/embeddings/available_embeddings/openai.md b/apps/docs/docs/modules/embeddings/available_embeddings/openai.md index 7dae906dc..859c20fb7 100644 --- a/apps/docs/docs/modules/embeddings/available_embeddings/openai.md +++ b/apps/docs/docs/modules/embeddings/available_embeddings/openai.md @@ -19,3 +19,7 @@ const results = await queryEngine.query({ query, }); ``` + +## API Reference + +- [OpenAIEmbedding](../../../api/classes/OpenAIEmbedding.md) diff --git a/apps/docs/docs/modules/embeddings/available_embeddings/together.md b/apps/docs/docs/modules/embeddings/available_embeddings/together.md index 025ab40f7..b69180c6c 100644 --- a/apps/docs/docs/modules/embeddings/available_embeddings/together.md +++ b/apps/docs/docs/modules/embeddings/available_embeddings/together.md @@ -21,3 +21,7 @@ const results = await queryEngine.query({ query, }); ``` + +## API Reference + +- [TogetherEmbedding](../../../api/classes/TogetherEmbedding.md) diff --git a/apps/docs/docs/modules/evaluation/modules/correctness.md b/apps/docs/docs/modules/evaluation/modules/correctness.md index eec2361f0..621ce0c3f 100644 --- a/apps/docs/docs/modules/evaluation/modules/correctness.md +++ b/apps/docs/docs/modules/evaluation/modules/correctness.md @@ -56,3 +56,7 @@ console.log( ```bash the response is not correct with a score of 2.5 ``` + +## API Reference + +- [CorrectnessEvaluator](../../../api/classes/CorrectnessEvaluator.md) diff --git a/apps/docs/docs/modules/evaluation/modules/faithfulness.md b/apps/docs/docs/modules/evaluation/modules/faithfulness.md index 1dd229a42..e741d3d46 100644 --- a/apps/docs/docs/modules/evaluation/modules/faithfulness.md +++ b/apps/docs/docs/modules/evaluation/modules/faithfulness.md @@ -76,3 +76,7 @@ console.log(`the response is ${result.passing ? "faithful" : "not faithful"}`); ```bash the response is faithful ``` + +## API Reference + +- [FaithfulnessEvaluator](../../../api/classes/FaithfulnessEvaluator.md) diff --git a/apps/docs/docs/modules/evaluation/modules/relevancy.md b/apps/docs/docs/modules/evaluation/modules/relevancy.md index fcf70f6c4..5594f897d 100644 --- a/apps/docs/docs/modules/evaluation/modules/relevancy.md +++ b/apps/docs/docs/modules/evaluation/modules/relevancy.md @@ -70,3 +70,7 @@ console.log(`the response is ${result.passing ? "relevant" : "not relevant"}`); ```bash the response is relevant ``` + +## API Reference + +- [RelevancyEvaluator](../../../api/classes/RelevancyEvaluator.md) diff --git a/apps/docs/docs/modules/ingestion_pipeline/index.md b/apps/docs/docs/modules/ingestion_pipeline/index.md index 4de6ee5fb..adb4d8bf9 100644 --- a/apps/docs/docs/modules/ingestion_pipeline/index.md +++ b/apps/docs/docs/modules/ingestion_pipeline/index.md @@ -97,3 +97,7 @@ async function main() { main().catch(console.error); ``` + +## API Reference + +- [IngestionPipeline](../../api/classes/IngestionPipeline.md) diff --git a/apps/docs/docs/modules/ingestion_pipeline/transformations.md b/apps/docs/docs/modules/ingestion_pipeline/transformations.md index 6808b69e2..d1e82b743 100644 --- a/apps/docs/docs/modules/ingestion_pipeline/transformations.md +++ b/apps/docs/docs/modules/ingestion_pipeline/transformations.md @@ -4,9 +4,9 @@ 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 +- [Embeddings](../embeddings/index.md) ## Usage Pattern diff --git a/apps/docs/docs/modules/llms/available_llms/anthropic.md b/apps/docs/docs/modules/llms/available_llms/anthropic.md index 546a7228a..d94b1678e 100644 --- a/apps/docs/docs/modules/llms/available_llms/anthropic.md +++ b/apps/docs/docs/modules/llms/available_llms/anthropic.md @@ -63,3 +63,7 @@ async function main() { console.log(response.response); } ``` + +## API Reference + +- [Anthropic](../../../api/classes/Anthropic.md) diff --git a/apps/docs/docs/modules/llms/available_llms/azure.md b/apps/docs/docs/modules/llms/available_llms/azure.md index 733cc9cb8..6e2b764f4 100644 --- a/apps/docs/docs/modules/llms/available_llms/azure.md +++ b/apps/docs/docs/modules/llms/available_llms/azure.md @@ -74,3 +74,7 @@ async function main() { console.log(response.response); } ``` + +## API Reference + +- [OpenAI](../../../api/classes/OpenAI.md) diff --git a/apps/docs/docs/modules/llms/available_llms/deepinfra.md b/apps/docs/docs/modules/llms/available_llms/deepinfra.md index bef6625d8..93c6a7f21 100644 --- a/apps/docs/docs/modules/llms/available_llms/deepinfra.md +++ b/apps/docs/docs/modules/llms/available_llms/deepinfra.md @@ -81,3 +81,7 @@ async function main() { ## Feedback If you have any feedback, please reach out to us at [feedback@deepinfra.com](mailto:feedback@deepinfra.com) + +## API Reference + +- [DeepInfra](../../../api/classes/DeepInfra) diff --git a/apps/docs/docs/modules/llms/available_llms/fireworks.md b/apps/docs/docs/modules/llms/available_llms/fireworks.md index e8c54d73b..2852b3004 100644 --- a/apps/docs/docs/modules/llms/available_llms/fireworks.md +++ b/apps/docs/docs/modules/llms/available_llms/fireworks.md @@ -59,3 +59,7 @@ async function main() { main().catch(console.error); ``` + +## API Reference + +- [FireworksLLM](../../../api/classes/FireworksLLM.md) diff --git a/apps/docs/docs/modules/llms/available_llms/gemini.md b/apps/docs/docs/modules/llms/available_llms/gemini.md index bc04d46bd..eae778d96 100644 --- a/apps/docs/docs/modules/llms/available_llms/gemini.md +++ b/apps/docs/docs/modules/llms/available_llms/gemini.md @@ -99,3 +99,7 @@ async function main() { console.log(response.response); } ``` + +## API Reference + +- [Gemini](../../../api/classes/Gemini.md) diff --git a/apps/docs/docs/modules/llms/available_llms/groq.mdx b/apps/docs/docs/modules/llms/available_llms/groq.mdx index 127fbfdec..5eed4fbdb 100644 --- a/apps/docs/docs/modules/llms/available_llms/groq.mdx +++ b/apps/docs/docs/modules/llms/available_llms/groq.mdx @@ -50,3 +50,7 @@ const results = await queryEngine.query({ <CodeBlock language="ts" showLineNumbers> {CodeSource} </CodeBlock> + +## API Reference + +- [Groq](../../../api/classes/Groq.md) diff --git a/apps/docs/docs/modules/llms/available_llms/llama2.md b/apps/docs/docs/modules/llms/available_llms/llama2.md index 4e6204065..2aec0c559 100644 --- a/apps/docs/docs/modules/llms/available_llms/llama2.md +++ b/apps/docs/docs/modules/llms/available_llms/llama2.md @@ -89,3 +89,8 @@ async function main() { console.log(response.response); } ``` + +## API Reference + +- [LlamaDeuce](../../../api/variables/LlamaDeuce.md) +- [DeuceChatStrategy](../../../api/variables/DeuceChatStrategy.md) diff --git a/apps/docs/docs/modules/llms/available_llms/mistral.md b/apps/docs/docs/modules/llms/available_llms/mistral.md index be39dea29..6e6009e3e 100644 --- a/apps/docs/docs/modules/llms/available_llms/mistral.md +++ b/apps/docs/docs/modules/llms/available_llms/mistral.md @@ -66,3 +66,7 @@ async function main() { console.log(response.response); } ``` + +## API Reference + +- [MistralAI](../../../api/classes/MistralAI.md) diff --git a/apps/docs/docs/modules/llms/available_llms/ollama.md b/apps/docs/docs/modules/llms/available_llms/ollama.md index 602b0f2ac..390a14970 100644 --- a/apps/docs/docs/modules/llms/available_llms/ollama.md +++ b/apps/docs/docs/modules/llms/available_llms/ollama.md @@ -71,3 +71,7 @@ async function main() { console.log(response.response); } ``` + +## API Reference + +- [Ollama](../../../api/classes/Ollama.md) diff --git a/apps/docs/docs/modules/llms/available_llms/openai.md b/apps/docs/docs/modules/llms/available_llms/openai.md index 1b2faf43e..964ab4287 100644 --- a/apps/docs/docs/modules/llms/available_llms/openai.md +++ b/apps/docs/docs/modules/llms/available_llms/openai.md @@ -67,3 +67,7 @@ async function main() { console.log(response.response); } ``` + +## API Reference + +- [OpenAI](../../../api/classes/OpenAI.md) diff --git a/apps/docs/docs/modules/llms/available_llms/portkey.md b/apps/docs/docs/modules/llms/available_llms/portkey.md index 1d5915e31..bc05bed0c 100644 --- a/apps/docs/docs/modules/llms/available_llms/portkey.md +++ b/apps/docs/docs/modules/llms/available_llms/portkey.md @@ -68,3 +68,7 @@ async function main() { console.log(response.response); } ``` + +## API Reference + +- [Portkey](../../../api/classes/Portkey.md) diff --git a/apps/docs/docs/modules/llms/available_llms/together.md b/apps/docs/docs/modules/llms/available_llms/together.md index 3a0521551..f3797a3bf 100644 --- a/apps/docs/docs/modules/llms/available_llms/together.md +++ b/apps/docs/docs/modules/llms/available_llms/together.md @@ -66,3 +66,7 @@ async function main() { console.log(response.response); } ``` + +## API Reference + +- [TogetherLLM](../../../api/classes/TogetherLLM.md) diff --git a/apps/docs/docs/modules/llms/index.md b/apps/docs/docs/modules/llms/index.md index cb0867cbf..525863f77 100644 --- a/apps/docs/docs/modules/llms/index.md +++ b/apps/docs/docs/modules/llms/index.md @@ -32,4 +32,4 @@ For local LLMs, currently we recommend the use of [Ollama](./available_llms/olla ## API Reference -- [OpenAI](../api/classes/OpenAI.md) +- [OpenAI](../../api/classes/OpenAI.md) diff --git a/apps/docs/docs/modules/node_parser.md b/apps/docs/docs/modules/node_parser.md index f7d18f8b7..68a024903 100644 --- a/apps/docs/docs/modules/node_parser.md +++ b/apps/docs/docs/modules/node_parser.md @@ -95,3 +95,4 @@ The output metadata will be something like: - [SimpleNodeParser](../api/classes/SimpleNodeParser.md) - [SentenceSplitter](../api/classes/SentenceSplitter.md) +- [MarkdownNodeParser](../api/classes/MarkdownNodeParser.md) diff --git a/apps/docs/docs/modules/node_postprocessors/cohere_reranker.md b/apps/docs/docs/modules/node_postprocessors/cohere_reranker.md index 9b312e8e6..a2405bd2d 100644 --- a/apps/docs/docs/modules/node_postprocessors/cohere_reranker.md +++ b/apps/docs/docs/modules/node_postprocessors/cohere_reranker.md @@ -65,3 +65,7 @@ const queryEngine = index.asQueryEngine({ // log the response const response = await queryEngine.query("Where did the author grown up?"); ``` + +## API Reference + +- [CohereRerank](../../api/classes/CohereRerank.md) diff --git a/apps/docs/docs/modules/node_postprocessors/index.md b/apps/docs/docs/modules/node_postprocessors/index.md index 92c3b085f..b1ecd446f 100644 --- a/apps/docs/docs/modules/node_postprocessors/index.md +++ b/apps/docs/docs/modules/node_postprocessors/index.md @@ -103,3 +103,7 @@ const processor = new SimilarityPostprocessor({ const filteredNodes = processor.postprocessNodes(nodes); ``` + +## API Reference + +- [SimilarityPostprocessor](../../api/classes/SimilarityPostprocessor.md) diff --git a/apps/docs/docs/modules/node_postprocessors/jinaai_reranker.md b/apps/docs/docs/modules/node_postprocessors/jinaai_reranker.md index 902c77b76..bf897b970 100644 --- a/apps/docs/docs/modules/node_postprocessors/jinaai_reranker.md +++ b/apps/docs/docs/modules/node_postprocessors/jinaai_reranker.md @@ -69,3 +69,7 @@ const queryEngine = index.asQueryEngine({ // log the response const response = await queryEngine.query("Where did the author grown up?"); ``` + +## API Reference + +- [JinaAIReranker](../../api/classes/JinaAIReranker.md) diff --git a/apps/docs/docs/modules/prompt/index.md b/apps/docs/docs/modules/prompt/index.md index 2644a8a4d..6506eb578 100644 --- a/apps/docs/docs/modules/prompt/index.md +++ b/apps/docs/docs/modules/prompt/index.md @@ -70,3 +70,9 @@ const response = await queryEngine.query({ query: "What did the author do in college?", }); ``` + +## API Reference + +- [TextQaPrompt](../../api/type-aliases/TextQaPrompt.md) +- [ResponseSynthesizer](../../api/classes/ResponseSynthesizer.md) +- [CompactAndRefine](../../api/classes/CompactAndRefine.md) diff --git a/apps/docs/docs/modules/query_engines/index.md b/apps/docs/docs/modules/query_engines/index.md index 83d6e875b..acc5b81fc 100644 --- a/apps/docs/docs/modules/query_engines/index.md +++ b/apps/docs/docs/modules/query_engines/index.md @@ -38,4 +38,4 @@ You can learn more about Tools by taking a look at the LlamaIndex Python documen - [RetrieverQueryEngine](../../api/classes/RetrieverQueryEngine.md) - [SubQuestionQueryEngine](../../api/classes/SubQuestionQueryEngine.md) -- [QueryEngineTool](../../api/interfaces/QueryEngineTool.md) +- [QueryEngineTool](../../api/classes/QueryEngineTool.md) diff --git a/apps/docs/docs/modules/query_engines/metadata_filtering.md b/apps/docs/docs/modules/query_engines/metadata_filtering.md index 2ae3ac83a..04b9d7c6c 100644 --- a/apps/docs/docs/modules/query_engines/metadata_filtering.md +++ b/apps/docs/docs/modules/query_engines/metadata_filtering.md @@ -151,3 +151,8 @@ async function main() { main(); ``` + +## API Reference + +- [VectorStoreIndex](../../api/classes/VectorStoreIndex.md) +- [ChromaVectorStore](../../api/classes/ChromaVectorStore.md) diff --git a/apps/docs/docs/modules/query_engines/router_query_engine.md b/apps/docs/docs/modules/query_engines/router_query_engine.md index f8147f2cf..be7c46e67 100644 --- a/apps/docs/docs/modules/query_engines/router_query_engine.md +++ b/apps/docs/docs/modules/query_engines/router_query_engine.md @@ -165,3 +165,7 @@ async function main() { main().then(() => console.log("Done")); ``` + +## API Reference + +- [RouterQueryEngine](../../api/classes/RouterQueryEngine.md) diff --git a/apps/docs/docs/modules/storage.md b/apps/docs/docs/modules/storage.md index 3844e8729..bec0cf65a 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) diff --git a/apps/docs/docs/modules/vector_stores/qdrant.md b/apps/docs/docs/modules/vector_stores/qdrant.md index 438dc1209..2dddb536f 100644 --- a/apps/docs/docs/modules/vector_stores/qdrant.md +++ b/apps/docs/docs/modules/vector_stores/qdrant.md @@ -84,3 +84,7 @@ async function main() { main().catch(console.error); ``` + +## API Reference + +- [QdrantVectorStore](../../api/classes/QdrantVectorStore.md) -- GitLab