Rename AI files

.changeset/nasty-bikes-travel.md

@@ -0,0 +1,5 @@
+---
+"@khanacademy/perseus": patch
+---
+
+Rename AI util files

packages/perseus/src/index.ts

@@ -255,4 +255,7 @@ export type {
     TagsShape,
 } from "./multi-items/shape-types";
 export type {Path} from "./multi-items/trees";
-export type {RendererPromptJSON, WidgetPromptJSON} from "./prompt-types";
+export type {
+    RendererPromptJSON,
+    WidgetPromptJSON,
+} from "./widget-ai-utils/prompt-types";

packages/perseus/src/renderer.tsx

@@ -40,7 +40,6 @@ import type {
     PerseusWidgetsMap,
     ShowSolutions,
 } from "./perseus-types";
-import type {GetPromptJSONInterface, RendererPromptJSON} from "./prompt-types";
 import type {PerseusStrings} from "./strings";
 import type {
     APIOptions,
@@ -53,6 +52,10 @@ import type {
     WidgetProps,
 } from "./types";
 import type {UserInputArray, UserInputMap} from "./validation.types";
+import type {
+    GetPromptJSONInterface,
+    RendererPromptJSON,
+} from "./widget-ai-utils/prompt-types";
 import type {KeypadAPI} from "@khanacademy/math-input";
 import type {LinterContextProps} from "@khanacademy/perseus-linter";
 

packages/perseus/src/server-item-renderer.tsx

@@ -22,12 +22,15 @@ import Renderer from "./renderer";
 import Util from "./util";
 
 import type {PerseusItem, ShowSolutions} from "./perseus-types";
-import type {GetPromptJSONInterface, RendererPromptJSON} from "./prompt-types";
 import type {
     FocusPath,
     PerseusDependenciesV2,
     SharedRendererProps,
 } from "./types";
+import type {
+    GetPromptJSONInterface,
+    RendererPromptJSON,
+} from "./widget-ai-utils/prompt-types";
 import type {KeypadAPI} from "@khanacademy/math-input";
 import type {
     KeypadContextRendererInterface,

packages/perseus/src/types.ts

@@ -7,7 +7,6 @@ import type {
     PerseusWidget,
     PerseusWidgetsMap,
 } from "./perseus-types";
-import type {WidgetPromptJSON} from "./prompt-types";
 import type {PerseusStrings} from "./strings";
 import type {SizeClass} from "./util/sizing-utils";
 import type {
@@ -16,6 +15,7 @@ import type {
     UserInputArray,
     UserInputMap,
 } from "./validation.types";
+import type {WidgetPromptJSON} from "./widget-ai-utils/prompt-types";
 import type {KeypadAPI} from "@khanacademy/math-input";
 import type {AnalyticsEventHandlerFn} from "@khanacademy/perseus-core";
 import type {LinterContextProps} from "@khanacademy/perseus-linter";

packages/perseus/src/widget-ai-utils/README.md

@@ -1,15 +1,25 @@
-# What are these utilities for?
+# Widget AI utils
 
-We want to have a representation of Perseus widgets that LLMs can understand.
-They understand JSON pretty well! This is a set of utility functions for each
-widget that get the minimum amount of data for an LLM to understand the state
-of the widget, as well as the current user input.
+> [!CAUTION]
+> This code is not meant to be interwoven with Perseus' core logic.
+> We want to keep it as isolated as possible from the rest of Perseus.
+
+> [!CAUTION]
+> Please be cautious making changes within this folder,
+> it's an external API consumed by the team working on Khanmigo.
+
+## Motivation
+
+1. The team working on Khanmigo needed access to Perseus data for prompt engineering - including both external-facing things (like the ItemData and UserInput) and internal things (like RenderProps)
+2. The Perseus team didn't want to write a blank check exposing all of our internal data because that would make it difficult for us to safely make internal changes
+3. The goal of the helpers in this folder is to have a set of functions that can take _all_ the information the Khanmigo team could possibly want and return only the pieces the Khanmigo team needs
+
+## What are these utilities for?
+
+We want to have a representation of Perseus widgets that LLMs can understand. They understand JSON pretty well! This is a set of utility functions for each widget that get the minimum amount of data for an LLM to understand the state of the widget, as well as the current user input.
 
 
 ### Why don't we just pass the raw widget json?
 
-We do not want to have the an external API relying on the internal
-representation of Perseus widgets. That would couple the widgets implementation
-to an external API, which would be subject to breakage. This approach balances
-having an explicit API, while keeping Perseus widgets mostly unaware of the
-LLM prompt requirements.
+We do not want to have the external API relying on the internal
+representation of Perseus widgets. That would couple the widgets implementation to an external API, which would be subject to breakage. This approach balances having an explicit API, while keeping Perseus widgets mostly unaware of the LLM prompt requirements.

packages/perseus/src/widget-ai-utils/categorizer/categorizer.test.ts → packages/perseus/src/widget-ai-utils/categorizer/categorizer-ai-utils.test.ts

@@ -5,10 +5,13 @@ import {testDependencies} from "../../../../../testing/test-dependencies";
 import * as Dependencies from "../../dependencies";
 import {renderQuestion} from "../../widgets/__testutils__/renderQuestion";
 
+import {getPromptJSON} from "./categorizer-ai-utils";
+
 import type {PerseusRenderer} from "../../perseus-types";
+import type {PerseusCategorizerUserInput} from "../../validation.types";
 import type {UserEvent} from "@testing-library/user-event";
 
-export const randomizedQuestion: PerseusRenderer = {
+const randomizedQuestion: PerseusRenderer = {
     content:
         "**Classify each graph according to the kind of relationship it suggests.**\n\n$\\qquad\\qquad\\quad\\text{Graph 1}\\qquad\\qquad\\quad\\qquad\\qquad\\quad\\text{Graph 2}$\n\n\n\n[[\u2603 categorizer 1]]\n\n**Graph 1.**\n\n![](https://ka-perseus-graphie.s3.amazonaws.com/049c091ed0978112aba3a36b0591d992baf7b1ac.png)\n\n**Graph 2.**\n\n![](https://ka-perseus-graphie.s3.amazonaws.com/40df186f39fb6d65de6bee0d8b681502d10cb37a.png)  \n",
     images: {},
@@ -35,7 +38,7 @@ export const randomizedQuestion: PerseusRenderer = {
     },
 };
 
-describe("categorizer widget", () => {
+describe("Categorizer AI utils", () => {
     let userEvent: UserEvent;
     beforeEach(() => {
         userEvent = userEventLib.setup({
@@ -47,6 +50,31 @@ describe("categorizer widget", () => {
         );
     });
 
+    it("it returns JSON with the expected format and fields", () => {
+        const renderProps: any = {
+            items: ["Luke Skywalker", "Darth Vader", "Yoda", "Han Solo"],
+            categories: ["Galactic Empire", "Rebel Alliance"],
+            values: [1, 0, 1, 1],
+        };
+
+        const userInput: PerseusCategorizerUserInput = {
+            values: [1, 0, 0, 1],
+        };
+
+        const resultJSON = getPromptJSON(renderProps, userInput);
+
+        expect(resultJSON).toEqual({
+            type: "categorizer",
+            options: {
+                items: ["Luke Skywalker", "Darth Vader", "Yoda", "Han Solo"],
+                categories: ["Galactic Empire", "Rebel Alliance"],
+            },
+            userInput: {
+                itemToCategoryMapping: [1, 0, 0, 1],
+            },
+        });
+    });
+
     it("should get prompt json which matches the state of the UI for a randomized question", async () => {
         // arrange
         const {renderer} = renderQuestion(randomizedQuestion);

packages/perseus/src/widget-ai-utils/cs-program/cs-program.test.ts → packages/perseus/src/widget-ai-utils/cs-program/cs-program-ai-utils.test.ts

@@ -1,8 +1,10 @@
 import {renderQuestion} from "../../widgets/__testutils__/renderQuestion";
 
+import {getPromptJSON} from "./cs-program-ai-utils";
+
 import type {PerseusRenderer} from "../../perseus-types";
 
-export const question1: PerseusRenderer = {
+const question1: PerseusRenderer = {
     content: "[[\u2603 cs-program 1]]\n\n",
     images: {},
     widgets: {
@@ -28,7 +30,17 @@ export const question1: PerseusRenderer = {
     },
 };
 
-describe("cs-program widget", () => {
+describe("CS Program AI utils", () => {
+    it("it returns JSON with the expected format and fields", () => {
+        const resultJSON = getPromptJSON();
+
+        expect(resultJSON).toEqual({
+            type: "cs-program",
+            isSupported: false,
+            message: "",
+        });
+    });
+
     it("should get prompt json which matches the state of the UI", async () => {
         // Arrange
         const {renderer} = renderQuestion(question1, {isMobile: false});

packages/perseus/src/widget-ai-utils/definition/definition.test.ts → packages/perseus/src/widget-ai-utils/definition/definition-ai-utils.test.ts

@@ -1,5 +1,7 @@
 import {renderQuestion} from "../../widgets/__testutils__/renderQuestion";
 
+import {getPromptJSON} from "./definition-ai-utils";
+
 const question = {
     content:
         "Read the excerpt and answer the question below. \n\nThe Governor and Council of the Massachusetts had much conference many days; and at last . . . . concluded a peace and friendship with [[\u2603 definition 1]], upon these conditions.",
@@ -23,7 +25,22 @@ const question = {
     },
 } as const;
 
-describe("definition widget", () => {
+describe("Definition AI utils", () => {
+    it("it returns JSON with the expected format and fields", () => {
+        const renderProps: any = {
+            definition: "to confuse or fluster",
+            togglePrompt: "bumfuzzle",
+        };
+
+        const resultJSON = getPromptJSON(renderProps);
+
+        expect(resultJSON).toEqual({
+            type: "definition",
+            definition: "to confuse or fluster",
+            togglePrompt: "bumfuzzle",
+        });
+    });
+
     it("should get prompt json which matches the state of the UI", async () => {
         // Arrange
         const {renderer} = renderQuestion(question);