Score Scripted Recording with Speechace API

Pipedream makes it easy to connect APIs for Speechace and 2,700+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Score Scripted Recording with the Speechace 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#

Create a workflow to Score Scripted Recording with the Speechace API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Score Scripted Recording action
1. Connect your Speechace account
2. Configure File Path or URL
3. Configure Text
4. Optional- Configure Question Info
5. Optional- Select a Dialect
6. Optional- Configure User ID
7. Optional- Configure syncDir
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Score Scripted Recording with Speechace API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Speechace

Try it

Score Scripted Recording with Speechace API on New Submission from Typeform API

Typeform + Speechace

Try it

Score Scripted Recording with Speechace API on New Submission (Instant) from Jotform API

Jotform + Speechace

Try it

Score Scripted Recording with Speechace API on New Scheduled Tasks from Pipedream API

Pipedream + Speechace

Try it

Score Scripted Recording with Speechace API on npm Download Counts from npm API

npm + Speechace

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Score Scripted Recording on Speechace

Description:Scores a scripted recording based on fluency and pronunciation. [See the documentation](https://docs.speechace.com/#c34b11dd-8172-441a-bc27-223339d48d8e)

Version:0.0.3

Key:speechace-score-scripted-recording

View on GitHub

Code#

import speechace from "../../speechace.app.mjs";
import FormData from "form-data";
import {
  getFileStreamAndMetadata, ConfigurationError,
} from "@pipedream/platform";

export default {
  key: "speechace-score-scripted-recording",
  name: "Score Scripted Recording",
  description: "Scores a scripted recording based on fluency and pronunciation. [See the documentation](https://docs.speechace.com/#c34b11dd-8172-441a-bc27-223339d48d8e)",
  version: "0.0.3",
  type: "action",
  props: {
    speechace,
    filePath: {
      propDefinition: [
        speechace,
        "filePath",
      ],
    },
    text: {
      type: "string",
      label: "Text",
      description: "A word, phrase, or sentence to score",
    },
    questionInfo: {
      type: "string",
      label: "Question Info",
      description: "A unique identifier for the activity or question this user audio is answering",
      optional: true,
    },
    dialect: {
      propDefinition: [
        speechace,
        "dialect",
      ],
    },
    userId: {
      propDefinition: [
        speechace,
        "userId",
      ],
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  async run({ $ }) {
    const data = new FormData();
    const {
      stream, metadata,
    } = await getFileStreamAndMetadata(this.filePath);
    data.append("user_audio_file", stream, {
      contentType: metadata.contentType,
      knownLength: metadata.size,
      filename: metadata.name,
    });
    if (this.text) {
      data.append("text", this.text);
    }
    if (this.questionInfo) {
      data.append("question_info", this.questionInfo);
    }

    const response = await this.speechace.scoreScript({
      $,
      params: {
        dialect: this.dialect,
        user_id: this.userId,
      },
      data,
      headers: data.getHeaders(),
    });
    if (response.status === "error") {
      throw new ConfigurationError(response.detail_message);
    }
    $.export("$summary", `Scored scripted recording for audio file: ${this.filePath}`);
    return response;
  },
};

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
Speechace	`speechace`	`app`	This component uses the Speechace app.
File Path or URL	`filePath`	`string`	Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.pdf).
Text	`text`	`string`	A word, phrase, or sentence to score
Question Info	`questionInfo`	`string`	A unique identifier for the activity or question this user audio is answering
Dialect	`dialect`	`string`	Select a value from the drop down menu:`{ "label": "US English", "value": "en-us" }{ "label": "UK English", "value": "en-gb" }`
User ID	`userId`	`string`	A unique anonymized identifier for the end-user who spoke the audio
N/A	`syncDir`	`dir`	This component uses `dir` to share files between component executions.