Update chat example to use newer template (#10)

* Update chat example to use newer template

* Replace JS code with TS code in example README

tutorials/chat-with-an-llm/README.md

@@ -20,7 +20,7 @@ npm start                        # Run the example
 
 cd python                        # Navigate to the python example
 poetry install                   # Install dependencies and build the example
-poetry run python src/example.py # Run the example
+poetry run main                  # Run the example
 ```
 
 </details>
@@ -39,23 +39,24 @@ we will be including the chat history that includes both the user input and LLM
 
 In NodeJS we can use the following program:
 
-```js
+```typescript
 import readline from "node:readline";
 
 import { Substrate, ComputeText } from "substrate";
 
 const substrate = new Substrate({ apiKey: process.env["SUBSTRATE_API_KEY"] });
 
-const message = (role, content) => ({ role, content });
+type Message = { role: "user" | "assistant", content: string };
+const message = (role: Message["role"], content: Message["content"]): Message => ({ role, content });
 
-const blue = (text) => `\x1b[34m${text}\x1b[0m`;
+const blue = (text: string) => `\x1b[34m${text}\x1b[0m`;
 
 const rl = readline.createInterface({
   input: process.stdin,
   output: process.stdout,
 });
 
-const prompt = (log) => `
+const prompt = (log: Message[]) => `
 You are a friendly assistant. Have fun engaging in the conversation.
 
 === Rules
@@ -66,7 +67,7 @@ You are a friendly assistant. Have fun engaging in the conversation.
 === Chat Log
 ${log.map((m) => `[${m.role}]: ${m.content}`).join("\n\n")}`;
 
-const continueThread = (log) => {
+const continueThread = (log: Message[]) => {
   rl.question(`> `, async (userPrompt) => {
     log.push(message("user", userPrompt));
 
@@ -161,3 +162,4 @@ We could extend these simple examples in many different ways to suit a new speci
 updating the prompts to guide the LLM responses toward a particular tone or personality. If there is 
 data we'd like the LLM to reference we could incorportate some context from a relevant data source. Enjoy
 exploring what's possible with Substrate.
+

tutorials/chat-with-an-llm/diagram.d2

@@ -0,0 +1,43 @@
+direction: right
+classes: {
+  substrate: {
+    label: "substrate"
+    style: {
+      font: mono
+      font-color: gray
+      font-size: 20
+      stroke: gray
+      stroke-dash: 1
+      fill: "transparent"
+      border-radius: 16
+    }
+  }
+  node: {
+    style: {
+      font: mono
+      font-size: 24
+      stroke-width: 2
+      fill: transparent
+      stroke: gray
+      border-radius: 16
+      stroke-dash: 1
+      3d: true
+    }
+  }
+  edge: {
+    style: {
+      stroke: "#000"
+      stroke-dash: 2
+    }
+  }
+}
+
+substrate.class: substrate
+substrate.a.class: node
+substrate.b.class: node
+substrate.c.class: node
+substrate.a.label: heuristic
+substrate.b.label: symbolic
+substrate.c.label: computation
+substrate.a->substrate.c { class: edge }
+substrate.b->substrate.c { class: edge }

tutorials/chat-with-an-llm/python/.gitignore

@@ -0,0 +1,10 @@
+# python generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# venv
+.venv

tutorials/chat-with-an-llm/python/README.md

@@ -0,0 +1,26 @@
+# Substrate Example Templates in Python
+
+This is a Substrate example template written in Python. To run this example,
+
+```bash
+# Set your API key as an environment variable.
+# Get one here https://www.substrate.run/dashboard/keys if this is your first time.
+export SUBSTRATE_API_KEY=<your Substrate API key>
+
+# Navigate to the python example directory.
+cd python
+```
+
+To run the example with Poetry (default), run the following.
+
+```bash
+poetry install
+poetry run main
+```
+
+To run the example with Rye, comment out the Poetry sections and uncomment the Rye sections in `pyproject.toml` and run the following.
+
+```bash
+rye sync
+rye run main
+```

tutorials/chat-with-an-llm/python/poetry.toml

@@ -1,3 +1,2 @@
 [virtualenvs]
 in-project = true
-

tutorials/chat-with-an-llm/python/pyproject.toml

@@ -1,6 +1,10 @@
 [project]
-name = "chat-with-an-llm"
+name = "template"
+version = "0.1.0"
+description = ""
+authors = [{ name = "Hanwen Wu", email = "[email protected]" }]
 readme = "README.md"
+
 requires-python = ">= 3.9"
 dependencies = ["substrate"]
 
@@ -28,7 +32,7 @@ build-backend = "poetry.core.masonry.api"
 name = "template"
 version = "0.1.0"
 description = ""
-authors = []
+authors = ["Hanwen Wu <[email protected]>"]
 readme = "README.md"
 
 packages = [{ include = "python", from = "src" }]
@@ -42,7 +46,7 @@ ruff = "^0.6.1"
 marimo = "^0.8.0"
 
 [tool.poetry.scripts]
-main = "example:main"
+main = "python.example:main"
 
 
 ###########################

tutorials/chat-with-an-llm/python/src/example.py → tutorials/chat-with-an-llm/python/src/python/example.py

@@ -56,3 +56,4 @@ def main():
 
 if __name__ == "__main__":
     main()
+

tutorials/chat-with-an-llm/typescript/README.md

@@ -0,0 +1,28 @@
+# Substrate Example Templates in Typescript
+
+This is a Substrate example template written in Typescript. To run this example,
+
+```bash
+# Set your API key as an environment variable.
+# Get one here https://www.substrate.run/dashboard/keys if this is your first time.
+export SUBSTRATE_API_KEY=<your Substrate API key>
+
+# Navigate to the python example directory.
+cd typescript
+```
+
+To run the example with tsx (default), run the following.
+
+```bash
+npx tsx ./example.ts
+
+# Or you can use the package.json scripts
+npm run start
+```
+
+To run the example with Deno, uncomment the Deno sections in `example.ts` and
+run the following.
+
+```bash
+deno run ./example.ts
+```

tutorials/chat-with-an-llm/typescript/main.js → tutorials/chat-with-an-llm/typescript/example.ts

@@ -4,16 +4,17 @@ import { Substrate, ComputeText } from "substrate";
 
 const substrate = new Substrate({ apiKey: process.env["SUBSTRATE_API_KEY"] });
 
-const message = (role, content) => ({ role, content });
+type Message = { role: "user" | "assistant", content: string };
+const message = (role: Message["role"], content: Message["content"]): Message => ({ role, content });
 
-const blue = (text) => `\x1b[34m${text}\x1b[0m`;
+const blue = (text: string) => `\x1b[34m${text}\x1b[0m`;
 
 const rl = readline.createInterface({
   input: process.stdin,
   output: process.stdout,
 });
 
-const prompt = (log) => `
+const prompt = (log: Message[]) => `
 You are a friendly assistant. Have fun engaging in the conversation.
 
 === Rules
@@ -24,7 +25,7 @@ You are a friendly assistant. Have fun engaging in the conversation.
 === Chat Log
 ${log.map((m) => `[${m.role}]: ${m.content}`).join("\n\n")}`;
 
-const continueThread = (log) => {
+const continueThread = (log: Message[]) => {
   rl.question(`> `, async (userPrompt) => {
     log.push(message("user", userPrompt));
 
@@ -46,3 +47,4 @@ const continueThread = (log) => {
 };
 console.log("=== Welcome to the chat! (use ^C to quit)");
 continueThread([]);
+

tutorials/chat-with-an-llm/typescript/package.json

@@ -1,11 +1,18 @@
 {
-  "name": "chat-with-an-llm",
+  "name": "substrate-example",
+  "version": "1.0.0",
+  "private": "true",
+  "main": "example.ts",
   "type": "module",
   "scripts": {
-    "start": "node main.js"
+    "start": "npx tsx example.ts",
+    "typecheck": "tsc --noEmit"
   },
-  "license": "MIT",
   "dependencies": {
-    "substrate": "^120240617.1.9"
+    "substrate": "^120240617"
+  },
+  "devDependencies": {
+    "@types/node": "^22",
+    "typescript": "^5"
   }
 }

tutorials/chat-with-an-llm/typescript/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "moduleDetection": "force",
+    "module": "Preserve",
+    "resolveJsonModule": true,
+    "allowJs": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "isolatedModules": true,
+    "strict": true,
+    "noEmit": true,
+    "moduleResolution": "node",
+    "jsx": "preserve",
+    "incremental": true,
+    "plugins": [{ "name": "next" }],
+    "paths": { "@/*": ["./*"] }
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}