Setup your development environment

In this workshop, you will use Neo4j, Python, and LangChain to create retrievers and agents that can interact with Generative AI models.

Before you start the hands-on exercises, you need to set up your development environment to run the code examples.

Get started

The repository, neo4j-graphacademy/workshop-genai, has been created for this course. It contains any starter code and resources you need.

You can use a GitHub codespace as an online IDE and workspace for this course. It will automatically clone the course repository and set up your environment.

Open in GitHub Codespace

GitHub Codespaces

You will need to login with a GitHub account. The GitHub Codespaces free monthly usage will cover the duration of this course.

Develop on your local machine

You will need:

You may want to set up a virtual environment using venv or virtualenv to keep your dependencies separate from other projects.

Clone the github.com/neo4j-graphacademy/workshop-genai repository:

bash
git clone https://github.com/neo4j-graphacademy/workshop-genai

Install the required packages using pip and download the required data:

bash
cd workshop-genai
pip install -r requirements.txt

You do not need to create a Neo4j database as you will use the provided instance.

The instance uses Neo4j’s GenAI functions, you can find out more about how to configure them in the Neo4j GenAI integration documentation.

Setup the environment

Create a copy of the .env.example file and name it .env. Fill in the required values.

Create a .env file
# Create a copy of this file and name it .env
OPENAI_API_KEY="sk-"
NEO4J_URI="neo4j://"
NEO4J_USERNAME="neo4j"
NEO4J_PASSWORD=""

Add your Open AI API key (OPENAI_API_KEY).

Update the Neo4j sandbox connection details:

NEO4J_URI

neo4j://{instance-ip}:{instance-boltPort}

NEO4J_USERNAME

{instance-username}

NEO4J_PASSWORD

{instance-password}

Test your setup

You can test your setup by running workshop-genai/test_environment.py - this will attempt to connect to the Neo4j sandbox and the OpenAI API.

You will see an OK message if you have set up your environment correctly. If any tests fail, check the contents of the .env file.

Continue

When you are ready, you can move on to the next lesson.

Lesson Summary

You have setup your development environment and are ready for hands-on practice.

In the next lesson, you will work hands-on with retrievers using Jupyter notebooks to see how they work in practice.

Continue to Hands-On Retrievers →

Chatbot

How can I help you today?