Skip to content

Commit c571904

Browse files
[Docs] Fixing RAG broken links in Cookbooks (#1122)
2 parents e166f0d + cabf50d commit c571904

File tree

9 files changed

+16
-11
lines changed

9 files changed

+16
-11
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ AIConfig helps unwind complexity by separating prompts, model parameters, and mo
184184

185185
AIConfig makes it easy to work with complex prompt chains, various models, and advanced generative AI workflows. Start with these recipes and access more in [`/cookbooks`](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks):
186186

187-
- [RAG with AIConfig](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-AIConfig)
187+
- [RAG with AIConfig](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-ChromaDB)
188188
- [Function Calling with OpenAI](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Function-Calling-OpenAI)
189189
- [CLI Chatbot](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Wizard-GPT)
190190
- [Prompt Routing](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Basic-Prompt-Routing)

aiconfig-docs/docs/basics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Here are the basics of interacting with `aiconfig`:
6363
There is a lot you can do with these capabilities. We have several tutorials to help get you started:
6464

6565
- [CLI Chatbot](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Wizard-GPT)
66-
- [RAG with AIConfig](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-AIConfig)
66+
- [RAG with ChromaDB](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-ChromaDB)
6767
- [Prompt routing](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Basic-Prompt-Routing)
6868
- [OpenAI function calling](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Function-Calling-OpenAI)
6969
- [Chain of thought](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Chain-of-Verification)

aiconfig-docs/docs/cookbooks.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ The [cookbooks](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks) dir
1414

1515
### Retrieval Augmented Generated (RAG)
1616

17-
- [RAG with AIConfig](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-AIConfig)
17+
- [RAG with ChromaDB](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-ChromaDB)
18+
- [RAG with MongoDB Vector Search](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-MongoDB)
1819

1920
At its core, RAG is about passing data into prompts. Read how to [pass data](/docs/overview/parameters) with AIConfig.
2021

aiconfig-docs/docs/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -537,7 +537,7 @@ A new tab with the AIConfig Editor opens in your default browser at http://local
537537
Check out these examples and guides:
538538

539539
- [OpenAI function calling](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Function-Calling-OpenAI)
540-
- [RAG with AIConfig](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-AIConfig)
540+
- [RAG with ChromaDB](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-ChromaDB)
541541
- [CLI Chatbot](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Wizard-GPT)
542542
- [Prompt routing](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Basic-Prompt-Routing)
543543
- [Chain of thought](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Chain-of-Verification)

aiconfig-docs/docs/overview/parameters.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ This will return the fully-resolved completion params that will be passed to the
215215
Because parameters can be passed in to prompts programmatically, exactly what gets passed in can be dynamic. For the example above you could have a dropdown of possible SQL languagesin your app, and you can set the `sql_langauge` parameter to the value selected by a user.
216216

217217
:::tip
218-
This pattern can be used to apply Retrieval Augmented Generation (RAG) techniques with `aiconfig`. For more details, see the [RAG cookbook](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-AIConfig).
218+
This pattern can be used to apply Retrieval Augmented Generation (RAG) techniques with `aiconfig`. For more details, see the [RAG cookbook](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-ChromaDB).
219219
:::
220220

221221
## What gets parameterized

cookbooks/Gemini/Gemini.ipynb

+2-1
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,8 @@
287287
" <li>Cookbooks and guides</li>\n",
288288
" <ul style=\"margin-bottom:0; padding-bottom:0;\">\n",
289289
" <li><a href=\"https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Wizard-GPT\">CLI Chatbot</a></li>\n",
290-
" <li><a href=\"https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-AIConfig\">RAG with AIConfig</a></li>\n",
290+
" <li><a href=\"https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-ChromaDB\">RAG with ChromaDB</a></li>\n",
291+
" <li><a href=\"https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-MongoDB\">RAG with MongoDB</a></li>\n",
291292
" <li><a href=\"https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Basic-Prompt-Routing\">Prompt routing</a></li>\n",
292293
" <li><a href=\"https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Function-Calling-OpenAI\">OpenAI function calling</a></li>\n",
293294
" <li><a href=\"https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Chain-of-Verification\">Chain of Verification</a></li>\n",

cookbooks/LLaMA-Guard/llama_guard_cookbook.ipynb

+2-1
Original file line numberDiff line numberDiff line change
@@ -901,7 +901,8 @@
901901
" <li>Cookbooks and guides</li>\n",
902902
" <ul style=\"margin-bottom:0; padding-bottom:0;\">\n",
903903
" <li><a href=\"https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Wizard-GPT\">CLI Chatbot</a></li>\n",
904-
" <li><a href=\"https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-AIConfig\">RAG with AIConfig</a></li>\n",
904+
" <li><a href=\"https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-ChromaDB\">RAG with ChromaDB</a></li>\n",
905+
" <li><a href=\"https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-MongoDB\">RAG with MongoDB</a></li>\n",
905906
" <li><a href=\"https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Basic-Prompt-Routing\">Prompt routing</a></li>\n",
906907
" <li><a href=\"https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Function-Calling-OpenAI\">OpenAI function calling</a></li>\n",
907908
" <li><a href=\"https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Chain-of-Verification\">Chain of Verification</a></li>\n",

python/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ AIConfig helps unwind complexity by separating prompts, model parameters, and mo
3939
<li><a href="#cookbooks">Cookbooks and guides</a></li>
4040
<ul style="margin-bottom:0; padding-bottom:0;">
4141
<li><a href="https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Wizard-GPT">CLI Chatbot</a></li>
42-
<li><a href="https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-AIConfig">RAG with AIConfig</a></li>
42+
<li><a href="https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-ChromaDB">RAG with ChromaDB</a></li>
43+
<li><a href="https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-MongoDB">RAG with MongoDB</a></li>
4344
<li><a href="https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Basic-Prompt-Routing">Prompt routing</a></li>
4445
<li><a href="https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Function-Calling-OpenAI">OpenAI function calling</a></li>
4546
<li><a href="https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Chain-of-Verification">Chain of Verification</a></li>

typescript/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ AIConfig helps unwind complexity by separating prompts, model parameters, and mo
3939
<li><a href="#cookbooks">Cookbooks and guides</a></li>
4040
<ul style="margin-bottom:0; padding-bottom:0;">
4141
<li><a href="https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Wizard-GPT">CLI Chatbot</a></li>
42-
<li><a href="https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-AIConfig">RAG with AIConfig</a></li>
42+
<li><a href="https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-ChromaDB">RAG with ChromaDB</a></li>
4343
<li><a href="https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Basic-Prompt-Routing">Prompt routing</a></li>
4444
<li><a href="https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Function-Calling-OpenAI">OpenAI function calling</a></li>
4545
<li><a href="https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Chain-of-Verification">Chain of Verification</a></li>
@@ -262,7 +262,7 @@ There is a lot you can do with `aiconfig`. We have several other tutorials to he
262262
Here are some example uses:
263263

264264
- [CLI Chatbot](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Wizard-GPT)
265-
- [RAG with AIConfig](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-AIConfig)
265+
- [RAG with ChromaDB](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-ChromaDB)
266266
- [Prompt routing](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Basic-Prompt-Routing)
267267
- [OpenAI function calling](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Function-Calling-OpenAI)
268268
- [Chain of thought](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/Chain-of-Verification)
@@ -422,7 +422,8 @@ We provide several guides to demonstrate the power of `aiconfig`.
422422

423423
### Retrieval Augmented Generated (RAG)
424424

425-
- [RAG with AIConfig](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-AIConfig)
425+
- [RAG with ChromaDB](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-ChromaDB)
426+
- [RAG with MongoDB](https://github.com/lastmile-ai/aiconfig/tree/main/cookbooks/RAG-with-MongoDB)
426427

427428
At its core, RAG is about passing data into prompts. Read how to [pass data](/docs/overview/parameters) with AIConfig.
428429

0 commit comments

Comments
 (0)