Developer Knowledge API

‫Developer Knowledge API מספק גישה פרוגרמטית לתיעוד הפומבי למפתחים של Google, ומאפשר לכם לשלב את מאגר הידע הזה באפליקציות ובסביבות העבודה שלכם.

סקירה כללית

ממשק Developer Knowledge API נועד להיות המקור הקנוני לגישה לקריאה על ידי מכונה למאמרי העזרה למפתחים של Google. הוא מציע פונקציות לחיפוש ולאחזור מסמכים, ולמענה על שאילתות:

• ‫SearchDocumentChunks כדי למצוא כתובות URI רלוונטיות של דפים וקטעי תוכן על סמך שאילתה.
• ‫GetDocument או ‫BatchGetDocuments כדי לאחזר את התוכן המלא של תוצאות החיפוש.
• ‫AnswerQuery כדי ליצור תשובות לשאילתות שמבוססות על מאגר התיעוד.

ממשק Developer Knowledge API תומך בחיפוש ובאחזור של דפי תיעוד כתוכן Markdown לא מובנה. מאגר התוכן שאפשר לחפש בו מפורט בהפניה למאגר.

דרכים להשתמש ב-Developer Knowledge

אתם יכולים לגשת ל-Developer Knowledge בפלטפורמות הבאות, בהתאם לתהליך העבודה שלכם:

• ‫API בארכיטקטורת REST ו-RPC API: קוראים ישירות לנקודות הקצה של HTTP או gRPC. מפרטים של רכיבי ה-method מופיעים במאמרי העזרה של REST ושל RPC.
• ספריות לקוח: אפשר לשלב את Developer Knowledge API באפליקציות באמצעות ספריות לקוח רשמיות ל-Python, ל-Node.js ול-TypeScript, ל-Go, ל-Java, ל-PHP ול-Ruby.
• ‫Google Cloud CLI‏ (gcloud): מריצים פקודות של gcloud developer-knowledge מהטרמינל כדי לחפש נתחים של מסמכים, לאחזר תוכן בפורמט Markdown וליצור תשובות.
• שרת MCP של מאגר הידע למפתחים: אפשר לחבר את העוזר האישי או הסוכן לתכנות מבוסס-AI למסמכי העזרה של Google באמצעות הכלים של Model Context Protocol‏ (MCP) (search_documents,‏ get_documents ו-answer_query). אפשר לעיין בהפניה ל-MCP.

הערה: אם אתם משתמשים בעוזר AI לתכנות, אתם צריכים להתקין את היכולת של הסוכן retrieving-developer-knowledge על ידי הפעלת הפקודה npx skills add google/skills --skill retrieving-developer-knowledge. הסקיל הזה מספק לעוזר האישי הוראות מובנות לגבי הכלי בשרת ה-MCP של Developer Knowledge שבו צריך לבחור, איך לטפל בשגיאות ואיך לקרוא ל-API בארכיטקטורת REST באמצעות curl אם שרת ה-MCP לא זמין. מידע נוסף זמין במאמר בנושא שימוש במיומנות של סוכן הידע למפתחים.

בחירה בין ה-API לבין שרת ה-MCP

ה-API של Developer Knowledge ושרת ה-MCP של Developer Knowledge מיועדים לצרכי שילוב שונים:

• משתמשים ב-Developer Knowledge API, בספריות לקוח או ב-CLI של gcloud במקרים הבאים:
  • בפרויקט שלכם לא נעשה שימוש בסוכן AI.
  • אתם רוצים להגדיר כלים מותאמים אישית או קבוצות כלים לסוכן.
  • אתם רוצים לעבד או לשלב תוצאות לפני שמעבירים אותן למודל (לדוגמה, בדיקת אורך בבייט של מסמך לפני אחזור התוכן המלא).
  • צריך לסנן את תוצאות החיפוש (למשל לפי data_source או update_time) או להחיל מסכות שדות.
• משתמשים בשרת ה-MCP של Developer Knowledge ובמיומנות הסוכן במקרים הבאים:
  • אתם רוצים לקשר סוכן או עוזר מבוסס-AI לכתיבת קוד בלי לכתוב הגדרות ותיאורים מותאמים אישית של כלים.
  • אתם רוצים עדכונים אוטומטיים כי שרת ה-MCP של Developer Knowledge מוסיף יכולות חדשות.
  • אתם לא צריכים סינון מותאם אישית של מטא נתונים בתוצאות החיפוש.

הפעלת ה-API

כדי להשתמש ב-Developer Knowledge API, צריך קודם להפעיל אותו בפרויקט ב-Google Cloud.

הערה: אם אין לכם פרויקט בענן ב-Google Cloud, צרו פרויקט חדש באמצעות ההוראות ל-Google Cloud או ל-Firebase.

1. פותחים את הדף של Developer Knowledge API בספריית Google APIs.
2. מוודאים שבחרתם את הפרויקט הנכון שבו אתם רוצים להשתמש ב-API.
3. לוחצים על הפעלה. לא נדרשים תפקידים ספציפיים ב-IAM כדי להפעיל את ה-API או להשתמש בו.

אימות

אפשר לאמת בקשות ל-Developer Knowledge API באחת מהשיטות הבאות:

• מפתח API: משמש לאימות של בקשות REST ישירות או של שרת ה-MCP של Developer Knowledge באמצעות פרמטר השאילתה key או הכותרת X-Goog-Api-Key.
• Application Default Credentials ‏ (ADC),‏ OAuth 2.0 או חשבונות שירות: משמשים לאימות בקשות כשמשתמשים בספריות הלקוח הרשמיות או בתהליכי עבודה של ייצור. מידע נוסף על הגדרת פרטי כניסה זמין במסמכי Application Default Credentials.
• פרטי כניסה של משתמש (ה-CLI של gcloud): אימות של בקשות CLI על ידי כניסה לחשבון Google Cloud באמצעות gcloud auth login. הוראות ההגדרה מופיעות במדריך למתחילים של ה-CLI של gcloud.

מסמכים כלולים

מידע על המסמכים שמתבצע בהם חיפוש באמצעות ה-API מופיע במאמר הפניית מאגר מידע.

מטרת Developer Knowledge API היא לספק גישה לתיעוד העדכני ביותר למפתחים של Google. המטרה שלנו היא לבצע אינדוקס מחדש של התוכן תוך 48 שעות ממועד הפרסום, כדי שהתיעוד החדש או המעודכן יהיה זמין תוך יומיים עסקיים.

מגבלות ידועות

• איכות ה-Markdown: ה-Markdown נוצר מ-HTML המקור. יכול להיות שיהיו אי התאמות או בעיות עיצוב.
• היקף התוכן: נכללים רק דפים ציבוריים בהפניה לקורפוס. התוכן לא כולל תוכן ממקורות אחרים כמו GitHub, אתרי OSS, בלוגים או YouTube.