توضّح هذه الصفحة كيفية بدء استخدام Cloud Client Libraries لواجهة Developer Knowledge API. بدلاً من إنشاء طلبات HTTP أولية، توفّر مكتبات البرامج أنواعًا اصطلاحية ومصادقة مضمّنة وتقسيمًا تلقائيًا إلى صفحات ومعالجة لإعادة المحاولة، ما يقلّل من مقدار الرمز الذي عليك كتابته.
لمزيد من المعلومات حول مكتبات العملاء في Google APIs، يُرجى الرجوع إلى مقالة شرح مكتبات العملاء.
تثبيت مكتبة البرامج
اختَر لغة البرمجة لتثبيت مكتبة برامج واجهة برمجة التطبيقات الرسمية Developer Knowledge API:
Go
أضِف الوحدة إلى مشروع Go:
go get cloud.google.com/go/developerknowledge/apiv1
لمزيد من المعلومات، يُرجى الرجوع إلى إعداد بيئة تطوير Go.
جافا
إذا كنت تستخدم Maven، أضِف الاعتمادية التالية إلى ملف pom.xml:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-developer-knowledge</artifactId>
<version>0.6.0</version>
</dependency>
إذا كنت تستخدم Gradle، أضِف التبعية التالية إلى ملف build.gradle:
implementation 'com.google.cloud:google-cloud-developer-knowledge:0.6.0'
لمزيد من المعلومات، يُرجى الرجوع إلى إعداد بيئة تطوير Java.
Node.js وTypeScript
ثبِّت الحزمة باستخدام npm:
npm install @google/developer-knowledge
لمزيد من المعلومات، يُرجى الاطّلاع على إعداد بيئة تطوير Node.js.
PHP
ثبِّت الحزمة باستخدام Composer:
composer require google/developer-knowledge
لمزيد من المعلومات، يُرجى الرجوع إلى استخدام PHP على Google Cloud.
Python
ثبِّت الحزمة باستخدام pip:
pip install --upgrade google-developer-knowledge
لمزيد من المعلومات، يُرجى الرجوع إلى إعداد بيئة تطوير Python.
Ruby
ثبِّت الأداة:
gem install google-developers-developer_knowledge
لمزيد من المعلومات، يُرجى الرجوع إلى إعداد بيئة تطوير Ruby.
إعداد المصادقة
قبل تقديم طلبات إلى واجهة برمجة التطبيقات، تأكَّد من تفعيل Developer Knowledge API في مشروعك على Google Cloud.
للمصادقة على الطلبات التي يتم إرسالها إلى Developer Knowledge API، تتيح مكتبات البرامج بيانات الاعتماد التلقائية للتطبيق (ADC). تبحث المكتبات عن بيانات الاعتماد في مجموعة من المواقع الجغرافية المحدّدة وتستخدم بيانات الاعتماد هذه للمصادقة على الطلبات التي يتم إرسالها إلى واجهة برمجة التطبيقات. باستخدام ADC، يمكنك إتاحة بيانات الاعتماد لتطبيقك في مجموعة متنوعة من البيئات، مثل التطوير المحلي أو الإصدار العلني، بدون الحاجة إلى تعديل الرمز البرمجي لتطبيقك.
بالنسبة إلى بيئات الإنتاج، تعتمد طريقة إعداد ADC على الخدمة والسياق:
- بيئات Google Cloud: عندما يتم تشغيل تطبيقك على Cloud Run أو Google Kubernetes Engine أو Compute Engine أو وظائف Cloud Run، تستخدم ADC تلقائيًا حساب الخدمة المرتبط بمورد الحوسبة.
- البيئات الخارجية أو المحلية: استخدِم
Workload Identity Federation أو اضبط متغيّر البيئة
GOOGLE_APPLICATION_CREDENTIALSعلى مسار ملف إعدادات بيانات الاعتماد.
لمزيد من المعلومات حول خيارات بيانات الاعتماد الخاصة بالإنتاج، يُرجى الاطّلاع على مقالة إعداد "بيانات الاعتماد التلقائية للتطبيق".
بالنسبة إلى بيئة التطوير المحلية، يمكنك إعداد ADC باستخدام بيانات الاعتماد المرتبطة بحساب Google:
- ثبِّت وفعِّل gcloud CLI.
إنشاء بيانات اعتماد مصادقة محلية لحساب Google:
gcloud auth application-default loginتظهر شاشة تسجيل الدخول. بعد تسجيل الدخول، يتم تخزين بيانات الاعتماد في ملف بيانات الاعتماد المحلي الذي يستخدمه ADC.
مراجع إضافية
اختَر علامة تبويب اللغة للعثور على روابط تؤدي إلى مرجع واجهة برمجة التطبيقات، وعيّنات الرموز البرمجية، وأفضل الممارسات، وأدوات تتبُّع المشاكل، ومستودعات الرموز المصدرية لكل مكتبة برامج:
Go
تحتوي القائمة التالية على روابط تنقلك إلى المزيد من المراجع ذات الصلة بمكتبة البرامج للعميل في Go:
جافا
تحتوي القائمة التالية على روابط تنقلك إلى المزيد من المراجع ذات الصلة بمكتبة برامج Java:
Node.js وTypeScript
تحتوي القائمة التالية على روابط تنقلك إلى مزيد من المراجع ذات الصلة بمكتبة العميل الخاصة بـ Node.js وTypeScript:
PHP
تتضمّن القائمة التالية روابط تنقلك إلى المزيد من المراجع ذات الصلة بمكتبة البرامج الخاصة بلغة PHP:
Python
تتضمّن القائمة التالية روابط تنقلك إلى المزيد من المراجع ذات الصلة بمكتبة البرامج للغة Python:
Ruby
تحتوي القائمة التالية على روابط تنقلك إلى المزيد من المراجع ذات الصلة بمكتبة برامج Ruby:
الخطوات التالية
- اتّبِع دليل البدء السريع لمكتبات العملاء لعرض نماذج الرموز وتشغيلها
في
AnswerQueryوSearchDocumentChunksوGetDocumentوBatchGetDocuments. - يمكنك الاطّلاع على مزيد من المعلومات عن فلاتر طلب البحث والتقسيم على صفحات وأقنعة الحقول في مقالة البحث عن المستندات واستردادها.
- استخدِم ميزة "الإنشاء المستند إلى المصادر" مع إنشاء إجابات من المستندات.
- راجِع استراتيجيات إعادة المحاولة ورموز الحالة في التعامل مع الأخطاء والحدّ من المعدّل وإدارة الحصة.
- تصفَّح مرجع مجموعة النصوص للاطّلاع على جميع نطاقات المستندات المتوافقة.