Skip to content

Commit d5bb2a1

Browse files
committed
Add errors to documentation
1 parent c926585 commit d5bb2a1

File tree

2 files changed

+56
-2
lines changed

2 files changed

+56
-2
lines changed

docs/source/api.rst

+54
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,57 @@ HybridCypherRetriever
4040

4141
.. autoclass:: neo4j_genai.retrievers.hybrid.HybridCypherRetriever
4242
:members:
43+
44+
45+
******
46+
Errors
47+
******
48+
49+
50+
RetrieverInitializationError
51+
============================
52+
53+
.. autoclass:: neo4j_genai.exceptions.RetrieverInitializationError
54+
:members:
55+
56+
57+
SearchValidationError
58+
=====================
59+
60+
.. autoclass:: neo4j_genai.exceptions.SearchValidationError
61+
:members:
62+
63+
64+
FilterValidationError
65+
=====================
66+
67+
.. autoclass:: neo4j_genai.exceptions.FilterValidationError
68+
:members:
69+
70+
71+
EmbeddingRequiredError
72+
======================
73+
74+
.. autoclass:: neo4j_genai.exceptions.EmbeddingRequiredError
75+
:members:
76+
77+
78+
RecordCreationError
79+
===================
80+
81+
.. autoclass:: neo4j_genai.exceptions.RecordCreationError
82+
:members:
83+
84+
85+
Neo4jIndexError
86+
===============
87+
88+
.. autoclass:: neo4j_genai.exceptions.Neo4jIndexError
89+
:members:
90+
91+
92+
Neo4jVersionError
93+
=================
94+
95+
.. autoclass:: neo4j_genai.exceptions.Neo4jVersionError
96+
:members:

src/neo4j_genai/exceptions.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
class RetrieverInitializationError(Exception):
1818
"""Exception raised when initialization of a retriever fails."""
1919

20-
def __init__(self, errors):
20+
def __init__(self, errors: str):
2121
super().__init__(f"Initialization failed: {errors}")
2222
self.errors = errors
2323

@@ -31,7 +31,7 @@ def __init__(self, errors):
3131

3232

3333
class FilterValidationError(Exception):
34-
"""Exception raised when an embedding method is required but not provided."""
34+
"""Exception raised when input validation for metadata filtering fails."""
3535

3636
pass
3737

0 commit comments

Comments
 (0)