Method: projects.locations.collections.dataStores.branches.documents.patch

עדכון של Document.

בקשת HTTP

PATCH https://discoveryengine.googleapis.com/v1alpha/{document.name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}

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

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

פרמטרים
document.name

string

אי אפשר לשנות. השם המלא של המשאב של המסמך. פורמט: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}

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

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

פרמטרים
allowMissing

boolean

אם הערך הוא true והמערכת לא מוצאת את Document, היא תיצור Document חדש.
updateMask

string (FieldMask format)

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

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.documents.update

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