מדריך למתחילים: תחילת העבודה עם Developer Knowledge API

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

לפני שמתחילים

לפני שמתחילים להשתמש ב-Developer Knowledge API, צריך לבצע את השלבים הבאים.

הפעלת ה-API

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

יצירה ואבטחה של מפתח API

  1. במסוף Google Cloud, עוברים אל הדף Credentials של הפרויקט שבו הפעלתם את ה-API.
  2. לוחצים על Create credentials ובתפריט בוחרים באפשרות מפתח API.
  3. בשדה Name, נותנים שם למפתח.

  4. לוחצים על התפריט הנפתח Select API restrictions ומקלידים Developer Knowledge API. לוחצים על התוצאה ואז על OK.

    הערות:

    • אם הפעלתם את Developer Knowledge API רק עכשיו, יכול להיות שיעבור קצת זמן עד שהוא יופיע ברשימה. מחכים כמה דקות ומנסים שוב.
    • אם אתם מתכננים להשתמש באותו מפתח לקריאות למודל הכללי של לקוח ה-AI (לדוגמה, GEMINI_API_KEY), אתם צריכים לבחור גם באפשרות Generative Language API. אחרת, השיחות האלה ייחסמו.
  5. לוחצים על יצירה.

יצירת תשובות מתוך תיעוד

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

  1. שומרים את מפתח Developer Knowledge API במשתנה סביבה:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    מחליפים את הערך YOUR_API_KEY במפתח ה-API שיצרתם.

  2. משתמשים ב-curl כדי לקרוא לנקודת הקצה AnswerQuery:

    curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

הפקודה הזו מחזירה תשובה לשאילתה שלכם על סמך התיעוד.

חיפוש של קטעי מסמכים

אם אתם רוצים למצוא קטעי תיעוד ספציפיים במקום תשובה שנוצרה, אתם יכולים לחפש ישירות קטעי מסמכים.

משתמשים ב-curl כדי להתקשר לנקודת הקצה SearchDocumentChunks:

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

התשובה כוללת קטעי תוכן תואמים מהמסמכים והפניות למסמכי ההורה.

שליפת מסמך

התשובה מ-searchDocumentChunks מכילה רשימה של קטעי מסמכים. לכל קטע במסמך יש שדה parent שמכיל את שם המשאב של המסמך. אתם יכולים להשתמש בשם הזה עם GetDocument כדי לאחזר את התוכן המלא של המסמך.

כדי לאחזר מסמך, מעתיקים את השדה parent מאחד הקטעים שמוחזרים על ידי searchDocumentChunks ושומרים אותו במשתנה סביבה. לאחר מכן משתמשים ב-curl כדי לקרוא לנקודת הקצה (endpoint) של GetDocument:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

הפונקציה מחזירה את כל התוכן בפורמט Markdown של המסמך שצוין.

המאמרים הבאים