@fluidframework/ai-collab 2.10.0-306579

package/dist/aiCollab.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aiCollab.d.ts","sourceRoot":"","sources":["../src/aiCollab.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,qBAAqB,EACrB,eAAe,EACf,uBAAuB,EACvB,MAAM,kBAAkB,CAAC;AAG1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,wBAAsB,QAAQ,CAC7B,OAAO,EAAE,eAAe,GACtB,OAAO,CAAC,uBAAuB,GAAG,qBAAqB,CAAC,CAa1D"}

package/dist/aiCollab.js

@@ -0,0 +1,81 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.aiCollab = void 0;
+const index_js_1 = require("./explicit-strategy/index.js");
+/**
+ * Calls an LLM to modify the provided SharedTree in a series of real time edits based on the provided users prompt input.
+ * @remarks This function is designed to be a controlled "all-in-one" function that handles the entire process of calling an LLM to collaborative edit a SharedTree.
+ *
+ * @example
+ * ```typescript
+ * import {
+ * 	SchemaFactory,
+ * 	TreeViewConfiguration,
+ * 	type TreeView
+ * } from "@fluidframework/tree";
+ *
+ * const sf = new SchemaFactory("todo-app");
+ *
+ * class TodoTask extends sf.object("TodoTask", {
+ * 	title: sf.string,
+ * 	description: sf.string,
+ * }) {}
+ *
+ * class TodoAppState extends sf.object("TodoAppState", {
+ * 	tasks: sf.array(TodoTask),
+ * }) {}
+ *
+ * // Initialize your SharedTree
+ * const treeView: TreeView = tree.viewWith(new TreeViewConfiguration({ schema: TodoAppState }));
+ * treeView.initialize({ tasks: [] });
+ *
+ * // Collaborate with AI in realtime in just one function call.
+ * const response = await aiCollab({
+ * 		openAI: {
+ * 			client: new OpenAI({
+ * 				apiKey: OPENAI_API_KEY,
+ * 			}),
+ * 			modelName: "gpt-4o",
+ * 		},
+ * 		treeNode: view.root,
+ * 		prompt: {
+ * 			systemRoleContext:
+ * 				"You are an helpful assistant managing a todo list for a user.",
+ * 			userAsk: "Create a set of new todos to plan a vacation to Cancun.",
+ * 		},
+ * 		planningStep: true,
+ * 		finalReviewStep: true,
+ * 		dumpDebugLog: true,
+ * 	});
+ * ```
+ *
+ * @remarks Known Limitiations:
+ * - Root level array nodes are not supported
+ * - Nested arrays are not supported
+ * - Primitive nodes are not supported, e.g. 'string', 'number', 'boolean'
+ * - Your application's Shared Tree schema must have no more than 4 levels of nesting
+ * - Optional nodes are not supported in the Shared Tree schema
+ * - Union types are not supported in the Shared Tree schema
+ * - See README for more details.
+ *
+ * @alpha
+ */
+async function aiCollab(options) {
+    const response = await (0, index_js_1.generateTreeEdits)({
+        treeNode: options.treeNode,
+        validator: options.validator,
+        openAI: options.openAI,
+        prompt: options.prompt,
+        limiters: options.limiters,
+        dumpDebugLog: options.dumpDebugLog,
+        planningStep: options.planningStep,
+        finalReviewStep: options.finalReviewStep,
+    });
+    return response;
+}
+exports.aiCollab = aiCollab;
+//# sourceMappingURL=aiCollab.js.map

package/dist/aiCollab.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aiCollab.js","sourceRoot":"","sources":["../src/aiCollab.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH,2DAAiE;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACI,KAAK,UAAU,QAAQ,CAC7B,OAAwB;IAExB,MAAM,QAAQ,GAAG,MAAM,IAAA,4BAAiB,EAAC;QACxC,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,eAAe,EAAE,OAAO,CAAC,eAAe;KACxC,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC;AACjB,CAAC;AAfD,4BAeC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type {\n\tAiCollabErrorResponse,\n\tAiCollabOptions,\n\tAiCollabSuccessResponse,\n} from \"./aiCollabApi.js\";\nimport { generateTreeEdits } from \"./explicit-strategy/index.js\";\n\n/**\n * Calls an LLM to modify the provided SharedTree in a series of real time edits based on the provided users prompt input.\n * @remarks This function is designed to be a controlled \"all-in-one\" function that handles the entire process of calling an LLM to collaborative edit a SharedTree.\n *\n * @example\n * ```typescript\n * import {\n * \tSchemaFactory,\n * \tTreeViewConfiguration,\n * \ttype TreeView\n * } from \"@fluidframework/tree\";\n *\n * const sf = new SchemaFactory(\"todo-app\");\n *\n * class TodoTask extends sf.object(\"TodoTask\", {\n * \ttitle: sf.string,\n * \tdescription: sf.string,\n * }) {}\n *\n * class TodoAppState extends sf.object(\"TodoAppState\", {\n * \ttasks: sf.array(TodoTask),\n * }) {}\n *\n * // Initialize your SharedTree\n * const treeView: TreeView = tree.viewWith(new TreeViewConfiguration({ schema: TodoAppState }));\n * treeView.initialize({ tasks: [] });\n *\n * // Collaborate with AI in realtime in just one function call.\n * const response = await aiCollab({\n * \t\topenAI: {\n * \t\t\tclient: new OpenAI({\n * \t\t\t\tapiKey: OPENAI_API_KEY,\n * \t\t\t}),\n * \t\t\tmodelName: \"gpt-4o\",\n * \t\t},\n * \t\ttreeNode: view.root,\n * \t\tprompt: {\n * \t\t\tsystemRoleContext:\n * \t\t\t\t\"You are an helpful assistant managing a todo list for a user.\",\n * \t\t\tuserAsk: \"Create a set of new todos to plan a vacation to Cancun.\",\n * \t\t},\n * \t\tplanningStep: true,\n * \t\tfinalReviewStep: true,\n * \t\tdumpDebugLog: true,\n * \t});\n * ```\n *\n * @remarks Known Limitiations:\n * - Root level array nodes are not supported\n * - Nested arrays are not supported\n * - Primitive nodes are not supported, e.g. 'string', 'number', 'boolean'\n * - Your application's Shared Tree schema must have no more than 4 levels of nesting\n * - Optional nodes are not supported in the Shared Tree schema\n * - Union types are not supported in the Shared Tree schema\n * - See README for more details.\n *\n * @alpha\n */\nexport async function aiCollab(\n\toptions: AiCollabOptions,\n): Promise<AiCollabSuccessResponse | AiCollabErrorResponse> {\n\tconst response = await generateTreeEdits({\n\t\ttreeNode: options.treeNode,\n\t\tvalidator: options.validator,\n\t\topenAI: options.openAI,\n\t\tprompt: options.prompt,\n\t\tlimiters: options.limiters,\n\t\tdumpDebugLog: options.dumpDebugLog,\n\t\tplanningStep: options.planningStep,\n\t\tfinalReviewStep: options.finalReviewStep,\n\t});\n\n\treturn response;\n}\n"]}

package/dist/aiCollabApi.d.ts

@@ -0,0 +1,173 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { TreeNode } from "@fluidframework/tree";
+import type OpenAI from "openai";
+/**
+ * OpenAI client options for the {@link AiCollabOptions} interface.
+ *
+ * @alpha
+ */
+export interface OpenAiClientOptions {
+    /**
+     * The OpenAI client to use for the AI collaboration.
+     */
+    client: OpenAI;
+    /**
+     * The name of the target OpenAI model to use for the AI collaboration.
+     */
+    modelName?: string;
+}
+/**
+ * Options for the AI collaboration.
+ *
+ * @alpha
+ */
+export interface AiCollabOptions {
+    /**
+     * The OpenAI client options to use for the LLM based AI collaboration.
+     */
+    readonly openAI: OpenAiClientOptions;
+    /**
+     * The specific tree node you want the AI to collaborate on. Pass the root node of your tree if you intend
+     * for the AI to work on the entire tree.
+     * @remarks
+     * - Optional root nodes are not supported
+     * - Primitive root nodes are not supported
+     */
+    readonly treeNode: TreeNode;
+    /**
+     * The prompt context to give the LLM in order to collaborate with your applications data.
+     */
+    readonly prompt: {
+        /**
+         * The context to give the LLM about its role in the collaboration.
+         * @remarks It's highly recommended to give context about your applications data model and the LLM's role in the collaboration.
+         */
+        readonly systemRoleContext: string;
+        /**
+         * The request from the users to the LLM.
+         */
+        readonly userAsk: string;
+    };
+    /**
+     * Limiters are various optional ways to limit this library's usage of the LLM.
+     */
+    readonly limiters?: {
+        /**
+         * An optional AbortController that can be used to abort the AI collaboration while it is still in progress.
+         */
+        readonly abortController?: AbortController;
+        /**
+         * The maximum number of sequential errors the LLM can make before aborting the collaboration.
+         * If the maximum number of sequential errors is reached, the AI collaboration will be aborted and return with the errorMessage 'tooManyErrors'.
+         * Leaving this undefined will disable this limiter.
+         */
+        readonly maxSequentialErrors?: number;
+        /**
+         * The maximum number of model calls the LLM can make before aborting the collaboration.
+         * If the maximum number of model calls is reached, the AI collaboration will be aborted and return with the errorMessage 'tooManyModelCalls'.
+         * Leaving this undefined will disable this limiter.
+         */
+        readonly maxModelCalls?: number;
+        /**
+         * The maximum token usage limits for the LLM.
+         * If the LLM exceeds the token limits, the AI collaboration will be aborted and return with the errorMessage 'tokenLimitExceeded'.
+         * This happens after the first model call's token usage is calculated, meaning that the limits set may be exceeded by a certain amount.
+         * Leaving this undefined will disable this limiter.
+         */
+        readonly tokenLimits?: TokenLimits;
+    };
+    /**
+     * When set to true, the LLM will be asked to first produce a plan, based on the user's ask, before generating any changes to your applications data.
+     * This can help the LLM produce better results.
+     * When set to false, the LLM will not be asked to produce a plan.
+     */
+    readonly planningStep?: boolean;
+    /**
+     * When set to true, the LLM will be asked to complete a final review of the changes and determine if any additional changes need to be made.
+     * When set to false, the LLM will not be asked to complete a final review.
+     */
+    readonly finalReviewStep?: boolean;
+    /**
+     * An optional validator function that can be used to validate the new content produced by the LLM.
+     */
+    readonly validator?: (newContent: TreeNode) => void;
+    /**
+     * When enabled, the library will console.log information useful for debugging the AI collaboration.
+     */
+    readonly dumpDebugLog?: boolean;
+}
+/**
+ * A successful response from the AI collaboration.
+ *
+ * @alpha
+ */
+export interface AiCollabSuccessResponse {
+    /**
+     * The status of the Ai Collaboration.
+     * A 'success' status indicates that the AI collaboration was successful at creating changes.
+     */
+    readonly status: "success";
+    /**
+     * {@inheritDoc TokenUsage}
+     */
+    readonly tokensUsed: TokenUsage;
+}
+/**
+ * An error response from the AI collaboration.
+ *
+ * @alpha
+ */
+export interface AiCollabErrorResponse {
+    /**
+     * The status of the Ai Collaboration.
+     * - A 'partial-failure' status indicates that the AI collaboration was partially successful, but was aborted due to a limiter or other error
+     * - A "failure" status indicates that the AI collaboration was not successful at creating any changes.
+     */
+    readonly status: "failure" | "partial-failure";
+    /**
+     * The type of known error that occured
+     * - 'tokenLimitExceeded' indicates that the LLM exceeded the token limits set by the user
+     * - 'tooManyErrors' indicates that the LLM made too many errors in a row
+     * - 'tooManyModelCalls' indicates that the LLM made too many model calls
+     * - 'aborted' indicates that the AI collaboration was aborted by the user or a limiter
+     */
+    readonly errorMessage: "tokenLimitExceeded" | "tooManyErrors" | "tooManyModelCalls" | "aborted";
+    /**
+     * {@inheritDoc TokenUsage}
+     */
+    readonly tokensUsed: TokenUsage;
+}
+/**
+ * Total usage of tokens by an LLM.
+ *
+ * @alpha
+ */
+export interface TokenUsage {
+    /**
+     * The total number of tokens used by the LLM for input.
+     */
+    inputTokens: number;
+    /**
+     * The total number of tokens used by the LLM for output.
+     */
+    outputTokens: number;
+}
+/**
+ * Maximum limits for the total tokens that can be used by an llm
+ *
+ * @alpha
+ */
+export interface TokenLimits {
+    /**
+     * The maximum number of tokens that can be used by the LLM for input.
+     */
+    readonly inputTokens?: number;
+    /**
+     * The maximum number of tokens that can be used by the LLM for output.
+     */
+    readonly outputTokens?: number;
+}
+//# sourceMappingURL=aiCollabApi.d.ts.map

package/dist/aiCollabApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aiCollabApi.d.ts","sourceRoot":"","sources":["../src/aiCollabApi.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAErD,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AAEjC;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IACrC;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE;QAChB;;;WAGG;QACH,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;QACnC;;WAEG;QACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;KACzB,CAAC;IACF;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE;QACnB;;WAEG;QACH,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC;QAC3C;;;;WAIG;QACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;QACtC;;;;WAIG;QACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;QAChC;;;;;WAKG;QACH,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC;KACnC,CAAC;IACF;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,UAAU,EAAE,QAAQ,KAAK,IAAI,CAAC;IACpD;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACrC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,iBAAiB,CAAC;IAC/C;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,EAClB,oBAAoB,GACpB,eAAe,GACf,mBAAmB,GACnB,SAAS,CAAC;IACb;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAC/B"}

package/dist/aiCollabApi.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=aiCollabApi.js.map

package/dist/aiCollabApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aiCollabApi.js","sourceRoot":"","sources":["../src/aiCollabApi.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { TreeNode } from \"@fluidframework/tree\";\n// eslint-disable-next-line import/no-named-as-default\nimport type OpenAI from \"openai\";\n\n/**\n * OpenAI client options for the {@link AiCollabOptions} interface.\n *\n * @alpha\n */\nexport interface OpenAiClientOptions {\n\t/**\n\t * The OpenAI client to use for the AI collaboration.\n\t */\n\tclient: OpenAI;\n\t/**\n\t * The name of the target OpenAI model to use for the AI collaboration.\n\t */\n\tmodelName?: string;\n}\n\n/**\n * Options for the AI collaboration.\n *\n * @alpha\n */\nexport interface AiCollabOptions {\n\t/**\n\t * The OpenAI client options to use for the LLM based AI collaboration.\n\t */\n\treadonly openAI: OpenAiClientOptions;\n\t/**\n\t * The specific tree node you want the AI to collaborate on. Pass the root node of your tree if you intend\n\t * for the AI to work on the entire tree.\n\t * @remarks\n\t * - Optional root nodes are not supported\n\t * - Primitive root nodes are not supported\n\t */\n\treadonly treeNode: TreeNode;\n\t/**\n\t * The prompt context to give the LLM in order to collaborate with your applications data.\n\t */\n\treadonly prompt: {\n\t\t/**\n\t\t * The context to give the LLM about its role in the collaboration.\n\t\t * @remarks It's highly recommended to give context about your applications data model and the LLM's role in the collaboration.\n\t\t */\n\t\treadonly systemRoleContext: string;\n\t\t/**\n\t\t * The request from the users to the LLM.\n\t\t */\n\t\treadonly userAsk: string;\n\t};\n\t/**\n\t * Limiters are various optional ways to limit this library's usage of the LLM.\n\t */\n\treadonly limiters?: {\n\t\t/**\n\t\t * An optional AbortController that can be used to abort the AI collaboration while it is still in progress.\n\t\t */\n\t\treadonly abortController?: AbortController;\n\t\t/**\n\t\t * The maximum number of sequential errors the LLM can make before aborting the collaboration.\n\t\t * If the maximum number of sequential errors is reached, the AI collaboration will be aborted and return with the errorMessage 'tooManyErrors'.\n\t\t * Leaving this undefined will disable this limiter.\n\t\t */\n\t\treadonly maxSequentialErrors?: number;\n\t\t/**\n\t\t * The maximum number of model calls the LLM can make before aborting the collaboration.\n\t\t * If the maximum number of model calls is reached, the AI collaboration will be aborted and return with the errorMessage 'tooManyModelCalls'.\n\t\t * Leaving this undefined will disable this limiter.\n\t\t */\n\t\treadonly maxModelCalls?: number;\n\t\t/**\n\t\t * The maximum token usage limits for the LLM.\n\t\t * If the LLM exceeds the token limits, the AI collaboration will be aborted and return with the errorMessage 'tokenLimitExceeded'.\n\t\t * This happens after the first model call's token usage is calculated, meaning that the limits set may be exceeded by a certain amount.\n\t\t * Leaving this undefined will disable this limiter.\n\t\t */\n\t\treadonly tokenLimits?: TokenLimits;\n\t};\n\t/**\n\t * When set to true, the LLM will be asked to first produce a plan, based on the user's ask, before generating any changes to your applications data.\n\t * This can help the LLM produce better results.\n\t * When set to false, the LLM will not be asked to produce a plan.\n\t */\n\treadonly planningStep?: boolean;\n\t/**\n\t * When set to true, the LLM will be asked to complete a final review of the changes and determine if any additional changes need to be made.\n\t * When set to false, the LLM will not be asked to complete a final review.\n\t */\n\treadonly finalReviewStep?: boolean;\n\t/**\n\t * An optional validator function that can be used to validate the new content produced by the LLM.\n\t */\n\treadonly validator?: (newContent: TreeNode) => void;\n\t/**\n\t * When enabled, the library will console.log information useful for debugging the AI collaboration.\n\t */\n\treadonly dumpDebugLog?: boolean;\n}\n\n/**\n * A successful response from the AI collaboration.\n *\n * @alpha\n */\nexport interface AiCollabSuccessResponse {\n\t/**\n\t * The status of the Ai Collaboration.\n\t * A 'success' status indicates that the AI collaboration was successful at creating changes.\n\t */\n\treadonly status: \"success\";\n\t/**\n\t * {@inheritDoc TokenUsage}\n\t */\n\treadonly tokensUsed: TokenUsage;\n}\n\n/**\n * An error response from the AI collaboration.\n *\n * @alpha\n */\nexport interface AiCollabErrorResponse {\n\t/**\n\t * The status of the Ai Collaboration.\n\t * - A 'partial-failure' status indicates that the AI collaboration was partially successful, but was aborted due to a limiter or other error\n\t * - A \"failure\" status indicates that the AI collaboration was not successful at creating any changes.\n\t */\n\treadonly status: \"failure\" | \"partial-failure\";\n\t/**\n\t * The type of known error that occured\n\t * - 'tokenLimitExceeded' indicates that the LLM exceeded the token limits set by the user\n\t * - 'tooManyErrors' indicates that the LLM made too many errors in a row\n\t * - 'tooManyModelCalls' indicates that the LLM made too many model calls\n\t * - 'aborted' indicates that the AI collaboration was aborted by the user or a limiter\n\t */\n\treadonly errorMessage:\n\t\t| \"tokenLimitExceeded\"\n\t\t| \"tooManyErrors\"\n\t\t| \"tooManyModelCalls\"\n\t\t| \"aborted\";\n\t/**\n\t * {@inheritDoc TokenUsage}\n\t */\n\treadonly tokensUsed: TokenUsage;\n}\n\n/**\n * Total usage of tokens by an LLM.\n *\n * @alpha\n */\nexport interface TokenUsage {\n\t/**\n\t * The total number of tokens used by the LLM for input.\n\t */\n\tinputTokens: number;\n\t/**\n\t * The total number of tokens used by the LLM for output.\n\t */\n\toutputTokens: number;\n}\n\n/**\n * Maximum limits for the total tokens that can be used by an llm\n *\n * @alpha\n */\nexport interface TokenLimits {\n\t/**\n\t * The maximum number of tokens that can be used by the LLM for input.\n\t */\n\treadonly inputTokens?: number;\n\t/**\n\t * The maximum number of tokens that can be used by the LLM for output.\n\t */\n\treadonly outputTokens?: number;\n}\n"]}

package/dist/alpha.d.ts

@@ -0,0 +1,41 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
+ */
+
+/**
+ * Experimental package for utilities that enable/simplify interaction with LLMs for apps based on SharedTree.
+ *
+ * See {@link https://github.com/microsoft/FluidFramework/tree/main/packages/framework/ai-collab#readme | README.md }
+ * for an overview of the package.
+ *
+ * @packageDocumentation
+ */
+
+export {
+	// @alpha APIs
+	AiCollabErrorResponse, 
+	AiCollabOptions, 
+	AiCollabSuccessResponse, 
+	Difference, 
+	DifferenceChange, 
+	DifferenceCreate, 
+	DifferenceMove, 
+	DifferenceRemove, 
+	ObjectPath, 
+	OpenAiClientOptions, 
+	Options, 
+	SharedTreeBranchManager, 
+	TokenLimits, 
+	TokenUsage, 
+	aiCollab, 
+	createMergableDiffSeries, 
+	createMergableIdDiffSeries, 
+	sharedTreeDiff, 
+	sharedTreeTraverse
+} from "./index.js";

package/dist/explicit-strategy/agentEditReducer.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { type TreeNode, type SimpleNodeSchema } from "@fluidframework/tree/internal";
+import { type TreeEdit } from "./agentEditTypes.js";
+import type { IdGenerator } from "./idGenerator.js";
+/**
+ * Manages applying the various types of {@link TreeEdit}'s to a a given {@link TreeNode}.
+ */
+export declare function applyAgentEdit(treeEdit: TreeEdit, idGenerator: IdGenerator, definitionMap: ReadonlyMap<string, SimpleNodeSchema>, validator?: (edit: TreeNode) => void): TreeEdit;
+//# sourceMappingURL=agentEditReducer.d.ts.map

package/dist/explicit-strategy/agentEditReducer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agentEditReducer.d.ts","sourceRoot":"","sources":["../../src/explicit-strategy/agentEditReducer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAKN,KAAK,QAAQ,EAEb,KAAK,gBAAgB,EAWrB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACN,KAAK,QAAQ,EASb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AA6DpD;;GAEG;AACH,wBAAgB,cAAc,CAC7B,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,WAAW,CAAC,MAAM,EAAE,gBAAgB,CAAC,EACpD,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,GAClC,QAAQ,CAyMV"}