Skip to content

Commit

Permalink
Adds query prefix to docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
willtai committed Apr 22, 2024
1 parent 53aa093 commit dda1d81
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion src/neo4j_genai/retrievers.py
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,14 @@ def search(

class VectorCypherRetriever(VectorRetriever):
"""
Provides retrieval method using vector similarity and custom Cypher query
Provides retrieval method using vector similarity and custom Cypher query.
When providing the custom query, note that the existing variable `node` can be used.
The query prefix:
```
CALL db.index.vector.queryNodes($index_name, $top_k, $query_vector)
YIELD node, score
```
"""

def __init__(
Expand Down

0 comments on commit dda1d81

Please sign in to comment.