Method: projects.locations.collections.dataStores.customModels.list

מקבלים רשימה של כל המודלים בהתאמה אישית.

בקשת HTTP


GET https://discoveryengine.googleapis.com/v1/{dataStore=projects/*/locations/*/collections/*/dataStores/*}/customModels

כתובות ה-URL כתובות בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
dataStore

string

חובה. שם המשאב של מאגר הנתונים ההורה, למשל projects/*/locations/global/collections/default_collection/dataStores/default_data_store. השדה הזה משמש לזיהוי מאגר הנתונים שממנו יאוחזרו המודלים.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

הודעת תגובה לשיטה SearchTuningService.ListCustomModels.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "models": [
    {
      object (CustomTuningModel)
    }
  ]
}
שדות
models[]

object (CustomTuningModel)

רשימה של מודלים בהתאמה אישית.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב dataStore:

  • discoveryengine.dataStores.listCustomModels

מידע נוסף מופיע במאמרי העזרה בנושא IAM.

CustomTuningModel

מטא-נתונים שמתארים מודל שעבר התאמה אישית.

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,
  "modelVersion": string,
  "modelState": enum (ModelState),
  "createTime": string,
  "trainingStartTime": string,
  "metrics": {
    string: number,
    ...
  },
  "errorMessage": string
}
שדות
name

string

חובה. שם המשאב המלא של המודל.

פורמט: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/customTuningModels/{custom_tuning_model}

הדגם חייב להיות מחרוזת אלפאנומרית באורך של עד 40 תווים.
displayName

string

השם המוצג של המודל.
modelVersion

string (int64 format)

גרסת המודל.
modelState

enum (ModelState)

המצב של המודל (למשל TRAINING או TRAINING_FAILED).
createTime
(deprecated)

string (Timestamp format)

יצא משימוש: חותמת הזמן שבה נוצר המודל.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
trainingStartTime

string (Timestamp format)

חותמת הזמן שבה התחיל אימון המודל.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
metrics

map (key: string, value: number)

מדדים של המודל שאומן.
errorMessage

string

כרגע, הערך הזה מאוכלס רק אם מצב המודל הוא INPUT_VALIDATION_FAILED.

ModelState

מצב המודל.

טיפוסים בני מנייה (enum)
MODEL_STATE_UNSPECIFIED ערך ברירת המחדל.
TRAINING_PAUSED המודל נמצא במצב אימון מושהה.
TRAINING המודל נמצא כרגע בתהליך אימון.
TRAINING_COMPLETE האימון של המודל הושלם בהצלחה.
READY_FOR_SERVING המודל מוכן להצגה.
TRAINING_FAILED אימון המודל נכשל.
NO_IMPROVEMENT אימון המודל הסתיים בהצלחה, אבל המדדים לא השתפרו.
INPUT_VALIDATION_FAILED אימות נתוני הקלט נכשל. אימון המודל לא התחיל.