@fluidframework/ai-collab 2.10.0-306579

package/lib/explicit-strategy/agentEditTypes.js

@@ -0,0 +1,47 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * TODO: The current scheme does not allow manipulation of arrays of primitive values because you cannot refer to them.
+ * We could accomplish this via a path (probably JSON Pointer or JSONPath) from a possibly-null objectId, or wrap arrays in an identified object.
+ *
+ * TODO: only 100 object fields total are allowed by OpenAI right now, so larger schemas will fail faster if we have a bunch of schema types generated for type-specific edits.
+ *
+ * TODO: experiment using https://github.com/outlines-dev/outlines (and maybe a llama model) to avoid many of the annoyances of OpenAI's JSON Schema subset.
+ *
+ * TODO: without field count limits, we could generate a schema for valid paths from the root object to any field, but it's not clear how useful that would be.
+ *
+ * TODO: We don't supported nested arrays yet.
+ *
+ * TODO: Add a prompt suggestion API!
+ *
+ * TODO: Could encourage the model to output more technical explanations of the edits (e.g. "insert a new Foo after "Foo2").
+ *
+ * TODO: Get explanation strings from o1.
+ *
+ * TODO: Tests of range edits.
+ *
+ * TODO: Handle 429 rate limit error from OpenAI.
+ *
+ * TODO: Add an app-specific guidance string.
+ *
+ * TODO: Give the model a final chance to evaluate the result.
+ *
+ * TODO: Separate system prompt into [system, user, system] for security.
+ *
+ * TODO: Top level arrays are not supported with current DSL.
+ *
+ * TODO: Structured Output fails when multiple schema types have the same first field name (e.g. id: sf.identifier on multiple types).
+ *
+ * TODO: Pass descriptions from schema metadata to the generated TS types that we put in the prompt
+ */
+/**
+ * This is the field we force the LLM to generate to avoid any type ambiguity (e.g. a vector and a point both have x/y and are ambiguous without the LLM telling us which it means).
+ */
+export const typeField = "__fluid_type";
+/**
+ * A field that is  auto-generated and injected into nodes before passing data to the LLM to ensure the LLM can refer to nodes in a stable way.
+ */
+export const objectIdKey = "__fluid_objectId";
+//# sourceMappingURL=agentEditTypes.js.map

package/lib/explicit-strategy/agentEditTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agentEditTypes.js","sourceRoot":"","sources":["../../src/explicit-strategy/agentEditTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,cAAc,CAAC;AAExC;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,kBAAkB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { JsonPrimitive } from \"./jsonTypes.js\";\n\n/**\n * TODO: The current scheme does not allow manipulation of arrays of primitive values because you cannot refer to them.\n * We could accomplish this via a path (probably JSON Pointer or JSONPath) from a possibly-null objectId, or wrap arrays in an identified object.\n *\n * TODO: only 100 object fields total are allowed by OpenAI right now, so larger schemas will fail faster if we have a bunch of schema types generated for type-specific edits.\n *\n * TODO: experiment using https://github.com/outlines-dev/outlines (and maybe a llama model) to avoid many of the annoyances of OpenAI's JSON Schema subset.\n *\n * TODO: without field count limits, we could generate a schema for valid paths from the root object to any field, but it's not clear how useful that would be.\n *\n * TODO: We don't supported nested arrays yet.\n *\n * TODO: Add a prompt suggestion API!\n *\n * TODO: Could encourage the model to output more technical explanations of the edits (e.g. \"insert a new Foo after \"Foo2\").\n *\n * TODO: Get explanation strings from o1.\n *\n * TODO: Tests of range edits.\n *\n * TODO: Handle 429 rate limit error from OpenAI.\n *\n * TODO: Add an app-specific guidance string.\n *\n * TODO: Give the model a final chance to evaluate the result.\n *\n * TODO: Separate system prompt into [system, user, system] for security.\n *\n * TODO: Top level arrays are not supported with current DSL.\n *\n * TODO: Structured Output fails when multiple schema types have the same first field name (e.g. id: sf.identifier on multiple types).\n *\n * TODO: Pass descriptions from schema metadata to the generated TS types that we put in the prompt\n */\n\n/**\n * This is the field we force the LLM to generate to avoid any type ambiguity (e.g. a vector and a point both have x/y and are ambiguous without the LLM telling us which it means).\n */\nexport const typeField = \"__fluid_type\";\n\n/**\n * A field that is  auto-generated and injected into nodes before passing data to the LLM to ensure the LLM can refer to nodes in a stable way.\n */\nexport const objectIdKey = \"__fluid_objectId\";\n\n/**\n * Describes an edit to a field within a node.\n * @remarks TODO: what is the [key: string] for?\n */\nexport interface TreeEditObject {\n\t[key: string]: TreeEditValue;\n\t[typeField]: string;\n}\n/**\n * An array of {@link TreeEditValue}'s, allowing a single {@link TreeEdit} to contain edits to multiple fields.\n */\nexport type TreeEditArray = TreeEditValue[];\n\n/**\n * The potential values for a given {@link TreeEdit}.\n * @remarks These values are typically a field within a node or an entire node,\n */\nexport type TreeEditValue = JsonPrimitive | TreeEditObject | TreeEditArray;\n\n/**\n * This is the the final object we expected from an LLM response.\n * @remarks Because TreeEdit can be multiple different types (polymorphic),\n * we need to wrap to avoid anyOf at the root level when generating the necessary JSON Schema.\n */\nexport interface EditWrapper {\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tedit: TreeEdit | null;\n}\n\n/**\n * Union type representing all possible types of edits that can be made to a tree.\n */\nexport type TreeEdit = Insert | Modify | Remove | Move;\n\n/**\n * The base interface for all types of {@link TreeEdit}.\n */\nexport interface Edit {\n\texplanation: string;\n\ttype: \"insert\" | \"modify\" | \"remove\" | \"move\";\n}\n\n/**\n * This object provides a way to 'select' either a given node or a range of nodes in an array.\n */\nexport type Selection = ObjectTarget | Range;\n\n/**\n * A Target object for an {@link TreeEdit}, identified by the target object's Id\n */\nexport interface ObjectTarget {\n\ttarget: string;\n}\n\n/**\n * Desribes where an object can be inserted into an array.\n * For example, if you have an array with 5 objects, and you insert an object at index 3, this differentiates whether you want\n * the existing item at index 3 to be shifted forward (if the 'location' is 'start') or shifted backwards (if the 'location' is 'end')\n *\n * @remarks TODO: Allow support for nested arrays\n */\nexport interface ArrayPlace {\n\ttype: \"arrayPlace\";\n\tparentId: string;\n\tfield: string;\n\tlocation: \"start\" | \"end\";\n}\n\n/**\n * Desribes where an object can be inserted into an array.\n * For example, if you have an array with 5 objects, and you insert an object at index 3, this differentiates whether you want\n * the existing item at index 3 to be shifted forward (if the 'location' is 'start') or shifted backwards (if the 'location' is 'end')\n *\n * @remarks Why does this and {@link ArrayPlace} exist together?\n */\nexport interface ObjectPlace extends ObjectTarget {\n\ttype: \"objectPlace\";\n\t// No \"start\" or \"end\" because we don't have a way to refer to arrays directly.\n\tplace: \"before\" | \"after\";\n}\n\n/**\n * A range of objects within an array. This allows the LLM to select multiple nodes at once,\n * for example during an {@link Remove} operation to remove a range of nodes.\n */\nexport interface Range {\n\tfrom: ObjectPlace;\n\tto: ObjectPlace;\n}\n\n/**\n * Describes an operation to insert a new node into the tree.\n */\nexport interface Insert extends Edit {\n\ttype: \"insert\";\n\tcontent: TreeEditObject | JsonPrimitive;\n\tdestination: ObjectPlace | ArrayPlace;\n}\n\n/**\n * Describes an operation to modify an existing node in the tree.\n */\nexport interface Modify extends Edit {\n\ttype: \"modify\";\n\ttarget: ObjectTarget;\n\tfield: string;\n\tmodification: TreeEditValue;\n}\n\n/**\n * Describes an operation to remove either a specific node or a range of nodes in an array.\n */\nexport interface Remove extends Edit {\n\ttype: \"remove\";\n\tsource: Selection;\n}\n\n/**\n * Describes an operation to move a node within an array\n */\nexport interface Move extends Edit {\n\ttype: \"move\";\n\tsource: Selection;\n\tdestination: ObjectPlace | ArrayPlace;\n}\n"]}

package/lib/explicit-strategy/idGenerator.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { TreeNode, ImplicitFieldSchema, TreeFieldFromImplicitField } from "@fluidframework/tree/internal";
+/**
+ * Given a tree, generates a set of LLM-friendly, unique IDs for each node in the tree.
+ * @remarks The ability to uniquely and stably in the tree is important for the LLM and this library to create and distinguish between different types certain {@link TreeEdit}s.
+ */
+export declare class IdGenerator {
+    private readonly idCountMap;
+    private readonly prefixMap;
+    private readonly nodeToIdMap;
+    private readonly idToNodeMap;
+    constructor();
+    getOrCreateId(node: TreeNode): string;
+    getNode(id: string): TreeNode | undefined;
+    getId(node: TreeNode): string | undefined;
+    assignIds(node: TreeFieldFromImplicitField<ImplicitFieldSchema>): string | undefined;
+    private generateID;
+}
+//# sourceMappingURL=idGenerator.d.ts.map

package/lib/explicit-strategy/idGenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"idGenerator.d.ts","sourceRoot":"","sources":["../../src/explicit-strategy/idGenerator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EACX,QAAQ,EACR,mBAAmB,EAEnB,0BAA0B,EAC1B,MAAM,+BAA+B,CAAC;AAEvC;;;GAGG;AACH,qBAAa,WAAW;IACvB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA6B;IACxD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA6B;IACvD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA+B;IAC3D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA+B;;IAIpD,aAAa,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM;IAcrC,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS;IAIzC,KAAK,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS;IAIzC,SAAS,CAAC,IAAI,EAAE,0BAA0B,CAAC,mBAAmB,CAAC,GAAG,MAAM,GAAG,SAAS;IAsB3F,OAAO,CAAC,UAAU;CAmBlB"}

package/lib/explicit-strategy/idGenerator.js

@@ -0,0 +1,70 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { assert, oob } from "@fluidframework/core-utils/internal";
+import { Tree, NodeKind } from "@fluidframework/tree/internal";
+/**
+ * Given a tree, generates a set of LLM-friendly, unique IDs for each node in the tree.
+ * @remarks The ability to uniquely and stably in the tree is important for the LLM and this library to create and distinguish between different types certain {@link TreeEdit}s.
+ */
+export class IdGenerator {
+    constructor() {
+        this.idCountMap = new Map();
+        this.prefixMap = new Map();
+        this.nodeToIdMap = new Map();
+        this.idToNodeMap = new Map();
+    }
+    getOrCreateId(node) {
+        const existingID = this.nodeToIdMap.get(node);
+        if (existingID !== undefined) {
+            return existingID;
+        }
+        const schema = Tree.schema(node).identifier;
+        const id = this.generateID(schema);
+        this.nodeToIdMap.set(node, id);
+        this.idToNodeMap.set(id, node);
+        return id;
+    }
+    getNode(id) {
+        return this.idToNodeMap.get(id);
+    }
+    getId(node) {
+        return this.nodeToIdMap.get(node);
+    }
+    assignIds(node) {
+        if (typeof node === "object" && node !== null) {
+            const schema = Tree.schema(node);
+            if (schema.kind === NodeKind.Array) {
+                for (const element of node) {
+                    this.assignIds(element);
+                }
+            }
+            else {
+                // TODO: SharedTree Team needs to either publish TreeNode as a class to use .instanceof() or a typeguard.
+                // Uncomment this assertion back once we have a typeguard ready.
+                // assert(isTreeNode(node), "Non-TreeNode value in tree.");
+                const objId = this.getOrCreateId(node);
+                for (const key of Object.keys(node)) {
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-argument
+                    this.assignIds(node[key]);
+                }
+                return objId;
+            }
+        }
+        return undefined;
+    }
+    generateID(schema) {
+        const segments = schema.split(".");
+        // If there's no period, the schema itself is the last segment
+        const lastSegment = segments[segments.length - 1] ?? oob();
+        const prefix = segments.length > 1 ? segments.slice(0, -1).join(".") : "";
+        // Check if the last segment already exists with a different prefix
+        assert(!this.prefixMap.has(lastSegment) || this.prefixMap.get(lastSegment) === prefix, "Different scopes not supported yet.");
+        this.prefixMap.set(lastSegment, prefix);
+        const count = this.idCountMap.get(lastSegment) ?? 1;
+        this.idCountMap.set(lastSegment, count + 1);
+        return `${lastSegment}${count}`;
+    }
+}
+//# sourceMappingURL=idGenerator.js.map

package/lib/explicit-strategy/idGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"idGenerator.js","sourceRoot":"","sources":["../../src/explicit-strategy/idGenerator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAQ/D;;;GAGG;AACH,MAAM,OAAO,WAAW;IAMvB;QALiB,eAAU,GAAG,IAAI,GAAG,EAAkB,CAAC;QACvC,cAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;QACtC,gBAAW,GAAG,IAAI,GAAG,EAAoB,CAAC;QAC1C,gBAAW,GAAG,IAAI,GAAG,EAAoB,CAAC;IAErC,CAAC;IAEhB,aAAa,CAAC,IAAc;QAClC,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,UAAU,CAAC;QACnB,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC;QAC5C,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACnC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC/B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAE/B,OAAO,EAAE,CAAC;IACX,CAAC;IAEM,OAAO,CAAC,EAAU;QACxB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,IAAc;QAC1B,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAEM,SAAS,CAAC,IAAqD;QACrE,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAA2B,CAAC,CAAC;YACxD,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,EAAE,CAAC;gBACpC,KAAK,MAAM,OAAO,IAAI,IAAgC,EAAE,CAAC;oBACxD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;gBACzB,CAAC;YACF,CAAC;iBAAM,CAAC;gBACP,yGAAyG;gBACzG,gEAAgE;gBAChE,2DAA2D;gBAC3D,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,IAAgB,CAAC,CAAC;gBACnD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;oBACrC,iJAAiJ;oBACjJ,IAAI,CAAC,SAAS,CAAE,IAAuB,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC/C,CAAC;gBACD,OAAO,KAAK,CAAC;YACd,CAAC;QACF,CAAC;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAEO,UAAU,CAAC,MAAc;QAChC,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEnC,8DAA8D;QAC9D,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC;QAC3D,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAE1E,mEAAmE;QACnE,MAAM,CACL,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,MAAM,EAC9E,qCAAqC,CACrC,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QACxC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;QAE5C,OAAO,GAAG,WAAW,GAAG,KAAK,EAAE,CAAC;IACjC,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, oob } from \"@fluidframework/core-utils/internal\";\nimport { Tree, NodeKind } from \"@fluidframework/tree/internal\";\nimport type {\n\tTreeNode,\n\tImplicitFieldSchema,\n\tTreeArrayNode,\n\tTreeFieldFromImplicitField,\n} from \"@fluidframework/tree/internal\";\n\n/**\n * Given a tree, generates a set of LLM-friendly, unique IDs for each node in the tree.\n * @remarks The ability to uniquely and stably in the tree is important for the LLM and this library to create and distinguish between different types certain {@link TreeEdit}s.\n */\nexport class IdGenerator {\n\tprivate readonly idCountMap = new Map<string, number>();\n\tprivate readonly prefixMap = new Map<string, string>();\n\tprivate readonly nodeToIdMap = new Map<TreeNode, string>();\n\tprivate readonly idToNodeMap = new Map<string, TreeNode>();\n\n\tpublic constructor() {}\n\n\tpublic getOrCreateId(node: TreeNode): string {\n\t\tconst existingID = this.nodeToIdMap.get(node);\n\t\tif (existingID !== undefined) {\n\t\t\treturn existingID;\n\t\t}\n\n\t\tconst schema = Tree.schema(node).identifier;\n\t\tconst id = this.generateID(schema);\n\t\tthis.nodeToIdMap.set(node, id);\n\t\tthis.idToNodeMap.set(id, node);\n\n\t\treturn id;\n\t}\n\n\tpublic getNode(id: string): TreeNode | undefined {\n\t\treturn this.idToNodeMap.get(id);\n\t}\n\n\tpublic getId(node: TreeNode): string | undefined {\n\t\treturn this.nodeToIdMap.get(node);\n\t}\n\n\tpublic assignIds(node: TreeFieldFromImplicitField<ImplicitFieldSchema>): string | undefined {\n\t\tif (typeof node === \"object\" && node !== null) {\n\t\t\tconst schema = Tree.schema(node as unknown as TreeNode);\n\t\t\tif (schema.kind === NodeKind.Array) {\n\t\t\t\tfor (const element of node as unknown as TreeArrayNode) {\n\t\t\t\t\tthis.assignIds(element);\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\t// TODO: SharedTree Team needs to either publish TreeNode as a class to use .instanceof() or a typeguard.\n\t\t\t\t// Uncomment this assertion back once we have a typeguard ready.\n\t\t\t\t// assert(isTreeNode(node), \"Non-TreeNode value in tree.\");\n\t\t\t\tconst objId = this.getOrCreateId(node as TreeNode);\n\t\t\t\tfor (const key of Object.keys(node)) {\n\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-argument\n\t\t\t\t\tthis.assignIds((node as unknown as any)[key]);\n\t\t\t\t}\n\t\t\t\treturn objId;\n\t\t\t}\n\t\t}\n\t\treturn undefined;\n\t}\n\n\tprivate generateID(schema: string): string {\n\t\tconst segments = schema.split(\".\");\n\n\t\t// If there's no period, the schema itself is the last segment\n\t\tconst lastSegment = segments[segments.length - 1] ?? oob();\n\t\tconst prefix = segments.length > 1 ? segments.slice(0, -1).join(\".\") : \"\";\n\n\t\t// Check if the last segment already exists with a different prefix\n\t\tassert(\n\t\t\t!this.prefixMap.has(lastSegment) || this.prefixMap.get(lastSegment) === prefix,\n\t\t\t\"Different scopes not supported yet.\",\n\t\t);\n\n\t\tthis.prefixMap.set(lastSegment, prefix);\n\t\tconst count = this.idCountMap.get(lastSegment) ?? 1;\n\t\tthis.idCountMap.set(lastSegment, count + 1);\n\n\t\treturn `${lastSegment}${count}`;\n\t}\n}\n"]}

package/lib/explicit-strategy/index.d.ts

@@ -0,0 +1,51 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { type TreeNode } from "@fluidframework/tree/internal";
+import type { OpenAiClientOptions, TokenLimits, TokenUsage } from "../aiCollabApi.js";
+/**
+ * {@link generateTreeEdits} options.
+ *
+ * @internal
+ */
+export interface GenerateTreeEditsOptions {
+    openAI: OpenAiClientOptions;
+    treeNode: TreeNode;
+    prompt: {
+        systemRoleContext: string;
+        userAsk: string;
+    };
+    limiters?: {
+        abortController?: AbortController;
+        maxSequentialErrors?: number;
+        maxModelCalls?: number;
+        tokenLimits?: TokenLimits;
+    };
+    finalReviewStep?: boolean;
+    validator?: (newContent: TreeNode) => void;
+    dumpDebugLog?: boolean;
+    planningStep?: boolean;
+}
+interface GenerateTreeEditsSuccessResponse {
+    status: "success";
+    tokensUsed: TokenUsage;
+}
+interface GenerateTreeEditsErrorResponse {
+    status: "failure" | "partial-failure";
+    errorMessage: "tokenLimitExceeded" | "tooManyErrors" | "tooManyModelCalls" | "aborted";
+    tokensUsed: TokenUsage;
+}
+/**
+ * Prompts the provided LLM client to generate valid tree edits.
+ * Applies those edits to the provided tree branch before returning.
+ *
+ * @remarks
+ * - Optional root nodes are not supported
+ * - Primitive root nodes are not supported
+ *
+ * @internal
+ */
+export declare function generateTreeEdits(options: GenerateTreeEditsOptions): Promise<GenerateTreeEditsSuccessResponse | GenerateTreeEditsErrorResponse>;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/explicit-strategy/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/explicit-strategy/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAIN,KAAK,QAAQ,EACb,MAAM,+BAA+B,CAAC;AASvC,OAAO,KAAK,EAAE,mBAAmB,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAiBtF;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACxC,MAAM,EAAE,mBAAmB,CAAC;IAC5B,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE;QACP,iBAAiB,EAAE,MAAM,CAAC;QAC1B,OAAO,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,QAAQ,CAAC,EAAE;QACV,eAAe,CAAC,EAAE,eAAe,CAAC;QAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,WAAW,CAAC,EAAE,WAAW,CAAC;KAC1B,CAAC;IACF,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,CAAC,UAAU,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC3C,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,UAAU,gCAAgC;IACzC,MAAM,EAAE,SAAS,CAAC;IAClB,UAAU,EAAE,UAAU,CAAC;CACvB;AAED,UAAU,8BAA8B;IACvC,MAAM,EAAE,SAAS,GAAG,iBAAiB,CAAC;IACtC,YAAY,EAAE,oBAAoB,GAAG,eAAe,GAAG,mBAAmB,GAAG,SAAS,CAAC;IACvF,UAAU,EAAE,UAAU,CAAC;CACvB;AAED;;;;;;;;;GASG;AACH,wBAAsB,iBAAiB,CACtC,OAAO,EAAE,wBAAwB,GAC/B,OAAO,CAAC,gCAAgC,GAAG,8BAA8B,CAAC,CAmG5E"}

package/lib/explicit-strategy/index.js

@@ -0,0 +1,219 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { getSimpleSchema, Tree, } from "@fluidframework/tree/internal";
+// eslint-disable-next-line import/no-internal-modules
+import { zodResponseFormat } from "openai/helpers/zod";
+import { z } from "zod";
+import { applyAgentEdit } from "./agentEditReducer.js";
+import { IdGenerator } from "./idGenerator.js";
+import { getEditingSystemPrompt, getPlanningSystemPrompt, getReviewSystemPrompt, toDecoratedJson, } from "./promptGeneration.js";
+import { generateGenericEditTypes } from "./typeGeneration.js";
+import { fail } from "./utils.js";
+const DEBUG_LOG = [];
+/**
+ * Prompts the provided LLM client to generate valid tree edits.
+ * Applies those edits to the provided tree branch before returning.
+ *
+ * @remarks
+ * - Optional root nodes are not supported
+ * - Primitive root nodes are not supported
+ *
+ * @internal
+ */
+export async function generateTreeEdits(options) {
+    const idGenerator = new IdGenerator();
+    const editLog = [];
+    let editCount = 0;
+    let sequentialErrorCount = 0;
+    const simpleSchema = getSimpleSchema(Tree.schema(options.treeNode));
+    const tokensUsed = { inputTokens: 0, outputTokens: 0 };
+    try {
+        for await (const edit of generateEdits(options, simpleSchema, idGenerator, editLog, options.limiters?.tokenLimits, tokensUsed)) {
+            try {
+                const result = applyAgentEdit(edit, idGenerator, simpleSchema.definitions, options.validator);
+                const explanation = result.explanation;
+                editLog.push({ edit: { ...result, explanation } });
+                sequentialErrorCount = 0;
+            }
+            catch (error) {
+                if (error instanceof Error) {
+                    sequentialErrorCount += 1;
+                    editLog.push({ edit, error: error.message });
+                    DEBUG_LOG?.push(`Error: ${error.message}`);
+                }
+                else {
+                    throw error;
+                }
+            }
+            const responseStatus = editCount > 0 && sequentialErrorCount < editCount ? "partial-failure" : "failure";
+            if (options.limiters?.abortController?.signal.aborted === true) {
+                return {
+                    status: responseStatus,
+                    errorMessage: "aborted",
+                    tokensUsed,
+                };
+            }
+            if (sequentialErrorCount >
+                (options.limiters?.maxSequentialErrors ?? Number.POSITIVE_INFINITY)) {
+                return {
+                    status: responseStatus,
+                    errorMessage: "tooManyErrors",
+                    tokensUsed,
+                };
+            }
+            if (++editCount >= (options.limiters?.maxModelCalls ?? Number.POSITIVE_INFINITY)) {
+                return {
+                    status: responseStatus,
+                    errorMessage: "tooManyModelCalls",
+                    tokensUsed,
+                };
+            }
+        }
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            DEBUG_LOG?.push(`Error: ${error.message}`);
+        }
+        if (options.dumpDebugLog ?? false) {
+            console.log(DEBUG_LOG.join("\n\n"));
+            DEBUG_LOG.length = 0;
+        }
+        if (error instanceof TokenLimitExceededError) {
+            return {
+                status: editCount > 0 && sequentialErrorCount < editCount ? "partial-failure" : "failure",
+                errorMessage: "tokenLimitExceeded",
+                tokensUsed,
+            };
+        }
+        throw error;
+    }
+    if (options.dumpDebugLog ?? false) {
+        console.log(DEBUG_LOG.join("\n\n"));
+        DEBUG_LOG.length = 0;
+    }
+    return {
+        status: "success",
+        tokensUsed,
+    };
+}
+/**
+ * Generates a single {@link TreeEdit} from an LLM.
+ *
+ * @remarks
+ * The design of this async generator function is such that which each iteration of this functions values,
+ * an LLM will be prompted to generate the next value (a {@link TreeEdit}) based on the users ask.
+ * Once the LLM believes it has completed the user's ask, it will no longer return an edit and as a result
+ * this generator will no longer yield a next value.
+ */
+async function* generateEdits(options, simpleSchema, idGenerator, editLog, tokenLimits, tokensUsed) {
+    const [types, rootTypeName] = generateGenericEditTypes(simpleSchema, true);
+    let plan;
+    if (options.planningStep !== undefined) {
+        const planningPromt = getPlanningSystemPrompt(options.treeNode, options.prompt.userAsk, options.prompt.systemRoleContext);
+        DEBUG_LOG?.push(planningPromt);
+        plan = await getStringFromLlm(planningPromt, options.openAI, tokensUsed);
+        DEBUG_LOG?.push(`AI Generated the following plan: ${planningPromt}`);
+    }
+    const originalDecoratedJson = (options.finalReviewStep ?? false)
+        ? toDecoratedJson(idGenerator, options.treeNode)
+        : undefined;
+    // reviewed is implicitly true if finalReviewStep is false
+    let hasReviewed = (options.finalReviewStep ?? false) ? false : true;
+    async function getNextEdit() {
+        const systemPrompt = getEditingSystemPrompt(options.prompt.userAsk, idGenerator, options.treeNode, editLog, options.prompt.systemRoleContext, plan);
+        DEBUG_LOG?.push(systemPrompt);
+        const schema = types[rootTypeName] ?? fail("Root type not found.");
+        const wrapper = await getStructuredOutputFromLlm(systemPrompt, options.openAI, schema, "A JSON object that represents an edit to a JSON tree.", tokensUsed);
+        // eslint-disable-next-line unicorn/no-null
+        DEBUG_LOG?.push(JSON.stringify(wrapper, null, 2));
+        if (wrapper === undefined) {
+            DEBUG_LOG?.push("Failed to get response");
+            return undefined;
+        }
+        if (wrapper.edit === null) {
+            DEBUG_LOG?.push("No more edits.");
+            if ((options.finalReviewStep ?? false) && !hasReviewed) {
+                const reviewResult = await reviewGoal();
+                if (reviewResult === undefined) {
+                    DEBUG_LOG?.push("Failed to get review response");
+                    return undefined;
+                }
+                // eslint-disable-next-line require-atomic-updates
+                hasReviewed = true;
+                if (reviewResult.goalAccomplished === "yes") {
+                    return undefined;
+                }
+                else {
+                    // eslint-disable-next-line require-atomic-updates
+                    editLog.length = 0;
+                    return getNextEdit();
+                }
+            }
+        }
+        else {
+            return wrapper.edit;
+        }
+    }
+    async function reviewGoal() {
+        const systemPrompt = getReviewSystemPrompt(options.prompt.userAsk, idGenerator, options.treeNode, originalDecoratedJson ?? fail("Original decorated tree not provided."), options.prompt.systemRoleContext);
+        DEBUG_LOG?.push(systemPrompt);
+        const schema = z.object({
+            goalAccomplished: z
+                .enum(["yes", "no"])
+                .describe('Whether the user\'s goal was met in the "after" tree.'),
+        });
+        return getStructuredOutputFromLlm(systemPrompt, options.openAI, schema);
+    }
+    let edit = await getNextEdit();
+    while (edit !== undefined) {
+        yield edit;
+        if (tokensUsed.inputTokens > (tokenLimits?.inputTokens ?? Number.POSITIVE_INFINITY)) {
+            throw new TokenLimitExceededError("Input token limit exceeded.");
+        }
+        if (tokensUsed.outputTokens > (tokenLimits?.outputTokens ?? Number.POSITIVE_INFINITY)) {
+            throw new TokenLimitExceededError("Output token limit exceeded.");
+        }
+        edit = await getNextEdit();
+    }
+}
+/**
+ * Calls the LLM to generate a structured output response based on the provided prompt.
+ */
+async function getStructuredOutputFromLlm(prompt, openAi, structuredOutputSchema, description, tokensUsed) {
+    const response_format = zodResponseFormat(structuredOutputSchema, "SharedTreeAI", {
+        description,
+    });
+    const body = {
+        messages: [{ role: "system", content: prompt }],
+        model: openAi.modelName ?? "gpt-4o",
+        response_format,
+    };
+    const result = await openAi.client.beta.chat.completions.parse(body);
+    if (result.usage !== undefined && tokensUsed !== undefined) {
+        tokensUsed.inputTokens += result.usage?.prompt_tokens;
+        tokensUsed.outputTokens += result.usage?.completion_tokens;
+    }
+    // TODO: fix types so this isn't null and doesn't need a cast
+    // The type should be derived from the zod schema
+    return result.choices[0]?.message.parsed;
+}
+/**
+ * Calls the LLM to generate a response based on the provided prompt.
+ */
+async function getStringFromLlm(prompt, openAi, tokensUsed) {
+    const body = {
+        messages: [{ role: "system", content: prompt }],
+        model: openAi.modelName ?? "gpt-4o",
+    };
+    const result = await openAi.client.chat.completions.create(body);
+    if (result.usage !== undefined && tokensUsed !== undefined) {
+        tokensUsed.inputTokens += result.usage?.prompt_tokens;
+        tokensUsed.outputTokens += result.usage?.completion_tokens;
+    }
+    return result.choices[0]?.message.content ?? undefined;
+}
+class TokenLimitExceededError extends Error {
+}
+//# sourceMappingURL=index.js.map

package/lib/explicit-strategy/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/explicit-strategy/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,eAAe,EACf,IAAI,GAGJ,MAAM,+BAA+B,CAAC;AACvC,sDAAsD;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAKvD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EACN,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,eAAe,GAEf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAElC,MAAM,SAAS,GAAa,EAAE,CAAC;AAqC/B;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACtC,OAAiC;IAEjC,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;IACtC,MAAM,OAAO,GAAY,EAAE,CAAC;IAC5B,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,IAAI,oBAAoB,GAAG,CAAC,CAAC;IAE7B,MAAM,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEpE,MAAM,UAAU,GAAG,EAAE,WAAW,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC;IAEvD,IAAI,CAAC;QACJ,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,aAAa,CACrC,OAAO,EACP,YAAY,EACZ,WAAW,EACX,OAAO,EACP,OAAO,CAAC,QAAQ,EAAE,WAAW,EAC7B,UAAU,CACV,EAAE,CAAC;YACH,IAAI,CAAC;gBACJ,MAAM,MAAM,GAAG,cAAc,CAC5B,IAAI,EACJ,WAAW,EACX,YAAY,CAAC,WAAW,EACxB,OAAO,CAAC,SAAS,CACjB,CAAC;gBACF,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;gBACvC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,GAAG,MAAM,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;gBACnD,oBAAoB,GAAG,CAAC,CAAC;YAC1B,CAAC;YAAC,OAAO,KAAc,EAAE,CAAC;gBACzB,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;oBAC5B,oBAAoB,IAAI,CAAC,CAAC;oBAC1B,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;oBAC7C,SAAS,EAAE,IAAI,CAAC,UAAU,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC5C,CAAC;qBAAM,CAAC;oBACP,MAAM,KAAK,CAAC;gBACb,CAAC;YACF,CAAC;YAED,MAAM,cAAc,GACnB,SAAS,GAAG,CAAC,IAAI,oBAAoB,GAAG,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC;YAEnF,IAAI,OAAO,CAAC,QAAQ,EAAE,eAAe,EAAE,MAAM,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;gBAChE,OAAO;oBACN,MAAM,EAAE,cAAc;oBACtB,YAAY,EAAE,SAAS;oBACvB,UAAU;iBACV,CAAC;YACH,CAAC;YAED,IACC,oBAAoB;gBACpB,CAAC,OAAO,CAAC,QAAQ,EAAE,mBAAmB,IAAI,MAAM,CAAC,iBAAiB,CAAC,EAClE,CAAC;gBACF,OAAO;oBACN,MAAM,EAAE,cAAc;oBACtB,YAAY,EAAE,eAAe;oBAC7B,UAAU;iBACV,CAAC;YACH,CAAC;YAED,IAAI,EAAE,SAAS,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,aAAa,IAAI,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBAClF,OAAO;oBACN,MAAM,EAAE,cAAc;oBACtB,YAAY,EAAE,mBAAmB;oBACjC,UAAU;iBACV,CAAC;YACH,CAAC;QACF,CAAC;IACF,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACzB,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC5B,SAAS,EAAE,IAAI,CAAC,UAAU,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,OAAO,CAAC,YAAY,IAAI,KAAK,EAAE,CAAC;YACnC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YACpC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;QACtB,CAAC;QAED,IAAI,KAAK,YAAY,uBAAuB,EAAE,CAAC;YAC9C,OAAO;gBACN,MAAM,EACL,SAAS,GAAG,CAAC,IAAI,oBAAoB,GAAG,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS;gBAClF,YAAY,EAAE,oBAAoB;gBAClC,UAAU;aACV,CAAC;QACH,CAAC;QACD,MAAM,KAAK,CAAC;IACb,CAAC;IAED,IAAI,OAAO,CAAC,YAAY,IAAI,KAAK,EAAE,CAAC;QACnC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACpC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IACtB,CAAC;IAED,OAAO;QACN,MAAM,EAAE,SAAS;QACjB,UAAU;KACV,CAAC;AACH,CAAC;AAMD;;;;;;;;GAQG;AACH,KAAK,SAAS,CAAC,CAAC,aAAa,CAC5B,OAAiC,EACjC,YAA8B,EAC9B,WAAwB,EACxB,OAAgB,EAChB,WAAoC,EACpC,UAAsB;IAEtB,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,GAAG,wBAAwB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IAE3E,IAAI,IAAwB,CAAC;IAC7B,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACxC,MAAM,aAAa,GAAG,uBAAuB,CAC5C,OAAO,CAAC,QAAQ,EAChB,OAAO,CAAC,MAAM,CAAC,OAAO,EACtB,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAChC,CAAC;QACF,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC/B,IAAI,GAAG,MAAM,gBAAgB,CAAC,aAAa,EAAE,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACzE,SAAS,EAAE,IAAI,CAAC,oCAAoC,aAAa,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,MAAM,qBAAqB,GAC1B,CAAC,OAAO,CAAC,eAAe,IAAI,KAAK,CAAC;QACjC,CAAC,CAAC,eAAe,CAAC,WAAW,EAAE,OAAO,CAAC,QAAQ,CAAC;QAChD,CAAC,CAAC,SAAS,CAAC;IACd,0DAA0D;IAC1D,IAAI,WAAW,GAAG,CAAC,OAAO,CAAC,eAAe,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IACpE,KAAK,UAAU,WAAW;QACzB,MAAM,YAAY,GAAG,sBAAsB,CAC1C,OAAO,CAAC,MAAM,CAAC,OAAO,EACtB,WAAW,EACX,OAAO,CAAC,QAAQ,EAChB,OAAO,EACP,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAChC,IAAI,CACJ,CAAC;QAEF,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAE9B,MAAM,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACnE,MAAM,OAAO,GAAG,MAAM,0BAA0B,CAC/C,YAAY,EACZ,OAAO,CAAC,MAAM,EACd,MAAM,EACN,uDAAuD,EACvD,UAAU,CACV,CAAC;QAEF,2CAA2C;QAC3C,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAClD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC3B,SAAS,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC;YAC1C,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YAC3B,SAAS,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAClC,IAAI,CAAC,OAAO,CAAC,eAAe,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;gBACxD,MAAM,YAAY,GAAG,MAAM,UAAU,EAAE,CAAC;gBACxC,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;oBAChC,SAAS,EAAE,IAAI,CAAC,+BAA+B,CAAC,CAAC;oBACjD,OAAO,SAAS,CAAC;gBAClB,CAAC;gBACD,kDAAkD;gBAClD,WAAW,GAAG,IAAI,CAAC;gBACnB,IAAI,YAAY,CAAC,gBAAgB,KAAK,KAAK,EAAE,CAAC;oBAC7C,OAAO,SAAS,CAAC;gBAClB,CAAC;qBAAM,CAAC;oBACP,kDAAkD;oBAClD,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;oBACnB,OAAO,WAAW,EAAE,CAAC;gBACtB,CAAC;YACF,CAAC;QACF,CAAC;aAAM,CAAC;YACP,OAAO,OAAO,CAAC,IAAI,CAAC;QACrB,CAAC;IACF,CAAC;IAED,KAAK,UAAU,UAAU;QACxB,MAAM,YAAY,GAAG,qBAAqB,CACzC,OAAO,CAAC,MAAM,CAAC,OAAO,EACtB,WAAW,EACX,OAAO,CAAC,QAAQ,EAChB,qBAAqB,IAAI,IAAI,CAAC,uCAAuC,CAAC,EACtE,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAChC,CAAC;QAEF,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAE9B,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;YACvB,gBAAgB,EAAE,CAAC;iBACjB,IAAI,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;iBACnB,QAAQ,CAAC,uDAAuD,CAAC;SACnE,CAAC,CAAC;QACH,OAAO,0BAA0B,CAAe,YAAY,EAAE,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvF,CAAC;IAED,IAAI,IAAI,GAAG,MAAM,WAAW,EAAE,CAAC;IAC/B,OAAO,IAAI,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,CAAC;QACX,IAAI,UAAU,CAAC,WAAW,GAAG,CAAC,WAAW,EAAE,WAAW,IAAI,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACrF,MAAM,IAAI,uBAAuB,CAAC,6BAA6B,CAAC,CAAC;QAClE,CAAC;QACD,IAAI,UAAU,CAAC,YAAY,GAAG,CAAC,WAAW,EAAE,YAAY,IAAI,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACvF,MAAM,IAAI,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;QACnE,CAAC;QACD,IAAI,GAAG,MAAM,WAAW,EAAE,CAAC;IAC5B,CAAC;AACF,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,0BAA0B,CACxC,MAAc,EACd,MAA2B,EAC3B,sBAAsC,EACtC,WAAoB,EACpB,UAAuB;IAEvB,MAAM,eAAe,GAAG,iBAAiB,CAAC,sBAAsB,EAAE,cAAc,EAAE;QACjF,WAAW;KACX,CAAC,CAAC;IAEH,MAAM,IAAI,GAA+B;QACxC,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAC/C,KAAK,EAAE,MAAM,CAAC,SAAS,IAAI,QAAQ;QACnC,eAAe;KACf,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAErE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC5D,UAAU,CAAC,WAAW,IAAI,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC;QACtD,UAAU,CAAC,YAAY,IAAI,MAAM,CAAC,KAAK,EAAE,iBAAiB,CAAC;IAC5D,CAAC;IAED,6DAA6D;IAC7D,iDAAiD;IACjD,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,MAAuB,CAAC;AAC3D,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,gBAAgB,CAC9B,MAAc,EACd,MAA2B,EAC3B,UAAuB;IAEvB,MAAM,IAAI,GAA+B;QACxC,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAC/C,KAAK,EAAE,MAAM,CAAC,SAAS,IAAI,QAAQ;KACnC,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAEjE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC5D,UAAU,CAAC,WAAW,IAAI,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC;QACtD,UAAU,CAAC,YAAY,IAAI,MAAM,CAAC,KAAK,EAAE,iBAAiB,CAAC;IAC5D,CAAC;IAED,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,OAAO,IAAI,SAAS,CAAC;AACxD,CAAC;AAED,MAAM,uBAAwB,SAAQ,KAAK;CAAG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tgetSimpleSchema,\n\tTree,\n\ttype SimpleTreeSchema,\n\ttype TreeNode,\n} from \"@fluidframework/tree/internal\";\n// eslint-disable-next-line import/no-internal-modules\nimport { zodResponseFormat } from \"openai/helpers/zod\";\nimport type {\n\tChatCompletionCreateParams,\n\t// eslint-disable-next-line import/no-internal-modules\n} from \"openai/resources/index.mjs\";\nimport { z } from \"zod\";\n\nimport type { OpenAiClientOptions, TokenLimits, TokenUsage } from \"../aiCollabApi.js\";\n\nimport { applyAgentEdit } from \"./agentEditReducer.js\";\nimport type { EditWrapper, TreeEdit } from \"./agentEditTypes.js\";\nimport { IdGenerator } from \"./idGenerator.js\";\nimport {\n\tgetEditingSystemPrompt,\n\tgetPlanningSystemPrompt,\n\tgetReviewSystemPrompt,\n\ttoDecoratedJson,\n\ttype EditLog,\n} from \"./promptGeneration.js\";\nimport { generateGenericEditTypes } from \"./typeGeneration.js\";\nimport { fail } from \"./utils.js\";\n\nconst DEBUG_LOG: string[] = [];\n\n/**\n * {@link generateTreeEdits} options.\n *\n * @internal\n */\nexport interface GenerateTreeEditsOptions {\n\topenAI: OpenAiClientOptions;\n\ttreeNode: TreeNode;\n\tprompt: {\n\t\tsystemRoleContext: string;\n\t\tuserAsk: string;\n\t};\n\tlimiters?: {\n\t\tabortController?: AbortController;\n\t\tmaxSequentialErrors?: number;\n\t\tmaxModelCalls?: number;\n\t\ttokenLimits?: TokenLimits;\n\t};\n\tfinalReviewStep?: boolean;\n\tvalidator?: (newContent: TreeNode) => void;\n\tdumpDebugLog?: boolean;\n\tplanningStep?: boolean;\n}\n\ninterface GenerateTreeEditsSuccessResponse {\n\tstatus: \"success\";\n\ttokensUsed: TokenUsage;\n}\n\ninterface GenerateTreeEditsErrorResponse {\n\tstatus: \"failure\" | \"partial-failure\";\n\terrorMessage: \"tokenLimitExceeded\" | \"tooManyErrors\" | \"tooManyModelCalls\" | \"aborted\";\n\ttokensUsed: TokenUsage;\n}\n\n/**\n * Prompts the provided LLM client to generate valid tree edits.\n * Applies those edits to the provided tree branch before returning.\n *\n * @remarks\n * - Optional root nodes are not supported\n * - Primitive root nodes are not supported\n *\n * @internal\n */\nexport async function generateTreeEdits(\n\toptions: GenerateTreeEditsOptions,\n): Promise<GenerateTreeEditsSuccessResponse | GenerateTreeEditsErrorResponse> {\n\tconst idGenerator = new IdGenerator();\n\tconst editLog: EditLog = [];\n\tlet editCount = 0;\n\tlet sequentialErrorCount = 0;\n\n\tconst simpleSchema = getSimpleSchema(Tree.schema(options.treeNode));\n\n\tconst tokensUsed = { inputTokens: 0, outputTokens: 0 };\n\n\ttry {\n\t\tfor await (const edit of generateEdits(\n\t\t\toptions,\n\t\t\tsimpleSchema,\n\t\t\tidGenerator,\n\t\t\teditLog,\n\t\t\toptions.limiters?.tokenLimits,\n\t\t\ttokensUsed,\n\t\t)) {\n\t\t\ttry {\n\t\t\t\tconst result = applyAgentEdit(\n\t\t\t\t\tedit,\n\t\t\t\t\tidGenerator,\n\t\t\t\t\tsimpleSchema.definitions,\n\t\t\t\t\toptions.validator,\n\t\t\t\t);\n\t\t\t\tconst explanation = result.explanation;\n\t\t\t\teditLog.push({ edit: { ...result, explanation } });\n\t\t\t\tsequentialErrorCount = 0;\n\t\t\t} catch (error: unknown) {\n\t\t\t\tif (error instanceof Error) {\n\t\t\t\t\tsequentialErrorCount += 1;\n\t\t\t\t\teditLog.push({ edit, error: error.message });\n\t\t\t\t\tDEBUG_LOG?.push(`Error: ${error.message}`);\n\t\t\t\t} else {\n\t\t\t\t\tthrow error;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tconst responseStatus =\n\t\t\t\teditCount > 0 && sequentialErrorCount < editCount ? \"partial-failure\" : \"failure\";\n\n\t\t\tif (options.limiters?.abortController?.signal.aborted === true) {\n\t\t\t\treturn {\n\t\t\t\t\tstatus: responseStatus,\n\t\t\t\t\terrorMessage: \"aborted\",\n\t\t\t\t\ttokensUsed,\n\t\t\t\t};\n\t\t\t}\n\n\t\t\tif (\n\t\t\t\tsequentialErrorCount >\n\t\t\t\t(options.limiters?.maxSequentialErrors ?? Number.POSITIVE_INFINITY)\n\t\t\t) {\n\t\t\t\treturn {\n\t\t\t\t\tstatus: responseStatus,\n\t\t\t\t\terrorMessage: \"tooManyErrors\",\n\t\t\t\t\ttokensUsed,\n\t\t\t\t};\n\t\t\t}\n\n\t\t\tif (++editCount >= (options.limiters?.maxModelCalls ?? Number.POSITIVE_INFINITY)) {\n\t\t\t\treturn {\n\t\t\t\t\tstatus: responseStatus,\n\t\t\t\t\terrorMessage: \"tooManyModelCalls\",\n\t\t\t\t\ttokensUsed,\n\t\t\t\t};\n\t\t\t}\n\t\t}\n\t} catch (error: unknown) {\n\t\tif (error instanceof Error) {\n\t\t\tDEBUG_LOG?.push(`Error: ${error.message}`);\n\t\t}\n\n\t\tif (options.dumpDebugLog ?? false) {\n\t\t\tconsole.log(DEBUG_LOG.join(\"\\n\\n\"));\n\t\t\tDEBUG_LOG.length = 0;\n\t\t}\n\n\t\tif (error instanceof TokenLimitExceededError) {\n\t\t\treturn {\n\t\t\t\tstatus:\n\t\t\t\t\teditCount > 0 && sequentialErrorCount < editCount ? \"partial-failure\" : \"failure\",\n\t\t\t\terrorMessage: \"tokenLimitExceeded\",\n\t\t\t\ttokensUsed,\n\t\t\t};\n\t\t}\n\t\tthrow error;\n\t}\n\n\tif (options.dumpDebugLog ?? false) {\n\t\tconsole.log(DEBUG_LOG.join(\"\\n\\n\"));\n\t\tDEBUG_LOG.length = 0;\n\t}\n\n\treturn {\n\t\tstatus: \"success\",\n\t\ttokensUsed,\n\t};\n}\n\ninterface ReviewResult {\n\tgoalAccomplished: \"yes\" | \"no\";\n}\n\n/**\n * Generates a single {@link TreeEdit} from an LLM.\n *\n * @remarks\n * The design of this async generator function is such that which each iteration of this functions values,\n * an LLM will be prompted to generate the next value (a {@link TreeEdit}) based on the users ask.\n * Once the LLM believes it has completed the user's ask, it will no longer return an edit and as a result\n * this generator will no longer yield a next value.\n */\nasync function* generateEdits(\n\toptions: GenerateTreeEditsOptions,\n\tsimpleSchema: SimpleTreeSchema,\n\tidGenerator: IdGenerator,\n\teditLog: EditLog,\n\ttokenLimits: TokenLimits | undefined,\n\ttokensUsed: TokenUsage,\n): AsyncGenerator<TreeEdit> {\n\tconst [types, rootTypeName] = generateGenericEditTypes(simpleSchema, true);\n\n\tlet plan: string | undefined;\n\tif (options.planningStep !== undefined) {\n\t\tconst planningPromt = getPlanningSystemPrompt(\n\t\t\toptions.treeNode,\n\t\t\toptions.prompt.userAsk,\n\t\t\toptions.prompt.systemRoleContext,\n\t\t);\n\t\tDEBUG_LOG?.push(planningPromt);\n\t\tplan = await getStringFromLlm(planningPromt, options.openAI, tokensUsed);\n\t\tDEBUG_LOG?.push(`AI Generated the following plan: ${planningPromt}`);\n\t}\n\n\tconst originalDecoratedJson =\n\t\t(options.finalReviewStep ?? false)\n\t\t\t? toDecoratedJson(idGenerator, options.treeNode)\n\t\t\t: undefined;\n\t// reviewed is implicitly true if finalReviewStep is false\n\tlet hasReviewed = (options.finalReviewStep ?? false) ? false : true;\n\tasync function getNextEdit(): Promise<TreeEdit | undefined> {\n\t\tconst systemPrompt = getEditingSystemPrompt(\n\t\t\toptions.prompt.userAsk,\n\t\t\tidGenerator,\n\t\t\toptions.treeNode,\n\t\t\teditLog,\n\t\t\toptions.prompt.systemRoleContext,\n\t\t\tplan,\n\t\t);\n\n\t\tDEBUG_LOG?.push(systemPrompt);\n\n\t\tconst schema = types[rootTypeName] ?? fail(\"Root type not found.\");\n\t\tconst wrapper = await getStructuredOutputFromLlm<EditWrapper>(\n\t\t\tsystemPrompt,\n\t\t\toptions.openAI,\n\t\t\tschema,\n\t\t\t\"A JSON object that represents an edit to a JSON tree.\",\n\t\t\ttokensUsed,\n\t\t);\n\n\t\t// eslint-disable-next-line unicorn/no-null\n\t\tDEBUG_LOG?.push(JSON.stringify(wrapper, null, 2));\n\t\tif (wrapper === undefined) {\n\t\t\tDEBUG_LOG?.push(\"Failed to get response\");\n\t\t\treturn undefined;\n\t\t}\n\n\t\tif (wrapper.edit === null) {\n\t\t\tDEBUG_LOG?.push(\"No more edits.\");\n\t\t\tif ((options.finalReviewStep ?? false) && !hasReviewed) {\n\t\t\t\tconst reviewResult = await reviewGoal();\n\t\t\t\tif (reviewResult === undefined) {\n\t\t\t\t\tDEBUG_LOG?.push(\"Failed to get review response\");\n\t\t\t\t\treturn undefined;\n\t\t\t\t}\n\t\t\t\t// eslint-disable-next-line require-atomic-updates\n\t\t\t\thasReviewed = true;\n\t\t\t\tif (reviewResult.goalAccomplished === \"yes\") {\n\t\t\t\t\treturn undefined;\n\t\t\t\t} else {\n\t\t\t\t\t// eslint-disable-next-line require-atomic-updates\n\t\t\t\t\teditLog.length = 0;\n\t\t\t\t\treturn getNextEdit();\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\treturn wrapper.edit;\n\t\t}\n\t}\n\n\tasync function reviewGoal(): Promise<ReviewResult | undefined> {\n\t\tconst systemPrompt = getReviewSystemPrompt(\n\t\t\toptions.prompt.userAsk,\n\t\t\tidGenerator,\n\t\t\toptions.treeNode,\n\t\t\toriginalDecoratedJson ?? fail(\"Original decorated tree not provided.\"),\n\t\t\toptions.prompt.systemRoleContext,\n\t\t);\n\n\t\tDEBUG_LOG?.push(systemPrompt);\n\n\t\tconst schema = z.object({\n\t\t\tgoalAccomplished: z\n\t\t\t\t.enum([\"yes\", \"no\"])\n\t\t\t\t.describe('Whether the user\\'s goal was met in the \"after\" tree.'),\n\t\t});\n\t\treturn getStructuredOutputFromLlm<ReviewResult>(systemPrompt, options.openAI, schema);\n\t}\n\n\tlet edit = await getNextEdit();\n\twhile (edit !== undefined) {\n\t\tyield edit;\n\t\tif (tokensUsed.inputTokens > (tokenLimits?.inputTokens ?? Number.POSITIVE_INFINITY)) {\n\t\t\tthrow new TokenLimitExceededError(\"Input token limit exceeded.\");\n\t\t}\n\t\tif (tokensUsed.outputTokens > (tokenLimits?.outputTokens ?? Number.POSITIVE_INFINITY)) {\n\t\t\tthrow new TokenLimitExceededError(\"Output token limit exceeded.\");\n\t\t}\n\t\tedit = await getNextEdit();\n\t}\n}\n\n/**\n * Calls the LLM to generate a structured output response based on the provided prompt.\n */\nasync function getStructuredOutputFromLlm<T>(\n\tprompt: string,\n\topenAi: OpenAiClientOptions,\n\tstructuredOutputSchema: Zod.ZodTypeAny,\n\tdescription?: string,\n\ttokensUsed?: TokenUsage,\n): Promise<T | undefined> {\n\tconst response_format = zodResponseFormat(structuredOutputSchema, \"SharedTreeAI\", {\n\t\tdescription,\n\t});\n\n\tconst body: ChatCompletionCreateParams = {\n\t\tmessages: [{ role: \"system\", content: prompt }],\n\t\tmodel: openAi.modelName ?? \"gpt-4o\",\n\t\tresponse_format,\n\t};\n\n\tconst result = await openAi.client.beta.chat.completions.parse(body);\n\n\tif (result.usage !== undefined && tokensUsed !== undefined) {\n\t\ttokensUsed.inputTokens += result.usage?.prompt_tokens;\n\t\ttokensUsed.outputTokens += result.usage?.completion_tokens;\n\t}\n\n\t// TODO: fix types so this isn't null and doesn't need a cast\n\t// The type should be derived from the zod schema\n\treturn result.choices[0]?.message.parsed as T | undefined;\n}\n\n/**\n * Calls the LLM to generate a response based on the provided prompt.\n */\nasync function getStringFromLlm(\n\tprompt: string,\n\topenAi: OpenAiClientOptions,\n\ttokensUsed?: TokenUsage,\n): Promise<string | undefined> {\n\tconst body: ChatCompletionCreateParams = {\n\t\tmessages: [{ role: \"system\", content: prompt }],\n\t\tmodel: openAi.modelName ?? \"gpt-4o\",\n\t};\n\n\tconst result = await openAi.client.chat.completions.create(body);\n\n\tif (result.usage !== undefined && tokensUsed !== undefined) {\n\t\ttokensUsed.inputTokens += result.usage?.prompt_tokens;\n\t\ttokensUsed.outputTokens += result.usage?.completion_tokens;\n\t}\n\n\treturn result.choices[0]?.message.content ?? undefined;\n}\n\nclass TokenLimitExceededError extends Error {}\n"]}

package/lib/explicit-strategy/jsonTypes.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Primitive JSON Types
+ */
+export type JsonPrimitive = string | number | boolean | null;
+/**
+ * A JSON Object, a collection of key to {@link JsonValue} pairs
+ */
+export interface JsonObject {
+    [key: string]: JsonValue;
+}
+/**
+ * An Array of {@link JsonValue}
+ */
+export type JsonArray = JsonValue[];
+/**
+ * A union type of all possible JSON values, including primitives, objects, and arrays
+ */
+export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+//# sourceMappingURL=jsonTypes.d.ts.map

package/lib/explicit-strategy/jsonTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonTypes.d.ts","sourceRoot":"","sources":["../../src/explicit-strategy/jsonTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AAEH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAE7D;;GAEG;AAEH,MAAM,WAAW,UAAU;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;CACzB;AACD;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,EAAE,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG,UAAU,GAAG,SAAS,CAAC"}

package/lib/explicit-strategy/jsonTypes.js

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export {};
+//# sourceMappingURL=jsonTypes.js.map

package/lib/explicit-strategy/jsonTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonTypes.js","sourceRoot":"","sources":["../../src/explicit-strategy/jsonTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Primitive JSON Types\n */\n// eslint-disable-next-line @rushstack/no-new-null\nexport type JsonPrimitive = string | number | boolean | null;\n\n/**\n * A JSON Object, a collection of key to {@link JsonValue} pairs\n */\n// eslint-disable-next-line @typescript-eslint/consistent-indexed-object-style\nexport interface JsonObject {\n\t[key: string]: JsonValue;\n}\n/**\n * An Array of {@link JsonValue}\n */\nexport type JsonArray = JsonValue[];\n\n/**\n * A union type of all possible JSON values, including primitives, objects, and arrays\n */\nexport type JsonValue = JsonPrimitive | JsonObject | JsonArray;\n"]}

package/lib/explicit-strategy/promptGeneration.d.ts

@@ -0,0 +1,51 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { type ImplicitFieldSchema, type TreeFieldFromImplicitField, type JsonTreeSchema, type TreeNode } from "@fluidframework/tree/internal";
+import { type TreeEdit } from "./agentEditTypes.js";
+import type { IdGenerator } from "./idGenerator.js";
+/**
+ * A log of edits that have been made to a tree.
+ * @remarks This is primarily used to help an LLM keep track of the active changes it has made.
+ */
+export type EditLog = {
+    edit: TreeEdit;
+    error?: string;
+}[];
+/**
+ * TBD
+ */
+export declare function toDecoratedJson(idGenerator: IdGenerator, root: TreeFieldFromImplicitField<ImplicitFieldSchema>): string;
+/**
+ * Generates a prompt designed to make an LLM produce a plan to edit the SharedTree to accomplish a user-specified goal.
+ */
+export declare function getPlanningSystemPrompt(treeNode: TreeNode, userPrompt: string, systemRoleContext?: string): string;
+/**
+ * Generates a prompt that provides a history of the edits an LLM has made to a SharedTree as well as any errors that occured from attemping to apply each respsecitve edit to the tree.
+ */
+export declare function createEditListHistoryPrompt(edits: EditLog): string;
+/**
+ * Generates the main prompt of this explicit strategy.
+ * This prompt is designed to give an LLM instructions on how it can modify a SharedTree using specific types of {@link TreeEdit}'s
+ * and provides with both a serialized version of the current state of the provided tree node as well as  the interfaces that compromise said tree nodes data.
+ */
+export declare function getEditingSystemPrompt(userPrompt: string, idGenerator: IdGenerator, treeNode: TreeNode, log: EditLog, appGuidance?: string, plan?: string): string;
+/**
+ * Generates a prompt designed to make an LLM review the edits it created and applied to a SharedTree based
+ * on a user-specified goal. This prompt is designed to give the LLM's ability to correct for mistakes and improve the accuracy/fidelity of its final set of tree edits
+ */
+export declare function getReviewSystemPrompt(userPrompt: string, idGenerator: IdGenerator, treeNode: TreeNode, originalDecoratedJson: string, appGuidance?: string): string;
+/**
+ * Converts a fully-qualified SharedTree schema name to a single-word name for use in textual TypeScript-style types.
+ *
+ * @remarks
+ * - TODO: Determine what to do with user-provided names that include periods (e.g. "Foo.Bar").
+ * - TODO: Should probably ensure name starts with an uppercase character.
+ */
+export declare function getPromptFriendlyTreeSchema(jsonSchema: JsonTreeSchema): string;
+/**
+ * TBD
+ */
+export declare function getFriendlySchemaName(schemaName: string): string;
+//# sourceMappingURL=promptGeneration.d.ts.map

package/lib/explicit-strategy/promptGeneration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promptGeneration.d.ts","sourceRoot":"","sources":["../../src/explicit-strategy/promptGeneration.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAEN,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,EAK/B,KAAK,cAAc,EAGnB,KAAK,QAAQ,EACb,MAAM,+BAA+B,CAAC;AAIvC,OAAO,EAAe,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAIpD;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG;IACrB,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CACf,EAAE,CAAC;AAEJ;;GAEG;AACH,wBAAgB,eAAe,CAC9B,WAAW,EAAE,WAAW,EACxB,IAAI,EAAE,0BAA0B,CAAC,mBAAmB,CAAC,GACnD,MAAM,CAsBR;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACtC,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,MAAM,EAClB,iBAAiB,CAAC,EAAE,MAAM,GACxB,MAAM,CAsBR;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAUlE;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACrC,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,WAAW,EACxB,QAAQ,EAAE,QAAQ,EAClB,GAAG,EAAE,OAAO,EACZ,WAAW,CAAC,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,MAAM,GACX,MAAM,CAqCR;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACpC,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,WAAW,EACxB,QAAQ,EAAE,QAAQ,EAClB,qBAAqB,EAAE,MAAM,EAC7B,WAAW,CAAC,EAAE,MAAM,GAClB,MAAM,CAwBR;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CAAC,UAAU,EAAE,cAAc,GAAG,MAAM,CA6B9E;AAgDD;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAOhE"}