Get Ocr Health

client.admin.getOcrStatus(?): AdminGetOcrStatusResponse { status, device, error_message, 3 more }

GET/api/v1/admin/ocr/statusz

Get OCR service health status including GPU availability.

ReturnsExpand Collapse

AdminGetOcrStatusResponse { status, device, error_message, 3 more }

Response model for OCR service health/GPU status.

status: "degraded" | "ok" | "unavailable"

One of the following:

"degraded"

"ok"

"unavailable"

device?: string

error_message?: string | null

gpu_available?: boolean

gpu_device_count?: number | null

gpu_device_name?: string | null

Get Ocr Health

import LlamaCloudAdmin from '@llamaindex/llama-cloud-admin';

const client = new LlamaCloudAdmin({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const response = await client.admin.getOcrStatus();

console.log(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"
}