Skip to content

Commit 53bb4f1

Browse files
authored
Added Pipeline to docs and update VectorRetriever example (#161)
1 parent 1edec5d commit 53bb4f1

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

docs/source/api.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,17 @@ LLMEntityRelationExtractor
7070
.. autoclass:: neo4j_graphrag.experimental.components.entity_relation_extractor.LLMEntityRelationExtractor
7171
:members: run
7272

73+
74+
.. _pipeline-section:
75+
76+
********
77+
Pipeline
78+
********
79+
80+
.. autoclass:: neo4j_graphrag.experimental.pipeline.Pipeline
81+
:members: run, add_component, connect, get_pygraphviz_graph
82+
83+
7384
.. _retrievers-section:
7485

7586
**********

src/neo4j_graphrag/retrievers/vector.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,12 @@ class VectorRetriever(Retriever):
6060
retriever = VectorRetriever(driver, "vector-index-name", custom_embedder)
6161
retriever.search(query_text="Find me a book about Fremen", top_k=5)
6262
63+
or if the vector embedding of the query text is available:
64+
65+
.. code-block:: python
66+
67+
retriever.search(query_vector=..., top_k=5)
68+
6369
Args:
6470
driver (neo4j.Driver): The Neo4j Python driver.
6571
index_name (str): Vector index name.

0 commit comments

Comments
 (0)