Skip to content

Commit

Permalink
Update get-started.md (#151)
Browse files Browse the repository at this point in the history
  • Loading branch information
briangodsey authored Feb 25, 2025
1 parent 50a36f3 commit 4981524
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/guide/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ matching the query, and then traverse to other animals with the same `habitat` a
simple = GraphRetriever(
store = vector_store,
edges = [("habitat", "habitat"), ("origin", "origin"), ("keywords", "keywords")],
strategy = Eager(k=10, start_k=1, depth=2),
strategy = Eager(k=10, start_k=1, max_depth=2),
)
```

Expand All @@ -170,7 +170,7 @@ matching the query, and then traverse to other animals with the same `habitat` a
simple = GraphRetriever(
store = CassandraAdapter(vector_store, shredder, {"keywords"}),,
edges = [("habitat", "habitat"), ("origin", "origin"), ("keywords", "keywords")],
strategy = Eager(k=10, start_k=1, depth=2),
strategy = Eager(k=10, start_k=1, max_depth=2),
)
```

Expand All @@ -183,7 +183,7 @@ matching the query, and then traverse to other animals with the same `habitat` a
simple = GraphRetriever(
store = vector_store,
edges = [("habitat", "habitat"), ("origin", "origin"), ("keywords", "keywords")],
strategy = Eager(k=10, start_k=1, depth=2),
strategy = Eager(k=10, start_k=1, max_depth=2),
)
```

Expand All @@ -198,7 +198,7 @@ matching the query, and then traverse to other animals with the same `habitat` a
simple = GraphRetriever(
store = ChromaAdapter(vector_store, shredder, {"keywords"}),
edges = [("habitat", "habitat"), ("origin", "origin"), ("keywords", "keywords")],
strategy = Eager(k=10, start_k=1, depth=2),
strategy = Eager(k=10, start_k=1, max_depth=2),
)
```

Expand All @@ -210,7 +210,7 @@ matching the query, and then traverse to other animals with the same `habitat` a

The above creates a graph traversing retriever that starts with the nearest animal
(`start_k=1`), retrieves 10 documents (`k=10`) and limits the search to documents that
are at most 2 steps away from the first animal (`depth=2`).
are at most 2 steps away from the first animal (`max_depth=2`).

The edges define how metadata values can be used for traversal. In this case, every
animal is connected to other animals with the same habitat and/or same origin.
Expand Down

0 comments on commit 4981524

Please sign in to comment.