מדריך למתחילים: תחילת העבודה עם 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 key.
  3. בשדה Name (שם), נותנים שם למפתח.

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

    הערות:

    • אם הפעלתם את 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 כדי לקרוא לנקודת הקצה GetDocument:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

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

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

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