User guide (#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

Author: stellasia

CHANGELOG.md

@@ -13,6 +13,7 @@
 -   Updated project configuration to support multiple Python versions (3.8 to 3.12) in CI workflows.
 -   Improved developer experience by copying the docstring from the `Retriever.get_search_results` method to the `Retriever.search` method
 -   Support for specifying database names in index handling methods and retrievers.
+-   User Guide in documentation.
 
 ### Changed
 -   Refactored import paths for retrievers to neo4j_genai.retrievers.

docs/source/api.rst

@@ -19,29 +19,34 @@ RetrieverInterface
 VectorRetriever
 ===============
 
-.. autoclass:: neo4j_genai.retrievers.vector.VectorRetriever
+.. autoclass:: neo4j_genai.retrievers.VectorRetriever
     :members: search
 
 VectorCypherRetriever
 =====================
 
-.. autoclass:: neo4j_genai.retrievers.vector.VectorCypherRetriever
+.. autoclass:: neo4j_genai.retrievers.VectorCypherRetriever
     :members: search
 
 
 HybridRetriever
 ===============
 
-.. autoclass:: neo4j_genai.retrievers.hybrid.HybridRetriever
+.. autoclass:: neo4j_genai.retrievers.HybridRetriever
     :members: search
 
 
 HybridCypherRetriever
 =====================
 
-.. autoclass:: neo4j_genai.retrievers.hybrid.HybridCypherRetriever
+.. autoclass:: neo4j_genai.retrievers.HybridCypherRetriever
     :members: search
 
+Text2CypherRetriever
+=====================
+
+.. autoclass:: neo4j_genai.retrievers.Text2CypherRetriever
+    :members: search
 
 
 *******************
@@ -65,6 +70,45 @@ PineconeNeo4jRetriever
     :members: search
 
 
+**********
+Embedder
+**********
+
+.. autoclass:: neo4j_genai.embedder.Embedder
+    :members:
+
+SentenceTransformerEmbeddings
+================================
+
+.. autoclass:: neo4j_genai.embeddings.SentenceTransformerEmbeddings
+    :members:
+
+**********
+Generation
+**********
+
+LLMInterface
+======================
+
+.. autoclass:: neo4j_genai.llm.LLMInterface
+    :members:
+
+
+OpenAILLM
+======================
+
+.. autoclass:: neo4j_genai.llm.OpenAILLM
+    :members:
+
+
+PromptTemplate
+======================
+
+.. autoclass:: neo4j_genai.generation.prompts.PromptTemplate
+    :members:
+
+.. _database-interaction-section:
+
 ********************
 Database Interaction
 ********************
@@ -73,6 +117,8 @@ Database Interaction
 
 .. autofunction:: neo4j_genai.indexes.create_vector_index
 
+.. _create-fulltext-index:
+
 .. autofunction:: neo4j_genai.indexes.create_fulltext_index
 
 .. autofunction:: neo4j_genai.indexes.drop_index_if_exists

docs/source/index.rst

@@ -30,7 +30,7 @@ Python versions supported:
 Topics
 ******
 
-+ :ref:`rag-documentation`
++ :ref:`user-guide`
 + :ref:`api-documentation`
 + :ref:`types-documentation`
 
@@ -39,7 +39,7 @@ Topics
     :caption: Contents:
     :hidden:
 
-    rag.rst
+    user_guide.rst
     api.rst
     types.rst
 

docs/source/rag.rst

@@ -4,13 +4,6 @@
 Types
 *****
 
-Embedder
-========
-
-.. autoclass:: neo4j_genai.embedder.Embedder
-    :members:
-
-
 RawSearchResult
 ==================
 
@@ -27,3 +20,15 @@ RetrieverResultItem
 ====================
 
 .. autoclass:: neo4j_genai.types.RetrieverResultItem
+
+
+LLMResponse
+====================
+
+.. autoclass:: neo4j_genai.llm.types.LLMResponse
+
+
+RagResultModel
+====================
+
+.. autoclass:: neo4j_genai.generation.types.RagResultModel