[Components] speak_ai - add instant-hook sources and AI Chat / Find Media actions

components/speak_ai/actions/find-media/find-media.mjs

@@ -0,0 +1,52 @@
+import app from "../../speak_ai.app.mjs";
+
+export default {
+  key: "speak_ai-find-media",
+  name: "Find Media",
+  description: "Find an existing Speak AI media item by its Media ID. [See the documentation](https://docs.speakai.co/).",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    app,
+    folderId: {
+      propDefinition: [
+        app,
+        "folderId",
+      ],
+    },
+    mediaId: {
+      propDefinition: [
+        app,
+        "mediaId",
+        ({ folderId }) => ({
+          folderId,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      mediaId,
+    } = this;
+
+    const results = await app.getInsights({
+      $,
+      params: {
+        mediaId,
+        pageSize: 1,
+      },
+    });
+    const media = app.firstResult(results);
+
+    $.export("$summary", media
+      ? `Found media \`${mediaId}\`.`
+      : `No media found for \`${mediaId}\`.`);
+    return media;
+  },
+};

components/speak_ai/actions/run-ai-chat/run-ai-chat.mjs

@@ -0,0 +1,75 @@
+import app from "../../speak_ai.app.mjs";
+
+export default {
+  key: "speak_ai-run-ai-chat",
+  name: "Run AI Chat",
+  description: "Run a Speak AI Chat against a folder and/or specific media. [See the documentation](https://docs.speakai.co/).",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    app,
+    prompt: {
+      propDefinition: [
+        app,
+        "prompt",
+      ],
+    },
+    folderId: {
+      propDefinition: [
+        app,
+        "folderId",
+      ],
+    },
+    assistantType: {
+      type: "string",
+      label: "Assistant Type",
+      description: "The assistant type to use for the prompt (e.g. `researcher`, `marketer`, `sales`, `general`, `recruiter`)",
+      optional: true,
+      default: "general",
+    },
+    assistantTemplateId: {
+      type: "string",
+      label: "Assistant Template ID",
+      description: "Optional custom assistant template to apply",
+      optional: true,
+    },
+    mediaIds: {
+      propDefinition: [
+        app,
+        "mediaIds",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      prompt,
+      folderId,
+      assistantType,
+      assistantTemplateId,
+      mediaIds,
+    } = this;
+
+    const response = await app.runPrompt({
+      $,
+      data: {
+        folderId,
+        prompt,
+        assistantType,
+        assistantTemplateId,
+        mediaIds: mediaIds || [],
+      },
+    });
+
+    const promptId = response?.data?.promptId;
+    $.export("$summary", promptId
+      ? `Successfully ran AI Chat \`${promptId}\`.`
+      : "Successfully ran AI Chat.");
+    return response;
+  },
+};

components/speak_ai/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/speak_ai",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Pipedream Speak AI Components",
   "main": "speak_ai.app.mjs",
   "keywords": [

components/speak_ai/sources/common/base.mjs

@@ -0,0 +1,65 @@
+import { ConfigurationError } from "@pipedream/platform";
+import app from "../../speak_ai.app.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  props: {
+    app,
+    db: "$.service.db",
+    http: "$.interface.http",
+  },
+  hooks: {
+    async activate() {
+      const { data } = await this.app.subscribeWebhook({
+        data: {
+          callbackUrl: this.http.endpoint,
+          events: this.getEvents(),
+        },
+      });
+      this.setWebhookId(data.webhookId);
+    },
+    async deactivate() {
+      const webhookId = this.getWebhookId();
+      if (webhookId) {
+        await this.app.unsubscribeWebhook({
+          webhookId,
+        });
+      }
+    },
+  },
+  methods: {
+    setWebhookId(value) {
+      this.db.set(constants.WEBHOOK_ID, value);
+    },
+    getWebhookId() {
+      return this.db.get(constants.WEBHOOK_ID);
+    },
+    getEvents() {
+      throw new ConfigurationError("getEvents is not implemented");
+    },
+    getSummary(resource) {
+      return `New Speak AI event: ${resource.eventType || "delivery"}`;
+    },
+    async hydrate(resource) {
+      return resource;
+    },
+    generateMeta(resource, data) {
+      return {
+        id: resource.deliveryId || resource.mediaId || resource.messageId || resource.promptId,
+        summary: this.getSummary(resource, data),
+        ts: Date.parse(resource.createdAt) || Date.now(),
+      };
+    },
+    async processResource(resource) {
+      const data = await this.hydrate(resource);
+      this.$emit(data, this.generateMeta(resource, data));
+    },
+  },
+  async run({ body }) {
+    if (!body || typeof body !== "object" || Array.isArray(body)) {
+      console.log("Skipping event: webhook body is missing or not a resource object.");
+      return;
+    }
+    await this.processResource(body);
+  },
+};

components/speak_ai/sources/new-ai-chat/new-ai-chat.mjs

@@ -0,0 +1,47 @@
+import common from "../common/base.mjs";
+import events from "../common/events.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "speak_ai-new-ai-chat",
+  name: "New AI Chat Response (Instant)",
+  description: "Emit new event when a Speak AI Chat response is ready (`chat.status`). [See the documentation](https://docs.speakai.co/).",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEvents() {
+      return [
+        events.CHAT_STATUS,
+      ];
+    },
+    getSummary(resource) {
+      return `New AI Chat response ${resource.messageId || resource.promptId || ""}`.trim();
+    },
+    async hydrate(resource) {
+      const res = await this.app.getPromptsHistory({
+        headers: {
+          Accept: "application/json",
+        },
+        params: {
+          pageSize: 100,
+        },
+      });
+      const history = res?.data?.history || [];
+      const match = history.find((item) =>
+        (resource.messageId && item.messageId === resource.messageId)
+        || (resource.promptId && item.promptId === resource.promptId));
+      return match || {
+        promptId: resource.promptId,
+        messageId: resource.messageId,
+        prompt: resource.prompt,
+        answer: resource.answer,
+        mediaIds: resource.mediaIds,
+        folderId: resource.folderId,
+      };
+    },
+  },
+  sampleEmit,
+};

components/speak_ai/sources/new-ai-chat/test-event.mjs

@@ -0,0 +1,39 @@
+export default {
+  "id": "64c2cfc863d1160cd6c2262a",
+  "promptId": "64c2cfc863d1160cd6c2262a",
+  "messageId": "45df1bc7b1b2",
+  "prompt": "What challenges is the team at Speak AI having with software sales?",
+  "answer": "From the text, it is mentioned that the team at Speak AI is facing several challenges with software sales, including customer segmentation, competition, and limited resources.",
+  "createdAt": "2023-07-27T20:12:56.645Z",
+  "assistantType": "General",
+  "mediaName": "Speak AI Office Hours",
+  "mediaIds": [],
+  "folderId": "27c6e4a90e32",
+  "state": "completed",
+  "link": "https://app.speakai.co/media/list?dialog=chat&tab=history",
+  "references": [
+    {
+      "companyId": "5e21c8dd2d77242c64214816",
+      "createdAt": "2021-08-06T17:39:24.934Z",
+      "folderId": "27c6e4a90e32",
+      "mediaId": "a59b93b67685",
+      "name": "Office Hours 28",
+      "tags": [
+        "Office Hours"
+      ],
+      "type": "video",
+      "userId": "5d03a9d5d4bca272e9c8cf89",
+      "sentences": [
+        {
+          "speaker": "Vatsal Shah",
+          "startTime": "0:04:41.38",
+          "endTime": "0:05:26.46",
+          "text": "Working on the engineering side building the product and moving to the customer segmentation side.",
+          "link": "",
+          "score": 0.84037739
+        }
+      ],
+      "score": 0.84037739
+    }
+  ]
+};

components/speak_ai/sources/new-captions/new-captions.mjs

@@ -0,0 +1,51 @@
+import common from "../common/base.mjs";
+import events from "../common/events.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "speak_ai-new-captions",
+  name: "New Captions (Instant)",
+  description: "Emit new event with caption files (SRT or VTT) when Speak AI finishes analyzing a media file (`media.analyzed`, `media.reanalyzed`). [See the documentation](https://docs.speakai.co/).",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    fileType: {
+      type: "string",
+      label: "Caption File Type",
+      description: "The caption format to fetch",
+      options: [
+        "SRT",
+        "VTT",
+      ],
+      default: "SRT",
+    },
+  },
+  methods: {
+    ...common.methods,
+    getEvents() {
+      return [
+        events.MEDIA_ANALYZED,
+        events.MEDIA_REANALYZED,
+      ];
+    },
+    getSummary(resource) {
+      return `New ${this.fileType} captions for media ${resource.mediaId}`;
+    },
+    async hydrate(resource) {
+      const results = await this.app.getExport({
+        headers: {
+          Accept: "application/json",
+        },
+        params: {
+          mediaId: resource.mediaId,
+          fileType: this.fileType.toLowerCase(),
+        },
+      });
+      return this.app.firstResult(results, resource);
+    },
+  },
+  sampleEmit,
+};

components/speak_ai/sources/new-captions/test-event.mjs

@@ -0,0 +1,8 @@
+export default {
+  "id": "4f42d4179f68",
+  "mediaId": "4f42d4179f68",
+  "name": "GMT20211029-100117_Recording_1920x1080",
+  "description": "testing 123",
+  "durationInSecond": "185",
+  "caption": "1\n00:00:11,780 --> 00:00:13,750\nHi, that's all I just wanted to\n\n2\n00:00:15,180 --> 00:00:20,050\nwrite you a message, but it's taking\ntoo long so I think it's maybe it's\njust easier if I.\n"
+};

components/speak_ai/sources/new-recording/new-recording.mjs

@@ -0,0 +1,36 @@
+import common from "../common/base.mjs";
+import events from "../common/events.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "speak_ai-new-recording",
+  name: "New Recording Captured (Instant)",
+  description: "Emit new event when a recording is captured through a Speak AI embed recorder (`embed_recorder.recording_received`). [See the documentation](https://docs.speakai.co/).",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEvents() {
+      return [
+        events.EMBED_RECORDER_RECORDING_RECEIVED,
+      ];
+    },
+    getSummary(resource) {
+      return `New recording captured for media ${resource.mediaId}`;
+    },
+    async hydrate(resource) {
+      const results = await this.app.getInsights({
+        params: {
+          uploadType: "recorder",
+          mediaId: resource.mediaId,
+          page: 0,
+          pageSize: 1,
+        },
+      });
+      return this.app.firstResult(results, resource);
+    },
+  },
+  sampleEmit,
+};