From 21014cab452a486e4e9ca3e9c6a38ec120ff4679 Mon Sep 17 00:00:00 2001 From: Rithik Kumar <46047011+rithikJha@users.noreply.github.com> Date: Sat, 17 Aug 2024 12:35:33 +0530 Subject: [PATCH] docs: add chatbot example and improve quality of other examples (#1544) --- docs/mkdocs.yml | 6 ++- .../python_examples/build_from_scratch.md | 6 +-- docs/src/examples/python_examples/chatbot.md | 41 +++++++++++++++++++ .../examples/python_examples/multimodal.md | 4 +- docs/src/examples/python_examples/rag.md | 4 +- .../examples/python_examples/vector_search.md | 8 ++-- 6 files changed, 57 insertions(+), 12 deletions(-) create mode 100644 docs/src/examples/python_examples/chatbot.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index bae287f4..024181fd 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -146,7 +146,8 @@ nav: - Multimodal: examples/python_examples/multimodal.md - Rag: examples/python_examples/rag.md - Vector Search: examples/python_examples/vector_search.md - - Miscellaneous: + - Chatbot: examples/python_examples/chatbot.md + - Miscellaneous: - YouTube Transcript Search: notebooks/youtube_transcript_search.ipynb - Documentation QA Bot using LangChain: notebooks/code_qa_bot.ipynb - Multimodal search using CLIP: notebooks/multimodal_search.ipynb @@ -233,7 +234,8 @@ nav: - Multimodal: examples/python_examples/multimodal.md - Rag: examples/python_examples/rag.md - Vector Search: examples/python_examples/vector_search.md - - Miscellaneous: + - Chatbot: examples/python_examples/chatbot.md + - Miscellaneous: - YouTube Transcript Search: notebooks/youtube_transcript_search.ipynb - Documentation QA Bot using LangChain: notebooks/code_qa_bot.ipynb - Multimodal search using CLIP: notebooks/multimodal_search.ipynb diff --git a/docs/src/examples/python_examples/build_from_scratch.md b/docs/src/examples/python_examples/build_from_scratch.md index f7469726..65e21af4 100644 --- a/docs/src/examples/python_examples/build_from_scratch.md +++ b/docs/src/examples/python_examples/build_from_scratch.md @@ -1,8 +1,8 @@ -# Build from Scratch with LanceDB πŸš€ +# **Build from Scratch with LanceDB πŸ› οΈπŸš€** -Start building your GenAI applications from the ground up using LanceDB's efficient vector-based document retrieval capabilities! πŸ“„ +Start building your GenAI applications from the ground up using LanceDB's efficient vector-based document retrieval capabilities! πŸ“‘ -#### Get Started in Minutes ⏱️ +**Get Started in Minutes ⏱️** These examples provide a solid foundation for building your own GenAI applications using LanceDB. Jump from idea to proof of concept quickly with applied examples. Get started and see what you can create! πŸ’» diff --git a/docs/src/examples/python_examples/chatbot.md b/docs/src/examples/python_examples/chatbot.md new file mode 100644 index 00000000..a16848a6 --- /dev/null +++ b/docs/src/examples/python_examples/chatbot.md @@ -0,0 +1,41 @@ +**Chatbot Application with LanceDB πŸ€–** +==================================================================== + + Create an innovative chatbot application that utilizes LanceDB for efficient vector-based response generation! 🌐✨ + +**Introduction πŸ‘‹βœ¨** + + Users can input their queries, allowing the chatbot to retrieve relevant context seamlessly. πŸ”πŸ“š This enables the generation of coherent and context-aware replies that enhance user experience. 🌟🀝 Dive into the world of advanced conversational AI and streamline interactions with powerful data management! πŸš€πŸ’‘ + + +| **Chatbot** | **Description** | **Links** | +|:----------------|:-----------------|:-----------| +| **Databricks DBRX Website Bot ⚑️** | Unlock magical conversations with the Hogwarts chatbot, powered by Open-source RAG, DBRX, LanceDB, LLama-index, and Hugging Face Embeddings, delivering enchanting user experiences and spellbinding interactions ✨ | [![GitHub](../../assets/github.svg)][databricks_github]
[![Python](../../assets/python.svg)][databricks_python] | +| **CLI SDK Manual Chatbot Locally πŸ’»** | CLI chatbot for SDK/hardware documents, powered by Local RAG, LLama3, Ollama, LanceDB, and Openhermes Embeddings, built with Phidata Assistant and Knowledge Base for instant technical support πŸ€– | [![GitHub](../../assets/github.svg)][clisdk_github]
[![Python](../../assets/python.svg)][clisdk_python] | +| **Youtube Transcript Search QA Bot πŸ“Ή** | Unlock the power of YouTube transcripts with a Q&A bot, leveraging natural language search and LanceDB for effortless data management and instant answers πŸ’¬ | [![GitHub](../../assets/github.svg)][youtube_github]
[![Open In Collab](../../assets/colab.svg)][youtube_colab]
[![Python](../../assets/python.svg)][youtube_python] | +| **Code Documentation Q&A Bot with LangChain πŸ€–** | Revolutionize code documentation with a Q&A bot, powered by LangChain and LanceDB, allowing effortless querying of documentation using natural language, demonstrated with Numpy 1.26 docs πŸ“š | [![GitHub](../../assets/github.svg)][docs_github]
[![Open In Collab](../../assets/colab.svg)][docs_colab]
[![Python](../../assets/python.svg)][docs_python] | +| **Context-aware Chatbot using Llama 2 & LanceDB πŸ€–** | Experience the future of conversational AI with a context-aware chatbot, powered by Llama 2, LanceDB, and LangChain, enabling intuitive and meaningful conversations with your data πŸ“šπŸ’¬ | [![GitHub](../../assets/github.svg)][aware_github]
[![Open In Collab](../../assets/colab.svg)][aware_colab]
[![Ghost](../../assets/ghost.svg)][aware_ghost] | +| **Chat with csv using Hybrid Search πŸ“Š** | Revolutionize data interaction with a chat application that harnesses LanceDB's hybrid search capabilities to converse with CSV and Excel files, enabling efficient and scalable data exploration and analysis πŸš€ | [![GitHub](../../assets/github.svg)][csv_github]
[![Open In Collab](../../assets/colab.svg)][csv_colab]
[![Ghost](../../assets/ghost.svg)][csv_ghost] | + + +[databricks_github]: https://github.com/lancedb/vectordb-recipes/blob/main/examples/databricks_DBRX_website_bot +[databricks_python]: https://github.com/lancedb/vectordb-recipes/blob/main/examples/databricks_DBRX_website_bot/main.py + +[clisdk_github]: https://github.com/lancedb/vectordb-recipes/blob/main/examples/CLI-SDK-Manual-Chatbot-Locally +[clisdk_python]: https://github.com/lancedb/vectordb-recipes/blob/main/examples/CLI-SDK-Manual-Chatbot-Locally/assistant.py + +[youtube_github]: https://github.com/lancedb/vectordb-recipes/blob/main/examples/Youtube-Search-QA-Bot +[youtube_colab]: https://colab.research.google.com/github/lancedb/vectordb-recipes/blob/main/examples/Youtube-Search-QA-Bot/main.ipynb +[youtube_python]: https://github.com/lancedb/vectordb-recipes/blob/main/examples/Youtube-Search-QA-Bot/main.py + +[docs_github]: https://github.com/lancedb/vectordb-recipes/blob/main/examples/Code-Documentation-QA-Bot +[docs_colab]: https://colab.research.google.com/github/lancedb/vectordb-recipes/blob/main/examples/Code-Documentation-QA-Bot/main.ipynb +[docs_python]: https://github.com/lancedb/vectordb-recipes/blob/main/examples/Code-Documentation-QA-Bot/main.py + +[aware_github]: https://github.com/lancedb/vectordb-recipes/blob/main/tutorials/chatbot_using_Llama2_&_lanceDB +[aware_colab]: https://colab.research.google.com/github/lancedb/vectordb-recipes/blob/main/tutorials/chatbot_using_Llama2_&_lanceDB/main.ipynb +[aware_ghost]: https://blog.lancedb.com/context-aware-chatbot-using-llama-2-lancedb-as-vector-database-4d771d95c755 + +[csv_github]: https://github.com/lancedb/vectordb-recipes/blob/main/tutorials/Chat_with_csv_file +[csv_colab]: https://colab.research.google.com/github/lancedb/vectordb-recipes/blob/main/tutorials/Chat_with_csv_file/main.ipynb +[csv_ghost]: https://blog.lancedb.com/p/d8c71df4-e55f-479a-819e-cde13354a6a3/ diff --git a/docs/src/examples/python_examples/multimodal.md b/docs/src/examples/python_examples/multimodal.md index 2409fb2f..376d7864 100644 --- a/docs/src/examples/python_examples/multimodal.md +++ b/docs/src/examples/python_examples/multimodal.md @@ -1,8 +1,8 @@ -# Multimodal Search with LanceDB πŸ”πŸ’‘ +# **Multimodal Search with LanceDB πŸ€Ήβ€β™‚οΈπŸ”** Experience the future of search with LanceDB's multimodal capabilities. Combine text and image queries to find the most relevant results in your corpus and unlock new possibilities! πŸ”“πŸ’‘ -#### Explore the Future of Search πŸš€ +**Explore the Future of Search πŸš€** Unlock the power of multimodal search with LanceDB, enabling efficient vector-based retrieval of text and image data! πŸ“ŠπŸ’» diff --git a/docs/src/examples/python_examples/rag.md b/docs/src/examples/python_examples/rag.md index c2c41d0c..02339515 100644 --- a/docs/src/examples/python_examples/rag.md +++ b/docs/src/examples/python_examples/rag.md @@ -1,10 +1,10 @@ -**πŸ”πŸ’‘ RAG: Revolutionize Information Retrieval with LanceDB πŸ”“** +**RAG: Revolutionize Information Retrieval with LanceDB πŸ”“πŸ§** ==================================================================== Unlock the full potential of Retrieval-Augmented Generation (RAG) with LanceDB, the ultimate solution for efficient vector-based information retrieval πŸ“Š. Input text queries and retrieve relevant documents with lightning-fast speed ⚑️ and accuracy βœ…. Generate comprehensive answers by combining retrieved information, uncovering new insights πŸ” and connections. -### Experience the Future of Search πŸ”„ +**Experience the Future of Search πŸ”„** Experience the future of search with RAG, transforming information retrieval and answer generation. Apply RAG to various industries, streamlining processes πŸ“ˆ, saving time ⏰, and resources πŸ’°. Stay ahead of the curve with innovative technology πŸ”, powered by LanceDB. Discover the power of RAG with LanceDB and transform your industry with innovative solutions πŸ’‘. diff --git a/docs/src/examples/python_examples/vector_search.md b/docs/src/examples/python_examples/vector_search.md index 67000d39..a7b91a16 100644 --- a/docs/src/examples/python_examples/vector_search.md +++ b/docs/src/examples/python_examples/vector_search.md @@ -1,10 +1,12 @@ -**πŸ” Vector Search: Unlock Efficient Document Retrieval πŸ”“** +**Vector Search: Unlock Efficient Document Retrieval πŸ”“πŸ‘€** ==================================================================== -**Introduction** - Unlock the power of vector search with LanceDB, a cutting-edge solution for efficient vector-based document retrieval πŸ“Š. Input text queries to find the most relevant documents from your corpus, and discover a new world of possibilities with our inbuilt hybrid search features 🌐. +**Unlock the Future of SearchπŸ”** + +Experience the transformative power of vector search with LanceDB. Discover, analyze, and retrieve documents with unprecedented efficiency and accuracy. πŸ’‘ + | **Vector Search** | **Description** | **Links** | |:-----------------|:---------------|:---------| | **Inbuilt Hybrid Search πŸ”„** | Combine the power of traditional search algorithms with LanceDB's vector-based search for a robust and efficient search experience πŸ“Š | [![Github](../../assets/github.svg)][inbuilt_hybrid_search_github]
[![Open In Collab](../../assets/colab.svg)][inbuilt_hybrid_search_colab] |