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

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

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

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

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

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

בקשת HTTP

POST https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/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` על סמך הגיבוב של מטען הייעוד, כך שהמזהים לא בהכרח יהיו עקביים במהלך כמה ייבואים. במקרה כזה, מומלץ מאוד להשתמש ב-`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`. השדה ב-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.collections.dataStores.branches.documents.import קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.