@aigne/agent-library 1.24.0-beta.4 → 1.24.0-beta.6

package/CHANGELOG.md

@@ -7,6 +7,28 @@
     * @aigne/core bumped to 1.22.0
     * @aigne/openai bumped to 0.3.4
 
+## [1.24.0-beta.6](https://github.com/AIGNE-io/aigne-framework/compare/agent-library-v1.24.0-beta.5...agent-library-v1.24.0-beta.6) (2025-12-25)
+
+
+### Bug Fixes
+
+* **agent-library:** add header field and use object-based answers in AskUserQuestion ([#851](https://github.com/AIGNE-io/aigne-framework/issues/851)) ([095db95](https://github.com/AIGNE-io/aigne-framework/commit/095db95e43b5d39b35c638d90d6f0b99565e0dc4))
+
+## [1.24.0-beta.5](https://github.com/AIGNE-io/aigne-framework/compare/agent-library-v1.24.0-beta.4...agent-library-v1.24.0-beta.5) (2025-12-25)
+
+
+### Features
+
+* **agent-library:** add askUserQuestion agent ([#848](https://github.com/AIGNE-io/aigne-framework/issues/848)) ([60fa69b](https://github.com/AIGNE-io/aigne-framework/commit/60fa69b40ec122295e57ad175075875ed4840345))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/core bumped to 1.72.0-beta.5
+    * @aigne/openai bumped to 0.16.16-beta.5
+
 ## [1.24.0-beta.4](https://github.com/AIGNE-io/aigne-framework/compare/agent-library-v1.24.0-beta.3...agent-library-v1.24.0-beta.4) (2025-12-24)
 
 

package/lib/cjs/ask-user-question/index.d.ts

@@ -0,0 +1,27 @@
+import { Agent, type AgentInvokeOptions, type AgentProcessResult, type Message } from "@aigne/core";
+import { z } from "zod";
+export interface AskUserQuestionAgentOption {
+    label: string;
+    description?: string;
+}
+export interface AskUserQuestionAgentInput extends Message {
+    questions: {
+        header: string;
+        question: string;
+        options?: AskUserQuestionAgentOption[];
+        multipleSelect?: boolean;
+    }[];
+    allowCustomAnswer?: boolean;
+}
+export interface AskUserQuestionAgentOutput extends Message {
+    answers: Record<string, string>;
+}
+export default class AskUserQuestionAgent extends Agent<AskUserQuestionAgentInput, AskUserQuestionAgentOutput> {
+    tag: string;
+    static schema(): z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+    static load<I extends Message = any, O extends Message = any>(options: {
+        filepath: string;
+        parsed: object;
+    }): Promise<Agent<I, O>>;
+    process(input: AskUserQuestionAgentInput, options: AgentInvokeOptions): Promise<AgentProcessResult<AskUserQuestionAgentOutput>>;
+}

package/lib/cjs/ask-user-question/index.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@aigne/core");
+const schema_js_1 = require("@aigne/core/loader/schema.js");
+const zod_1 = require("zod");
+const askUserQuestionAgentOptionSchema = zod_1.z.object({
+    label: zod_1.z.string().describe("The display text for this option (1-5 words)"),
+    description: (0, schema_js_1.optionalize)(zod_1.z.string()).describe("Explanation of what this option means"),
+});
+const askUserQuestionAgentInputSchema = zod_1.z.object({
+    questions: zod_1.z
+        .array(zod_1.z.object({
+        header: zod_1.z
+            .string()
+            .describe("Very short label (max 12 chars) used as key in answers. Examples: 'Auth method', 'Library', 'Approach'"),
+        question: zod_1.z.string().describe("The question to ask the user"),
+        options: (0, schema_js_1.optionalize)(zod_1.z.array(askUserQuestionAgentOptionSchema)).describe("List of options to present to the user"),
+        multipleSelect: (0, schema_js_1.optionalize)(zod_1.z.boolean()).describe("Whether to allow multiple selections"),
+    }))
+        .describe("List of questions to ask the user"),
+    allowCustomAnswer: (0, schema_js_1.optionalize)(zod_1.z.boolean()).describe("Whether to allow the user to provide custom answers"),
+});
+class AskUserQuestionAgent extends core_1.Agent {
+    tag = "AskUserQuestion";
+    static schema() {
+        return zod_1.z.object({});
+    }
+    static async load(options) {
+        return new AskUserQuestionAgent({
+            name: defaultName,
+            description: defaultDescription,
+            ...options.parsed,
+            inputSchema: askUserQuestionAgentInputSchema,
+        });
+    }
+    async process(input, options) {
+        const { prompts } = options;
+        if (!prompts)
+            throw new Error("Prompts is not available in AskUserQuestionAgent");
+        const { questions, allowCustomAnswer } = input;
+        const answers = {};
+        for (const q of questions) {
+            let answer;
+            if (q.options?.length) {
+                const choices = q.options.map((opt) => ({
+                    value: opt.label,
+                    name: opt.label,
+                    description: opt.description ?? opt.label,
+                }));
+                if (allowCustomAnswer) {
+                    choices.push({
+                        name: "None of the above / Enter my own response",
+                        value: "OTHER_OPTION",
+                    });
+                }
+                if (!q.multipleSelect) {
+                    answer = await prompts.select({
+                        message: q.question,
+                        choices,
+                    });
+                }
+                else {
+                    answer = await prompts.checkbox({
+                        message: q.question,
+                        choices,
+                    });
+                }
+                if (answer === "OTHER_OPTION" ||
+                    (Array.isArray(answer) && answer.includes("OTHER_OPTION"))) {
+                    answer = await prompts.input({
+                        message: `Please provide your response for: ${q.question}`,
+                    });
+                }
+            }
+            else {
+                answer = await prompts.input({
+                    message: q.question,
+                });
+            }
+            answers[q.header] = Array.isArray(answer) ? answer.join(", ") : answer;
+        }
+        return {
+            answers,
+        };
+    }
+}
+exports.default = AskUserQuestionAgent;
+const defaultName = "askUserQuestion";
+const defaultDescription = `\
+Use this tool when you need to ask the user questions during execution. This allows you to:
+1. Gather user preferences or requirements
+2. Clarify ambiguous instructions
+3. Get decisions on implementation choices as you work
+4. Offer choices to the user about what direction to take.
+
+Usage notes:
+- Users will always be able to select "Other" to provide custom text input
+- Use multiSelect: true to allow multiple answers to be selected for a question
+- If you recommend a specific option, make that the first option in the list and add "(Recommended)" at the end of the label
+`;

package/lib/dts/ask-user-question/index.d.ts

@@ -0,0 +1,27 @@
+import { Agent, type AgentInvokeOptions, type AgentProcessResult, type Message } from "@aigne/core";
+import { z } from "zod";
+export interface AskUserQuestionAgentOption {
+    label: string;
+    description?: string;
+}
+export interface AskUserQuestionAgentInput extends Message {
+    questions: {
+        header: string;
+        question: string;
+        options?: AskUserQuestionAgentOption[];
+        multipleSelect?: boolean;
+    }[];
+    allowCustomAnswer?: boolean;
+}
+export interface AskUserQuestionAgentOutput extends Message {
+    answers: Record<string, string>;
+}
+export default class AskUserQuestionAgent extends Agent<AskUserQuestionAgentInput, AskUserQuestionAgentOutput> {
+    tag: string;
+    static schema(): z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+    static load<I extends Message = any, O extends Message = any>(options: {
+        filepath: string;
+        parsed: object;
+    }): Promise<Agent<I, O>>;
+    process(input: AskUserQuestionAgentInput, options: AgentInvokeOptions): Promise<AgentProcessResult<AskUserQuestionAgentOutput>>;
+}

package/lib/esm/ask-user-question/index.d.ts

@@ -0,0 +1,27 @@
+import { Agent, type AgentInvokeOptions, type AgentProcessResult, type Message } from "@aigne/core";
+import { z } from "zod";
+export interface AskUserQuestionAgentOption {
+    label: string;
+    description?: string;
+}
+export interface AskUserQuestionAgentInput extends Message {
+    questions: {
+        header: string;
+        question: string;
+        options?: AskUserQuestionAgentOption[];
+        multipleSelect?: boolean;
+    }[];
+    allowCustomAnswer?: boolean;
+}
+export interface AskUserQuestionAgentOutput extends Message {
+    answers: Record<string, string>;
+}
+export default class AskUserQuestionAgent extends Agent<AskUserQuestionAgentInput, AskUserQuestionAgentOutput> {
+    tag: string;
+    static schema(): z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+    static load<I extends Message = any, O extends Message = any>(options: {
+        filepath: string;
+        parsed: object;
+    }): Promise<Agent<I, O>>;
+    process(input: AskUserQuestionAgentInput, options: AgentInvokeOptions): Promise<AgentProcessResult<AskUserQuestionAgentOutput>>;
+}

package/lib/esm/ask-user-question/index.js

@@ -0,0 +1,97 @@
+import { Agent } from "@aigne/core";
+import { optionalize } from "@aigne/core/loader/schema.js";
+import { z } from "zod";
+const askUserQuestionAgentOptionSchema = z.object({
+    label: z.string().describe("The display text for this option (1-5 words)"),
+    description: optionalize(z.string()).describe("Explanation of what this option means"),
+});
+const askUserQuestionAgentInputSchema = z.object({
+    questions: z
+        .array(z.object({
+        header: z
+            .string()
+            .describe("Very short label (max 12 chars) used as key in answers. Examples: 'Auth method', 'Library', 'Approach'"),
+        question: z.string().describe("The question to ask the user"),
+        options: optionalize(z.array(askUserQuestionAgentOptionSchema)).describe("List of options to present to the user"),
+        multipleSelect: optionalize(z.boolean()).describe("Whether to allow multiple selections"),
+    }))
+        .describe("List of questions to ask the user"),
+    allowCustomAnswer: optionalize(z.boolean()).describe("Whether to allow the user to provide custom answers"),
+});
+export default class AskUserQuestionAgent extends Agent {
+    tag = "AskUserQuestion";
+    static schema() {
+        return z.object({});
+    }
+    static async load(options) {
+        return new AskUserQuestionAgent({
+            name: defaultName,
+            description: defaultDescription,
+            ...options.parsed,
+            inputSchema: askUserQuestionAgentInputSchema,
+        });
+    }
+    async process(input, options) {
+        const { prompts } = options;
+        if (!prompts)
+            throw new Error("Prompts is not available in AskUserQuestionAgent");
+        const { questions, allowCustomAnswer } = input;
+        const answers = {};
+        for (const q of questions) {
+            let answer;
+            if (q.options?.length) {
+                const choices = q.options.map((opt) => ({
+                    value: opt.label,
+                    name: opt.label,
+                    description: opt.description ?? opt.label,
+                }));
+                if (allowCustomAnswer) {
+                    choices.push({
+                        name: "None of the above / Enter my own response",
+                        value: "OTHER_OPTION",
+                    });
+                }
+                if (!q.multipleSelect) {
+                    answer = await prompts.select({
+                        message: q.question,
+                        choices,
+                    });
+                }
+                else {
+                    answer = await prompts.checkbox({
+                        message: q.question,
+                        choices,
+                    });
+                }
+                if (answer === "OTHER_OPTION" ||
+                    (Array.isArray(answer) && answer.includes("OTHER_OPTION"))) {
+                    answer = await prompts.input({
+                        message: `Please provide your response for: ${q.question}`,
+                    });
+                }
+            }
+            else {
+                answer = await prompts.input({
+                    message: q.question,
+                });
+            }
+            answers[q.header] = Array.isArray(answer) ? answer.join(", ") : answer;
+        }
+        return {
+            answers,
+        };
+    }
+}
+const defaultName = "askUserQuestion";
+const defaultDescription = `\
+Use this tool when you need to ask the user questions during execution. This allows you to:
+1. Gather user preferences or requirements
+2. Clarify ambiguous instructions
+3. Get decisions on implementation choices as you work
+4. Offer choices to the user about what direction to take.
+
+Usage notes:
+- Users will always be able to select "Other" to provide custom text input
+- Use multiSelect: true to allow multiple answers to be selected for a question
+- If you recommend a specific option, make that the first option in the list and add "(Recommended)" at the end of the label
+`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/agent-library",
-  "version": "1.24.0-beta.4",
+  "version": "1.24.0-beta.6",
   "description": "Collection of agent libraries for AIGNE framework",
   "publishConfig": {
     "access": "public"
@@ -57,9 +57,9 @@
     "yaml": "^2.8.1",
     "zod": "^3.25.67",
     "zod-to-json-schema": "^3.24.6",
-    "@aigne/core": "^1.72.0-beta.4",
-    "@aigne/sqlite": "^0.4.9-beta",
-    "@aigne/openai": "^0.16.16-beta.4"
+    "@aigne/openai": "^0.16.16-beta.5",
+    "@aigne/core": "^1.72.0-beta.5",
+    "@aigne/sqlite": "^0.4.9-beta"
   },
   "devDependencies": {
     "@types/bun": "^1.2.22",