Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating parameters used in code snippets to new, correct names. #151

Merged
merged 1 commit into from
Feb 25, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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