From 8b5f973cc2e976315b499c72e2247511949c676c Mon Sep 17 00:00:00 2001
From: Raphael De Lio <raphadlts@gmail.com>
Date: Tue, 14 Oct 2025 16:21:04 +0200
Subject: [PATCH] docs(readme): improving SemanticRouter example

Version with "-SNAPSHOT" isn't available

SentenceTransformers constructors currently require a model.

SemanticRouter requires a vectorizer.
---
 README.md | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 9206eb1..1a94cee 100644
--- a/README.md
+++ b/README.md
@@ -48,13 +48,13 @@ Add RedisVL to your Java (17+) project using Maven or Gradle:
 <dependency>
     <groupId>com.redis</groupId>
     <artifactId>redisvl</artifactId>
-    <version>0.0.1-SNAPSHOT</version>
+    <version>0.0.1</version>
 </dependency>
 ```
 
 **Gradle:**
 ```gradle
-implementation 'com.redis:redisvl:0.0.1-SNAPSHOT'
+implementation 'com.redis:redisvl:0.0.1'
 ```
 
 ## Setting up Redis
@@ -246,7 +246,7 @@ List<float[]> embeddings = vectorizer.embedBatch(
 import com.redis.vl.utils.vectorize.SentenceTransformersVectorizer;
 
 // Using local ONNX model
-SentenceTransformersVectorizer vectorizer = new SentenceTransformersVectorizer();
+SentenceTransformersVectorizer vectorizer = new SentenceTransformersVectorizer("sentence-transformers/all-mpnet-base-v2");
 
 float[] embedding = vectorizer.embed("What is the capital city of France?");
 ```
@@ -316,6 +316,9 @@ Build fast decision models that run directly in Redis and route user queries to
 ```java
 import com.redis.vl.extensions.router.SemanticRouter;
 import com.redis.vl.extensions.router.Route;
+import com.redis.vl.utils.vectorize.SentenceTransformersVectorizer
+
+SentenceTransformersVectorizer vectorizer = new SentenceTransformersVectorizer("sentence-transformers/all-mpnet-base-v2")
 
 List<Route> routes = List.of(
     Route.builder()
@@ -335,6 +338,7 @@ List<Route> routes = List.of(
 // build semantic router from routes
 SemanticRouter router = SemanticRouter.builder()
     .name("topic-router")
+    .vectorizer(vectorizer)
     .routes(routes)
     .jedis(jedis)
     .build();