סקירה כללית על Vertex AI API

ממשקי Vertex AI API ב-Google Distributed Cloud (GDC)‎ עם air gap מאפשרים לשלב באופן פרוגרמטי מודלים של למידת מכונה שאומנו מראש באפליקציות שלכם, ולנהל את המשאבים של Vertex AI Workbench. בהתאם לשירות, אתם יכולים להשתמש בממשקי ה-API האלה באמצעות gRPC, ‏REST, ספריות לקוח של Python או מודל המשאבים של Kubernetes ‏(KRM).

נקודת קצה של שירות ומסמך Discovery

כדי ליצור אינטראקציה פרוגרמטית עם ממשקי ה-API של Vertex AI, צריך נקודת קצה של שירות.

איך מקבלים את נקודת הקצה ומסמך ה-Discovery של Vertex AI Workbench

נקודת הקצה ל-API של Vertex AI Workbench KRM API היא:

https://ENDPOINT/apis/aiplatform.gdc.goog/v1

מחליפים את ENDPOINT בנקודת הקצה ל-API של שרת Management API.

כדי לגשת למסמך Discovery של Vertex AI Workbench, מבצעים אחת מהפעולות הבאות:

  • מזינים את כתובת ה-URL של נקודת הקצה בדפדפן.

  • מריצים את הפקודה kubectl proxy בכלי כמו curl כדי לפתוח שרת proxy לשרת Management API במחשב המקומי. אחרי שהפקודה הזו פועלת, מזינים את כתובת ה-URL הבאה בדפדפן:

    http://127.0.0.1:8001/apis/aiplatform.gdc.goog/v1.

קבלת נקודות קצה ל-API שעברו אימון מראש

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

‫REST,‏ gRPC,‏ KRM וספריות לקוח

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

לחלופין, אתם יכולים לגשת לחלק מממשקי ה-API שעברו אימון מראש באמצעות REST.

אתם יכולים לנהל את Vertex AI Workbench באמצעות Kubernetes Resource Model (KRM) API.

ספריות לקוח

ב-Vertex AI יש ספריות לקוח ב-Python לממשקי API שעברו אימון מראש. בטבלה הבאה מוצגת השוואה בין היתרונות והחסרונות של שימוש בספריות לקוח:

יתרונות חסרונות
מנוהל על ידי Google.
אימות מובנה.
ניסיונות חוזרים מובנים.
גוף בקשת HTTP יעיל של מאגר אחסון לפרוטוקולים.
התכונה לא זמינה בכל שפות התכנות.

REST

ממשקי ה-API של OCR ו-Translation תומכים ב-REST. למידע נוסף, קראו את מאמרי העזרה של ה-API בארכיטקטורת REST של השירותים האלה:

בטבלה הבאה מוצגת השוואה בין היתרונות והחסרונות של השימוש ב-REST:

יתרונות חסרונות
ממשק JSON פשוט.
יש תמיכה טובה בהרבה כלים וספריות של Google ושל צד שלישי.
אתם צריכים ליצור לקוח משלכם.
צריך להטמיע אימות.
צריך להטמיע ניסיונות חוזרים.
גוף בקשת HTTP מסוג JSON פחות יעיל.
ממשקי ה-API האלה לא תומכים בסטרימינג ב-REST.

gRPC

ממשקי API מאומנים מראש תומכים ב-gRPC. למידע נוסף על התיאורים הגנריים של הסוגים, השיטות והשדות שנוצרו בשביל ספריית gRPC, עיינו במאמרי העזרה הבאים של gRPC:

בטבלה הבאה מוצגת השוואה בין היתרונות והחסרונות של השימוש ב-gRPC:

יתרונות חיסרון
תמיכה בהרבה שפות תכנות.
גוף בקשת HTTP יעיל של מאגר אחסון לפרוטוקולים.
אתם צריכים ליצור לקוח משלכם ממאגרי אחסון לפרוטוקולים ש-Google מספקת.
צריך להטמיע אימות.
צריך להטמיע ניסיונות חוזרים.

KRM

‫Vertex AI Workbench API תומך ב-KRM. מידע נוסף זמין במאמרי העזרה של Vertex AI Workbench KRM API.

שמות של סוגים, שיטות ושדות

בהתאם לשימוש בספריות לקוח, ב-REST, ב-gRPC או ב-KRM, שמות הסוגים, השיטות והשדות של ה-API משתנים בדרכים הבאות:

  • ‫REST מסודר לפי היררכיות של משאבים והשיטות שלהם.
  • ספריות הלקוח ו-gRPC מסודרות לפי שירותים והשיטות שלהם.
  • שמות השדות של KRM משתמשים ב-camelCase, אבל שירות ה-API מקבל גם camelCase וגם קו תחתון בין המילים.
  • שמות השדות ב-REST וב-gRPC כתובים ב-snake_case.
  • שמות השדות של ספריית הלקוח משתמשים באותיות רישיות בתחילת כל מילה, ב-camelCase או ב-קו תחתון בין המילים, בהתאם לשם המקובל בשפה.

‫REST ומאגרי אחסון לפרוטוקולים

כששולחים קריאה ל-API בארכיטקטורת REST, התנהגות ערך ברירת המחדל של מאגרי האחסון לפרוטוקולים עלולה לגרום לשדות חסרים בתגובת JSON. השדות האלה מוגדרים לערך ברירת המחדל, ולכן הם לא נכללים בתגובה.