← بازگشت به فهرست ATP
سلامت سرویس

بررسی سلامت سرویس (GET /health)

GET /health مشاهده در Swagger

ATP - بررسی سلامت سرویس (GET /health)

Endpoint

GET /health

هدف آزمون

بررسی وضعیت سرویس گردش‌کار هوش مصنوعی و پیکربندی LLM.

شرایط آزمون

فرآیند آزمون

  1. ارسال درخواست GET به /health
  2. دریافت پاسخ JSON
  3. بررسی فیلدهای status، service، llm_provider و api_key_configured

معرفی ویژگی

endpoint سلامت برای probeهای Docker/Kubernetes و مانیتورینگ عملیاتی. وضعیت ارائه‌دهنده LLM و مدل استخراج را گزارش می‌کند.

سناریوی آزمون

سناریو 1: مسیر موفق — سرویس سالم

  1. ارسال GET /health
  2. دریافت کد 200
  3. بررسی status: "ok" و service: "patent-genie-ai-workflow"
  4. بررسی api_key_configured: true در محیط پیکربندی‌شده

سناریو 2: خطا — کلید API تنظیم نشده

  1. اجرای سرویس بدون AVALAI_API_KEY یا OPENAI_API_KEY
  2. ارسال GET /health
  3. دریافت کد 200 با api_key_configured: false
  4. endpointهای استخراج و prior-art باید 503 برگردانند

سناریو 3: پیکربندی ارائه‌دهنده OpenAI

  1. تنظیم LLM_PROVIDER=openai و OPENAI_API_KEY
  2. ارسال GET /health
  3. بررسی llm_provider: "openai"
  4. بررسی api_key_configured: true

سناریو 4: متد پشتیبانی‌نشده

  1. ارسال POST /health
  2. دریافت کد 405
  3. بررسی وجود پاسخ استاندارد Method Not Allowed

قالب API

مولفه نوع نوع داده اجباری توضیحات
بدون پارامتر ورودی

Swagger

get:
  summary: Health check with LLM configuration status
  responses:
    200:
      description: Service status returned

نمونه ورودی

curl -X GET "http://127.0.0.1:8000/health" \
  -H "Accept: application/json"

نمونه خروجی

{
  "status": "ok",
  "service": "patent-genie-ai-workflow",
  "llm_provider": "avalai",
  "sectioned_extraction_model": "gemini-2.5-flash",
  "api_key_configured": true
}

Status Codes

نتیجه مورد انتظار

پاسخ JSON با فیلدهای status، service، llm_provider، sectioned_extraction_model و api_key_configured با کد HTTP 200.

روال صحت‌سنجی

  1. بررسی کد وضعیت 200
  2. بررسی فیلد service برابر "patent-genie-ai-workflow"
  3. بررسی llm_provider مطابق با متغیر محیطی
  4. بررسی api_key_configured مطابق با وجود کلید فعال

توضیحات