メインコンテンツまでスキップ

Zendesk

Squidと連携してZendeskサポートプラットフォームから問い合わせやチケットの作成を行います​

Zendesk API Tokenの作成​

Zendesk REST APIへのリクエストには、Zendeskのadmin dashboardから生成されたAPI tokenが必要です。API tokenを作成するには、Zendeskのドキュメントに記載されているGenerating API tokensの手順に従ってください。

SquidアプリケーションへのZendeskコネクタの追加​

  1. Squid ConsoleのConnectorsタブに移動します。

  2. Available Connectorsをクリックします。

  3. Zendeskコネクタを見つけ、Add Connectorを選択します。

  4. 以下の設定詳細を入力します:

Connector ID: コード内でコネクタを一意に識別する文字列

Domain: Zendeskインスタンスのドメイン。例えば、Zendeskインスタンスが https://mycompany.zendesk.com にある場合、mycompany.zendesk.com を入力します。

Email: SquidがZendeskにログインする際に使用するアカウントのメールアドレス

API Token: Zendeskにより生成されたトークンキー

Zendeskコネクタの機能​

現在、ZendeskコネクタはSquid AIエージェントに対してチケットの問い合わせ、作成、削除を可能にしています。これらの機能をAIエージェントに提供することで、ユーザーはエージェントに代わってチケットに関する操作を実行させることができます。

この機能の使用方法についてさらに知りたい場合は、Zendesk REST APIのドキュメントを読むことをお勧めします。これにより、問い合わせ可能なフィールド、問題作成に必要なプロパティなどについて理解を深めることができます。

基盤となるAPIをよりよく理解すれば、この機能をさらに効果的に使用できますが、不足している詳細をAIエージェントがメッセージで尋ねるので、必須ではありません。

アプリケーションでのZendeskコネクタの利用方法​

No-code Studio​

No-codeソリューションはSquid Agent Studioを使用して作成できます。

  1. Squid ConsoleのStudioタブに移動します。

  2. Create AI Agentをクリックします。

  3. agent IDとdescription（例："zendesk-agent" と "This agent helps the user interact with Zendesk tickets"）を入力します。

  4. Add Abilitiesをクリックします。

  5. Existingタブに切り替え、先ほど作成したZendeskコネクタを選択します。

  6. エージェントがこの接続をどのように使用するかの説明を入力します（例："Call this when a user wants to interact with Zendesk tickets."）。

  7. Testをクリックし、エージェントに「What are my tickets?」と尋ねてみます。

コードでの基本的なビルディングブロック​

SquidアプリケーションでZendeskコネクタを使用するには、@squidcloud/zendesk npmパッケージをインストールします

npm install @squidcloud/zendesk

Zendesk npmパッケージは、Zendesk APIを呼び出すために使用するAI functionsを提供します。コネクタを使用するには、Squid backend projectの設定が必要です。

Squid backendにZendeskコネクタをエクスポートすることで、プロジェクトにZendesk AI functionsが追加されます。アプリケーションで使用するため、src/service/index.tsでパッケージをエクスポートしてください。

export * from './your-service';
export * from '@squidcloud/zendesk';

Zendesk AI functionsを使用するには、AIエージェントがこれらのfunctionsに接続されている必要があります。そのため、Squid ConsoleでAIエージェントのプロファイルを設定してください。バックエンドが展開されている場合、エージェントはコンソール内のドロップダウンからAI functionsにアクセスできます。バックエンドが展開されていない場合は、コード内でAI functionsをエージェントに提供する必要があります。例えば、Squid Chat Widgetを使用する場合、ウィジェットのsquid-ai-functions-jsonパラメータでAI functionsを提供できます。

const aiFunctionContext = { integrationId: 'YOUR_ZENDESK_CONNECTOR_ID' };
const aiFunctionsJson = JSON.stringify([
  {
    name: 'createTicket',
    context: aiFunctionContext,
  },
  {
    name: 'getAllTickets',
    context: aiFunctionContext,
  },
  {
    name: 'getZendeskTicketsByRequester',
    context: aiFunctionContext,
  },
  {
    name: 'searchZendeskTickets',
    context: aiFunctionContext,
  },
  {
    name: 'deleteZendeskTicket',
    context: aiFunctionContext,
  },
  {
    name: 'getLoggedInUser',
    context: aiFunctionContext,
  },
  {
    name: 'getZendeskUserByEmail',
    context: aiFunctionContext,
  },
  {
    name: 'genericFallbackQueryFunction',
    context: aiFunctionContext,
  },
]);

const chatWidget = document.createElement('squid-chat-widget');
chatWidget.setAttribute('squid-ai-integration-id', 'ai_agents');
chatWidget.setAttribute('squid-app-id', 'YOUR_APP_ID');
chatWidget.setAttribute('squid-region', 'YOUR_REGION');
chatWidget.setAttribute('squid-environment-id', 'YOUR_ENVIRONMENT');
chatWidget.setAttribute('squid-developer-id', 'YOUR_DEVELOPER_ID');
chatWidget.setAttribute('squid-ai-agent-id', 'YOUR_AGENT_ID');
chatWidget.setAttribute('header-title', 'Zendesk AI');
chatWidget.setAttribute('squid-ai-functions-json', aiFunctionsJson);
chatWidget.setAttribute(
  'intro-text',
  'Hi, I am the Zendesk agent. How can I help?'
);
chatWidget.setAttribute(
  'style',
  'display: block; min-height: 350px; height: 75vh;'
);

const widgetContainer = document.getElementById('widget');
if (widgetContainer) {
  widgetContainer.innerHTML = ''; // Clear any existing widget
  widgetContainer.appendChild(chatWidget);
}

以上が、アプリケーションでZendeskコネクタを機能させるための基本的なビルディングブロックです。 最も簡単な方法は、sample codeをコピーしてそこから構築することです。

おめでとうございます！これで、あなたはZendeskインスタンスについてAIエージェントに質問できるようになりました！