Skip to content

Commit 23fd585

Browse files
authored
User guide (neo4j#72)
* Create user guide, document all features * Improved wording, added missing docstring * Update CHANGELOG.md * Fix link, English, add table to list retrievers instead of bullet list * Fix typo, update the custom embedding example
1 parent f454e50 commit 23fd585

File tree

7 files changed

+874
-118
lines changed

7 files changed

+874
-118
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
- Updated project configuration to support multiple Python versions (3.8 to 3.12) in CI workflows.
1414
- Improved developer experience by copying the docstring from the `Retriever.get_search_results` method to the `Retriever.search` method
1515
- Support for specifying database names in index handling methods and retrievers.
16+
- User Guide in documentation.
1617

1718
### Changed
1819
- Refactored import paths for retrievers to neo4j_genai.retrievers.

docs/source/api.rst

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,29 +19,34 @@ RetrieverInterface
1919
VectorRetriever
2020
===============
2121

22-
.. autoclass:: neo4j_genai.retrievers.vector.VectorRetriever
22+
.. autoclass:: neo4j_genai.retrievers.VectorRetriever
2323
:members: search
2424

2525
VectorCypherRetriever
2626
=====================
2727

28-
.. autoclass:: neo4j_genai.retrievers.vector.VectorCypherRetriever
28+
.. autoclass:: neo4j_genai.retrievers.VectorCypherRetriever
2929
:members: search
3030

3131

3232
HybridRetriever
3333
===============
3434

35-
.. autoclass:: neo4j_genai.retrievers.hybrid.HybridRetriever
35+
.. autoclass:: neo4j_genai.retrievers.HybridRetriever
3636
:members: search
3737

3838

3939
HybridCypherRetriever
4040
=====================
4141

42-
.. autoclass:: neo4j_genai.retrievers.hybrid.HybridCypherRetriever
42+
.. autoclass:: neo4j_genai.retrievers.HybridCypherRetriever
4343
:members: search
4444

45+
Text2CypherRetriever
46+
=====================
47+
48+
.. autoclass:: neo4j_genai.retrievers.Text2CypherRetriever
49+
:members: search
4550

4651

4752
*******************
@@ -65,6 +70,45 @@ PineconeNeo4jRetriever
6570
:members: search
6671

6772

73+
**********
74+
Embedder
75+
**********
76+
77+
.. autoclass:: neo4j_genai.embedder.Embedder
78+
:members:
79+
80+
SentenceTransformerEmbeddings
81+
================================
82+
83+
.. autoclass:: neo4j_genai.embeddings.SentenceTransformerEmbeddings
84+
:members:
85+
86+
**********
87+
Generation
88+
**********
89+
90+
LLMInterface
91+
======================
92+
93+
.. autoclass:: neo4j_genai.llm.LLMInterface
94+
:members:
95+
96+
97+
OpenAILLM
98+
======================
99+
100+
.. autoclass:: neo4j_genai.llm.OpenAILLM
101+
:members:
102+
103+
104+
PromptTemplate
105+
======================
106+
107+
.. autoclass:: neo4j_genai.generation.prompts.PromptTemplate
108+
:members:
109+
110+
.. _database-interaction-section:
111+
68112
********************
69113
Database Interaction
70114
********************
@@ -73,6 +117,8 @@ Database Interaction
73117

74118
.. autofunction:: neo4j_genai.indexes.create_vector_index
75119

120+
.. _create-fulltext-index:
121+
76122
.. autofunction:: neo4j_genai.indexes.create_fulltext_index
77123

78124
.. autofunction:: neo4j_genai.indexes.drop_index_if_exists

docs/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Python versions supported:
3030
Topics
3131
******
3232

33-
+ :ref:`rag-documentation`
33+
+ :ref:`user-guide`
3434
+ :ref:`api-documentation`
3535
+ :ref:`types-documentation`
3636

@@ -39,7 +39,7 @@ Topics
3939
:caption: Contents:
4040
:hidden:
4141

42-
rag.rst
42+
user_guide.rst
4343
api.rst
4444
types.rst
4545

docs/source/rag.rst

Lines changed: 0 additions & 105 deletions
This file was deleted.

docs/source/types.rst

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,6 @@
44
Types
55
*****
66

7-
Embedder
8-
========
9-
10-
.. autoclass:: neo4j_genai.embedder.Embedder
11-
:members:
12-
13-
147
RawSearchResult
158
==================
169

@@ -27,3 +20,15 @@ RetrieverResultItem
2720
====================
2821

2922
.. autoclass:: neo4j_genai.types.RetrieverResultItem
23+
24+
25+
LLMResponse
26+
====================
27+
28+
.. autoclass:: neo4j_genai.llm.types.LLMResponse
29+
30+
31+
RagResultModel
32+
====================
33+
34+
.. autoclass:: neo4j_genai.generation.types.RagResultModel

0 commit comments

Comments
 (0)