Classification example #164
+459
−6
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,257 @@ | ||
| { | ||
| "version": "0.2.0", | ||
| "configurations": [ | ||
| { | ||
| "name": "sentiment-wsl", | ||
|
There was a problem hiding this comment. Why do we need wsl-specific tasks here? People should just enter the directory from within WSL if that's what they want. There was a problem hiding this comment. It's makes it easier to debug from the root. You need a separate config for WSL if you are debugging in that environment using VSCODE. There was a problem hiding this comment. Wait, really? Even if you're using the WSL extension? There was a problem hiding this comment. So I tried this out locally - my experience is that So I think that matches what I recommended elsewhere - that all the WSL-oriented tasks should be the defaults, and there shouldn't be any sort of variant. If that's not matching your experience, we can jump on a call and run through it. There was a problem hiding this comment. Yes, let’s sync on Monday. I want to check the configuration on windows. |
||
| "type": "node", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/examples/sentiment/src/main.ts", | ||
| "stopOnEntry": false, | ||
| "args": [], | ||
| "cwd": "${workspaceFolder}/examples/sentiment", | ||
| "skipFiles": [ | ||
| "<node_internals>/**" | ||
| ], | ||
| "preLaunchTask": "build-sentiment", | ||
| "sourceMaps": true, | ||
| "outFiles": [ | ||
| "${workspaceFolder}/examples/sentiment/dist/**/*.js" | ||
| ], | ||
| "console": "integratedTerminal" | ||
| }, | ||
| { | ||
| "name": "sentiment", | ||
| "type": "node", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/examples/sentiment/src/main.ts", | ||
| "stopOnEntry": false, | ||
| "args": [], | ||
| "cwd": "${workspaceFolder}/examples/sentiment", | ||
| "skipFiles": [ | ||
| "<node_internals>/**" | ||
| ], | ||
| "preLaunchTask": "build-sentiment", | ||
| "sourceMaps": true, | ||
| "outFiles": [ | ||
| "${workspaceFolder}/examples/sentiment/dist/**/*.js" | ||
| ], | ||
| "console": "externalTerminal" | ||
| }, | ||
| { | ||
| "name": "calendar-wsl", | ||
| "type": "node", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/examples/calendar/src/main.ts", | ||
| "stopOnEntry": false, | ||
| "args": [], | ||
| "cwd": "${workspaceFolder}/examples/calendar", | ||
| "skipFiles": [ | ||
| "<node_internals>/**" | ||
| ], | ||
| "preLaunchTask": "build-calendar", | ||
| "sourceMaps": true, | ||
| "outFiles": [ | ||
| "${workspaceFolder}/examples/calendar/dist/**/*.js" | ||
| ], | ||
| "console": "integratedTerminal" | ||
| }, | ||
| { | ||
| "name": "calendar", | ||
| "type": "node", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/examples/calendar/src/main.ts", | ||
| "stopOnEntry": false, | ||
| "args": [], | ||
| "cwd": "${workspaceFolder}/examples/calendar", | ||
| "skipFiles": [ | ||
| "<node_internals>/**" | ||
| ], | ||
| "preLaunchTask": "build-calendar", | ||
| "sourceMaps": true, | ||
| "outFiles": [ | ||
| "${workspaceFolder}/examples/calendar/dist/**/*.js" | ||
| ], | ||
| "console": "externalTerminal" | ||
| }, | ||
| { | ||
| "name": "math-wsl", | ||
| "type": "node", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/examples/math/src/main.ts", | ||
| "stopOnEntry": false, | ||
| "args": [], | ||
| "cwd": "${workspaceFolder}/examples/math", | ||
| "skipFiles": [ | ||
| "<node_internals>/**" | ||
| ], | ||
| "preLaunchTask": "build-math", | ||
| "sourceMaps": true, | ||
| "outFiles": [ | ||
| "${workspaceFolder}/examples/math/dist/**/*.js" | ||
| ], | ||
| "console": "integratedTerminal" | ||
| }, | ||
| { | ||
| "name": "math", | ||
| "type": "node", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/examples/math/src/main.ts", | ||
| "stopOnEntry": false, | ||
| "args": [], | ||
| "cwd": "${workspaceFolder}/examples/math", | ||
| "skipFiles": [ | ||
| "<node_internals>/**" | ||
| ], | ||
| "preLaunchTask": "build-math", | ||
| "sourceMaps": true, | ||
| "outFiles": [ | ||
| "${workspaceFolder}/examples/math/dist/**/*.js" | ||
| ], | ||
| "console": "externalTerminal" | ||
| }, | ||
| { | ||
| "name": "music-wsl", | ||
| "type": "node", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/examples/music/src/main.ts", | ||
| "stopOnEntry": false, | ||
| "args": [], | ||
| "cwd": "${workspaceFolder}/examples/music", | ||
| "skipFiles": [ | ||
| "<node_internals>/**" | ||
| ], | ||
| "preLaunchTask": "build-music", | ||
| "sourceMaps": true, | ||
| "outFiles": [ | ||
| "${workspaceFolder}/examples/music/dist/**/*.js" | ||
| ], | ||
| "console": "integratedTerminal" | ||
| }, | ||
| { | ||
| "name": "music", | ||
| "type": "node", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/examples/music/src/main.ts", | ||
| "stopOnEntry": false, | ||
| "args": [], | ||
| "cwd": "${workspaceFolder}/examples/music", | ||
| "skipFiles": [ | ||
| "<node_internals>/**" | ||
| ], | ||
| "preLaunchTask": "build-music", | ||
| "sourceMaps": true, | ||
| "outFiles": [ | ||
| "${workspaceFolder}/examples/music/dist/**/*.js" | ||
| ], | ||
| "console": "externalTerminal" | ||
| }, | ||
| { | ||
| "name": "restaurant-wsl", | ||
| "type": "node", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/examples/restaurant/src/main.ts", | ||
| "stopOnEntry": false, | ||
| "args": [], | ||
| "cwd": "${workspaceFolder}/examples/restaurant", | ||
| "skipFiles": [ | ||
| "<node_internals>/**" | ||
| ], | ||
| "preLaunchTask": "build-restaurant", | ||
| "sourceMaps": true, | ||
| "outFiles": [ | ||
| "${workspaceFolder}/examples/restaurant/dist/**/*.js" | ||
| ], | ||
| "console": "integratedTerminal" | ||
| }, | ||
| { | ||
| "name": "restaurant", | ||
| "type": "node", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/examples/restaurant/src/main.ts", | ||
| "stopOnEntry": false, | ||
| "args": [], | ||
| "cwd": "${workspaceFolder}/examples/restaurant", | ||
| "skipFiles": [ | ||
| "<node_internals>/**" | ||
| ], | ||
| "preLaunchTask": "build-restaurant", | ||
| "sourceMaps": true, | ||
| "outFiles": [ | ||
| "${workspaceFolder}/examples/restaurant/dist/**/*.js" | ||
| ], | ||
| "console": "externalTerminal" | ||
| }, | ||
| { | ||
| "name": "coffeeShop-wsl", | ||
| "type": "node", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/examples/coffeeShop/src/main.ts", | ||
| "stopOnEntry": false, | ||
| "args": [], | ||
| "cwd": "${workspaceFolder}/examples/coffeeShop", | ||
| "skipFiles": [ | ||
| "<node_internals>/**" | ||
| ], | ||
| "preLaunchTask": "build-coffeeShop", | ||
| "sourceMaps": true, | ||
| "outFiles": [ | ||
| "${workspaceFolder}/examples/coffeeShop/dist/**/*.js" | ||
| ], | ||
| "console": "integratedTerminal" | ||
| }, | ||
| { | ||
| "name": "coffeeShop", | ||
| "type": "node", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/examples/coffeeShop/src/main.ts", | ||
| "stopOnEntry": false, | ||
| "args": [], | ||
| "cwd": "${workspaceFolder}/examples/coffeeShop", | ||
| "skipFiles": [ | ||
| "<node_internals>/**" | ||
| ], | ||
| "preLaunchTask": "build-coffeeShop", | ||
| "sourceMaps": true, | ||
| "outFiles": [ | ||
| "${workspaceFolder}/examples/coffeeShop/dist/**/*.js" | ||
| ], | ||
| "console": "externalTerminal" | ||
| }, | ||
| { | ||
| "name": "classification-wsl", | ||
| "type": "node", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/examples/classification/src/main.ts", | ||
| "stopOnEntry": false, | ||
| "args": [], | ||
| "cwd": "${workspaceFolder}/examples/classification", | ||
| "skipFiles": [ | ||
| "<node_internals>/**" | ||
| ], | ||
| "preLaunchTask": "build-classification", | ||
| "sourceMaps": true, | ||
| "outFiles": [ | ||
| "${workspaceFolder}/examples/classification/dist/**/*.js" | ||
| ], | ||
| "console": "integratedTerminal" | ||
| }, | ||
| { | ||
| "name": "classification", | ||
| "type": "node", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/examples/classification/src/main.ts", | ||
| "stopOnEntry": false, | ||
| "args": [], | ||
| "cwd": "${workspaceFolder}/examples/classification", | ||
| "skipFiles": [ | ||
| "<node_internals>/**" | ||
| ], | ||
| "preLaunchTask": "build-classification", | ||
| "sourceMaps": true, | ||
| "outFiles": [ | ||
| "${workspaceFolder}/examples/classification/dist/**/*.js" | ||
| ], | ||
| "console": "externalTerminal" | ||
| } | ||
| ], | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| { | ||
| "version": "2.0.0", | ||
| "tasks": [ | ||
| { | ||
| "label": "build-sentiment", | ||
| "type": "npm", | ||
| "script": "build", | ||
| "path": "examples/sentiment", | ||
| "group": "build", | ||
| "problemMatcher": [], | ||
| "detail": "tsc -p src" | ||
| }, | ||
| { | ||
| "label": "build-calendar", | ||
| "type": "npm", | ||
| "script": "build", | ||
| "path": "examples/calendar", | ||
| "group": "build", | ||
| "problemMatcher": [], | ||
| "detail": "tsc -p src" | ||
| }, | ||
| { | ||
| "label": "build-math", | ||
| "type": "npm", | ||
| "script": "build", | ||
| "path": "examples/math", | ||
| "group": "build", | ||
| "problemMatcher": [], | ||
| "detail": "tsc -p src" | ||
| }, | ||
| { | ||
| "label": "build-music", | ||
| "type": "npm", | ||
| "script": "build", | ||
| "path": "examples/music", | ||
| "group": "build", | ||
| "problemMatcher": [], | ||
| "detail": "tsc -p src" | ||
| }, | ||
| { | ||
| "label": "build-restaurant", | ||
| "type": "npm", | ||
| "script": "build", | ||
| "path": "examples/restaurant", | ||
| "group": "build", | ||
| "problemMatcher": [], | ||
| "detail": "tsc -p src" | ||
| }, | ||
| { | ||
| "label": "build-coffeeShop", | ||
| "type": "npm", | ||
| "script": "build", | ||
| "path": "examples/coffeeShop", | ||
| "group": "build", | ||
| "problemMatcher": [], | ||
| "detail": "tsc -p src" | ||
| }, | ||
| { | ||
| "label": "build-classification", | ||
| "type": "npm", | ||
| "script": "build", | ||
| "path": "examples/classification", | ||
| "group": "build", | ||
| "problemMatcher": [], | ||
| "detail": "tsc -p src" | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| // Use IntelliSense to learn about possible attributes. | ||
| // Hover to view descriptions of existing attributes. | ||
| // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 | ||
| "version": "0.2.0", | ||
| "configurations": [ | ||
| { | ||
| "type": "node", | ||
| "request": "launch", | ||
| "name": "Launch Program", | ||
| "skipFiles": [ | ||
| "<node_internals>/**" | ||
| ], | ||
| "program": "${workspaceFolder}/dist/main.js", | ||
| "console": "externalTerminal" | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| { | ||
| "name": "classification", | ||
| "version": "0.0.1", | ||
| "private": true, | ||
| "description": "", | ||
| "main": "dist/main.js", | ||
| "scripts": { | ||
| "build": "tsc -p src", | ||
| "postbuild": "copyfiles -u 1 src/**/*Schema.ts src/**/*.txt dist" | ||
| }, | ||
| "author": "", | ||
| "license": "MIT", | ||
| "dependencies": { | ||
| "dotenv": "^16.3.1", | ||
| "typechat": "^0.0.10" | ||
| }, | ||
| "devDependencies": { | ||
| "@types/node": "^20.3.1", | ||
| "copyfiles": "^2.4.1", | ||
| "typescript": "^5.1.3" | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| export type Classification = { | ||
| name: string; | ||
| description: string; | ||
| }; | ||
|
|
||
| export interface ClassificationResponse { | ||
| class: Classification; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| I want to buy a Sherlock Holmes novel | ||
| I want to order a tall latte with extra foam | ||
| I want to buy Richard Feynman's book on physics | ||
| I want to buy Nurtec 75mg |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| import fs from "fs"; | ||
| import path from "path"; | ||
| import dotenv from "dotenv"; | ||
| import { createLanguageModel, createJsonTranslator, processRequests } from "typechat"; | ||
| import { Classification, ClassificationResponse } from "./classificationSchema"; | ||
|
|
||
| const classes: Classification[] = [ | ||
| { | ||
| "name": "CoffeeShop", | ||
| "description": "Order Coffee Drinks (Italian names included) and Baked Goods" | ||
| }, | ||
| { | ||
| "name": "Mystery Bookshop", | ||
| "description": "A bookstore that specializes in mystery books" | ||
| }, | ||
| { | ||
| "name": "Bookstore", | ||
| "description": "A bookstore that sells all kinds of books" | ||
| }, | ||
| { | ||
| "name": "Drugstore", | ||
| "description": "A drugstore that sells health and beauty products" | ||
| } | ||
| ]; | ||
|
|
||
| // TODO: use local .env file. | ||
| dotenv.config({ path: path.join(__dirname, "../../../.env") }); | ||
|
|
||
| const model = createLanguageModel(process.env); | ||
| const schema = fs.readFileSync(path.join(__dirname, "classificationSchema.ts"), "utf8"); | ||
| const translator = createJsonTranslator<ClassificationResponse>(model, schema, "ClassificationResponse"); | ||
|
|
||
| // Process requests interactively or from the input file specified on the command line | ||
| processRequests("🤗> ", process.argv[2], async (request) => { | ||
| const initClasses: string = JSON.stringify(classes, undefined); | ||
| const fullRequest: string = `Classify "${request}" using the following classification table:\n${initClasses}\n`; | ||
|
There was a problem hiding this comment. A few things about the classification example feels off. First, this seems far too similar to the sentiment example. The biggest difference is the custom prompt - but it very well may be the case that a custom prompt needs a custom translator. Then there is the fact that we're effectively doing a look-up - but if you have that information, then why do you need things like a description anyhow? If you have a fixed set of items, you could describe that directly in the schema, right? Or you would just use embeddings to fetch the most similar one? There was a problem hiding this comment. The way I look at it is the sentiment example is a special case of the classifier example. Another way of doing this would be to use a custom translator but we do not need it as the translate method has a Yes, I could also describe it in the schema as well but that idea is to keep the data (classes) separate from the schema. What do you think? |
||
| const response = await translator.translate(request, [{role: "assistant", content:`${fullRequest}`}]); | ||
| if (!response.success) { | ||
| console.log(response.message); | ||
| return; | ||
| } | ||
| console.log(`The classification is ${response.data.class.name}`); | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| { | ||
| "compilerOptions": { | ||
| "target": "es2021", | ||
| "lib": ["es2021"], | ||
| "module": "node16", | ||
| "types": ["node"], | ||
| "outDir": "../dist", | ||
| "esModuleInterop": true, | ||
| "forceConsistentCasingInFileNames": true, | ||
| "strict": true, | ||
| "noUnusedLocals": true, | ||
| "noUnusedParameters": true, | ||
| "exactOptionalPropertyTypes": true, | ||
| "inlineSourceMap": true | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't want these removed - if you need an exception for the root
.vscode/launch.json, I'd add that.