@pipedream/serenity_ai_hub 0.0.1 → 0.1.0

package/actions/execute-agent/execute-agent.mjs

@@ -0,0 +1,82 @@
+import app from "../../serenity_ai_hub.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "serenity_ai_hub-execute-agent",
+  name: "Execute Agent",
+  description: "Executes an agent by its code with the provided parameters. [See the documentation](https://docs.serenitystar.ai/docs/api/aihub/execute-agent-with-code/)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    readOnlyHint: false,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    app,
+    agentCode: {
+      propDefinition: [
+        app,
+        "agentCode",
+      ],
+    },
+    message: {
+      type: "string",
+      label: "Message",
+      description: "The message to send to the agent",
+    },
+    culture: {
+      propDefinition: [
+        app,
+        "culture",
+      ],
+    },
+    chatId: {
+      type: "string",
+      label: "Chat ID",
+      description: "The ID of an existing conversation to continue. Leave empty to start a new conversation",
+      optional: true,
+    },
+    additionalParameters: {
+      type: "string[]",
+      label: "Additional Parameters",
+      description: "Array of additional parameters with `key` and `value` properties, or a JSON string representing that array. Example: `[{\"key\": \"param1\", \"value\": \"value1\"}]`",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const data = [
+      {
+        Key: "message",
+        Value: this.message,
+      },
+    ];
+
+    if (this.chatId) {
+      data.push({
+        Key: "chatId",
+        Value: this.chatId,
+      });
+    }
+
+    if (this.additionalParameters) {
+      const extra = utils.parseInputParameters(this.additionalParameters);
+      data.push(...extra.map((item) => ({
+        Key: item.key,
+        Value: item.value,
+      })));
+    }
+
+    const response = await this.app.executeAgent({
+      $,
+      agentCode: this.agentCode,
+      params: {
+        culture: this.culture,
+      },
+      data,
+    });
+
+    $.export("$summary", `Successfully executed agent \`${this.agentCode}\``);
+    return response;
+  },
+};

package/actions/get-all-agents/get-all-agents.mjs

@@ -0,0 +1,58 @@
+import app from "../../serenity_ai_hub.app.mjs";
+
+export default {
+  key: "serenity_ai_hub-get-all-agents",
+  name: "Get All Agents",
+  description: "Gets a list containing all agents. [See the documentation](https://docs.serenitystar.ai/docs/api/aihub/get-all-agents)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    readOnlyHint: true,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    app,
+    term: {
+      type: "string",
+      label: "Search Term",
+      description: "Filter agents by a search term",
+      optional: true,
+    },
+    culture: {
+      propDefinition: [
+        app,
+        "culture",
+      ],
+    },
+    max: {
+      type: "integer",
+      label: "Max Results",
+      description: "Maximum number of agents to return. Defaults to `100`",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      max,
+      term,
+      culture,
+    } = this;
+
+    const agents = await app.getPaginatedResources({
+      resourcesFn: app.getAllAgents,
+      resourcesFnArgs: {
+        $,
+        params: {
+          term,
+          culture,
+        },
+      },
+      max,
+    });
+
+    $.export("$summary", `Successfully retrieved \`${agents.length}\` agent(s)`);
+    return agents;
+  },
+};

package/actions/get-initial-conversation-info/get-initial-conversation-info.mjs

@@ -0,0 +1,67 @@
+import app from "../../serenity_ai_hub.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "serenity_ai_hub-get-initial-conversation-info",
+  name: "Get Initial Conversation Info",
+  description: "Gets initial conversation information. [See the documentation](https://docs.serenitystar.ai/docs/api/aihub/get-initial-conversation-info-by-agent-code)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    readOnlyHint: true,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    app,
+    agentCode: {
+      propDefinition: [
+        app,
+        "agentCode",
+      ],
+    },
+    culture: {
+      propDefinition: [
+        app,
+        "culture",
+      ],
+    },
+    userIdentifier: {
+      type: "string",
+      label: "User Identifier",
+      description: "An identifier for the user",
+      optional: true,
+    },
+    inputParameters: {
+      type: "string[]",
+      label: "Input Parameters",
+      description: "Array of input parameters with `key` and `value` properties, or a JSON string representing that array. Example: `[{\"key\": \"param1\", \"value\": \"value1\"}]`",
+      optional: true,
+    },
+    channel: {
+      type: "string",
+      label: "Channel",
+      description: "Optional channel information",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.getConversationInfo({
+      $,
+      agentCode: this.agentCode,
+      params: {
+        culture: this.culture,
+      },
+      data: {
+        userIdentifier: this.userIdentifier,
+        inputParameters: this.inputParameters
+          ? utils.parseInputParameters(this.inputParameters)
+          : undefined,
+        channel: this.channel,
+      },
+    });
+
+    $.export("$summary", `Successfully retrieved conversation info for agent \`${this.agentCode}\``);
+    return response;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,7 @@
+const DEFAULT_MAX = 100;
+const DEFAULT_LIMIT = 20;
+
+export default {
+  DEFAULT_MAX,
+  DEFAULT_LIMIT,
+};

package/common/utils.mjs

@@ -0,0 +1,36 @@
+/**
+ * Parses input parameters into the API's key-value pair format.
+ * Accepts either a JSON string (e.g. `'[{"key":"k","value":"v"}]'` or `'[]'`)
+ * or an array of objects with `key` and `value` properties.
+ * @param {string | { key: string, value: string }[]} params
+ * @returns {{ key: string, value: string }[]}
+ */
+const parseInputParameters = (params) => {
+  const parsed = typeof params === "string"
+    ? JSON.parse(params)
+    : params;
+
+  if (!Array.isArray(parsed)) {
+    throw new Error("Expected an array of objects with `key` and `value` properties");
+  }
+
+  return parsed.map((item, index) => {
+    const entry = typeof item === "string"
+      ? JSON.parse(item)
+      : item;
+    if (entry?.key === undefined || entry?.key === null) {
+      throw new Error(`Item at index ${index} is missing the \`key\` property`);
+    }
+    if (entry?.value === undefined || entry?.value === null) {
+      throw new Error(`Item at index ${index} is missing the \`value\` property`);
+    }
+    return {
+      key: entry.key,
+      value: entry.value,
+    };
+  });
+};
+
+export default {
+  parseInputParameters,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/serenity_ai_hub",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Serenity* AI Hub Components",
   "main": "serenity_ai_hub.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.2.5"
   }
 }

package/serenity_ai_hub.app.mjs

@@ -1,11 +1,128 @@
+import { axios } from "@pipedream/platform";
+import constants from "./common/constants.mjs";
+
 export default {
   type: "app",
   app: "serenity_ai_hub",
-  propDefinitions: {},
+  propDefinitions: {
+    agentCode: {
+      type: "string",
+      label: "Agent Code",
+      description: "The unique identifier code of the agent",
+      async options({ page }) {
+        const response = await this.getAllAgents({
+          params: {
+            page: page + 1,
+            pageSize: 20,
+          },
+        });
+        const agents = response?.items ?? [];
+        return agents.map((agent) => ({
+          label: agent.name || agent.code,
+          value: agent.code,
+        }));
+      },
+    },
+    culture: {
+      type: "string",
+      label: "Culture",
+      description: "Overrides the response language",
+      optional: true,
+      options: [
+        {
+          label: "English",
+          value: "en",
+        },
+        {
+          label: "Spanish",
+          value: "es",
+        },
+      ],
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    getUrl(path) {
+      return `https://api.serenitystar.ai/api/v2${path}`;
+    },
+    getHeaders(headers) {
+      return {
+        "content-type": "application/json-patch+json",
+        "x-api-key": this.$auth.api_key,
+        ...headers,
+      };
+    },
+    _makeRequest({
+      $ = this, path, headers, ...opts
+    }) {
+      return axios($, {
+        url: this.getUrl(path),
+        headers: this.getHeaders(headers),
+        ...opts,
+      });
+    },
+    getAllAgents(opts = {}) {
+      return this._makeRequest({
+        path: "/agent",
+        ...opts,
+      });
+    },
+    getConversationInfo({
+      agentCode, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/Agent/${agentCode}/conversation/info`,
+        method: "POST",
+        ...opts,
+      });
+    },
+    executeAgent({
+      agentCode, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/agent/${agentCode}/execute`,
+        method: "POST",
+        ...opts,
+      });
+    },
+    async getPaginatedResources(args) {
+      const items = [];
+      for await (const item of this.paginate(args)) {
+        items.push(item);
+      }
+      return items;
+    },
+    async *paginate({
+      resourcesFn, resourcesFnArgs, max = constants.DEFAULT_MAX,
+    }) {
+      let page = 1;
+      let count = 0;
+      const pageSize = constants.DEFAULT_LIMIT;
+
+      while (true) {
+        const response = await resourcesFn({
+          ...resourcesFnArgs,
+          params: {
+            ...resourcesFnArgs?.params,
+            page,
+            pageSize,
+          },
+        });
+
+        const items = response?.items ?? [];
+
+        for (const item of items) {
+          yield item;
+          count++;
+          if (max && count >= max) {
+            return;
+          }
+        }
+
+        if (items.length < pageSize) {
+          return;
+        }
+        page++;
+      }
     },
   },
-};
+};