Generate Alt Text with AltText.ai API on Changes to Specific Files from Google Drive API

Pipedream makes it easy to connect APIs for AltText.ai, Google Drive and 2,900+ other apps remarkably fast.

Trigger workflow on

Changes to Specific Files from the Google Drive API

Next, do this

Generate Alt Text with the AltText.ai API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Google Drive trigger and AltText.ai action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Changes to Specific Files trigger
1. Configure infoAlert
2. Connect your Google Drive account
3. Optional- Configure Drive
4. Configure Push notification renewal schedule
5. Select one or more Files
6. Optional- Configure Include Link
7. Optional- Configure dir
8. Configure intervalAlert
9. Optional- Configure Minimum Interval Per File
10. Select one or more Types of updates
Configure the Generate Alt Text action
1. Connect your AltText.ai account
2. Configure fileInfo
3. Optional- Configure Image Data
4. Optional- Configure Image File Path or URL
5. Optional- Configure Keywords
6. Optional- Configure Negative Keywords
7. Optional- Configure Keyword Source
8. Optional- Select a Language
9. Optional- Configure syncDir
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

Changes to Specific Files on Google Drive

Description:Watches for changes to specific files, emitting an event when a change is made to one of those files. To watch for changes to [shared drive](https://support.google.com/a/users/answer/9310351) files, use the **Changes to Specific Files (Shared Drive)** source instead.

Version:0.3.1

Key:google_drive-changes-to-specific-files

View on GitHub

Google Drive Overview#

The Google Drive API on Pipedream allows you to automate various file management tasks, such as creating, reading, updating, and deleting files within your Google Drive. You can also share files, manage permissions, and monitor changes to files and folders. This opens up possibilities for creating workflows that seamlessly integrate with other apps and services, streamlining document handling, backup processes, and collaborative workflows.

Trigger Code#

import cronParser from "cron-parser";
import includes from "lodash/includes.js";
import { v4 as uuid } from "uuid";
import { MY_DRIVE_VALUE } from "../../common/constants.mjs";
import changesToSpecificFiles from "../changes-to-specific-files-shared-drive/changes-to-specific-files-shared-drive.mjs";
import { ConfigurationError } from "@pipedream/platform";
import sampleEmit from "./test-event.mjs";

/**
 * This source uses the Google Drive API's
 * {@link https://developers.google.com/drive/api/v3/reference/files/watch files: watch}
 * endpoint to subscribe to changes to specific files in the user's drive.
 */
export default {
  ...changesToSpecificFiles,
  key: "google_drive-changes-to-specific-files",
  name: "Changes to Specific Files",
  description: "Watches for changes to specific files, emitting an event when a change is made to one of those files. To watch for changes to [shared drive](https://support.google.com/a/users/answer/9310351) files, use the **Changes to Specific Files (Shared Drive)** source instead.",
  version: "0.3.1",
  type: "source",
  // Dedupe events based on the "x-goog-message-number" header for the target channel:
  // https://developers.google.com/drive/api/v3/push#making-watch-requests
  dedupe: "unique",
  props: {
    infoAlert: {
      type: "alert",
      alertType: "info",
      content: "This source uses `files.watch` and supports up to 10 file subscriptions. To watch for changes to more than 10 files, use the **Changes to Files in Drive** source instead (uses `changes.watch`).",
    },
    ...changesToSpecificFiles.props,
    drive: {
      type: "string",
      label: "Drive",
      description: "Defaults to `My Drive`. To use a [Shared Drive](https://support.google.com/a/users/answer/9310351), use the **Changes to Specific Files (Shared Drive)** source instead.",
      optional: true,
      default: MY_DRIVE_VALUE,
    },
    updateTypes: {
      propDefinition: [
        changesToSpecificFiles.props.googleDrive,
        "updateTypes",
      ],
    },
    includeLink: {
      label: "Include Link",
      type: "boolean",
      description: "Upload file to your File Stash and emit temporary download link to the file. Google Workspace documents will be converted to PDF. See [the docs](https://pipedream.com/docs/connect/components/files) to learn more about working with files in Pipedream.",
      default: false,
      optional: true,
    },
    dir: {
      type: "dir",
      accessMode: "write",
      optional: true,
    },
  },
  hooks: {
    ...changesToSpecificFiles.hooks,
    async deploy() {
      if (this.files.length > 10) {
        throw new ConfigurationError("This source only supports up to 10 files");
      }
      await changesToSpecificFiles.hooks.deploy.bind(this)();
    },
    async activate() {
      // Called when a component is created or updated. Handles all the logic
      // for starting and stopping watch notifications tied to the desired
      // files.

      // You can pass the same channel ID in watch requests for multiple files, so
      // our channel ID is fixed for this component to simplify the state we have to
      // keep track of.
      const channelID = uuid();

      // Subscriptions are keyed on Google's resourceID, "an opaque value that
      // identifies the watched resource". This value is included in request
      // headers, allowing us to look up the watched resource.
      let subscriptions = this._getSubscriptions() || {};

      const files = this.files;
      for (const fileID of files) {
        const {
          expiration,
          resourceId,
        } = await this.googleDrive.activateFileHook(
          channelID,
          this.http.endpoint,
          fileID,
        );
        // The fileID must be kept with the subscription metadata so we can
        // renew the watch request for this specific file when it expires.
        subscriptions[resourceId] = {
          expiration,
          fileID,
        };
      }

      // Save metadata on the subscription so we can stop / renew later
      this._setSubscriptions(subscriptions);
      this._setChannelID(channelID);
    },
    async deactivate() {
      const channelID = this._getChannelID();
      if (!channelID) {
        console.log(
          "Channel not found, cannot stop notifications for non-existent channel",
        );
        return;
      }

      const subscriptions = this._getSubscriptions() || {};
      for (const resourceId of Object.keys(subscriptions)) {
        await this.googleDrive.stopNotifications(channelID, resourceId);
      }

      // Reset DB state
      this._setSubscriptions({});
      this._setChannelID(null);
    },
  },
  methods: {
    ...changesToSpecificFiles.methods,
    _getSubscriptions() {
      return this.db.get("subscriptions") || {};
    },
    _setSubscriptions(subscriptions) {
      this.db.set("subscriptions", subscriptions);
    },
    _getNextTimerEventTimestamp(event) {
      if (event.cron) {
        return cronParser
          .parseExpression(event.cron)
          .next()
          .getTime();
      }
      if (event.interval_seconds) {
        return Date.now() + event.interval_seconds * 1000;
      }
    },
    async renewFileSubscriptions(event) {
      const subscriptions = this._getSubscriptions() || {};
      const channelID = this._getChannelID();
      const newChannelID = uuid();

      const nextRunTimestamp = this._getNextTimerEventTimestamp(event);

      for (const [
        currentResourceId,
        metadata,
      ] of Object.entries(subscriptions)) {
        const { fileID } = metadata;

        const subscription = {
          ...metadata,
          resourceId: currentResourceId,
        };
        const {
          expiration,
          resourceId,
        } = await this.googleDrive.renewFileSubscription(
          subscription,
          this.http.endpoint,
          channelID,
          newChannelID,
          fileID,
          nextRunTimestamp,
        );
        subscriptions[resourceId] = {
          expiration,
          fileID,
        };
      }
      this._setSubscriptions(subscriptions);
      this._setChannelID(newChannelID);
    },
  },
  async run(event) {
    // This function is polymorphic: it can be triggered as a cron job, to make sure we renew
    // watch requests for specific files, or via HTTP request (the change payloads from Google)

    // Component was invoked by timer
    if (event.timestamp) {
      return this.renewFileSubscriptions(event);
    }

    const channelID = this._getChannelID();
    let subscriptions = this._getSubscriptions() || {};

    const { headers } = event;

    if (
      !headers["x-goog-resource-state"] ||
      !headers["x-goog-resource-id"] ||
      !headers["x-goog-resource-uri"] ||
      !headers["x-goog-message-number"]
    ) {
      console.log("Request missing necessary headers: ", headers);
      return;
    }

    const incomingChannelID = headers["x-goog-channel-id"];
    if (incomingChannelID !== channelID) {
      console.log(
        `Channel ID of ${incomingChannelID} not equal to deployed component channel of ${channelID}`,
      );
      return;
    }

    if (subscriptions[headers["x-goog-resource-id"]] === undefined) {
      console.log(
        `Resource ID of ${headers["x-goog-resource-id"]} not currently being tracked. Exiting`,
      );
      return;
    }

    if (!includes(this.updateTypes, headers["x-goog-resource-state"])) {
      console.log(
        `Update type ${headers["x-goog-resource-state"]} not in list of updates to watch: `,
        this.updateTypes,
      );
      return;
    }

    // We observed false positives where a single change to a document would trigger two changes:
    // one to "properties" and another to "content,properties". But changes to properties
    // alone are legitimate, most users just won't want this source to emit in those cases.
    // If x-goog-changed is _only_ set to "properties", only move on if the user set the prop
    if (
      !this.watchForPropertiesChanges &&
      headers["x-goog-changed"] === "properties"
    ) {
      console.log(
        "Change to properties only, which this component is set to ignore. Exiting",
      );
      return;
    }

    const file = await this.googleDrive.getFileMetadata(
      headers["x-goog-resource-uri"],
    );

    if (!file || !Object.keys(file).length) {
      console.log("No file metadata returned, nothing to emit");
      return;
    }

    const [
      checkedFile,
    ] = this.checkMinimumInterval([
      file,
    ]);
    if (checkedFile) {
      await this.processChange(file, headers);
    }
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Google Drive	`googleDrive`	`app`	This component uses the Google Drive app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Drive	`drive`	`string`	Defaults to `My Drive`. To use a Shared Drive, use the Changes to Specific Files (Shared Drive) source instead.
Files	`files`	`string[]`	Select a value from the drop down menu.
Include Link	`includeLink`	`boolean`	Upload file to your File Stash and emit temporary download link to the file. Google Workspace documents will be converted to PDF. See the docs to learn more about working with files in Pipedream.
	`dir`	`dir`
Minimum Interval Per File	`perFileInterval`	`integer`	How many minutes to wait until the same file can emit another event. If set to `0`, this interval is disabled and all events will be emitted.
Types of updates	`updateTypes`	`string[]`	Select a value from the drop down menu:`{ "label": "'sync' - A channel was successfully created. You can expect to start receiving notifications for it.", "value": "sync" }{ "label": "'add' - A resource was created or shared.", "value": "add" }{ "label": "'remove' - An existing resource was deleted or unshared.", "value": "remove" }{ "label": "'update' - One or more properties (metadata) of a resource have been updated.", "value": "update" }{ "label": "'trash' - A resource has been moved to the trash.", "value": "trash" }{ "label": "'untrash' - A resource has been removed from the trash.", "value": "untrash" }{ "label": "'change' - One or more changelog items have been added.", "value": "change" }`

Trigger Authentication#

Google Drive uses OAuth authentication. When you connect your Google Drive account, Pipedream will open a popup window where you can sign into Google Drive and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Drive API.

Pipedream requests the following authorization scopes when you connect your account:

https://www.googleapis.com/auth/drive

About Google Drive#

Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.

Action#

Generate Alt Text on AltText.ai

Description:Generates a descriptive alt text for a given image. [See the documentation](https://alttext.ai/apidocs#tag/Images/operation/create-image)

Version:0.1.2

Key:alttext_ai-generate-alt-text

View on GitHub

AltText.ai Overview#

AltText.ai provides an API that leverages artificial intelligence to generate alternative text (alt text) for images, which is crucial for web accessibility and SEO. With AltText.ai, you can automate the process of creating descriptive, keyword-rich, and meaningful alt text for images on websites, blogs, or online stores. In Pipedream, you can create workflows that trigger on various events to send images to the AltText.ai API and receive alt text, which you can then store or apply to your content management system automatically.

Action Code#

import alttextAi from "../../alttext_ai.app.mjs";
import {
  ConfigurationError, getFileStream,
} from "@pipedream/platform";
import { LANGUAGE_OPTIONS } from "../../commons/constants.mjs";

export default {
  key: "alttext_ai-generate-alt-text",
  name: "Generate Alt Text",
  description:
    "Generates a descriptive alt text for a given image. [See the documentation](https://alttext.ai/apidocs#tag/Images/operation/create-image)",
  version: "0.1.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    alttextAi,
    fileInfo: {
      type: "alert",
      alertType: "warning",
      content: "Either `Image Data` or `Image File Path or URL` should be provided. If both are provided, `Image Data` will be used.",
    },
    imageData: {
      type: "string",
      label: "Image Data",
      description:
        "The image data in base64 format",
      optional: true,
    },
    imageFilePath: {
      type: "string",
      label: "Image File Path or URL",
      description:
        "The image to process. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myImage.jpg`)",
      optional: true,
    },
    keywords: {
      type: "string[]",
      label: "Keywords",
      description:
        "Keywords / phrases to be considered when generating the alt text. Keywords must be in English, even if requesting alt text in another language. Max 6 items.",
      optional: true,
    },
    negativeKeywords: {
      type: "string[]",
      label: "Negative Keywords",
      description:
        "Negative keywords / phrases to be removed from any generated alt text. Negative keywords must be in English, even if requesting alt text in another language. Max 6 items.",
      optional: true,
    },
    keywordSource: {
      type: "string",
      label: "Keyword Source",
      description:
        "Text to use as the source of keywords for the alt text. Will only be used if `Keywords` is not provided. This text might be a product description, or a paragraph that describes the context of the images, etc. Max 1024 characters.",
      optional: true,
    },
    language: {
      type: "string",
      label: "Language",
      description: "The language for the generated alt text.",
      options: LANGUAGE_OPTIONS,
      default: "en",
      optional: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      imageData, imageFilePath,
    } = this;
    if (!imageData && !imageFilePath) {
      throw new ConfigurationError("Either `Image Data` or `Image File Path or URL` should be specified.");
    }

    let rawData = imageData;
    if (!rawData) {
      const stream = await getFileStream(imageFilePath);
      const chunks = [];
      for await (const chunk of stream) {
        chunks.push(chunk);
      }
      const buffer = Buffer.concat(chunks);
      rawData = buffer.toString("base64");
    }

    const response = await this.alttextAi.generateAltText({
      $,
      data: {
        image: {
          raw: rawData,
        },
        keywords: this.keywords,
        negative_keywords: this.negativeKeywords,
        keyword_source: this.keywordSource,
        lang: this.language,
      },
    });

    $.export("$summary", "Generated alt text successfully");
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
AltText.ai	`alttextAi`	`app`	This component uses the AltText.ai app.
Image Data	`imageData`	`string`	The image data in base64 format
Image File Path or URL	`imageFilePath`	`string`	The image to process. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myImage.jpg`)
Keywords	`keywords`	`string[]`	Keywords / phrases to be considered when generating the alt text. Keywords must be in English, even if requesting alt text in another language. Max 6 items.
Negative Keywords	`negativeKeywords`	`string[]`	Negative keywords / phrases to be removed from any generated alt text. Negative keywords must be in English, even if requesting alt text in another language. Max 6 items.
Keyword Source	`keywordSource`	`string`	Text to use as the source of keywords for the alt text. Will only be used if `Keywords` is not provided. This text might be a product description, or a paragraph that describes the context of the images, etc. Max 1024 characters.
Language	`language`	`string`	Select a value from the drop down menu:`{ "label": "Afrikaans", "value": "af" }{ "label": "Albanian", "value": "sq" }{ "label": "Amharic", "value": "am" }{ "label": "Arabic", "value": "ar" }{ "label": "Armenian", "value": "hy" }{ "label": "Assamese", "value": "as" }{ "label": "Aymara", "value": "ay" }{ "label": "Azerbaijani", "value": "az" }{ "label": "Bambara", "value": "bm" }{ "label": "Basque", "value": "eu" }{ "label": "Belarusian", "value": "be" }{ "label": "Bengali", "value": "bn" }{ "label": "Bhojpuri", "value": "bho" }{ "label": "Bosnian", "value": "bs" }{ "label": "Bulgarian", "value": "bg" }{ "label": "Catalan", "value": "ca" }{ "label": "Cebuano", "value": "ceb" }{ "label": "Chinese (Simplified)", "value": "zh-CN" }{ "label": "Chinese (Traditional)", "value": "zh-TW" }{ "label": "Corsican", "value": "co" }{ "label": "Croatian", "value": "hr" }{ "label": "Czech", "value": "cs" }{ "label": "Danish", "value": "da" }{ "label": "Dhivehi", "value": "dv" }{ "label": "Dogri", "value": "doi" }{ "label": "Dutch", "value": "nl" }{ "label": "English", "value": "en" }{ "label": "Esperanto", "value": "eo" }{ "label": "Estonian", "value": "et" }{ "label": "Ewe", "value": "ee" }{ "label": "Filipino (Tagalog)", "value": "fil" }{ "label": "Finnish", "value": "fi" }{ "label": "French", "value": "fr" }{ "label": "Frisian", "value": "fy" }{ "label": "Galician", "value": "gl" }{ "label": "Georgian", "value": "ka" }{ "label": "German", "value": "de" }{ "label": "Greek", "value": "el" }{ "label": "Guarani", "value": "gn" }{ "label": "Gujarati", "value": "gu" }{ "label": "Haitian Creole", "value": "ht" }{ "label": "Hausa", "value": "ha" }{ "label": "Hawaiian", "value": "haw" }{ "label": "Hebrew", "value": "he" }{ "label": "Hindi", "value": "hi" }{ "label": "Hmong", "value": "hmn" }{ "label": "Hungarian", "value": "hu" }{ "label": "Icelandic", "value": "is" }{ "label": "Igbo", "value": "ig" }{ "label": "Ilocano", "value": "ilo" }{ "label": "Indonesian", "value": "id" }{ "label": "Irish", "value": "ga" }{ "label": "Italian", "value": "it" }{ "label": "Japanese", "value": "ja" }{ "label": "Javanese", "value": "jv" }{ "label": "Kannada", "value": "kn" }{ "label": "Kazakh", "value": "kk" }{ "label": "Khmer", "value": "km" }{ "label": "Kinyarwanda", "value": "rw" }{ "label": "Konkani", "value": "gom" }{ "label": "Korean", "value": "ko" }{ "label": "Krio", "value": "kri" }{ "label": "Kurdish", "value": "ku" }{ "label": "Kurdish (Sorani)", "value": "ckb" }{ "label": "Kyrgyz", "value": "ky" }{ "label": "Lao", "value": "lo" }{ "label": "Latin", "value": "la" }{ "label": "Latvian", "value": "lv" }{ "label": "Lingala", "value": "ln" }{ "label": "Lithuanian", "value": "lt" }{ "label": "Luganda", "value": "lg" }{ "label": "Luxembourgish", "value": "lb" }{ "label": "Macedonian", "value": "mk" }{ "label": "Maithili", "value": "mai" }{ "label": "Malagasy", "value": "mg" }{ "label": "Malay", "value": "ms" }{ "label": "Malayalam", "value": "ml" }{ "label": "Maltese", "value": "mt" }{ "label": "Maori", "value": "mi" }{ "label": "Marathi", "value": "mr" }{ "label": "Meiteilon (Manipuri)", "value": "mni-Mtei" }{ "label": "Mizo", "value": "lus" }{ "label": "Mongolian", "value": "mn" }{ "label": "Myanmar (Burmese)", "value": "my" }{ "label": "Nepali", "value": "ne" }{ "label": "Norwegian", "value": "no" }{ "label": "Nyanja (Chichewa)", "value": "ny" }{ "label": "Odia (Oriya)", "value": "or" }{ "label": "Oromo", "value": "om" }{ "label": "Pashto", "value": "ps" }{ "label": "Persian", "value": "fa" }{ "label": "Polish", "value": "pl" }{ "label": "Portuguese", "value": "pt" }{ "label": "Punjabi", "value": "pa" }{ "label": "Quechua", "value": "qu" }{ "label": "Romanian", "value": "ro" }{ "label": "Russian", "value": "ru" }{ "label": "Samoan", "value": "sm" }{ "label": "Sanskrit", "value": "sa" }{ "label": "ScotsGaelic", "value": "gd" }{ "label": "Sepedi", "value": "nso" }{ "label": "Serbian", "value": "sr" }{ "label": "Sesotho", "value": "st" }{ "label": "Shona", "value": "sn" }{ "label": "Sindhi", "value": "sd" }{ "label": "Sinhala (Sinhalese)", "value": "si" }{ "label": "Slovak", "value": "sk" }{ "label": "Slovenian", "value": "sl" }{ "label": "Somali", "value": "so" }{ "label": "Spanish", "value": "es" }{ "label": "Sundanese", "value": "su" }{ "label": "Swahili", "value": "sw" }{ "label": "Swedish", "value": "sv" }{ "label": "Tagalog (Filipino)", "value": "tl" }{ "label": "Tajik", "value": "tg" }{ "label": "Tamil", "value": "ta" }{ "label": "Tatar", "value": "tt" }{ "label": "Telugu", "value": "te" }{ "label": "Thai", "value": "th" }{ "label": "Tigrinya", "value": "ti" }{ "label": "Tsonga", "value": "ts" }{ "label": "Turkish", "value": "tr" }{ "label": "Turkmen", "value": "tk" }{ "label": "Twi (Akan)", "value": "ak" }{ "label": "Ukrainian", "value": "uk" }{ "label": "Urdu", "value": "ur" }{ "label": "Uyghur", "value": "ug" }{ "label": "Uzbek", "value": "uz" }{ "label": "Vietnamese", "value": "vi" }{ "label": "Welsh", "value": "cy" }{ "label": "Xhosa", "value": "xh" }{ "label": "Yiddish", "value": "yi" }{ "label": "Yoruba", "value": "yo" }{ "label": "Zulu", "value": "zu" }`
syncDir	`syncDir`	`dir`

Action Authentication#

AltText.ai uses API keys for authentication. When you connect your AltText.ai account, Pipedream securely stores the keys so you can easily authenticate to AltText.ai APIs in both code and no-code steps.

About AltText.ai#

Automatically generate alt text for images in over 130 languages. Improve SEO and site accessibility. Integrations for WordPress, Shopify, web, CMS, and more.

More Ways to Connect AltText.ai + Google Drive#

Other Popular Integrations#

Generate Alt Text with AltText.ai API on New or Modified Comments from Google Drive API

Google Drive + AltText.ai

Generate Alt Text with AltText.ai API on Changes to Specific Files from Google Drive API

Pipedream makes it easy to connect APIs for AltText.ai, Google Drive and 2,900+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,900+apps by most popular

1
-
24
of
2,900+
apps by most popular