בדף הזה במדריך Cloud Search מוסבר איך להגדיר מקור נתונים ומחבר תוכן לאינדוקס נתונים. כדי להתחיל מההתחלה של המדריך הזה, כדאי לעיין במדריך לתחילת העבודה עם Cloud Search
בניית המחבר
משנים את ספריית העבודה לספרייה cloud-search-samples/end-to-end/connector ומריצים את הפקודה הבאה:
mvn package -DskipTests
הפקודה מורידה את התלות הנדרשת לבניית מחבר התוכן ומקמפלת את הקוד.
יצירת פרטי כניסה לחשבון שירות
כדי להשתמש במחבר הזה, צריך פרטי כניסה של חשבון שירות כדי לבצע קריאה ל-Cloud Search APIs. כדי ליצור את פרטי הכניסה:
- חוזרים אל מסוף Google Cloud.
- בחלונית הניווט הימנית, לוחצים על פרטי כניסה. יופיע הדף 'אישורים'.
- לוחצים על הרשימה הנפתחת + CREATE CREDENTIALS ובוחרים באפשרות Service account. מופיע הדף 'יצירת חשבון שירות'.
- בשדה Service account name (שם חשבון השירות), מזינים tutorial.
- רושמים את הערך של מזהה חשבון השירות (מימין לשם חשבון השירות). הערך הזה ישמש בהמשך.
- לוחצים על יצירה. מופיעה תיבת הדו-שיח 'הרשאות של חשבון שירות (אופציונלי)'.
- לוחצים על המשך. מופיעה תיבת הדו-שיח 'הענקת גישה למשתמשים לחשבון השירות הזה (אופציונלי)'.
- לוחצים על סיום. יופיע המסך 'פרטי כניסה'.
- בקטע Service Accounts (חשבונות שירות), לוחצים על כתובת האימייל של חשבון השירות. יופיע הדף 'פרטי חשבון השירות'.
- בקטע Keys (מפתחות), לוחצים על התפריט הנפתח ADD KEY (הוספת מפתח) ובוחרים באפשרות Create new key (יצירת מפתח חדש). מופיעה תיבת הדו-שיח 'יצירת מפתח פרטי'.
- לוחצים על יצירה.
- (אופציונלי) אם מופיע הדו-שיח 'האם ברצונך לאפשר הורדות ב-console.cloud.google.com?', לוחצים על אישור.
- קובץ המפתח הפרטי יישמר במחשב. רושמים או זוכרים את המיקום של הקובץ שהורד. הקובץ הזה משמש להגדרת מחבר התוכן, כדי שהוא יוכל לבצע אימות עצמי כשמתבצעת קריאה ל-Google Cloud Search APIs.
הפעלת תמיכה של צד שלישי
צריך לאתחל את התמיכה בצד שלישי ב-Google Cloud Search לפני שקוראים לממשקי API אחרים של Cloud Search.
כדי לאתחל תמיכה בצד שלישי:
- יוצרים פרטי כניסה לאפליקציית אינטרנט בפרויקט של פלטפורמת Cloud Search. מידע נוסף זמין במאמר בנושא יצירת פרטי כניסה. צריך את מזהה הלקוח ואת הסוד של הלקוח.
- מקבלים אסימון גישה באמצעות OAuth 2.0 Playground:
- לוחצים על OAuth 2.0 Configuration (סמל ההגדרות) ומסמנים את התיבה Use your own OAuth credentials (שימוש בפרטי הכניסה שלכם ב-OAuth).
- מזינים את מזהה הלקוח ואת הסוד של הלקוח.
- בשדה 'היקפים', מזינים את הערך
https://www.googleapis.com/auth/cloud_search.settingsולוחצים על Authorize APIs (אישור של ממשקי API). - לוחצים על Exchange authorization code for tokens (החלפת קוד הרשאה באסימונים).
מריצים את פקודת ה-curl הבאה ומחליפים את
[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. אם הפעולה נכשלת, פנו לתמיכה של Cloud Search.משתמשים ב-
operations.getכדי לאמת את ההפעלה:curl 'https://cloudsearch.googleapis.com/v1/operations/<var>operation_name</var>?key=[YOUR_API_KEY]' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --compressedהאתחול מסתיים כשערך המשתנה
doneהואtrue.
יצירת מקור הנתונים
לאחר מכן, יוצרים מקור נתונים במסוף Admin. מקור הנתונים מספק מרחב שמות לאינדוקס של תוכן באמצעות המחבר.
- פותחים את מסוף Google Admin.
- לוחצים על סמל האפליקציות. יופיע הדף 'ניהול אפליקציות'.
- לוחצים על Google Workspace. מופיע הדף 'ניהול אפליקציות ב-Google Workspace'.
- גוללים למטה ולוחצים על Cloud Search. מופיע הדף 'הגדרות של Google Workspace'.
- לוחצים על מקורות נתונים של צד שלישי. יופיע הדף 'מקורות נתונים'.
- לוחצים על העיגול הצהוב עם +. מופיעה תיבת הדו-שיח 'הוספת מקור נתונים חדש'.
- בשדה השם המוצג מקלידים 'tutorial'.
- בשדה Service account email addresses, מזינים את כתובת האימייל של חשבון השירות שיצרתם בקטע הקודם. אם אתם לא יודעים מה כתובת האימייל של חשבון השירות, תוכלו לחפש את הערך בדף חשבונות שירות.
- לוחצים על ADD. מופיעה תיבת הדו-שיח 'יצירת מקור הנתונים הסתיימה'.
- לוחצים על *אישור. שימו לב למזהה המקור של מקור הנתונים החדש שיצרתם. מזהה המקור משמש להגדרת מחבר התוכן.
יצירת אסימון גישה אישי ל-GitHub API
כדי לקבל מכסת שימוש מספקת, המחבר דורש גישה מאומתת ל-GitHub API. כדי לפשט את התהליך, המחבר משתמש באסימוני גישה אישיים במקום ב-OAuth. טוקנים אישיים מאפשרים אימות כמשתמש עם מערך מוגבל של הרשאות, בדומה ל-OAuth.
- מתחברים ל-GitHub.
- בפינה השמאלית העליונה, לוחצים על תמונת הפרופיל. יופיע תפריט נפתח.
- לוחצים על הגדרות.
- לוחצים על הגדרות למפתחים.
- לוחצים על Personal access tokens (אסימוני גישה אישיים).
- לוחצים על יצירת אסימון גישה אישי.
- בשדה הערה מזינים Cloud Search tutorial (הדרכה בנושא Cloud Search).
- בודקים את ההיקף public_repo.
- לוחצים על יצירת אסימון.
- שימו לב לטוקן שנוצר. המחבר משתמש בו כדי לקרוא ל-API של GitHub, והוא מספק מכסת 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. ה-method main יוצרת מופע של IndexingApplication SDK ומפעילה אותו.
ListingConnector
ה-SDK מספק אסטרטגיית מעבר
שמסתמכת על תורים של Cloud Search
למעקב אחרי מצב הפריטים באינדקס. הוא מעביר את הבקשה אל GithubRepository, שמיושם על ידי מחבר לדוגמה, כדי לגשת לתוכן מ-GitHub.
מעבר בין המאגרים ב-GitHub
במהלך סריקות מלאות, השיטה getIds() מופעלת כדי להעביר לתור פריטים שאולי צריך להוסיף לאינדקס.
המחבר יכול להוסיף לאינדקס כמה מאגרי מידע או ארגונים. כדי למזער את ההשפעה של כשל, כל מאגר GitHub נסרק בנפרד. נקודת ביקורת מוחזרת עם תוצאות הסריקה, שמכילה את רשימת המאגרים שיש ליצור להם אינדקס בקריאות הבאות ל-getIds(). אם מתרחשת שגיאה, ההוספה לאינדקס מתחדשת במאגר הנוכחי במקום להתחיל מההתחלה.
השיטה collectRepositoryItems() מטפלת במעבר על מאגר GitHub יחיד. השיטה הזו מחזירה אוסף של ApiOperations שמייצג את הפריטים שיועברו לתור. הפריטים נדחפים כשם משאב וכערך גיבוב (hash) שמייצג את המצב הנוכחי של הפריט.
ערך הגיבוב משמש למעברים הבאים במאגרי GitHub. הערך הזה מאפשר לבצע בדיקה קלה כדי לקבוע אם התוכן השתנה, בלי להעלות תוכן נוסף. המחבר מוסיף את כל הפריטים לתור בלי לבדוק אותם. אם הפריט חדש או שערך הגיבוב השתנה, הוא יהיה זמין לשליפת נתונים בתור. אחרת, הפריט ייחשב כפריט שלא בוצעו בו שינויים.
עיבוד התור
אחרי שהמעבר המלא מסתיים, המחבר מתחיל לבצע בדיקה חוזרת של התור כדי למצוא פריטים שצריך להוסיף לאינדקס. השיטה getDoc() נקראת לכל פריט שנשלף מהתור. השיטה קוראת את הפריט מ-GitHub וממירה אותו לייצוג המתאים לאינדקס.
מכיוון שהמחבר פועל על נתונים פעילים שעשויים להשתנות בכל רגע, getDoc() גם מוודא שהפריט בתור עדיין תקף ומוחק מהאינדקס פריטים שכבר לא קיימים.
לכל אחד מהאובייקטים ב-GitHub שהמחבר מבצע עליהם אינדוקס, השיטה המתאימה indexItem() מטפלת בבניית הייצוג של הפריט ב-Cloud Search. לדוגמה, כדי ליצור את הייצוג של פריטי תוכן:
לאחר מכן, פורסים את ממשק החיפוש.