Jira
Squid からクエリの実行や課題の作成を行うために、Jira Cloud プラットフォームを接続します
Creating a Jira API key
Jira REST API へのリクエストでは Authorization ヘッダーが必要です。Squid から Jira API に対してリクエストを認証するために、Jira connector は Atlassian API key で構成する必要があります。API key を作成するには、Atlassian のドキュメントに記載されている手順に従って Create an API token を実行してください。この値は Jira connector を追加する際に必要となるので、必ずコピーしてください。
Adding the Jira connector to your Squid application
-
Squid Console 内の Integrations タブに移動します。
-
Available Integrations をクリックします。
-
Jira インテグレーションを見つけ、Add Integration を選択します。
-
次の設定情報を入力します：
Connector ID: コード内でインテグレーションを一意に識別する文字列
Domain: Jira インスタンスのドメイン名。ドメイン名は通常、Jira にアクセスするための URL の最初の部分です。例えば、Jira インスタンスが
https://mycompany.atlassian.netにある場合、ドメインはmycompanyとなります。API Key: 前のセクションで作成した Atlassian API token
The Jira connector's functionality
現在、Jira connector は Squid AI エージェントが検索文字列による Jira 課題のクエリ、JQL (Jira Query Language) を使用した Jira 課題のクエリ、及び新規課題の作成を行えるようにします。これらの機能を AI エージェントに提供することで、ユーザーは単に AI エージェントに課題のクエリや新規課題の作成を依頼するだけで、エージェントが望むアクションを実行します。
この機能の使用方法についてさらに詳しく知りたい場合は、Jira REST API および JQL のドキュメントを参照することをお勧めします。これにより、どのフィールドがクエリ可能か、課題作成に必要なプロパティは何かなどをよりよく理解することができます。
基盤となる API の理解が深まれば、この機能をさらに効果的に使用できますが、必須要件ではありません。AI エージェントはリクエストに不足する必要な詳細がある場合、その旨のメッセージを返してくれます。
Using the Jira connector in your application
Squid アプリケーションで Jira connector を使用するには、@squidcloud/jira npm パッケージをインストールしてください
npm install @squidcloud/jira
Jira npm パッケージは Jira API を呼び出すための AI functions を提供します。connector を使用するためには、setup a Squid backend project を行う必要があります。
Squid backend で Jira connector をエクスポートすると、プロジェクトに Jira AI functions が追加されます。src/service/index.ts 内で、以下のようにパッケージをエクスポートして、アプリケーション内で使用できるようにします。
export * from './example-service';
export * from '@squidcloud/jira';
Jira AI functions を使用するためには、AI エージェントをこれらの functions に接続する必要があります。そのために、Squid Console で AI エージェントプロファイルを設定してください。バックエンドがデプロイされている場合、コンソールのドロップダウンで AI エージェントが Jira AI functions にアクセスできるようになります。バックエンドがデプロイされていない場合は、コード内で AI エージェントに AI functions を提供する必要があります。例えば、Squid Chat Widget を使用している場合、AI functions はウィジェットの squid-ai-functions-json パラメータで提供できます。
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 エージェントに投げかけることができるようになりました！