pdfix/alt-text-openai repository overview

⁠Alt Text Generator OpenAI

A Docker image that automatically generates and applies alternative image descriptions to PDF files using PDFix SDK and OpenAI.

⁠Table of Contents

• Alt Text Generator OpenAI⁠
  • Table of Contents⁠
  • Getting Started⁠
  • Run using Command Line Interface⁠
  • Run Description Generation using REST API⁠
    • Exporting Configuration for Integration⁠
  • License & libraries used⁠
  • Help & Support⁠

⁠Getting Started

To use this Docker application, you'll need to have Docker installed on your system. If Docker is not installed, please follow the instructions on the official Docker website⁠ to install it.

⁠Run using Command Line Interface

To run the docker container as CLI, you should share the folder containing the PDF for processing using the -i parameter. In this example, the current folder is used.

docker run -v $(pwd):/data/ -w /data pdfix/alt-text-openai:latest detect -i document.pdf -o out.pdf --tags "Figure|Formula" --openai <api_key> --lang English --overwrite true

With an account-based PDFix License add these arguments.

--name ${LICENSE_NAME} --key ${LICENSE_KEY}

Contact support for more infomation.

First run will pull the docker image, which may take some time. Make your own image for more advanced use.

For more detailed information about the available command-line arguments, you can run the following command:

docker run --rm pdfix/alt-text-openai:latest --help

⁠Run Description Generation using REST API

Comming soon. Please contact us.

⁠Exporting Configuration for Integration

To export the configuration JSON file, use the following command:

docker run -v $(pwd):/data -w /data --rm pdfix/alt-text-openai:latest config -o config.json

⁠License & libraries used

• PDFix SDK - https://pdfix.net/terms⁠
• OpenAI API - https://openai.com/policies/⁠

Trial version of the PDFix SDK may apply a watermark on the page and redact random parts of the PDF including the scanned image in background. Contact us to get an evaluation or production license.

⁠Help & Support

To obtain a PDFix SDK license or report an issue please contact us at [email protected]⁠. For more information visit https://pdfix.net⁠