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 a618c83e00357bb4ceffac9b30ed650017550ebc..a6d7e67cbba5f826ae99f78adc319154c4db24d5 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 66f2fa2640819a931bf4fd2f153e9a4c3cb2703a..49ff74d7597b068c4c55c9b9d8acdc4cbffb1fd8 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 65a3f8cd4502d0320f10055e15a27d9a0ce111cb..1941d1f5061e8ab07e638e0ac6b3f8084c080b98 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 607d683a2e8ed99df98f4b33559fca65c6c97629..d4a36ca6c28a947de076edf59ae74423ae47ff0b 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 754b5ae3e66b6d96d0b81a363a426c66c3ed207a..002fd69d3e31f8bb47197d277914b4c05766493a 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 6f049ea864f319d2ef1ca5485db2bc2d4cc2e554..b7fe8e580dbf8ccee230aba936ede8d8fb6f1bae 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 0ba461fcc5a54a65ed68efec3fde6c452b59bbf8..c9d431e24f04b7593f2cdeef530ed5d7bee30143 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 41c0a0b41ec65b5b469880d6552c7e2cf23f6047..bd71151ef08c4449497925d14d3fec2a2d5bbb24 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 d6d52263ef5f579d4d5637877a5861e101e1cf9b..bb497a7d76962c1e28e26eb01b57541e5e6d3500 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 a747482ed99423ac74bdf9574aa0cf30f329d20d..7a5343b4c70310e40cf4f2b24ae8612fc85e19d8 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 b9c9122f7c534292a0c618c41c4eaa6dab525edb..38f45bf189d0b1852f0a3882863b4983409452e1 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 7dae906dc1267f4f7889b2a87fcdb82a60b9b7d3..859c20fb701249726ae29606f6b184428f9992c1 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 025ab40f719ceff1ec1bdfbb1408ab155e53b075..b69180c6cf6f79ff52a14b174742cac947e813c9 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 eec2361f0a67eebf5279c9bed79411eb6e65c199..621ce0c3f9b39eeadbc0a159e9628fb4b90e487c 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 1dd229a42e3cec8c75398a51e9fe494158e1f5a7..e741d3d460416e638368f80c36f23a5f5ea95682 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 fcf70f6c4bd363179cbaaf14af759f541e17a226..5594f897db7673f0060f1e410444027565e23912 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 4de6ee5fba687d281c129aab49c10ab2356511ae..adb4d8bf93328f150bbb80184b2b80263e3e9007 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 6808b69e2e1caafb1270140325964677969ade1b..d1e82b7430e6ce2bad5faa103fbc51fda7f92dac 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 546a7228a25ab09c747ad403693ebba7787d8a71..d94b1678e46c2ba4dc962d9b9b18f100660cb67a 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 733cc9cb810349db4163043d4587393bc2d3d62f..6e2b764f4238d2f0111eeeb40b672234379086a7 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 bef6625d88833844cb9ed96ea9ab0aa90a5ae7f3..93c6a7f218b5e858a74cce6d3ec527525acf53d4 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 e8c54d73b97d764e6b69889b76d2c1301cc1a151..2852b3004fc858d28688fc718c4c84471c84dac1 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 bc04d46bdd1bcac593d13cb0ce3d7644de767132..eae778d96ddde52dc1db34b599cc3b27ea1a4106 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 127fbfdec87c9752963627592c13bdd138d67c99..5eed4fbdb5bfc1750c319b3caf59ba90f04468e7 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 4e62040651be59137e9dc7c7a7166f9e241ea857..2aec0c559d7c4c7552aae2946522ff88c53d8d3e 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 be39dea2992c6be1972cf5d8491dc65230b73319..6e6009e3e4f8d15560f83be2d9c49fd34432c9da 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 602b0f2ac8d71e717eedaa5b4557e99089666d6c..390a14970628ed116e07c4f6a8ebf2e6cb69c0f2 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 1b2faf43e6ebf246a906b6b5b326475e8821ba5a..964ab4287e262c24a90577773b2531b5332cf4ba 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 1d5915e318d5c322b85b309d0c56192aca189460..bc05bed0cdb8170d5cdaa741f6fdca8fa54abcf7 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 3a05215511bdfe79f8057456c18e0e943ab518a1..f3797a3bf81c090966ad3a8318bcf10ce6f5a60b 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 cb0867cbf9902671b0896d85ad951e8a4df59d6b..525863f7740800993c6250274187d75dae7ddcd5 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 f7d18f8b7d81e9bcf251bf74653d9976ac50fe05..68a024903efc33b72e0eac5308f15ede8b9216d3 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 9b312e8e6525848a0f642d9417bcb38df4b65dca..a2405bd2dadfc50132be75ffd546b12ebac9f036 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 92c3b085f7b6fb94c122b4f26988ca63286780eb..b1ecd446fe59721e5d93ba20a0923f4e969896af 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 902c77b761a50c8b1fa22a88193dd09911b2a7dd..bf897b9707dd50ee104577a11e52b9c0015a8f56 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 2644a8a4d9b9a592bead7c0ade7812a1c0b9c86a..6506eb578fbabbae486d047210b0ef874b03528f 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 83d6e875bf3b7c4253f854d090e045f2f87d8eb9..acc5b81fcd31ccff18109dbdffa889a7fc5e20e4 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 2ae3ac83a1f4c125ef856d2ef41d3ecfba8e5932..04b9d7c6c4804be48ed04ab44ec1736e52f3dde1 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 f8147f2cf621b6b4df4ab944a9090b70a8b257ea..be7c46e67378e25b17e1e62897a92793f285d64b 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 3844e8729e33c9afa0f560b849bcb8c0119dcca7..bec0cf65a3aaeaba0cb3e8b038e5defb3e46466e 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 438dc1209bdfaf27142606813f3941aad1b0ac79..2dddb536f5edcaf9f02a5992c9302ec6ea14fc74 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)