التشغيل السريع: بدء استخدام Developer Knowledge API

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

قبل البدء

قبل البدء في استخدام Developer Knowledge API، تأكَّد من إكمال الخطوات التالية.

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

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

إنشاء مفتاح واجهة برمجة التطبيقات وتأمينه

  1. في Google Cloud Console للمشروع الذي فعّلت فيه واجهة برمجة التطبيقات، انتقِل إلى الـ صفحة بيانات الاعتماد.
  2. انقر على إنشاء بيانات اعتماد، ثمّ اختَر مفتاح واجهة برمجة التطبيقات من القائمة.
  3. في حقل الاسم ، أدخِل اسمًا للمفتاح.

  4. انقر على القائمة المنسدلة اختيار قيود واجهة برمجة التطبيقات ، ثمّ اكتب Developer Knowledge API. انقر على النتيجة، ثمّ انقر على حسنًا.

    ملاحظات:

    • إذا فعّلت Developer Knowledge API للتو، قد يحدث تأخير قبل ظهورها في القائمة. انتظِر بضع دقائق وحاوِل مرة أخرى.
    • إذا كنت تخطط لاستخدام هذا المفتاح نفسه لطلبات النموذج العام من عميل الذكاء الاصطناعي (على سبيل المثال، GEMINI_API_KEY)، عليك أيضًا اختيار Generative Language API. وإلا سيتم حظر هذه الطلبات.
  5. انقر على إنشاء.

إنشاء إجابات من المستندات

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

  1. احفظ مفتاح Developer Knowledge API في متغيّر بيئة:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    استبدِل YOUR_API_KEY بمفتاح واجهة برمجة التطبيقات الذي أنشأته.

  2. استخدِم curl لاستدعاء نقطة النهاية AnswerQuery:

    curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

يعرض هذا الأمر إجابة لطلب البحث استنادًا إلى المستندات.

البحث عن أجزاء من المستندات

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

استخدِم curl لاستدعاء نقطة النهاية SearchDocumentChunks:

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

تتضمّن الاستجابة أجزاء مطابقة من المحتوى من المستندات ومراجع للمستندات الرئيسية.

استرداد مستند

تحتوي الاستجابة من searchDocumentChunks على قائمة بأجزاء المستندات. يحتوي كل جزء من المستند على حقل parent يتضمّن اسم مورد المستند، ويمكنك استخدامه مع GetDocument لاسترداد المحتوى الكامل للمستند.

لاسترداد مستند، انسخ حقل parent من أحد الأجزاء التي تعرضها searchDocumentChunks واحفظه في متغيّر بيئة، ثمّ استخدِم curl لاستدعاء نقطة النهاية GetDocument:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

يعرض هذا الأمر محتوى Markdown الكامل للمستند المحدّد.

الخطوات التالية