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

Importación masiva de varios Documents. El procesamiento de solicitudes puede ser síncrono. Se crean los elementos que no existen.

Nota: Es posible que un subconjunto de los Documents se actualice correctamente.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Es el nombre del recurso superior de la rama, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Requiere permiso de creación o actualización.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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.
}
Campos
errorConfig

object (ImportErrorConfig)

Es la ubicación deseada de los errores que se produjeron durante la importación.
reconciliationMode

enum (ReconciliationMode)

Es el modo de conciliación entre los documentos existentes y los que se importarán. La configuración predeterminada es ReconciliationMode.INCREMENTAL.
updateMask

string (FieldMask format)

Indica qué campos de los documentos importados proporcionados se deben actualizar. Si no se configura, la opción predeterminada es actualizar todos los campos.

Esta es una lista separada por comas de los nombres de campos completamente calificados. Ejemplo: "user.displayName,photo".
autoGenerateIds

boolean

Indica si se deben generar automáticamente IDs para los documentos si no están presentes.

Si se establece en true, los Document.ids se generan automáticamente en función del hash de la carga útil, en la que los IDs pueden no ser coherentes durante varias importaciones. En ese caso, se recomienda ReconciliationMode.FULL para evitar contenido duplicado. Si no se establece o se establece en false, los Document.ids se deben especificar con idField. De lo contrario, no se podrán importar los documentos sin IDs.

Fuentes de datos compatibles:
idField

string

El campo indica el campo o la columna de ID que se usará como IDs únicos de los documentos.

Para GcsSource, es la clave del campo JSON. Por ejemplo, my_id para JSON {"my_id": "some_uuid"}. Para otros, puede ser el nombre de la columna de la tabla en la que se almacenan los IDs únicos.

Los valores del campo JSON o de la columna de la tabla se usan como Document.ids. El campo JSON o la columna de la tabla deben ser de tipo string, y los valores deben establecerse como cadenas válidas que cumplan con RFC-1034 con 1 a 63 caracteres. De lo contrario, no se podrán importar los documentos sin IDs válidos.

Solo establece este campo cuando autoGenerateIds no esté establecido o se establezca como false. De lo contrario, se arroja un error INVALID_ARGUMENT.

Si no se establece, se usa un valor predeterminado Id cuando se importa desde las fuentes de datos permitidas.

Fuentes de datos compatibles:
forceRefreshContent

boolean

Es opcional. Indica si se debe forzar la actualización del contenido no estructurado de los documentos.

Si se establece en true, se actualizará la parte de contenido de los documentos, independientemente del estado de actualización del contenido de referencia.
Campo de unión source. Obligatorio. Es la fuente de la entrada. source puede ser solo uno de los parámetros siguientes:
inlineSource

object (InlineSource)

Es la fuente intercalada para el contenido de entrada de los documentos.
gcsSource

object (GcsSource)

Es la ubicación de Cloud Storage para el contenido de entrada.
bigquerySource

object (BigQuerySource)

Es la fuente de entrada de BigQuery.
fhirStoreSource

object (FhirStoreSource)

Es la fuente de entrada de FhirStore.
spannerSource

object (SpannerSource)

Es la fuente de entrada de Spanner.
cloudSqlSource

object (CloudSqlSource)

Es la fuente de entrada de Cloud SQL.
firestoreSource

object (FirestoreSource)

Es la fuente de entrada de Firestore.
alloyDbSource

object (AlloyDbSource)

Es la fuente de entrada de AlloyDB.
bigtableSource

object (BigtableSource)

Es la fuente de entrada de Cloud Bigtable.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.documents.import

Para obtener más información, consulta la documentación de IAM.