הערה: חבילת המסמכים הזו מיועדת למהדורות Standard,‏ Plus,‏ תשלום לפי שימוש ו-Frontline של Gemini Enterprise. לעיון במסמכי התיעוד של מהדורת Business, אפשר להיכנס אל מרכז העזרה של Gemini Enterprise – מהדורת Business.

‫Google משתמשת בטכנולוגיית AI כדי לתרגם תוכן לשפה המועדפת עליך. בתרגומים כאלו עשויות להיות שגיאות.

Method: projects.locations.dataStores.branches.documents.import

בקשת HTTP
פרמטרים של נתיב
גוף הבקשה
- ייצוג ב-JSON
גוף התגובה
היקפי הרשאות
הרשאות IAM

ייבוא בכמות גדולה של כמה Document. יכול להיות שעיבוד הבקשה יתבצע באופן סינכרוני. פריטים שלא קיימים נוצרים.

הערה: יכול להיות שרק חלק מה-Documents יעודכנו בהצלחה.

בקשת HTTP

בוחרים נקודת קצה:

POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents:import

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

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

פרמטרים

פרמטרים
`parent`	`string` חובה. שם המשאב של ענף ההורה, למשל `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}`. נדרשת הרשאת יצירה או עדכון.

parent

string

חובה. שם המשאב של ענף ההורה, למשל projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. נדרשת הרשאת יצירה או עדכון.

גוף הבקשה

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

ייצוג ב-JSON

ייצוג ב-JSON
{ "errorConfig": { object (`ImportErrorConfig`) }, "reconciliationMode": enum (`ReconciliationMode`), "updateMask": string, "autoGenerateIds": boolean, "idField": string, "forceRefreshContent": boolean, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "inlineSource": { object (`InlineSource`) }, "gcsSource": { object (`GcsSource`) }, "bigquerySource": { object (`BigQuerySource`) }, "fhirStoreSource": { object (`FhirStoreSource`) }, "spannerSource": { object (`SpannerSource`) }, "cloudSqlSource": { object (`CloudSqlSource`) }, "firestoreSource": { object (`FirestoreSource`) }, "alloyDbSource": { object (`AlloyDbSource`) }, "bigtableSource": { object (`BigtableSource`) } // End of mutually exclusive fields. }

{
  "errorConfig": {
    object (ImportErrorConfig)
  },
  "reconciliationMode": enum (ReconciliationMode),
  "updateMask": string,
  "autoGenerateIds": boolean,
  "idField": string,
  "forceRefreshContent": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "inlineSource": {
    object (InlineSource)
  },
  "gcsSource": {
    object (GcsSource)
  },
  "bigquerySource": {
    object (BigQuerySource)
  },
  "fhirStoreSource": {
    object (FhirStoreSource)
  },
  "spannerSource": {
    object (SpannerSource)
  },
  "cloudSqlSource": {
    object (CloudSqlSource)
  },
  "firestoreSource": {
    object (FirestoreSource)
  },
  "alloyDbSource": {
    object (AlloyDbSource)
  },
  "bigtableSource": {
    object (BigtableSource)
  }
  // End of mutually exclusive fields.
}

שדות
`errorConfig`	`object (ImportErrorConfig)` המיקום הרצוי של השגיאות שמתרחשות במהלך הייבוא.
`reconciliationMode`	`enum (ReconciliationMode)` אופן ההתאמה בין מסמכים קיימים לבין המסמכים שיובאו. ברירת המחדל היא `ReconciliationMode.INCREMENTAL`.
`updateMask`	`string (FieldMask format)` מציין אילו שדות במסמכים המיובאים שסופקו צריך לעדכן. אם לא מגדירים את המדיניות, ברירת המחדל היא לעדכן את כל השדות. זוהי רשימה מופרדת בפסיקים של שמות שדות שמוגדרים במלואם. דוגמה: `"user.displayName,photo"`
`autoGenerateIds`	`boolean` האם ליצור מזהים באופן אוטומטי למסמכים אם הם לא קיימים. אם הערך מוגדר כ-`true`, המערכת יוצרת באופן אוטומטי `Document.id`s על סמך הגיבוב של מטען הייעודי (payload), כך שהמזהים לא בהכרח יהיו עקביים במהלך כמה פעולות ייבוא. במקרה כזה, מומלץ מאוד להשתמש ב-`ReconciliationMode.FULL` כדי להימנע מתוכן כפול. אם המדיניות לא מוגדרת או מוגדרת לערך `false`, צריך לציין את `Document.id` באמצעות `idField`, אחרת לא ניתן לייבא מסמכים ללא מזהים. מקורות נתונים נתמכים: ‫`GcsSource`. הערך של `GcsSource.data_schema` צריך להיות `custom` או `csv`. אחרת, מוצגת שגיאה מסוג INVALID_ARGUMENT. ‫`BigQuerySource`. הערך של `BigQuerySource.data_schema` צריך להיות `custom` או `csv`. אחרת, מוצגת שגיאה מסוג INVALID_ARGUMENT. `SpannerSource`. `CloudSqlSource`. `FirestoreSource`. `BigtableSource`.
`idField`	`string` בשדה הזה מציינים את השדה או העמודה של המזהים שבהם יש להשתמש כמזהים ייחודיים של המסמכים. בשביל `GcsSource` זה המפתח של שדה ה-JSON. לדוגמה, `my_id` עבור JSON `{"my_id": "some_uuid"}`. עבור אחרים, זה יכול להיות שם העמודה בטבלה שבה מאוחסנים המזהים הייחודיים. הערכים של שדה ה-JSON או של עמודת הטבלה משמשים כ-`Document.id`s. השדה ב-JSON או העמודה בטבלה צריכים להיות מסוג מחרוזת, והערכים צריכים להיות מחרוזות תקינות בהתאם ל-RFC-1034, באורך של 1 עד 63 תווים. אחרת, לא ניתן לייבא מסמכים ללא מזהים תקינים. מגדירים את השדה הזה רק אם השדה `autoGenerateIds` לא מוגדר או מוגדר כ-`false`. אחרת, מוצגת שגיאה מסוג INVALID_ARGUMENT. אם לא מגדירים ערך, המערכת משתמשת בערך ברירת המחדל `Id` כשמייבאים נתונים ממקורות הנתונים המותרים. מקורות נתונים נתמכים: ‫`GcsSource`. הערך של `GcsSource.data_schema` צריך להיות `custom` או `csv`. אחרת, מוצגת שגיאה מסוג INVALID_ARGUMENT. ‫`BigQuerySource`. הערך של `BigQuerySource.data_schema` צריך להיות `custom` או `csv`. אחרת, מוצגת שגיאה מסוג INVALID_ARGUMENT. `SpannerSource`. `CloudSqlSource`. `BigtableSource`.
`forceRefreshContent`	`boolean` זה שינוי אופציונלי. האם לרענן בכוח את התוכן הלא מובנה של המסמכים. אם הערך מוגדר ל-`true`, החלק של התוכן במסמכים ירענן ללא קשר לסטטוס העדכון של התוכן שאליו יש הפניה.
חובה. המקור של הקלט. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
`inlineSource`	`object (InlineSource)` המקור של התוכן שמוזן למסמכים.
`gcsSource`	`object (GcsSource)` מיקום ב-Cloud Storage של תוכן הקלט.
`bigquerySource`	`object (BigQuerySource)` מקור קלט של BigQuery.
`fhirStoreSource`	`object (FhirStoreSource)` מקור הקלט של FhirStore.
`spannerSource`	`object (SpannerSource)` מקור קלט של Spanner.
`cloudSqlSource`	`object (CloudSqlSource)` מקור קלט של Cloud SQL.
`firestoreSource`	`object (FirestoreSource)` מקור הקלט של Firestore.
`alloyDbSource`	`object (AlloyDbSource)` מקור קלט של AlloyDB.
`bigtableSource`	`object (BigtableSource)` מקור קלט של Cloud Bigtable.
סוף השדות הבלעדיים.

גוף התשובה

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

discoveryengine.documents.import

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

Method: projects.locations.dataStores.branches.documents.import קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.