Confluence
Confluence wiki を Squid に接続し、AI agent が documentation を検索可能な knowledge として利用できるようにします
Confluence Connector の Functionality
Confluence connector は、Confluence space 内の page を knowledge base に読み取り、Squid AI agent が documentation を使用して question に回答できるようにします。
- Squid は Confluence space を background で sync し、10 分ごとに refresh します。page content は semantic search 用に index 化され、page に embed された image も含まれます。
- Confluence connector に接続された AI agent は、index 化された content に対して semantic search を実行できます。そのため、user は「新しい customer をどのように onboard しますか?」といった question を尋ね、wiki を source とする answer を得られます。
- Squid は Confluence 固有の space および page restriction を尊重できるため、agent は chat 中の person が Confluence で閲覧できる page のみを retrieve します。Respecting source permissionsを参照してください。
- Confluence Cloud と Data Center instance の両方がサポートされます。
connector は read-only access を提供します。agent は Confluence content を search・reference できますが、page の作成・編集はできません。
Confluence API Token の作成
- Confluence Cloud の場合、API token の管理に関する Atlassian documentationに従って Atlassian API token を作成します。
- Confluence Data Center の場合、Personal Access Token を作成します。
Squid Application に Confluence Connector を追加する
-
Squid Console の Connectors tab に移動します。
-
Available Connectors をクリックします。
-
Confluence connector を見つけ、Add Connector を選択します。
-
次の configuration detail を指定します。
Connector ID: code 内で connector を一意に識別する string。
Domain: mycompany.atlassian.net など、Confluence instance の fully qualified domain。
Email: Confluence Cloud では、Atlassian API token に関連付けられた email address。Personal Access Token を使用する Data Center instance では空欄にします。
API Key: Atlassian API token(Cloud)または Personal Access Token(Data Center)。token は Squid secret として安全に保存されます。
Cloud ID: Optional。subdomain を介して instance に access できない場合に必要な Atlassian Cloud ID。設定すると、API call は api.atlassian.com を通じて route されます。
Spaces: Optional。sync する Confluence space key の comma-separated list。例: ENG, DOCS。space を特定の top-level page に scope するには、spaceKey[pageId1, pageId2] format を使用します。すべての space を sync するには空欄にします。
personal space は、Spaces list に明示的に含めない限り sync されません。connector を追加した後、space の initial sync が完了するまでしばらく待機してください。
Application で Confluence Connector を使用する
No-code Studio
-
Squid Console の Studio tab に移動します。
-
Create AI Agent をクリックします。
-
"docs-agent"と"This agent answers questions using our Confluence documentation"などの agent ID と description を指定します。 -
Add Abilities をクリックします。
-
Confluence entry を expand し、先ほど作成した Confluence connector を選択します。
-
「user が internal documentation で回答できる可能性のある question を尋ねた場合にこれを call する」など、agent がこの connection を使用する方法の description を指定します。
-
Test をクリックし、wiki 内の content に関する question を agent に尋ねてみます。
Squid SDK を使用する
Squid SDK を使用して AI agent を作成する場合は、ask() function の connectedIntegrations option に追加して Confluence connector を接続します。
- TypeScript
- Python
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',
},
],
});
await squid.ai().agent('AGENT_ID').ask(
'How do we onboard a new customer?',
options={
'connectedIntegrations': [
{
'integrationId': 'CONFLUENCE_CONNECTOR_ID',
'integrationType': 'confluence',
'description': 'Call this connector to search our Confluence documentation',
}
]
},
)
SDK から agent と interaction する方法について詳しくは、AI agent documentationを参照してください。