أنشئ أداة API
أضف أداة تستدعي نقطة الاتصال الخاصة بك على الويب، واربطها بوكيل، واختبرها.
ما الذي ستحققه
ستنشئ أداة مثل «البحث عن حالة طلب»، وتربطها بوكيل، وتراها تعمل.
المتطلبات المسبقة
- نقطة اتصال على الويب يمكن الوصول إليها من الإنترنت (ليست عنوانًا خاصًا أو localhost)، وتعيد JSON أو نصًا.
- دور owner أو admin.
الإعداد خطوة بخطوة
- افتح Tools في الشريط الجانبي واختر Add tool.
- في New tool، املأ:
- Name: ما يراه النموذج، لذا سمِّها باسم الإجراء، مثل
lookup_order. وتتحول المسافات إلى شرطات سفلية والحروف إلى صغيرة. - Description: كيف يقرر النموذج متى يستدعيها، مثل "Look up the delivery status of an order".
- Method: GET أو POST أو PUT أو PATCH أو DELETE.
- API endpoint: مثل
https://api.yoursite.com/orders/{order_id}. ضع اسمًا بين أقواس معقوفة لإدراجه في المسار.
- Name: ما يراه النموذج، لذا سمِّها باسم الإجراء، مثل
- اختر Create tool. تُفتح صفحة الأداة نفسها لإدخال التفاصيل: المعاملات والمصادقة والحدود.
- أضف كل Parameter يجب أن يقدّمه النموذج (راجع الدليل التالي)، واضبط Authentication إذا كانت نقطة الاتصال تحتاجها، واختر Save changes.
- اربطها بوكيل: افتح الوكيل، تبويب Tools، Your tools، Add tool، Existing tool، حدّدها واختر Add tool. أو اختر New tool هناك لإنشائها وربطها في خطوة واحدة (Create and add).
- اضغط Save في الوكيل إذا عرض تغييرات غير محفوظة.
صفحة الأداة، قسمًا قسمًا
| القسم | ما يحتويه |
|---|---|
| What it does | Description: "Tells the model when to call this tool." |
| When it runs | Run in the background: هل ينتظر الوكيل الأداة أم يواصل الحديث. |
| Endpoint | Method وURL. ضع {param} في المسار، مثل /orders/{order_id}. |
| Body template | JSON اختياري لـ POST وPUT وPATCH. وإذا كان فارغًا تُرسَل المعاملات كـ JSON. |
| Read this from the response | مسار منقّط مثل data.status. وإذا كان فارغًا يُعاد كل شيء. |
| Parameters | ما يجب أن يقدّمه النموذج، ويُتحقَّق منه قبل كل طلب. |
| Authentication | Type وSent as وName والسرّ. |
| Limits | Timeout وAttempts. |
| Test | جرّب الأداة بقيم نموذجية. |
كيف يُبنى الطلب
- المسار. يُستبدل
{order_id}في العنوان بالقيمة، مشفّرة لعناوين URL. - GET وDELETE. تُرسَل المعاملات غير المستخدمة في المسار كسلسلة استعلام.
- POST وPUT وPATCH. تُرسَل المعاملات كنص JSON، أو تملأ Body template لديك.
- لا تُتَّبَع إعادة التوجيه، وتُحدَّد الاستجابات بسقف 1 ميغابايت، وتُرفَض العناوين الخاصة أو الداخلية.
الاختبار
استخدم Test في صفحة الأداة (راجع اختبر الأدوات وأصلح أعطالها)، ثم Talk مع الوكيل واطلب ما تفعله الأداة.
النتيجة المتوقعة
يجيب الوكيل مستخدمًا نتيجة الأداة، ويعرض صف الأداة في صفحة Tools طلبًا محسوبًا ناجحًا.
استكشاف الأخطاء
- A tool named '…' already exists. الأسماء فريدة في مساحة العمل.
- لا يستدعيها الوكيل أبدًا. حسّن Description، واذكر الأداة في تعليمات النظام.
- راجع إخفاقات الأدوات.
أدلة ذات صلة
هل في هذه الصفحة ما لا يطابق ما تراه في لوحة التحكم؟ أخبرنا.