Get Ocr Health

admin.get_ocr_status() -> AdminGetOcrStatusResponse

GET/api/v1/admin/ocr/statusz

Get OCR service health status including GPU availability.

ReturnsExpand Collapse

class AdminGetOcrStatusResponse: …

Response model for OCR service health/GPU status.

status: Literal["degraded", "ok", "unavailable"]

One of the following:

"degraded"

"ok"

"unavailable"

device: Optional[str]

error_message: Optional[str]

gpu_available: Optional[bool]

gpu_device_count: Optional[int]

gpu_device_name: Optional[str]

Get Ocr Health

import os
from llama_cloud_admin import LlamaCloudAdmin

client = LlamaCloudAdmin(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
response = client.admin.get_ocr_status()
print(response.status)

{
  "status": "degraded",
  "device": "device",
  "error_message": "error_message",
  "gpu_available": true,
  "gpu_device_count": 0,
  "gpu_device_name": "gpu_device_name"
}

Returns Examples

{
  "status": "degraded",
  "device": "device",
  "error_message": "error_message",
  "gpu_available": true,
  "gpu_device_count": 0,
  "gpu_device_name": "gpu_device_name"
}