Create Document Transcription Task with Scale AI API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for Scale AI, Typeform and 2,400+ other apps remarkably fast.

Trigger workflow on

New Submission from the Typeform API

Next, do this

Create Document Transcription Task with the Scale 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 Typeform trigger and Scale AI action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Submission trigger
1. Connect your Typeform account
2. Select a Form
Configure the Create Document Transcription Task action
1. Connect your Scale AI account
2. Optional- Select a Project
3. Optional- Configure Instruction
4. Optional- Configure Callback URL
5. Optional- Configure Attachment
6. Optional- Configure Attachments
7. Optional- Configure Language
8. Optional- Select a Geometry
9. Optional- Configure Unique ID
10. Configure Number Of Features
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#

New Submission on Typeform

Description:Emit new submission

Version:0.0.8

Key:typeform-new-submission

View on GitHub

Typeform Overview#

The Typeform API furnishes you with the means to create dynamic forms and collect user responses in real-time. By leveraging this API within Pipedream's serverless platform, you can automate workflows to process this data, integrate seamlessly with other services, and react to form submissions instantaneously. This empowers you to craft tailored responses, synchronize with databases, trigger email campaigns, or even manage event registrations without manual intervention.

Trigger Code#

import { createHmac } from "crypto";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";
import common from "../common/common.mjs";
import constants from "../../constants.mjs";
import utils from "../common/utils.mjs";

const { typeform } = common.props;
const { parseIsoDate } = utils;

export default {
  ...common,
  key: "typeform-new-submission",
  name: "New Submission",
  version: "0.0.8",
  type: "source",
  description: "Emit new submission",
  props: {
    ...common.props,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateSecret() {
      return "" + Math.random();
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const secret = this.generateSecret();
      this._setSecret(secret);

      let tag = this._getTag();
      if (!tag) {
        tag = uuid();
        this._setTag(tag);
      }

      return await this.typeform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        tag,
        secret,
      });
    },
    async deactivate() {
      const tag = this._getTag();

      return await this.typeform.deleteHook({
        formId: this.formId,
        tag,
      });
    },
  },
  async run(event) {
    const {
      body,
      headers,
    } = event;

    const { [constants.TYPEFORM_SIGNATURE]: typeformSignature } = headers;

    if (typeformSignature) {
      const secret = this._getSecret();

      const hmac =
        createHmac(constants.ALGORITHM, secret)
          .update(body)
          .digest(constants.ENCODING);

      const signature = `${constants.ALGORITHM}=${hmac}`;

      if (typeformSignature !== signature) {
        throw new Error("signature mismatch");
      }
    }

    let formResponseString = "";
    const data = Object.assign({}, body.form_response);
    data.form_response_parsed = {};

    for (let i = 0; i < body.form_response.answers.length; i++) {
      const field = body.form_response.definition.fields[i];
      const answer = body.form_response.answers[i];

      let parsedAnswer;
      let value = answer[answer.type];

      if (value.label) {
        parsedAnswer = value.label;

      } else if (value.labels) {
        parsedAnswer = value.labels.join();

      } else if (value.choice) {
        parsedAnswer = value.choice;

      } else if (value.choices) {
        parsedAnswer = value.choices.join();

      } else {
        parsedAnswer = value;
      }

      data.form_response_parsed[field.title] = parsedAnswer;
      formResponseString += `### ${field.title}\n${parsedAnswer}\n`;
    }

    data.form_response_string = formResponseString;
    data.raw_webhook_event = body;

    if (data.landed_at) {
      data.landed_at = parseIsoDate(data.landed_at);
    }

    if (data.submitted_at) {
      data.submitted_at = parseIsoDate(data.submitted_at);
    }

    data.form_title = body.form_response.definition.title;
    delete data.answers;
    delete data.definition;

    this.$emit(data, {
      summary: JSON.stringify(data),
      id: data.token,
    });

    this.http.respond({
      status: 200,
    });
  },
  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
Typeform	`typeform`	`app`	This component uses the Typeform app.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

offlineaccounts:readforms:writeforms:readimages:writeimages:readthemes:writethemes:readresponses:readresponses:writewebhooks:readwebhooks:writeworkspaces:readworkspaces:write

About Typeform#

Typeform lets you build no-code forms, quizzes, and surveys - and get more responses.

Action#

Create Document Transcription Task on Scale AI

Description:Create a document transcription task. [See the documentation](https://docs.scale.com/reference/document-transcription-1)

Version:0.0.2

Key:scale_ai-create-document-transcription-task

View on GitHub

Scale AI Overview#

Scale AI offers an API to automate and streamline data labeling for machine learning applications, providing access to a global workforce and sophisticated tools. With Scale AI's API on Pipedream, you can integrate scalable data annotation workflows directly into your apps. Trigger tasks, manage datasets, and receive annotated data, all within Pipedream's serverless platform. This enables seamless automation of labeling tasks, integration with machine learning pipelines, and real-time updates on annotations.

Action Code#

import app from "../../scale_ai.app.mjs";
import utils from "../../common/utils.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "scale_ai-create-document-transcription-task",
  name: "Create Document Transcription Task",
  description: "Create a document transcription task. [See the documentation](https://docs.scale.com/reference/document-transcription-1)",
  type: "action",
  version: "0.0.2",
  props: {
    app,
    project: {
      propDefinition: [
        app,
        "project",
      ],
    },
    instruction: {
      propDefinition: [
        app,
        "instruction",
      ],
    },
    callbackUrl: {
      propDefinition: [
        app,
        "callbackUrl",
      ],
    },
    attachment: {
      description: "The url of the attachment of the data to be collected. We will use the HTTP content type to determine the type of the attachment. Either **Attachment** or **Attachments** is required. You can supply attachments instead of attachment if needed.",
      propDefinition: [
        app,
        "attachment",
      ],
    },
    attachments: {
      type: "string[]",
      label: "Attachments",
      description: "Used instead of **Attachment** - The urls of a multi-page document. Either **Attachment** or **Attachments** is required.",
      optional: true,
    },
    lang: {
      type: "string",
      label: "Language",
      description: "Language of the attachment. Defaults to `en-U`.",
      optional: true,
      default: "en-US",
    },
    geometry: {
      type: "string",
      label: "Geometry",
      description: "Geometry type for the annotations. Supported values are `box` for axis-aligned rectangles or `polygon` for rotated rectangles. Defaults to `box`.",
      optional: true,
      options: Object.values(constants.GEOMETRY_TYPE),
      default: constants.GEOMETRY_TYPE.BOX,
    },
    uniqueId: {
      propDefinition: [
        app,
        "uniqueId",
      ],
    },
    numberOfFeatures: {
      type: "integer",
      label: "Number Of Features",
      description: "The number of features to be collected. Defaults to `1`.",
      default: 1,
      reloadProps: true,
    },
  },
  methods: {
    featuresPropsMapper(prefix) {
      const {
        [`${prefix}type`]: type,
        [`${prefix}label`]: label,
        [`${prefix}title`]: title,
        [`${prefix}flags`]: flags,
      } = this;

      return {
        type,
        label,
        title,
        flags,
      };
    },
    getFeaturesPropDefinitions({
      prefix,
      label,
    } = {}) {
      return {
        [`${prefix}type`]: {
          type: "string",
          label: `${label} - Type`,
          description: "One of `text`, `block`, or `group`. See \"Feature Types\" for more information.",
          options: Object.values(constants.FEATURE_TYPE),
        },
        [`${prefix}label`]: {
          type: "string",
          label: `${label} - Label`,
          description: "Label for the annotation. It is required for block and text features.",
          optional: true,
        },
        [`${prefix}title`]: {
          type: "string",
          label: `${label} - Title`,
          description: "For `group`-type features, a group title must be provided as opposed to a label since a group itself is not labeled.",
          optional: true,
        },
        [`${prefix}flags`]: {
          type: "string[]",
          label: `${label} - Flags`,
          description: "A list of ContentFlag values. Content flags allow Scale to transcribe documents more effectively by enabling special tooling or modifying the default behavior for certain features.",
          optional: true,
          options: Object.values(constants.CONTENT_FLAG),
        },
      };
    },
    createDocumentTranscriptionTask(args = {}) {
      return this.app.post({
        path: "/task/documenttranscription",
        ...args,
      });
    },
  },
  async additionalProps() {
    const {
      numberOfFeatures,
      getFeaturesPropDefinitions,
    } = this;

    return utils.getAdditionalProps({
      numberOfFields: numberOfFeatures,
      fieldName: "feature",
      getPropDefinitions: getFeaturesPropDefinitions,
    });
  },
  async run({ $: step }) {
    const {
      createDocumentTranscriptionTask,
      project,
      instruction,
      callbackUrl,
      attachment,
      attachments,
      lang,
      geometry,
      uniqueId,
      numberOfFeatures,
      featuresPropsMapper,
    } = this;

    const response = await createDocumentTranscriptionTask({
      step,
      data: {
        project,
        instruction,
        callback_url: callbackUrl,
        attachment,
        attachments,
        lang,
        geometry,
        unique_id: uniqueId,
        features: utils.getFieldsProps({
          numberOfFields: numberOfFeatures,
          fieldName: "feature",
          propsMapper: featuresPropsMapper,
        }),
      },
    });

    step.export("$summary", `Successfully created document transcription task with ID  \`${response.task_id}\``);

    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
Scale AI	`app`	`app`	This component uses the Scale AI app.
Project	`project`	`string`	Select a value from the drop down menu.
Instruction	`instruction`	`string`	A markdown-enabled string or iframe embedded Google Doc explaining how to do the task. You can use markdown to show example images, give structure to your instructions, and more. See our instruction best practices for more details. For Scale Rapid projects, DO NOT set this field unless you specifically want to override the project level instructions.
Callback URL	`callbackUrl`	`string`	The full url (including the scheme `http://` or `https://`) or email address of the callback that will be used when the task is completed.
Attachment	`attachment`	`string`	The url of the attachment of the data to be collected. We will use the HTTP content type to determine the type of the attachment. Either Attachment or Attachments is required. You can supply attachments instead of attachment if needed.
Attachments	`attachments`	`string[]`	Used instead of Attachment - The urls of a multi-page document. Either Attachment or Attachments is required.
Language	`lang`	`string`	Language of the attachment. Defaults to `en-U`.
Geometry	`geometry`	`string`	Select a value from the drop down menu:`boxpolygon`
Unique ID	`uniqueId`	`string`	A arbitrary ID that you can assign to a task and then query for later. This ID must be unique across all projects under your account, otherwise the task submission will be rejected. See Avoiding Duplicate Tasks for more details.
Number Of Features	`numberOfFeatures`	`integer`	The number of features to be collected. Defaults to `1`.