導入手順

本ツールの導入手順について説明します。

プロバイダー情報設定

本ツールでは LLM を利用するため、事前に利用するプロバイダーの情報 (API key 等) を設定する必要があります。

利用可能なプロバイダーは以下の通りです。

  • OpenAI
  • Azure OpenAI Service
  • Anthropic

プロバイダー情報の設定は settings_provider.yaml で行います。

当該ファイルはツール初回起動時に空の値で自動生成されます。

自動生成前に準備する場合は settings_provider.yaml.sample を参考にしてください。

# settings_provider.yaml.sample
openai:  # OpenAI
  api_key: ""  # sk-xxxx
  organization: ""  # org-xxxx
azure:  # Azure OpenAI Service
  api_key: ""  # 32桁の16進数
  endpoint: ""  # https://?????????.openai.azure.com
  deploy_name: ""  # デプロイ名
  api_version: "2024-10-01-preview"  # APIバージョン(モデルのバージョンとは異なります)
anthropic:  # Anthropic (Claude)
  api_key: ""  # sk-xxxx

設定する項目はプロバイダーごとに異なります。

以下にプロバイダーごとの設定内容を簡単に説明します。

OpenAI

OpenAI 用のプロバイダー情報

api_key

APIキー

例: sk-xxxx

organization

組織ID 例: org-xxxx

Azure OpenAI Service

Azure OpenAI Service 用のプロバイダー情報

api_key

APIキー

例: 32桁の16進数

endpoint

エンドポイント 例: https://?????????.openai.azure.com

deploy_name

デプロイ名。Azure OpenAI Service では OpenAI とは異なり API の model パラメータにはこのデプロイ名を指定する必要があります。

api_version

API バージョン。モデルのバージョンとは異なります。デフォルト値のままの利用を推奨します。 例: 2024-10-01-preview

Anthropic

Anthropic 用のプロバイダー情報

api_key

APIキー

例: sk-xxxx