توفّر واجهة برمجة التطبيقات Developer Knowledge API إمكانية الوصول الآلي إلى مستندات المطوّرين العامة من Google، ما يتيح لك دمج قاعدة المعلومات هذه في تطبيقاتك وسير عملك.
نظرة عامة
تم تصميم Developer Knowledge API لتكون المصدر الأساسي الذي يتيح الوصول إلى مستندات المطوّرين من Google بتنسيق قابل للقراءة آليًا. ويوفّر وظائف للبحث عن المستندات واسترجاعها والإجابة عن الاستعلامات:
SearchDocumentChunksللعثور على معرّفات الموارد الموحّدة (URI) ومقتطفات المحتوى ذات الصلة استنادًا إلى طلب بحث- اضغط على
GetDocumentأوBatchGetDocumentsللحصول على المحتوى الكامل لنتائج البحث. AnswerQueryللحصول على إجابات عن طلبات البحث المستندة إلى مجموعة مستندات.
للبدء بسرعة، اتّبِع دليل البدء السريع.
يتم إدراج مجموعة المحتوى القابل للبحث في مرجع مجموعة المحتوى.
تتيح واجهة Developer Knowledge API البحث عن صفحات المستندات واستردادها بتنسيق Markdown غير منظَّم.
تفعيل واجهة برمجة التطبيقات
لاستخدام Developer Knowledge API، عليك أولاً تفعيلها لمشروعك على Google Cloud.
- افتح صفحة Developer Knowledge API في مكتبة Google APIs.
- تأكَّد من اختيار المشروع الصحيح الذي تنوي استخدام واجهة برمجة التطبيقات فيه.
- انقر على تفعيل. لا تتطلّب واجهة برمجة التطبيقات أي أدوار محدّدة في "إدارة الهوية وإمكانية الوصول" لتفعيلها أو استخدامها.
المصادقة
يجب توفُّر مفتاح لواجهة Developer Knowledge API لاستخدامها. لإنشاء حساب:
- في Google Cloud Console للمشروع الذي فعّلت فيه واجهة برمجة التطبيقات، انتقِل إلى صفحة "بيانات الاعتماد".
- انقر على إنشاء بيانات اعتماد، ثم اختَر مفتاح واجهة برمجة التطبيقات من القائمة.
- في حقل الاسم، أدخِل اسمًا للمفتاح.
-
انقر على القائمة المنسدلة اختيار قيود واجهة برمجة التطبيقات، ثم اكتب Developer Knowledge API. انقر على النتيجة، ثم انقر على حسنًا.
ملاحظات:
- إذا فعّلت واجهة برمجة التطبيقات Developer Knowledge API للتو، قد يحدث تأخير قبل ظهورها في القائمة. انتظر بضع دقائق وأعِد المحاولة.
-
إذا كنت تخطّط لاستخدام المفتاح نفسه لطلبات النموذج العام لعميل الذكاء الاصطناعي (على سبيل المثال،
GEMINI_API_KEY)، عليك أيضًا اختيار Generative Language API. وفي حال عدم استيفاء هذا الشرط، سيتم حظر هذه المكالمات.
- انقر على إنشاء.
يجب تضمين مفتاح Developer Knowledge API هذا في طلباتك. على سبيل المثال، يجب أن تتضمّن طلبات REST
هذا المعرّف باستخدام مَعلمة طلب البحث key. يمكنك الرجوع إلى
دليل البدء السريع للاطّلاع على مثال.
المستندات المضمّنة
يُرجى الرجوع إلى مرجع مجموعة المستندات للحصول على معلومات حول المستندات التي تبحث فيها واجهة برمجة التطبيقات.
تهدف واجهة برمجة التطبيقات Developer Knowledge API إلى توفير إمكانية الوصول إلى أحدث مستندات مطوّري Google. هدفنا هو إعادة فهرسة المحتوى خلال 48 ساعة من نشره، لكي تصبح المستندات الجديدة أو المعدَّلة متاحة خلال يومَي عمل.القيود المعروفة
- جودة Markdown: يتم إنشاء Markdown من مصدر HTML. قد تكون هناك بعض الاختلافات أو المشاكل في التنسيق.
- نطاق المحتوى: يتم تضمين الصفحات العلنية فقط في مرجع المجموعة. لا يتم تضمين المحتوى من مصادر أخرى، مثل GitHub أو مواقع OSS أو المدوّنات أو YouTube.