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

Jira

Jira Cloud プラットフォームを Squid に接続して、課題の検索と作成を行います​

Jira API key の作成​

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

Squid アプリケーションに Jira connector を追加する​

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

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

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

  4. 次の設定項目を入力します:

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

Domain: Jira インスタンスのドメイン名。ドメイン名は通常、Jira にアクセスするために使用する URL の最初の部分です。たとえば Jira インスタンスが https://mycompany.atlassian.net にある場合、domain は mycompany になります。

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

Jira connector の機能​

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

この機能の使い方をさらに学びたい場合は、Jira REST API と JQL のドキュメントを読むことを推奨します。これにより、検索可能なフィールド、課題作成に必要なプロパティなどをより理解できるようになります。

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

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

Squid アプリケーションで Jira connector を使用するには、@squidcloud/jira npm package をインストールします。

npm install @squidcloud/jira

Jira npm package は、Jira API を呼び出すために使用される AI functions を提供します。connector を使用するには、setup a 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 が deploy 済みの場合、console の dropdown から AI agent が Jira AI functions にアクセスできるようになります。backend が deploy されていない場合は、コード内で AI functions を AI agent に提供する必要があります。たとえば Squid Chat Widget を使用している場合、widget の squid-ai-functions-json パラメータで 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 インスタンスについて AI agent に質問できるようになりました！