@arcgis/ai-components 5.2.0-next.5 → 5.2.0-next.51

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

@@ -41,6 +41,11 @@ import type { ArcgisMap as ArcgisMap } from "@arcgis/map-components/components/a
  * for the included ArcGIS agents to function properly, as they rely on the map context to perform their tasks. This is not
  * a requirement for [custom agents](https://developers.arcgis.com/javascript/latest/agentic-apps/ai-custom-agents/).
  *
+ * ## Application Identification
+ * For applications that use the arcgis-assistant component, setting the [`applicationName`](https://developers.arcgis.com/javascript/latest/references/core/config/#Config-applicationName) property on the ArcGIS config object [`esriConfig`](https://developers.arcgis.com/javascript/latest/references/core/config/) is recommended.
+ * When provided, this value can help associate assistant activity and feedback with a specific application, where supported.
+ * This can make it easier to understand usage patterns and troubleshoot feedback.
+ *
  * ## Context
  *
  * Use the [referenceElement](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/#referenceElement) property to provide a web map as context to the assistant and its agents.
@@ -89,6 +94,13 @@ export abstract class ArcgisAssistant extends LitElement {
       stopButtonLabel: string;
       askButtonLabel: string;
   }>;
+  /**
+   * 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.
@@ -270,6 +282,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
@@ -454,6 +473,13 @@ 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.
    *
@@ -508,6 +534,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"];
   };