Skip to content
Python

docs: document Jev post screening (#1376)

Yijia-Xiao24c38602e552
diff --git a/.env.example b/.env.example
index fa24e8963..61275aed6 100644
--- a/.env.example
+++ b/.env.example
@@ -22,6 +22,10 @@ NVIDIA_API_KEY=
# FRED (Federal Reserve macro data). Free key: https://fred.stlouisfed.org/docs/api/api_key.html
#FRED_API_KEY=
+# TypeSafe Jev: screens StockTwits and Reddit posts for the Sentiment Analyst. Optional.
+#TYPESAFE_API_KEY=
+#TYPESAFE_DEFAULT_MODEL=jev-latest
+
# Custom OpenAI-compatible endpoint (vLLM, LM Studio, llama.cpp). Local servers need no key.
#OPENAI_COMPATIBLE_API_KEY=
diff --git a/README.md b/README.md
index d5008133c..6fc114ee2 100644
--- a/README.md
+++ b/README.md
@@ -166,6 +166,7 @@ export GROQ_API_KEY=... # Groq
export NVIDIA_API_KEY=... # NVIDIA NIM
export FRED_API_KEY=... # FRED macro data (free, optional)
export ALPHA_VANTAGE_API_KEY=... # Alpha Vantage
+export TYPESAFE_API_KEY=... # Jev social-post screening (optional)
```
For Azure OpenAI, copy `.env.enterprise.example` to `.env.enterprise` and fill in your credentials.
@@ -176,6 +177,8 @@ For local models, configure Ollama with `llm_provider: "ollama"`. The default en
For any other OpenAI-compatible server (vLLM, LM Studio, llama.cpp, or a custom relay), use `llm_provider: "openai_compatible"` and set the endpoint via `backend_url` (or `TRADINGAGENTS_LLM_BACKEND_URL`), e.g. `http://localhost:8000/v1` for vLLM or `http://localhost:1234/v1` for LM Studio. The model is whatever your server serves. No key is needed for local servers; set `OPENAI_COMPATIBLE_API_KEY` when the endpoint requires one.
+With `TYPESAFE_API_KEY` set, the Sentiment Analyst screens StockTwits and Reddit posts with TypeSafe's Jev before reading them. Posts that are not about the company are dropped, and each source opens with a count of the remaining posts by stance: bullish, bearish, neutral, or unclear. Without the key, posts pass through unscreened. `jev-latest` moves with new releases; set `TYPESAFE_DEFAULT_MODEL` to a versioned ID such as `jev-1.13.0` to hold it fixed across runs.
+
Alternatively, copy `.env.example` to `.env` and fill in your keys:
```bash
cp .env.example .env