Product Guides are now only available at docs.box.com. Check out all the details on what's changed.

Box Status
Print

Managing Custom Extract Agents in Box Extract

End User , Established , P2 , Box Extract

From the Box Extract dashboard, you can configure an Extract agent by clicking on a specific an agent:

  • Configure
    • Agent type
      • Select an agent type: Standard Extract Agent or Enhanced Extract Agent.
    • Fields and AI Instructions
      • Select metadata fields to extract. Box Extract requires at least one field to be enabled. Click on the switch in the top right column to enable all metadata fields.
      • Add optional AI Instructions per field to improve accuracy.
    • Extraction policy and templates
      • Choose to Keep existing metadata values or Override metadata values.
      • Replacing a metadata template resets all Custom Extract Agent settings, including AI instructions and prompts.
  • Rename
    • Set a descriptive agent name, up to 255 characters. Renaming the Custom Extract Agent does not change extraction behavior.
  • Deactive
    • Disables the Custom Extract Agent and stops extractions
    • Some extraction processes may still occur after Custom Extract Agent deactivation or deletion.
  • Delete
    • Deleting a Custom Extract Agent moves it to the Trash (if enabled for your enterprise), from where it can be restored. However, restoring the archived agent requires deactivation then reactivation before it can extract metadata again.

You can add more source folders for the Custom Extract Agent to automatically extract data to.

  • Source folders and activation
    • Attach up to 10 Box folders as sources to automate extraction processes at scale. Only PDF files that are stored directly within those folders are processed.
    • Click Activate to begin adding source folders after saving the configuration to the Custom Extract Agent.

Per-file access and edits

  • You can view metadata attached to each file directly within Box Preview.
  • Edit or enter new values using the pencil icon.

Run Reports

  • Run History
    • Records extraction jobs with job status, source folder, and timestamps.
    • Use Run History to verify extraction results or diagnose issues.
      • Common workflow (high-level)
  1. Create
  2. Configure fields & AI instructions
  3. Add folders 
  4. Activate 
  5. Monitor via Run History 
  6. Edit metadata as needed

Folder and file names in the Run History of a Custom Extract Agent are displayed exactly as they appeared when the extraction was executed.

Related articles