تخط وانتقل إلى المحتوى الرئيسي

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

ملخص

يسير هذا المقالك خلال كيفية إعداد إجراء API REST في Wati. ستتعلم كيفية اختيار المحفز الصحيح ، واختيار نوع حدث إذا لزم الأمر ، وإضافة الإجراء إلى تعليمات وكيلك الاصطناعي بشكل صحيح حتى يعمل كما هو متوقع.

ملاحظة: يتوفر إجراء REST API لعملاء Astra المشتركين في خطة Business فقط.

الإرشادات

يعمل إجراء API REST فقط عند تكوينه بشكل صحيح وإضافته إلى تعليمات وكيلك الاصطناعي. يتضمن عملية التثبيت 3 خطوات رئيسية:

  1. اختر كيفية تشغيل الإجراء

  2. حدد نوع حدث (إذا كان مطبقًا)

  3. أضف إجراء API REST إلى تعليمات وكيلك الاصطناعي

اتبع الخطوات أدناه لإكمال الإعداد.

الخطوة 1: اختر نوع محفز

عند إنشاء إجراء API REST ، يكون القرار الأول هو كيفية تشغيله.

توجد أنواع محفزات متاحة:

محفز قائم على القصد

يستخدم هذا المحفز عندما تريد تشغيل الإجراء بناءً على ما يقوله المستخدم.

  • يتم تشغيله عند اكتشاف وكيلك الاصطناعي لقصد المستخدم المحدد أثناء محادثة

  • مفيد للإجراءات مثل إرسال البيانات عندما يطلب المستخدم تجربة أو يشارك اهتمامه

سلوك المعاملات: يمكن استخدام المحلول الوهمي الديناميكي لتكوين API.

وضع المحفز: يدعم حاليًا agent_decides فقط. هذا يعني أن وكيلك الاصطناعي يحدد متى يجب تنفيذ الإجراء بناءً على سياق المحادثة.

محفز قائم على الحدث

يعمل هذا المحفز تلقائيًا عند حدوث حدث محدد مسبقًا.

  • يتم تشغيله دون الاعتماد على قصد المستخدم

  • مفيد للإجراءات الموجهة بالنظام مثل ملاحظات الإرسال أو إرسال النماذج

الخطوة 2: حدد نوع حدث (حسب الحدث فقط)

إذا اخترت الحدث كنوع محفز ، يجب عليك اختيار واحد من أنواع الأحداث المدعومة.

يدعم Astra حاليًا أنواع الأحداث التالية:

استلام ملاحظات إيجابية (إبهام للأعلى)

  • يتم تشغيله عند النقر على خيار الإبهام للأعلى

  • يدعم المعاملات الثابتة فقط

استلام ملاحظات سلبية (إبهام لأسفل)

  • يتم تشغيله عند النقر على خيار الإبهام لأسفل

  • يدعم المعاملات الثابتة فقط

إرسال النموذج

  • يتم تشغيله عند إرسال المستخدم لنموذج مخصص

  • يدعم المعاملات الديناميكية المرسلة من حقول النماذج

استحصال رصيد

  • يتم تشغيله عند جمع معلومات الرصيد خلال محادثة

  • يستخدم هيكل جسم الطلب الثابت

اختر نوع الحدث الذي يطابق بشكل أفضل وقت تشغيل إجراء API REST.

الخطوة 3: أضف إجراء API REST إلى تعليمات وكيلك الاصطناعي

إنشاء إجراء API REST لا يكفي بمفرده. لن يعمل الإجراء حتى يُضاف إلى تعليمات وكيلك الاصطناعي.

مطلوب لجميع إجراءات API REST

  • أضف إجراء API REST إلى تكوين تعليمات وكيلك

إذا لم يتم تضمين الإجراء في التعليمات ، فلن يتم تشغيله أبدًا.

متطلب إضافي لـ "إرسال النموذج"

إذا كنت تستخدم نوع حدث إرسال النموذج ، هناك متطلب إضافي:

  • يجب عليك أيضًا إضافة النموذج المخصص المرتبط إلى تعليمات الوكيل

  • يجب تضمين إجراء API REST ونموذج مخصص

إذا كان أي منهما مفقودًا ، لن يتم تشغيل إجراء API REST بشكل صحيح.

هنا نظرة عامة سريعة على ما يجب تناوله حسب نوع الحدث:

نوع الحدث

ماذا تدمج

إبهام للأعلى / إبهام لأسفل

إجراء API REST فقط

إرسال النموذج

إجراء API REST + نموذج مخصص

استحصال رصيد

إجراء API REST فقط

قصد

إجراء API REST فقط

قائمة التحقق النهائية

قبل نشر وكيلك الاصطناعي ، تأكد من أن:

  • تم اختيار نوع محفز

  • تم اختيار نوع حدث (إذا كان قائمًا على الحدث)

  • تم إضافة إجراء API REST إلى تعليمات الوكيل

  • تم إضافة النموذج المخصص عند استخدام إرسال النموذج

بمجرد إكمال جميع هذه الخطوات ، يكون إجراء API REST جاهزًا للتشغيل تلقائيًا أثناء المحادثات.

هل أجاب هذا عن سؤالك؟