Skip to content

Commit 6503a23

Browse files
committed
Update documentation
1 parent 2adf48d commit 6503a23

File tree

1 file changed

+34
-10
lines changed

1 file changed

+34
-10
lines changed

Diff for: docs/source/api.rst

+34-10
Original file line numberDiff line numberDiff line change
@@ -47,50 +47,74 @@ Errors
4747
******
4848

4949

50+
* :class:`neo4j_genai.exceptions.Neo4jGenAiError`
51+
52+
* :class:`neo4j_genai.exceptions.RetrieverInitializationError`
53+
54+
* :class:`neo4j_genai.exceptions.SearchValidationError`
55+
56+
* :class:`neo4j_genai.exceptions.FilterValidationError`
57+
58+
* :class:`neo4j_genai.exceptions.EmbeddingRequiredError`
59+
60+
* :class:`neo4j_genai.exceptions.InvalidRetrieverResultError`
61+
62+
* :class:`neo4j_genai.exceptions.Neo4jIndexError`
63+
64+
* :class:`neo4j_genai.exceptions.Neo4jVersionError`
65+
66+
67+
Neo4jGenAiError
68+
===============
69+
70+
.. autoclass:: neo4j_genai.exceptions.Neo4jGenAiError
71+
:show-inheritance:
72+
73+
5074
RetrieverInitializationError
5175
============================
5276

5377
.. autoclass:: neo4j_genai.exceptions.RetrieverInitializationError
54-
:members:
78+
:show-inheritance:
5579

5680

5781
SearchValidationError
5882
=====================
5983

6084
.. autoclass:: neo4j_genai.exceptions.SearchValidationError
61-
:members:
85+
:show-inheritance:
6286

6387

6488
FilterValidationError
6589
=====================
6690

6791
.. autoclass:: neo4j_genai.exceptions.FilterValidationError
68-
:members:
92+
:show-inheritance:
6993

7094

7195
EmbeddingRequiredError
7296
======================
7397

7498
.. autoclass:: neo4j_genai.exceptions.EmbeddingRequiredError
75-
:members:
99+
:show-inheritance:
76100

77101

78-
RecordCreationError
79-
===================
102+
InvalidRetrieverResultError
103+
===========================
80104

81-
.. autoclass:: neo4j_genai.exceptions.RecordCreationError
82-
:members:
105+
.. autoclass:: neo4j_genai.exceptions.InvalidRetrieverResultError
106+
:show-inheritance:
83107

84108

85109
Neo4jIndexError
86110
===============
87111

88112
.. autoclass:: neo4j_genai.exceptions.Neo4jIndexError
89-
:members:
113+
:show-inheritance:
90114

91115

92116
Neo4jVersionError
93117
=================
94118

95119
.. autoclass:: neo4j_genai.exceptions.Neo4jVersionError
96-
:members:
120+
:show-inheritance:

0 commit comments

Comments
 (0)