Importar arquivos do Box

🤖/box/import importa diretórios inteiros de arquivos do seu Box.

Exemplo de uso

{
  "steps": {
    "imported": {
      "credentials": "YOUR_BOX_CREDENTIALS",
      "path": "path/to/files/",
      "robot": "/box/import"
    }
  }
}

Parâmetros

• interpolate

  boolean | Record<string, boolean>

  Controla se as Assembly Variables são interpoladas em campos individuais de instruções.

  Por padrão, a maioria dos campos de instruções dos Robots interpola Assembly Variables. Defina isso como false para tratar todos os campos de instruções como texto literal, ou defina o caminho de um campo individual como false para tratar apenas esse campo como texto literal. Para campos específicos de um Robot que são literais por padrão, defina isso como true ou defina o caminho desse campo como true para voltar a usar a interpolação.

  Use nomes de campos como path ou caminhos com pontos como ffmpeg.vf para objetos aninhados.

• output_meta

  Record<string, boolean> | boolean | Array<string>

  Permite especificar um conjunto de metadados cujo cálculo exige mais CPU e que, por isso, vem desativado por padrão para manter o processamento das suas Assemblies rápido.

  Para imagens, você pode adicionar "has_transparency": true neste objeto para extrair se a imagem contém partes transparentes e "dominant_colors": true para extrair um array de códigos de cores hexadecimais da imagem.

  Para imagens, você também pode adicionar "blurhash": true para extrair uma string BlurHash⁠ — uma representação compacta de um placeholder da imagem, útil para exibir uma prévia desfocada enquanto a imagem completa carrega.

  Para vídeos, você pode adicionar o parâmetro "colorspace": true para extrair o espaço de cores do vídeo de saída.

  Para vídeos, você também pode adicionar "interlaced": true para detectar se o vídeo é entrelaçado. Isso combina a flag computacionalmente barata field_order do ffprobe com uma passagem de amostragem idet limitada sobre os primeiros quadros da origem, expondo interlaced, field_order e um objeto de diagnóstico interlace_detection em file.meta. Isso é computacionalmente caro e cobrado de acordo.

  Para áudio, você pode adicionar "mean_volume": true para obter um único valor que representa o volume médio do arquivo de áudio.

  Você também pode definir isso como false para pular a extração de metadados e acelerar a transcodificação.

• user_meta

  Record<string, any>(padrão: {})

  Adiciona metadados JSON personalizados a cada arquivo emitido sem modificar seu conteúdo. Objetos e arrays aninhados são suportados.

  A herança depende do Robot. Os valores são mesclados com o user_meta existente no arquivo de saída; o Step atual substitui as chaves de nível superior com o mesmo nome. Atribua explicitamente as chaves necessárias quando um Robot criar novas saídas.

  Nos Steps de processamento, ${file.*} se refere à primeira entrada e ${result.*} ao arquivo emitido. Os valores são avaliados para cada saída após a execução do Robot, antes da extração subsequente de metadados e do armazenamento temporário. Em :original, os valores são avaliados para cada upload antes da extração de metadados.

  Os Steps subsequentes leem ${file.user_meta.key}. Consulte Metadados personalizados para ver um exemplo completo e as regras de herança.

• result

  boolean(padrão: false)

  Se os resultados deste Step devem estar presentes no Assembly Status JSON

• queue

  batch

  Definir a fila como “batch” rebaixa manualmente a prioridade dos Jobs deste Step, para evitar o consumo de vagas prioritárias de Jobs em Jobs que não precisam de tempo zero de espera na fila

• force_accept

  boolean(padrão: false)

  Forçar um Robot a aceitar um tipo de arquivo que ele teria ignorado.

  Por padrão, os Robots ignoram arquivos que não conhecem. O 🤖/video/encode, por exemplo, ignora tranquilamente imagens de entrada.

  Com o parâmetro force_accept definido como true, você pode forçar os Robots a aceitar todos os arquivos enviados a eles. Isso normalmente leva a erros e só deve ser usado para depuração ou para lidar com casos extremos.

• ignore_errors

  boolean | Array<meta | import | execute>(padrão: [])

  Ignorar erros durante fases específicas do processamento.

  Definir isso como ["meta"] fará com que o Robot ignore erros durante a extração de metadados.

  Definir isso como ["execute"] fará com que o Robot ignore erros durante a fase principal de execução.

  Definir isso como ["import"] fará com que o Robot ignore erros ao importar o arquivo de origem. A fase "import" está disponível apenas para Robots de importação.

  Definir isso como true equivale a ["meta", "import", "execute"] e fará com que erros sejam ignorados nas três fases.

• force_name

  string | Array<string> | null(padrão: null)

  Nome personalizado para o(s) arquivo(s) importado(s). Por padrão, os nomes dos arquivos são derivados da origem.

• import_on_errors

  Array<meta>(padrão: [])

  Definir isso como ["meta"] ainda importa o arquivo quando ocorrem erros de extração de metadados. ignore_errors é parecido: também ignora o erro e garante que o Robot não pare, mas não importa o arquivo.

• credentials

  string

  Crie um aplicativo Box no Box Developer Console⁠ usando Server Authentication (JWT).

  Gere um par de chaves pública/privada para esse aplicativo. O Box baixará um arquivo de configuração JSON (com boxAppSettings e appAuth) que inclui o material da sua chave privada JWT.

  Na sua conta da Transloadit, crie credenciais de Template do tipo Box e cole o arquivo JSON completo em key_file_contents. Depois, defina este parâmetro credentials com o nome das credenciais de Template.

  Se a sua organização no Box exigir, certifique-se de que o aplicativo seja autorizado por um administrador antes de usá-lo em produção.

• path — obrigatório

  string | Array<string>

  O caminho no seu Box para o arquivo ou diretório específico. Se o caminho apontar para um arquivo, apenas esse arquivo será importado. Por exemplo: images/avatar.jpg.

  Se apontar para um diretório, indicado por uma barra no final (/), todos os arquivos descendentes desse diretório serão importados recursivamente. Por exemplo: images/.

  Se quiser importar todos os arquivos do diretório raiz, use / como valor aqui.

  Você também pode usar um array de strings de caminhos aqui para importar vários caminhos no mesmo Step do Robot.