Requirements setup for Java AI Agent workshop

Author: michaelsembwever

README.md

@@ -1,41 +1,11 @@
 # Build your own Java RAG AI Agent
 
- ☕️ Welcome to this workshop to build your own Java AI Agent using Retrieval Augmented Generation.
-
- 🏆 It leverages the best of open-source for fast implementation of the RAG pattern for production quality applications.
-
- 🤩 The completed RAG ChatBot will demonstrate how your AI Agent can do
- - LLM and Prompt Engineering
- - Conversational Memory
- - Vector Similarity Searching and Dense Passage Retrieval
- - Transform, chunk, and vectorise unstructured files like PDFs
- - Caching of LLM responses for latency and cost performance
- - Reranking of search results
- - Vector calculations using JVector
- - Online searching using the Tavily service
- - Hybrid Searching
- - Closed Loop Feedback System
- - LLM Function Calling
- - Time Series Vector Similarity Searching
+ ⬅ This is the next workshop step after the [introduction step](../workshop-intro).
 
- 
-
- ♻️  This workshop uses Java 21, Spring AI and Vaadin for the UI.  The use of Spring and Vaadin is minimal, the code is intended to be re-used in other frameworks.
-
- 👩‍ It is CQL compatbile with Cassandra 5.0 and AstraDB Vector.  Database schemas and data models are intentionally flexible so the concepts in the workshop can be retrofitted to your needs and your production.
-
- 🙇‍ The workshop will use the services: OpenAI, Tavily, and AstraDB.  You will need accounts and api keys for each of these.
-
- 🌴 Each step in the workshop is a separate branch in this repository, you will need to be familiar with git switching between branches.
-
- 💪🏽 To move on to read the [requirements setup step](../workshop-intro-requirements), do the following:
-```
-git switch workshop-intro-requirements
-```
 
 
 
-## Requirements
+## General Requirements
 - Java 21 (or beyond)
 - Command line `git` and git knowledge
 - [DataStax Astra DB](https://astra.datastax.com) (you can sign up through your Github account)
@@ -45,9 +15,61 @@ git switch workshop-intro-requirements
 
 
 
+## Service Requirements Setup
+
+ 🙇‍ The workshop will use the services: OpenAI, Tavily, and AstraDB. You will need accounts and api keys for each of these.
+
+
+
+### Sign up for Astra DB ✍️
+
+Go to astra.datastax.com, sign-in, and create a vector-capable Astra database.
+- Get the Application Token for your database, also in the right pane.
+- You need the API Endpoint found in the right pane underneath Database details.
+
+![astra-signup](./src/assets/astra-signup.png)
+
+ 
+
+### Create Astra Namespace
+
+- Create Namespace “datastax_ai_agent”
+
+![astra-namespace](./src/assets/astra-namespace.png)
+
+ ⚠️ Make sure you have full permissions on this new namespace.
+Permissions are found under left pane "Settings → Roles → ︙ → Edit Role → select all keyspaces".
+
+
+### Sign up for OpenAI ✍️
+
+- Create an [OpenAI account](https://platform.openai.com/signup), or sign in.
+- Navigate to the [API key page](https://platform.openai.com/account/api-keys) and create a new Secret Key, optionally naming the key.
+
+![openai-signup](./src/assets/openai-signup.png)
+ 
+
+### Sign up for Tavily ✍️
+
+- Create an [Tavily account](https://app.tavily.com/sign-in), or sign in.
+- Navigate to the [API key page](https://app.tavily.com/home) and copy your API Key.
+
+![tavily-signup](./src/assets/tavily-signup.png)
+
+ 
+
+## Next… 
+
+ 💪🏽 To move on to the first step, [step-0](../workshop-step-0), do the following:
+```
+git switch workshop-step-0
+```
+
+
+
 ***
 ![java](./src/assets/java.png) ![vaadin](./src/assets/vaadin.png) ![spring](./src/assets/spring.png) ![tika](./src/assets/tika.jpeg) ![openai](./src/assets/openai.png) ![cassandra](./src/assets/cassandra.png) ![tavily](./src/assets/tavily.jpeg)
 
-***
+*** 
 All work is copyrighted to DataStax, Inc