intra-mart Accel Platform 設定ファイルリファレンス第34版 2024-04-01

目次 ≪ IM-Copilot IM-Copilot 生成AI連携アクション設定 ≫

IM-Copilot 生成AI連携ドライバ設定¶

項目

概要
リファレンス

概要 ¶

IM-Copilot に関する設定です。

デフォルトの設定としてim-copilot-driver-config.xmlが用意されています。

モジュール	IM-Copilot モジュール
フォーマットファイル(xsd)	WEB-INF/schema/im-copilot-driver-config.xsd
設定場所	WEB-INF/conf/im-copilot-driver-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<im-copilot-driver-config xmlns="https://www.intra-mart.jp/im-copilot/im-copilot-driver-config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://www.intra-mart.jp/im-copilot/im-copilot-driver-config ../schema/im-copilot-driver-config.xsd ">

  <!-- Tenant common settings -->
  <default-drivers>
    <driver type="open-ai">
      <api-key>sk-0000XXXXXX</api-key>
      <base-url>https://api.openai.com/v1</base-url>
      <organization>YYYYYY</organization>
      <retry-count>3</retry-count>
      <retry-wait>1</retry-wait>
    </driver>
    <driver type="azure-open-ai">
      <api-key>9999XXXXXX</api-key>
      <base-url>https://openai-service-foo.openai.azure.com/openai/</base-url>
      <api-version>2023-12-01-preview</api-version>
      <retry-count>3</retry-count>
      <retry-wait>1</retry-wait>
    </driver>
  </default-drivers>

  <!-- Tenant specific settings -->
  <drivers tenant="foo">
    <driver type="open-ai">
      <api-key>sk-1111XXXXXX</api-key>
      <base-url>https://api.openai.com/v1</base-url>
      <organization>YYYYYY</organization>
      <retry-count>3</retry-count>
      <retry-wait>1</retry-wait>
    </driver>
    <driver type="azure-open-ai">
      <api-key>5555XXXXXX</api-key>
      <base-url>https://openai-service-foo.openai.azure.com/openai/</base-url>
      <api-version>2023-12-01-preview</api-version>
      <retry-count>3</retry-count>
      <retry-wait>1</retry-wait>
    </driver>
  </drivers>

  <drivers tenant="bar">
    <driver type="azure-open-ai">
      <api-key>0000XXXXXX</api-key>
      <base-url>https://openai-service-foo.openai.azure.com/openai/</base-url>
      <api-version>2023-12-01-preview</api-version>
      <retry-count>3</retry-count>
      <retry-wait>1</retry-wait>
    </driver>
  </drivers>

</im-copilot-driver-config>

リファレンス ¶

デフォルトドライバ情報設定 ¶

タグ名 default-drivers

テナント共通で管理するドライバ情報を設定します。

個別のテナントドライバ情報が設定されていない場合、デフォルトドライバ情報が使用されます。

【設定項目】
<default-drivers>
  ....
</default-drivers>
必須項目 ×

複数設定 ×

設定値・設定する内容デフォルトのドライバ情報の各種設定を指定します。

単位・型なし

省略時のデフォルト値なし

親タグ im-copilot-driver-config

テナントドライバ情報設定 ¶

タグ名 drivers

テナント指定でドライバ情報を設定します。

テナント指定の設定はデフォルトドライバ情報の設定よりも優先されて使用されます。

【設定項目】
<drivers tenant="foo">
  ....
</drivers>
必須項目 ×

複数設定 ○

設定値・設定する内容ドライバ情報の各種設定を指定します。

単位・型なし

省略時のデフォルト値なし

親タグ im-copilot-driver-config

【属性】

属性名説明必須デフォルト値

tenant

このドライバ情報の設定を特定するテナントIDです。

○ なし

ドライバ情報設定 ¶

タグ名 driver

ドライバ情報の設定を行います。

【設定項目】
<drivers tenant="foo">
  <driver type="open-ai">
    ....
  </driver>
</drivers>
必須項目 ○

複数設定 ○

設定値・設定する内容ドライバ情報を指定します。

単位・型なし

省略時のデフォルト値なし

親タグ default-drivers または drivers

【属性】

属性名説明必須デフォルト値

type

生成AIのタイプを設定します。

2024年4月現在、指定可能な値は以下の通りです。

・ OpenAI の場合：

open-ai

・ Azure OpenAI Service の場合：

azure-open-ai

○ なし

コラム

指定できるタイプは今後の製品アップデートに合わせて追加または変更される場合があります。

APIキー設定 ¶

タグ名 api-key

生成AIのAPIキーの設定を行います。

【設定項目】
<drivers tenant="foo">
  <driver type="open-ai">
    <api-key>sk-0000XXXXXX</api-key>
    ....
  </driver>
</drivers>
必須項目 ○

複数設定 ×

設定値・設定する内容 APIキーを指定します。

単位・型文字列

省略時のデフォルト値なし

親タグ driver

エンドポイント設定 ¶

タグ名 base-url

生成AIのエンドポイントの設定を行います。

【設定項目】
<drivers tenant="foo">
  <driver type="open-ai">
    ....
    <base-url>https://api.openai.com/v1</base-url>
    ....
  </driver>
</drivers>
必須項目 ○

複数設定 ×

設定値・設定する内容

エンドポイントを指定します。

2024年4月現在、指定可能な値は以下の通りです。

・ OpenAI の場合：

https://api.openai.com/v1

・ Azure OpenAI Service の場合：

https://openai-service-foo.openai.azure.com/openai/

openai-service-foo 部分はリソースID（サンプル値）です。必ず Azure OpenAI Service のポータルサイトで生成したリソースIDを指定してください。

単位・型文字列

省略時のデフォルト値なし

親タグ driver

Organization設定（ OpenAI ）¶

タグ名 organization

OpenAI をご利用される場合、Organizationの設定を行います。

【設定項目】
<drivers tenant="foo">
  <driver type="open-ai">
    ....
    <organization>YYYYYY</organization>
    ....
  </driver>
</drivers>
必須項目 ○

複数設定 ×

設定値・設定する内容 OpenAI Organization IDを指定します。

単位・型文字列

省略時のデフォルト値なし

親タグ driver

APIバージョン設定（ Azure OpenAI Service ）¶

タグ名 api-version

Azure OpenAI Service をご利用される場合、APIバージョンを設定します。

【設定項目】
<drivers tenant="foo">
  <driver type="open-ai">
    ....
    <api-version>2023-12-01-preview</api-version>
    ....
  </driver>
</drivers>
必須項目 ○

複数設定 ×

設定値・設定する内容

APIバージョンを指定します。

2024年4月現在、指定可能な値は以下の通りです。

・ 2023-12-01-preview

単位・型文字列

省略時のデフォルト値なし

親タグ driver

リトライ回数設定 ¶

タグ名 retry-count

リトライ回数を設定します。

【設定項目】
<drivers tenant="foo">
  <driver type="open-ai">
    ....
    <retry-count>3</retry-count>
    ....
  </driver>
</drivers>
必須項目 ○

複数設定 ×

設定値・設定する内容リトライ回数を指定します。

単位・型数値

省略時のデフォルト値なし

親タグ driver

リトライ待ち時間設定 ¶

タグ名 retry-wait

リトライ待ち時間を設定します。

【設定項目】
<drivers tenant="foo">
  <driver type="open-ai">
    ....
    <retry-wait>1</retry-wait>
    ....
  </driver>
</drivers>
必須項目 ○

複数設定 ×

設定値・設定する内容

リトライ待ち時間を設定します。

単位・型数値

省略時のデフォルト値なし

親タグ driver

目次 ≪ IM-Copilot IM-Copilot 生成AI連携アクション設定 ≫