التشغيل السريع: بدء استخدام 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 الكامل للمستند المحدّد.

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