Skip to content

Commit 10db320

Browse files
authored
docs(readme): improving SemanticRouter example (#1)
Version with "-SNAPSHOT" isn't available SentenceTransformers constructors currently require a model. SemanticRouter requires a vectorizer.
1 parent d0239bd commit 10db320

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,13 @@ Add RedisVL to your Java (17+) project using Maven or Gradle:
4848
<dependency>
4949
<groupId>com.redis</groupId>
5050
<artifactId>redisvl</artifactId>
51-
<version>0.0.1-SNAPSHOT</version>
51+
<version>0.0.1</version>
5252
</dependency>
5353
```
5454

5555
**Gradle:**
5656
```gradle
57-
implementation 'com.redis:redisvl:0.0.1-SNAPSHOT'
57+
implementation 'com.redis:redisvl:0.0.1'
5858
```
5959

6060
## Setting up Redis
@@ -246,7 +246,7 @@ List<float[]> embeddings = vectorizer.embedBatch(
246246
import com.redis.vl.utils.vectorize.SentenceTransformersVectorizer;
247247
248248
// Using local ONNX model
249-
SentenceTransformersVectorizer vectorizer = new SentenceTransformersVectorizer();
249+
SentenceTransformersVectorizer vectorizer = new SentenceTransformersVectorizer("sentence-transformers/all-mpnet-base-v2");
250250
251251
float[] embedding = vectorizer.embed("What is the capital city of France?");
252252
```
@@ -316,6 +316,9 @@ Build fast decision models that run directly in Redis and route user queries to
316316
```java
317317
import com.redis.vl.extensions.router.SemanticRouter;
318318
import com.redis.vl.extensions.router.Route;
319+
import com.redis.vl.utils.vectorize.SentenceTransformersVectorizer
320+
321+
SentenceTransformersVectorizer vectorizer = new SentenceTransformersVectorizer("sentence-transformers/all-mpnet-base-v2")
319322
320323
List<Route> routes = List.of(
321324
Route.builder()
@@ -335,6 +338,7 @@ List<Route> routes = List.of(
335338
// build semantic router from routes
336339
SemanticRouter router = SemanticRouter.builder()
337340
.name("topic-router")
341+
.vectorizer(vectorizer)
338342
.routes(routes)
339343
.jedis(jedis)
340344
.build();

0 commit comments

Comments
 (0)