@arcgis/ai-components 5.2.0-next.12 → 5.2.0-next.121

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

@@ -98,6 +98,112 @@ export type AssistantPromptSelectDetail = {
   prompt: string;
 };
 
+/**
+ * A command selected in an assistant submission.
+ * A submission can contain at most one command.
+ *
+ * @internal
+ */
+export type AssistantCommandInputPart = Readonly<{
+    kind: "command";
+    id: string;
+    label: string;
+    agentId?: string;
+    requiresText?: boolean;
+    data?: unknown;
+}>;
+
+/**
+ * A selectable command returned by an assistant command provider.
+ *
+ * @internal
+ */
+export type AssistantCommandSuggestion = Readonly<{
+    id: string;
+    label: string;
+    description?: string;
+    agentId?: string;
+    requiresText?: boolean;
+    data?: unknown;
+}>;
+
+/**
+ * Provides suggestions for the reserved `/` command trigger in the assistant chat entry.
+ *
+ * @internal
+ */
+export type AssistantCommandProvider = Readonly<{ getSuggestions: (query: string, signal: AbortSignal) => Promise<readonly AssistantCommandSuggestion[]> | readonly AssistantCommandSuggestion[]; }>;
+
+/**
+ * An entity selected in an assistant submission.
+ *
+ * @internal
+ */
+export type AssistantEntityInputPart = Readonly<{
+    kind: "entity";
+    providerId: string;
+    trigger: string;
+    id: string;
+    label: string;
+    data?: unknown;
+}>;
+
+/**
+ * A selectable entity returned by an assistant entity provider.
+ *
+ * @internal
+ */
+export type AssistantEntitySuggestion = Readonly<{
+    id: string;
+    label: string;
+    description?: string;
+    data?: unknown;
+}>;
+
+/**
+ * Provides entity suggestions for a trigger in the assistant chat entry.
+ * The `/` trigger is reserved for commands.
+ * Selected entities remain in the submitted prompt and do not affect agent routing.
+ *
+ * @internal
+ */
+export type AssistantEntityProvider = Readonly<{
+    id: string;
+    trigger: string;
+    getSuggestions: (query: string, signal: AbortSignal) => Promise<readonly AssistantEntitySuggestion[]> | readonly AssistantEntitySuggestion[];
+}>;
+
+/**
+ * Structured input submitted with an assistant request.
+ *
+ * @internal
+ */
+export type AssistantInputPart = AssistantCommandInputPart | AssistantEntityInputPart;
+
+/**
+ * Options for submitting an assistant message.
+ * Requests with parts but no message text require a command with an `agentId` or an explicitly selected agent through
+ * `alwaysUseAgentId`.
+ * Parts are scoped to this request; they are not persisted in message history.
+ *
+ * @internal
+ */
+export type SubmitMessageOptions = Readonly<{
+    parts?: readonly AssistantInputPart[];
+    displayText?: string;
+}>;
+
+/**
+ * A snapshot of an assistant submission, separating execution text from display text.
+ *
+ * @internal
+ */
+export type AssistantSubmission = Readonly<{
+    prompt: string;
+    displayText: string;
+    parts: readonly AssistantInputPart[];
+}>;
+
 /** Detail payload emitted by the assistant slottable request event. */
 export type AssistantSlottableRequestDetail = {
   /** The request name describing the slot being requested. */
@@ -125,6 +231,8 @@ export interface UserMessage extends ChatMessageBase {
    * This content is sent to the assistant and its agents for processing and generating responses.
    */
   content: string;
+  /** Structured input parts submitted with the message. */
+  parts?: readonly AssistantInputPart[];
 }
 
 /** Feedback provided by the user for a specific message. */

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

@@ -1,6 +1,7 @@
 /// <reference path="../../index.d.ts" />
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { AgentRegistration } from "../../utils/index.js";
+import type { AgenticWorkflowJson } from "../../agentic-workflow/jsonTypes.js";
 
 /**
  * The Assistant Agent component is a generic wrapper for registering custom agents to the [arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/) component. To define
@@ -67,7 +68,6 @@ export abstract class ArcgisAssistantAgent<TContext = Record<string, unknown>> e
    * See the [Custom Agents guide](https://developers.arcgis.com/javascript/latest/agentic-apps/ai-custom-agents/) for more instructions
    * and links to samples demonstrating how to create custom agents.
    *
-   * @required
    * @see [LangGraph documentation](https://docs.langchain.com/oss/javascript/langgraph/overview)
    * @see [Custom agents guide](https://developers.arcgis.com/javascript/latest/agentic-apps/ai-custom-agents/)
    * @example
@@ -138,4 +138,16 @@ export abstract class ArcgisAssistantAgent<TContext = Record<string, unknown>> e
    * ```
    */
   accessor context: TContext | (() => Promise<TContext | undefined> | TContext | undefined) | undefined;
+  /**
+   * The portal item ID associated with this assistant agent.
+   *
+   * @internal
+   */
+  accessor itemId: string | undefined;
+  /**
+   * The workflow JSON associated with this assistant agent.
+   *
+   * @internal
+   */
+  accessor workflow: AgenticWorkflowJson | undefined;
 }