Method: projects.locations.dataStores.importDocuments

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

המערכת מדלגת על קובץ שכבר יובא בהצלחה, אלא אם האובייקט שלו ב-Cloud Storage הוחלף מאז, או אם המטא-נתונים שלו השתנו (ב-SOURCE_FORMAT_DOCUMENT_JSON). קבצים שהייבוא שלהם נכשל בעבר יעובדו שוב. קבצים ספציפיים שלא ניתן לייבא מדווחים בדוח השגיאות (ראו ImportOutputConfig.error_gcs_prefix) במקום לגרום לכישלון של כל הייבוא.

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

בקשת HTTP

POST https://vectorsearch.googleapis.com/v1beta/{name}:importDocuments

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

פרמטרים
name

string

חובה. שם המשאב של מאגר הנתונים שאליו רוצים לייבא מסמכים. פורמט: projects/{project}/locations/{location}/dataStores/{dataStore}.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON
{
  "importOutputConfig": {
    object (ImportOutputConfig)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsSource": {
    object (GcsSource)
  }
  // End of mutually exclusive fields.
}
שדות
importOutputConfig

object (ImportOutputConfig)

זה שינוי אופציונלי. הגדרת היעד לפלט של מסמכי הייבוא: איפה לכתוב את דוח השגיאות של הייבוא.

חובה. מקור הקלט. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
gcsSource

object (GcsSource)

המיקום ב-Cloud Storage של תוכן הקלט. עם ברירת המחדל sourceFormat, ה-URI יכול להיות תבנית כמו gs://my-bucket/folder/*, שתואמת לאובייקטים ישירות ב-folder אבל לא לאובייקטים בתיקיות המשנה שלו. ייבוא אחד יכול לכלול עד 100,000 קבצים למאגר נתונים של UNSTRUCTURED, או 100 למאגר נתונים של VIDEO.

סוף השדות שמוציאים זה את זה.

גוף התשובה

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

היקפי הרשאות

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

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

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

ImportOutputConfig

הגדרת היעד לפלט שקשור למסמכי ייבוא.

ייצוג ב-JSON
{
  "errorGcsPrefix": string
}
שדות
errorGcsPrefix

string

זה שינוי אופציונלי. קידומת ה-URI של המיקום ב-Cloud Storage שבו ייכתבו השגיאות שיתרחשו במהלך הייבוא. אסור שהקידומת תכיל אובייקטים. השגיאות נכתבות לקבצים מפוצלים עם הקידומת הזו, אחת בכל שורה, כהודעת google.rpc.Status בקידוד JSON. אם השדה הזה ריק, לא נכתב דוח שגיאות.