zakkur-sdk
v1.0.4
Published
The official Enterprise AI SDK for Zakkur - Digital C-Suite and Decision Engine.
Maintainers
Readme
Zakkur AI Enterprise SDK 🚀
المحرك التنفيذي للقرارات المؤسسية الذكية (Digital C-Suite)
تم تصميم هذا الـ SDK لتمكين المطورين من دمج طاقم تنفيذي رقمي متكامل (C-Suite) داخل تطبيقاتهم، مما يسمح بأتمتة القرارات الاستراتيجية وتحليل البيانات المالية عبر ذكاء اصطناعي متخصص.
📌 فهرس المحتويات
- ✨ المميزات الرئيسية
- 📦 التثبيت
- 🛠️ التهيئة
- 🧠 دليل استخدام الوحدات
- 🔒 إدارة الجلسات
- ⚠️ معالجة الأخطاء
- 📜 مراجع الـ API السريعة
✨ المميزات الرئيسية
- 🏛️ Digital Boardroom: استدعاء كافة أعضاء المجلس (12 وكيلاً) بطلب واحد لتحليل القضايا المعقدة.
- 🤖 Dynamic Agent Proxy: وصول ذكي للوكلاء (CEO, CFO, CTO...) بأسلوب برمجي حديث وأنيق.
- 📚 RAG Integrated: ربط الوكلاء بقاعدة المعرفة المؤسسية (ملفات PDF و TXT).
- 🦾 Ops Execution Engine: تحويل القرارات إلى خطوات تنفيذية قابلة للربط مع الأدوات الخارجية.
- 🛡️ Enterprise Grade: دعم إعادة المحاولة تلقائياً (Retries) وإدارة المهلة الزمنية.
📦 التثبيت
يتطلب الـ SDK بيئة عمل Node.js إصدار 18 أو أحدث.
npm install zakkur-sdk
🛠️ التهيئة (Initialization)قم بإنشاء كائن من الفئة Zakkur باستخدام مفتاح الوصول الخاص بمؤسستك.JavaScriptconst Zakkur = require('zakkur-sdk');
const sdk = new Zakkur({
apiKey: 'zk_live_xxxxxxxxxxxxxxxx', // احصل عليه من بوابة المطورين
baseUrl: '[https://zakkur.com/api](https://zakkur.com/api)', // رابط السيرفر الخاص بك
timeout: 30000, // 30 ثانية
retries: 3 // عدد محاولات إعادة الطلب
});
🧠 دليل استخدام الوحدات1️⃣ وحدة مجلس الإدارة (The Board)تُستخدم لاتخاذ القرارات الكبرى التي تتطلب رؤية شاملة.JavaScript// استشارة كامل المجلس في قضية استراتيجية معقدة
const response = await sdk.board.consult("نخطط لتوسيع عملياتنا في السوق العالمي، ما هي المخاطر التقنية والمالية؟");
console.log("القرار التنفيذي:", response.data.final_decision.decision);
console.log("خارطة الطريق:", response.data.final_decision.action_items);
2️⃣ وحدة الوكلاء الديناميكية (Dynamic Agents)يمكنك التحدث مع أي مدير تنفيذي مباشرة بأسلوب برمجي حديث.JavaScript// استشارة المدير المالي (CFO) مباشرة
const financialReport = await sdk.agents.cfo.consult("قم بتحليل ميزانية الربع القادم");
// طلب مهمة تنفيذية من المدير التقني (CTO)
const codeTask = await sdk.agents.cto.execute("اكتب سكربت بايثون لتحليل بيانات العملاء بأمان");
3️⃣ وحدة المعرفة (Knowledge Base)تسمح لك بتغذية ذكاء زكور بملفات شركتك المؤسسية.JavaScript// رفع مستند جديد
const upload = await sdk.knowledge.upload(fileBuffer, 'HR_Policy_2026.pdf');
// عرض قائمة المستندات المتوفرة
const docs = await sdk.knowledge.list();
🔒 إدارة الجلسات (Contextual Threading)للحفاظ على سياق المحادثة وجعل الوكيل يتذكر تاريخ الحوار السابق.JavaScriptlet threadId = null;
// الطلب الأول
const step1 = await sdk.agents.ceo.consult("من هو عميلنا المثالي؟");
threadId = step1.threadId;
// الطلب الثاني (بنفس السياق المستمر)
const step2 = await sdk.agents.ceo.consult("وكيف يمكننا استهدافه بفاعلية؟", { threadId });
⚠️ معالجة الأخطاء (Error Handling)يوفر الـ SDK كلاس خاص ZakkurError لتسهيل عملية التصحيح.JavaScripttry {
const result = await sdk.board.consult("...");
} catch (error) {
if (error.name === 'ZakkurError') {
console.error(`Status: ${error.status}`); // مثل 403 أو 429
console.error(`Code: ${error.code}`); // AGENT_RESTRICTED
console.error(`Message: ${error.message}`);
} else {
console.error("خطأ غير متوقع في الشبكة");
}
}
🛡️ الصلاحيات والقيود[!IMPORTANT]باقة Startup: توفر الوصول إلى الوكلاء الأساسيين (CEO, CFO, CTO) فقط. للوصول لكامل الفريق، يرجى الترقية لباقة Enterprise.[!WARNING]الأمان: لا تقم أبداً بتضمين مفتاح الـ API في كود المتصفح العام (Client-side)؛ استخدم الـ SDK دائماً في بيئة خلفية آمنة (Backend).📜 مراجع الـ API السريعةالمسار البرمجيالوصفالمعاملات الأساسيةsdk.board.consult(text)قرار مجلس إدارة شاملtext (String)sdk.agents.[role].consult(text)استشارة وكيل متخصصprompt, optionssdk.agents.[role].execute(task)طلب مخرج عملي/تنفيذيtask, optionssdk.knowledge.upload(file)رفع ملف للذاكرة المؤسسيةfile, titlesdk.board.getHistory()استرجاع سجل القراراتلا يوجد📩 التواصل والدعمتم بناء هذا النظام لتمكين الأتمتة المؤسسية الذكية. لطلب الدعم التقني، تواصل مع فريق المطورين:📧 Email: [email protected]© 2026 Zakkur AI. All rights reserved.