تعرض هذه الصفحة من دليل Cloud Search التعليمي كيفية إعداد مصدر بيانات. وموصِّل المحتوى لفهرسة البيانات. للبدء من بداية هذا البرنامج التعليمي، راجع الدليل التعليمي حول بدء استخدام Cloud Search
بناء الموصل
تغيير دليل العمل إلى cloud-search-samples/end-to-end/connector
الدليل وقم بتشغيل هذا الأمر:
mvn package -DskipTests
يقوم الأمر بتنزيل التبعيات المطلوبة اللازمة لإنشاء المحتوى وتجميع التعليمات البرمجية.
إنشاء بيانات اعتماد لحساب الخدمة
يتطلب الموصِّل بيانات اعتماد حساب الخدمة للاتصال بخدمة Cloud Search واجهات برمجة التطبيقات. لإنشاء بيانات الاعتماد:
- رجوع إلى وحدة تحكُّم Google Cloud
- في شريط التنقل الأيمن، انقر على بيانات الاعتماد. تشير "بيانات الاعتماد" صفحة تسجيل الدخول.
- انقر على القائمة المنسدلة + إنشاء بيانات الاعتماد واختَر حساب الخدمة: "إنشاء حساب خدمة" صفحة تسجيل الدخول.
- في الحقل اسم حساب الخدمة، أدخِل "البرنامج التعليمي".
- دوِّن قيمة رقم تعريف حساب الخدمة (بعد اسم حساب الخدمة مباشرةً). يتم استخدام هذه القيمة لاحقًا.
- انقر على إنشاء. "أذونات حساب الخدمة (اختيارية)" سيظهر مربع حوار.
- انقر على متابعة. يعرض عمود "منح المستخدمين إمكانية الوصول إلى حساب الخدمة هذا (اختياري)" سيظهر مربع حوار.
- انقر على تم. "بيانات الاعتماد" تظهر الشاشة.
- ضِمن "حسابات الخدمة"، انقر على البريد الإلكتروني لحساب الخدمة. تعتمد "الخدمة تفاصيل الحساب" لمحتواك.
- ضمن "المفاتيح"، انقر على القائمة المنسدلة إضافة مفتاح واختَر. إنشاء مفتاح جديد. يتيح لك "إنشاء مفتاح خاص" سيظهر مربع حوار.
- انقر على إنشاء.
- (اختياري) إذا ظهرت رسالة "هل تريد السماح بالتنزيلات على console.cloud.google.com؟" انقر على السماح.
- يتم حفظ ملف مفتاح خاص على جهاز الكمبيوتر. دوِّن الموقع الجغرافي من الملف الذي تم تنزيله. يُستخدَم هذا الملف لإعداد موصِّل المحتوى لكي يمكنه مصادقة نفسه عند طلب واجهات برمجة تطبيقات Google Cloud Search.
تهيئة دعم الجهات الخارجية
قبل أن تتمكن من طلب أي واجهات برمجة تطبيقات أخرى في Cloud Search، عليك إعداد جهات خارجية. على Google Cloud Search
لإعداد دعم الجهات الخارجية في Cloud Search:
يحتوي مشروع منصة Cloud Search على بيانات اعتماد حساب الخدمة. ومع ذلك، فمن أجل تهيئة دعم الجهات الخارجية، يجب إنشاء صفحات ويب بيانات اعتماد التطبيق. للحصول على إرشادات حول كيفية إنشاء تطبيق ويب بيانات الاعتماد، راجع إنشاء بيانات الاعتماد بعد الانتهاء من هذه الخطوة، ينبغي أن يكون لديك معرف عميل وملف سر العميل.
استخدام نموذج OAuth 2 التجريبي من Google للحصول على رمز الدخول:
- انقر على الإعدادات وضع علامة في المربّع استخدِم بيانات اعتماد المصادقة الخاصة بك.
- أدخِل معرِّف العميل وسر العميل من الخطوة 1.
- انقر على إغلاق.
- في حقل "النطاقات"، اكتب
https://www.googleapis.com/auth/cloud_search.settings
. وانقر على تفويض. تعرض واجهة OAuth 2 رمز تفويض. - انقر على رمز تفويض Exchange للرموز المميّزة. يتم إرجاع رمز مميّز.
لإعداد دعم الجهات الخارجية في Cloud Search، يمكنك استخدام الحلقة التالية الأمر. تأكَّد من استبدال
[YOUR_ACCESS_TOKEN]
بالرمز المميّز الذي تم الحصول عليه في الخطوة الثانية:curl --request POST \ 'https://cloudsearch.googleapis.com/v1:initializeCustomer' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{}' \ --compressed
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثيل
operation
بالنسبة مثال:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" }
في حال تعذَّر ذلك، يمكنك التواصل مع فريق دعم Cloud Search.
استخدِم operations.get للتأكّد من تم إعداد دعم الجهة الخارجية:
curl \ 'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key= [YOUR_API_KEY]' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --compressed
وعند اكتمال تهيئة الجهة الخارجية، تحتوي على تم ضبط الحقل
done
علىtrue
. على سبيل المثال:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" done: true }
إنشاء مصدر البيانات
بعد ذلك، أنشئ مصدر بيانات في وحدة تحكُّم المشرف. مصدر البيانات توفر مساحة اسم لفهرسة المحتوى باستخدام الموصل.
- افتح وحدة تحكّم المشرف في Google.
- انقر على رمز التطبيقات. "إدارة التطبيقات" صفحة تسجيل الدخول.
- انقر على Google Workspace. "إدارة تطبيقات Google Workspace" صفحة تسجيل الدخول.
- انتقِل للأسفل وانقر على Cloud Search. "إعدادات Google Workspace" صفحة تظهر.
- انقر على مصادر البيانات التابعة لجهات خارجية. "مصادر البيانات" صفحة تسجيل الدخول.
- انقر على رمز + الأصفر المستدير. قسم "إضافة مصدر بيانات جديد" سيظهر مربع حوار.
- في الحقل الاسم المعروض، اكتب "فيديو تعليمي".
- في حقل عناوين البريد الإلكتروني لحساب الخدمة، أدخِل عنوان البريد الإلكتروني حساب الخدمة الذي أنشأته في القسم السابق إذا كنت لا تعرف عنوان البريد الإلكتروني لحساب الخدمة، وابحث عن القيمة في الـ حسابات الخدمة .
- انقر على إضافة. "تم إنشاء مصدر البيانات بنجاح" سيظهر مربع حوار.
- انقر على *حسنًا. دوِّن معرّف المصدر لمصدر البيانات الذي تمّ إنشاؤه حديثًا. تشير رسالة الأشكال البيانية يتم استخدام معرّف المصدر لإعداد موصِّل المحتوى.
إنشاء رمز دخول شخصي لواجهة GitHub API
يتطلب الموصل وصولًا تمت مصادقته إلى GitHub API للترتيب للحصول على حصة كافية. ولتبسيط الأمر، يستفيد الموصل من البيانات الشخصية بدلاً من OAuth. تتيح الرموز المميزة الشخصية المصادقة مستخدم لديه مجموعة محدودة من الأذونات المشابهة لـ OAuth.
- سجِّل الدخول إلى GitHub.
- في أعلى يسار الصفحة، انقر على صورة ملفك الشخصي. قائمة منسدلة تظهر.
- انقر على الإعدادات.
- انقر على إعدادات المطوِّر.
- انقر على رموز الدخول الشخصية.
- انقر على إنشاء رمز دخول شخصي.
- في الحقل ملاحظة، أدخِل "الدليل التوجيهي حول Cloud Search".
- تحقَّق من النطاق public_repo.
- انقر على إنشاء رمز مميّز.
- سجِّل الرمز المميّز الذي تم إنشاؤه. يستخدمه الموصل لاستدعاء GitHub واجهات برمجة التطبيقات ويوفر حصة واجهة برمجة التطبيقات لإجراء الفهرسة.
ضبط الموصل
بعد إنشاء بيانات الاعتماد ومصدر البيانات، عليك تحديث الموصِّل التكوين لتضمين القيم التالية:
- من سطر الأوامر، قم بتغيير الدليل إلى
cloud-search-samples/end-to-end/connector/
- افتح ملف
sample-config.properties
باستخدام محرِّر نصوص. - اضبط المَعلمة
api.serviceAccountPrivateKeyFile
على مسار ملف بيانات اعتماد الخدمة التي قمت بتنزيلها مسبقًا. - اضبط المعلمة
api.sourceId
على رقم تعريف مصدر البيانات الذي التي تم إنشاؤها مسبقًا. - اضبط المَعلمة
github.user
على اسم مستخدم GitHub. - اضبط المعلمة
github.token
على رمز الدخول الذي سبق لك إنشاؤه. - احفظ الملف.
تعديل المخطط
يفهرس الموصل المحتوى المنظَّم وغير المهيكل. قبل الفهرسة البيانات، فيجب تحديث مخطط مصدر البيانات. شغِّل الأمر التالي لتحديث المخطط:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
-Dexec.args="-Dconfig=sample-config.properties"
تشغيل الموصِّل
لتشغيل الموصِّل وبدء الفهرسة، شغِّل الأمر:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
-Dexec.args="-Dconfig=sample-config.properties"
التكوين الافتراضي للموصل هو فهرسة مستودع واحد
في مؤسسة googleworkspace
. تستغرق فهرسة المستودع دقيقة واحدة تقريبًا.
بعد الفهرسة الأولية، يستمر الموصل في البحث عن التغييرات التي تطرأ على
المستودع الذي يجب أن يظهر في فهرس Cloud Search.
مراجعة التعليمة البرمجية
تفحص الأقسام المتبقية كيفية إنشاء الموصل.
بدء التطبيق
نقطة الدخول إلى الموصِّل هي الفئة GithubConnector
. تشير رسالة الأشكال البيانية
تنشئ الطريقة main
مثيلاً لحزمة IndexingApplication
الخاصة بحزمة تطوير البرامج (SDK).
ويبدأونه.
ListingConnector
التي تقدمها حزمة تطوير البرامج (SDK) تنفّذ استراتيجية اجتياز
تستفيد من قوائم الانتظار في Cloud Search
لتتبّع حالة العناصر في الفهرس. يفوّض إلى GithubRepository
،
الذي تم تنفيذه بواسطة نموذج الموصل، للوصول إلى المحتوى من جيت هب.
اجتياز مستودعات GitHub
خلال عمليات الاجتياز الكاملة، تعرض سمة getIds()
لدفع العناصر التي قد تحتاج إلى فهرستها في قائمة الانتظار.
يمكن للموصل فهرسة مستودعات أو مؤسسات متعددة. لتقليد
تأثير الإخفاق، يتم اجتياز مستودع جيت هب واحد في كل مرة. نقطة تفتيش
مع نتائج الاجتياز التي تحتوي على قائمة
المستودعات التي ستتم فهرستها في عمليات الاستدعاء اللاحقة إلى getIds()
. إذا كان هناك خطأ
يتم استئناف الفهرسة في المستودع الحالي بدلاً من
من البداية.
تعالج الطريقة collectRepositoryItems()
عملية اجتياز
مستودع GitHub. تعرض هذه الطريقة مجموعة من ApiOperations
تمثل العناصر المراد دفعها إلى قائمة الانتظار. يتم دفع العناصر كـ
اسم المورد وقيمة تجزئة تمثل الحالة الحالية للعنصر.
يتم استخدام قيمة التجزئة في عمليات اجتياز GitHub اللاحقة المستودعات. توفّر هذه القيمة إمكانية فحص بسيط لتحديد ما إذا كان المحتوى تغيرت بدون الحاجة إلى تحميل محتوى إضافي. يظهر الموصّل بشكل عشوائي يضع كل العناصر في قائمة الانتظار. إذا كان العنصر جديدًا أو تم تغيير قيمة التجزئة، يصبح المتاح للاقتراع في قائمة الانتظار. وبخلاف ذلك، يُعتبر العنصر غير معدّل.
جارٍ معالجة قائمة المحتوى التالي
بعد اكتمال الاجتياز بالكامل، يبدأ الموصل في استطلاع
قائمة انتظار للعناصر التي يجب فهرستها. getDoc()
لكل عنصر يتم سحبه من قائمة الانتظار. تُقرأ الطريقة
العنصر من GitHub ويحوله إلى التمثيل المناسب
للفهرسة.
نظرًا لأن الموصل يعمل مع البيانات المباشرة التي يمكن تغييرها في أي وقت
وقت، يتأكد getDoc()
أيضًا من أن العنصر المدرج في قائمة الانتظار لا يزال صالحًا
وتحذف أي عناصر من الفهرس لم تعد موجودة.
يقوم فهارس الموصل الخاصة بكل من كائنات جيت هب،
تعالج الطريقة indexItem()
إنشاء تمثيل العنصر
Cloud Search. على سبيل المثال، لإنشاء تمثيل لعناصر المحتوى:
بعد ذلك، انشر واجهة البحث.