Add Utterance with wit.ai API on New Message Updates (Instant) from Telegram API

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

Trigger workflow on

New Message Updates (Instant) from the Telegram API

Next, do this

Add Utterance with the wit.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 Telegram trigger and wit.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 Message Updates (Instant) trigger
1. Connect your Telegram account
2. Optional- Configure Chat ID
Configure the Add Utterance action
1. Connect your wit.ai account
2. Configure Text
3. Optional- Configure Out of Scope
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 Message Updates (Instant) on Telegram

Description:Emit new event each time a Telegram message is created or updated.

Version:0.1.6

Key:telegram_bot_api-message-updates

View on GitHub

Telegram Overview#

The Telegram Bot API allows you to build bots that can interact with users on the Telegram platform. Using Pipedream, you can automate messaging, handle commands, and trigger actions based on conversations or alerts. Pipedream's serverless execution model enables you to create complex workflows involving Telegram messages without managing any infrastructure. With Pipedream's integration, you can process inbound messages, send outbound notifications, and connect the Telegram Bot API with numerous other services to create powerful automation solutions.

Trigger Code#

import base from "../common/webhooks.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...base,
  key: "telegram_bot_api-message-updates",
  name: "New Message Updates (Instant)",
  description: "Emit new event each time a Telegram message is created or updated.",
  version: "0.1.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...base.props,
    chatId: {
      propDefinition: [
        base.props.telegramBotApi,
        "chatId",
      ],
      optional: true,
    },
  },
  hooks: {
    ...base.hooks,
    async deploy() {
      if (this.chatId) {
        const { id } = await this.telegramBotApi.sdk().getChat(this.chatId);
        this._setChatId(id);
      }
      await base.hooks.deploy.call(this);
    },
  },
  methods: {
    ...base.methods,
    _getChatId() {
      return this.db.get("chatId");
    },
    _setChatId(chatId) {
      this.db.set("chatId", chatId);
    },
    getMeta(event, message) {
      return {
        id: event.update_id,
        summary: message.text,
        ts: new Date(message.edit_date ?? message.date),
      };
    },
    getEventTypes() {
      return [
        "message",
        "edited_message",
      ];
    },
    processEvent(event) {
      const message = event.edited_message ?? event.message;
      if (this.chatId) {
        const chatId = this._getChatId();
        if (chatId && chatId != message?.chat?.id) {
          return;
        }
      }
      this.$emit(event, this.getMeta(event, message));
    },
  },
  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
Telegram	`telegramBotApi`	`app`	This component uses the Telegram 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.
Chat ID	`chatId`	`string`	Enter the unique identifier for the target chat (e.g. `1035597319`) or username of the target public chat (in the format `@channelusername` or `@supergroupusername`). For example, if the group's public link is `t.me/mygroup`, the username is `@mygroup`.

Trigger Authentication#

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

About Telegram#

Telegram, is a cloud-based, cross-platform, encrypted instant messaging (IM) service.

Action#

Add Utterance on wit.ai

Description:Add a sample utterance to train your app with an intent. [See the documentation](https://wit.ai/docs/http/20240304#post__utterances).

Version:0.0.1

Key:wit_ai-add-utterance

View on GitHub

wit.ai Overview#

Wit.ai API enables your apps to process natural language and understand human commands contextually. With it, you can build conversational interfaces, decipher intent from text or voice inputs, and train your model to improve recognition. Pipedream provides a seamless platform to trigger workflows using this API, allowing the automation of tasks based on language cues. It's perfect for crafting custom bots, enhancing customer service, or streamlining internal operations by interpreting human requests and taking action accordingly.

Action Code#

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

export default {
  key: "wit_ai-add-utterance",
  name: "Add Utterance",
  description: "Add a sample utterance to train your app with an intent. [See the documentation](https://wit.ai/docs/http/20240304#post__utterances).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    text: {
      type: "string",
      label: "Text",
      description: "The text (sentence) you want your app to understand.",
    },
    outOfScope: {
      type: "boolean",
      label: "Out of Scope",
      description: "To train your app to recognize utterances that it should not handle set this to `true`.",
      optional: true,
      default: false,
      reloadProps: true,
    },
  },
  async additionalProps() {
    if (this.outOfScope === true) {
      return {};
    }

    const data = await this.app.listIntents();
    const intents = data.map(({ name }) => name);
    const intentOptions = intents.concat(Object.values(constants.BUILTIN_INTENTS));

    return {
      intent: {
        type: "string",
        label: "Intent",
        description: "The name of the intent you wish to create or train.",
        options: intentOptions,
      },
      entities: {
        type: "string[]",
        label: "Entities",
        description: "The list of entities appearing in this sentence, that you want your app to extract once it is trained. Each entity must be a JSON string with the following properties:\n- `entity` (string, required): The entity name, including the role (e.g., `temperature:temperature` or `wit$temperature:temperature`).\n- `start` (integer, required): The starting index within the text.\n- `end` (integer, required): The ending index within the text.\n- `body` (string, required): The span of the text for the entity.\n- `entities` (array, required): List of entities found within the composite entity.\n\nExample: `{\"entity\":\"wit$temperature:temperature\",\"start\":19,\"end\":26,\"body\":\"34 degrees\",\"entities\":[]}`",
        optional: true,
      },
      traits: {
        type: "string[]",
        label: "Traits",
        description: "The list of traits that are relevant for the utterance. Each trait must be a JSON string with the following properties:\n- `trait` (string, required): The trait name. This can be a trait you created, or a built-in one. i.e `faq` or `wit$sentiment`.\n- `value` (string, required): The value for the trait, e.g. `positive`.\n\nExample: `{\"trait\":\"wit$sentiment\",\"value\":\"neutral\"}`",
        optional: true,
      },
    };
  },
  methods: {
    addUtterance(args = {}) {
      return this.app.post({
        path: "/utterances",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      addUtterance,
      text,
      intent,
      entities,
      traits,
    } = this;

    const response = await addUtterance({
      $,
      data: [
        {
          text,
          intent,
          entities: utils.parseArray(entities),
          traits: utils.parseArray(traits),
        },
      ],
    });

    $.export("$summary", "Successfully added an utterance to your app.");
    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
wit.ai	`app`	`app`	This component uses the wit.ai app.
Text	`text`	`string`	The text (sentence) you want your app to understand.
Out of Scope	`outOfScope`	`boolean`	To train your app to recognize utterances that it should not handle set this to `true`.