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

Freshdesk

Freshdesk support desk を Squid に接続し、ticket の検索、作成、管理を行います​

Freshdesk Connector の Functionality​

Freshdesk connector により、Squid AI agent は user に代わって support ticket を操作できます。

Capability説明
Ticket の検索ticket の text search、または最も最近 update された ticket の list 化
Ticket detail の取得必要に応じて related ticket を含む、conversation history を含めた完全な ticket detail
Semantic search指定 ticket に類似する ticket の検索を含む、index 化済み ticket に対する自然言語 search
Ticket の作成subject、description、requester email、priority、status を含む ticket の作成
Ticket の updateticket の subject、description、priority、status の update
Reply と note の追加ticket への public（または private）reply の post、または private internal note の追加

Index Tickets が有効な場合、Squid は ticket history を 10 分ごとに knowledge base に sync し、semantic search と similar-ticket feature を有効にします。

Freshdesk API Key を確認する​

connector は Freshdesk API key を使用して authenticate します。API key は Freshdesk の profile settings 内の Your API Key にあります。詳細は、Freshdesk の API key の確認に関する documentationを参照してください。

Squid Application に Freshdesk Connector を追加する​

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

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

  3. Freshdesk connector を見つけ、Add Connector を選択します。

  4. 次の configuration detail を指定します。

Connector ID: code 内で connector を unique に識別する string。

Subdomain: Freshdesk instance の subdomain。たとえば、instance が https://mycompany.freshdesk.com にある場合、mycompany を入力します。

API Key: Freshdesk API key。key は Squid secret として安全に保存されます。

Index Tickets: Freshdesk ticket の semantic search および similarity feature を有効にします。

Ticket History Days: indexing のために sync する ticket history の日数。default は 30 です。

注記

semantic search と similar-ticket feature には、Index Tickets を有効にする必要があります。有効にした後、initial sync が完了するまでしばらく待機してください。

Application で Freshdesk Connector を使用する​

No-code Studio​

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

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

  3. "support-agent" や "This agent helps the user manage Freshdesk tickets" などの agent ID と description を指定します。

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

  5. Freshdesk entry を expand し、先ほど作成した Freshdesk connector を選択します。

  6. 「user が support ticket を検索または管理したい場合にこれを call する」など、agent が connection を使用する方法の description を指定します。

  7. Test をクリックし、「What are my most recent tickets?」と agent に質問してみます。

Squid SDK を使用する​

Squid SDK を使用して AI agent を作成する場合、ask() function の connectedIntegrations option に Freshdesk connector を追加して接続します。

await this.squid
  .ai()
  .agent('AGENT_ID')
  .ask('Find tickets about login problems and summarize them', {
    connectedIntegrations: [
      {
        integrationId: 'FRESHDESK_CONNECTOR_ID',
        integrationType: 'freshdesk',
        description: 'Call this connector to look up and manage Freshdesk tickets',
      },
    ],
  });

npm Package を使用する​

backend または client code から programmatic（non-agent）access を行うには、@squidcloud/freshdesk-client package を install します。

npm install @squidcloud/freshdesk-client
import { FreshdeskClient } from '@squidcloud/freshdesk-client';

const freshdesk = new FreshdeskClient(squid, 'FRESHDESK_CONNECTOR_ID');

// Search and inspect tickets
const tickets = await freshdesk.searchTickets('login problems');
const details = await freshdesk.getTicketDetails(tickets[0].id);

// Create, reply, and resolve
const ticket = await freshdesk.createTicket('Login issue', 'User cannot log in.', 'user@example.com');
await freshdesk.replyToTicket(ticket.id, 'We are looking into this.');
await freshdesk.resolveTicket(ticket.id);
注記

Freshdesk では priority に numeric value（1 = Low、2 = Medium、3 = High、4 = Urgent）、status に numeric value（2 = Open、3 = Pending、4 = Resolved、5 = Closed）を使用します。