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

Jira

Connect your Jira Cloud platform to Squid to query and create issues​

(Jira Cloud プラットフォームを Squid に接続して、課題の問い合わせおよび作成を行います)

Creating a Jira API key​

(Jira API キーの作成)

Requests to the Jira REST API require an Authorization header. To authorize the requests to the Jira API from Squid, the Jira connector must be configured with an Atlassian API key. To create an API key, follow the steps in Atlassian's documentation to Create an API token. Make sure to copy this value as it is needed when adding the Jira connector.
(Jira REST API へのリクエストには Authorization ヘッダーが必要です。Squid から Jira API へのリクエストを認証するために、Jira connector は Atlassian API キーで構成する必要があります。API キーを作成するには、Atlassian のドキュメントに記載された手順に従い Create an API token を参照してください。Jira connector を追加する際にこの値が必要になるため、必ずコピーしてください。)

Adding the Jira connector to your Squid application​

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

  1. Navigate to the Integrations tab in the Squid Console.
    (まず、Squid Console の Integrations タブに移動します。)

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

  3. Find the Jira integration, and select Add Integration.
    (Jira integration を見つけて、Add Integration を選択します。)

  4. Provide the following configuration details:
    (以下の構成の詳細を入力してください。)

Connector ID: A string that uniquely identifies the integration in the code.
(Connector ID: コード内で統合を一意に識別する文字列)

Domain: The domain name of a Jira instance. The domain name is typically the first part of the URL used to access Jira. For example, if your Jira instance is at https://mycompany.atlassian.net, your domain would be mycompany.
(Domain: Jira インスタンスのドメイン名です。ドメイン名は通常、Jira へアクセスする際の URL の最初の部分です。例えば、Jira インスタンスの URL が https://mycompany.atlassian.net の場合、ドメインは mycompany となります。)

API Key: The Atlassian API token created in the previous section.
(API Key: 前のセクションで作成した Atlassian API token)

The Jira connector's functionality​

(Jira connector の機能)

The Jira connector currently enables Squid AI agents to query Jira issues by a search string, query Jira issues using JQL (Jira Query Language), and create new issues. By providing AI agents with these capabilities, users can simply ask the AI agent to query or create new issues, and the agent will take the desired action.
(現在の Jira connector により、Squid AI agent は検索文字列による Jira 課題の問い合わせ、JQL (Jira Query Language) を使用した Jira 課題の問い合わせ、及び新規課題の作成が可能になります。これらの機能を AI agent に提供することで、ユーザーは単に AI agent に問い合わせや新規課題の作成を指示するだけで、エージェントが希望するアクションを実行します。)

If you are interested in learning more about how to use this feature, it is recommended to read the Jira REST API and JQL documentation. This will give users a better sense of what fields can be queried, what properties are necessary for creating an issue, and more.
(この機能の使用方法に関する詳細を知りたい場合は、Jira REST API および JQL のドキュメントを読むことをお勧めします。これにより、どのフィールドが問い合わせ可能か、課題の作成に必要なプロパティが何であるか等がより明確になります。)

While a better understanding of the underlying API will allow the user to use this feature more effectively, it is not a requirement as the AI agent will respond with messages indicating if requests are missing any required details.
(基盤となる API をより深く理解すれば、この機能をより効果的に使用することが可能になりますが、必須ではありません。なぜなら、AI agent は必要な詳細が不足している場合にその旨のメッセージで応答するためです。)

Using the Jira connector in your application​

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

To use the Jira connector in a Squid application, install the @squidcloud/jira npm package
(Squid アプリケーションで Jira connector を使用するには、@squidcloud/jira npm パッケージをインストールします)

npm install @squidcloud/jira

The Jira npm package provides AI functions used to call the Jira API. You will need to setup a Squid backend project in order to use the connector.
(Jira npm パッケージは、Jira API を呼び出すために使用する AI functions を提供します。connector を利用するには setup a Squid backend project を行う必要があります。)

Exporting the Jira connector in the Squid backend adds the Jira AI functions to your project. In the src/service/index.ts, export the package in order to use it in your application.
(Squid backend で Jira connector をエクスポートすると、Jira AI functions がプロジェクトに追加されます。アプリケーションで使用するために、src/service/index.ts でこのパッケージをエクスポートしてください。)

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

In order to use the Jira AI functions, the AI agent must be connected to those functions. To do so, setup an AI agent profile in the Squid Console. If the backend is deployed, the AI agent will be able to access the Jira AI functions in the dropdown in the console. If the backend is not deployed, the AI functions must be provided to the AI agent in your code. For example, if using the Squid Chat Widget, the AI functions can be provided in the squid-ai-functions-json parameter of the widget.
(Jira AI functions を使用するためには、AI agent がこれらの functions に接続されている必要があります。そのために、Squid Console で AI agent プロファイルを設定してください。バックエンドがデプロイ済みの場合、コンソール内のドロップダウンから AI agent は Jira AI functions にアクセス可能になります。バックエンドがデプロイされていない場合は、コード内で AI agent に対して AI functions を提供する必要があります。例えば、Squid Chat 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>

Congratulations! You can now can ask questions to your AI agent about your Jira instance!
(おめでとうございます！これで、Jira インスタンスに関する質問を AI agent に問い合わせることができます！)