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

Jira

Jira Cloud platform を Squid に接続し、issue の query と作成を行います​

Jira API Key の作成​

Jira REST API への request には Authorization header が必要です。Squid から Jira API への request を authorize するには、Jira connector を Atlassian API key で構成する必要があります。API key を作成するには、Atlassian documentation の API token を作成する step に従います。Jira connector の追加時に必要となるため、この value を copy してください。

Squid Application に Jira Connector を追加する​

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

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

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

  4. 次の configuration detail を入力します。

Connector ID: code 内で integration を一意に識別する string。

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

API Key: 前の section で作成した Atlassian API token。

Jira Connector の Functionality​

Jira connector は現在、Squid AI agent が search string で Jira issue を query し、JQL（Jira Query Language）を使用して Jira issue に query し、新規 issue を作成することを可能にします。AI agent にこれらの capability を提供することで、user は AI agent に issue の query や新規作成を依頼するだけで、agent が目的の action を実行します。

この feature の使用方法に関心がある場合は、Jira REST API と JQL の documentation を読むことをおすすめします。これにより、query 可能な field、issue 作成に必要な property などをより理解できます。

underlying API をより深く理解すると、この feature をより効果的に使用できますが、必須ではありません。request に必要な detail が欠けている場合、AI agent はそれを示す message で response します。

Application で Jira Connector を使用する​

Squid application で Jira connector を使用するには、@squidcloud/jira npm package を install します。

npm install @squidcloud/jira

Jira npm package は Jira API の call に使用する AI function を提供します。connector を使用するには Squid backend project を setupする必要があります。

Squid backend で Jira connector を export すると、Jira AI function が project に追加されます。application で使用するために、src/service/index.ts で package を export します。

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

Jira AI function を使用するには、AI agent がそれらの function に接続されている必要があります。そのために Squid Console で AI agent profile を setup します。backend が deploy されている場合、AI agent は console の dropdown から Jira AI function に access できます。backend が deploy されていない場合、code 内で AI function を AI agent に提供する必要があります。たとえば、Squid Chat Widget を使用する場合、widget の squid-ai-functions-json parameter に AI function を指定できます。

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>

おめでとうございます！これで AI agent に Jira instance について question を尋ねられます。