Skip to content

Package level Error Messaging and Logging #94

@frayle-ons

Description

@frayle-ons

The aim of this ticket is to create a consistent logic around error messaging for users (developers writing code using the package) to clearly explain what went wrong with the package API when an error occurs.

Key considerations include:

  • when an error occurs, error message returned to the user should indicate which module [Vectoriser, VectorStore, startAPI, (RAG)] the error originated from.
  • WIth Pre-processing and Post-Processing functions on main module Classes #86 and feat: pre- and post- processing Hooks #91 there are now several areas errors can occur:
    - At the pyndatic entry point to the function when input arguments are validated
    - In the pre- or post- processing functions that the user implemented
    - in the core logic of the package modules
    - in the restAPI service, either during request validation with pedantic or on the server
  • To the above point, how errors are handled in each case should be decided and specifically how errors should be handled when an error is encountered with the live API service, versus when doing actual development in a python script

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions