Switch Dispatcher command handler to use ActionContext (#145)

- Command handlers get an ActionContext (instead of just the CommandHandlerContext) - Remove special `executDispatcherCommand` and use the standard helper from the SDK. - Switch most dispatcher command handlers to use `ActionIO`. Remove `RequestIO` API that is no longer used. - Add `block` append mode for `appendDisplay`
microsoft · Sep 14, 2024 · 05569d2 · 05569d2
1 parent 9afa30a
commit 05569d2
Show file tree

Hide file tree

Showing 35 changed files with 740 additions and 536 deletions.
diff --git a/ts/packages/agentSdk/src/agentInterface.ts b/ts/packages/agentSdk/src/agentInterface.ts
@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+import { ActionIO, DisplayType, DynamicDisplay } from "./display.js";
 import { Profiler } from "./profiler.js";
 
 //==============================================================================
@@ -40,13 +41,6 @@ export interface AppActionWithParameters extends AppAction {
     parameters: { [key: string]: any };
 }
 
-export type DisplayType = "html" | "text";
-
-export type DynamicDisplay = {
-    content: DisplayContent;
-    nextRefreshMs: number; // in milliseconds, -1 means no more refresh.
-};
-
 export type CommandDescriptor = {
     description: string;
     help?: string;
@@ -152,19 +146,6 @@ export interface Storage {
     getTokenCachePersistence(): Promise<TokenCachePersistence>;
 }
 
-export type DisplayContent =
-    | string
-    | {
-          type: DisplayType;
-          content: string;
-      };
-
-export interface ActionIO {
-    readonly type: DisplayType;
-    setDisplay(content: DisplayContent): void;
-    appendDisplay(content: DisplayContent): void;
-}
-
 export interface ActionContext<T = void> {
     profiler?: Profiler | undefined;
     streamingContext: unknown;

diff --git a/ts/packages/agentSdk/src/display.ts b/ts/packages/agentSdk/src/display.ts
@@ -0,0 +1,24 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+export type DisplayType = "html" | "text";
+
+export type DynamicDisplay = {
+    content: DisplayContent;
+    nextRefreshMs: number; // in milliseconds, -1 means no more refresh.
+};
+
+export type DisplayContent =
+    | string
+    | {
+          type: DisplayType;
+          content: string;
+      };
+
+export type DisplayAppendMode = "inline" | "block" | "temporary";
+
+export interface ActionIO {
+    readonly type: DisplayType;
+    setDisplay(content: DisplayContent): void;
+    appendDisplay(content: DisplayContent, mode?: DisplayAppendMode): void;
+}
diff --git a/ts/packages/agentSdk/src/index.ts b/ts/packages/agentSdk/src/index.ts
@@ -15,13 +15,17 @@ export {
     StorageEncoding,
     TokenCachePersistence,
     ActionContext,
+    CommandDescriptor,
+    CommandDescriptorTable,
+} from "./agentInterface.js";
+
+export {
     ActionIO,
     DisplayType,
     DynamicDisplay,
     DisplayContent,
-    CommandDescriptor,
-    CommandDescriptorTable,
-} from "./agentInterface.js";
+    DisplayAppendMode,
+} from "./display.js";
 export * from "./memory.js";
 
 export { Profiler } from "./profiler.js";
diff --git a/ts/packages/agentSdk/src/memory.ts b/ts/packages/agentSdk/src/memory.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { DisplayContent } from "./agentInterface.js";
+import { DisplayContent } from "./display.js";
 
 export interface Entity {
     // the name of the entity such as "Bach" or "frog"

diff --git a/ts/packages/cli/src/commands/run/request.ts b/ts/packages/cli/src/commands/run/request.ts
@@ -2,10 +2,9 @@
 // Licensed under the MIT License.
 
 import { Args, Command, Flags } from "@oclif/core";
+import { createDispatcher } from "agent-dispatcher";
 import {
     getCacheFactory,
-    initializeCommandHandlerContext,
-    RequestCommandHandler,
     getBuiltinTranslatorNames,
 } from "agent-dispatcher/internal";
 import chalk from "chalk";
@@ -47,14 +46,14 @@ export default class RequestCommand extends Command {
         const translators = flags.translator
             ? Object.fromEntries(flags.translator.map((name) => [name, true]))
             : undefined;
-        const handler = new RequestCommandHandler();
-        await handler.run(
-            args.request,
-            await initializeCommandHandlerContext("cli run request", {
-                translators,
-                explainerName: flags.explainer,
-                cache: false,
-            }),
+        const dispatcher = await createDispatcher("cli run request", {
+            translators,
+            explainerName: flags.explainer,
+            cache: false,
+        });
+        await dispatcher.processCommand(
+            `@request ${args.request}`,
+            undefined,
             this.loadAttachment(args.attachment),
         );
     }

diff --git a/ts/packages/cli/src/commands/run/translate.ts b/ts/packages/cli/src/commands/run/translate.ts
@@ -2,11 +2,8 @@
 // Licensed under the MIT License.
 
 import { Args, Command, Flags } from "@oclif/core";
-import {
-    initializeCommandHandlerContext,
-    TranslateCommandHandler,
-    getBuiltinTranslatorNames,
-} from "agent-dispatcher/internal";
+import { createDispatcher } from "agent-dispatcher";
+import { getBuiltinTranslatorNames } from "agent-dispatcher/internal";
 
 export default class TranslateCommand extends Command {
     static args = {
@@ -32,17 +29,15 @@ export default class TranslateCommand extends Command {
 
     async run(): Promise<void> {
         const { args, flags } = await this.parse(TranslateCommand);
-        const handler = new TranslateCommandHandler();
         const translators = flags.translator
             ? Object.fromEntries(flags.translator.map((name) => [name, true]))
             : undefined;
-        await handler.run(
-            args.request,
-            await initializeCommandHandlerContext("cli run translate", {
-                translators,
-                actions: {}, // We don't need any actions
-                cache: false,
-            }),
-        );
+
+        const dispatcher = await createDispatcher("cli run translate", {
+            translators,
+            actions: {}, // We don't need any actions
+            cache: false,
+        });
+        await dispatcher.processCommand(`@translate ${args.request}`);
     }
 }
diff --git a/ts/packages/dispatcher/src/action/actionHandlers.ts b/ts/packages/dispatcher/src/action/actionHandlers.ts
@@ -16,6 +16,7 @@ import {
     DisplayType,
     DisplayContent,
     ActionContext,
+    DisplayAppendMode,
 } from "@typeagent/agent-sdk";
 import { MatchResult } from "agent-cache";
 import { getStorage } from "./storageImpl.js";
@@ -40,8 +41,16 @@ function getActionContext(
         setDisplay(content: DisplayContent): void {
             context.requestIO.setDisplay(content, actionIndex, appAgentName);
         },
-        appendDisplay(content: DisplayContent): void {
-            context.requestIO.appendDisplay(content, actionIndex, appAgentName);
+        appendDisplay(
+            content: DisplayContent,
+            mode: DisplayAppendMode = "inline",
+        ): void {
+            context.requestIO.appendDisplay(
+                content,
+                actionIndex,
+                appAgentName,
+                mode,
+            );
         },
     };
     return {

diff --git a/ts/packages/dispatcher/src/agent/agentProcess.ts b/ts/packages/dispatcher/src/agent/agentProcess.ts
@@ -11,6 +11,8 @@ import {
     TokenCachePersistence,
     ActionIO,
     DisplayType,
+    DisplayContent,
+    DisplayAppendMode,
     AppAgentEvent,
 } from "@typeagent/agent-sdk";
 
@@ -316,16 +318,17 @@ function getActionContextShim(
         get type(): DisplayType {
             return "text";
         },
-        setDisplay(content: string): void {
+        setDisplay(content: DisplayContent): void {
             rpc.send("setDisplay", {
                 actionContextId,
                 content,
             });
         },
-        appendDisplay(content: string): void {
+        appendDisplay(content: DisplayContent, mode?: DisplayAppendMode): void {
             rpc.send("appendDisplay", {
                 actionContextId,
                 content,
+                mode,
             });
         },
     };

diff --git a/ts/packages/dispatcher/src/agent/agentProcessShim.ts b/ts/packages/dispatcher/src/agent/agentProcessShim.ts
@@ -11,6 +11,7 @@ import {
     CommandDescriptor,
     CommandDescriptorTable,
     DisplayContent,
+    DisplayAppendMode,
 } from "@typeagent/agent-sdk";
 import {
     AgentCallFunctions,
@@ -235,10 +236,11 @@ export async function createAgentProcessShim(
         appendDisplay: (param: {
             actionContextId: number;
             message: DisplayContent;
+            mode: DisplayAppendMode;
         }) => {
             actionContextMap
                 .get(param.actionContextId)
-                .actionIO.appendDisplay(param.message);
+                .actionIO.appendDisplay(param.message, param.mode);
         },
     };
 

diff --git a/ts/packages/dispatcher/src/agent/agentProcessTypes.ts b/ts/packages/dispatcher/src/agent/agentProcessTypes.ts
@@ -3,6 +3,7 @@
 
 import {
     AppAgentEvent,
+    DisplayAppendMode,
     DisplayContent,
     DisplayType,
     StorageListOptions,
@@ -22,6 +23,7 @@ export type AgentContextCallFunctions = {
     appendDisplay: (param: {
         actionContextId: number;
         message: DisplayContent;
+        mode: DisplayAppendMode;
     }) => void;
 };