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

Importação em massa de vários Documents. O processamento de pedidos pode ser síncrono. Os itens não existentes são criados.

Nota: é possível que um subconjunto dos Documents seja atualizado com êxito.

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso da ramificação principal, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Requer autorização para criar/atualizar.

Corpo do pedido

O corpo do pedido contém dados com a seguinte estrutura:

Representação 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)

A localização desejada dos erros incorridos durante a importação.
reconciliationMode

enum (ReconciliationMode)

O modo de conciliação entre os documentos existentes e os documentos a importar. A predefinição é ReconciliationMode.INCREMENTAL.
updateMask

string (FieldMask format)

Indica os campos nos documentos importados fornecidos a atualizar. Se não for definido, a predefinição é atualizar todos os campos.

Esta é uma lista separada por vírgulas de nomes totalmente qualificados de campos. Exemplo: "user.displayName,photo".
autoGenerateIds

boolean

Se devem ser gerados automaticamente IDs para os documentos, caso não existam.

Se estiver definido como true, os Document.ids são gerados automaticamente com base no hash da carga útil, em que os IDs podem não ser consistentes durante várias importações. Nesse caso, é altamente recomendável usar ReconciliationMode.FULL para evitar conteúdos duplicados. Se não estiver definida ou estiver definida como false, os Document.ids têm de ser especificados através de idField. Caso contrário, a importação dos documentos sem IDs falha.

Origens de dados suportadas:
idField

string

O campo indica o campo ou a coluna de ID a usar como IDs únicos dos documentos.

Para GcsSource, é a chave do campo JSON. Por exemplo, my_id para JSON {"my_id": "some_uuid"}. Para outros, pode ser o nome da coluna da tabela onde os IDs únicos estão armazenados.

Os valores do campo JSON ou da coluna da tabela são usados como os Document.ids. O campo JSON ou a coluna da tabela tem de ser do tipo string e os valores têm de ser definidos como strings válidas em conformidade com a RFC-1034 com 1 a 63 carateres. Caso contrário, os documentos sem IDs válidos não são importados.

Defina este campo apenas quando autoGenerateIds não estiver definido ou estiver definido como false. Caso contrário, é gerado um erro INVALID_ARGUMENT.

Se não estiver definido, é usado um valor predefinido Id quando a importação é feita a partir das origens de dados permitidas.

Origens de dados suportadas:
forceRefreshContent

boolean

Opcional. Se deve forçar a atualização do conteúdo não estruturado dos documentos.

Se estiver definido como true, a parte de conteúdo dos documentos é atualizada independentemente do estado de atualização do conteúdo de referência.
Campo de união source. Obrigatório. A origem da entrada. source só pode ser uma das seguintes opções:
inlineSource

object (InlineSource)

A origem inline do conteúdo de entrada para documentos.
gcsSource

object (GcsSource)

Localização do Cloud Storage para o conteúdo de entrada.
bigquerySource

object (BigQuerySource)

Origem de entrada do BigQuery.
fhirStoreSource

object (FhirStoreSource)

Origem de entrada FhirStore.
spannerSource

object (SpannerSource)

Origem de entrada do Spanner.
cloudSqlSource

object (CloudSqlSource)

Origem de entrada do Cloud SQL.
firestoreSource

object (FirestoreSource)

Origem de entrada do Firestore.
alloyDbSource

object (AlloyDbSource)

Origem de entrada do AlloyDB.
bigtableSource

object (BigtableSource)

Origem de entrada do Cloud Bigtable.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de Operation.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.documents.import

Para mais informações, consulte a documentação do IAM.