add motoko/llm_chatbot

Author: viviveevee

.github/workflows/motoko-llm-chatbot-example.yml

@@ -0,0 +1,40 @@
+name: motoko-llm-chatbot
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    paths:
+      - motoko/llm_chatbot/**
+      - .github/workflows/provision-darwin.sh
+      - .github/workflows/provision-linux.sh
+      - .github/workflows/motoko-llm-chatbot-example.yml
+      - .ic-commit
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  motoko-llm-chatbot-darwin:
+    runs-on: macos-15
+    steps:
+      - uses: actions/checkout@v1
+      - name: Provision Darwin
+        run: bash .github/workflows/provision-darwin.sh
+      - name: Motoko Flying Ninja Darwin
+        run: |
+          dfx start --background
+          pushd motoko/llm_chatbot
+          make install
+          popd
+  motoko-llm-chatbot-linux:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v1
+      - name: Provision Linux
+        run: bash .github/workflows/provision-linux.sh
+      - name: Motoko Flying Ninja Linux
+        run: |
+          dfx start --background
+          pushd motoko/llm_chatbot
+          make install
+          popd

motoko/llm_chatbot/BUILD.md

@@ -0,0 +1,109 @@
+# Continue building locally
+
+Projects deployed through ICP Ninja are temporary; they will only be live for 20 minutes before they are removed. The command-line tool `dfx` can be used to continue building your ICP Ninja project locally and deploy it to the mainnet.
+
+To migrate your ICP Ninja project off of the web browser and develop it locally, follow these steps.
+
+### 1. Install developer tools.
+
+You can install the developer tools natively or use Dev Containers.
+
+#### Option 1: Natively install developer tools
+
+> Installing `dfx` natively is currently only supported on macOS and Linux systems. On Windows, it is recommended to use the Dev Containers option.
+
+1. Install `dfx` with the following command:
+
+```
+
+sh -ci "$(curl -fsSL https://internetcomputer.org/install.sh)"
+
+```
+
+> On Apple Silicon (e.g., Apple M1 chip), make sure you have Rosetta installed (`softwareupdate --install-rosetta`).
+
+2. [Install NodeJS](https://nodejs.org/en/download/package-manager).
+
+3. For Rust projects, you will also need to:
+
+- Install [Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html#install-rust-and-cargo): `curl https://sh.rustup.rs -sSf | sh`
+
+- Install [candid-extractor](https://crates.io/crates/candid-extractor): `cargo install candid-extractor`
+
+4. For Motoko projects, you will also need to:
+
+- Install the Motoko package manager [Mops](https://docs.mops.one/quick-start#2-install-mops-cli): `npm i -g ic-mops`
+
+Lastly, navigate into your project's directory that you downloaded from ICP Ninja.
+
+#### Option 2: Dev Containers
+
+Continue building your projects locally by installing the [Dev Container extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) for VS Code and [Docker](https://docs.docker.com/engine/install/).
+
+Make sure Docker is running, then navigate into your project's directory that you downloaded from ICP Ninja and start the Dev Container by selecting `Dev-Containers: Reopen in Container` in VS Code's command palette (F1 or Ctrl/Cmd+Shift+P).
+
+> Note that local development ports (e.g. the ports used by `dfx` or `vite`) are forwarded from the Dev Container to your local machine. In the VS code terminal, use Ctrl/Cmd+Click on the displayed local URLs to open them in your browser. To view the current port mappings, click the "Ports" tab in the VS Code terminal window.
+
+### 2. Create a local developer identity.
+
+To manage your project's canisters, it is recommended that you create a local [developer identity](https://internetcomputer.org/docs/building-apps/getting-started/identities) rather than use the `dfx` default identity that is not stored securely.
+
+To create a new identity, run the commands:
+
+```
+
+dfx start --background
+
+dfx identity new IDENTITY_NAME
+
+dfx identity use IDENTITY_NAME
+
+```
+
+Replace `IDENTITY_NAME` with your preferred identity name. The first command `dfx start --background` starts the local `dfx` processes, then `dfx identity new` will create a new identity and return your identity's seed phase. Be sure to save this in a safe, secure location.
+
+The third command `dfx identity use` will tell `dfx` to use your new identity as the active identity. Any canister smart contracts created after running `dfx identity use` will be owned and controlled by the active identity.
+
+Your identity will have a principal ID associated with it. Principal IDs are used to identify different entities on ICP, such as users and canisters.
+
+[Learn more about ICP developer identities](https://internetcomputer.org/docs/building-apps/getting-started/identities).
+
+### 3. Deploy the project locally.
+
+Deploy your project to your local developer environment with:
+
+```
+npm install
+dfx deploy
+
+```
+
+Your project will be hosted on your local machine. The local canister URLs for your project will be shown in the terminal window as output of the `dfx deploy` command. You can open these URLs in your web browser to view the local instance of your project.
+
+### 4. Obtain cycles.
+
+To deploy your project to the mainnet for long-term public accessibility, first you will need [cycles](https://internetcomputer.org/docs/building-apps/getting-started/tokens-and-cycles). Cycles are used to pay for the resources your project uses on the mainnet, such as storage and compute.
+
+> This cost model is known as ICP's [reverse gas model](https://internetcomputer.org/docs/building-apps/essentials/gas-cost), where developers pay for their project's gas fees rather than users pay for their own gas fees. This model provides an enhanced end user experience since they do not need to hold tokens or sign transactions when using a dapp deployed on ICP.
+
+> Learn how much a project may cost by using the [pricing calculator](https://internetcomputer.org/docs/building-apps/essentials/cost-estimations-and-examples).
+
+Cycles can be obtained through [converting ICP tokens into cycles using `dfx`](https://internetcomputer.org/docs/building-apps/developer-tools/dfx/dfx-cycles#dfx-cycles-convert).
+
+### 5. Deploy to the mainnet.
+
+Once you have cycles, run the command:
+
+```
+
+dfx deploy --network ic
+
+```
+
+After your project has been deployed to the mainnet, it will continuously require cycles to pay for the resources it uses. You will need to [top up](https://internetcomputer.org/docs/building-apps/canister-management/topping-up) your project's canisters or set up automatic cycles management through a service such as [CycleOps](https://cycleops.dev/).
+
+> If your project's canisters run out of cycles, they will be removed from the network.
+
+## Additional examples
+
+Additional code examples and sample applications can be found in the [DFINITY examples repo](https://github.com/dfinity/examples).

motoko/llm_chatbot/Makefile

@@ -0,0 +1,28 @@
+.PHONY: all
+all: build
+
+.PHONY: node_modules
+.SILENT: node_modules
+node_modules:
+	npm install
+
+.PHONY: build
+.SILENT: build
+build: node_modules
+	dfx canister create --all
+	dfx build
+
+.PHONY: install
+.SILENT: install
+install: build
+	dfx canister install --all
+
+.PHONY: upgrade
+.SILENT: upgrade
+upgrade: build
+	dfx canister install --all --mode=upgrade
+
+.PHONY: clean
+.SILENT: clean
+clean:
+	rm -fr .dfx

motoko/llm_chatbot/README.md

@@ -0,0 +1,60 @@
+# LLM Chatbot
+
+![LLM Chatbot](../../_attachments/llm_chatbot.png)
+
+The LLM Chatbot example demonstrates how an ICP smart contract can be used to interact with a large language model (LLM) to generate text. The user can input a prompt, and the smart contract will use the LLM to generate a response.
+The response is then returned to the user, and the user can submit some follow-up prompts to continue the conversation.
+
+This application's logic is written in [Motoko](https://internetcomputer.org/docs/motoko/main/getting-started/motoko-introduction), a programming language designed specifically for developing canisters on ICP.
+
+## What is ICP Ninja?
+
+ICP Ninja is a web-based integrated development environment (IDE) for the Internet Computer. It allows you to write code and deploy applications directly from your web browser in a temporary, sandbox-like environment.
+
+For users who may already be familiar with the Internet Computer or who would rather use more **advanced tooling** such as command-line development tools, please refer to the [ICP developer documentation](https://internetcomputer.org/docs/building-apps/getting-started/install) to learn more.
+
+Projects deployed to ICP from ICP Ninja are available on the mainnet for 20 minutes at a time. After 20 minutes, the project must be redeployed.
+
+To deploy your project for long-term, production use such that it persists longer than 20 minutes without needing to be redeployed, you must migrate the files off of ICP Ninja and deploy them to the mainnet via `dfx` in a command-line environment.
+
+## Project structure
+
+The `/backend` folder contains the Motoko canister, `app.mo`. The `/frontend` folder contains web assets for the application's user interface. The user interface is written using the React framework. Edit the `mops.toml` file to add [Motoko dependencies](https://mops.one/) to the project.
+
+## Deploying from ICP Ninja
+
+When viewing this project in ICP Ninja, you can deploy it directly to the mainnet for free by clicking "Deploy" in the upper right corner.
+
+To **download** or **reset** the project files, click the menu option next to the deploy button.
+
+## Editing files
+
+To make adjustments to this project, you can edit any file that is unlocked. Then, redeploy your application to view your changes.
+
+To edit files that are immutable in ICP Ninja, you can export the project to GitHub or download the project to your local environment using the "Download files" option.
+
+## Build and deploy from the command-line
+
+To migrate your ICP Ninja project off of the web browser and develop it locally, follow these steps. These steps are necessary if you want to deploy this project for long-term, production use on the mainnet.
+
+### 1. Download your project from ICP Ninja using the 'Download files' button on the upper left corner under the pink ninja star icon.
+
+### 2. Setting up Ollama
+
+To be able to test the agent locally, you'll need a server for processing the agent's prompts. For that, we'll use `ollama`, which is a tool that can download and serve LLMs.
+See the documentation on the [Ollama website](https://ollama.com/) to install it. Once it's installed, run:
+
+```
+ollama serve
+# Expected to start listening on port 11434
+```
+
+The above command will start the Ollama server, so that it can process requests by the agent. Additionally, and in a separate window, run the following command to download the LLM that will be used by the agent:
+
+```
+ollama run llama3.1:8b
+```
+
+The above command will download an 8B parameter model, which is around 4GiB. Once the command executes and the model is loaded, you can terminate it. You won't need to do this step again.
+
+### 3. Open the `BUILD.md` file for further instructions.

motoko/llm_chatbot/backend/app.mo

@@ -0,0 +1,11 @@
+import LLM "mo:llm";
+
+persistent actor {
+  public func prompt(prompt : Text) : async Text {
+    await LLM.prompt(#Llama3_1_8B, prompt);
+  };
+
+  public func chat(messages : [LLM.ChatMessage]) : async Text {
+    await LLM.chat(#Llama3_1_8B, messages);
+  };
+};

motoko/llm_chatbot/devcontainer.json

@@ -0,0 +1,20 @@
+{
+  "name": "ICP Dev Environment",
+  "image": "ghcr.io/dfinity/icp-dev-env-slim:17",
+  "forwardPorts": [4943, 5173],
+  "portsAttributes": {
+    "4943": {
+      "label": "dfx",
+      "onAutoForward": "ignore"
+    },
+    "5173": {
+      "label": "vite",
+      "onAutoForward": "openBrowser"
+    }
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": ["dfinity-foundation.vscode-motoko"]
+    }
+  }
+}

motoko/llm_chatbot/dfx.json

@@ -0,0 +1,35 @@
+{
+  "canisters": {
+    "backend": {
+      "dependencies": ["llm"],
+      "main": "backend/app.mo",
+      "type": "motoko",
+      "args": "--enhanced-orthogonal-persistence"
+    },
+    "frontend": {
+      "dependencies": ["backend"],
+      "frontend": {
+        "entrypoint": "frontend/index.html"
+      },
+      "source": ["frontend/dist"],
+      "type": "assets"
+    },
+    "llm": {
+      "candid": "https://github.com/dfinity/llm/releases/latest/download/llm-canister-ollama.did",
+      "type": "custom",
+      "specified_id": "w36hm-eqaaa-aaaal-qr76a-cai",
+      "remote": {
+        "id": {
+          "ic": "w36hm-eqaaa-aaaal-qr76a-cai"
+        }
+      },
+      "wasm": "https://github.com/dfinity/llm/releases/latest/download/llm-canister-ollama.wasm"
+    }
+  },
+  "output_env_file": ".env",
+  "defaults": {
+    "build": {
+      "packtool": "mops sources"
+    }
+  }
+}

motoko/llm_chatbot/files.json

@@ -0,0 +1,18 @@
+[
+  "README.md",
+  "backend/app.mo",
+  "dfx.json",
+  "frontend/index.css",
+  "frontend/index.html",
+  "frontend/package.json",
+  "frontend/postcss.config.js",
+  "frontend/public/bot.svg",
+  "frontend/public/favicon.ico",
+  "frontend/public/user.svg",
+  "frontend/src/main.jsx",
+  "frontend/tailwind.config.js",
+  "frontend/vite.config.js",
+  "mops.toml",
+  "package-lock.json",
+  "package.json"
+]

motoko/llm_chatbot/frontend/index.css

@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;

motoko/llm_chatbot/frontend/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>LLM Chatbot</title>
+    <link rel="icon" href="/favicon.ico" />
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="src/main.jsx"></script>
+  </body>
+</html>