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: אימות בקשות REST ישירות באמצעות פרמטר השאילתה
keyאו הכותרתX-Goog-Api-Key. דוגמה מופיעה במדריך למתחילים בנושא REST. - Application Default Credentials (ADC), OAuth 2.0 או חשבונות שירות: משמשים לאימות בקשות כשמשתמשים בספריות הלקוח הרשמיות או בתהליכי עבודה של ייצור. מידע נוסף על הגדרת פרטי כניסה זמין במסמכי Application Default Credentials.
מסמכים כלולים
מידע על המסמכים שמתבצע בהם חיפוש באמצעות ה-API מופיע במאמר הפניית מאגר מידע.
מטרת Developer Knowledge API היא לספק גישה לתיעוד העדכני ביותר למפתחים של Google. המטרה שלנו היא לבצע אינדוקס מחדש של התוכן תוך 48 שעות ממועד הפרסום, כדי שהתיעוד החדש או המעודכן יהיה זמין תוך יומיים עסקיים.מגבלות ידועות
- איכות ה-Markdown: ה-Markdown נוצר מ-HTML המקור. יכול להיות שיהיו אי התאמות או בעיות עיצוב.
- היקף התוכן: נכללים רק דפים ציבוריים בהפניה לקורפוס. התוכן לא כולל תוכן ממקורות אחרים כמו GitHub, אתרי OSS, בלוגים או YouTube.