Skip to content

List of error messages

[!NOTE] For the latest implementation status, please refer to Functional Implementation Status (Remaining Functionality).

Implementation notes (artifacts): See docs/implementation/ARTIFACT_MANIFESTS.md for the artifact_manifest.json output by the training script and recommended CLI flags.

This document is a complete list of standardized error messages used in the EvoSpikeNet system.

overview

Error code system

The error code consists of the following format:

{カテゴリ}_{連番}

Example: MODEL_001, DB_002, NET_003

Category list

Prefix Category Description
MODEL Model-related Errors related to loading, registering, and managing models
DB Database Errors related to database connections, queries, and transactions
NET Network Zenoh connection, messaging, and node communication errors
VAL Validation Errors related to input validation and data type checking
INF Inference Errors related to model inference and batch processing
SYS System System initialization, internal server error
CFG Settings Errors related to configuration files and parameters
AUTH Authentication/Authorization Errors related to API authentication, permissions, and rate limits
RES Resources Errors related to resources such as memory, disk, GPU, etc.
TASK Task Errors related to task execution and pipeline processing
NODE Node Errors related to node discovery, management, and health checks

Severity level

Level Description Urgency of response
critical System failure, immediate attention required 🔴 Urgent
high Major functionality is impaired 🟠 High
medium Some functions are impaired 🟡 Medium
low Minor issue, workaround available 🟢 Low
info Information only, no response required ⚪ Information

Error message details

MODEL Errors

MODEL_001

  • Severity: high
  • HTTP Status: 404
  • Message: Model not found: {model_id}
  • Troubleshooting: Please check if the model ID is correct. You can see available models at /api/models.

MODEL_002

  • Severity: medium
  • HTTP Status: 503
  • Message: Model is not ready: {model_id}. Status: {status}
  • Troubleshooting: Please wait until the model has finished loading. You can check the status at /api/models/{model_id}/status.

MODEL_003

  • Severity: high
  • HTTP Status: 500
  • Message: Failed to load model: {model_id}. Error: {error}
  • Troubleshooting: Check the integrity of model files and system resources. Please check the log for details.

MODEL_004

  • Severity: medium
  • HTTP Status: 400
  • Message: Failed to register model: {reason}
  • Troubleshooting: Check the model metadata and file format. Make sure your model ID is unique.

DB Errors

DB_001

  • Severity: critical
  • HTTP Status: 503
  • Message: Database connection failed: {error}
  • Troubleshooting: Check the database server status and connection string. Please check your network connection.

DB_002

  • Severity: high
  • HTTP Status: 500
  • Message: Database query failed: {query}. Error: {error}
  • Troubleshooting: Check your query syntax and database schema. Please check the database log.

DB_003

  • Severity: medium
  • HTTP Status: 500
  • Message: Database transaction failed: {operation}
  • Troubleshooting: Check for concurrent changes and deadlocks. Please try the operation again.

DB_004

  • Severity: low
  • HTTP Status: 404
  • Message: Record not found: {table}.{id}
  • Troubleshooting: Please check the record ID. The record may have been deleted.

NET Errors

NET_001

  • Severity: critical
  • HTTP Status: 503
  • Message: Zenoh connection failed: {error}
  • Troubleshooting: Check the Zenoh router status and network connectivity. Please check your router address.

NET_002

  • Severity: high
  • HTTP Status: 500
  • Message: Message delivery failed: {topic}. Error: {error}
  • Troubleshooting: Check your network connectivity and topic permissions. Please check the message size.

NET_003

  • Severity: medium
  • HTTP Status: 504
  • Message: Network timeout: {operation} exceeded {timeout} seconds
  • Troubleshooting: Check network latency. Increase the timeout value if necessary.

NET_004

  • Severity: medium
  • HTTP Status: 503
  • Message: Node unreachable: {node_id}
  • Troubleshooting: Check the node status and network path. The node may be offline.

VAL Errors

VAL_001

  • Severity: low
  • HTTP Status: 400
  • Message: Invalid input: {field}. {reason}
  • Troubleshooting: Check input format and constraints. Please check the API documentation.

VAL_002

  • Severity: low
  • HTTP Status: 400
  • Message: Required field is missing: {field}
  • Troubleshooting: Make sure your request includes all required fields.

VAL_003

  • Severity: low
  • HTTP Status: 400
  • Message: Value is out of range: {field}={value}. Expected value: {min} to {max}
  • Troubleshooting: Please enter a value within the specified range.

VAL_004

  • Severity: low
  • HTTP Status: 400
  • Message: Invalid data type: {field}. expected value {expected}, actual {actual}
  • Troubleshooting: Make sure the field is the correct data type.

VAL_005

  • Severity: low
  • HTTP Status: 413
  • Message: Input too large: {field}. Maximum size: {max_size}
  • Troubleshooting: Reduce input size or split into multiple requests.

INF Errors

INF_001

  • Severity: high
  • HTTP Status: 500
  • Message: Reasoning failed: {reason}
  • Troubleshooting: Check the model status and input data. Please check the inference log.

INF_002

  • Severity: medium
  • HTTP Status: 504
  • Message: Inference timeout: {timeout} seconds exceeded
  • Troubleshooting: Reduce batch size or increase timeout. Please check the system load.

INF_003

  • Severity: medium
  • HTTP Status: 400
  • Message: Batch size too large: {batch_size}. Maximum value: {max_batch_size}
  • Troubleshooting: Reduce batch size to stay within system limits.

INF_004

  • Severity: low
  • HTTP Status: 400
  • Message: Invalid input shape: expected value {expected}, actual {actual}
  • Troubleshooting: Reshape inputs to suit model requirements.

SYS Errors

SYS_001

  • Severity: critical
  • HTTP Status: 500
  • Message: System initialization failed: {component}
  • Troubleshooting: Check system logs and configuration. Please contact your system administrator.

SYS_002

  • Severity: critical
  • HTTP Status: 500
  • Message: Internal server error: {error_id}
  • Troubleshooting: An unexpected error has occurred. Please report the error ID to support.

SYS_003

  • Severity: high
  • HTTP Status: 503
  • Message: Service unavailable: {service}
  • Troubleshooting: The service may be undergoing maintenance. Please try again later.

SYS_004

  • Severity: medium
  • HTTP Status: 500
  • Message: Component not initialized: {component}
  • Troubleshooting: Verify that the system boot sequence is correct. Please check your settings.

CFG Errors

CFG_001

  • Severity: high
  • HTTP Status: 500
  • Message: Configuration error: {key}. {reason}
  • Troubleshooting: Check the configuration file syntax and values. Please check the documentation.

CFG_002

  • Severity: high
  • HTTP Status: 500
  • Message: Missing setting: {key}
  • Troubleshooting: Add the required configuration parameters. Please check the default settings.

CFG_003

  • Severity: medium
  • HTTP Status: 500
  • Message: Invalid configuration format: {file}
  • Troubleshooting: Please check the format of the configuration file (YAML/JSON). Check for syntax errors.

CFG_004

  • Severity: low
  • HTTP Status: 400
  • Message: Configuration validation failed: {errors}
  • Troubleshooting: Fix configuration validation errors. Use a schema validation tool.

AUTH Errors

AUTH_001

  • Severity: medium
  • HTTP Status: 401
  • Message: Authentication failed: {reason}
  • Troubleshooting: Please check your API key or credentials. Please check the appropriate authentication header.

AUTH_002

  • Severity: medium
  • HTTP Status: 403
  • Message: Authorization failed: Insufficient permissions for {resource}
  • Troubleshooting: Please request appropriate permissions from your administrator.

AUTH_003

  • Severity: low
  • HTTP Status: 401
  • Message: API key has expired or is invalid
  • Troubleshooting: Please regenerate your API key or get a new one.

AUTH_004

  • Severity: medium
  • HTTP Status: 429
  • Message: Rate limit exceeded: {limit} requests per {window}
  • Troubleshooting: Wait before sending the request. Consider upgrading your plan.

RES Errors

RES_001

  • Severity: critical
  • HTTP Status: 507
  • Message: Insufficient memory: {available}MB available, {required}MB
  • Troubleshooting: Free memory or increase system resources. Please reduce batch size.

RES_002

  • Severity: high
  • HTTP Status: 507
  • Message: Insufficient disk space: {available}GB available, threshold {threshold}GB
  • Troubleshooting: Please free up disk space. Clean up temporary files and old artifacts.

RES_003

  • Severity: high
  • HTTP Status: 503
  • Message: GPU not available: {reason}
  • Troubleshooting: Please check GPU driver and CUDA installation. Make sure the GPU is not in use.

RES_004

  • Severity: medium
  • HTTP Status: 429
  • Message: Resource quota exceeded: {resource}. Limit: {limit}
  • Troubleshooting: Wait until resources are freed or increase quota.

TASK Errors

TASK_001

  • Severity: medium
  • HTTP Status: 404
  • Message: Task not found: {task_id}
  • Troubleshooting: Please check the task ID. The task may have expired or been deleted.

TASK_002

  • Severity: high
  • HTTP Status: 500
  • Message: Failed to execute task: {task_id}. Error: {error}
  • Troubleshooting: Please check the task settings and input data. Please check the task log.

TASK_003

  • Severity: medium
  • HTTP Status: 503
  • Message: Task queue is full: cannot accept new tasks
  • Troubleshooting: Please wait for the task to complete. Consider increasing the queue size.

TASK_004

  • Severity: low
  • HTTP Status: 409
  • Message: Task canceled: {task_id}. Reason: {reason}
  • Troubleshooting: The task was canceled by the user or the system. Please resend if necessary.

NODE Errors

NODE_001

  • Severity: medium
  • HTTP Status: 404
  • Message: Node not found: {node_id}
  • Troubleshooting: Please check the node ID. The node may be offline or deleted.

NODE_002

  • Severity: high
  • HTTP Status: 500
  • Message: Failed to register node: {reason}
  • Troubleshooting: Please check the node configuration and network connectivity.

NODE_003

  • Severity: medium
  • HTTP Status: 503
  • Message: Node health check failed: {node_id}. Status: {status}
  • Troubleshooting: Check node logs and resource usage. A restart of the node may be required.

NODE_004

  • Severity: low
  • HTTP Status: 503
  • Message: Node is inactive: {node_id}. Last seen: {last_seen}
  • Troubleshooting: Node is not sending heartbeats. Check node status and connectivity.

How to use

Usage in Python code

<!-- from evospikenet.error_messages import ErrorMessages, format_error_response -->

# Get error message
error_info = ErrorMessages.get("MODEL_001", model_id="my_model", lang="en")
print(error_info["message"])  # "Model not found: my_model"

# Get error message (Japanese)
error_info = ErrorMessages.get("MODEL_001", model_id="my_model", lang="ja")
print(error_info["message"])  # "Model not found: my_model"

# Format for API responses
response = format_error_response("DB_001", error="Connection timeout", lang="ja")

Usage with FastAPI

from fastapi import HTTPException
<!-- TODO: update or remove - import fail<!-- Remember: Automatic conversion not possible — please fix manually -->ort ErrorMessages, get_http_status -->

@app.get("/models/{model_id}")
async def get_model(model_id: str):
    if model_id not in models:
        error_info = ErrorMessages.get("MODEL_001", model_id=model_id, lang="ja")
        raise HTTPException(
            status_code=error_info["http_status"],
            detail=error_info
        )
    return models[model_id]

List of errors by category

<!-- Module 'evospikenet' not found. Check moves/renames within the package -->
<!-<!-- Remember: Unable to auto-convert — please fix manually -->List of Dell-related errors
model_errors = ErrorMessages.list_by_category(ErrorCategory.MODEL)
for code, template in model_errors.items():
    print(f"{code}: {template.message_en}")

Document generation

<!-- TODO: update<!-- Module 'evospikenet' not found. Please check moves/renames in the package -->kenet.error_messages import <!-- Remember: Cannot convert automatically — please fix manually -->ang="ja")
with open("docs/ERROR_MESSAGES.md", "w") as f:
    f.write(doc_ja)

# English document generation
doc_en = ErrorMessages.export_documentation(lang="en")
with open("docs/ERROR_MESSAGES.en.md", "w") as f:
    f.write(doc_en)

Best practices

1. Select the appropriate error code

  • Select the category that best suits the nature of the error
  • Precisely set severity level
  • Use proper HTTP status codes

2. Parameterization of error messages

# ❌ Bad example: hard-coded messages
raise ValueError("Model test_model not found")

# ✅ Good example: parameterized messages
error_info = ErrorMessages.get("MODEL_001", model_id="test_model")
raise ModelNotFoundError(error_info["message"])

3. Utilize troubleshooting information

error_info = ErrorMessages.get("DB_001", error="timeout")
logger.error(f"{error_info['message']}")
logger.info(f"Troubleshooting: {error_info['troubleshooting']}")

4. Multilingual support

from fastapi import Request

def get_preferred_language(request: Request) -> str:
    """リクエストから優先言語を取得"""
    accept_lang = request.headers.get("Accept-Language", "en")
    return "ja" if accept_lang.startswith("ja") else "en"

@app.get("/api/data")
async def get_data(request: Request):
    lang = get_preferred_language(request)
    error_info = ErrorMessages.get("VAL_001", field="id", reason="Invalid format", lang=lang)
    # ...

Error code addition guide

If you want to add a new error code:

  1. Select the appropriate category

  2. Consider creating a new category if existing categories do not work.

  3. Determine the sequential number

  4. Check existing codes in category and use next number

  5. Create templatepython "NEW_001": ErrorMessageTemplate( code="NEW_001", category=ErrorCategory.NEW, severity=ErrorSeverity.MEDIUM, message_en="English message with {param}", message_ja="日本語メッセージ {param}", troubleshooting_en="English troubleshooting guide", troubleshooting_ja="日本語トラブルシューティングガイド", http_status=400 )

  6. Documentation updated

  7. Add new error to this document
  8. Includes code examples and use cases

Last updated: 2025/12/20

Version: 1.0.0