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

Importation par lots de plusieurs Documents. Le traitement des requêtes peut être synchrone. Les éléments inexistants sont créés.

Remarque : Il est possible qu'un sous-ensemble des Documents soit mis à jour.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la ressource de branche parente, par exemple projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Nécessite l'autorisation de création/mise à jour.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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.
}
Champs
errorConfig

object (ImportErrorConfig)

Emplacement souhaité des erreurs survenues lors de l'importation.
reconciliationMode

enum (ReconciliationMode)

Mode de rapprochement entre les documents existants et les documents à importer. La valeur par défaut est ReconciliationMode.INCREMENTAL.
updateMask

string (FieldMask format)

Indique les champs des documents importés fournis à mettre à jour. Si aucune valeur n'est définie, la valeur par défaut consiste à mettre à jour tous les champs.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo".
autoGenerateIds

boolean

Indique s'il faut générer automatiquement des ID pour les documents en cas d'absence.

Si la valeur est définie sur true, les Document.id sont générés automatiquement en fonction du hachage de la charge utile, où les ID peuvent ne pas être cohérents lors de plusieurs importations. Dans ce cas, il est fortement recommandé d'utiliser ReconciliationMode.FULL pour éviter les contenus en double. Si la valeur n'est pas définie ou est définie sur false, les Document.id doivent être spécifiés à l'aide de idField. Sinon, les documents sans ID ne peuvent pas être importés.

Sources de données compatibles :
idField

string

Le champ indique le champ ou la colonne d'ID à utiliser comme ID uniques des documents.

Pour GcsSource, il s'agit de la clé du champ JSON. Par exemple, my_id pour JSON {"my_id": "some_uuid"}. Pour les autres, il peut s'agir du nom de la colonne de la table dans laquelle les ID uniques sont stockés.

Les valeurs du champ JSON ou de la colonne de la table sont utilisées comme Document.id. Le champ JSON ou la colonne de la table doivent être de type chaîne, et les valeurs doivent être définies comme des chaînes valides conformes à la norme RFC-1034 avec 1 à 63 caractères. Sinon, les documents sans ID valides ne peuvent pas être importés.

Ne définissez ce champ que lorsque autoGenerateIds n'est pas défini ou est défini sur false. Dans le cas contraire, une erreur INVALID_ARGUMENT est renvoyée.

Si aucune valeur n'est définie, la valeur par défaut Id est utilisée lors de l'importation à partir des sources de données autorisées.

Sources de données compatibles :
forceRefreshContent

boolean

Facultatif. Indique s'il faut forcer l'actualisation du contenu non structuré des documents.

Si la valeur est définie sur true, la partie de contenu des documents est actualisée, quel que soit l'état de mise à jour du contenu référencé.
Champ d'union source. Obligatoire. Source de l'entrée. source ne peut être qu'un des éléments suivants :
inlineSource

object (InlineSource)

Source intégrée pour le contenu d'entrée des documents.
gcsSource

object (GcsSource)

Emplacement Cloud Storage pour le contenu d'entrée.
bigquerySource

object (BigQuerySource)

Source d'entrée BigQuery.
fhirStoreSource

object (FhirStoreSource)

Source d'entrée FhirStore.
spannerSource

object (SpannerSource)

Source d'entrée Spanner.
cloudSqlSource

object (CloudSqlSource)

Source d'entrée Cloud SQL.
firestoreSource

object (FirestoreSource)

Source d'entrée Firestore.
alloyDbSource

object (AlloyDbSource)

Source d'entrée AlloyDB.
bigtableSource

object (BigtableSource)

Source d'entrée Cloud Bigtable.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • discoveryengine.documents.import

Pour en savoir plus, consultez la documentation IAM.