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

大量匯入多個 Document。要求處理作業可能是同步進行。系統會建立不存在的項目。

注意：部分 Document 可能成功更新。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
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

是否要在文件 ID 不存在時自動產生 ID。

如果設為 true，系統會根據酬載的雜湊自動產生 Document.id，因此多次匯入時 ID 可能不一致。在這種情況下，我們強烈建議使用 ReconciliationMode.FULL，以免內容重複。如未設定或設為 false，則必須使用 idField 指定 Document.id，否則系統無法匯入沒有 ID 的文件。

支援的資料來源：
idField

string

這個欄位會指出要當做文件專屬 ID 的 ID 欄位或資料欄。

如果是 GcsSource，則為 JSON 欄位的鍵。舉例來說，JSON {"my_id": "some_uuid"} 的 my_id。如果是其他資料來源，則可能是儲存專屬 ID 的資料表欄名。

JSON 欄位或表格資料欄的值會做為 Document.id。JSON 欄位或資料表資料欄必須為字串類型，且值必須設為符合 RFC-1034 的有效字串，長度為 1 至 63 個字元。否則，系統將無法匯入沒有有效 ID 的文件。

只有在 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 權限

需要 parent 資源的下列 IAM 權限：

  • discoveryengine.documents.import

詳情請參閱 IAM 說明文件。