Download the PHP package tfd/statamic-aida without Composer

On this page you can find all versions of the php package tfd/statamic-aida. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package statamic-aida


A.I.D.A - AI-Driven Alt-text Assistant

Statamic 5.0+ Latest Version

Enhancing web accessibility and SEO through AI-generated alt texts for Statamic 5.

A.I.D.A is an addon for Statamic 5 that leverages AI to automatically generate descriptive alt texts for images. By simplifying this process, A.I.D.A aids in making web content more accessible to visually impaired users, enhances SEO, and supports content in multiple languages.

Features

Getting Started

Installation

  1. Install the addon using Composer:

Configuration

To set up and customize the A.I.D.A addon, follow these steps:

  1. Publish Configuration File: Start by publishing the addon's configuration file to make it editable. Run the following command in your terminal:

    This will copy the default configuration file to your application's config directory, allowing you to customize the addon settings.

  2. Set OpenAI API Key: A.I.D.A uses OpenAI to generate alt texts. You must provide your OpenAI API key for the service to function. It's recommended to set this key in your application's .env file for security reasons, rather than directly in the aida.php configuration file:

    Add the following line to your .env file:

    This ensures your API key remains secure and not hard-coded in your version-controlled files.

  3. Configure Queue: To manage performance and efficiently handle multiple alt text generation requests, it's advisable to use a queue connection, such as Redis. Queues allow for asynchronous processing, improving the user experience and system performance.

    First, ensure you have your queue system set up according to the Laravel documentation. Then, specify your queue connection for A.I.D.A by adding the following line to your .env file:

    This tells A.I.D.A to use the redis queue connection for processing alt text generation jobs.

  4. Generator Configuration: The default OpenAI Generator is configured with a sensible set of default values. You can adjust these values to better fit your needs.

    The following options are configurable via .env file:

    For additional information please have a look at the config/aida.php file.

  5. Automatic Generation on Upload: By default, the addon does not generate alt texts automatically upon image uploads to avoid unnecessary processing. However, you can enable this feature to have alt texts generated immediately as images are uploaded.

    To enable automatic alt text generation on upload, add the following line to your .env file:

    With this setting enabled, every new image uploaded will automatically have an alt text generated, enhancing accessibility and SEO with minimal effort.

Example Configurations

Single Site with no custom alt field

Single Site with custom alt field

Multi Site (1)

Multi Site (2)

Multi Site (3)

Updates

After updating the addon, make sure to inspect the config/aida.php file to learn about new configuration values. You might want to add them to the published config file of your application.

Usage

Manual Generation: Use the Generate Alt Text action in the Asset Browser to generate alt texts for selected images. This option allows you to decide whether to override existing alt texts.

Customization

Custom Generator: You can replace the default OpenAI-based generator with your own by implementing the TFD\AIDA\Generator\Generator interface.

  1. Create a custom generator class e.g. /app/Generator/MyAltTextGenerator.php.

  2. Implement the generate method to utilize your preferred service for generating alt texts.
  3. Update the aida.php configuration file to use your custom generator class.

Credits

This project is maintained by 21st digital. We appreciate the contributions from the community that help make this project better.


All versions of statamic-aida with dependencies

PHP Build Version
Package Version
Requires openai-php/client Version ^0.10.1
statamic/cms Version ^5.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package tfd/statamic-aida contains the following files

Loading the files please wait ....