Error Reporting

This guide describes how errors are reported in the RAI Console and the RelationalAI SDKs.

RAI Console

If you experience an error while using the RAI Console, the output returns the following fields:

This is an example:

RelationalAI SDKs

If you experience an error while using any of the RelationalAI SDKs, the output returns the following fields as a JSON string:

This is an example using the RelationalAI SDK for Python:

{
    "is_error": true,
    "error_code": "PARSE_ERROR",
    "path": "",
    "report": "1| def output = {1;;2;3}\n                 ~~^~\n\nwhile parsing:\n    1. expr ::= expr \";\" expr\n    2. expr ::= expr \";\" expr\n    3. expr ::= \"{\" expr \"}\"\n\nUnexpected \";\" found.\n\n",
    "message": "parse error",
    "is_exception": false,
    "type": "ClientProblem"
}

See the Result Structure section in any of the RelationalAI SDKs for more details.

List of Error Codes