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

Importazione collettiva di più Document. L'elaborazione della richiesta potrebbe essere sincrona. Vengono creati elementi non esistenti.

Nota: è possibile che venga aggiornato correttamente un sottoinsieme di Document.

Richiesta HTTP


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

Gli URL utilizzano la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa del ramo principale, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Richiede l'autorizzazione di creazione/aggiornamento.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione 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.
}
Campi
errorConfig

object (ImportErrorConfig)

La posizione desiderata degli errori riscontrati durante l'importazione.
reconciliationMode

enum (ReconciliationMode)

La modalità di riconciliazione tra i documenti esistenti e quelli da importare. Il valore predefinito è ReconciliationMode.INCREMENTAL.
updateMask

string (FieldMask format)

Indica quali campi dei documenti importati forniti devono essere aggiornati. Se non è impostato, il valore predefinito prevede l'aggiornamento di tutti i campi.

Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".
autoGenerateIds

boolean

Indica se generare automaticamente gli ID per i documenti se non sono presenti.

Se impostato su true, i Document.id vengono generati automaticamente in base all'hash del payload, dove gli ID potrebbero non essere coerenti durante più importazioni. In questo caso, è consigliabile utilizzare ReconciliationMode.FULL per evitare contenuti duplicati. Se non è impostato o è impostato su false, gli Document.id devono essere specificati utilizzando idField, altrimenti l'importazione dei documenti senza ID non va a buon fine.

Origini dati supportate:
idField

string

Il campo indica il campo o la colonna ID da utilizzare come ID univoci dei documenti.

Per GcsSource è la chiave del campo JSON. Ad esempio, my_id per JSON {"my_id": "some_uuid"}. Per altri, potrebbe essere il nome della colonna della tabella in cui sono archiviati gli ID univoci.

I valori del campo JSON o della colonna della tabella vengono utilizzati come Document.id. Il campo JSON o la colonna della tabella deve essere di tipo stringa e i valori devono essere impostati come stringhe valide conformi a RFC-1034 con 1-63 caratteri. In caso contrario, l'importazione dei documenti senza ID validi non andrà a buon fine.

Imposta questo campo solo quando autoGenerateIds non è impostato o è impostato su false. In caso contrario, viene generato un errore INVALID_ARGUMENT.

Se non è impostato, viene utilizzato un valore predefinito Id durante l'importazione dalle origini dati consentite.

Origini dati supportate:
forceRefreshContent

boolean

Facoltativo. Se forzare l'aggiornamento dei contenuti non strutturati dei documenti.

Se impostato su true, la parte dei contenuti dei documenti verrà aggiornata indipendentemente dallo stato di aggiornamento dei contenuti di riferimento.
Obbligatorio. L'origine dell'input. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
inlineSource

object (InlineSource)

L'origine in linea per i contenuti di input per i documenti.
gcsSource

object (GcsSource)

Il percorso Cloud Storage dei contenuti di input.
bigquerySource

object (BigQuerySource)

Origine di input BigQuery.
fhirStoreSource

object (FhirStoreSource)

Origine di input FhirStore.
spannerSource

object (SpannerSource)

Origine di input Spanner.
cloudSqlSource

object (CloudSqlSource)

Origine di input Cloud SQL.
firestoreSource

object (FirestoreSource)

Origine di input Firestore.
alloyDbSource

object (AlloyDbSource)

Origine di input AlloyDB.
bigtableSource

object (BigtableSource)

Origine di input Cloud Bigtable.
Fine dei campi che si escludono a vicenda.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Operation.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • discoveryengine.documents.import

Per saperne di più, consulta la documentazione di IAM.