DM Champ Docs

واجهة برمجة تطبيقات قاعدة المعرفة

قاعدة معرفتك هي ما يقرأ منه الذكاء الاصطناعي. وهي تتكون من جزأين، وتغطي هذه الصفحة كلاً منهما:

  • مصادر المعرفة (/kb-sources): صفحات الويب والمستندات التي ترفعها إلى المنصة. تتم قراءة كل منها، وتقسيمها إلى أقسام، وتحويلها إلى أسئلة شائعة يمكن للذكاء الاصطناعي الخاص بك الإجابة عليها.
  • مجموعات المعرفة (/kb-groups): حزم مسمّاة من الأسئلة الشائعة التي يمكنك تطبيقها على وكيل (Agent) أو حملة في طلب واحد، بحيث يمكن إعادة استخدام المعرفة التي قمت بتنظيمها مسبقاً مع الوكيل التالي الذي تنشئه.

تستقر الأسئلة الشائعة التي ينتجها المصدر في نفس المكتبة التي توجد بها الأسئلة التي تكتبها يدويًا، لذا بمجرد انتهاء الاستيراد، يمكنك قراءتها وتعديلها وربطها باستخدام واجهة برمجة تطبيقات الأسئلة الشائعة.

جميع نقاط النهاية نسبية إلى https://api.dmchamp.com/v1 وتتطلب مفتاح API: راجع الوصول إلى API والمصادقة. الوصول إلى API ميزة مدفوعة؛ وبدونها، يتم رفض الطلبات مع 403. كل حقل، واستجابة، ورمز خطأ موجود في مرجع API؛ الأخطاء المشتركة موجودة في الأخطاء والترقيم.

الوكالات: تقبل كل نقطة نهاية في هذه الصفحة sub_account_id، لذا يمكنك بناء قاعدة معرفة للعميل داخل حسابهم الفرعي باستخدام مفتاح الوكالة الخاص بك. أرسله في نص الطلب على POST/PUT وكمعامل استعلام على GET/DELETE. راجع واجهة برمجة التطبيقات للوكالات.

الاستيراد يستهلك رصيداً. قراءة صفحة أو مستند وكتابة أسئلة شائعة منهما يستهلك رصيداً، يتناسب تقريباً مع حجم المحتوى الموجود. استخدم تقدير تكلفة الاستيراد قبل البدء بعملية زحف كبيرة.


كيف يعمل الاستيراد

الاستيراد هو مهمة في الخلفية، وليس عملية تنتهي أثناء انتظارك. تجيب كل نقطة نهاية للاستيراد فوراً (202) بـ source_id، وتقوم أنت باستطلاع حالة ذلك المصدر حتى ينتهي:

  1. بدء الاستيراد: POST /kb-sources/url (صفحة واحدة)، أو POST /kb-sources/file (مستند مرفوع)، أو POST /kb-sources/bulk-import (ما يصل إلى 100 صفحة).
  2. الاستطلاع: GET /kb-sources/{sourceId} حتى لا تعود الحالة status هي queued أو processing.
  3. قراءة الأسئلة الشائعة: عندما تكون الحالة ready، ستجد الإدخالات التي تم إنتاجها في مكتبة الأسئلة الشائعة الخاصة بك (GET /faqs).
الحالة ماذا تعني
queued في انتظار القراءة. لم يتم خصم أي رصيد بعد.
processing يتم قراءتها وتحويلها إلى أسئلة شائعة الآن.
ready انتهت. الأسئلة الشائعة موجودة في مكتبتك.
failed تعذر الاستيراد. يوضح error_message السبب.
cancelled تم إيقافها قبل قراءتها (راجع إيقاف استيراد).
paused تم إيقافها لأن مفتاح الذكاء الاصطناعي الخاص بك فشل في منتصف الاستيراد (راجع استئناف استيراد متوقف).
deleting عملية حذف جماعي تعمل عليها حالياً.
unknown السجل لا يحمل أي حالة. تعامل معه على أنه غير جاهز.

اربط أثناء الاستيراد. مرر autoLinkToAgentId في أي نقطة نهاية للاستيراد، وسيهبط المصدر، بالإضافة إلى كل سؤال شائع ينتجه، في معرفة ذلك الوكيل في نفس الطلب. يقوم autoLinkToCampaignId بنفس الشيء لحملة كلاسيكية. الربط هو محاولة بأفضل جهد: المعرف الذي لا وجود له، أو الذي ينتمي لحساب آخر، يتم تخطيه بصمت ويستمر الاستيراد، لذا تأكد من الربط عن طريق قراءة بيانات الوكيل مرة أخرى.


نقاط النهاية

المهمة الطريقة والمسار المرجع
استيراد صفحة ويب POST /kb-sources/url فتح في مرجع API
استيراد مستند مرفوع POST /kb-sources/file فتح في مرجع API
استيراد صفحات متعددة دفعة واحدة POST /kb-sources/bulk-import فتح في مرجع API
التحقق من مصدر GET /kb-sources/{sourceId} فتح في مرجع API
حذف مصدر DELETE /kb-sources/{sourceId} فتح في مرجع API
حذف مصادر متعددة دفعة واحدة POST /kb-sources/bulk-delete فتح في مرجع API
اكتشاف صفحات على موقع ويب POST /kb-sources/discover-pages فتح في مرجع API
تقدير تكلفة الاستيراد POST /kb-sources/estimate-cost فتح في مرجع API
إيقاف استيراد POST /kb-sources/cancel-import فتح في مرجع API
استئناف استيراد متوقف مؤقتاً POST /kb-sources/resume-import فتح في مرجع API
العثور على صفحات جديدة على موقع ويب POST /kb-sources/refresh-domain فتح في مرجع API
تحديث كل صفحة على موقع ويب POST /kb-sources/trigger-domain-refresh فتح في مرجع API
تتبع تحديث موقع ويب GET /kb-sources/domain-refresh-status فتح في مرجع API
إيقاف تحديث موقع ويب POST /kb-sources/refresh-domain/cancel فتح في مرجع API
تحديث مصدر واحد POST /kb-sources/{sourceId}/refresh فتح في مرجع API
اختيار الصفحات الأكثر صلة POST /kb-sources/select-relevant-pages فتح في مرجع API
إنشاء مجموعة معرفة POST /kb-groups فتح في مرجع API
إعادة تسمية مجموعة معرفة PUT /kb-groups/{groupId} فتح في مرجع API
حذف مجموعة معرفة DELETE /kb-groups/{groupId} فتح في مرجع API
إضافة سؤال شائع إلى مجموعة POST /kb-groups/{groupId}/faqs فتح في مرجع API
إزالة سؤال شائع من مجموعة DELETE /kb-groups/{groupId}/faqs/{faqId} فتح في مرجع API
تطبيق مجموعة على وكيل POST /kb-groups/{groupId}/apply-to-agent فتح في مرجع API
تطبيق مجموعة على حملة (كلاسيكية) POST /kb-groups/{groupId}/apply-to-campaign فتح في مرجع API

استيراد صفحة ويب

POST /kb-sources/url يضيف صفحة واحدة ويجيب بـ 202 مع source_id للاستطلاع.

curl -X POST "https://api.dmchamp.com/v1/kb-sources/url?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.com/pricing", "autoLinkToAgentId": "ag7HkQ2ZpLxR3mNb" }'
{ "success": true, "source_id": "kb_src_abc123", "status": "queued", "batch_id": "batch_9f2a" }
  • إذا كانت الصفحة نفسها موجودة بالفعل في قاعدة معرفتك، فلن يتم وضع أي شيء جديد في قائمة الانتظار: ستحصل على 200 مع status: "exists" وskipped_duplicate: 1، وسيظل الربط التلقائي الذي طلبته مطبقاً على المصدر الموجود.
  • يجب أن يكون url عنوان http أو https كاملاً.

استيراد مستند مرفوع

POST /kb-sources/file يضيف مستنداً موجوداً بالفعل في مساحة تخزين ملفات حسابك. الأنواع المدعومة: PDF، DOCX، TXT، MD، CSV و XLSX. يتم اكتشاف نوع الملف من الامتداد في filename.

  • نقطة النهاية هذه لا تحمل الملف. لا يوجد رفع متعدد الأجزاء (multipart)، ولا نص base64، ولا تنزيل من رابط: أنت ترسل موقع تخزين ملف موجود بالفعل. يجب أن يبدأ storage_path بـ users/{your user id}/uploads/، وإلا سيتم رفض الطلب بـ 403. تضع لوحة التحكم الملفات هناك عندما تقوم بسحبها وإفلاتها. إذا لم تكن لديك طريقة لوضع ملف هناك، استخدم استيراد صفحة ويب بدلاً من ذلك.
curl -X POST "https://api.dmchamp.com/v1/kb-sources/file?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "storage_path": "users/abc123uid/uploads/handbook.pdf",
    "filename": "handbook.pdf",
    "mime_type": "application/pdf",
    "autoLinkToAgentId": "ag7HkQ2ZpLxR3mNb"
  }'

التحقق من مصدر

GET /kb-sources/{sourceId} هو الاستطلاع الذي يتبع كل عملية استيراد وتحديث. كرره حتى تصبح الحالة ready أو failed.

curl "https://api.dmchamp.com/v1/kb-sources/kb_src_abc123?apiKey=YOUR_API_KEY"
{ "success": true, "source_id": "kb_src_abc123", "status": "ready", "faq_count": 24, "section_count": 31, "error_message": null }

حذف مصدر

DELETE /kb-sources/{sourceId} يزيل مصدراً واحداً. افتراضياً، يتم الاحتفاظ بالأسئلة الشائعة التي أنتجها؛ أضف delete_faqs=true لإزالتها أيضاً (خلاف ذلك، يكون faqs_deleted الخاص بالاستجابة هو 0).

حذف مصادر متعددة دفعة واحدة (POST /kb-sources/bulk-delete، حتى 2000 معرف لكل طلب) يعمل في الخلفية ويرسل إليك بريداً إلكترونياً عند انتهائه. هو يزيل الأسئلة الشائعة دائماً أيضاً؛ لا يوجد خيار للاحتفاظ بها. domainLabel هو مجرد اسم ودي لذلك البريد الإلكتروني.


استيراد صفحات متعددة دفعة واحدة

POST /kb-sources/bulk-import يضيف ما يصل إلى 100 صفحة لكل طلب. وهو المتابعة المعتادة لـ اكتشاف صفحات على موقع ويب أو العثور على صفحات جديدة على موقع ويب. استطلع كل معرف في queued_source_ids باستخدام التحقق من مصدر.

curl -X POST "https://api.dmchamp.com/v1/kb-sources/bulk-import?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": ["https://example.com/pricing", "https://example.com/faq"],
    "autoLinkToAgentId": "ag7HkQ2ZpLxR3mNb"
  }'
{ "success": true, "batch_id": "batch_9f2a", "queued": 2, "skipped_duplicate": 0, "queued_source_ids": ["kb_src_abc123", "kb_src_def456"] }

معلومات مفيدة:

  • يتم تخطي التكرارات، ولا يتم استيرادها مرتين، وتظل مرتبطة بالوكيل (Agent) عندما تطلب ذلك.
  • حد الصفحات. يمكن أن يحتوي حسابك على ما يصل إلى 5,000 صفحة في انتظار الاستيراد في وقت واحد، بما في ذلك الصفحات الموجودة بالفعل في قائمة الانتظار أو التي يجري قراءتها. أي طلب يتجاوز هذا الحد يتم رفضه مع 400 و error_code: kb_import_page_limit، ولا يتم وضع أي شيء من ذلك الطلب في قائمة الانتظار. تتطلب عمليات الاستيراد التي تزيد عن 5,000 صفحة موافقة: اتصل بالدعم لرفع هذا الحد.
  • التحقق من الرصيد مسبقاً. يتم رفض أي عملية استيراد لا يمكن لحسابك دفع تكلفتها قبل وضع أي شيء في قائمة الانتظار، مع 402 و error_code: kb_import_insufficient_credits (بالإضافة إلى required_credits و available_credits و waiting_pages). تُحتسب كل صفحة كجزء واحد (chunk) على الأقل، كما تُحتسب الصفحات التي تنتظر بالفعل، لأنها لا تُخصم إلا عند معالجتها. الحسابات التي تستخدم التعبئة التلقائية لا يتم رفضها بسبب رصيدها. الحسابات التي تستخدم مفتاح الذكاء الاصطناعي الخاص بها لا يتم رفضها أيضاً، إلا إذا كانت تعمل على فئة Max، والتي يتم محاسبتها بالرصيد. بالنسبة للحساب الفرعي، available_credits هي null.
  • أكثر من 100 صفحة تعني عدة طلبات. أرسل حجم التحديد بالكامل كـ plannedTotal في الطلب الأول، بحيث يغطي حد الصفحات والتحقق من الرصيد التحديد بالكامل، ويتم رفض عملية الاستيراد التي لا يمكن إكمالها قبل وضع أي صفحة في قائمة الانتظار، بدلاً من التوقف في منتصف الطريق. الطلب الأول المقبول يُرجع import_session: أرسله كـ importSession في كل طلب لاحق لهذا التحديد. تتخطى تلك الطلبات بعد ذلك التحقق المسبق من الرصيد لما يصل إلى العدد المعتمد من الصفحات، لمدة ساعة واحدة. لا يزال حد الصفحات سارياً، ولا تزال كل صفحة تُخصم عند معالجتها. بدون جلسة (أو بمجرد انتهاء صلاحيتها أو استهلاك صفحاتها) يحصل كل طلب على التحقق العادي. يتم تجاهل علامة continuesImport القديمة.

اكتشاف الصفحات على موقع ويب

POST /kb-sources/discover-pages تستكشف موقعاً من عنوان بداية واحد وتسرد الصفحات التي تجدها على نفس النطاق، مع نصيحة لكل منها حول ما إذا كانت تستحق الاستيراد. لا يتم استيراد أي شيء ولا يتم تحديد أي شيء لك.

curl -X POST "https://api.dmchamp.com/v1/kb-sources/discover-pages?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.com", "maxPages": 100 }'
{
  "success": true,
  "source_type": "sitemap",
  "pages": [
    { "url": "https://example.com/pricing", "title": "Pricing", "depth": 1, "score": 95, "recommendation": "add", "reason_key": "core_page" }
  ]
}
  • تحصل كل صفحة على score (من 0 إلى 100) و recommendation: add (نتيجة 90 أو أعلى)، maybe (حدية) أو skip (سجلات التغيير، الصفحات القانونية، الترجمات المكررة). reason_key هو سبب ثابت يمكن للآلة قراءته، على سبيل المثال core_page أو changelog_history أو legal_page أو locale_duplicate.
  • maxPages تفتراضي هو حد الاستيراد الخاص بك (5,000) ولا يمكن أن يكون أعلى؛ يتم رفض القيمة الأعلى مع 400 و kb_import_page_limit. لا يتجاوز الاستكشاف أبداً 10,000 صفحة. عندما يحتوي الموقع على صفحات أكثر من الحد، تكون limit_reached هي true ولا يتم إرجاع سوى أول max_pages.
  • الاستكشاف هو أفضل جهد ممكن. إذا تعذرت قراءة الموقع، تظل الاستجابة 200، مع success: false، وقائمة pages فارغة، و error. تحقق من success قبل قراءة pages.

تقدير تكلفة الاستيراد

POST /kb-sources/estimate-cost تحسب الرصيد الذي ستستهلكه عملية استيراد مقترحة. يتم جلب الصفحات وقراءة المستندات لقياس حجمها، ولكن لا يتم استيراد أي شيء ولا يستهلك التقدير نفسه أي رصيد. أرسل urls، أو files (تم تحميله بالفعل)، أو كليهما؛ مرر tier ليتطابق التقدير مع فئة جودة الذكاء الاصطناعي التي ستتم محاسبتك عليها.

curl -X POST "https://api.dmchamp.com/v1/kb-sources/estimate-cost?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "urls": ["https://example.com/pricing"] }'
{
  "success": true,
  "estimates": [{ "ref": "https://example.com/pricing", "chunks": 7, "credits": 7 }],
  "total_credits": 7, "affordable": true, "available_credits": 120,
  "waiting_pages": 0, "max_affordable_chunks": 120
}
  • يعكس كل صف في ref عنوان URL الخاص بك أو مسار التخزين. الصفحة أو الملف الذي تعذرت قراءته لا يزال يحصل على صف، ويُحتسب كجزء واحد (chunk)، مع error عليه.
  • affordable تحسب الصفحات التي تنتظرها بالفعل (waiting_pages). لتقدير تحديد كبير في عدة طلبات، قارن الإجمالي الجاري بـ max_affordable_chunks، أو أرسل أجزاء الطلبات السابقة كـ prior_chunks (فهي تُحتسب فقط ضمن affordable).
  • max_affordable_chunks تكون null عندما لا يقيدك رصيدك (تعبئة تلقائية، أو مفتاح الذكاء الاصطناعي الخاص بك تحت فئة Max)، وتكون دائماً null للحساب الفرعي، الذي يحصل على affordable فقط و null available_credits.

إيقاف عملية استيراد

POST /kb-sources/cancel-import توقف الصفحات التي لا تزال تنتظر في قائمة الانتظار، لعملية زحف تبين أنها أكبر من المتوقع. مرر host (على سبيل المثال docs.example.com) لإيقاف ذلك الموقع فقط؛ اتركها فارغة لإيقاف كل عمليات الاستيراد المنتظرة في الحساب.

  • إلغاء صفحة منتظرة لا يكلف شيئاً، لأنها لم تُقرأ بعد.
  • الصفحات التي يجري معالجتها بالفعل لا يتم إيقافها: عملها قيد التنفيذ وتُخصم تكلفتها في كلتا الحالتين. تبلغ الاستجابة عنها كـ in_flight بجانب cancelled.

استئناف عملية استيراد متوقفة مؤقتاً

POST /kb-sources/resume-import تعيد تشغيل عملية استيراد تم إيقافها مؤقتاً لأن مفتاح الذكاء الاصطناعي الخاص بك توقف عن العمل (اختيارياً لموقع واحد فقط host).

  • الاتصال بها يعتبر موافقتك على إنهاء الاستيراد باستخدام أي مفتاح نشط حالياً، مما قد يعني إنفاق رصيد المنصة إذا كان مفتاحك الخاص لا يزال معطلاً.

الحفاظ على تحديث الموقع الإلكتروني

ثلاثة طلبات منفصلة، لذا فإن البحث لا يكلف شيئاً:

  1. العثور على صفحات جديدة على موقع إلكتروني (POST /kb-sources/refresh-domain) تستكشف موقعاً استوردت منه بالفعل وتُبلغ فقط عن الصفحات التي ليست في قاعدة معرفتك بعد، مع نفس نصيحة الاستكشاف. لا يتم استيراد أو تغيير أي شيء. استورد الصفحات التي تريدها باستخدام استيراد العديد من الصفحات دفعة واحدة.
  2. تحديث كل صفحة على موقع إلكتروني (POST /kb-sources/trigger-domain-refresh) تعيد قراءة كل صفحة استوردتها بالفعل من ذلك الموقع: يتم تحديث الأقسام المتغيرة، وإضافة أقسام جديدة، وإسقاط الأقسام المحذوفة. تضع العمل في قائمة الانتظار وتعود على الفور.
  3. تتبع تحديث الموقع الإلكتروني (GET /kb-sources/domain-refresh-status?baseUrl=...) تعرض التقدم، و إيقاف تحديث الموقع الإلكتروني (POST /kb-sources/refresh-domain/cancel) توقف العملية.

baseUrl يمكن أن يكون أي عنوان على الموقع، أو مجرد المضيف (host).

curl -X POST "https://api.dmchamp.com/v1/kb-sources/trigger-domain-refresh?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "baseUrl": "https://example.com" }'

curl "https://api.dmchamp.com/v1/kb-sources/domain-refresh-status?baseUrl=https://example.com&apiKey=YOUR_API_KEY"
{ "success": true, "job": { "domainBatchId": "job_7c1e", "total": 249, "pending": 28, "succeeded": 219, "failed": 2, "status": "refreshing" } }

معلومات مفيدة:

  • العثور على صفحات جديدة لا يضع أي شيء في قائمة الانتظار. new_urls_queued تكون دائماً 0 (تم الاحتفاظ بها للتوافق مع الإصدارات السابقة)، و existing_refresh_queued تحسب فقط الصفحات التي لديك بالفعل والتي هي جاهزة لإعادة القراءة. مثل الاستكشاف، تفشل بهدوء (200، success: false، new_pages فارغة) وتستخدم نفس حدود الصفحات.
  • التقدم: الصفحات المنتهية هي total ناقص pending. تتحرك مهمة status عبر refreshing، ثم deduplicating (تمريرة التنظيف في النهاية)، ثم completed أو failed أو cancelled نهائية. job تكون null عندما لا يتم تشغيل أي تحديث لذلك الموقع. احتفظ بـ domainBatchId: فهي jobId التي تمررها لطلب الإلغاء.
  • الإيقاف: الصفحات التي انتهت بالفعل تحتفظ بمحتواها المحدث، والصفحات التي لم تبدأ تُسقط، والصفحات التي يجري إعادة قراءتها تعود إلى حالتها السابقة (sources_reset)؛ الصفحات الجديدة تماماً لهذا التحديث التي كانت لا تزال في قائمة الانتظار يتم إلغاؤها (sources_cancelled). الإلغاء مرتين غير ضار. بمجرد وصول التحديث إلى تمريرة التنظيف، لا يمكن إيقافه بعد الآن: تكون الاستجابة success: false مع reason: "already_finalizing".

تحديث مصدر واحد (POST /kb-sources/{sourceId}/refresh) تعيد قراءة صفحة واحدة استوردتها بالفعل بنفس الطريقة، وتجيب بـ 202؛ استعلم عنها باستخدام التحقق من مصدر.

اختيار الصفحات الأكثر صلة

POST /kb-sources/select-relevant-pages يطلب من الذكاء الاصطناعي اختيار الصفحات الخمس، من بين urls المرشحة الخاصة بك، التي تصف بشكل أفضل النشاط التجاري الكامن وراء homeUrl. يُستخدم هذا عند إنشاء دليل حملة من موقع ويب، وهو يستهلك رصيداً. إنه أداة مساعدة وليس مورداً: عند الفشل، فإنه لا يزال يجيب بـ 200 مع success: false، وقائمة pages فارغة، وerror.


مجموعات المعرفة

تُعد مجموعة المعرفة حزمة مسماة من الأسئلة الشائعة (“الشحن والإرجاع”، “الإعداد”) التي يمكنك تطبيقها على وكيل أو حملة في مكالمة واحدة. تحتفظ المجموعة بمراجع، وليس نسخاً: تظل الأسئلة الشائعة في مكتبتك الموحدة، لذا فإن تعديل أحدها باستخدام واجهة برمجة تطبيقات الأسئلة الشائعة يؤدي إلى تحديثه في كل مكان يُستخدم فيه.

  • تبدأ المجموعة الجديدة فارغة. أضف سؤالاً شائعاً إلى مجموعة باستخدام faq_id الخاص بها.
  • إضافة سؤال شائع إلى مجموعة يغير الحزمة فقط؛ ولا يربط السؤال الشائع بأي وكيل. طبق مجموعة على وكيل للقيام بذلك.
  • التطبيق دائماً يضيف ما هو مفقود فقط، لذا فإن تطبيق نفس المجموعة مرتين غير ضار: added_count يكون 0 عندما تكون المجموعة فارغة أو مطبقة بالفعل.
  • إزالة سؤال شائع من مجموعة لا يحذف السؤال الشائع، والوكلاء الذين تم تطبيق المجموعة عليهم بالفعل يحتفظون به. حذف مجموعة يزيل الحزمة فقط؛ تظل أسئلتها الشائعة في مكتبتك ويحتفظ بها أي شيء تم تطبيقها عليه. إعادة التسمية تترك الأسئلة الشائعة دون تغيير.
  • في الحساب القائم على الوكيل، استخدم مكالمة الوكيل؛ مكالمة الحملة هي إصدار الحملة الكلاسيكية.

إضافة سؤال شائع إلى مجموعة

curl -X POST "https://api.dmchamp.com/v1/kb-groups/kbg_abc123/faqs?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "faq_id": "aBcD1234eFgH5678" }'

تطبيق مجموعة على وكيل

curl -X POST "https://api.dmchamp.com/v1/kb-groups/kbg_abc123/apply-to-agent?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "agent_id": "ag7HkQ2ZpLxR3mNb" }'
{ "success": true, "group_id": "kbg_abc123", "agent_id": "ag7HkQ2ZpLxR3mNb", "added_count": 12 }

الأخطاء

الحالة متى يحدث ذلك في نقطة نهاية قاعدة المعرفة
400 حقل مطلوب مفقود أو غير صالح: url فارغ، أو baseUrl أو jobId مفقود، أو أكثر من 100 رابط في استيراد مجمع، أو أكثر من 2000 معرف في حذف مجمع، أو نوع ملف لا يمكننا قراءته، أو تجاوز حد الصفحة (kb_import_page_limit).
402 لا يوجد رصيد كافٍ لتشغيل الاستيراد (kb_import_insufficient_credits). اشحن رصيدك وحاول مرة أخرى.
403 storage_path خارج مجلد التحميلات الخاص بك، أو أن خطتك لا تتضمن الوصول إلى واجهة برمجة التطبيقات.
404 لم يتم العثور على المصدر أو المجموعة أو السؤال الشائع أو الوكيل أو الحملة أو مهمة التحديث: فهي غير موجودة أو تنتمي إلى حساب آخر.

الإخفاقات البسيطة ليست أخطاء. يجيب الاكتشاف (discover-pages، refresh-domain) وأداة اختيار الصفحات المساعدة بـ 200 مع success: false وerror عندما يتعذر قراءة موقع الويب. تحقق دائماً من success قبل قراءة البيانات.


ذات صلة