Skip to content
  • HELP
  • ERROR MESSAGES
  • Error Reporting

Error Reporting

This guide introduces how errors are reported depending on the way you are interacting with the system, including the RAI Console and the RAI SDKs.

RAI Console

If you are experiencing any error while using the RAI Console, the following fields are returned in the output:

FieldMeaning
CodeType of issue encountered. Refer to the full list of errors.
MessageA short description of the problem.
Transaction-idTransaction ID. Learn more about them here.
ReportFull detailed information on the cause of error.

This is an example:

Error example from the RAI Console

SDKs

If you are experiencing any error while using any of the RAI SDKs, the following fields are returned as a JSON string in the output:

FieldMeaning
error_codeThe type of issue encountered. Refer to the full list of errors.
is_errorWhether an error occurred or there was some other problem.
is_exceptionWhether an exception occurred or there was some other problem.
messageA short description of the problem.
pathA file path for the cases when such a path was used.
reportFull detailed information on the cause of error.
typeThe type of problem, for example, "ClientProblem".

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"
}

Refer to the Result Structure section of any of the SDKs to learn more about it.

List of Error Codes

Error CodeDescription
ARITY_MISMATCHArity mismatch errors.
DATA_LOADData loading errors.
DATA_LOAD_CONFIGData loading configuration errors.
EXCEPTIONExecution errors.
EXCEPTION - Ungrounded VariableA variable has not been correctly instantiated.
INTEGRITY_CONSTRAINT_VIOLATIONIntegrity constraint violations.
NON_FORMULA_IC_BODYThe integrity constraint is not well defined.
PARSE_ERRORRel syntax errors.
PARSE_ERROR - Reserved KeywordReserved keyword errors.
SHADOWED_VARIABLESame naming for different variables.
UNBOUND_VARIABLEThe variable type cannot be inferred.
UNDEFINEDA variable has not been correctly defined.
VARARGSThe argument arity is not a finite number.
Was this doc helpful?