Connect Customer SDK AI Agents API

The Connect Customer SDK provides an AIAgentsClient which serves as an interface that your app can use to interact with AI Agent functionality. This client provides methods for real-time agent assistance use cases like checking AI Agent support, sending messages to AI Agents, retrieving message history, fetching knowledge content, and subscribing to real-time AI Agent message events.

The AIAgentsClient constructor requires a ConnectClientConfig argument, which is defined as:

export type ConnectClientConfig =
    | AmazonConnectProvider
    | { context: ModuleContext; provider?: AmazonConnectProvider }
    | { provider: AmazonConnectProvider };

Pass the provider that AmazonConnectApp.init returns to the constructor. You must provide this argument.

import { AIAgentsClient } from "@amazon-connect/ai-agents";

const aiAgentsClient = new AIAgentsClient(provider);

Note

You must first instantiate the AmazonConnectApp, which initializes the default AmazonConnectProvider and returns { provider }.

The following sections describe the API calls for working with the AI Agents API.

Contents

• isAIAgentSupported()

• onAIAgentContactReady()

• offAIAgentContactReady()

• sendAIAgentMessage()

• listAIAgentMessages()

• getKnowledgeContent()

• onAIAgentMessageReceived()

• offAIAgentMessageReceived()

• onAIAgentMessageStatusChanged()

• offAIAgentMessageStatusChanged()