Method: corpora.documents.patch

מתבצע עדכון של Document.

בקשת HTTP

PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

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

פרמטרים
document.name

string

לא משתנה. מזהה. שם המשאב Document. המזהה (לא כולל הקידומת 'corpora/*/documents/') יכול להכיל עד 40 תווים אלפאנומריים או מקפים (-) באותיות קטנות. המזהה לא יכול להתחיל או להסתיים במקף. אם השם יהיה ריק בשלב היצירה, המערכת תפיק שם ייחודי מהמזהה displayName עם סיומת אקראית של 12 תווים. דוגמה: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

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

פרמטרים
updateMask

string (FieldMask format)

חובה. רשימת השדות לעדכון. בשלב זה, אפשרות זו תומכת רק בעדכון של displayName ושל customMetadata.

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/generative-language.retriever

למידע נוסף, קראו את הסקירה הכללית על אימות.