Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/JoseOlivares19/Proyecto-PC3-JavaScript-Avanzado/llms.txt

Use this file to discover all available pages before exploring further.

The /health endpoint provides a lightweight liveness check for the SmartStock360 Python AI service. It confirms the service is accepting requests and returns the exact set of model keys that were trained and registered during the application’s startup event. Integrate this endpoint into your load balancer health checks or monitoring dashboards to detect service restarts or failed model initialisation before issuing any prediction requests.

Endpoint

GET http://localhost:8001/health
No query parameters, path parameters, or request body are required.

Example Request

curl -X GET http://localhost:8001/health

Example Response

{
  "status": "ok",
  "modelos_cargados": [
    "utp-risk",
    "fraud-shield",
    "cyber-sentinel",
    "smart-stock",
    "talent-match"
  ]
}

Response Fields

status
string
required
Indicates whether the service is operational. Always returns "ok" when the process is reachable and all models have been loaded successfully.
modelos_cargados
array of strings
required
An ordered list of model keys that are currently loaded in memory and ready to serve prediction requests. Each key corresponds to one of the five /predict/* routes.
modelos_cargados always lists exactly the five model keys — utp-risk, fraud-shield, cyber-sentinel, smart-stock, and talent-match — because all five RandomForest classifiers are trained and registered together during the FastAPI startup event. If any model fails to train, the service will not start.

Build docs developers (and LLMs) love