Developer Knowledge API מספק גישה פרוגרמטית לתיעוד הפומבי של Google למפתחים, ומאפשר לכם לשלב את מאגר הידע הזה באפליקציות ובסביבות העבודה שלכם.
סקירה כללית
ה-Developer Knowledge API נועד להיות המקור הקנוני לגישה בפורמט קריא למכונה למאמרי העזרה למפתחים של Google. הוא מציע פונקציות לחיפוש ולאחזור מסמכים, ולמענה על שאילתות:
-
SearchDocumentChunksכדי למצוא מזהי URI של דפים רלוונטיים וקטעי תוכן על סמך שאילתה. -
GetDocumentאו BatchGetDocumentsכדי לאחזר את התוכן המלא של תוצאות החיפוש. AnswerQueryכדי לקבל תשובות לשאילתות שמבוססות על מאגר התיעוד.
כדי להתחיל במהירות, כדאי לעיין במדריך למתחילים.
מאגר התוכן שאפשר לחפש בו מפורט בהפניה למאגר.
ממשק Developer Knowledge API תומך בחיפוש ובאחזור של דפי תיעוד כתוכן Markdown לא מובנה.
הפעלת ה-API
כדי להשתמש ב-Developer Knowledge API, צריך קודם להפעיל אותו בפרויקט ב-Google Cloud.
- פותחים את הדף של Developer Knowledge API בספריית Google APIs.
- מוודאים שבחרתם את הפרויקט הנכון שבו אתם רוצים להשתמש ב-API.
- לוחצים על הפעלה. לא נדרשים תפקידים ספציפיים ב-IAM כדי להפעיל את ה-API או להשתמש בו.
אימות
כדי להשתמש ב-Developer Knowledge API, צריך מפתח API של Developer Knowledge. כדי ליצור אחד:
- במסוף Google Cloud, בפרויקט שבו הפעלתם את ה-API, עוברים אל הדף Credentials.
- לוחצים על Create credentials ובתפריט בוחרים באפשרות API key.
- בשדה Name (שם), מזינים שם למפתח.
-
לוחצים על התפריט הנפתח Select API restrictions ומקלידים Developer Knowledge API. לוחצים על התוצאה ואז על אישור.
- הערה: אם הפעלתם את Developer Knowledge API רק עכשיו, יכול להיות שיחול עיכוב עד שהוא יופיע ברשימה. מחכים כמה דקות ומנסים שוב.
- לוחצים על יצירה.
צריך לכלול את מפתח ה-API של Developer Knowledge בבקשות. לדוגמה, צריך לכלול אותו בקריאות REST באמצעות פרמטר השאילתה key. לדוגמה, אפשר לעיין במדריך למתחילים.
מסמכים כלולים
בהפניית הקורפוס מוסבר אילו מסמכים נסרקים על ידי ה-API.
מגבלות ידועות
- איכות ה-Markdown: ה-Markdown נוצר מ-HTML המקור. יכול להיות שיהיו אי-התאמות או בעיות עיצוב.
- היקף התוכן: נכללים רק דפים ציבוריים בהפניה לקורפוס. התוכן לא כולל תוכן ממקורות אחרים כמו GitHub, אתרי OSS, בלוגים או YouTube.