@arcgis/ai-components 5.1.0-next.98 → 5.1.0

package/dist/chunks/summarize_query_response_prompt.js

@@ -0,0 +1,80 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
+const e = `## Task: Summarize Geographic Features
+
+You are given features from ArcGIS Feature layer for multiple layers:  
+{queryResponse}
+
+## Input
+
+Assigned task:
+{assignedTask}
+
+Latest user request:
+{userRequest}
+
+Prior steps:
+{priorSteps}
+
+Use the assigned task as the primary instruction for the current query.
+Use the latest user request as supporting context when needed.
+Use prior steps only when the assigned task clearly depends on earlier results.
+Use chat history only when necessary to understand conversational references, and do not override the assigned task.
+
+### Your goal:
+
+1. If the assigned task is about a **specific calculation** (e.g., average, total, count, min, max), return a **single concise sentence** that includes the numeric result.
+
+- Example: “The average price is $4.00.”
+- Never return a bare number by itself (for example: \`4\`).
+- When a value is already present in \`queryResponse\` (for example in \`details.value\` or \`summary\`), copy that value **verbatim**.
+- Do NOT reformat values (including numbers, dates, and times):
+  - Do not add/remove grouping commas.
+  - Do not change decimals, round values, or change numeric type/text.
+  - Do not change date/time format, timezone notation, separators, or precision.
+
+2. If the question is more general or there are **multiple features with varying attributes**, write a **brief summary** (2–3 sentences max) that highlights key patterns or insights.
+
+3. The response can be per layer, or summarize based on the question.
+
+4. DO NOT ramble.
+
+5. If a \`geometryFilter\` is used, do NOT assume the feature referenced in that geometry (e.g., "ApplicationNumber = 'XYZ'") must appear in the results. It may only be used as a spatial anchor.
+
+Only describe what _was_ found — not what was _used to search_.
+
+6. If no feature \`attributes\` are returned but \`totalCount\` is present, assume the spatial filter was applied correctly. There is no need to say the subset was not returned — just summarize based on the count and available context.
+
+7. Do not give suggestions like exporting the results as the tools are not capable to do that.
+
+8. Format all responses using **Markdown** suitable for chat display.
+
+- Use bullet points for lists and use new lines (\\n) and appropriate formatting in your response.
+- Use Markdown emphasis (for example, **bold**) only when it improves clarity; keep formatting minimal and readable.
+- If results are best presented in rows/columns (for example, multiple features sharing the same fields), format them as a **Markdown table**.
+- The table must be valid Markdown with a header row and separator row (e.g., \`| Column |\` and \`| --- |\`).
+- Do not use plain aligned text, CSV-like output, or code fences for tabular data.
+
+9. Do NOT say things like "I can't change the map", "I can't highlight features", or suggest WHERE clauses for the user to run manually. A separate system handles map visualization automatically after this step. Your job is ONLY to summarize the data returned by the query.
+
+In all cases:
+
+- Focus on **notable attribute values**, **commonalities or differences**, and **interesting trends**.
+- If the feature list is empty or not meaningful, state that clearly.
+- Only use fields present in query results. Do not make guesses.
+
+### STRICT OUTPUT RULES
+
+- Do NOT ask follow-up questions.
+- Do NOT offer additional actions or suggestions.
+- Do NOT explain what you can do next.
+- Do NOT add conversational phrases.
+- Do NOT add any text beyond the requested summary or numeric answer.
+- End the response immediately after the summary.
+- Do NOT include introductory phrases (e.g., "Found", "Here are", "The results show").
+- Do NOT restate the assigned task or user’s question.
+- Use Markdown formatting for the response.
+- When presenting tabular data, output a valid Markdown table.
+`;
+export {
+  e as default
+};

package/dist/chunks/toolCallResponse.js

@@ -0,0 +1,32 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
+import "@arcgis/core/identity/IdentityManager.js";
+import "@arcgis/core/portal/Portal.js";
+import "@langchain/langgraph/web";
+import "@arcgis/toolkit/string";
+import "./generateLayerDescriptions.js";
+import "@langchain/core/messages";
+import { s as a } from "./index.js";
+import "@langchain/openai";
+import "@arcgis/core/config.js";
+import "@arcgis/core/core/reactiveUtils.js";
+import "@arcgis/core/layers/FeatureLayer.js";
+import "@arcgis/core/request.js";
+import "@langchain/core/prompts";
+const L = async (t, o) => {
+  const i = t.tool_calls ?? [];
+  if (i.length === 0) {
+    await a({ text: `LLM did not request any tool calls: ${String(t?.content)}` }, o);
+    return;
+  }
+  await Promise.all(
+    i.map(
+      async (r) => await a(
+        { text: `LLM invoked ${r.name} tool with arguments: ${JSON.stringify(r.args, null, 2)}` },
+        o
+      )
+    )
+  );
+};
+export {
+  L as h
+};

package/dist/chunks/utils.js

@@ -1,35 +1,53 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import { getClosestElement as a } from "@arcgis/toolkit/dom";
-import { g as i } from "./utils2.js";
-function o(e, t) {
-  const s = i(e.el, e.referenceElement);
-  if (s)
-    return s;
-  const n = a(e.el, "arcgis-assistant"), r = i(e.el, n?.referenceElement);
-  if (r)
-    return r;
-  throw new Error(`${t}: Reference element not found`);
+import { AIMessage as i } from "@langchain/core/messages";
+function p(e, s, t) {
+  return {
+    ...e,
+    status: s,
+    summary: t
+  };
 }
-function l(e, t) {
-  const n = o(e, t).view;
-  if (!n)
-    throw new Error(`${t}: Reference element does not have a view`);
-  return n;
+function f(e) {
+  const s = Object.entries(e).filter(
+    ([t, n]) => t !== "agentExecutionContext" && t !== "outputMessage" && t !== "summary" && t !== "status" && n !== void 0
+  );
+  if (s.length !== 0)
+    try {
+      return JSON.stringify(Object.fromEntries(s), null, 2);
+    } catch {
+      return;
+    }
 }
-function m(e) {
-  return typeof e == "function";
+function m(e, s, t = []) {
+  const n = s.safeParse(e);
+  if (n.success) {
+    const a = { ...n.data }, r = f(a), o = r ?? "LLMAgent produced structured output.", u = r ?? a.outputMessage, c = {
+      ...a,
+      ...u ? { outputMessage: u } : {},
+      agentExecutionContext: {
+        messages: [
+          ...t,
+          new i(typeof u == "string" && u.trim() ? u : o)
+        ]
+      }
+    };
+    return p(c, "success", o);
+  } else
+    throw new Error(`LLMAgent output schema validation failed: ${n.error.message}`);
 }
-function g(e) {
-  const t = a(e.el, "arcgis-assistant");
-  if (t === void 0)
-    throw new Error("arcgis-assistant-agent must be used within an arcgis-assistant element");
-  t.register({
-    agent: e.agent,
-    getContext: async () => await e.getContext?.() ?? e.context ?? {}
-  });
+function l(e, s) {
+  const t = {
+    outputMessage: e.outputMessage
+  };
+  if (s) {
+    const n = s.shape, a = e;
+    for (const r of Object.keys(n ?? {}))
+      r in e && (t[r] = a[r]);
+  }
+  return t;
 }
 export {
-  g as a,
-  m as i,
-  l as r
+  p as c,
+  l as g,
+  m as h
 };

package/dist/chunks/utils2.js

@@ -1,12 +1,47 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
 import { getClosestElement as i } from "@arcgis/toolkit/dom";
-function r(s, o) {
-  return o ? typeof o == "string" ? l(s, o) ?? null : o : i(s, "arcgis-map") ?? null;
+import { g as s, a as o } from "./utils3.js";
+function c(e, t) {
+  const r = s(e.el, e.referenceElement);
+  if (r)
+    return r;
+  const n = i(e.el, "arcgis-assistant"), a = s(e.el, n?.referenceElement);
+  if (a)
+    return a;
+  throw new Error(`${t}: Reference element not found`);
 }
-function l(s, o) {
-  const u = o.includes("#") || o.includes(".") || o.includes("["), t = s.getRootNode();
-  return (u ? void 0 : t.querySelector(`#${o}`)) ?? t.querySelector(o) ?? void 0;
+function m(e, t) {
+  const n = c(e, t).view;
+  if (!n)
+    throw new Error(`${t}: Reference element does not have a view`);
+  return n;
+}
+function w(e) {
+  return typeof e == "function";
+}
+function g(e) {
+  const t = i(e.el, "arcgis-assistant");
+  if (t === void 0)
+    throw new Error("arcgis-assistant-agent must be used within an arcgis-assistant element");
+  return t.register({
+    agent: e.agent,
+    getContext: async () => await e.getContext?.() ?? e.context ?? {}
+  }), t;
+}
+function l(e) {
+  const t = o(e.el, e.referenceElement);
+  if (t)
+    return t;
+  const r = i(e.el, "arcgis-assistant"), n = s(e.el, r?.referenceElement);
+  return n || null;
+}
+function v(e) {
+  const t = l(e);
+  return t ? t.view : null;
 }
 export {
-  r as g
+  g as a,
+  v as b,
+  w as i,
+  m as r
 };

package/dist/chunks/utils3.js

@@ -0,0 +1,16 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
+import { getClosestElement as s } from "@arcgis/toolkit/dom";
+function l(t, o) {
+  return o ? typeof o == "string" ? u(t, o) ?? null : o : s(t, "arcgis-map") ?? null;
+}
+function n(t, o) {
+  return o ? typeof o == "string" ? u(t, o) ?? null : o : s(t, "arcgis-link-chart") ?? s(t, "arcgis-map") ?? null;
+}
+function u(t, o) {
+  const r = o.includes("#") || o.includes(".") || o.includes("["), i = t.getRootNode();
+  return (r ? void 0 : i.querySelector(`#${o}`)) ?? i.querySelector(o) ?? void 0;
+}
+export {
+  n as a,
+  l as g
+};

package/dist/components/arcgis-assistant/customElement.d.ts

@@ -89,14 +89,34 @@ export abstract class ArcgisAssistant extends LitElement {
       stopButtonLabel: string;
       askButtonLabel: string;
   }>;
-  /** @default false */
+  /**
+   * When `true`, disables the assistant avatar in the chat interface.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor assistantAvatarEnabled: boolean;
+  /**
+   * Indicates whether the assistant is currently processing a user message.
+   * This value is `true` while the assistant is generating a response and `false` when idle.
+   *
+   * @default false
+   * @since 5.1
+   */
   get awaitingResponse(): boolean;
+  /**
+   * The current processing status message shown while the assistant is generating a response.
+   * This can be used to display progress details such as the current step in processing.
+   *
+   * @since 5.1
+   */
   get awaitingResponseStep(): string;
   /**
    * When `true`, enables the copy action that, when clicked, copies the content of the message to the clipboard. This can be helpful for users to easily copy and share
    * information provided by the assistant, such as a summary of findings, a set of instructions, or any other relevant details. Enabling this property can enhance the user experience by providing a convenient way for users to capture and utilize the information generated by the assistant.
    *
    * @default false
+   * @since 5.0
    * @example
    * ```html
    * <arcgis-assistant copy-enabled></arcgis-assistant>
@@ -112,6 +132,7 @@ export abstract class ArcgisAssistant extends LitElement {
    * The description text displayed below the heading in the assistant. This text provides additional
    * context about the assistant's capabilities and how users can interact with it.
    *
+   * @since 5.0
    * @example
    * ```html
    * <arcgis-assistant description="Explore parcel data ownership, zoning designations, and other relevant information."></arcgis-assistant>
@@ -129,6 +150,7 @@ export abstract class ArcgisAssistant extends LitElement {
    * the entry message will be closed and replaced with the chat interface. You can use this property to provide
    * instructions, suggest prompts, or simply welcome users to the assistant.
    *
+   * @since 5.0
    * @example
    * ```html
    * <arcgis-assistant entry-message="I can answer questions about parcel ownership, zoning, and other relevant information."></arcgis-assistant>
@@ -147,6 +169,7 @@ export abstract class ArcgisAssistant extends LitElement {
    * through a custom interface and log it to a database or service for later analysis.
    *
    * @default false
+   * @since 5.0
    * @example
    * ```html
    * <arcgis-assistant feedback-enabled></arcgis-assistant>
@@ -171,6 +194,7 @@ export abstract class ArcgisAssistant extends LitElement {
    * GUI, the heading should be more specific to the assistant's function to avoid confusion with the overall
    * application title.
    *
+   * @since 5.0
    * @example
    * ```html
    * <arcgis-assistant heading="Parcel Viewer"></arcgis-assistant>
@@ -187,6 +211,8 @@ export abstract class ArcgisAssistant extends LitElement {
    * Applications rendering custom interrupt UI through the `interrupt` slot can read this value
    * and call [submitInterrupt()](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/#submitInterrupt) or [cancelInterrupt()](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/#cancelInterrupt)
    * to respond.
+   *
+   * @since 5.1
    */
   get interrupt(): Interrupt | null;
   /**
@@ -194,6 +220,7 @@ export abstract class ArcgisAssistant extends LitElement {
    * when the user submits a message.
    *
    * @default false
+   * @since 5.0
    * @example
    * ```html
    * <arcgis-assistant keep-suggested-prompts></arcgis-assistant>
@@ -215,6 +242,7 @@ export abstract class ArcgisAssistant extends LitElement {
    * logs while non-technical audiences may find them overwhelming or confusing.
    *
    * @default false
+   * @since 5.0
    * @example
    * ```html
    * <arcgis-assistant log-enabled></arcgis-assistant>
@@ -232,15 +260,16 @@ export abstract class ArcgisAssistant extends LitElement {
    * and are used to provide context for the conversation. When a user submits a message, it is added to this
    * collection with the role of "user". When the assistant generates a response, it is added to this collection
    * with the role of "assistant", along with any logs or errors that occurred during processing.
+   *
+   * @since 5.0
    */
   accessor messages: Collection<ChatMessage>;
-  /** @default false */
-  accessor readAloudEnabled: boolean;
   /**
    * The reference element to the map that provides context for the assistant and its agents. Currently,
    * this is only scoped to `arcgis-map` elements. This is required when ArcGIS agents are registered to the assistant.
    * For example, this allows the navigation agent to execute a map navigation tool for a specific map.
    *
+   * @since 5.0
    * @example
    * ```html
    * <arcgis-map id="my-map"></arcgis-map>
@@ -248,6 +277,13 @@ export abstract class ArcgisAssistant extends LitElement {
    * ```
    */
   accessor referenceElement: ArcgisMap | string | null;
+  /**
+   * When `true`, assistant text responses render after completion instead of streaming progressively.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor streamingDisabled: boolean;
   /**
    * Prompts to suggest to the end user on load. These are intended to help users understand which questions they can ask.
    * This property should be set to establish boundaries for the end user. As all agents have limitations and LLMs can
@@ -269,9 +305,11 @@ export abstract class ArcgisAssistant extends LitElement {
    * ```
    */
   accessor suggestedPrompts: string[];
-  /** @default false */
-  accessor voiceInputEnabled: boolean;
-  /** Cancels the active interrupt, if one is pending. */
+  /**
+   * Cancels the active interrupt, if one is pending.
+   *
+   * @since 5.1
+   */
   cancelInterrupt(): void;
   /**
    * Clears the chat history between the user and the assistant. This method can be used to programmatically reset the conversation,
@@ -289,6 +327,7 @@ export abstract class ArcgisAssistant extends LitElement {
    * Submits a response for the active interrupt.
    *
    * @param response - The response payload expected by the active interrupt type.
+   * @since 5.1
    */
   submitInterrupt(response: string[] | boolean | string): void;
   /**
@@ -299,6 +338,7 @@ export abstract class ArcgisAssistant extends LitElement {
    * complex interactions and integrations with other components or services.
    *
    * @param message - The message to submit to the assistant. This should be a string containing the user's input or question they want to ask the assistant.
+   * @since 5.0
    * @example
    * ```js
    * const assistant = document.querySelector("arcgis-assistant");
@@ -311,6 +351,7 @@ export abstract class ArcgisAssistant extends LitElement {
    * This allows app developers to capture messages cancelled by the user and respond to them in custom ways, such as by providing additional information,
    * triggering other actions in the app, or logging them for analysis.
    *
+   * @since 5.0
    * @example
    * ```js
    * const assistant = document.querySelector("arcgis-assistant");
@@ -325,6 +366,7 @@ export abstract class ArcgisAssistant extends LitElement {
    * This allows app developers to capture errors that occur within the assistant and respond to them in custom ways, such as by displaying an
    * error message to the user, logging the error for analysis, or triggering other actions in the app.
    *
+   * @since 5.0
    * @example
    * ```js
    * const assistant = document.querySelector("arcgis-assistant");
@@ -341,6 +383,7 @@ export abstract class ArcgisAssistant extends LitElement {
    * This allows the application to capture user feedback on the assistant's responses and respond to it in custom ways, such as by providing additional
    * information, adjusting the assistant's behavior, logging the feedback for analysis, or triggering other actions in the app.
    *
+   * @since 5.0
    * @example
    * ```js
    * const assistant = document.querySelector("arcgis-assistant");
@@ -355,6 +398,7 @@ export abstract class ArcgisAssistant extends LitElement {
    * Emitted when an agent triggers an interrupt. An interrupt is a human-in-the-loop mechanism that provides a UI component prompting
    * the user for additional information.
    *
+   * @since 5.0
    * @example
    * ```js
    * const assistant = document.querySelector("arcgis-assistant");
@@ -368,6 +412,7 @@ export abstract class ArcgisAssistant extends LitElement {
   /**
    * Emitted when the user cancels an interrupt. This is typically invoked when a user clicks the cancel button displayed in an interrupt message
    *
+   * @since 5.0
    * @example
    * ```js
    * const assistant = document.querySelector("arcgis-assistant");
@@ -381,6 +426,7 @@ export abstract class ArcgisAssistant extends LitElement {
    * Emitted when the user submits a message during an interrupt. For example, this will be invoked if the user clicks the submit button
    * in an interrupt message asking for confirmation, or when the user submits additional text or selects an option provided in an interrupt.
    *
+   * @since 5.0
    * @example
    * ```js
    * const assistant = document.querySelector("arcgis-assistant");
@@ -396,6 +442,7 @@ export abstract class ArcgisAssistant extends LitElement {
    * Applications that provide a custom `chat-entry` slot can listen for this event to sync
    * the selected prompt into their own entry implementation.
    *
+   * @since 5.1
    * @example
    * ```js
    * const assistant = document.querySelector("arcgis-assistant");
@@ -410,6 +457,7 @@ export abstract class ArcgisAssistant extends LitElement {
    * Emitted when the assistant is ready to receive messages from the end user. This indicates that the assistant has been successfully
    * initialized and is ready to process user input.
    *
+   * @since 5.0
    * @example
    * ```js
    * const assistant = document.querySelector("arcgis-assistant");
@@ -420,16 +468,40 @@ export abstract class ArcgisAssistant extends LitElement {
    * ```
    */
   readonly arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
+  /**
+   * Emitted when the assistant generates a response to a user message. The event detail includes an AssistantMessage object that contains the assistant's response,
+   * along with any relevant logs or errors. This allows app developers to capture the assistant's responses.
+   *
+   * @since 5.1
+   */
+  readonly arcgisResponse: import("@arcgis/lumina").TargetedEvent<this, AssistantMessage>;
   /**
    * Emitted when the assistant requests custom slotted content for an assistant message.
-   * The event detail includes the request name, the target slot name, and the data needed to render or update custom content.
    *
+   * Use this event to render app-provided content into dynamic slot targets created at runtime
+   * for assistant responses. The event detail includes:
+   * - name: conceptual request type
+   * - slotName: concrete slot target to render into
+   * - data: payload needed to render or update content
+   *
+   * Dynamic slot name formats:
+   * - name = "message" -> slotName = "message-{messageId}"
+   * - name = "block" -> slotName = "block-{messageId}-{index}"
+   *
+   * @since 5.1
    * @example
    * ```js
    * const assistant = document.querySelector("arcgis-assistant");
    * assistant.addEventListener("arcgisSlottableRequest", (event) => {
    *   const { name, slotName, data } = event.detail;
-   *   // Render or update custom content for the requested slot
+   *
+   *   if (!data) {
+   *     // Remove previously rendered slotted content for this slotName.
+   *     return;
+   *   }
+   *
+   *   // Render or update app-provided content and set slot=slotName.
+   *   // Optionally branch on name ("message" or "block") for different rendering.
    * });
    * ```
    */
@@ -437,6 +509,7 @@ export abstract class ArcgisAssistant extends LitElement {
   /**
    * Emitted when the user submits a message. This is typically invoked when a user clicks the submit button in the chat interface or hits the Enter key.
    *
+   * @since 5.0
    * @example
    * ```js
    * const assistant = document.querySelector("arcgis-assistant");
@@ -456,6 +529,7 @@ export abstract class ArcgisAssistant extends LitElement {
     arcgisInterruptSubmit: ArcgisAssistant["arcgisInterruptSubmit"]["detail"];
     arcgisPromptSelect: ArcgisAssistant["arcgisPromptSelect"]["detail"];
     arcgisReady: ArcgisAssistant["arcgisReady"]["detail"];
+    arcgisResponse: ArcgisAssistant["arcgisResponse"]["detail"];
     arcgisSlottableRequest: ArcgisAssistant["arcgisSlottableRequest"]["detail"];
     arcgisSubmit: ArcgisAssistant["arcgisSubmit"]["detail"];
   };