Method: projects.locations.collections.engines.patch

עדכון של Engine

בקשת HTTP

PATCH https://discoveryengine.googleapis.com/v1/{engine.name=projects/*/locations/*/collections/*/engines/*}

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

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

פרמטרים
engine.name

string

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

השדה הזה חייב להיות מחרוזת בקידוד UTF-8, עם מגבלת אורך של 1,024 תווים.

פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} המנוע צריך להכיל 1-63 תווים, והתווים התקפים הם /[a-z0-9][a-z0-9-_]*/. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.

פרמטרים של שאילתה

פרמטרים
updateMask

string (FieldMask format)

מציין אילו שדות בקובץ Engine שסופק צריך לעדכן.

אם מספקים שדה לא נתמך או לא ידוע, מוחזרת שגיאה מסוג INVALID_ARGUMENT.

זוהי רשימה מופרדת בפסיקים של שמות שדות שמוגדרים במלואם. דוגמה: "user.displayName,photo"

גוף הבקשה

גוף הבקשה מכיל מופע של Engine.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Engine.

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.engines.update

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