مستندات فنی

سه API استاندارد پلتفرم هوش‌یار

معماری API-First یعنی هر قابلیت پلتفرم از طریق REST و gRPC در دسترس است و رابط کاربری صرفاً یک کلاینت روی همین APIها ساخته شده.

بارگذاری و اینجست سند

دریافت اسناد ورودی، OCR دوزبانه و قطعه‌بندی معنایی، و ثبت در پایگاه دانش سه‌گانه.

POST /v1/documents/ingest

استخراج ساختاریافته

استخراج فیلدها و داده‌های ساختاریافته از سند، با خروجی JSON اعتبارسنجی‌شده.

POST /v1/documents/extract

بازیابی و RAG با استناد رسمی

پرسش زبان طبیعی با پاسخ مستند: شناسه‌ی سند، شماره‌ی صفحه و نقل‌قول برای هر جمله.

POST /v1/query

نمونه‌ی پاسخ

فرمت خروجی JSON ساختاریافته

هر پاسخ به‌صورت اجباری از طریق Function Calling / Instructor / Outlines ساختاریافته می‌شود تا قابل اعتبارسنجی خودکار باشد.

{
  "answer": ""...متن پاسخ..."",
  "citations": [
    {
      "document_id": "doc_18422",
      "page": 14,
      "quote": "...نقل‌قول دقیق از سند..."
    }
  ],
  "confidence": 0.94,
  "tenant_id": "org_4471"
}

مشخصات فنی

پروتکل‌ها و امنیت

مورد	مشخصات
پروتکل	`REST` و `gRPC`
فرمت پاسخ	JSON ساختاریافته با استناد اجباری
امنیت دسترسی	فیلترینگ ACL در زمان بازیابی (Retrieval-time ACL)
چندمستأجری	Strict Multi-Tenancy با Row-Level Security
احراز هویت	توکن API به‌ازای هر سازمان/مستأجر

دسترسی به کلید API

برای دریافت کلید API و مستندات کامل نسخه‌بندی‌شده، با تیم فنی هوش‌یار در تماس باشید.

درخواست دسترسی