Method: projects.locations.dataStores.patch

עדכון הפרמטרים של מאגר נתונים אחד.

‫dataStores.patch, dataStores.importDocuments ו-dataStores.purgeDocuments פועלים אחד בכל פעם לכל DataStore. בזמן שפעולה אחת פועלת, פעולה נוספת יכולה להמתין. כל בקשה נוספת תיכשל עם השגיאה ABORTED עד שהפעולה שפועלת תסתיים.

בקשת HTTP

PATCH https://vectorsearch.googleapis.com/v1beta/{dataStore.name}

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

פרמטרים
dataStore.name

string

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

פורמט: projects/{project}/locations/{location}/dataStores/{dataStoreId}

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

פרמטרים
updateMask

string (FieldMask format)

זה שינוי אופציונלי. מסכת השדות משמשת כדי לציין את השדות שיוחלפו במשאב DataStore על ידי העדכון. השדות שצוינו ב-updateMask הם יחסיים למשאב, ולא לבקשה המלאה. שדה יוחלף אם הוא נמצא במסכה. נתיב שנותן שם להודעה מחליף את כל ההודעה: שדות משנה שהושמטו מהבקשה נמחקים, ומוגדרים מחדש לברירות המחדל שלהם ב-processingConfig.

אם המשתמש לא מספק מסכה, כל שדה שהבקשה מגדירה לערך שאינו ברירת מחדל יוחלף. הודעות שנשלחות ריקות (לדוגמה layoutParsingConfig: {}) ושדות שמוגדרים לערך ברירת המחדל שלהם (לדוגמה false) לא מוחלים. במקום זאת, צריך לתת להם שם במסכה.

אפשר לעדכן את השדות הבאים: displayName,‏ description,‏ labels,‏ processingConfig ו-documentMetadataSchema. צריך לעדכן את documentMetadataSchema כמכלול (נתיב המסכה הוא documentMetadataSchema), ורק על ידי הוספת מאפיינים: אי אפשר להסיר או לשנות מאפיינים קיימים.

אם * צוין ב-updateMask, תתבצע החלפה מלאה.

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

string

זה שינוי אופציונלי. מזהה בקשה אופציונלי לזיהוי בקשות. ציינו מזהה בקשה ייחודי, כדי שאם תצטרכו לנסות שוב לשלוח את הבקשה, השרת יידע להתעלם ממנה אם היא כבר הושלמה. השרת יבטיח זאת למשך 60 דקות לפחות מהבקשה הראשונה.

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

מזהה הבקשה חייב להיות UUID תקין, אבל אין תמיכה ב-UUID עם אפסים (00000000-0000-0000-0000-000000000000).

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

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

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