Converter documentos para formatos diferentes

🤖/document/convert converte documentos em diferentes formatos.

Exemplo de uso

{
  "steps": {
    "converted": {
      "format": "pdf",
      "robot": "/document/convert",
      "use": ":original"
    }
  }
}

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 é mais custoso para a 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 imagens, "thumbhash": true em vez disso extrai um ThumbHash⁠ codificado em base64 em meta.thumbhash, junto com meta.has_alpha (se existe um canal alfa, mesmo quando totalmente opaco). Ele descreve pixels orientados por EXIF e usa o primeiro quadro de imagens animadas. A extração é feita em regime de melhor esforço: imagens acima de 40 megapixels, formatos não suportados ou uma decodificação com falha/limitada não geram placeholder. Uma extração bem-sucedida adiciona uma cobrança de metadados equivalente a 20% dos bytes desse arquivo. Nenhuma sobretaxa de ThumbHash se aplica quando desativado ou quando nenhum hash é gerado.

  Defina essa opção no Step que produz a imagem, como /upload/handle para originais enviados por upload ou /image/resize para saídas processadas. Defini-la apenas em /transloadit/store não solicita a extração: o armazenamento preserva os metadados do produtor. O Transloadit Storage persiste um hash gerado com sua versão imutável e o retorna em resultados armazenados e em leituras nativas de ativos. Uploads diretos para o S3 não geram placeholders. Um placeholder contém informações da imagem, portanto proteja-o com os mesmos controles de acesso da imagem completa.

  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 barata do ffprobe field_order 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 | 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 true equivale a ["meta", "execute"] e fará com que erros sejam ignorados nas duas fases.

• use

  string | Array<string> | Array<object> | object

  Especifica quais Steps usar como entrada.

  • Você pode escolher qualquer nome para os Steps, exceto ":original" (reservado para uploads de usuários tratados pela Transloadit)
  • Você pode fornecer vários Steps como entrada usando arrays:

    {
      "use": [
        ":original",
        "encoded",
        "resized"
      ]
    }
    

  • Você também pode marcar os Steps de entrada com as para transmitir intenção semântica aos Robots:

    {
      "use": [
        {
          "name": ":original",
          "as": "image"
        },
        {
          "name": ":original",
          "as": "mask"
        }
      ]
    }
    

  Dica

  Provavelmente é tudo o que você precisa saber sobre use, mas você pode ver os casos de uso avançados.

• format — obrigatório

  ai | csv | doc | docx | eps | gif | html | mais 28 ↓

  O formato desejado para a conversão do documento.

• markdown_format

  commonmark | gfm(padrão: "gfm")

  Markdown pode ser representado em diversas variantes⁠, por isso, ao usar este Robot para transformar Markdown em HTML, especifique qual revisão está sendo usada.

• markdown_theme

  bare | github(padrão: "github")

  Este parâmetro reformula o estilo dos seus arquivos Markdown com base em várias predefinições prontas.

• pdf_margin

  string(padrão: "6.25mm,6.25mm,14.11mm,6.25mm")

  Margens do papel do PDF, separadas por , e com unidades.

  Aceitamos os seguintes valores de unidade: px, in, cm, mm.

  Atualmente, este parâmetro só é compatível com a conversão a partir de html.

• pdf_print_background

  boolean(padrão: true)

  Imprime os elementos gráficos de fundo do PDF.

  Atualmente, este parâmetro só é compatível com a conversão a partir de html.

• pdf_format

  A0 | A1 | A2 | A3 | A4 | A5 | A6 | mais 4 ↓(padrão: "Letter")

  Formato do papel do PDF. Os valores não diferenciam maiúsculas de minúsculas.

  Atualmente, este parâmetro só é compatível com a conversão a partir de html.

• pdf_display_header_footer

  boolean(padrão: false)

  Exibe o cabeçalho e o rodapé do PDF.

  Atualmente, este parâmetro só é compatível com a conversão a partir de html.

• pdf_header_template

  string

  Modelo HTML para o cabeçalho de impressão do PDF.

  Deve ser uma marcação HTML válida com as seguintes classes, usadas para inserir os valores de impressão:

  • date data de impressão formatada
  • title título do documento
  • url localização do documento
  • pageNumber número da página atual
  • totalPages total de páginas do documento

  Atualmente, este parâmetro só é compatível com a conversão a partir de html e exige que pdf_display_header_footer esteja habilitado.

  Para alterar a formatação do elemento HTML, é necessário especificar font-size em um elemento contêiner. Por exemplo, para centralizar o número da página no topo de uma página, você usaria o seguinte HTML como modelo de cabeçalho:

  <div style="font-size: 15px; width: 100%; text-align: center;"><span class="pageNumber"></span></div>
  

• pdf_footer_template

  string

  Modelo HTML para o rodapé de impressão do PDF.

  Deve usar o mesmo formato de pdf_header_template.

  Atualmente, este parâmetro só é compatível com a conversão a partir de html e exige que pdf_display_header_footer esteja habilitado.

  Para alterar a formatação do elemento HTML, é necessário especificar font-size em um elemento contêiner. Por exemplo, para centralizar o número da página no rodapé, você usaria o seguinte HTML como modelo de rodapé:

  <div style="font-size: 15px; width: 100%; text-align: center;"><span class="pageNumber"></span></div>
  

Demonstrações

Publicações relacionadas no blog