Skip to content

Commit fc7d319

Browse files
authored
Moved Embedder class to under neo4j_graphrag.embeddings (#138)
* Moved Embedder class to under neo4j_graphrag.embeddings * Update documentation * Rename to base and add await to run example in docs * Update CHANGELOG
1 parent 1f5b8eb commit fc7d319

26 files changed

+31
-27
lines changed

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# @neo4j/neo4j-graphrag-python
22

33
## Next
4+
45
### Added
56
- Add `template` validation in `PromptTemplate` class upon construction.
67
- `custom_prompt` arg is now converted to `Text2CypherTemplate` class within the `Text2CypherRetriever.get_search_results` method.
@@ -9,6 +10,9 @@
910
- Add feature to include kwargs in `Text2CypherRetriever.search()` that will be injected into a custom prompt, if provided.
1011
- Add validation to `custom_prompt` parameter of `Text2CypherRetriever` to ensure that `query_text` placeholder exists in prompt.
1112

13+
### Changed
14+
- Moved the Embedder class to the neo4j_graphrag.embeddings directory for better organization alongside other custom embedders.
15+
1216
## 0.6.3
1317
### Changed
1418
- Updated documentation links in README.
@@ -128,4 +132,4 @@
128132
### Fixed
129133

130134
- Updated documentation to include new custom exceptions.
131-
- Improved the use of Pydantic for input data validation for retriever objects.
135+
- Improved the use of Pydantic for input data validation for retriever objects.

docs/source/api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ PineconeNeo4jRetriever
135135
Embedder
136136
********
137137

138-
.. autoclass:: neo4j_graphrag.embedder.Embedder
138+
.. autoclass:: neo4j_graphrag.embeddings.base.Embedder
139139
:members:
140140

141141
SentenceTransformerEmbeddings
@@ -147,13 +147,13 @@ SentenceTransformerEmbeddings
147147
OpenAIEmbeddings
148148
================
149149

150-
.. autoclass:: neo4j_genai.embeddings.openai.OpenAIEmbeddings
150+
.. autoclass:: neo4j_graphrag.embeddings.openai.OpenAIEmbeddings
151151
:members:
152152

153153
VertexAIEmbeddings
154154
==================
155155

156-
.. autoclass:: neo4j_genai.embeddings.vertexai.VertexAIEmbeddings
156+
.. autoclass:: neo4j_graphrag.embeddings.vertexai.VertexAIEmbeddings
157157
:members:
158158

159159
**********

docs/source/user_guide_kg_builder.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ Here is a code block illustrating these concepts:
188188
189189
schema_builder = SchemaBuilder()
190190
191-
schema_builder.run(
191+
await schema_builder.run(
192192
entities=[
193193
SchemaEntity(
194194
label="Person",

docs/source/user_guide_rag.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ the following implementation of an embedder that wraps the `OllamaEmbedding` mod
277277
.. code:: python
278278
279279
from llama_index.embeddings.ollama import OllamaEmbedding
280-
from neo4j_graphrag.embedder import Embedder
280+
from neo4j_graphrag.embeddings.base import Embedder
281281
282282
class OllamaEmbedder(Embedder):
283283
def __init__(self, ollama_embedding):

examples/hybrid_cypher_search.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from random import random
44

55
from neo4j import GraphDatabase
6-
from neo4j_graphrag.embedder import Embedder
6+
from neo4j_graphrag.embeddings.base import Embedder
77
from neo4j_graphrag.indexes import create_fulltext_index, create_vector_index
88
from neo4j_graphrag.retrievers import HybridCypherRetriever
99

examples/hybrid_search.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from random import random
44

55
from neo4j import GraphDatabase
6-
from neo4j_graphrag.embedder import Embedder
6+
from neo4j_graphrag.embeddings.base import Embedder
77
from neo4j_graphrag.indexes import create_fulltext_index, create_vector_index
88
from neo4j_graphrag.retrievers import HybridRetriever
99

examples/similarity_search_for_text.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from random import random
44

55
from neo4j import GraphDatabase
6-
from neo4j_graphrag.embedder import Embedder
6+
from neo4j_graphrag.embeddings.base import Embedder
77
from neo4j_graphrag.indexes import create_vector_index
88
from neo4j_graphrag.retrievers import VectorRetriever
99

examples/vector_cypher_retrieval.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import string
55

66
from neo4j import GraphDatabase
7-
from neo4j_graphrag.embedder import Embedder
7+
from neo4j_graphrag.embeddings.base import Embedder
88
from neo4j_graphrag.indexes import create_vector_index
99
from neo4j_graphrag.retrievers import VectorCypherRetriever
1010

examples/vector_search_with_filters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import string
55

66
from neo4j import GraphDatabase
7-
from neo4j_graphrag.embedder import Embedder
7+
from neo4j_graphrag.embeddings.base import Embedder
88
from neo4j_graphrag.indexes import create_vector_index
99
from neo4j_graphrag.retrievers import VectorRetriever
1010

0 commit comments

Comments
 (0)