Types
import type { AssistantAgentDefinition, AgentRegistrationSource } from "@arcgis/ai-components/components/assistant/assistant-agents/types.js";

Type definitions

AssistantAgentDefinition

Type definition

The type accepted by the arcgis-assistant-agent.agent property. Provide either:

  • An agent instance created with an AI Components agent utility.
  • An AgentRegistration object for a custom agent built directly with LangGraph.

AgentRegistrationSource

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.2

An agent instance that provides an AgentRegistration through its registration property. AI Components agent utilities, such as LLMAgent, FunctionAgent, WorkflowAgent, and SkillAgent, implement this interface. Assign the agent instance directly to the arcgis-assistant-agent.agent property of arcgis-assistant-agent.

id

readonly Property
Type
string

A unique identifier for the agent within the assistant.

name

readonly Property
Type
string

A human-readable name that describes the agent's purpose.

description

readonly Property
Type
string

A description of what the agent does and when the assistant should invoke it.

registration

readonly Property
Type
AgentRegistration

The AgentRegistration containing the agent metadata and graph definition used by the assistant to register and invoke this agent.