# Filtrar archivos

Robot: `/file/filter`

🤖/file/filter dirige archivos a diferentes Steps de encoding según tus condiciones.

Considera este <dfn>Robot</dfn> como una condición `if/else` para crear flujos de trabajo avanzados de conversión de archivos. Con él, puedes filtrar y dirigir determinados archivos subidos según sus metadatos.

El <dfn>Robot</dfn> tiene dos modos de funcionamiento:

* Construir condiciones a partir de arrays con 3 miembros cada uno. Por ejemplo, `["${file.size}", "<=", "720"]`
* Escribir condiciones en JavaScript. Por ejemplo, `${file.size <= 720}`. Consulta también [Evaluación dinámica](/es/docs/topics/dynamic-evaluation.md).

Si quieres que un Step `/file/filter` deje pasar sin cambios todos los archivos de entrada, no establezcas `accepts` ni
`declines`, o establécelos en `null`. No uses `"accepts": "true"` para esto: las cadenas simples
solo se tratan como expresiones de JavaScript cuando usan la forma `${...}`, como `"${true}"`.

Proporcionar JavaScript te permite implementar una lógica tan compleja como quieras; sin embargo, es más lento que combinar arrays de condiciones y se cobrará por cada invocación mediante [🤖/script/run](/es/docs/robots/script-run.md).

### Condiciones como arrays

Los parámetros `accepts` y `declines` pueden establecerse individualmente como un array de arrays con tres miembros:

1. Un valor o una variable de Job, como `${file.mime}`
2. Uno de los siguientes operadores: `=`, `==`, `===`, `<`, `>`, `<=`, `>=`, `!=`, `!==`, `regex`, `!regex`, `includes`, `!includes`, `empty`, `!empty`
3. Un valor o una variable de Job, como `50` o `"foo"`

Ejemplos:

* `[["${file.meta.width}", ">", "${file.meta.height}"]]`
* `[["${file.size}", "<=", "720"]]`
* `[["${file.size}", ">", "20mb"]]`
* `[["720", ">=", "${file.size}"]]`
* `[["${file.mime}", "regex", "image"]]`

Cuando se compara con `${file.mime}`, el valor suele basarse en los metadatos extraídos por Transloadit
del lado del servidor durante el flujo normal de subida, y no únicamente en el tipo MIME indicado
por el cliente o el navegador. Esto hace que `/file/filter` sea adecuado para rechazar archivos con etiquetas incorrectas.
Según el contenedor del archivo y las herramientas de detección involucradas, algunos formatos pueden aparecer con
tipos MIME estrechamente relacionados, como `image/heic` o `image/heif`.

Si solo quieres formatos que los navegadores rendericen de manera uniforme, opta por una lista explícita de permitidos como
`^(image/jpeg|image/png|image/gif|image/webp|image/avif)$` en lugar de una regla amplia `^image/`.

Para las comparaciones numéricas (`<`, `>`, `<=`, `>=`), puedes usar valores de bytes legibles para humanos, como `"20mb"`, `"1gb"` o `"512kb"`. Estos usan multiplicadores binarios (basados en 1024). Unidades compatibles: `b`, `kb`, `mb`, `gb`, `tb`, `pb` (y sus equivalentes IEC `kib`, `mib`, `gib`, `tib`, `pib`).

Los operadores `includes` y `!includes` funcionan con arrays o cadenas (en las cadenas se comprueba la presencia de subcadenas).

> [!Warning]
> Si quieres comparar con un valor `null` o con un valor que no está presente (por ejemplo, un archivo de audio no tiene una propiedad `video_codec` en sus metadatos), compara en su lugar con `""` (una cadena vacía). En el futuro admitiremos correctamente la comparación con `null`, pero en este momento no podemos hacerlo fácilmente sin afectar la compatibilidad con versiones anteriores.

### Condiciones como JavaScript

Los parámetros `accepts` y `declines` pueden establecerse individualmente como cadenas de JavaScript que devuelven un valor booleano.

Ejemplos:

* `${file.meta.width > file.meta.height}`
* `${file.size <= 720}`
* `${/image/.test(file.mime)}`
* `${Math.max(file.meta.width, file.meta.height) > 100}`

Como se indicó, cobramos por esto mediante [🤖/script/run](/es/docs/robots/script-run.md). Consulta también [Evaluación dinámica](/es/docs/topics/dynamic-evaluation.md) para obtener más detalles sobre la sintaxis y el comportamiento permitidos.

Etapa: ga

## Ejemplo de uso

Rechaza archivos que sean mayores de 20 MB:

```json
{
  "steps": {
    "filtered": {
      "robot": "/file/filter",
      "use": ":original",
      "declines": [
        [
          "${file.size}",
          ">",
          "20mb"
        ]
      ],
      "error_on_decline": true,
      "error_msg": "File size must not exceed 20 MB"
    }
  }
}
```

## Parámetros

* `interpolate`: Controla si las Assembly Variables se interpolan en campos de instrucciones individuales.

  De forma predeterminada, la mayoría de los campos de instrucciones de los Robots interpolan Assembly Variables. Establece esta opción en `false` para tratar todos los campos de instrucciones como texto literal, o establece la ruta de un campo individual en `false` para tratar únicamente ese campo como texto literal. En el caso de los campos específicos de un Robot que son literales de forma predeterminada, establece esta opción en `true` o la ruta de ese campo en `true` para volver a habilitar la interpolación.

  Usa nombres de campos como `path` o rutas con puntos como `ffmpeg.vf` para los objetos anidados.

* `output_meta`: Te permite especificar un conjunto de metadatos cuyo cálculo requiere más recursos de CPU y que, por lo tanto, está desactivado de forma predeterminada para que tus Assemblies se procesen rápidamente.

  Para imágenes, puedes añadir `"has_transparency": true` a este objeto para determinar si la imagen contiene partes transparentes y `"dominant_colors": true` para extraer un array de códigos de color hexadecimales de la imagen.

  Para imágenes, también puedes añadir `"blurhash": true` para extraer una cadena [BlurHash](https://blurha.sh), una representación compacta de un marcador de posición para la imagen que resulta útil para mostrar una vista previa desenfocada mientras se carga la imagen completa.

  Para videos, puedes añadir el parámetro `"colorspace": true` para extraer el espacio de color del video de salida.

  Para videos, también puedes añadir `"interlaced": true` para detectar si el video está entrelazado. Esto combina el indicador `field_order` de ffprobe, cuyo costo en recursos de procesamiento es bajo, con una pasada de muestreo limitada mediante `idet` sobre los primeros fotogramas de la fuente, y expone `interlaced`, `field_order` y un objeto de diagnóstico `interlace_detection` en `file.meta`. Esto requiere muchos recursos computacionales y se factura en consecuencia.

  Para audio, puedes añadir `"mean_volume": true` para obtener un único valor que represente el volumen promedio del archivo de audio.

  También puedes establecerlo en `false` para omitir la extracción de metadatos y acelerar la transcodificación.

* `user_meta`: Añade metadatos personalizados a cada archivo emitido por este Robot sin modificar el contenido del archivo.

  Los valores se combinan con los `user_meta` existentes en el archivo de entrada. Si ambos objetos contienen la misma clave, el valor de este Robot tiene prioridad. Se admiten Assembly Variables, por ejemplo `{ "internal_file_id": "${file.id}" }`.

* `result`: Indica si los resultados de este Step deben aparecer en el Assembly Status JSON

* `queue`: Establecer la cola en «batch» reduce manualmente la prioridad de los Jobs de este Step para evitar consumir cupos prioritarios con Jobs que no necesitan un tiempo de espera cero en la cola

* `force_accept`: Forzar a un Robot a aceptar un tipo de archivo que habría ignorado.

  De forma predeterminada, los Robots ignoran los archivos que no reconocen.
  [🤖/video/encode](/es/docs/robots/video-encode.md), por
  ejemplo, ignorará sin problemas las imágenes de entrada.

  Si configuras el parámetro `force_accept` como `true`, puedes forzar a los Robots a aceptar todos los archivos que reciban.
  Esto normalmente provocará errores y solo debe usarse para depuración o para abordar casos extremos.

* `ignore_errors`: Ignorar errores durante fases específicas del procesamiento.

  Establecer este parámetro en `["meta"]` hará que el Robot ignore los errores durante la extracción de metadatos.

  Establecer este parámetro en `["execute"]` hará que el Robot ignore los errores durante la fase principal de ejecución.

  Configurar este parámetro como `true` equivale a `["meta", "execute"]` y hará que se ignoren los errores en ambas fases.

* `use`: Especifica qué Step o Steps se usarán como entrada.

  * Puedes elegir cualquier nombre para los Steps, excepto `":original"` (reservado para las subidas de usuarios gestionadas por Transloadit)
  * Puedes proporcionar varios Steps como entrada mediante arrays:
    ```json
    {
      "use": [
        ":original",
        "encoded",
        "resized"
      ]
    }
    ```
  * También puedes etiquetar los Steps de entrada con `as` para comunicar la intención semántica a los Robots:
    ```json
    {
      "use": [
        {
          "name": ":original",
          "as": "image"
        },
        {
          "name": ":original",
          "as": "mask"
        }
      ]
    }
    ```

  > [!Tip]
  > Probablemente eso sea todo lo que necesitas saber sobre `use`, pero puedes consultar los [casos de uso avanzados](/es/docs/topics/use-parameter.md).

* `accepts`: Se aceptarán los archivos que cumplan al menos un requisito; de lo contrario, se rechazarán. Si el valor es `null`, se aceptarán todos los archivos. Si el array está vacío, no se aceptará ningún archivo. Omite este parámetro o establécelo en `null` cuando quieras que el Step deje pasar todos los archivos. Ejemplos:

  `[["${file.mime}", "==", "image/gif"]]`
  `[["${file.size}", "<", "5kb"]]`

  Para las comparaciones numéricas (`<`, `>`, `<=`, `>=`), se admiten valores de bytes legibles para humanos, como `"20mb"`, `"1gb"` o `"512kb"`.

  Si el parámetro `condition_type` se establece en `"and"`, deben cumplirse todos los requisitos para que se acepte el archivo.

  Si se proporcionan tanto `accepts` como `declines`, los requisitos de `accepts` se evaluarán primero, antes que las condiciones de `declines`.

* `declines`: Los archivos que cumplan al menos un requisito se rechazarán; de lo contrario, se aceptarán. Si el valor es `null` o un array vacío, no se rechazará ningún archivo. Ejemplos:

  `[["${file.size}", ">", "1024"]]`
  `[["${file.size}", ">", "20mb"]]`

  Para las comparaciones numéricas (`<`, `>`, `<=`, `>=`), se admiten valores de bytes legibles para humanos, como `"20mb"`, `"1gb"` o `"512kb"`.

  Si el parámetro `condition_type` se establece en `"and"`, deben cumplirse todos los requisitos para que se rechace el archivo.

  Si se proporcionan tanto `accepts` como `declines`, los requisitos de `accepts` se evaluarán primero, antes que las condiciones de `declines`.

* `condition_type`: Especifica el tipo de condición según el cual deben evaluarse los miembros de los arrays `accepts` o `declines`. Puede ser `"or"` o `"and"`.

* `error_on_decline`: Si se establece en `true` y se rechazan uno o más archivos, la Assembly se detendrá y se marcará con un error.

* `error_msg`: El mensaje de error que se muestra a tus usuarios (por ejemplo, mediante Uppy) cuando se rechaza un archivo y `error_on_decline` se establece en `true`.