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

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

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

בקשת HTTP

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

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

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

פרמטרים
parent

string

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

גוף הבקשה

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

ייצוג ב-JSON 
{
  "errorConfig": {
    object (ImportErrorConfig)
  },
  "reconciliationMode": enum (ReconciliationMode),
  "updateMask": string,
  "autoGenerateIds": boolean,
  "idField": string,
  "forceRefreshContent": boolean,

  // Union field source can be only one of the following:
  "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 list of possible types for union field source.
}
שדות
errorConfig

object (ImportErrorConfig)

המיקום הרצוי של השגיאות שמתרחשות במהלך הייבוא.
reconciliationMode

enum (ReconciliationMode)

מצב ההתאמה בין מסמכים קיימים לבין המסמכים שיובאו. ברירת המחדל היא ReconciliationMode.INCREMENTAL.
updateMask

string (FieldMask format)

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

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

boolean

האם ליצור מזהים באופן אוטומטי למסמכים אם הם לא קיימים.

אם הערך הוא true, המערכת יוצרת באופן אוטומטי Document.ids על סמך הגיבוב של מטען הייעודי (payload), ולכן יכול להיות שהמזהים לא יהיו עקביים במהלך כמה ייבואים. במקרה כזה, מומלץ מאוד להשתמש ב-ReconciliationMode.FULL כדי להימנע מתוכן כפול. אם המדיניות לא מוגדרת או מוגדרת כ-false, צריך לציין את Document.id באמצעות idField, אחרת לא ניתן לייבא מסמכים ללא מזהים.

מקורות נתונים נתמכים:
idField

string

בשדה הזה מציינים את השדה או העמודה של המזהים הייחודיים של המסמכים.

בשביל GcsSource זה המפתח של שדה ה-JSON. לדוגמה, my_id ל-JSON {"my_id": "some_uuid"}. עבור אחרים, זה יכול להיות שם העמודה בטבלה שבה מאוחסנים המזהים הייחודיים.

הערכים בשדה ה-JSON או בעמודה בטבלה משמשים כ-Document.id. השדה JSON או העמודה בטבלה צריכים להיות מסוג מחרוזת, והערכים צריכים להיות מחרוזות חוקיות שתואמות ל-RFC-1034 עם 1 עד 63 תווים. אחרת, לא ניתן לייבא מסמכים ללא מזהים תקינים.

מגדירים את השדה הזה רק אם autoGenerateIds לא מוגדר או מוגדר כ-false. אחרת, מוצגת השגיאה INVALID_ARGUMENT.

אם לא מוגדר ערך, המערכת תשתמש בערך ברירת המחדל Id כשמייבאים נתונים ממקורות הנתונים המותרים.

מקורות נתונים נתמכים:
forceRefreshContent

boolean

זה שינוי אופציונלי. האם לרענן בכוח את התוכן הלא מובנה של המסמכים.

אם הערך הוא true, החלק של התוכן במסמכים ירענן ללא קשר לסטטוס העדכון של התוכן שמפנים אליו.
שדה איחוד source. חובה. המקור של הקלט. הערך source יכול להיות רק אחד מהבאים:
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

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

הרשאות IAM

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

  • discoveryengine.documents.import

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