Developer Knowledge API

توفّر واجهة برمجة التطبيقات Developer Knowledge API إمكانية الوصول الآلي إلى مستندات المطوّرين العامة من Google، ما يتيح لك دمج قاعدة المعلومات هذه في تطبيقاتك وسير عملك.

نظرة عامة

تم تصميم Developer Knowledge API لتكون المصدر الأساسي الذي يتيح الوصول إلى مستندات المطوّرين من Google بتنسيق قابل للقراءة آليًا. يوفّر هذا التطبيق وظائف للبحث عن المستندات واستردادها والإجابة عن الاستعلامات:

• SearchDocumentChunks للعثور على معرّفات الموارد المنتظمة (URI) الخاصة بالصفحات ذات الصلة ومقتطفات المحتوى استنادًا إلى طلب بحث
• GetDocument أو BatchGetDocuments لجلب المحتوى الكامل لنتائج البحث.
• AnswerQuery لإنشاء إجابات عن طلبات البحث المستندة إلى مجموعة مستندات.

تتيح واجهة Developer Knowledge API البحث عن صفحات المستندات واستردادها كملفات Markdown غير منظَّمة. يتم إدراج مجموعة المحتوى القابل للبحث في مرجع المحتوى.

طرق استخدام "معرفة المطوّر"

يمكنك الوصول إلى "معرفة المطوّرين" من خلال المساحات التالية حسب سير عملك:

• REST API وRPC API: يمكنك طلب نقاط نهاية HTTP أو gRPC مباشرةً. راجِع مرجع REST ومرجع RPC للاطّلاع على مواصفات الطرق.
• مكتبات البرامج: يمكنك دمج واجهة Developer Knowledge API في تطبيقاتك باستخدام مكتبات البرامج الرسمية للغات Python وNode.js وTypeScript وGo وJava وPHP وRuby.
• واجهة سطر الأوامر (CLI) في Google Cloud (gcloud): يمكنك تنفيذ أوامر gcloud developer-knowledge من المحطة الطرفية للبحث عن أجزاء من المستندات وجلب محتوى Markdown وإنشاء إجابات.
• خادم "بروتوكول سياق النموذج" (MCP) الخاص بـ Developer Knowledge: يمكنك ربط مساعد الترميز أو الوكيل المستند إلى الذكاء الاصطناعي بمستندات Google باستخدام أدوات "بروتوكول سياق النموذج" (search_documents وget_documents وanswer_query). يُرجى الرجوع إلى مرجع "بروتوكول سياق النموذج".

ملاحظة: إذا كنت تستخدم مساعد ترميز يعمل بالذكاء الاصطناعي، ثبِّت مهارة وكيل retrieving-developer-knowledge من خلال تنفيذ npx skills add google/skills --skill retrieving-developer-knowledge. توفّر هذه المهارة لمساعدك تعليمات مدمجة حول أداة خادم MCP الخاصة بـ Developer Knowledge التي يجب اختيارها، وكيفية التعامل مع الأخطاء، وكيفية طلب REST API باستخدام curl في حال عدم توفّر خادم MCP. لمزيد من المعلومات، يُرجى الاطّلاع على المقالة استخدام مهارة "قاعدة معلومات المطوّرين".

الاختيار بين واجهة برمجة التطبيقات وخادم MCP

تم تصميم واجهة برمجة التطبيقات Developer Knowledge API وخادم Developer Knowledge MCP لتلبية احتياجات مختلفة في ما يتعلّق بعمليات الدمج:

• استخدام Developer Knowledge API أو مكتبات البرامج أو gcloud CLI في الحالات التالية:
  • لا يستخدم مشروعك وكيل الذكاء الاصطناعي.
  • تريد تحديد أدوات أو مجموعات أدوات مخصّصة للوكيل.
  • تريد معالجة النتائج أو دمجها قبل تمريرها إلى نموذج (على سبيل المثال، التحقّق من طول بايت المستند قبل جلب المحتوى الكامل).
  • عليك فلترة نتائج البحث (مثل حسب data_source أو update_time) أو تطبيق أقنعة الحقول.
• استخدام خادم Developer Knowledge MCP ومهارة الوكيل في الحالات التالية:
  • تريد ربط مساعد أو وكيل ترميز مستند إلى الذكاء الاصطناعي بدون كتابة تعريفات وأوصاف مخصّصة للأدوات.
  • تريد الحصول على تحديثات تلقائية عندما يضيف خادم MCP الخاص بـ "معرفة المطوّر" إمكانات جديدة.
  • لا تحتاج إلى فلترة البيانات الوصفية المخصّصة في نتائج البحث.

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

لاستخدام Developer Knowledge API، عليك أولاً تفعيلها لمشروعك على Google Cloud.

ملاحظة: إذا لم يكن لديك مشروع على Google Cloud، أنشئ مشروعًا باتّباع تعليمات Google Cloud أو Firebase.

1. افتح صفحة Developer Knowledge API في مكتبة Google APIs.
2. تأكَّد من اختيار المشروع الصحيح الذي تنوي استخدام واجهة برمجة التطبيقات فيه.
3. انقر على تفعيل. لا تتطلّب واجهة برمجة التطبيقات أي أدوار محدّدة في "إدارة الهوية وإمكانية الوصول" لتفعيلها أو استخدامها.

المصادقة

يمكنك المصادقة على الطلبات المُرسَلة إلى Developer Knowledge API باستخدام إحدى الطرق التالية:

• مفتاح واجهة برمجة التطبيقات: للمصادقة على طلبات REST المباشرة أو خادم MCP الخاص بـ "معرفة المطوّر" باستخدام مَعلمة طلب البحث key أو العنوان X-Goog-Api-Key
• بيانات الاعتماد التلقائية للتطبيق (ADC) أو OAuth 2.0 أو حسابات الخدمة: تتم مصادقة الطلبات عند استخدام مكتبات البرامج الرسمية أو سير العمل الخاصة بالإنتاج. لمزيد من المعلومات حول إعداد بيانات الاعتماد، راجِع مستندات "بيانات الاعتماد التلقائية للتطبيق".
• بيانات اعتماد المستخدم (واجهة سطر الأوامر في Google Cloud): مصادقة طلبات واجهة سطر الأوامر من خلال تسجيل الدخول إلى حسابك على Google Cloud باستخدام gcloud auth login راجِع دليل البدء السريع في gcloud CLI للحصول على تعليمات الإعداد.

المستندات المضمّنة

يُرجى الرجوع إلى مرجع مجموعة المستندات للحصول على معلومات حول المستندات التي تبحث فيها واجهة برمجة التطبيقات.

تهدف واجهة برمجة التطبيقات Developer Knowledge API إلى توفير إمكانية الوصول إلى أحدث مستندات Google للمطوّرين. هدفنا هو إعادة فهرسة المحتوى خلال 48 ساعة من نشره، لكي تصبح المستندات الجديدة أو المعدَّلة متاحة خلال يومَي عمل.

القيود المعروفة

• جودة Markdown: يتم إنشاء Markdown من مصدر HTML. قد تكون هناك بعض الاختلافات أو المشاكل في التنسيق.
• نطاق المحتوى: يتم تضمين الصفحات المتاحة للجميع فقط في مرجع المجموعة. لا يتم تضمين المحتوى من مصادر أخرى، مثل GitHub أو مواقع OSS أو المدونات أو YouTube.