Add documentation for pipeline exceptions (#90)

Author: willtai

docs/source/api.rst

@@ -10,7 +10,7 @@ Retrievers
 **********
 
 RetrieverInterface
-===================
+==================
 
 .. autoclass:: neo4j_genai.retrievers.base.Retriever
     :members:
@@ -70,9 +70,9 @@ PineconeNeo4jRetriever
     :members: search
 
 
-**********
+********
 Embedder
-**********
+********
 
 .. autoclass:: neo4j_genai.embedder.Embedder
     :members:
@@ -88,21 +88,21 @@ Generation
 **********
 
 LLMInterface
-======================
+============
 
 .. autoclass:: neo4j_genai.llm.LLMInterface
     :members:
 
 
 OpenAILLM
-======================
+=========
 
 .. autoclass:: neo4j_genai.llm.OpenAILLM
     :members:
 
 
 PromptTemplate
-======================
+==============
 
 .. autoclass:: neo4j_genai.generation.prompts.PromptTemplate
     :members:
@@ -159,6 +159,12 @@ Errors
 
   * :class:`neo4j_genai.exceptions.LLMGenerationError`
 
+  * :class:`neo4j_genai.pipeline.exceptions.PipelineDefinitionError`
+
+  * :class:`neo4j_genai.pipeline.exceptions.PipelineMissingDependencyError`
+
+  * :class:`neo4j_genai.pipeline.exceptions.PipelineStatusUpdateError`
+
 
 Neo4jGenAiError
 ===============
@@ -224,7 +230,7 @@ Neo4jVersionError
 
 
 Text2CypherRetrievalError
-==========================
+=========================
 
 .. autoclass:: neo4j_genai.exceptions.Text2CypherRetrievalError
    :show-inheritance:
@@ -238,21 +244,42 @@ SchemaFetchError
 
 
 RagInitializationError
-==========================
+======================
 
 .. autoclass:: neo4j_genai.exceptions.RagInitializationError
    :show-inheritance:
 
 
 PromptMissingInputError
-==========================
+=======================
 
 .. autoclass:: neo4j_genai.exceptions.PromptMissingInputError
    :show-inheritance:
 
 
 LLMGenerationError
-==========================
+==================
 
 .. autoclass:: neo4j_genai.exceptions.LLMGenerationError
    :show-inheritance:
+
+
+PipelineDefinitionError
+=======================
+
+.. autoclass:: neo4j_genai.pipeline.exceptions.PipelineDefinitionError
+   :show-inheritance:
+
+
+PipelineMissingDependencyError
+==============================
+
+.. autoclass:: neo4j_genai.pipeline.exceptions.PipelineMissingDependencyError
+   :show-inheritance:
+
+
+PipelineStatusUpdateError
+=========================
+
+.. autoclass:: neo4j_genai.pipeline.exceptions.PipelineStatusUpdateError
+   :show-inheritance:

docs/source/user_guide_pipeline.rst

@@ -5,13 +5,15 @@ User Guide: Pipeline
 
 This page provides information about how to create a pipeline.
 
-.. node::
+
+.. note::
 
     Pipelines run asynchronously, see examples below.
 
-******************************
+
+*******************
 Creating Components
-******************************
+*******************
 
 Components are asynchronous units of work that perform simple tasks,
 such as chunking documents or saving results to Neo4j.

src/neo4j_genai/pipeline/exceptions.py

@@ -12,21 +12,22 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from neo4j_genai.exceptions import Neo4jGenAiError
 
 
-class PipelineDefinitionError(Exception):
+class PipelineDefinitionError(Neo4jGenAiError):
     """Raised when the pipeline graph is invalid"""
 
     pass
 
 
-class PipelineMissingDependencyError(Exception):
+class PipelineMissingDependencyError(Neo4jGenAiError):
     """Raised when a task is scheduled but its dependencies are not yet done"""
 
     pass
 
 
-class PipelineStatusUpdateError(Exception):
+class PipelineStatusUpdateError(Neo4jGenAiError):
     """Raises when trying an invalid change of state (e.g. DONE => DOING)"""
 
     pass