Merge pull request #101 from restackio/agentApis

Agent apis

Author: aboutphilippe

agent-apis/.env.example

@@ -0,0 +1,9 @@
+OPENAI_API_KEY=
+
+# Restack
+
+RESTACK_ENGINE_ID=
+RESTACK_ENGINE_ADDRESS=
+RESTACK_ENGINE_API_KEY=
+
+RESTACK_CLOUD_TOKEN=

agent-apis/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "ts-example-openai",
+  "version": "1.0.0",
+  "description": "Basic OpenAI example with Restack TypeScript library",
+  "main": "index.js",
+  "scripts": {
+    "start": "ts-node src/services.ts",
+    "start.watch": "nodemon src/services.ts",
+    "dev": "npm run start.watch",
+    "build": "tsc --build",
+    "clean": "rm -rf node_modules",
+    "schedule": "ts-node ./scheduleWorkflow.ts"
+  },
+  "nodemonConfig": {
+    "execMap": {
+      "ts": "ts-node"
+    },
+    "ext": "ts",
+    "watch": [
+      "src"
+    ]
+  },
+  "dependencies": {
+    "@restackio/ai": "^0.0.104",
+    "@temporalio/workflow": "1.11.6",
+    "openai": "^4.80.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.16.9",
+    "nodemon": "^2.0.22",
+    "ts-node": "^10.9.2"
+  }
+}

agent-apis/readme.md

@@ -0,0 +1,67 @@
+# Restack AI - Agent with Third Party APIs
+
+This repository contains an agent with Third Party APIs
+It demonstrates how to set up a multi steps workflow with Weather API and OpenAI.
+
+## Prerequisites
+
+- **Node 20+**
+
+## Start Restack
+
+To start the Restack, use the following Docker command:
+
+```bash
+docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 ghcr.io/restackio/restack:main
+```
+
+## Install dependencies and start services
+
+```bash
+npm install
+npm run dev
+```
+
+## Run agent
+
+### from UI
+
+You can run workflows from the UI by clicking the "Run" button.
+
+![Run workflows from UI](./workflow_get.png)
+
+### from API
+
+You can run workflows from the API by using the generated endpoint:
+
+`POST http://localhost:6233/api/workflows/multistepWorkflow`
+
+### from any client
+
+You can run workflows with any client connected to Restack, for example:
+
+If using uv:
+
+```bash
+uv run schedule-workflow
+```
+
+If using pip:
+
+```bash
+python -c "from src.schedule_workflow import run_schedule_workflow; run_schedule_workflow()"
+```
+
+executes `schedule_workflow.py` which will connect to Restack and execute the `multistepWorkflow` workflow.
+
+## See run results
+
+### from UI
+
+You can see the run results in the UI.
+
+![See run results from UI](./workflow_run.png)
+
+## Deploy on Restack Cloud
+
+To deploy the application on Restack, you can create an account at [https://console.restack.io](https://console.restack.io)

agent-apis/scheduleWorkflow.ts

@@ -0,0 +1,29 @@
+import { client } from "./src/client";
+
+export type InputSchedule = {
+  name: string;
+};
+
+async function scheduleWorkflow(input: InputSchedule) {
+  try {
+    const workflowId = `${Date.now()}-multistepWorkflow`;
+    const runId = await client.scheduleWorkflow({
+      workflowName: "multistepWorkflow",
+      workflowId,
+      input,
+    });
+
+    const result = await client.getWorkflowResult({ workflowId, runId });
+
+    console.log("Workflow result:", result);
+
+    process.exit(0); // Exit the process successfully
+  } catch (error) {
+    console.error("Error scheduling workflow:", error);
+    process.exit(1); // Exit the process with an error code
+  }
+}
+
+scheduleWorkflow({
+  name: "test",
+});

agent-apis/src/client.ts

@@ -0,0 +1,14 @@
+import Restack from "@restackio/ai";
+
+import "dotenv/config";
+
+export const connectionOptions = {
+  engineId: process.env.RESTACK_ENGINE_ID!,
+  address: process.env.RESTACK_ENGINE_ADDRESS!,
+  apiKey: process.env.RESTACK_ENGINE_API_KEY!,
+  apiAddress: process.env.RESTACK_ENGINE_API_ADDRESS!,
+};
+
+export const client = new Restack(
+  process.env.RESTACK_ENGINE_API_KEY ? connectionOptions : undefined
+);

agent-apis/src/functions/index.ts

@@ -0,0 +1,2 @@
+export * from "./llm";
+export * from "./weather";

agent-apis/src/functions/llm.ts

@@ -0,0 +1,46 @@
+import { FunctionFailure, log } from "@restackio/ai/function";
+import OpenAI from "openai/index";
+import { ChatCompletionCreateParamsNonStreaming } from "openai/resources/chat/completions";
+import { ChatModel } from "openai/resources/index";
+
+export type UsageOutput = { tokens: number; cost: number };
+
+export type OpenAIChatInput = {
+  userContent: string;
+  systemContent?: string;
+  model?: ChatModel;
+};
+
+export const llm = async ({
+  userContent,
+  systemContent = "",
+  model = "gpt-4o-mini",
+}: OpenAIChatInput): Promise<string> => {
+  try {
+    const openai = new OpenAI({
+      baseURL: "https://ai.restack.io",
+      apiKey: process.env.RESTACK_API_KEY,
+    });
+
+    const chatParams: ChatCompletionCreateParamsNonStreaming = {
+      messages: [
+        ...(systemContent
+          ? [{ role: "system" as const, content: systemContent }]
+          : []),
+        { role: "user" as const, content: userContent },
+      ],
+
+      model,
+    };
+
+    log.debug("OpenAI chat completion params", {
+      chatParams,
+    });
+
+    const completion = await openai.chat.completions.create(chatParams);
+
+    return completion.choices[0].message.content ?? "";
+  } catch (error) {
+    throw FunctionFailure.nonRetryable(`Error OpenAI chat: ${error}`);
+  }
+};

agent-apis/src/functions/weather.ts

@@ -0,0 +1,23 @@
+import { FunctionFailure, log } from "@restackio/ai/function";
+
+export const weather = async (): Promise<string> => {
+  const url =
+    "https://api.open-meteo.com/v1/forecast?latitude=52.52&longitude=13.41&current=temperature_2m,wind_speed_10m&hourly=temperature_2m,relative_humidity_2m,wind_speed_10m";
+
+  try {
+    const response = await fetch(url);
+    log.info("response", { response });
+
+    if (response.ok) {
+      const data = await response.json();
+      log.info("weather data", { data });
+      return JSON.stringify(data);
+    } else {
+      log.error(`Error: ${response.status}`);
+      throw new Error(`Error: ${response.status}`);
+    }
+  } catch (error) {
+    log.error(`Error: ${error}`);
+    throw FunctionFailure.nonRetryable(`Error fetching weather data: ${error}`);
+  }
+};

agent-apis/src/services.ts

@@ -0,0 +1,22 @@
+import { llm, weather } from "./functions";
+import { client } from "./client";
+
+async function services() {
+  const workflowsPath = require.resolve("./workflows");
+  try {
+    await Promise.all([
+      client.startService({
+        workflowsPath,
+        functions: { llm, weather },
+      }),
+    ]);
+
+    console.log("Services running successfully.");
+  } catch (e) {
+    console.error("Failed to run services", e);
+  }
+}
+
+services().catch((err) => {
+  console.error("Error running services:", err);
+});

agent-apis/src/workflows/index.ts

@@ -0,0 +1 @@
+export * from "./multistep";