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

Impor massal beberapa Document. Pemrosesan permintaan dapat bersifat sinkron. Item yang tidak ada akan dibuat.

Catatan: Sebagian kecil Document dapat berhasil diperbarui.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource cabang induk, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Memerlukan izin pembuatan/pembaruan.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi 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.
}
Kolom
errorConfig

object (ImportErrorConfig)

Lokasi yang diinginkan untuk error yang terjadi selama Impor.
reconciliationMode

enum (ReconciliationMode)

Mode rekonsiliasi antara dokumen yang ada dan dokumen yang akan diimpor. Nilai defaultnya adalah ReconciliationMode.INCREMENTAL.
updateMask

string (FieldMask format)

Menunjukkan kolom mana dalam dokumen impor yang diberikan yang akan diperbarui. Jika tidak ditetapkan, defaultnya adalah memperbarui semua kolom.

Ini adalah comma-separated list berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".
autoGenerateIds

boolean

Apakah akan membuat ID secara otomatis untuk dokumen jika tidak ada.

Jika disetel ke true, Document.id akan otomatis dibuat berdasarkan hash payload, dengan ID yang mungkin tidak konsisten selama beberapa kali impor. Dalam hal ini, sebaiknya gunakan ReconciliationMode.FULL untuk menghindari konten duplikat. Jika tidak disetel atau disetel ke false, Document.id harus ditentukan menggunakan idField. Jika tidak, dokumen tanpa ID akan gagal diimpor.

Sumber data yang didukung:
idField

string

Kolom ini menunjukkan kolom atau kolom ID yang akan digunakan sebagai ID unik dokumen.

Untuk GcsSource, ini adalah kunci kolom JSON. Misalnya, my_id untuk JSON {"my_id": "some_uuid"}. Untuk yang lain, mungkin berupa nama kolom tabel tempat ID unik disimpan.

Nilai kolom tabel atau kolom JSON digunakan sebagai Document.id. Kolom JSON atau kolom tabel harus berjenis string, dan nilai harus ditetapkan sebagai string valid yang sesuai dengan RFC-1034 dengan 1-63 karakter. Jika tidak, dokumen tanpa ID yang valid akan gagal diimpor.

Tetapkan kolom ini hanya jika autoGenerateIds tidak ditetapkan atau ditetapkan sebagai false. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

Jika tidak disetel, nilai default Id akan digunakan saat mengimpor dari sumber data yang diizinkan.

Sumber data yang didukung:
forceRefreshContent

boolean

Opsional. Apakah akan memuat ulang konten tidak terstruktur dokumen secara paksa.

Jika disetel ke true, bagian konten dokumen akan diperbarui terlepas dari status pembaruan konten yang merujuk.
Kolom union source. Wajib. Sumber input. source hanya ada berupa salah satu diantara berikut:
inlineSource

object (InlineSource)

Sumber Inline untuk konten input dokumen.
gcsSource

object (GcsSource)

Lokasi Cloud Storage untuk konten input.
bigquerySource

object (BigQuerySource)

Sumber input BigQuery.
fhirStoreSource

object (FhirStoreSource)

Sumber input FhirStore.
spannerSource

object (SpannerSource)

Sumber input Spanner.
cloudSqlSource

object (CloudSqlSource)

Sumber input Cloud SQL.
firestoreSource

object (FirestoreSource)

Sumber input Firestore.
alloyDbSource

object (AlloyDbSource)

Sumber input AlloyDB.
bigtableSource

object (BigtableSource)

Sumber input Cloud Bigtable.

Isi respons

Jika berhasil, isi respons akan berisi instance Operation.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource parent:

  • discoveryengine.documents.import

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.