Zendesk

SquidにZendeskサポートプラットフォームを接続して、issueの問い合わせや作成を行います

Zendesk API Tokenの作成

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

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

Squid ConsoleのConnectorsタブに移動します。
Available Connectorsをクリックします。
Zendeskコネクタを見つけ、Add Connectorを選択します。
以下の設定詳細を入力します：

Connector ID: あなたのコード内でコネクタを一意に識別するための文字列。

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

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

API Token: Zendeskによって生成されたtoken key。

Zendeskコネクタの機能

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

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

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

あなたのアプリケーションでのZendeskコネクタの使用

No-code Studio

No-codeソリューションは、Squid Agent Studio経由で作成できます。

Squid ConsoleのStudioタブに移動します。
Create AI Agentをクリックします。
agent ID と description（例："zendesk-agent" と "This agent helps the user interact with Zendesk tickets"）を入力します。
Add Abilitiesをクリックします。
Existingタブに切り替え、先ほど作成したZendeskコネクタを選択します。
エージェントがこの接続をどのように使用するかについての説明を入力します（例："Call this when a user wants to interact with Zendesk tickets."）。
Testをクリックし、エージェントに "What are my tickets?" と問い合わせてみます。

コードでの基本的な構成要素

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

npm install @squidcloud/zendesk

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

SquidバックエンドでZendeskコネクタをエクスポートすると、プロジェクトにZendesk AI functionsが追加されます。src/service/index.tsでパッケージをエクスポートして、アプリケーション内で使用できるようにします。

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

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

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エージェントに尋ねることができるようになりました！

SquidにZendeskサポートプラットフォームを接続して、issueの問い合わせや作成を行います​

Zendesk API Tokenの作成​

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

Zendeskコネクタの機能​

あなたのアプリケーションでのZendeskコネクタの使用​

No-code Studio​

コードでの基本的な構成要素​