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

Confluence

Confluence wiki を Squid に接続して、AI agents がドキュメントの検索可能な knowledge を利用できるようにします​

Confluence connector の機能​

Confluence connector は、Confluence spaces 内のページを knowledge base に読み込み、Squid AI agents がドキュメントを使用して質問に回答できるようにします。

  • Squid はバックグラウンドで Confluence spaces を同期し、10 分ごとに更新します。ページコンテンツは semantic search 用にインデックス化され、ページに埋め込まれた画像も含まれます。
  • Confluence connector に接続された AI agents は、インデックス化されたコンテンツに対して semantic searches を実行できるため、ユーザーは "How do we onboard a new customer?" のような質問をして、wiki をソースとした回答を得ることができます。
  • Confluence Cloud と Data Center instances の両方がサポートされています。

この connector は読み取り専用アクセスを提供します。agents は Confluence コンテンツを検索して参照できますが、ページを作成または編集することはできません。

Confluence API token の作成​

  • Confluence Cloud の場合は、Atlassian の managing API tokens に関するドキュメントに従って Atlassian API token を作成します。
  • Confluence Data Center の場合は、Personal Access Token を作成します。

Squid application に Confluence connector を追加する​

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

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

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

  4. 次の構成詳細を入力します。

Connector ID: コード内で connector を一意に識別する文字列。

Domain: mycompany.atlassian.net など、Confluence instance の fully qualified domain。

Email: Confluence Cloud の場合は、Atlassian API token に関連付けられた email address。Personal Access Token を使用する Data Center instances の場合は空のままにします。

API Key: Atlassian API token（Cloud）または Personal Access Token（Data Center）。token は Squid secret として安全に保存されます。

Cloud ID: 任意。Atlassian Cloud ID。instance が subdomain 経由でアクセスできない場合に必要です。設定すると、API calls は api.atlassian.com 経由でルーティングされます。

Spaces: 任意。ENG, DOCS など、同期する Confluence space keys の comma-separated list。space を特定の top-level pages に限定するには、spaceKey[pageId1, pageId2] の形式を使用します。すべての spaces を同期するには空のままにします。

注記

Personal spaces は、Spaces リストに明示的に含めない限り同期されません。connector を追加した後、spaces の初回同期が完了するまでしばらく待ってください。

application で Confluence connector を使用する​

No-code Studio​

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

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

  3. "docs-agent" や "This agent answers questions using our Confluence documentation" などの agent ID と description を入力します。

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

  5. Confluence entry を展開し、先ほど作成した Confluence connector を選択します。

  6. "Call this when a user asks a question that may be answered by our internal documentation." のように、agent がこの接続をどのように使用すべきかについての description を入力します。

  7. Test をクリックし、wiki 内のコンテンツについて agent に質問してみます。

Squid SDK の使用​

Squid SDK で AI agent を作成している場合は、ask() function の connectedIntegrations option に追加することで Confluence connector を接続します。

await this.squid
  .ai()
  .agent('AGENT_ID')
  .ask('How do we onboard a new customer?', {
    connectedIntegrations: [
      {
        integrationId: 'CONFLUENCE_CONNECTOR_ID',
        integrationType: 'confluence',
        description: 'Call this connector to search our Confluence documentation',
      },
    ],
  });

SDK から agent とやり取りする方法の詳細については、AI agent documentation を参照してください。