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

Bulk-Import mehrerer Documents. Die Anfrageverarbeitung kann synchron erfolgen. Nicht vorhandene Elemente werden erstellt.

Hinweis: Es ist möglich, dass nur eine Teilmenge der Document erfolgreich aktualisiert wird.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname des übergeordneten Zweigs, z. B. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Erfordert die Berechtigung zum Erstellen/Aktualisieren.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "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.
}
Felder
errorConfig

object (ImportErrorConfig)

Der gewünschte Speicherort für Fehler, die während des Imports aufgetreten sind.
reconciliationMode

enum (ReconciliationMode)

Der Abgleichsmodus zwischen vorhandenen Dokumenten und den zu importierenden Dokumenten. Die Standardeinstellung ist ReconciliationMode.INCREMENTAL.
updateMask

string (FieldMask format)

Gibt an, welche Felder in den bereitgestellten importierten Dokumenten aktualisiert werden sollen. Wenn nicht festgelegt, werden standardmäßig alle Felder aktualisiert.

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".
autoGenerateIds

boolean

Gibt an, ob IDs für die Dokumente automatisch generiert werden sollen, wenn sie nicht vorhanden sind.

Wenn der Wert auf true festgelegt ist, werden Document.ids automatisch auf Grundlage des Hash der Nutzlast generiert. Die IDs sind bei mehreren Importen möglicherweise nicht konsistent. In diesem Fall wird ReconciliationMode.FULL dringend empfohlen, um doppelte Inhalte zu vermeiden. Wenn nicht festgelegt oder auf false gesetzt, müssen Document.ids mit idField angegeben werden. Andernfalls können Dokumente ohne IDs nicht importiert werden.

Unterstützte Datenquellen:
idField

string

Das Feld gibt das ID-Feld oder die ID-Spalte an, die als eindeutige IDs der Dokumente verwendet werden soll.

Für GcsSource ist es der Schlüssel des JSON-Felds. Beispiel: my_id für JSON {"my_id": "some_uuid"}. Für andere ist es möglicherweise der Spaltenname der Tabelle, in der die eindeutigen IDs gespeichert sind.

Die Werte des JSON-Felds oder der Tabellenspalte werden als Document.id verwendet. Das JSON-Feld oder die Tabellenspalte muss vom Typ „String“ sein und die Werte müssen als gültige Strings gemäß RFC-1034 mit 1 bis 63 Zeichen festgelegt werden. Andernfalls können Dokumente ohne gültige IDs nicht importiert werden.

Legen Sie dieses Feld nur fest, wenn autoGenerateIds nicht festgelegt oder auf false gesetzt ist. Andernfalls wird der Fehler INVALID_ARGUMENT ausgegeben.

Wenn es nicht festgelegt ist, wird beim Importieren aus den zulässigen Datenquellen der Standardwert Id verwendet.

Unterstützte Datenquellen:
forceRefreshContent

boolean

Optional. Gibt an, ob der unstrukturierte Inhalt der Dokumente aktualisiert werden soll.

Wenn diese Option auf true gesetzt ist, wird der Inhaltsteil der Dokumente unabhängig vom Aktualisierungsstatus des referenzierten Inhalts aktualisiert.
Union-Feld source. Erforderlich. Die Quelle der Eingabe. Für source ist nur einer der folgenden Werte zulässig:
inlineSource

object (InlineSource)

Die Inline-Quelle für die Eingabeinhalte für Dokumente.
gcsSource

object (GcsSource)

Cloud Storage-Speicherort für die Eingabeinhalte.
bigquerySource

object (BigQuerySource)

BigQuery-Eingabequelle.
fhirStoreSource

object (FhirStoreSource)

FhirStore-Eingabequelle.
spannerSource

object (SpannerSource)

Spanner-Eingabequelle.
cloudSqlSource

object (CloudSqlSource)

Cloud SQL-Eingabequelle.
firestoreSource

object (FirestoreSource)

Firestore-Eingabequelle.
alloyDbSource

object (AlloyDbSource)

AlloyDB-Eingabequelle.
bigtableSource

object (BigtableSource)

Cloud Bigtable-Eingabequelle.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • discoveryengine.documents.import

Weitere Informationen finden Sie in der IAM-Dokumentation.