Method: projects.locations.dataStores.importDocuments

Inicia uma operação de longa duração para importar documentos para um repositório de dados.

Um arquivo que já foi importado com sucesso é ignorado, a menos que o objeto do Cloud Storage tenha sido substituído ou, para SOURCE_FORMAT_DOCUMENT_JSON, os metadados tenham sido alterados. Os arquivos que falharam em uma importação anterior são processados novamente. Os arquivos individuais que não podem ser importados são informados no relatório de erros (consulte ImportOutputConfig.error_gcs_prefix) em vez de causar falha em toda a importação.

dataStores.importDocuments, dataStores.purgeDocuments e dataStores.patch são executados um por vez em cada DataStore. Enquanto uma é executada, outra pode aguardar. Qualquer outra solicitação falha com ABORTED até que a operação em execução seja concluída. Para importar muitos arquivos, liste todos em inputUris de uma solicitação em vez de enviar solicitações paralelas.

Solicitação HTTP

POST https://vectorsearch.googleapis.com/v1beta/{name}:importDocuments

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do recurso do DataStore em que os documentos serão importados. Formato: projects/{project}/locations/{location}/dataStores/{dataStore}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "importOutputConfig": {
    object (ImportOutputConfig)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsSource": {
    object (GcsSource)
  }
  // End of mutually exclusive fields.
}
Campos
importOutputConfig

object (ImportOutputConfig)

Opcional. Configuração do destino para a saída de documentos de importação: onde gravar o relatório de erros da importação.

Obrigatório. A origem da entrada. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
gcsSource

object (GcsSource)

Local do Cloud Storage para o conteúdo de entrada. Com o sourceFormat padrão, um URI pode ser um padrão como gs://my-bucket/folder/*, que corresponde aos objetos diretamente em folder, mas não aos que estão nas subpastas. Uma importação pode incluir no máximo 100.000 arquivos para um DataStore do UNSTRUCTURED ou 100 para um DataStore do VIDEO.

Fim dos campos mutuamente exclusivos.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

ImportOutputConfig

Configuração do destino para saída relacionada a documentos de importação.

Representação JSON
{
  "errorGcsPrefix": string
}
Campos
errorGcsPrefix

string

Opcional. Prefixo de URI do local do Cloud Storage para gravar os erros encontrados durante a importação. O prefixo não pode conter objetos. Os erros são gravados em arquivos fragmentados com esse prefixo, um por linha, como uma mensagem google.rpc.Status codificada em JSON. Se esse campo estiver vazio, nenhum relatório de erros será gravado.