בדף הזה במדריך של Cloud Search מוסבר איך להגדיר מקור נתונים. ומחבר תוכן לצורך הוספת נתונים לאינדקס. כדי להתחיל בתחילת המדריך הזה, עיינו בקטע מדריך לתחילת העבודה עם Cloud Search
יצירת המחבר
שינוי ספריית העבודה לפורמט cloud-search-samples/end-to-end/connector
ומריצים את הפקודה הבאה:
mvn package -DskipTests
הפקודה מורידה את יחסי התלות הנדרשים שנדרשים ליצירת מחבר תוכן ומהדר את הקוד.
יצירת פרטי כניסה לחשבון שירות
המחבר דורש פרטי כניסה לחשבון שירות כדי להפעיל את Cloud Search ממשקי API. כדי ליצור את פרטי הכניסה:
- חזרה אל מסוף Google Cloud.
- בחלונית הניווט השמאלית, לוחצים על Credentials (פרטי כניסה). השדה מופיעה.
- לוחצים על הרשימה הנפתחת + CREATE CREDENTIALS ובוחרים חשבון שירות. האפשרות 'יצירת חשבון שירות' מופיעה.
- בשדה Service account name, מזינים 'tutorial'.
- שימו לב לערך של מזהה חשבון השירות (מיד אחרי השם של חשבון השירות). ייעשה שימוש בערך הזה מאוחר יותר.
- לוחצים על יצירה. העמודה 'הרשאות חשבון שירות (אופציונלי)' תופיע תיבת דו-שיח.
- לוחצים על המשך. השדה 'נותנים למשתמשים גישה לחשבון השירות הזה (אופציונלי)" תופיע תיבת דו-שיח.
- לוחצים על סיום. השדות 'פרטי כניסה' מופיעה.
- בקטע 'חשבונות שירות', לוחצים על כתובת האימייל של חשבון השירות. "השירות" פרטי החשבון" הצעות מחיר.
- בקטע 'מפתחות', לוחצים על הרשימה הנפתחת הוספת מפתח ובוחרים יצירת מפתח חדש. הלחצן 'יצירת מפתח פרטי' תופיע תיבת דו-שיח.
- לוחצים על יצירה.
- (אופציונלי) אם ההודעה 'האם לאפשר הורדות ב: console.cloud.google.com?” מופיעה, לוחצים על Allow (אישור).
- קובץ מפתח פרטי נשמר במחשב שלכם. רושמים את המיקום של הקובץ שהורד. הקובץ הזה משמש להגדרה של מחבר התוכן כך הוא יכול לאמת את עצמו כשהוא שולח קריאה לממשקי ה-API של Google Cloud Search.
הפעלת תמיכה של צד שלישי
כדי לקרוא לממשקי API אחרים של Cloud Search, צריך לאתחל צד שלישי תמיכה ב-Google Cloud Search.
כדי להפעיל תמיכה של צד שלישי ב-Cloud Search:
הפרויקט בפלטפורמת Cloud Search מכיל פרטי כניסה של חשבון שירות. עם זאת, כדי להתחיל אתחול תמיכה של צד שלישי, צריך ליצור דפי אינטרנט של האפליקציה. להוראות ליצירת אפליקציית אינטרנט מתייחסים יוצרים פרטי כניסה. כשתסיימו את השלב הזה, תצטרכו לספק מזהה לקוח וקובץ סוד לקוח.
כדאי להשתמש הרשאות OAuth 2 של Google כדי לקבל אסימון גישה:
- לוחצים על 'הגדרות' ומסמנים את האפשרות שימוש בפרטי הכניסה שלך לאימות.
- מזינים את מזהה הלקוח ואת סוד הלקוח משלב 1.
- לוחצים על סגירה.
- בשדה 'היקפים', מקלידים
https://www.googleapis.com/auth/cloud_search.settings
ולוחצים על Authorize. ה-Playground של OAuth 2 מחזיר קוד הרשאה. - לוחצים על החלפת קוד הרשאה לאסימונים. מוחזר אסימון.
כדי לאתחל תמיכה של צד שלישי ב-Cloud Search, צריך להשתמש ב-curl הבא הפקודה. חשוב להחליף את
[YOUR_ACCESS_TOKEN]
באסימון שהתקבל שלב 2.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 }
יצירת מקור הנתונים
בשלב הבא צריך ליצור מקור נתונים במסוף Admin. מקור הנתונים מספק מרחב שמות להוספת תוכן לאינדקס באמצעות המחבר.
- פותחים את מסוף Google Admin.
- לוחצים על סמל האפליקציות. ניהול האפליקציות מופיעה.
- לוחצים על Google Workspace. הדף 'ניהול אפליקציות ב-Google Workspace' מופיעה.
- גוללים למטה ולוחצים על Cloud Search. הדף 'הגדרות ב-Google Workspace' דף מופיעה.
- לוחצים על מקורות נתונים של צד שלישי. מקורות הנתונים מופיעה.
- לוחצים על הסמל הצהוב + העגול. האפשרות 'הוספה של מקור נתונים חדש' תופיע תיבת דו-שיח.
- בשדה Display name, מקלידים 'tutorial'.
- בשדה Service account email addresses, מזינים את כתובת האימייל של חשבון השירות שיצרתם בקטע הקודם. אם אתם לא יודעים כתובת האימייל של חשבון השירות, מחפשים את הערך ה חשבונות שירות הדף הזה.
- לוחצים על ADD. מקור הנתונים 'מקור הנתונים נוצר בהצלחה' תופיע תיבת דו-שיח.
- לוחצים על *אישור. שימו לב למזהה המקור של מקור הנתונים החדש שנוצר. מזהה המקור משמש להגדרת מחבר התוכן.
יצירת אסימון גישה אישי ל-GitHub API
למחבר נדרשת גישה מאומתת ל-GitHub API כדי כדי שתהיה מכסה מספקת. כדי לשמור על פשטות, המחבר משתמש אסימוני גישה במקום OAuth. אסימונים אישיים מאפשרים אימות בתור משתמש עם קבוצה מוגבלת של הרשאות, שדומות ל-OAuth.
- מתחברים ל-GitHub.
- בפינה הימנית העליונה, לוחצים על תמונת הפרופיל. תפריט נפתח מופיעה.
- לוחצים על הגדרות.
- לוחצים על הגדרות למפתחים.
- לוחצים על אסימוני גישה אישיים.
- לוחצים על יצירת אסימון גישה אישי.
- בשדה הערה, מזינים "Cloud Search training" (מדריך ל-Cloud Search).
- בודקים את ההיקף של public_repo.
- לוחצים על יצירת אסימון.
- רושמים או זוכרים את האסימון שנוצר. המחבר משתמש בו כדי לקרוא ל-GitHub ממשקי API ומספקת מכסת API לביצוע ההוספה לאינדקס.
הגדרת המחבר
אחרי יצירת פרטי הכניסה ומקור הנתונים, צריך לעדכן את המחבר כדי לכלול את הערכים האלה:
- משורת הפקודה, משנים את הספרייה ל-
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.
מעבר למאגרים של GitHub
במהלך מעברים מלאים, getIds()
נקראת כדי לדחוף פריטים שייתכן שצריך להוסיף לאינדקס אל 'הבאים בתור'.
המחבר יכול להוסיף מספר מאגרים או ארגונים לאינדקס. כדי לצמצם ככל האפשר את
ההשפעה של כשל, מאגר אחד ב-GitHub עובר בכל פעם. נקודת ביקורת
מוחזר עם תוצאות המעבר שמכילות את הרשימה
מאגרים שצריך להוסיף לאינדקס בקריאות הבאות אל getIds()
. אם אירעה שגיאה
, ההוספה לאינדקס תתחדש במאגר הנוכחי במקום להתחיל
מההתחלה.
השיטה collectRepositoryItems()
מטפלת במעבר של מקטע יחיד
מאגר GitHub השיטה הזו מחזירה אוסף של ApiOperations
שמייצגים את הפריטים שיש להעביר אותם לתור. פריטים נדחפים כ-
שם משאב וערך גיבוב (hash) שמייצג את המצב הנוכחי של הפריט.
ערך הגיבוב (hash) משמש במעברים הבאים ב-GitHub מאגרים. הערך הזה מספק בדיקה פשוטה כדי לקבוע אם התוכן השתנה ללא צורך להעלות תוכן נוסף. המחבר באופן עיוור מוסיף את כל הפריטים לתור. אם הפריט חדש או שערך הגיבוב השתנה, הוא מוגדר יהיה זמין לקלפי בתור. אחרת, הפריט נחשב ללא שינוי.
מתבצע עיבוד של התור
לאחר השלמת המעבר המלא, המחבר מתחיל לבדוק את
'הבאים בתור' לפריטים שצריך להוסיף לאינדקס. getDoc()
נשלחת קריאה לכל פריט שנשלף מהתור. השיטה קוראת
של הפריט מ-GitHub וממיר אותו לייצוג המתאים
להוספה לאינדקס.
מאחר שהמחבר פועל מול נתונים פעילים שעשויים להשתנות בכל שלב
הזמן, getDoc()
גם מאמת שהפריט בתור עדיין תקף
ומוחק את כל הפריטים מהאינדקס שכבר לא קיימים.
לגבי כל אחד מהאובייקטים של GitHub שהמחבר מוסיף לאינדקס, הערכים התואמים
השיטה indexItem()
מטפלת בבניית ייצוג הפריט עבור
ב-Cloud Search. לדוגמה, כדי ליצור ייצוג של פריטי תוכן:
לאחר מכן, פורסים את ממשק החיפוש.