Adding Discord Bot example

Author: GAIA Framework Bot

README.md

@@ -117,9 +117,9 @@ For the tool to execute properly the docker image must be built first:
       docker build -t jupyter-runtime .
       ```
 
-### Run Typescript Example
+### Run Typescript Console Example
 
-1. Navigate to `examples/typescript` in terminal
+1. Navigate to `examples/typescript/console` in terminal
 
 2. Create a `.env` file based on the `.env.example` and add your value for the `OPENAI_API_KEY`
 
@@ -134,6 +134,37 @@ For the tool to execute properly the docker image must be built first:
 4. Enter a prompt that would make GPT choose the tool
    - e.g., `execute a python script to add two numbers together and show the result`
 
+### Run Typescript Discord Bot Example
+
+1. Setup a Bot on the Discord Developer Portal: <https://discord.com/developers/applications>
+
+2. Navigate to `examples/typescript/discordbot` in terminal
+
+3. Create a `.env` file based on the `.env.example` and add your value for the `OPENAI_API_KEY`
+
+    - (Optional) To connect to Azure Blob storage, provide values for the additional following keys, assuming Azure Blob Storage is already configured in your Azure subscription (see [Microsofts Quickstart](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-portal))
+
+      - `AZURE_STORAGE_CONNECTION_STRING` - The connection string to your Azure Storage resource
+
+      - `AZURE_BLOB_CONTAINER_NAME` - The name of your blob container
+
+      - `AZURE_STORAGE_ACCOUNT_NAME` - The name of the Azure Storage account
+
+      - `AZURE_STORAGE_ACCOUNT_KEY` - The account key of the Azure Storage account
+
+4. Run the following commands sequentially:
+
+    ```bash
+    yarn install
+    yarn build
+    yarn start
+    ```
+
+5. Start a chat with your bot using its username
+
+6. Enter a prompt to your bot in Discord that would make GPT choose the tool
+   - e.g., `execute a python script to do something cool and display it`
+
 ## Example Run Outputs
 
 View [output examples](docs/output_examples.md) to see example run outputs using the tool with `.runTools(...)` from the [OpenAI Node API](https://www.npmjs.com/package/openai) for easy usage and handling tool errors

docs/output_examples.md

@@ -343,7 +343,7 @@ This plot showcases a simple, yet elegant, sine wave which is a fundamental conc
 
 ## Example 4 - Utilizing the tool with a Discord Bot
 
-In this example, a discord bot setup with GPT is configured to use the tool. After GPT responds with a url similarly to the examples above, it displays the message including a link to download the file if one is created. Which this case it returns a downloadable link to a blob storage where the file is uploaded to. Since discord supports displaying markdown, its shown nicely to the user compared to the standard CLI output. The code for this is not included in the repo, but a demonstration of what can be done using the tool in your application depending on the architecture. 
+In this example, a discord bot setup with GPT is configured to use the tool. After GPT responds with a url similarly to the examples above, it displays the message including a link to download the file if one is created. Which this case it returns a downloadable link to a blob storage where the file is uploaded to. Since discord supports displaying markdown, its shown nicely to the user compared to the standard CLI output.
 
 <details>
 <summary>View example</summary>

examples/typescript/.env.example renamed to examples/typescript/console/.env.example

@@ -0,0 +1,6 @@
+OPENAI_API_KEY=
+DISCORD_BOT_TOKEN=
+AZURE_BLOB_CONTAINER_NAME=
+AZURE_STORAGE_CONNECTION_STRING=
+AZURE_STORAGE_ACCOUNT_KEY=
+AZURE_STORAGE_ACCOUNT_NAME=

examples/typescript/package.json renamed to examples/typescript/console/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "typescript-discordbot",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc",
+    "start": "node ./dist/index.js"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@azure/storage-blob": "^12.17.0",
+    "discord.js": "^14.14.1",
+    "dotenv": "^16.4.5",
+    "openai": "^4.35.0"
+  }
+}

examples/typescript/src/example_openai.ts renamed to examples/typescript/console/src/example_openai.ts

@@ -0,0 +1,133 @@
+import {
+  BlobServiceClient,
+  BlobSASPermissions,
+  StorageSharedKeyCredential,
+  generateBlobSASQueryParameters
+} from "@azure/storage-blob";
+import path from "path";
+import { promises as fs } from 'fs';
+import { config } from "../config";
+import { BlobType } from "../utils/types";
+
+/**
+ * Represents a service for interacting with Azure Blob Storage.
+ */
+export class AzureBlobService {
+  private blobServiceClient: BlobServiceClient;
+
+  constructor() {
+    this.blobServiceClient = BlobServiceClient.fromConnectionString(config.azureStorageConnectionString);
+  }
+
+  static isBlobStorageAvailable(): boolean {
+    return Boolean(config.azureStorageConnectionString);
+  }
+
+  /**
+   * Generates a Shared Access Signature (SAS) URL for a blob in Azure Blob Storage.
+   * @param blobServiceClient - The BlobServiceClient instance.
+   * @param containerName - The name of the container.
+   * @param blobName - The name of the blob.
+   * @returns A Promise that resolves to the SAS URL for the blob.
+   */
+  async generateBlobSasUrl(blobServiceClient: BlobServiceClient, containerName: string, blobName: string): Promise<string> {
+    const containerClient = blobServiceClient.getContainerClient(containerName);
+    const blobClient = containerClient.getBlobClient(blobName);
+
+    const sasOptions = {
+      containerName,
+      blobName,
+      permissions: BlobSASPermissions.parse("r"),
+      startsOn: new Date(),
+      expiresOn: new Date(new Date().valueOf() + 3600 * 1000), // 1 hour from now
+    };
+
+    const sharedKeyCredential = new StorageSharedKeyCredential(
+      config.azureStorageAccountName,
+      config.azureStorageAccountKey
+    );
+
+    const sasToken = generateBlobSASQueryParameters(sasOptions, sharedKeyCredential).toString();
+
+    return `${blobClient.url}?${sasToken}`;
+  }
+
+  /**
+   * Uploads data to a blob container and returns a shared access signature (SAS) token for the uploaded blob.
+   * @param data - The data to be uploaded as a string.
+   * @param type - The type of the blob.
+   * @param fileExtension - The file extension of the blob.
+   * @returns A Promise that resolves to the SAS token for the uploaded blob.
+   */
+  async uploadToBlob(data: string, type: BlobType, fileExtension: string): Promise<string> {
+    const blobContainerClient = this.blobServiceClient.getContainerClient(config.azureBlobContainerName);
+    const blobName = `${type}-${Date.now()}.${fileExtension}`;
+    const blockBlobClient = blobContainerClient.getBlockBlobClient(blobName);
+
+    console.log(`Uploading ${type} to blob: ${blobName}`);
+
+    await blockBlobClient.upload(data, data.length);
+
+    const sasToken = await blockBlobClient.generateSasUrl({
+      expiresOn: new Date(new Date().valueOf() + 3600 * 1000), // 1 hour from now
+      permissions: BlobSASPermissions.parse("r")
+    });
+
+    return sasToken;
+  }
+
+  /**
+   * Uploads a file to the Azure Blob storage.
+   * @param filePath - The path of the file to upload.
+   * @returns A Promise that resolves to the SAS (Shared Access Signature) URL of the uploaded file.
+   */
+  async uploadFileToBlob(filePath: string): Promise<string> {
+    const blobType: BlobType = BlobType.File;
+    const originalFileName = path.basename(filePath);
+    const blobContainerClient = this.blobServiceClient.getContainerClient(config.azureBlobContainerName);
+    const fileExtension = path.extname(filePath);
+    const blobName = `${blobType}-${originalFileName.split('.')[0]}-${Date.now()}${fileExtension}`;
+    const blockBlobClient = blobContainerClient.getBlockBlobClient(blobName);
+
+    console.log(`Uploading ${blobType} to blob: ${blobName}`);
+
+    // Read the file as a buffer to handle both text and binary files correctly
+    const data = await fs.readFile(filePath);
+    await blockBlobClient.upload(data, data.length);
+
+    const sasUrl = await blockBlobClient.generateSasUrl({
+      expiresOn: new Date(new Date().valueOf() + 3600 * 1000), // 1 hour from now
+      permissions: BlobSASPermissions.parse("r")
+    });
+
+    return sasUrl;
+  }
+
+  async deleteBlob(blobName: string): Promise<void> {
+    const blobContainerClient = this.blobServiceClient.getContainerClient(config.azureBlobContainerName);
+    await blobContainerClient.deleteBlob(blobName);
+  }
+
+  /**
+   * Uploads a base64 encoded image to an Azure Blob storage container.
+   * @param base64Data - The base64 encoded image data.
+   * @param type - The type of the image (e.g., 'image', 'file', 'folder').
+   * @returns A Promise that resolves to the SAS (Shared Access Signature) URL of the uploaded image.
+   */
+  async uploadBase64ImageToBlob(base64Data: string, type: BlobType): Promise<string> {
+    const data = Buffer.from(base64Data, 'base64');
+
+    const blobContainerClient = this.blobServiceClient.getContainerClient(config.azureBlobContainerName);
+    const blobName = `${type}-${Date.now()}.png`;
+    const blockBlobClient = blobContainerClient.getBlockBlobClient(blobName);
+
+    console.info(`Uploading ${type} image to blob: ${blobName}`);
+
+    await blockBlobClient.upload(data, data.length, {
+      blobHTTPHeaders: { blobContentType: 'image/png' }
+    });
+
+    const sasUrl = await this.generateBlobSasUrl(this.blobServiceClient, config.azureBlobContainerName, blobName);
+    return sasUrl;
+  }
+}

examples/typescript/src/index.ts renamed to examples/typescript/console/src/index.ts

@@ -0,0 +1,44 @@
+import { Client, GatewayIntentBits, Partials } from "discord.js";
+import { getBotResponse } from "../example_openai";
+
+/**
+ * Represents a Discord bot that interacts with the Discord API.
+ */
+export class DiscordBot {
+  private client: Client;
+
+  constructor() {
+    this.client = new Client({
+      intents: [
+        GatewayIntentBits.Guilds,
+        GatewayIntentBits.GuildMessages,
+        GatewayIntentBits.MessageContent,
+        GatewayIntentBits.GuildMessageTyping,
+        GatewayIntentBits.DirectMessages
+      ],
+      partials: [Partials.Channel],
+    });
+  }
+
+  /**
+   * Starts the Discord bot and sets up event listeners for message creation and bot readiness.
+   */
+  start() {
+    this.client.on("ready", async () => {
+      console.log(`Discord bot logged in as ${this.client.user?.tag}!`);
+    });
+
+    this.client.on("messageCreate", async (message) => {
+      if (message.author.bot) return;
+
+      message.channel.sendTyping();
+
+      // Query open AI with the message content, utilizing
+      // discord for the input and output of chats
+      const response = await getBotResponse(message.content);
+      await message.channel.send(response ?? "Failed to get response from bot");
+    });
+
+    this.client.login(process.env.DISCORD_BOT_TOKEN);
+  }
+}

examples/typescript/src/tools/pythonTool.ts renamed to examples/typescript/console/src/tools/pythonTool.ts

@@ -0,0 +1,12 @@
+import * as dotenv from "dotenv";
+
+dotenv.config();
+
+export const config = {
+  discordBotToken: process.env.DISCORD_BOT_TOKEN,
+  openaiApiKey: process.env.OPENAI_API_KEY,
+  azureStorageConnectionString: process.env.AZURE_STORAGE_CONNECTION_STRING || "",
+  azureBlobContainerName: process.env.AZURE_BLOB_CONTAINER_NAME || "",
+  azureStorageAccountName: process.env.AZURE_STORAGE_ACCOUNT_NAME || "",
+  azureStorageAccountKey: process.env.AZURE_STORAGE_ACCOUNT_KEY || "",
+};

examples/typescript/src/utils/jupyter/NotebookParser.ts renamed to examples/typescript/console/src/utils/jupyter/NotebookParser.ts

@@ -0,0 +1,75 @@
+import OpenAI from 'openai';
+import { ChatCompletionMessageParam } from 'openai/resources';
+import { executePythonInNotebook } from './tools/pythonTool';
+
+const client = new OpenAI({
+  apiKey: process.env.OPENAI_API_KEY
+});
+
+const chatHistory: ChatCompletionMessageParam[] = [];
+
+/**
+ * Runs an example using OpenAI.
+ * This function executes Python code in a Jupyter notebook environment using OpenAI's GPT model.
+ * It prompts the user for a query, sends the query to the GPT model along with previous chat history,
+ * and displays the response from the GPT model.
+ */
+export async function getBotResponse(input: string) {
+  const executePythonSchema = {
+    "description": "Execute python in a jupyter notebook environment",
+    "parameters": {
+      "type": "object",
+      "properties": {
+        "input": {
+          "type": "string",
+          "description": "The code content to execute in the runtime execution environment"
+        }
+      },
+      "required": ["input"],
+    }
+  };
+
+  const instructions = `You are a Discord Bot GPT that has a tool to execute Python code. Here are the instructions for the python tool: 
+  -  When you send a message containing Python code to python, it will be executed in a non-stateful Jupyter notebook environment. Python will respond with the output of the execution and path to file if one exists. No timeout exists. The drive at '/mnt/data' can be used to save and persist user files. Internet access for this session is enabled, if needed or requested.
+  
+  - On errors of tool calls, try 3 times to fix the error if the tool response results in an error. If an error persists, let the user know.`;
+
+  chatHistory.push({
+    role: 'user',
+    content: input
+  });
+
+  // Note: remove chat history if you want a clear chat history for each query
+  // and just use instructions + user input as the query messages
+  const queryMessages: ChatCompletionMessageParam[] = [
+    {
+      role: "system",
+      content: instructions
+    },
+    ...chatHistory
+  ];
+
+  const runner = await client.beta.chat.completions
+    .runTools({
+      model: 'gpt-4-turbo',
+      messages: queryMessages,
+      tools: [
+        {
+          type: 'function',
+          function: {
+            function: executePythonInNotebook,
+            parse: JSON.parse,
+            ...executePythonSchema,
+          },
+        }
+      ],
+    });
+
+  runner.on('message', (message) => {
+    console.log(message);
+    chatHistory.push(message);
+  });
+
+  const finalContent = await runner.finalContent();
+  return finalContent;
+}

examples/typescript/src/utils/jupyter/notebookUtils.ts renamed to examples/typescript/console/src/utils/jupyter/notebookUtils.ts

@@ -0,0 +1,5 @@
+import * as dotenv from "dotenv";
+dotenv.config();
+
+import { DiscordBot } from "./bot/DiscordBot";
+new DiscordBot().start();