IM-Copilot 生成AI連携ドライバ設定¶
項目
- 概要
- リファレンス
- デフォルトドライバ情報設定
- テナントドライバ情報設定
- ドライバ情報設定
- APIキー設定
- エンドポイント設定
- Organization設定( OpenAI )
- APIバージョン設定( Azure OpenAI Service )
- リトライ回数設定
- リトライ待ち時間設定
- リージョン設定( Amazon Bedrock )
- 認証プロファイル設定( Amazon Bedrock )
- アクセスキーとシークレットキーの設定( Amazon Bedrock )
- アクセスキー設定( Amazon Bedrock )
- シークレットキー設定( Amazon Bedrock )
- IAMロール設定( Amazon Bedrock )
概要¶
IM-Copilot のドライバに関する設定です。この設定ファイルでは、各生成AIサービスに対しての接続に関する設定を行います。
モジュール 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> <driver type="amazon-bedrock"> <aws-region>ap-northeast-3</aws-region> <aws-credentials-profile>default</aws-credentials-profile> </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> <driver type="amazon-bedrock"> <aws-region>ap-northeast-3</aws-region> <aws-credentials-profile>foo</aws-credentials-profile> </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> <driver type="amazon-bedrock"> <aws-region>ap-northeast-3</aws-region> <aws-credentials-static> <access-key>XXXXXX</access-key> <secret-key>YYYYYY</secret-key> </aws-credentials-static> </driver> </drivers> <drivers tenant="baz"> <driver type="amazon-bedrock"> <aws-region>ap-northeast-3</aws-region> <aws-credentials-iam-role-arn>ZZZZZZ</aws-credentials-iam-role-arn> </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年10月現在、指定可能な値は以下の通りです。
- OpenAI の場合:
open-ai
- Azure OpenAI Service の場合:
azure-open-ai
- Amazon Bedrock の場合:
amazon-bedrock
○ なし コラム
指定できるタイプは今後の製品アップデートに合わせて追加または変更される場合があります。
APIキー設定¶
タグ名 api-key OpenAI または Azure OpenAI Service を利用する際の設定です。生成AIサービスへ接続する際に用いるAPIキーの設定を行います。【設定項目】
<drivers tenant="foo"> <driver type="open-ai"> <api-key>sk-0000XXXXXX</api-key> .... </driver> </drivers>
必須項目 × 複数設定 × 設定値・設定する内容 APIキーを指定します。 単位・型 文字列 省略時のデフォルト値 なし 親タグ driver
エンドポイント設定¶
タグ名 base-url OpenAI または Azure OpenAI Serviceを利用する際の設定です。接続先となる生成AIサービスのエンドポイントの設定を行います。【設定項目】
<drivers tenant="foo"> <driver type="open-ai"> .... <base-url>https://api.openai.com/v1</base-url> .... </driver> </drivers>
必須項目 × 複数設定 × 設定値・設定する内容 エンドポイントを指定します。2024年10月現在、指定可能な値は以下の通りです。
- 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を指定してください。
- Amazon Bedrock の場合:
このタグを記述する必要はありません。
単位・型 文字列 省略時のデフォルト値 なし 親タグ 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年10月現在、指定可能な値は以下の通りです。
- 2023-12-01-preview
単位・型 文字列 省略時のデフォルト値 なし 親タグ driver
リトライ回数設定¶
タグ名 retry-count OpenAI または Azure OpenAI Service を利用する際の設定です。リトライ回数を設定します。【設定項目】
<drivers tenant="foo"> <driver type="open-ai"> .... <retry-count>3</retry-count> .... </driver> </drivers>
必須項目 × 複数設定 × 設定値・設定する内容 リトライ回数を指定します。 単位・型 数値 省略時のデフォルト値 なし 親タグ driver
リトライ待ち時間設定¶
タグ名 retry-wait OpenAI または Azure OpenAI Service を利用する際の設定です。リトライ待ち時間を設定します。【設定項目】
<drivers tenant="foo"> <driver type="open-ai"> .... <retry-wait>1</retry-wait> .... </driver> </drivers>
必須項目 × 複数設定 × 設定値・設定する内容 リトライ待ち時間を設定します。単位・型 数値 省略時のデフォルト値 なし 親タグ driver
リージョン設定( Amazon Bedrock )¶
タグ名 aws-region Amazon Bedrock を利用する際の設定です。リージョンを設定します。【設定項目】
<drivers tenant="foo"> <driver type="amazon-bedrock"> .... <aws-region>ap-northeast-3</aws-region> .... </driver> </drivers>
必須項目 × 複数設定 × 設定値・設定する内容 リージョンを設定します。単位・型 文字列 省略時のデフォルト値 なし 親タグ driver
認証プロファイル設定( Amazon Bedrock )¶
タグ名 aws-credentials-profile Amazon Bedrock を利用する際の設定です。認証情報ファイルを利用してAWSに認証を行う場合、認証プロファイル名の設定を行います。【設定項目】
<drivers tenant="foo"> <driver type="amazon-bedrock"> .... <aws-credentials-profile>default</aws-credentials-profile> .... </driver> </drivers>
必須項目 × 複数設定 × 設定値・設定する内容 認証プロファイルを設定します。単位・型 文字列 省略時のデフォルト値 なし 親タグ driver
アクセスキーとシークレットキーの設定( Amazon Bedrock )¶
タグ名 aws-credentials-static Amazon Bedrock を利用する際の設定です。設定ファイルにアクセスキーとシークレットキーを直接設定してAWSに認証を行う場合、アクセスキーとシークレットキーの設定を行います。【設定項目】
<drivers tenant="foo"> <driver type="amazon-bedrock"> .... <aws-credentials-static> .... </aws-credentials-static> .... </driver> </drivers>
必須項目 × 複数設定 × 設定値・設定する内容 アクセスキーとシークレットキーを設定します。単位・型 なし 省略時のデフォルト値 なし 親タグ driver
アクセスキー設定( Amazon Bedrock )¶
タグ名 access-key Amazon Bedrock を利用する際の設定です。設定ファイルにアクセスキーとシークレットキーを直接設定してAWSに認証を行う場合の、アクセスキーの設定を行います。【設定項目】
<drivers tenant="foo"> <driver type="amazon-bedrock"> .... <aws-credentials-static> <access-key>XXXXXX</access-key> .... </aws-credentials-static> .... </driver> </drivers>
必須項目 ○ 複数設定 × 設定値・設定する内容 アクセスキーを設定します。単位・型 文字列 省略時のデフォルト値 なし 親タグ aws-credentials-static
シークレットキー設定( Amazon Bedrock )¶
タグ名 secret-key Amazon Bedrock を利用する際の設定です。設定ファイルにアクセスキーとシークレットキーを直接設定してAWSに認証を行う場合の、シークレットキーの設定を行います。【設定項目】
<drivers tenant="foo"> <driver type="amazon-bedrock"> .... <aws-credentials-static> .... <secret-key>YYYYYY</secret-key> </aws-credentials-static> .... </driver> </drivers>
必須項目 ○ 複数設定 × 設定値・設定する内容 シークレットキーを設定します。単位・型 文字列 省略時のデフォルト値 なし 親タグ aws-credentials-static
IAMロール設定( Amazon Bedrock )¶
タグ名 aws-credentials-iam-role-arn Amazon Bedrock を利用する際の設定です。IAMロールを利用してAWSに認証を行う場合、IAMロールのARNの設定を行います。【設定項目】
<drivers tenant="foo"> <driver type="amazon-bedrock"> .... <aws-credentials-iam-role-arn>ZZZZZZ</aws-credentials-iam-role-arn> .... </driver> </drivers>
必須項目 × 複数設定 × 設定値・設定する内容 IAMロールのARNを設定します。単位・型 文字列 省略時のデフォルト値 なし 親タグ driver