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

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

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

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa del ramo padre, 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,

  // 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.
}
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 è 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 dei documenti se non sono presenti.

Se impostato su true, gli Document.id vengono generati automaticamente in base all'hash del payload, dove gli ID potrebbero non essere coerenti durante più importazioni. In questo caso, è altamente consigliato utilizzare ReconciliationMode.FULL per evitare contenuti duplicati. Se non è impostato o è impostato su false, gli Document.id devono essere specificati utilizzando idField. In caso contrario, i documenti senza ID non verranno importati.

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 gli altri, potrebbe essere il nome della colonna della tabella in cui sono memorizzati 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 devono essere di tipo stringa e i valori devono essere impostati come stringhe valide conformi a RFC-1034 con 1-63 caratteri. In caso contrario, i documenti senza ID validi non verranno importati.

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. Indica se forzare l'aggiornamento dei contenuti non strutturati dei documenti.

Se impostato su true, la parte di contenuto dei documenti verrà aggiornata indipendentemente dallo stato di aggiornamento dei contenuti di riferimento.
Campo unione source. Obbligatorio. L'origine dell'input. source può essere solo uno dei seguenti tipi:
inlineSource

object (InlineSource)

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

object (GcsSource)

La posizione in Cloud Storage per i contenuti di input.
bigquerySource

object (BigQuerySource)

Sorgente di ingresso BigQuery.
fhirStoreSource

object (FhirStoreSource)

Sorgente di ingresso FhirStore.
spannerSource

object (SpannerSource)

Sorgente di ingresso Spanner.
cloudSqlSource

object (CloudSqlSource)

Sorgente di ingresso Cloud SQL.
firestoreSource

object (FirestoreSource)

Sorgente di ingresso Firestore.
alloyDbSource

object (AlloyDbSource)

Sorgente di ingresso AlloyDB.
bigtableSource

object (BigtableSource)

Sorgente di ingresso Cloud Bigtable.

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.