Skip to content

Commit 483f0fd

Browse files
authored
Merge pull request #3 from Hlyda/fix/readme
[fix] new readme version
2 parents 68be152 + 68e403c commit 483f0fd

File tree

3 files changed

+19
-5
lines changed

3 files changed

+19
-5
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,3 +162,4 @@ cython_debug/
162162
#.idea/
163163
.DS_Store
164164
uv.lock
165+
.langgraph_api/

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,31 @@ This project has been tested with:
2323

2424
The system is structured to work with other providers, but implementations for alternatives would need to be added.
2525

26+
## Prerequisites
27+
Before you begin, ensure you have the following API keys for:
28+
29+
- [LangSmith](https://smith.langchain.com/settings?_gl=1*1abavxa*_ga*MTExOTQ4NDEzMy4xNzQ4ODcyNzQ3*_ga_47WX3HKKY2*czE3NDg4NzI3NDYkbzEkZzEkdDE3NDg4NzQ3OTAkajMxJGwwJGgw)
30+
- [OpenAI](https://platform.openai.com/signup) (for LLM access)
31+
- [Pinecone](https://www.pinecone.io/start/) (for vector database access)
2632
## Getting Started
2733

2834
1. Copy `.env.example` to `.env`
2935
```bash
3036
cp .env.example .env
3137
```
32-
3338
2. Add your API keys and configuration to `.env`
3439

35-
3. Running with LangGraph Studio
36-
- **Mac users**: Use LangGraph Studio directly
37-
- **Windows/Linux users**: Follow [this tutorial](https://langchain-ai.github.io/langgraph/tutorials/langgraph-platform/local-server/#langgraph-studio-web-ui) to set up LangGraph Studio
40+
3. Install the LangGraph CLI
41+
```bash
42+
pip install --upgrade "langgraph-cli[inmem]"
43+
```
44+
45+
4. Launch LangGraph Server
46+
Start the LangGraph API server locally:
47+
48+
```bash
49+
langgraph dev
50+
```
3851

3952
## Integration with Frontend
4053

src/self_rag/nodes/generate.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from langchain_openai import ChatOpenAI
66

77
# Prompt
8-
prompt = hub.pull("self-rag")
8+
prompt = hub.pull("langchaindoc/self-rag")
99

1010
# LLM
1111
llm = ChatOpenAI(model_name="gpt-4o-mini", temperature=0)

0 commit comments

Comments
 (0)