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

Jira

Jira Cloud platform を Squid に接続して、issue のクエリや作成を行います​

Jira API key の作成​

Jira REST API へのリクエストには Authorization header が必要です。Squid から Jira API へのリクエストを認可するには、Jira connector を Atlassian API key で設定する必要があります。API key を作成するには、Atlassian のドキュメントの手順に従って API token を作成 してください。Jira connector を追加する際に必要になるため、この値は必ずコピーしておいてください。

Squid application への Jira connector の追加​

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

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

  3. Jira integration を見つけて、Add Integration を選択します。

  4. 次の設定詳細を入力します。

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

Domain: Jira instance の domain name。domain name は通常、Jira にアクセスする URL の最初の部分です。たとえば Jira instance が https://mycompany.atlassian.net にある場合、domain は mycompany です。

API Key: 前のセクションで作成した Atlassian API token。

Jira connector の機能​

Jira connector は現在、Squid AI agent が検索文字列で Jira issue をクエリすること、JQL（Jira Query Language）を使用して Jira issue をクエリすること、そして新しい issue を作成することを可能にします。これらの機能を AI agent に提供することで、ユーザーは AI agent に対して issue の検索や新規作成を依頼するだけで、agent が目的のアクションを実行します。

この機能の使い方をより詳しく学びたい場合は、Jira REST API と JQL のドキュメントを読むことをおすすめします。これにより、どのフィールドをクエリできるか、issue 作成にどのプロパティが必要か、などをより明確に理解できます。

基盤となる API をより深く理解すると、この機能をより効果的に利用できますが、必須ではありません。リクエストに必要な詳細が不足している場合、AI agent がそれを示すメッセージで応答します。

アプリケーションで Jira connector を使用する​

Squid application で Jira connector を使用するには、@squidcloud/jira npm package をインストールします。

npm install @squidcloud/jira

Jira npm package は、Jira API を呼び出すために使用する AI functions を提供します。connector を使用するには、Squid backend project をセットアップ する必要があります。

Squid backend で Jira connector を export すると、Jira AI functions がプロジェクトに追加されます。src/service/index.ts で package を export して、アプリケーション内で使用できるようにします。

export * from './example-service';
export * from '@squidcloud/jira';

Jira AI functions を使用するには、AI agent をそれらの functions に接続する必要があります。そのために、Squid Console で AI agent profile をセットアップします。backend がデプロイされている場合、console の dropdown から AI agent が Jira AI functions にアクセスできます。backend がデプロイされていない場合は、コード内で AI functions を AI agent に提供する必要があります。たとえば Squid Chat Widget を使用する場合、widget の squid-ai-functions-json parameter で AI functions を渡せます。

const aiFunctionsJson = `[{"name": "searchJiraIssuesByText", "context": {"integrationId":"YOUR_INTEGRATION_ID"}}, {"name": "searchJiraIssuesByJQL", "context":  {"integrationId":"YOUR_INTEGRATION_ID"}}, {"name": "createJiraIssue", "context":  {"integrationId":"YOUR_INTEGRATION_ID"}}]`;

<squid-chat-widget>
  squid-ai-integration-id=ai_agents;
  squid-ai-profile-id=YOUR_PROFILE_ID;
  squid-ai-functions-json={aiFunctionsJson}
  squid-app-id='YOUR_APP_ID'
  squid-region='YOUR_REGION'
  squid-environment-id='YOUR_ENVIRONMENT'
  squid-developer-id='YOUR_DEVELOPER_ID' {/* Include the developer ID when running backend locally */}
</squid-chat-widget>

おめでとうございます！これで、Jira instance について AI agent に質問できるようになりました！