From d0e95971f533268a155914a2562cf7461f7ed47f Mon Sep 17 00:00:00 2001 From: hsm207 Date: Tue, 10 Dec 2024 06:00:07 +0100 Subject: [PATCH] langchain-weaviate: Remove outdated docs (#28058) Thank you for contributing to LangChain! - [x] **PR title**: "package: description" - Where "package" is whichever of langchain, community, core, etc. is being modified. Use "docs: ..." for purely docs changes, "infra: ..." for CI changes. - Example: "community: add foobar LLM" Docs on how to do hybrid search with weaviate is covered [here](https://python.langchain.com/docs/integrations/vectorstores/weaviate/) @efriis --------- Co-authored-by: pookam90 Co-authored-by: Pooja Kamath <60406274+Pookam90@users.noreply.github.com> Co-authored-by: Erick Friis --- .../retrievers/weaviate-hybrid.ipynb | 297 ------------------ docs/vercel.json | 4 + 2 files changed, 4 insertions(+), 297 deletions(-) delete mode 100644 docs/docs/integrations/retrievers/weaviate-hybrid.ipynb diff --git a/docs/docs/integrations/retrievers/weaviate-hybrid.ipynb b/docs/docs/integrations/retrievers/weaviate-hybrid.ipynb deleted file mode 100644 index 9592435b918..00000000000 --- a/docs/docs/integrations/retrievers/weaviate-hybrid.ipynb +++ /dev/null @@ -1,297 +0,0 @@ -{ - "cells": [ - { - "cell_type": "markdown", - "id": "ce0f17b9", - "metadata": {}, - "source": [ - "# Weaviate Hybrid Search\n", - "\n", - ">[Weaviate](https://weaviate.io/developers/weaviate) is an open-source vector database.\n", - "\n", - ">[Hybrid search](https://weaviate.io/blog/hybrid-search-explained) is a technique that combines multiple search algorithms to improve the accuracy and relevance of search results. It uses the best features of both keyword-based search algorithms with vector search techniques.\n", - "\n", - ">The `Hybrid search in Weaviate` uses sparse and dense vectors to represent the meaning and context of search queries and documents.\n", - "\n", - "This notebook shows how to use `Weaviate hybrid search` as a LangChain retriever." - ] - }, - { - "attachments": {}, - "cell_type": "markdown", - "id": "c307b082", - "metadata": {}, - "source": [ - "Set up the retriever:" - ] - }, - { - "cell_type": "code", - "execution_count": 1, - "id": "bba863a2-977c-4add-b5f4-bfc33a80eae5", - "metadata": { - "tags": [] - }, - "outputs": [], - "source": [ - "%pip install --upgrade --quiet weaviate-client" - ] - }, - { - "cell_type": "code", - "execution_count": 2, - "id": "c10dd962", - "metadata": {}, - "outputs": [], - "source": [ - "import os\n", - "\n", - "import weaviate\n", - "\n", - "WEAVIATE_URL = os.getenv(\"WEAVIATE_URL\")\n", - "auth_client_secret = (weaviate.AuthApiKey(api_key=os.getenv(\"WEAVIATE_API_KEY\")),)\n", - "client = weaviate.Client(\n", - " url=WEAVIATE_URL,\n", - " additional_headers={\n", - " \"X-Openai-Api-Key\": os.getenv(\"OPENAI_API_KEY\"),\n", - " },\n", - ")\n", - "\n", - "# client.schema.delete_all()" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "f47a2bfe", - "metadata": {}, - "outputs": [], - "source": [ - "from langchain_community.retrievers import (\n", - " WeaviateHybridSearchRetriever,\n", - ")\n", - "from langchain_core.documents import Document" - ] - }, - { - "cell_type": "code", - "execution_count": 4, - "id": "f2eff08e", - "metadata": {}, - "outputs": [], - "source": [ - "retriever = WeaviateHybridSearchRetriever(\n", - " client=client,\n", - " index_name=\"LangChain\",\n", - " text_key=\"text\",\n", - " attributes=[],\n", - " create_schema_if_missing=True,\n", - ")" - ] - }, - { - "attachments": {}, - "cell_type": "markdown", - "id": "b68debff", - "metadata": {}, - "source": [ - "Add some data:" - ] - }, - { - "cell_type": "code", - "execution_count": 5, - "id": "cd8a7b17", - "metadata": {}, - "outputs": [], - "source": [ - "docs = [\n", - " Document(\n", - " metadata={\n", - " \"title\": \"Embracing The Future: AI Unveiled\",\n", - " \"author\": \"Dr. Rebecca Simmons\",\n", - " },\n", - " page_content=\"A comprehensive analysis of the evolution of artificial intelligence, from its inception to its future prospects. Dr. Simmons covers ethical considerations, potentials, and threats posed by AI.\",\n", - " ),\n", - " Document(\n", - " metadata={\n", - " \"title\": \"Symbiosis: Harmonizing Humans and AI\",\n", - " \"author\": \"Prof. Jonathan K. Sterling\",\n", - " },\n", - " page_content=\"Prof. Sterling explores the potential for harmonious coexistence between humans and artificial intelligence. The book discusses how AI can be integrated into society in a beneficial and non-disruptive manner.\",\n", - " ),\n", - " Document(\n", - " metadata={\"title\": \"AI: The Ethical Quandary\", \"author\": \"Dr. Rebecca Simmons\"},\n", - " page_content=\"In her second book, Dr. Simmons delves deeper into the ethical considerations surrounding AI development and deployment. It is an eye-opening examination of the dilemmas faced by developers, policymakers, and society at large.\",\n", - " ),\n", - " Document(\n", - " metadata={\n", - " \"title\": \"Conscious Constructs: The Search for AI Sentience\",\n", - " \"author\": \"Dr. Samuel Cortez\",\n", - " },\n", - " page_content=\"Dr. Cortez takes readers on a journey exploring the controversial topic of AI consciousness. The book provides compelling arguments for and against the possibility of true AI sentience.\",\n", - " ),\n", - " Document(\n", - " metadata={\n", - " \"title\": \"Invisible Routines: Hidden AI in Everyday Life\",\n", - " \"author\": \"Prof. Jonathan K. Sterling\",\n", - " },\n", - " page_content=\"In his follow-up to 'Symbiosis', Prof. Sterling takes a look at the subtle, unnoticed presence and influence of AI in our everyday lives. It reveals how AI has become woven into our routines, often without our explicit realization.\",\n", - " ),\n", - "]" - ] - }, - { - "cell_type": "code", - "execution_count": 6, - "id": "3c5970db", - "metadata": {}, - "outputs": [ - { - "data": { - "text/plain": [ - "['3a27b0a5-8dbb-4fee-9eba-8b6bc2c252be',\n", - " 'eeb9fd9b-a3ac-4d60-a55b-a63a25d3b907',\n", - " '7ebbdae7-1061-445f-a046-1989f2343d8f',\n", - " 'c2ab315b-3cab-467f-b23a-b26ed186318d',\n", - " 'b83765f2-e5d2-471f-8c02-c3350ade4c4f']" - ] - }, - "execution_count": 6, - "metadata": {}, - "output_type": "execute_result" - } - ], - "source": [ - "retriever.add_documents(docs)" - ] - }, - { - "attachments": {}, - "cell_type": "markdown", - "id": "6e030694", - "metadata": {}, - "source": [ - "Do a hybrid search:" - ] - }, - { - "cell_type": "code", - "execution_count": 7, - "id": "bf7dbb98", - "metadata": {}, - "outputs": [ - { - "data": { - "text/plain": [ - "[Document(page_content='In her second book, Dr. Simmons delves deeper into the ethical considerations surrounding AI development and deployment. It is an eye-opening examination of the dilemmas faced by developers, policymakers, and society at large.', metadata={}),\n", - " Document(page_content='A comprehensive analysis of the evolution of artificial intelligence, from its inception to its future prospects. Dr. Simmons covers ethical considerations, potentials, and threats posed by AI.', metadata={}),\n", - " Document(page_content=\"In his follow-up to 'Symbiosis', Prof. Sterling takes a look at the subtle, unnoticed presence and influence of AI in our everyday lives. It reveals how AI has become woven into our routines, often without our explicit realization.\", metadata={}),\n", - " Document(page_content='Prof. Sterling explores the potential for harmonious coexistence between humans and artificial intelligence. The book discusses how AI can be integrated into society in a beneficial and non-disruptive manner.', metadata={})]" - ] - }, - "execution_count": 7, - "metadata": {}, - "output_type": "execute_result" - } - ], - "source": [ - "retriever.invoke(\"the ethical implications of AI\")" - ] - }, - { - "attachments": {}, - "cell_type": "markdown", - "id": "d0c5bb4d", - "metadata": {}, - "source": [ - "Do a hybrid search with where filter:" - ] - }, - { - "cell_type": "code", - "execution_count": 8, - "id": "b2bc87c1", - "metadata": {}, - "outputs": [ - { - "data": { - "text/plain": [ - "[Document(page_content='Prof. Sterling explores the potential for harmonious coexistence between humans and artificial intelligence. The book discusses how AI can be integrated into society in a beneficial and non-disruptive manner.', metadata={}),\n", - " Document(page_content=\"In his follow-up to 'Symbiosis', Prof. Sterling takes a look at the subtle, unnoticed presence and influence of AI in our everyday lives. It reveals how AI has become woven into our routines, often without our explicit realization.\", metadata={})]" - ] - }, - "execution_count": 8, - "metadata": {}, - "output_type": "execute_result" - } - ], - "source": [ - "retriever.invoke(\n", - " \"AI integration in society\",\n", - " where_filter={\n", - " \"path\": [\"author\"],\n", - " \"operator\": \"Equal\",\n", - " \"valueString\": \"Prof. Jonathan K. Sterling\",\n", - " },\n", - ")" - ] - }, - { - "cell_type": "markdown", - "id": "5ae2899e", - "metadata": {}, - "source": [ - "Do a hybrid search with scores:" - ] - }, - { - "cell_type": "code", - "execution_count": 9, - "id": "4fffd0af", - "metadata": {}, - "outputs": [ - { - "data": { - "text/plain": [ - "[Document(page_content='Prof. Sterling explores the potential for harmonious coexistence between humans and artificial intelligence. The book discusses how AI can be integrated into society in a beneficial and non-disruptive manner.', metadata={'_additional': {'explainScore': '(bm25)\\n(hybrid) Document eeb9fd9b-a3ac-4d60-a55b-a63a25d3b907 contributed 0.00819672131147541 to the score\\n(hybrid) Document eeb9fd9b-a3ac-4d60-a55b-a63a25d3b907 contributed 0.00819672131147541 to the score', 'score': '0.016393442'}}),\n", - " Document(page_content=\"In his follow-up to 'Symbiosis', Prof. Sterling takes a look at the subtle, unnoticed presence and influence of AI in our everyday lives. It reveals how AI has become woven into our routines, often without our explicit realization.\", metadata={'_additional': {'explainScore': '(bm25)\\n(hybrid) Document b83765f2-e5d2-471f-8c02-c3350ade4c4f contributed 0.0078125 to the score\\n(hybrid) Document b83765f2-e5d2-471f-8c02-c3350ade4c4f contributed 0.008064516129032258 to the score', 'score': '0.015877016'}}),\n", - " Document(page_content='In her second book, Dr. Simmons delves deeper into the ethical considerations surrounding AI development and deployment. It is an eye-opening examination of the dilemmas faced by developers, policymakers, and society at large.', metadata={'_additional': {'explainScore': '(bm25)\\n(hybrid) Document 7ebbdae7-1061-445f-a046-1989f2343d8f contributed 0.008064516129032258 to the score\\n(hybrid) Document 7ebbdae7-1061-445f-a046-1989f2343d8f contributed 0.0078125 to the score', 'score': '0.015877016'}}),\n", - " Document(page_content='A comprehensive analysis of the evolution of artificial intelligence, from its inception to its future prospects. Dr. Simmons covers ethical considerations, potentials, and threats posed by AI.', metadata={'_additional': {'explainScore': '(vector) [-0.0071824766 -0.0006682752 0.001723625 -0.01897258 -0.0045127636 0.0024410256 -0.020503938 0.013768672 0.009520169 -0.037972264]... \\n(hybrid) Document 3a27b0a5-8dbb-4fee-9eba-8b6bc2c252be contributed 0.007936507936507936 to the score', 'score': '0.007936508'}})]" - ] - }, - "execution_count": 9, - "metadata": {}, - "output_type": "execute_result" - } - ], - "source": [ - "retriever.invoke(\n", - " \"AI integration in society\",\n", - " score=True,\n", - ")" - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3 (ipykernel)", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.10.12" - } - }, - "nbformat": 4, - "nbformat_minor": 5 -} diff --git a/docs/vercel.json b/docs/vercel.json index f91844dda12..236755ba7da 100644 --- a/docs/vercel.json +++ b/docs/vercel.json @@ -121,6 +121,10 @@ { "source": "/docs/contributing/:path((?:faq|repo_structure|review_process)/?)", "destination": "/docs/contributing/reference/:path" + }, + { + "source": "/docs/integrations/retrievers/weaviate-hybrid(/?)", + "destination": "/docs/integrations/vectorstores/weaviate/#search-mechanism" } ] }