diff --git a/docs/examples/retrievers/reciprocal_rerank_fusion.ipynb b/docs/examples/retrievers/reciprocal_rerank_fusion.ipynb
index 96f72014f25c083496c7a9e212089a46241abdf0..d3c19719c197478b36c911a33fcc8fc5437c2546 100644
--- a/docs/examples/retrievers/reciprocal_rerank_fusion.ipynb
+++ b/docs/examples/retrievers/reciprocal_rerank_fusion.ipynb
@@ -1,7 +1,6 @@
{
"cells": [
{
- "attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
@@ -21,6 +20,16 @@
"Full credits go to @Raduaschl on github for their [example implementation here](https://github.com/Raudaschl/rag-fusion)."
]
},
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "%pip install llama-index-llms-openai\n",
+ "%pip install llama-index-retrievers-bm25"
+ ]
+ },
{
"cell_type": "code",
"execution_count": null,
@@ -42,7 +51,6 @@
]
},
{
- "attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
@@ -51,7 +59,6 @@
]
},
{
- "attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
@@ -62,7 +69,25 @@
"cell_type": "code",
"execution_count": null,
"metadata": {},
- "outputs": [],
+ "outputs": [
+ {
+ "name": "stdout",
+ "output_type": "stream",
+ "text": [
+ "--2024-02-12 17:59:58-- https://raw.githubusercontent.com/run-llama/llama_index/main/docs/examples/data/paul_graham/paul_graham_essay.txt\n",
+ "Resolving raw.githubusercontent.com (raw.githubusercontent.com)... 2606:50c0:8003::154, 2606:50c0:8001::154, 2606:50c0:8002::154, ...\n",
+ "Connecting to raw.githubusercontent.com (raw.githubusercontent.com)|2606:50c0:8003::154|:443... connected.\n",
+ "HTTP request sent, awaiting response... 200 OK\n",
+ "Length: 75042 (73K) [text/plain]\n",
+ "Saving to: ‘data/paul_graham/paul_graham_essay.txt’\n",
+ "\n",
+ "data/paul_graham/pa 100%[===================>] 73.28K 327KB/s in 0.2s \n",
+ "\n",
+ "2024-02-12 17:59:59 (327 KB/s) - ‘data/paul_graham/paul_graham_essay.txt’ saved [75042/75042]\n",
+ "\n"
+ ]
+ }
+ ],
"source": [
"!mkdir -p 'data/paul_graham/'\n",
"!wget 'https://raw.githubusercontent.com/run-llama/llama_index/main/docs/examples/data/paul_graham/paul_graham_essay.txt' -O 'data/paul_graham/paul_graham_essay.txt'"
@@ -138,7 +163,7 @@
"metadata": {},
"outputs": [],
"source": [
- "from llama_index.core.retrievers import BM25Retriever\n",
+ "from llama_index.retrievers.bm25 import BM25Retriever\n",
"\n",
"vector_retriever = index.as_retriever(similarity_top_k=2)\n",
"\n",
@@ -216,20 +241,18 @@
"name": "stdout",
"output_type": "stream",
"text": [
- "Score: 0.05 - Now you could just update the software right on the server.\n",
- "\n",
- "We started a new company we called Viaweb, after the fact that our software worked via the web, and we got $10,000 in seed funding from Idelle's husband Julian. In return for that and doing the initial legal work and giving us business advice, we gave him 10% of the company. Ten years later this deal became the model for Y Combinator's. We knew founders needed something like this, because we'd needed it ourselves.\n",
+ "Score: 0.03 - The UI was horrible, but it proved you could build a whole store through the browser, without any client software or typing anything into the command line on the server.\n",
"\n",
- "At this stage I had a negative net worth, because the thousand dollars or so I had in the bank was more than counterbalanced by what I owed the government in taxes. (Had I diligently set aside the proper proportion of the money I'd made consulting for Interleaf? No, I had not.) So although Robert had his graduate student stipend, I needed that seed funding to live on.\n",
+ "Now we felt like we were really onto something. I had visions of a whole new generation of software working this way. You wouldn't need versions, or ports, or any of that crap. At Interleaf there had been a whole group called Release Engineering that seemed to be at least as big as the group that actually wrote the software. Now you could just update the software right on the server.\n",
"\n",
- "We originally hoped to launch in September, but we got more ambitious about the software as we worked on it....\n",
+ "We started a new company we called Viaweb, after the fact that our software worked via the web, and we got $10,000 in seed funding from Idelle's husband Julian. In return for that and doing the initial legal work and giving us business advice, we gave him 10% of the company. Ten years later this deal became the model for Y Combinator's. We knew founders needed something like this, because we'd needed it ourselves....\n",
"-----\n",
"\n",
- "Score: 0.03 - [8]\n",
+ "Score: 0.03 - Now we felt like we were really onto something. I had visions of a whole new generation of software working this way. You wouldn't need versions, or ports, or any of that crap. At Interleaf there had been a whole group called Release Engineering that seemed to be at least as big as the group that actually wrote the software. Now you could just update the software right on the server.\n",
"\n",
- "There were three main parts to the software: the editor, which people used to build sites and which I wrote, the shopping cart, which Robert wrote, and the manager, which kept track of orders and statistics, and which Trevor wrote. In its time, the editor was one of the best general-purpose site builders. I kept the code tight and didn't have to integrate with any other software except Robert's and Trevor's, so it was quite fun to work on. If all I'd had to do was work on this software, the next 3 years would have been the easiest of my life. Unfortunately I had to do a lot more, all of it stuff I was worse at than programming, and the next 3 years were instead the most stressful.\n",
+ "We started a new company we called Viaweb, after the fact that our software worked via the web, and we got $10,000 in seed funding from Idelle's husband Julian. In return for that and doing the initial legal work and giving us business advice, we gave him 10% of the company. Ten years later this deal became the model for Y Combinator's. We knew founders needed something like this, because we'd needed it ourselves.\n",
"\n",
- "There were a lot of startups making ecommerce software in the second half of the 90s. We were determined to be the Microsoft Word, not the Interleaf. Which meant being easy to use and inexpensive. It was lucky for us that we were poor, because that caused us to make Viaweb even more inexpensive than we realized. We charged $100 a month for a small store and $300 a month for a big one....\n",
+ "At this stage I had a negative net worth, because the thousand dollars or so I had in the bank was more than counterbalanced by what I owed the government in taxes. (Had I diligently set aside the proper proportion of the money I'd made consulting for Interleaf?...\n",
"-----\n",
"\n"
]
@@ -279,7 +302,7 @@
"Generated queries:\n",
"1. What were the major events or milestones in the history of Interleafe and Viaweb?\n",
"2. Can you provide a timeline of the key developments and achievements of Interleafe and Viaweb?\n",
- "3. What were the successes and failures of Interleafe and Viaweb as companies?\n"
+ "3. What were the outcomes or impacts of Interleafe and Viaweb on the respective industries they operated in?\n"
]
}
],
@@ -295,9 +318,7 @@
{
"data": {
"text/markdown": [
- "**`Final Response:`** At Interleaf, the author had worked as a consultant and had made some money. However, they did not set aside the proper proportion of the money to pay taxes, resulting in a negative net worth. \n",
- "\n",
- "At Viaweb, the author and their team started a new company that developed software for building websites and managing online stores. They received $10,000 in seed funding from Julian, who was the husband of Idelle. In return for the funding and business advice, Julian received a 10% stake in the company. The software developed by Viaweb was designed to be easy to use and inexpensive, with prices ranging from $100 to $300 per month."
+ "**`Final Response:`** At Interleaf, there was a group called Release Engineering that was as big as the group that actually wrote the software. This suggests that there was a significant focus on managing versions and ports of the software. However, at Viaweb, the founders realized that they could update the software directly on the server, eliminating the need for versions and ports. They started Viaweb, a company that built software that worked via the web. They received $10,000 in seed funding and gave 10% of the company to Julian, who provided the funding and business advice. This deal later became the model for Y Combinator's."
],
"text/plain": [
"<IPython.core.display.Markdown object>"
@@ -316,9 +337,9 @@
],
"metadata": {
"kernelspec": {
- "display_name": "Python 3 (ipykernel)",
+ "display_name": "llama_index_v3",
"language": "python",
- "name": "python3"
+ "name": "llama_index_v3"
},
"language_info": {
"codemirror_mode": {
diff --git a/docs/examples/retrievers/simple_fusion.ipynb b/docs/examples/retrievers/simple_fusion.ipynb
index b4c062a782af77729135b149f17d284816e2cf7b..d01650b549e135efdfe3925533243bc268d1ba68 100644
--- a/docs/examples/retrievers/simple_fusion.ipynb
+++ b/docs/examples/retrievers/simple_fusion.ipynb
@@ -45,7 +45,7 @@
" input_files=[\"../../community/integrations/vector_stores.md\"]\n",
").load_data()\n",
"documents_2 = SimpleDirectoryReader(\n",
- " input_files=[\"../../core_modules/data_modules/storage/vector_stores.md\"]\n",
+ " input_files=[\"../../module_guides/storing/vector_stores.md\"]\n",
").load_data()"
]
},
@@ -125,7 +125,7 @@
"text": [
"Generated queries:\n",
"1. What are the steps to set up a chroma vector store?\n",
- "2. Best practices for setting up a chroma vector store\n",
+ "2. Best practices for configuring a chroma vector store\n",
"3. Troubleshooting common issues when setting up a chroma vector store\n"
]
}
@@ -143,15 +143,13 @@
"name": "stdout",
"output_type": "stream",
"text": [
- "Score: 0.81 - construct vector store\n",
- "neo4j_vector = Neo4jVectorStore(\n",
- " username=\"neo4j\",\n",
- " password=\"pleasele...\n",
- "Score: 0.80 - construct vector store\n",
- "vector_store = ChromaVectorStore(\n",
- " chroma_collection=chroma_collection,\n",
- ")\n",
- "...\n"
+ "Score: 0.78 - # Vector Stores\n",
+ "\n",
+ "Vector stores contain embedding vectors of ingested document chunks\n",
+ "(and sometimes ...\n",
+ "Score: 0.78 - # Using Vector Stores\n",
+ "\n",
+ "LlamaIndex offers multiple integration points with vector stores / vector dat...\n"
]
}
],
@@ -210,18 +208,41 @@
{
"data": {
"text/markdown": [
- "**`Final Response:`** To set up a Chroma Vector Store, you can use the `ChromaVectorStore` class from the `llama_index.vector_stores` module. Here is an example of how to set it up:\n",
+ "**`Final Response:`** To set up a Chroma vector store, you need to follow these steps:\n",
"\n",
+ "1. Import the necessary libraries:\n",
"```python\n",
- "from llama_index.vector_stores import ChromaVectorStore\n",
+ "import chromadb\n",
+ "from llama_index.vector_stores.chroma import ChromaVectorStore\n",
+ "```\n",
+ "\n",
+ "2. Create a Chroma client:\n",
+ "```python\n",
+ "chroma_client = chromadb.EphemeralClient()\n",
+ "chroma_collection = chroma_client.create_collection(\"quickstart\")\n",
+ "```\n",
+ "\n",
+ "3. Construct the vector store:\n",
+ "```python\n",
+ "vector_store = ChromaVectorStore(chroma_collection=chroma_collection)\n",
+ "```\n",
+ "\n",
+ "Here's an example of how to set up a Chroma vector store using the above steps:\n",
+ "\n",
+ "```python\n",
+ "import chromadb\n",
+ "from llama_index.vector_stores.chroma import ChromaVectorStore\n",
+ "\n",
+ "# Creating a Chroma client\n",
+ "# EphemeralClient operates purely in-memory, PersistentClient will also save to disk\n",
+ "chroma_client = chromadb.EphemeralClient()\n",
+ "chroma_collection = chroma_client.create_collection(\"quickstart\")\n",
"\n",
- "# Assuming you have a chroma_collection variable\n",
- "vector_store = ChromaVectorStore(\n",
- " chroma_collection=chroma_collection,\n",
- ")\n",
+ "# construct vector store\n",
+ "vector_store = ChromaVectorStore(chroma_collection=chroma_collection)\n",
"```\n",
"\n",
- "This code creates an instance of the `ChromaVectorStore` class, passing in the `chroma_collection` as a parameter."
+ "This example demonstrates how to create a Chroma client, create a collection named \"quickstart\", and then construct a Chroma vector store using that collection."
],
"text/plain": [
"<IPython.core.display.Markdown object>"
@@ -240,9 +261,9 @@
],
"metadata": {
"kernelspec": {
- "display_name": "llama-index-4a-wkI5X-py3.11",
+ "display_name": "llama_index_v3",
"language": "python",
- "name": "python3"
+ "name": "llama_index_v3"
},
"language_info": {
"codemirror_mode": {
@@ -257,5 +278,5 @@
}
},
"nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
}